DoxyPress  1.4.1
Project File

The project file for DoxyPress uses the JSON format. This is an ASCII readable file format similar to an XML file.

The following is an alphabetical list of the tags used to configure a DoxyPress project. The tag values can be modified by hand, although it is often more convenient to use DoxyPressApp to set up a project.

## Project File Tags

The following is an alphabetical list of the tags and their descriptions.

ABBREVIATE-BRIEF

This tag is a list of phrases which are removed from the beginning of a brief description.

The default values are: The $name class, The$name widget, The $name file, is, provides, specifies, contains, represents, a, an, the ALIASES This tag is used to specify a number of aliases which act as commands in the documentation. An alias has the format: name=value. sideeffect=\par Side Effects:\n This example defines the command \sideeffect (or @sideeffect). The result is a user-defined paragraph with a heading of "Side Effects:" ALL-EXTERNALS If this tag is set all external class will be listed in the class index. If set to NO only the inherited external classes will be listed. The default value is: NO ALLOW-SUB-GROUPING Set this tag to allow class member groups of the same type For instance, a group of public functions will be grouped with other functions of the same type. Set this tag to NO to prevent subgrouping. Alternatively, sub-grouping can be done per class using the \nosubgrouping command. The default value is: YES ALLOW-UNICODE-NAMES If this tag is set DoxyPress will allow non-ASCII characters to appear in the names of generated files. If set to NO, non-ASCII characters will be escaped. For example: _xE3_x81_x84 will be used for Unicode U+3044. The default value is: NO ALPHA-INDEX If this tag is set an alphabetical index of all compounds will be generated. This tag should be enabled if the project contains numerous classes, structs, unions or interfaces. The default value is: YES ALWAYS-DETAILED-SEC If this tag and 'REPEAT BRIEF DESCRIPTION' is set, a detailed section will be generated even if there is only a brief description. The default value is: NO AUTO-LINK When this tag is set DoxyPress tries to link words which correspond to documented classes, functions, or namespaces to their corresponding documentation. An auto link can be prevented for individual cases by adding a % character in front of the word or globally by setting this tag to NO. The default value is: YES BINARY-TOC This tag controls whether the chm will contain a binary table of contents (YES) or a normal table of contents (NO). It also enables the Previous and Next buttons. The default value is: NO This tag requires the tag 'GENERATE HTML HELP' is set to YES BRIEF-MEMBER-DESC If this tag is set a brief description will be included after each method, function, or other member in the documentation of a class or file. The default value is: YES BUILT-IN-STL-SUPPORT If you use STL classes (std::string, std::vector, etc.) but do not want to include a tag file for the STL sources as input, then set this tag to YES. The default value is: NO CASE-SENSITIVE-FNAME If this tag is set to NO all file names will be generated in lower case. If set to YES, case is preserved. The default value is: YES CHM-FILE This tag is used to specify the file name of the resulting .chm file. If a path is specified the file will be written to this path instead of the html output directory. This tag requires the tag 'GENERATE HTML HELP' is set to YES CHM-INDEX-ENCODING This tag is used to encode HtmlHelp index (hhk), content (hhc) and project file content. This tag requires the tag 'GENERATE HTML HELP' is set to YES CITE-BIB-FILES This tag is used to specify one or more bib files containing the reference definitions. To use this feature both perl and bibtex must be available in the search path. Windows users can download the binary for bibtex from our download site. bibtex For LaTeX the style of the bibliography can be controlled using 'LATEX BIB STYLE'. Refer to the \cite command. CLANG-COMPILATION-PATH This tag is used to set the path to a JSON file previously created by a build tool like CMake or Visual Studio. This file is referred to as the 'compilation database'. If this tag is used then the compiler options do not need to be specified in the 'CLANG FLAGS'. Requires the tag 'CLANG PARSING' is set to YES CLANG-DIALECT This tag specifies which C++ standard should be used when parsing source code with clang and a compilation JSON file is not provided. The default value is: -std=c++14 Requires the tag 'CLANG PARSING' is set to YES CLANG-FLAGS This tag is used to pass flags to clang when parsing source files. This tag requires 'CLANG PARSING' is set to YES CLANG-INCLUDE-INPUT-SOURCE If this tag is set all directories listed in 'INPUT SOURCE' will be added to the clang flags using the '-I' option. Requires the tag 'CLANG PARSING' is set to YES CLANG-PARSING If this tag is set DoxyPress will use the clang parser for parsing C, C++, and Objective-C source code. Using clang might be slightly slower, however it will be more accurate. The default value is: NO CLANG-USE-HEADERS At run time DoxyPress will need access to the clang header files. Checking this tag will use the clang headers located in the installed 'doxypress/include' folder. To use a different set of clang headers ensure this tag is not set. You will need to specify the location of the clang headers using -I pathToClang in the 'CLANG FLAGS' . The default value is: NO This tag requires 'CLANG PARSING' is set to YES CLASS-DIAGRAMS If this tag is set DoxyPress will generate a class diagram in HTML and LaTeX for classes with base or super classes. Setting the tag to NO turns the diagrams off. It is recommended you install and use the dot program since it yields more powerful graphs. The default value is: YES COLS-IN-INDEX This tag is used to specify the number of columns to use for the alphabetical index. Minimum: 1, Maximum: 20, Default: 5 This tag requires the tag 'ALPHABETICAL INDEX' is set to YES CPP-CLI-SUPPORT If you use Microsoft's C++/CLI language this tag should set set to enable parsing support. The default value is: NO CREATE-SUBDIRS If this tag is set, 4096 sub-directories (in 2 levels) will be created under the output directory for each output format type. The output files will be distributed in these directories. The default value is: NO DIA-FILE-DIRS This tag is used to specify one or more directories containing dia files which are included in the documentation. Refer to the \diafile command. DIA-PATH Diagrams made with Dia can be included in DoxyPress documentation. DoxyPress will run Dia to produce the diagram and insert it in the documentation. This tag is used to specify the directory where the Dia program is located. If left empty Dia is assumed to be found in the search path. DIRECTORY-GRAPH If this tag is set the dependencies a directory has on other directories, will be shown. The dependency relations are determined by the #include relations between the files in the directories. The default value is: YES This tag requires the tag 'HAVE DOT' is set to YES DISABLE-INDEX To obtain full control over the layout of generated HTML it can be necessary to disable the index and replace it with a custom index. This tag is used to turn enable (NO) or disable (YES) the index tabs at the top of each HTML page. Since the tabs in the index contain the same information as the navigation tree, you can set this option to YES if you also set 'GENERATE NAVIGATION TREEVIEW' to YES. The default value is: NO This tag requires the tag 'GENERATE HTML' is set to YES DOCBOOK-OUTPUT This tag is used to specify the location for the DocBook output. If a relative path is entered the value of 'OUTPUT DIRECTORY' will be prepended. The default directory is: docbook This tag requires the tag 'GENERATE DOCBOOK' is set to YES DOCBOOK-PROGRAM-LISTING If this tag is set DoxyPress will include the program listings, including syntax highlighting and cross-referencing information, to the Docbook output. Enabling this tag will significantly increase the size of the documentation. The default value is: NO This tag requires the tag 'GENERATE DOCBOOK' is set to YES DOCSET-BUNDLE-ID This tag specifies a string which should uniquely identify the documentation set bundle. The ID is a reversed domain name like com.mycompany.MyDocSet. DoxyPress will append .docset to the ID. The default value is: org.doxypress.Project This tag requires the tag 'GENERATE DOCSET' is set to YES DOCSET-FEEDNAME This tag determines the name of the docset feed. A documentation feed provides a name under which multiple documentation sets from a single provider (such as a company or product suite) can be grouped. The default value is: DoxyPress generated docs This tag requires the tag 'GENERATE DOCSET' is set to YES DOCSET-PUBLISHER-ID This tag is used to specify a string which should uniquely identify the documentation publisher. The ID is a reversed domain name like com.mycompany.MyDocSet.documentation. The default value is: org.doxypress.Publisher This tag requires the tag 'GENERATE DOCSET' is set to YES DOCSET-PUBLISHER-NAME This tag identifies the documentation publisher. The default value is: Publisher. This tag requires the tag 'GENERATE DOCSET' is set to YES DOT-CALL If this tag is set a call dependency graph for every global function or class method will be generated. Call graphs can be enabled for selected functions by using the \callgraph command. If this tag is enabled use the \hidecallgraph command to prevent a call graph from being generated. The default value is: NO This tag requires the tag 'HAVE DOT' is set to YES DOT-CALLED-BY If this tag is set a caller dependency graph will be generated for every global function or class method. Caller graphs can be enabled for selected functions by using the \callergraph command. If this tag is enabled use the \hidecallergraph command to prevent a caller graph from being generated. The default value is: NO This tag requires the tag 'HAVE DOT' is set to YES DOT-CLASS-GRAPH If this tag is set DoxyPress will generate a graph for each documented class showing the direct and indirect inheritance relations. Setting this tag to YES will force the 'CLASS DIAGRAMS' tag to NO. The default value is: YES This tag requires the tag 'HAVE DOT' is set to YES DOT-CLEANUP If this tag is set DoxyPress will remove the intermediate dot files which are used to generate the various graphs. The default value is: YES This tag requires the tag 'HAVE DOT' is set to YES DOT-COLLABORATION If this tag is set DoxyPress will generate a graph for each documented class showing the direct and indirect implementation dependencies (inheritance, containment, and class references variables) of the class with other documented classes. The default value is: YES This tag requires the tag 'HAVE DOT' is set to YES DOT-FILE-DIRS This tag is used to specify one or more directories containing dot files which are included in the documentation. Refer to the \dotfile command. This tag requires the tag 'HAVE DOT' is set to YES DOT-FONT-NAME This tag specifies a different font for the dot program. The path can be set using the 'DOT FONT PATH' tag. The default value is: Helvetica This tag requires the tag 'HAVE DOT' is set to YES DOT-FONT-PATH The dot program will use the default font as specified by 'DOT FONT NAME'. If a font name is specified then this tag will be used as the path to locate the font file. This tag requires the tag 'HAVE DOT' is set to YES DOT-FONT-SIZE This tag can be used to set the size (in points) of the font of dot graphs. Minimum: 4, Maximum: 24, Default: 10 This tag requires the tag 'HAVE DOT' is set to YES DOT-GRAPH-MAX-NODES This tag sets the maximum number of nodes shown in the graph. If the number of nodes is larger than this tag value the graph will be truncated. If the number of direct children of the root node is already larger than this tag value, the graph will not be shown at all. The size of the graph can be further restricted by 'DOT MAX GRAPH DEPTH'. Minimum: 0, Maximum: 10000, Default: 50 This tag requires the tag 'HAVE DOT' is set to YES DOT-GRAPH-MAX-DEPTH This tag is used to set the maximum depth of the graphs generated by the dot program. A depth value of 3 means only nodes reachable from the root in no more than 3 steps will be shown. Nodes which are further from the root node will be omitted. Setting this option to 1 or 2 may reduce the computation time needed for large code bases. The size of a graph can be further restricted by 'DOT GRAPH MAX NODES'. Using a depth of 0 means no depth restriction. Minimum: 0, Maximum: 1000, Default: 0 This tag requires the tag 'HAVE DOT' is set to YES DOT-HIERARCHY If this tag is set a graphical hierarchy of all classes will be shown instead of a textual one. The default value is: YES This tag requires the tag 'HAVE DOT' is set to YES DOT-IMAGE-FORMAT This tag is used to specify the image format generated by the dot program. If svg is selected 'HTML FILE EXTENSION' should be set to 'xhtml' in order to ensure the images files are visible in all browsers. Possible values are: png, jpg, gif or svg. The default value is: png This tag requires the tag 'HAVE DOT' is set to YES DOT-INCLUDE If this tag plus 'ENABLE PREPROCESSING' and 'SEARCH INCLUDES' are set to YES, DoxyPress will generate a graph for each documented file showing the direct and indirect include dependencies of the file with other documented files. The default value is: YES This tag requires the tag 'HAVE DOT' is set to YES DOT-INCLUDED-BY If this tag plus 'ENABLE PREPROCESSING' and 'SEARCH INCLUDES' are set to YES, DoxyPress will generate a graph for each documented file showing the direct and indirect include dependencies of the file with other documented files. The default value is: YES This tag requires the tag 'HAVE DOT' is set to YES DOT-MULTIPLE-TARGETS Set this tag to allow the dot program to generate multiple output files in one run. Setting this tag to YES makes dot run faster. Only versions of dot 1.8.10 or newer support this feature. The default value is: NO This tag requires the tag 'HAVE DOT' is set to YES DOT-NUM-THREADS This tag specifies the number of dot invocations DoxyPress is allowed to run in parallel. If the value is zero, DoxyPress will select a value based on the number of processors available in the system. Minimum: 0, Maximum: 32, Default: 0 This tag requires the tag 'HAVE DOT'is set to YES DOT-PATH This tag is used to specify the path where the dot program is located. If left blank DoxyPress will search the users path. This tag requires the tag 'HAVE DOT' is set to YES DOT-TRANSPARENT Set this tag to generate images with a transparent background. Depending on your platform, enabling this option may lead to unreadable anti-aliased labels on the edges of a graph. The default value is: NO This tag requires the tag 'HAVE DOT' is set to YES DUPLICATE-DOCS If member grouping is used in the documentation and this tag is set, DoxyPress will reuse the documentation of the first member in the group (if any) for the other members of the group. By default all members of a group must be documented explicitly. The default value is: NO ECLIPSE-DOC-ID A unique identifier for the Eclipse help plugin. When installing the plugin the directory name containing the HTML and XML files should also have this name. Each documentation set should have its own identifier. The default value is: org.doxypress.Project This tag requires the tag 'GENERATE ECLIPSE HELP' is set to YES ENABLE-PREPROCESSING If this tag is set DoxyPress will evaluate all C preprocessor directives found in the source and include files. The default value is: YES ENABLED-SECTIONS This tag is used to enable conditional documentation by marking a section with one of the following: \if <section_label> ... \endif \cond <section_label> ... \endcond ENUM-VALUES-PER-LINE This tag is used to set the number of enum values DoxyPress will group on one line in the generated HTML documentation. A value of 0 will completely suppress the enum values from appearing in the overview section. Minimum: 0, Maximum: 20, Default: 4 This tag requires the tag 'GENERATE HTML' is set to YES EXAMPLE-PATTERNS If the value of the 'EXAMPLE FILES OR DIRECTORIES' tag contains directories then this tag is used to specify one or more wildcard patterns like *.cpp or *.h to filter out the source files in the example directories. The default value is: * EXAMPLE-RECURSIVE If this tag is set then example source code will be searched recursively for the \include or \dontinclude commands. This search will occur even if the 'INPUT, SCAN RECURSIVELY' tag is set to NO. The default value is: NO EXAMPLE-SOURCE This tag is used to specify full file names or directories which contain example code fragments. Refer to the \include command. EXCLUDE-FILES This tag is used to specify files or directories which should be excluded from the 'INPUT SOURCE' tag. The relative paths are relative to the directory from which DoxyPress is run. EXCLUDE-PATTERNS If the 'INPUT SOURCE' tag contains directories, this tag will be used to specify wildcard patterns to exclude certain files from those directories. Wildcards are matched using the absolute path. As an example, to exclude all test directories use the pattern ‌/test/‌ EXCLUDE-SYMBOLS This tag is used to specify symbol names, namespaces, classes, functions, etc. which should be excluded from the documentation. Examples: FooNamespace, BarClass, FooNamespace::BarClass, FooNamespace::*Test EXCLUDE-SYMLINKS This tag is used to select if symbolic links are excluded from the input. The default value is: NO EXPAND-AS-DEFINED If the 'MACRO EXPANSION' and 'EXPAND ONLY PREDEFINED MACROS' tags are set to YES, this tag is used to specify a list of macro names which should be expanded. DoxyPress will use the macro definitions found in your source code. Use the 'PREDEFINED MACROS' tag to specify a different macro definition. This tag requires the tag 'ENABLE PREPROCESSING' is set to YES EXPAND-ONLY-PREDEFINED If this tag and 'MACRO EXPANSION' are both set to YES, the macro expansion is limited to the macros specified by 'PREDEFINED MACROS' and 'EXPAND AS DEFINED' tags. The default value is: NO This tag requires the tag 'ENABLE PREPROCESSING' is set to YES EXTERNAL-GROUPS If this tag is set all external groups will be listed in the modules index. If set to NO only the current project's groups will be listed. The default value is: YES EXTERNAL-LINKS-IN-WINDOW If this tag is set DoxyPress will open links to external symbols imported via tag files in a separate window. The default value is: NO This tag requires the tag 'GENERATE HTML' is set to YES EXTERNAL-PAGES If this tag is set all external pages will be listed in the related pages index. If set to NO only the current project's pages will be listed. The default value is: YES EXTRACT-ALL If this tag is set DoxyPress will assume all entities are documented. Private class members and static file members will be hidden unless the 'EXTRACT PRIVATE' or the 'EXTRACT STATIC' tags are set to YES. Setting this tag will disable warnings about undocumented members. The default value is: NO EXTRACT-ANON-NAMESPACES If this tag is set the members of anonymous namespaces will be extracted and appear as a namespace called 'anonymous-namespace{file}'. The value for 'file' will be replaced with the base name of the file which contains the anonymous namespace. By default anonymous namespaces are hidden. The default value is: NO EXTRACT-LOCAL-CLASSES If this tag is set then classes and structs defined locally in source files will be included in the documentation. If set to NO, only classes defined in header files are included. This tag has no effect on Java source code. The default value is: YES EXTRACT-LOCAL-METHODS This tag is only useful for Objective-C source code. If set then local methods, which are defined in the implementation section but not in the interface, are included in the documentation. If set to NO only methods in the interface are included. The default value is: NO EXTRACT-PACKAGE If this tag is set then all members with package or internal scope will be included in the documentation. The default value is: NO EXTRACT-PRIVATE If this tag is set then all private members of a class will be included in the documentation. The default value is: NO EXTRACT-STATIC If this tag is set then all static members of a file will be included in the documentation. The default value is: NO FILE-VERSION-FILTER This tag is used to specify a program which should invoke to obtain the current version for each file. DoxyPress will invoke this program and pass a file name as the input parameter. The value written to standard output is used as the file version. FILTER-PATTERNS This tag is used to specify filter programs based on a wildcard match. DoxyPress will compare source file names with the wildcards and apply the filter program if there is a match. If this tag is empty or none of the wildcards match, then the program specified by the 'FILTER PROGRAM NAME' will be used. The filter programs are listed in the format: wildcard=filter program Example: *.cpp=my_cpp_filter FILTER-PROGRAM This tag is used to specify a program which is called to filter each input file. DoxyPress will invoke the filter program and pass the input file name as the first parameter. The filter program must not add or remove lines and is run before the source code is scanned, not when the documentation output code is generated. The output of the filter program will be used instead of your original source code. Custom file extensions need to be defined in the 'LANGUAGE MAPPING' tag. FILTER-SOURCE-FILES If this tag is set the program specified in the 'FILTER PROGRAM NAME' tag will be used to filter the input source files when generating source documentation. The default value is: NO FILTER-SOURCE-PATTERNS This tag is used to specify filter programs based on a wildcard match. DoxyPress will compare each source file name with the list of wildcards and apply the filter program which matches. This tag will override the 'SELECT FILTER PROGRAM BY WILDCARD'. Example: *.c=some_c_filter, *.h= The first pattern specifies which filter program to use for every *.c file. The second pattern specifies not to use a filter program for any header file. This tag requires the tag 'FILTER SOURCE CODE FILES' is set to YES FORCE-LOCAL-INCLUDES If this tag is set DoxyPress will list include files with double quotes instead of less than and greater than symbols. The default value is: NO FORMULA-FONTSIZE Use this tag to change the font size of LaTeX formulas included as images in the HTML documentation. If the font size is changed, ensure there are no existing form_*.png images in the HTML output directory. This will force DoxyPress to regenerate the images the next time it is run. Minimum: 8, Maximum: 50, Default: 10 This tag requires the tag 'GENERATE HTML' is set to YES FORMULA-TRANSPARENT If this tag is set transparent PNGs will be used in formulas. Transparent PNGs may not be supported properly in older browsers. If this tag is modified make sure to delete all files named form_*.png in the HTML output directory. The default value is: YES This tag requires the tag 'GENERATE HTML' is set to YES FULL-PATH-NAMES If this tag is set DoxyPress will prepend the full path before file names in the file list and in the header files. If set to NO, the shortest path which makes the file name unique will be used. The default value is: YES GENERATE-BUG-LIST This tag is used to enable (YES) or disable (NO) the bug list. This list is created by putting \bug commands in the documentation. The default value is: YES GENERATE-CHI This tag controls if a separate .chi index file is generated (YES) or if should be included in the master .chm file (NO). The default value is: NO This tag requires the tag 'GENERATE HTML HELP' is set to YES GENERATE-CHM If this tag is set three additional HTML index files will be generated: index.hhp, index.hhc, and index.hhk. The index.hhp is a project file used by by Microsoft's HTML Help Workshop on Windows. HTML Help Workshop contains a compiler to convert the HTML output into a single compiled HTML .chm file. The default value is: NO This tag requires the tag 'GENERATE HTML' is set to YES GENERATE-DEPRECATE-LIST This tag is used to enable (YES) or disable (NO) the deprecated list. This list is created by putting \deprecated commands in the documentation. The default value is: YES GENERATE-DOCBOOK If this tag is set Docbook files will be generated. These files can be used to generate a PDF. The default value is: NO GENERATE-DOCSET If this tag is set additional index files will be generated which can be used as input for Apple's Xcode IDE. DoxyPress will generate a Makefile in the HTML output directory. Running make will produce the docset and running make install will install the docset. The default value is: NO This tag requires the tag 'GENERATE HTML' is set to YES GENERATE-ECLIPSE If this tag is set additional index files will be generated with the HTML files to create an Eclipse help plugin. To install the plugin the contents of the directory containing the HTML and XML files must be copied into the plugins directory of eclipse. The name of the directory within the plugins directory should be the same as the 'ECLIPSE DOC ID'. The default value is: NO This tag requires the tag 'GENERATE HTML' is set to YES GENERATE-HTML If this tag is set HTML output will be generated. The default value is: YES GENERATE-LATEX If this tag is set DoxyPress will generate LaTeX output. The default value is: YES GENERATE-LEGEND If this tag is set DoxyPress will generate a legend page explaining the meaning of the various boxes and arrows in the dot generated graphs. The default value is: YES This tag requires the tag 'HAVE DOT' is set to YES GENERATE-MAN If this tag is set man pages for classes and files will be generated. The default value is: NO GENERATE-PERL If this tag is set DoxyPress will generate a Perl module file which contains the structure of the code including all documentation. This feature is currently experimental. The default value is: NO GENERATE-QTHELP If this tag is set and both 'QHP NAMESPACE' and 'QHP VIRTUAL FOLDER' are set, an additional index file will be generated. This file can be used as input for qhelpgenerator to create a Compressed Help file (.qch) from the generated HTML documentation. The default value is: NO This tag requires the tag 'GENERATE HTML' is set to YES GENERATE-RTF If this tag is set RTF output will be generated. The default value is: NO GENERATE-TAGFILE When a file name is specified DoxyPress will create a tag file based on the input files. Refer to Linking to external documentation. GENERATE-TEST-LIST This tag is used to enable (YES) or disable (NO) the test list. This list is created by putting \test commands in the documentation. The default value is: YES GENERATE-TODO-LIST This tag is used to enable (YES) or disable (NO) the todo list. This list is created by putting \todo commands in the documentation. The default value is: YES GENERATE-TREEVIEW This tag is used to specify whether a tree index will be displayed in the HTML output. The default value is: NO This tag requires the tag 'GENERATE HTML' is set to YES GENERATE-XML If this tag is set XML documentation will be generated. The default value is: NO GHOSTSCRIPT This tag specifies the full path and file name for the GhostScript program. This tag requires the tag 'GENERATE HTML' is set to YES GROUP-GRAPHS If this tag is set DoxyPress will generate a graph for groups, showing the direct groups dependencies. The default value is: YES This tag requires the tag 'HAVE DOT' is set to YES GROUP-NESTED-COMPOUNDS If this tag is enabled then nested classes or structures will be in the same group the parent class or structure is located. If disabled nested classes or structures can be added explicitly using the \ingroup command. The default value is: NO HAVE-DOT If this tag is set DoxyPress will expect the dot program is available from your path. This program is part of Graphviz which is a graph visualization toolkit from AT&T and Lucent Bell Labs. The default value is: NO HHC-LOCATION This tag is used to specify the location (absolute path including file name) of the HTML help compiler (hhc.exe). If non-empty, DoxyPress will try to run the HTML help compiler on the generated index.hhp. The file has to be specified with full path. This tag requires the tag 'GENERATE HTML HELP' is set to YES HIDE-COMPOUND-REF If this tag is set to NO, DoxyPress will append additional text to a page's title, such as Class Reference. If set to YES the compound reference will be hidden. The default value is: NO HIDE-FRIEND-COMPOUNDS If this tag is set to YES DoxyPress will hide all friend class, struct, or union declarations. If set to NO these declarations will be included in the documentation. The default value is: NO HIDE-IN-BODY-DOCS If this tag is set DoxyPress will hide any documentation blocks found inside the body of a function. If set to NO, these blocks will be appended to the function's detailed documentation block. The default value is: NO HIDE-NAVTREE-MEMBERS If this tag is set to YES, then members will not be shown in the navigation treeview. The default value is: NO HIDE-SCOPE-NAMES If this tag is set to NO then members will be shown with their full class and namespace scopes in the documentation. If set to YES, the scope will be hidden. The default value is: NO HIDE-UNDOC-CLASSES If this tag is set DoxyPress will hide all undocumented classes which are normally visible in the class hierarchy. If set to NO, these classes will be included in the various overviews. This tag has no effect if 'EXTRACT ALL' is set to YES. The default value is: NO HIDE-UNDOC-MEMBERS If this tag is set DoxyPress will hide all undocumented members inside documented classes or files. If set to NO, these members will be included in the various overviews, but no documentation section is generated. This tag has no effect if 'EXTRACT ALL' is set to YES. The default value is: NO HIDE-UNDOC-RELATIONS If this tag is set the inheritance and collaboration graphs will hide inheritance and usage relations if the target is undocumented or is not a class. The default value is: YES HTML-COLORSTYLE-HUE This tag controls the color of the HTML output. DoxyPress will adjust the colors in the stylesheet and background images according to this color. Minimum: 0, Maximum: 359, Default: 220 This tag requires the tag 'GENERATE HTML' is set to YES HTML-COLORSTYLE-GAMMA This controls the gamma correction applied to the luminance component of the colors in the HTML output. Minimum: 40, Maximum: 240, Default: 80 This tag requires the tag 'GENERATE HTML' is set to YES HTML-COLORSTYLE-SAT This tag controls the purity (or saturation) of the colors in the HTML output. Minimum: 0, Maximum: 255, Default: 100 This tag requires the tag 'GENERATE HTML' is set to YES HTML-DYNAMIC-SECTIONS If this tag is set then the generated HTML documentation will contain sections which can be hidden and shown after the page has loaded. The default value is: NO This tag requires the tag 'GENERATE HTML' is set to YES HTML-EXTRA-FILES This tag is used to specify one or more extra images or source files which should be copied to the 'HTML OUTPUT DIRECTORY'. To access the extra files in the 'HTML HEADER FILE' or 'HTML FOOTER FILE', prepend$relpath^ to the file name. In a CSS stylesheet specify only the file name.

