* code that must be skipped by doxygen */Īround the blocks that should be hidden and put: PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS This should be within the same file of course.īut you can also use doxygen's preprocessor for this: If you put #ifndef DOXYGEN_SHOULD_SKIP_THIS The new and easiest way is to add one comment block with a \cond command at the start and one comment block with a \endcond command at the end of the piece of code that should be ignored. How can I make doxygen ignore some code fragment? If no mapping is specified the file's contents will be ignored. This mapping is specified using the EXTENSION_MAPPING tag. Since version 1.8.8, doxygen requires that you specify a mapping that tells for a certain file extension, which parser to use. In the past doxygen parsed all files with an unknown extension as C files which could lead to undesired results. My file with a custom extension is not parsed (properly) (anymore).ĭoxygen only parses files that are specified as input (via the INPUT tag) and that match a specified extension (mentioned in FILE_PATTERNS) The list of files is then reduced by excluding files listed as EXCLUDE or files that match the patterns set by EXCLUDE_PATTERNS.
In order for global functions, variables, enums, typedefs, and defines to be documented you should document the file in which these commands are located using a comment block containing a \file (or command.Īlternatively, you can put all members in a group (or module) using the \ingroup command and then document the group using a comment block containing the \defgroup command.įor member functions or functions that are part of a namespace you should document either the class or namespace. When I set EXTRACT_ALL to NO none of my functions are shown in the documentation.
Doxygen makefile manual#
Please read the preprocessing section of the manual for more information. This typically boils down to the following settings in the configuration file: ENABLE_PREPROCESSING = YES MY_MACRO())? If so then you have to instruct doxygen's preprocessor to remove it. Is there a function macro in your class that does not end with a semicolon (e.g. Is your class / file / namespace documented? If not, it will not be extracted from the sources unless EXTRACT_ALL is set to YES in the configuration file.Īre the members private? If so, you must set EXTRACT_PRIVATE to YES to make them appear in the documentation. Help, some/all of the members of my class / file / namespace are not documented? * \subsection step1 Step 1: Opening the box You should use the \mainpage command inside a comment block like this: /*! \mainpage My Personal Index Page
Doxygen makefile how to#
How to get information on the index page in HTML?
Doxygen makefile windows#
Doxygen automatically generates a link to the class M圜lass somewhere in the running text.How can I exclude all test directories from my directory tree?.The overall HTML output looks different, while I only wanted to use my own html header file.I don't like the quick index that is put above each HTML page, what do I do?.How can I use tag files in combination with compressed HTML?.How can I change what is after the #include in the class documentation?.How can I make doxygen ignore some code fragment?.My file with a custom extension is not parsed (properly) (anymore).When I set EXTRACT_ALL to NO none of my functions are shown in the documentation.Help, some/all of the members of my class / file / namespace are not documented?.How to get information on the index page in HTML?.
0 kommentar(er)