This tag requires the tag 'GENERATE HTML' is set to YES

HTML-FILE-EXTENSION

This tag is used to specify the file extension for each generated HTML page. For example: .html, .php, or .asp.

The default value is: .html

This tag requires the tag 'GENERATE HTML' is set to YES

HTML-FOOTER

This tag is used to specify an user defined HTML footer for each generated HTML page. If left blank DoxyPress will use a standard footer.

To create a new footer file run DoxyPress --w html-foot [footer file name]

This tag requires the tag 'GENERATE HTML' is set to YES

This tag is used to specify a user-defined HTML header file for each generated HTML page. If left blank DoxyPress will generate a standard header.

This tag requires the tag 'GENERATE HTML' is set to YES

HTML-INDEX-NUM-ENTRIES

This tag defines the preferred number of entries shown in the various tree structured indices. DoxyPress will expand the tree until the specified number of entries are visible. Setting this value to 1 will produce a fully collapsed tree. A value of 0 will result in a fully expanded tree.

Minimum: 0, Maximum: 9999, Default: 100

This tag requires the tag 'GENERATE HTML' is set to YES

HTML-OUTPUT

This tag is used to specify the location for the HTML output. If a relative path is entered the value of 'OUTPUT DIRECTORY' will be prepended.

The default directory is: html

This tag requires the tag 'GENERATE HTML' is set to YES

HTML-SEARCH

When this tag is set DoxyPress will generate a search box for the HTML output. The search engine uses JavaScript and DHTML. If this search engine is too slow try using the 'SEARCH SERVER BASED'.

The default value is: YES

This tag requires the tag 'GENERATE HTML' is set to YES

HTML-STYLESHEETS

This tag is used to specify additional custom css files which will be included after the standard 'doxy-style.css' file. DoxyPress will automatically copy any css files listed in this tag to the 'HTML OUTPUT DIRECTORY'.

The order of the css files is important. The last stylesheet will override the settings of any previous stylesheets.

This tag requires the tag 'GENERATE HTML' is set to YES

HTML-TIMESTAMP

If this tag is set to YES, the footer of each generated HTML page will contain the date and time when the page was generated.

The default value is: YES

This tag requires the tag 'GENERATE HTML' is set to YES

IDL-SUPPORT

For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. If this option is set DoxyPress will replace the get and set methods by a property in the documentation. This only works if the methods are getting or setting a simple type. If you want to show the methods anyway, set this option to NO.

The default value is: YES

IGNORE-PREFIX

This tag is used to define a prefix or a list of prefixes, which should be ignored while generating the index headers. This is useful when several classes start with a common prefix as too many entries would appear under the same letter in the alphabetical index.

This tag requires the tag 'ALPHABETICAL INDEX' is set to YES

IMAGE-PATH

This tag can be used to specify one or more files or directories which contain images to be included in the documentation.

Refer to the \image command.

INCLUDE-PATTERNS

This tag is used to specify wildcard patterns (like *.h) to filter out the header files in the directories. If left blank, the patterns specified with the 'INPUT FILE PATTERNS' tag will be used.

This tag requires the tag 'ENABLE PREPROCESSING' is set to YES

INCLUDE-PATH

This tag is used to specify one or more directories which contain include files.

This tag requires the tag 'SEARCH INCLUDES' is set to YES

INHERIT-DOCS

If this tag is set then an undocumented member inherits the documentation from any documented member which it re-implements.

The default value is: YES

INLINE-GROUPED-CLASSES

When this tag is set classes, structs, and unions are shown inside the group in which they are included. Use the \ingroup command instead of a separate page (for HTML and Man pages) or section (for LaTeX and RTF).

This feature does not work in combination with 'SEPARATE MEMBER PAGES'

The default value is: NO

INLINE-INFO

If this tag is set then '[inline]' is displayed for inline members.

The default value is: YES

INLINE-INHERITED-MEMBER

If this tag is set DoxyPress will show all inherited members of a class in the documentation of that class as if those members were ordinary class members. Constructors, destructors and assignment operators of the base classes will not be shown.

The default value is: NO

INLINE-SIMPLE-STRUCT

When this tag is set structs, classes, and unions with only public data fields or simple typedef fields, will be shown inline in the documentation of the scope in which they are defined. If this tag is set to NO then structs, classes, and unions are shown on a separate page (for HTML and Man pages) or section (for LaTeX and RTF).

The default value is: NO

INLINE-SOURCE

Setting this tag will include the body of functions, classes and enums directly into the documentation.

The default value is: NO

INTERACTIVE-SVG

If 'DOT IMAGE FORMAT' is set to svg, this option can be set to YES to enable the generation of interactive svg images to allow zooming and panning. If svg is selected 'HTML FILE EXTENSION' should be set to 'xhtml' in order to ensure the images files are visible in all browsers.

The default value is: NO

This tag requires the tag 'HAVE DOT' is set to YES

INTERNAL-DOCS

This tag determines if documentation which is typed after an \internal command is included in the documentation. Set to YES to include the internal documentation, set to NO, to exclude the documentation.

The default value is: NO

INPUT-ENCODING

This tag is used to specify the character encoding of the source files which are parsed.

The default value is: UTF-8

INPUT-PATTERNS

If the 'INPUT SOURCE' tag contains directories then this tag is used to specify wildcard patterns. Files matching these patterns will be processed by DoxyPress as source. Custom file extensions need to be defined in the 'LANGUAGE MAPPING' tag.

The default values are: *.as, *.c, *.cc, *.cpp, *.cxx, *.c++, *.cs, *.d, *.ddl, .dox, *.for, *.f, *.f90, *.h, *.hh, *.hxx, *.hpp, *.h++, *.idl, *.ii, *.ixx, .ipp, *.i++, *.inc, *.inl, *.java, *.js, *.m, *.md, *.mm, *.markdown, .odl, *.php, *.php3, *.php4, *.php5, *.phtml, *.py, *.pyw, *.qsf, *.tcl, *.ucf

INPUT-RECURSIVE

This tag can be used to specify whether or not subdirectories should be searched for input files.

The default value is: NO

INPUT-SOURCE

This tag is used to specify full file names or directories containing source files to be processed. Wildcards are not permitted.

If this tag is empty only the current directory is searched.

If this tag is set DoxyPress will interpret the first sentence of a JavaDoc style comment as the brief description. If set to NO, an explicit @brief command is required.

The default value is: NO

LANGUAGE-MAPPING

DoxyPress selects the language parser depending on the extension of the files it is parsing. Use this tag to assign a specific parser to use for a given file extension. The format for this tag is ext=language, where ext is a file extension and language is one of the parsers supported by DoxyPress.

The supported parsers are: C, C++, C#, IDL, Java, JavaScript, Objective-C, PHP, Python, Fortran, FortranFixed, FortranFree.

As an example, to treat .f files as C (default is Fortran), use: f=C

For files with no extensions use no-extension as a placeholder. For custom extensions modify 'INPUT FILE PATTERNS', otherwise these files will not be read by DoxyPress.

LATEX-BATCH-MODE

If this tag is set DoxyPress will add the \batchmode command to the generated LaTeX files. This will instruct LaTeX to keep running if errors occur. This option is also used when generating formulas in HTML.

The default value is: NO

This tag requires the tag 'GENERATE LATEX' is set to YES

LATEX-BIB-STYLE

This tag is used to specify the style to use for the bibliography, plainnat, or IEEEtranN, etc. Refer to the \cite command.

The default value is: plain

This tag requires the tag 'GENERATE LATEX' is set to YES

LATEX-CMD-NAME

This tag is used to specify the LaTeX command name to be invoked.

When 'USE PDF LATEX' is set, this option is only used for generating bitmaps for formulas in the HTML output.

The default file is: latex

This tag requires the tag 'GENERATE LATEX' is set to YES

LATEX-COMPACT

If this tag is set DoxyPress generates compact LaTeX documents.

The default value is: NO

This tag requires the tag 'GENERATE LATEX' is set to YES

LATEX-EXTRA-FILES

This tag is used to specify one or more extra images or other source files which should be copied to the 'LATEX OUTPUT DIRECTORY' directory. The files will be copied verbatim.

This tag requires the tag 'GENERATE LATEX' is set to YES

LATEX-EXTRA-PACKAGES

This tag is used to specify one or more LaTeX packages to include in the LaTeX output. Each entry can be a package name or the literal argument passed to the \usepackage command. As an example, to use the times font in your LaTeX output specify either 'times' or '{times}' for this tag.

If this tag is blank no extra packages will be included.

This tag requires the tag 'GENERATE LATEX' is set to YES

LATEX-FOOTER

This tag is used to specify a user-defined LaTeX footer for the generated LaTeX document. If left blank DoxyPress will generate a standard footer. The footer should contain everything after the last chapter.

To create a new footer file run DoxyPress --w latex-foot [footer file name]

This tag requires the tag 'GENERATE LATEX' is set to YES

This tag is used to specify a user-defined LaTeX header file for the generated LaTeX document.

The header should contain everything until the first chapter. The following commands have a special meaning: $title,$datetime, $date,$DoxyPressversion, $projectname,$projectnumber, $projectbrief,$projectlogo. DoxyPress will replace $title with the empty string for the replacement values of the other commands the user is referred to 'HTML HEADER FILE'. If this tag is blank DoxyPress will generate a standard header. To create a new header file run DoxyPress --w latex-head [header file name] This tag requires the tag 'GENERATE LATEX' is set to YES LATEX-HIDE-INDICES If this tag is set DoxyPress will not include the index chapters such as File Index, Compound Index, etc. in the output. The default value is: NO This tag requires the tag 'GENERATE LATEX' is set to YES LATEX-HYPER-PDF If this tag is set the generated LaTeX is prepared for conversion to PDF using ps2pdf or pdflatex. The PDF file will contain links instead of page references. The default value is: YES This tag requires the tag 'GENERATE LATEX' is set to YES LATEX-OUTPUT This tag is used to specify the location for the LaTeX output. If a relative path is entered the value of 'OUTPUT DIRECTORY' will be prepended. The default directory is: latex This tag requires the tag 'GENERATE LATEX' is set to YES LATEX-PAPER-TYPE This tag is used to set the paper type used by the printer. Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 14 inches) and executive (7.25 x 10.5 inches). The default value is: a4 This tag requires the tag 'GENERATE LATEX' is set to YES LATEX-PDF If this tag is set DoxyPress will use the pdflatex program to generate the PDF file directly from the LaTeX files. Set this option to obtain higher quality PDF documentation. The default value is: YES This tag requires the tag 'GENERATE LATEX' is set to YES LATEX-PS Setting this option will disable latex PDF output. This tag requires the tag 'GENERATE LATEX' is set to YES LATEX-SOURCE-CODE If this tag is set DoxyPress will include source code with syntax highlighting in the LaTeX output. Which sources are shown depend on other settings such as 'SOURCE CODE' The default value is: NO This tag requires the tag 'GENERATE LATEX' is set to YES LATEX-STYLESHEETS This tag is used to specify additional custom style sheets which will be included after the standard stylesheets. DoxyPress will automatically copy any files listed in this tag to the 'LATEX OUTPUT DIRECTORY'. The order of stylesheets is important. The last stylesheet will override the settings of any previous stylesheets. This tag requires the tag 'GENERATE LATEX' is set to YES LATEX-TIMESTAMP If this tag is set the footer page will contain the date and time when the page was generated. The default value is: NO This tag requires the tag 'GENERATE LATEX' is set to YES LAYOUT-FILE This tag is used to specify a layout file. The layout file controls the global structure of the generated output files. To create a new layout file run DoxyPress --l [layout file name] If DoxyPress is run from a directory containing a file called DoxyPress_Layout.xml, DoxyPress will parse it automatically even if this tag is left empty. LOOKUP-CACHE-SIZE The size of the symbol lookup cache can be set using this tag. If the cache is too small DoxyPress may run slower. At the end of a run DoxyPress will report the cache usage and suggest the optimal cache size. Minimum: 0, Maximum: 9, Default: 0 MACRO-EXPANSION If this tag is set DoxyPress will expand all macro names in the source code. If set to NO, only conditional compilation will be performed. Macro expansion can be done in a controlled way by setting 'EXPAND ONLY PREDEFINED MACROS' to YES. The default value is: NO This tag requires the tag 'ENABLE PREPROCESSING' is set to YES MAKE-INDEX-CMD-NAME This tag is used to specify the command name to generate an index for LaTeX. The default file is: makeindex This tag requires the tag 'GENERATE LATEX' is set to YES MAN-EXTENSION This tag determines the extension which is added to the generated man pages. In case the manual section does not start with a number, the number 3 is prepended. The dot (.) at the beginning of this tag is optional. The default value is: .3 This tag requires the tag 'GENERATE MAN' is set to YES MAN-LINKS If this tag is set then for each entity documented in the man pages, one additional file will be generated linking the name of the entity with the correct man page. The default value is: NO This tag requires the tag 'GENERATE MAN' is set to YES MAN-OUTPUT This tag is used to specify the location for the man page output. If a relative path is entered the value of 'OUTPUT DIRECTORY' will be prepended. A directory named man3 will be created inside the directory specified by this tag. The default directory is: man This tag requires the tag 'GENERATE MAN' is set to YES MAN-SUBDIR This tag determines the name of the directory created under the value for the 'MAN PAGE OUTPUT DIRECTORY' tag. The default directory will be man3. This tag requires the tag 'GENERATE MAN' is set to YES MAIN-PAGE-NAME This tag is used to specify an input file name which should be used for the index page. The file name will not be included in the navigation treeview file listing if FILES is enabled. MAIN-PAGE-OMIT If this tag is set the index page will not be included in the navigation treeview. The default value is: NO MARKDOWN If this tag is set DoxyPress will preprocess all comments according to the Markdown format. You can mix Markdown, HTML, and XML commands. The default value is: YES MATHJAX-CODEFILE This tag is used to specify a file with JavaScript fragments which will be used during startup of the MathJax code. This tag requires the tag 'USE MATHJAX' is set to YES MATHJAX-EXTENSIONS This tag is used to specify one or more MathJax extension names which will be enabled during MathJax rendering. For example: TeX/AMSmath, TeX/AMSsymbols This tag requires the tag 'USE MATHJAX' is set to YES MATHJAX-FORMAT This tag is used to set the default output format to be used for the MathJax output. Possible values are: HTML-CSS (which is slower, but has the best compatibility), NativeMML (i.e. MathML) and SVG. The default value is: HTML-CSS This tag requires the tag 'USE MATHJAX' is set to YES MATHJAX-RELPATH When MathJax is enabled specify the location relative to the HTML output directory using the 'MATHJAX RELATIVE PATH' tag. The destination directory should contain the MathJax.js script. For example, if the mathjax directory is located at the same level as the HTML output directory, then this tag should be ../mathjax. The default value points to the MathJax Content Delivery Network so you can quickly see the result without installing MathJax. The default value is: "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/" This tag requires the tag 'USE MATHJAX' is set to YES MAX-INIT-LINES This tag specifies the maximum number of lines which are displayed in the documentation for the definition of variable or a macro. If the variable or macro consists of more lines than specified in this tag, the entire initializer will be hidden. This tag can be overridden on a per variable or macro basis by using the \showinitializer or \hideinitializer command. A value of 0 will hide initializers completely. Minimum: 0, Maximum: 10000, Default: 30 MDFILE-MAINPAGE This tag refers to the name of a markdown file which is part of the input. The contents of the file will be placed on the main index.html page. MSC-FILE-DIRS This tag is used to specify one or more directories containing msc files included in the documentation. Refer to the \mscfile command. MSCGEN-PATH Message sequence charts can be defined within DoxyPress comments using the \msc command. DoxyPress will run the mscgen program to produce the chart and insert it in the documentation. This tag is used to specify the directory where the mscgen program is located. If left empty the default path will be searched. MULTILINE-CPP-BRIEF If this tag is set DoxyPress will treat a multi-line C++ special comment block (a block of //! or /// comments) as a brief description. The default is to treat a multi-line C++ special comment block as a detailed description. Setting this tag to YES, means Rational Rose comments are not recognized. The default value is: NO NS-ALIAS This tag is used to specify a list of namespaces which should be renamed in the documentation. The format for this tag is: namespace=alias As an example, boost::thread=bt will replace 'boost::thread' everywhere it occurs in your documentation with the value of 'bt'. OPTIMIZE-C Set this tag if your project consists of PHP or C source code. DoxyPress will generate documentation tailored for these languages. The default value is: NO OPTIMIZE-CPLUS Set this tag to optimize for C++. The default value is: YES OPTIMIZE-FORTRAN Set this tag if your project consists of Fortran source code. DoxyPress will generate documentation tailored for Fortran. The default value is: NO OPTIMIZE-JAVA Set this tag if your project consists of Java or C# source code. DoxyPress will generate documentation tailored for these languages. The default value is: NO OPTIMIZE-PYTHON Set this tag if your project consists of Python source code. DoxyPress will generate documentation tailored for Python. The default value is: NO OUTPUT-DIR This tag is used to specify the relative or absolute path where the generated documentation will be written. If a relative path is entered it will be relative to the location where DoxyPress was started. If left blank the current directory will be used. OUTPUT-LANGUAGE This tag is used to specify the language for the generated documentation. Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian and Vietnamese. The default value is: English PERL-LATEX If this tag is set DoxyPress will generate the necessary Makefile rules, Perl scripts, and LaTeX code to be able to generate PDF and DVI output from the Perl module output. The default value is: NO This tag requires the tag 'GENERATE PERL MODULE' is set to YES PERL-PREFIX The names of the make variables in the generated doxyrules.make file are prefixed with the string contained in 'PERL MODULE MAKEVAR PREFIX'. This is useful so different doxyrules.make files included by the same Makefile do not overwrite each other's variables. This tag requires the tag 'GENERATE PERL MODULE' is set to YES PERL-PRETTY If this tag is set the Perl module output will be formatted so it is readable. If this tag is set to NO, the size of the Perl module output will be much smaller. Perl can parse either format. The default value is: YES This tag requires the tag 'GENERATE PERL MODULE' is set to YES PLANTUML-INC-PATH When using PlantUML the specified paths are searched for files specified by the ! include statement in a plantuml block. PLANTUML-CFG-FILE When using PlantUML this tag can be used to specify a configuration file. PLANTUML-JAR-PATH This tag specifies the path where Java can find the plantuml.jar file. If left blank it is assumed PlantUML is not used or called during a preprocessing step. DoxyPress will generate a warning when it encounters a \startuml command in this case and will not generate output for the diagram. PREDEFINED-MACROS This tag is used to specify one or more macro names which are defined during DoxyPress preprocessor. To prevent a macro definition from being undefined via #undef or recursively expanded, use := instead of the = operator. If the definition and the = are omitted, =1 is assumed. The format for this tag is: name=definition, with no spaces. This tag requires the tag 'ENABLE PREPROCESSING' is set to YES PROJECT-BRIEF This tag is used to specify a single line description which will appear at the top of each generated documentation page. PROJECT-LOGO This tag specifies a logo or icon which is included in the documentation. The height of the logo should not exceed 55 pixels and the width should not exceed 200 pixels. PROJECT-NAME This tag is a single word or a sequence of words surrounded by double quotes which identifies your project. This project name is used in the title of the generated documentation PROJECT-VERSION This tag is used to enter a project number or revision number. QCH-FILE This tag is used to specify the .qch output file name of the QtHelp Generator. This tag requires the tag 'GENERATE QT HELP' is set to YES QHP-CUST-ATTRIB This tag specifies the list of attributes for the custom filter used by QtHelp. This tag requires the tag 'GENERATE QT HELP' is set to YES QHP-CUST-FILTER-NAME This tag specifies the name of a custom filter for the QtHelp output. This tag requires the tag 'GENERATE QT HELP' is set to YES QHP-NAMESPACE This tag specifies the namespace to use when generating QtHelp output. The default value is: org.doxypress.Project This tag requires the tag 'GENERATE QT HELP' is set to YES QHP-SECT-ATTRIB This tag specifies the list of filter section attributes used by QtHelp. This tag requires the tag 'GENERATE QT HELP' is set to YES QHP-VIRTUAL-FOLDER This tag specifies the virtual folder to use when generating QtHelp output. The default value is: doc This tag requires the tag 'GENERATE QT HELP' is set to YES QT-AUTO-BRIEF If this tag is set DoxyPress will interpret the first sentence of a Qt style comment as the brief description. If set to NO an explicit @brief command is required. The default value is: NO QTHELP-GEN-PATH This tag is used to specify the path for the QtHelp Generator. If this tag is empty DoxyPress will search for the qhelpgenerator program in your path. This tag requires the tag 'GENERATE QT HELP' is set to YES QUIET This tag is used to enable (YES) or disable (NO) messages which are generated to standard output. If this tag is set standard messages will be generated. The default value is: NO REF-BY-RELATION If this tag is set, then for each documented entity all documented functions referencing it will be listed. The default value is: NO REF-LINK-SOURCE If this tag is set and 'SOURCE CODE' is set, the hyperlinks from functions in 'REFERENCED BY RELATION' and 'REFERENCES RELATION' will link to the source code. Otherwise, the link will refer to the generated documentation. The default value is: YES REF-RELATION If this tag then for each documented function all documented entities called/used by that function will be listed. The default value is: NO REPEAT-BRIEF If this tag is set DoxyPress will prepend the brief description of a member or function before the detailed description. If 'BRIEF DESCRIPTION' and 'HIDE UNDOCUMENTED MEMBERS' are set to NO, the brief descriptions will be completely suppressed. The default value is: YES RTF-COMPACT If this tag is set DoxyPress generates compact RTF documents. The default value is: NO This tag requires the tag 'GENERATE RTF' is set to YES RTF-EXTENSION This tag is used to set the path to an RTF Extension file. This file contains optional variables used in the generation of an RTF document. To create a sample extension file run DoxyPress --w rtf-ext [extensions file name] This tag requires the tag 'GENERATE RTF' is set to YES RTF-HYPERLINKS If this tag is set the RTF generated will contain hyperlinks. The output may be more suitable for browsing rather than printing. The default value is: NO This tag requires the tag 'GENERATE RTF' is set to YES RTF-OUTPUT This tag is used to specify the location for the RTF output. If a relative path is entered the value of 'OUTPUT DIRECTORY' will be prepended. The default directory is: rtf This tag requires the tag 'GENERATE RTF' is set to YES RTF-SOURCE-CODE If this tag is set DoxyPress will include source code with syntax highlighting in the RTF output. Which source files are shown depend on other settings such as the 'SOURCE CODE' tag. The default value is: NO This tag requires the tag 'GENERATE RTF' is set to YES RTF-STYLESHEET Load stylesheet definitions from file. Refer to DoxyPress Usage for information on how to generate the default stylesheet. This tag requires the tag 'GENERATE RTF' is set to YES SEARCH-DATA-FILE When 'SERVER BASED SEARCH' and 'EXTERNAL SEARCH' are both enabled the unindexed search data is written to a file for indexing by an external program. This tag is used to specify the name of the file. The default file is: searchdata.xml This tag requires the tag 'HTML SEARCH' is set to YES SEARCH-ENGINE-URL This tag references a search engine hosted by a web server which will return the search results when 'EXTERNAL SEARCH' is enabled. Refer to External Searching. This tag requires the tag 'HTML SEARCH' is set to YES SEARCH-EXTERNAL When this tag is enabled DoxyPress will not generate the PHP script for searching. The search results will be written to an XML file which must be processed by an external indexing system. DoxyPress will call the external search engine referenced in the tag 'SEARCH ENGINE URL'. The default value is: NO This tag requires the tag 'HTML SEARCH' is set to YES SEARCH-EXTERNAL-ID When the tags 'SERVER BASED SEARCH' and 'EXTERNAL SEARCH' are both enabled, this tag is used as an identifier. This is useful in combination with 'SEARCH MAPPINGS' to search through multiple projects and redirect the results to the correct project. This tag requires the tag 'HTML SEARCH' is set to YES SEARCH-INCLUDES If this tag is set then files specified in the 'INCLUDE PATH' tag will be searched if the #include directive is found in the source code. The default value is: YES This tag requires the tag 'ENABLE PREPROCESSING' is set to YES SEARCH-MAPPINGS This tag is used to enable searching in multiple DoxyPress projects. Each project needs to have a unique id set via the 'EXTERNAL SEARCH ID' tag. This tag is used to map the id to a relative location where the documentation can be found. The format is: tagname1=loc1 tagname2=loc2 ... This tag requires the tag 'HTML SEARCH' is set to YES SEARCH-SERVER-BASED When this tag is set the search engine will be implemented using a web server instead of a web client using JavaScript. There are two flavors of web server based searching depending on on the 'EXTERNAL SEARCH' setting. When disabled, DoxyPress will generate a PHP script for searching and an index file used by the script. When 'EXTERNAL SEARCH' is enabled the indexing and searching needs to be provided by external tools. Refer to External Searching. The default value is: NO This tag requires the tag 'HTML SEARCH' is set to YES SEPARATE-MEMBER-PAGES If this tag is set DoxyPress will produce a new page for each member. If set to NO the documentation of a member will be part of the file/class/namespace which contains the member. The default value is: NO SHORT-NAMES If this tag is set shorter file names will be generated which may be less readable. The default value is: NO SHOW-FILE-PAGE Set this tag to NO to disable the generation of the Files page. This will remove the Files entry from the Quick Index and from the Folder Tree View if specified. The default value is: YES SHOW-GROUPED-MEMBERS-INC If this tag is set DoxyPress will add for each grouped member, an include statement indicating which file to include in order to use the member. The default value is: NO SHOW-INCLUDE-FILES If this tag is set DoxyPress will put a list of the files which are included by a file, in the documentation of that file. The default value is: YES SHOW-NAMESPACE-PAGE Set this tag to NO to disable the generation of the Namespaces page. This will remove the Namespaces entry from the Quick Index and from the Folder Tree View if specified. The default value is: YES SHOW-USED-FILES When this tag is set a list will be generated at the bottom of classes and struct documentation. The list will contain all file names which were used to generate the documentation. The default value is: YES SIP-SUPPORT Set this tag if your project consists of sip sources only. DoxyPress will parse them like normal C++ but will assume all classes use public instead of private inheritance when no explicit protection keyword is present. The default value is: NO SKIP-FUNCTION-MACROS If this tag is set DoxyPress will preprocess and remove all references to function-like macros which are alone on a line, are in uppercase, and do not end with a semicolon. Such function macros are typically used for boiler-plate code and will confuse the parser if not removed. The default value is: YES This tag requires the tag 'ENABLE PREPROCESSING' is set to YES SORT-BY-SCOPE-NAME If this tag is set the class list will be sorted by fully qualified names including namespaces. If set to NO, the class list will be sorted only by class name, not including the namespace part. The default value is: NO SORT-BRIEF-DOCS If this tag is set DoxyPress will sort the brief descriptions of file, namespace, and class members alphabetically by member name. If set to NO, members will appear in the order they are defined in the source code. This tag affects the order of entries in the class list. The default value is: NO SORT-CLASS-CASE-SENSITIVE If this tag is set to YES then sorting of classes in the index will be case sensitive. The default value is: NO SORT-CONSTRUCTORS-FIRST If this tag is set DoxyPress will sort class members with constructors and destructors listed first. If this tag is set to NO they will appear in the order defined by 'SORT BRIEF DOCUMENTATION' and 'SORT MEMBER DOCUMENTATION'. If 'SORT BRIEF DOCUMENTATION' is set to NO, this tag is ignored when sorting brief member documentation. If 'SORT MEMBER DOCUMENTATION' is set to NO, this tag is ignored when sorting detailed member documentation. The default value is: NO SORT-GROUP-NAMES If this tag is set DoxyPress will sort the groups alphabetically, as defined by the \defgroup command. If set to NO, groups will appear in the order they are defined in the source code. Groups will appear on a page called modules. The default value is: NO SORT-MEMBER-DOCS If this tag is set DoxyPress will sort the detailed documentation alphabetically. If set to NO, members will appear in the order they are defined in the source code. To sort pages manually refer to the \sortid command. The default value is: YES SOURCE-CODE If this tag is set then a list of source files will be generated. Documented entities will be cross-referenced with these sources. To remove all source code in the generated output set 'VERBATIM HEADERS' to NO The default value is: NO SOURCE-TOOLTIPS If this tag is set then hovering on a hyperlink in the source code will show a tooltip with additional information such as prototype, brief description, or links to the definition and documentation. The default value is: YES This tag requires the tag 'SOURCE CODE' is set to YES STRICT-SIG-MATCHING If this tag is set then an exact match of the function signature is required to document a function. An exact match means the function name and parameters must all match.. If this tag is set to NO DoxyPress will do an approximate match. The default value is: NO STRIP-CODE-COMMENTS If this tag is set DoxyPress will hide any special comment blocks from generated source code fragments. Normal C, C++, and Fortran comments will always remain visible. The default value is: YES STRIP-FROM-PATH This tag is used to specify what portion of the path to remove from the source files. The path is only stripped if one of the specified strings matches the beginning part of the path. This tag can be used to show relative paths in the file list. If left blank the directory where DoxyPress is run is used as the path to strip. This tag requires the tag 'FULL PATH NAME' is set to YES STRIP-FROM-INC-PATH This tag is used to specify what portion of the path to remove for include files. The include file shown in the documentation will indicate which header file to include, in order to use a particular class. If this tag is left blank the full path will be removed. SUFFIX-EXCLUDE-NAVTREE This tag is used to specify a list of file extensions which should not appear in the Files and File List of the navigation treeview. The 'dot' for the extension should not be specified in this tag. If this tag is empty the default will be: doc, dox, md, markdown, txt SUFFIX-HEADER-NAVTREE This tag is used to specify a list of file extensions which will be treated as headers when building the Files and File List of the navigation treeview. The 'dot' for the extension should not be specified in this tag. If this tag is empty the default will be: h, hh, hxx, hpp, h++, idl, ddl, pidl SUFFIX-SOURCE-NAVTREE This tag is used to specify a list of file extensions which are treated as source. All entities in source files are considered to be 'local' rather than 'global'. Local entities will only be documented if the tag 'EXTRACT_LOCAL_CLASSES' is set. The 'dot' for the extension should not be specified in this tag. If this tag is empty the default will be: c, cc, cxx, cpp, c++, ii, ixx, ipp, i++, inl, java, m, mm, xml TAG-FILES This tag is used to specify one or more tag files. For each tag file the location to the external documentation should be provided. The format of a tag file without this location is: TAGFILES = tagFile1 tagFile2 ... Syntax to add a url or path for the tag files. Loc1 and loc2 can be relative or absolute. TAGFILES = tagFile1=loc1 tagFile2 = loc2 ... Each tag file must have a unique name (where the name does NOT include the path). If a tag file is not located in the directory in which DoxyPress is run, include the path with the file name. TAB-SIZE This tag is used to set the number of spaces in a tab. This value is used to replace tabs with spaces in code fragments. Minimum: 1, Maximum: 16, Default: 4 TCL-SUBST This tag is used to specify a number of word-keyword mappings. A mapping has the form name=value. For example, adding class=itcl::class allows you to use the command class in the itcl::class meaning. This tag is only used when parsing a TCL file. TEMPLATE-RELATIONS If this tag is set the inheritance and collaboration graphs will show the relations between templates and their instances. The default value is: NO This tag requires the tag 'HAVE DOT' is set to YES TOC-EXPANDED If this tag is set to YES, then group members will be added to the table of contents of the HTML help documentation and to the tree view. The default value is: NO This tag requires the tag 'GENERATE HTML HELP' is set to YES TOC-INCLUDE-HEADERS In markdown syntax a line of documentation which starts with a # sign is called a header. In the output this 'markdown header' will look like an html H1 element. Multiple # signs can be used up to the standard header limit of 6, which corresponds to H6. When this tag is set to a value greater than 0 all markdown headers with the same or greater level as this tag will automatically be included in the table of contents. This will occur even if the header does not have an id attribute. The default value is: 0 This tag requires the tag 'MARKDOWN SUPPORT' is set to YES TREEVIEW-WIDTH If 'GENERATE NAVIGATION TREEVIEW' is enabled this tag can be used to set the initial width (in pixels) of the frame in which the tree is shown. Minimum: 0, Maximum: 1500, Default: 250 This tag requires the tag 'GENERATE HTML' is set to YES UML-LIMIT-NUM-FIELDS If the 'UML LOOK' tag is enabled, the fields and methods are shown inside the class node. If there are many fields or methods and many nodes the graph may become too big to be useful. This tag limits the number of items for each type to make the size more manageable. Set this tag to 0 for no limit. The threshold may be exceeded by 50% before the limit is enforced. When the threshold is 10, up to 15 fields may appear, but if the number exceeds 15, the total amount of fields shown is limited to 10. Minimum: 0, Maximum: 100, Default: 10 This tag requires the tag 'HAVE DOT' is set to YES UML-LOOK If this tag is set DoxyPress will generate inheritance and collaboration diagrams in a style similar to the OMG's Unified Modeling Language. The default value is: NO This tag requires the tag 'HAVE DOT' is set to YES USE-HTAGS If this tag is set then all references to source code will point to the HTML generated by the htags(1) program. Instead of the source browser generated by DoxyPress, the links to the source code will point to the output of htags. The htags tool is part of GNU's global source tagging system. DoxyPress will invoke htags which will invoke gtags. Both programs must be available in your search path. The default value is: NO This tag requires the tag 'SOURCE CODE' is set to YES USE-MATHJAX Set this tag to render LaTeX formulas using MathJax. Client side JavaScript will be used for rendering instead of pre-rendered bitmaps. This tag should be used if you do not have LaTeX installed or if you want formulas to look better in the HTML output. When enabled, you may also need to install MathJax and configure the path to it using the 'MATHJAX RELATIVE PATH' option. The default value is: NO This tag requires the tag 'GENERATE HTML' is set to YES USE-TYPEDEF-NAME When the tag is set a typedef of a struct, union, or enum is documented as struct, union, or enum with the name of the typedef. For example, Typedef struct Type_S {} Type_T, will appear as a struct with name Type_T. When disabled, the typedef will appear as a member of a file, namespace, or class and the struct will be named Type_S. The default value is: NO VERBATIM-HEADERS If this tag is set DoxyPress will generate a verbatim copy of the header file for each class for which an include is specified. Set to NO to disable this feature. Refer to the \class command. The default value is: YES WARN-DOC-ERROR If this tag is set DoxyPress will generate warnings for potential errors such as not documenting some parameters in a documented function, documenting parameters which do not exist, or using markup commands incorrectly. The default value is: YES WARN-FORMAT This tag determines the format of the warning messages. The macro$file will be replaced by the file name, $line is replaced by the line number where the warning originated, and$text is replaced with the warning text. This tag can also include $version which will be replaced by the version of the file if it can be obtained from the 'FILE VERSION FILTER'. The default value is:$file:$line:$text

WARN-LOGFILE
This tag is used to specify a file where warning and error messages should be written. If left blank the output is written to standard error (stderr).
WARN-PARAM-MISMATCH

Setting this tag will generate a message when the parameter variable name in the declaration does not match the name in the documentation.

The default value is: NO

WARN-UNDOC

If this tag is set DoxyPress will generate warnings for undocumented members. If 'EXTRACT ALL' is set this tag will automatically be disabled.

The default value is: YES

WARN-UNDOC-PARAM

This tag is used to warn about functions which are documented but have no documentation for their parameters or return value. If set to NO, only warnings about wrong or incomplete parameter documentation, but not about the absence of documentation, will be generated.

The default value is: NO

WARNINGS

This tag can be used to enable (YES) or disable (NO) warning messages which are sent to standard error (stderr). If this tag is set standard error messages will be generated.

The default value is: YES

XML-INCLUDE-NS-MEMBERS

If this tag is set then the output will include namespace members in the file scope.

The default value is: NO

XML-OUTPUT

This tag is used to specify the location for the XML output. If a relative path is entered the value of 'OUTPUT DIRECTORY' will be prepended.

The default directory is: xml

This tag requires the tag 'GENERATE XML' is set to YES

XML-PROGRAM-LISTING

If this tag is set program source code, including syntax highlighting and cross-referencing will be generated.

The default value is: YES

This tag requires the tag 'GENERATE XML' is set to YES