=) and one or more values. If the same tag is assigned more than once, the last assignment overwrites any earlier assignment. For tags that take a list as their argument, the += operator can be used instead of = to append new values to the list. Values are sequences of non-blanks. If the value should contain one or more blanks it must be surrounded by quotes ("..."). Multiple lines can be concatenated by inserting a backslash (\c \\) as the last character of a line. Environment variables can be expanded using the pattern \$(ENV_VARIABLE_NAME). You can also include part of a configuration file from another configuration file using a \@INCLUDE tag as follows: \verbatim @INCLUDE = config_file_name \endverbatim The include file is searched in the current working directory. You can also specify a list of directories that should be searched before looking in the current working directory. Do this by putting a \@INCLUDE_PATH tag with these paths before the \@INCLUDE tag, e.g.: \verbatim @INCLUDE_PATH = my_config_dir \endverbatim The configuration options can be divided into several categories. Below is an alphabetical index of the tags that are recognized followed by the descriptions of the tags grouped by category. ]]> All text after a double hash (##) is considered a comment and is placed in front of the TAG it is preceding.
All text after a single hash (#) is considered a comment and will be ignored. The format is: \verbatim TAG = value [value, ...] \endverbatim For lists, items can also be appended using: \verbatim TAG += value [value, ...] \endverbatim Values that contain spaces should be placed between quotes (\" \"). ]]>

Note: If both \ref cfg_hide_undoc_members "HIDE_UNDOC_MEMBERS" and \ref cfg_brief_member_desc "BRIEF_MEMBER_DESC" are set to \c NO, the brief descriptions will be completely suppressed. ]]> Note that you can specify absolute paths here, but also relative paths, which will be relative from the directory where doxygen is started. ]]> Note that setting this tag to \c YES also means that rational rose comments are not recognized any more. ]]> ext=language, where \c ext is a file extension, and language is one of the parsers supported by doxygen: IDL, Java, JavaScript, Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: Fortran. In the later case the parser tries to guess whether the code is fixed or free formatted code, this is the default for Fortran type files). For instance to make doxygen treat .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), use: `inc=Fortran f=C`.
Note: For files without extension you can use `no_extension` as a placeholder.
Note that for custom extensions you also need to set \ref cfg_file_patterns "FILE_PATTERNS" otherwise the files are not read by doxygen. When specifying `no_extension` you should add `*` to the \ref cfg_file_patterns "FILE_PATTERNS".
Note see also the list of \ref default_file_extension_mapping "default file extension mappings". ]]> sip sources only. Doxygen will parse them like normal C++ but will assume all classes use public instead of private inheritance when no explicit protection keyword is present. ]]> Note that this feature does not work in combination with \ref cfg_separate_member_pages "SEPARATE_MEMBER_PAGES". ]]> typedef struct TypeS {} TypeT, will appear in the documentation as a struct with name \c TypeT. When disabled the typedef will appear as a member of a file, namespace, or class. And the struct will be named \c TypeS. This can typically be useful for C code in case the coding convention dictates that all compound types are typedef'ed and only the typedef is referenced, never the tag name. ]]> ... \ref cmdendif "\\endif" and \ref cmdcond "\\cond" \ ... \ref cmdendcond "\\endcond" blocks. ]]> popen()) the command command input-file, where \c command is the value of the \c FILE_VERSION_FILTER tag, and \c input-file is the name of an input file provided by doxygen. Whatever the program writes to standard output is used as the file version. ]]>
Example of using a shell script as a filter for Unix: \verbatim FILE_VERSION_FILTER = "/bin/sh versionfilter.sh" \endverbatim
Example shell script for CVS: \verbatim #!/bin/sh cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).*/\1/p' \endverbatim
Example shell script for Subversion: \verbatim #!/bin/sh svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p' \endverbatim
Example filter for ClearCase: \verbatim FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn" \endverbatim ]]> Note that if you run doxygen from a directory containing a file called \c DoxygenLayout.xml, doxygen will parse it automatically even if the \c LAYOUT_FILE tag is left empty. ]]> .bib files. The .bib extension is automatically appended if omitted. This requires the \c bibtex tool to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. For \f$\mbox{\LaTeX}\f$ the style of the bibliography can be controlled using \ref cfg_latex_bib_style "LATEX_BIB_STYLE". To use this feature you need \c bibtex and \c perl available in the search path. See also \ref cmdcite "\\cite" for info how to create references. ]]> \b Tip: Turn warnings on while writing the documentation. ]]> \$file, \$line, and \$text tags, which will be replaced by the file and line number from which the warning originated and the warning text. Optionally the format may contain $version, which will be replaced by the version of the file (if it could be obtained via \ref cfg_file_version_filter "FILE_VERSION_FILTER") ]]> the libiconv documentation for the list of possible encodings. ]]> Note that for custom extensions or not directly supported extensions you also need to set \ref cfg_extension_mapping "EXTENSION_MAPPING" for the extension otherwise the files are not read by doxygen.
Note the list of default checked file patterns might differ from the list of \ref default_file_extension_mapping "default file extension mappings".
If left blank the following patterns are tested: ]]> Note that relative paths are relative to the directory from which doxygen is run. ]]> Note that the wildcards are matched against the file with absolute path, so to exclude all test directories for example use the pattern `*``/test/``*` ]]> Note that the wildcards are matched against the file with absolute path, so to exclude all test directories use the pattern `*``/test/``*` ]]> popen()) the command:
\ \
where \ is the value of the \c INPUT_FILTER tag, and \ is the name of an input file. Doxygen will then use the output that the filter program writes to standard output. If \ref cfg_filter_patterns "FILTER_PATTERNS" is specified, this tag will be ignored.
Note that the filter must not add or remove lines; it is applied before the code is scanned, but not when the output code is generated. If lines are added or removed, the anchors will not be placed correctly.
Note that for custom extensions or not directly supported extensions you also need to set \ref cfg_extension_mapping "EXTENSION_MAPPING" for the extension otherwise the files are not properly processed by doxygen.
]]> Note that for custom extensions or not directly supported extensions you also need to set \ref cfg_extension_mapping "EXTENSION_MAPPING" for the extension otherwise the files are not properly processed by doxygen.
]]> Note: To get rid of all source code in the generated output, make sure that also \ref cfg_verbatim_headers "VERBATIM_HEADERS" is set to \c NO. ]]> To use it do the following: -# Install the latest version of \c global -# Enable \ref cfg_source_browser "SOURCE_BROWSER" and \c USE_HTAGS in the configuration file -# Make sure the \ref cfg_input "INPUT" points to the root of the source tree -# Run \c doxygen as normal
Doxygen will invoke \c htags (and that will in turn invoke \c gtags), so these tools must be available from the command line (i.e. in the search path).
The result: instead of the source browser generated by doxygen, the links to source code will now point to the output of \c htags. ]]> clang parser for more accurate parsing at the cost of reduced performance. This can be particularly helpful with template rich C++ code for which doxygen's built-in parser lacks the necessary type information. @note The availability of this option depends on whether or not doxygen was generated with the `-Duse_libclang=ON` option for CMake. ]]> compilation database containing the options used when the source files were built. This is equivalent to specifying the `-p` option to a clang tool, such as `clang-check`. These options will then be passed to the parser. Any options specified with \ref cfg_clang_options "CLANG_OPTIONS" will be added as well. @note The availability of this option depends on whether or not doxygen was generated with the `-Duse_libclang=ON` option for CMake. ]]> .htm, .php, .asp). ]]> To get valid HTML the header file that includes any scripts and style sheets that doxygen needs, which is dependent on the configuration options used (e.g. the setting \ref cfg_generate_treeview "GENERATE_TREEVIEW"). It is highly recommended to start with a default header using \verbatim doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile \endverbatim and then modify the file \c new_header.html. See also section \ref doxygen_usage for information on how to generate the default header that doxygen normally uses. @note The header is subject to change so you typically have to regenerate the default header when upgrading to a newer version of doxygen. ]]>

$title

will be replaced with the title of the page.

$datetime

will be replaced with current the date and time.

$date

will be replaced with the current date.

$year

will be replaces with the current year.

$doxygenversion

will be replaced with the version of doxygen

$projectname

will be replaced with the name of the project (see \ref cfg_project_name "PROJECT_NAME")

$projectnumber

will be replaced with the project number (see \ref cfg_project_number "PROJECT_NUMBER")

$projectbrief

will be replaced with the project brief description (see \ref cfg_project_brief "PROJECT_BRIEF")

$projectlogo

will be replaced with the project logo (see \ref cfg_project_logo "PROJECT_LOGO")

$generatedby

will be replaced with the output language dependent version of the text "Generated by" or when the \ref cfg_html_timestamp "HTML_TIMESTAMP" is set by the output language dependent version of the text "Generated on `$datetime` for `$projectname` by".

$stylesheet

will be replaced with the setting of \ref cfg_html_stylesheet "HTML_STYLESHEET" unless it is empty or the file in which case it is replaced by the default setting `doxygen.css`.

$extrastylesheet

will be replaced with the setting of \ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET" including the required HTML tags for each extra stylesheet.

$treeview

will be replaced with links to the javascript and style sheets needed for the navigation tree (or an empty string when \ref cfg_generate_treeview "GENERATE_TREEVIEW" is disabled).

$search

will be replaced with a links to the javascript and style sheets needed for the search engine (or an empty string when \ref cfg_searchengine "SEARCHENGINE" is disabled).

$searchbox

will be replaced with the HTML code needed for the search box to be shown (or an empty string when \ref cfg_searchengine "SEARCHENGINE" is disabled).

$mathjax

will be replaced with a links to the javascript and style sheets needed for the MathJax feature (or an empty string when \ref cfg_use_mathjax "USE_MATHJAX" is disabled).

$relpath^

If \ref cfg_create_subdirs "CREATE_SUBDIRS" is enabled, the command $relpath^ can be used to produce a relative path to the root of the HTML output directory, e.g. use $relpath^doxygen.css, to refer to the standard style sheet.

$navpath

will be replaced with a path as required by \ref cfg_generate_treeview "GENERATE_TREEVIEW" To cope with differences in the layout of the header and footer that depend on configuration settings, the header can also contain special blocks that will be copied to the output or skipped depending on the configuration. Such blocks have the following form: \verbatim Some context copied when condition BLOCKNAME holds Some context copied when condition BLOCKNAME does not hold \endverbatim The following block names are supported:

DISABLE_INDEX

Content within this block is copied to the output if the \ref cfg_disable_index "DISABLE_INDEX" option is enabled (so when the index is disabled).

GENERATE_TREEVIEW

Content within this block is copied to the output if the \ref cfg_generate_treeview "GENERATE_TREEVIEW" option is enabled.

SEARCHENGINE

Content within this block is copied to the output if the \ref cfg_searchengine "SEARCHENGINE" option is enabled.

PROJECT_NAME

Content within the block is copied to the output if the \ref cfg_project_name "PROJECT_NAME" option is not empty.

PROJECT_NUMBER

Content within the block is copied to the output if the \ref cfg_project_number "PROJECT_NUMBER" option is not empty.

PROJECT_BRIEF

Content within the block is copied to the output if the \ref cfg_project_brief "PROJECT_BRIEF" option is not empty.

PROJECT_LOGO

Content within the block is copied to the output if the \ref cfg_project_logo "PROJECT_LOGO" option is not empty.

FULL_SIDEBAR

Content within the block is copied to the output if the \ref cfg_full_sidebar "FULL_SIDEBAR", \ref cfg_disable_index "DISABLE_INDEX" and \ref cfg_generate_treeview "GENERATE_TREEVIEW" options are all enabled.

TITLEAREA

Content within this block is copied to the output if a title is visible at the top of each page. This is the case if either \ref cfg_project_name "PROJECT_NAME", \ref cfg_project_brief "PROJECT_BRIEF", \ref cfg_project_logo "PROJECT_LOGO" is filled in or if both \ref cfg_disable_index "DISABLE_INDEX" and \ref cfg_searchengine "SEARCHENGINE" are enabled.

]]> HTML_STYLESHEET) will in the future become obsolete. ]]> $relpath^ marker in the \ref cfg_html_header "HTML_HEADER" and/or \ref cfg_html_footer "HTML_FOOTER" files to load these files. In the \ref cfg_html_stylesheet "HTML_STYLESHEET" file, use the file name only. Also note that the files will be copied as-is; there are no commands or markers available. ]]> Apple's Xcode 3 integrated development environment, introduced with OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a Makefile in the HTML output directory. Running \c make will produce the docset in that directory and running make install will install the docset in ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at startup. See https://developer.apple.com/library/archive/featuredarticles/DoxygenXcode/_index.html for more information. ]]> com.mycompany.MyDocSet. Doxygen will append .docset to the name. ]]> com.mycompany.MyDocSet.documentation. ]]> Installation executable.
The HTML Help Workshop contains a compiler that can convert all HTML output generated by doxygen into a single compiled HTML file (`.chm`). Compiled HTML files are now used as the Windows 98 help format, and will replace the old Windows help format (`.hlp`) on all Windows platforms in the future. Compressed HTML files also contain an index, a table of contents, and you can search for words in the documentation. The HTML workshop also contains a viewer for compressed HTML files. ]]> Qt Help Project / Namespace. ]]> Qt Help Project / Virtual Folders. ]]> Qt Help Project / Custom Filters. ]]> Qt Help Project / Custom Filters. ]]> Qt Help Project / Filter Attributes. ]]> Note that a value of 0 will completely suppress the enum values from appearing in the overview section. ]]> Note that when changing this option you need to delete any `form_*.png` files in the HTML output directory before the changes have effect. ]]> MathJax version 2 and MathJax version 3. ]]> ../mathjax. The default value points to the MathJax Content Delivery Network so you can quickly see the result without installing MathJax. However, it is strongly recommended to install a local copy of MathJax from https://www.mathjax.org before deployment. The default value is: - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 ]]> the MathJax site for more details. ]]> disableRenderer.js: \verbatim MathJax.Hub.Config({ menuSettings: { showRenderer: false, } }); \endverbatim ]]> \ + S (what the \ is depends on the OS and browser, but it is typically \, \/\, or both). Inside the search box use the \ to jump into the search results window, the results can be navigated using the \. Press \ to select an item or \ to cancel the search. The filter options can be selected when the cursor is inside the search box by pressing \+\. Also here use the \ to select a filter and \ or \ to activate or cancel the filter option. ]]> Doxygen ships with an example indexer (\c doxyindexer) and search engine (doxysearch.cgi) which are based on the open source search engine library Xapian.
See the section \ref extsearch for details. ]]> Doxygen ships with an example indexer (\c doxyindexer) and search engine (doxysearch.cgi) which are based on the open source search engine library Xapian. See the section \ref extsearch for details. ]]> Note that when not enabling \ref cfg_use_pdflatex "USE_PDFLATEX" the default is \c latex when enabling \ref cfg_use_pdflatex "USE_PDFLATEX" the default is \c pdflatex and when in the later case \c latex is chosen this is overwritten by \c pdflatex. For specific output languages the default can have been set differently, this depends on the implementation of the output language. ]]> Note: Only use a user-defined header if you know what you are doing! @note The header is subject to change so you typically have to regenerate the default header when upgrading to a newer version of doxygen. The following commands have a special meaning inside the header (and footer): ]]>

$title

will be replaced with the project name.

$datetime

will be replaced with current the date and time.

$date

will be replaced with the current date.

$year

will be replaces with the current year.

$doxygenversion

will be replaced with the version of doxygen

$projectname

will be replaced with the name of the project (see \ref cfg_project_name "PROJECT_NAME")

$projectnumber

will be replaced with the project number (see \ref cfg_project_number "PROJECT_NUMBER")

$projectbrief

will be replaced with the project brief description (see \ref cfg_project_brief "PROJECT_BRIEF")

$projectlogo

will be replaced with the project logo (see \ref cfg_project_logo "PROJECT_LOGO")

$latexdocumentpre

will be replaced by an output language dependent setting e.g. embed the entire document in a special environment (for Chinese, Japanese etc.) Commonly used together with `$latexdocumentpost` in the footer.

$latexdocumentpost

will be replaced by an output language dependent setting e.g. embed the entire document in a special environment (for Chinese, Japanese etc.) Commonly used together with `$latexdocumentpre` in the header.

$generatedby

will be replaced with the output language dependent version of the text "Generated by" or when the \ref cfg_latex_timestamp "LATEX_TIMESTAMP" is set by the output language dependent version of the text "Generated on `$datetime` for `$projectname` by".

$latexcitereference

will be replaced by the output language dependent$ version of the word "Bibliography". This setting is typically used in combination with the block name `CITATIONS_PRESENT`.

$latexbibstyle

will be replaced with the latex bib style to be used as as set by \ref cfg_latex_bib_style "LATEX_BIB_STYLE", in case nothing is set the bib style `plain` is used. This setting is typically used in combination with the block name `CITATIONS_PRESENT`.

$latexbibfiles

will be replaced by the comma separated list of `bib. files as set by \ref cfg_cite_bib_files "CITE_BIB_FILES" (when necessary a missing `.bib` is automatically added). This setting is typically used in combination with the block name `CITATIONS_PRESENT`.

$papertype

will be replaced by the paper type as set in \ref cfg_paper_type "PAPER_TYPE" and the word "paper" is directly appended to it to have a correct \f$\mbox{\LaTeX}\f$ paper type.

$languagesupport

will be replaced by an output language dependent setting of packages required for translating terms of the specified language.

$latexfontenc

will be replaced by an output language dependent setting of the fontencoding to be used. This setting is typically used in combination with the block name `LATEX_FONTENC`.

$latexfont

will be replaced by an output language dependent setting of the fonts to be used.

$latexemojidirectory

will be replaced by the directory as set in \ref cfg_latex_emoji_directory "LATEX_EMOJI_DIRECTORY" with the backslashes replaced by forward slashes (so usable by \f$\mbox{\LaTeX}\f$). In case the \ref cfg_latex_emoji_directory "LATEX_EMOJI_DIRECTORY" is empty, the current directory will be used.

$makeindex

will be replaced by the command as set in \ref cfg_latex_makeindex_cmd "LATEX_MAKEINDEX_CMD". Then the command doesn't start with a backslash, a backslash is automatically prepended. In case the setting is empty the command `\makeindex` is used.

$extralatexpackages

will be replaced by commands for using the packages set in \ref cfg_extra_packages "EXTRA_PACKAGES".

$extralatexstylesheet

will be replaced by commands for using the packages set in \ref cfg_latex_extra_stylesheet "LATEX_EXTRA_STYLESHEET" (when the extension is the default extension, `.sty`, this extension is stripped for the package name).

$latexspecialformulachars

will be replaced by the code for some special unicode characters that are commonly used (i.e. superscript minus, superscript 2 and superscript 3)

$formulamacrofile

will be replaced by the name of the file as set in \ref cfg_formula_macrofile "FORMULA_MACROFILE". This setting is typically used in combination with the block name `FORMULA_MACROFILE`. To cope with differences in the layout of the header and footer that depend on configuration settings, the header and footer can also contain special blocks that will be copied to the output or skipped depending on the configuration. Such blocks have the following form: \verbatim %%BEGIN BLOCKNAME Some context copied when condition BLOCKNAME holds %%END BLOCKNAME %%BEGIN !BLOCKNAME Some context copied when condition BLOCKNAME does not hold %%END !BLOCKNAME \endverbatim The following block names are set based on the used settings in the configuration file:

COMPACT_LATEX

Content within this block is copied to the output when the \ref cfg_compact_latex "COMPACT_LATEX" option is enabled.

PDF_HYPERLINKS

Content within this block is copied to the output when the \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS" option is enabled.

USE_PDFLATEX

Content within this block is copied to the output when the \ref cfg_use_pdflatex "USE_PDFLATEX" option is enabled.

LATEX_BATCHMODE

Content within this block is copied to the output when the \ref cfg_latex_batchmode "LATEX_BATCHMODE" option is enabled.

LATEX_TIMESTAMP

Content within this block is copied to the output when the \ref cfg_latex_timestamp "LATEX_TIMESTAMP" option is enabled.

The following block names are set based on the fact whether or not the tag has a value in the used configuration file:

LATEX_FONTENC

Content within this block is copied to the output when the doxygen latex translator function returns a value for the font encoding to be used. It is to be used in combination with the above mentioned `$latexfontenc`.

FORMULA_MACROFILE

Content within this block is copied to the output when the \ref cfg_formula_macrofile "FORMULA_MACROFILE" option is not empty. It is to be used in combination with the above mentioned `$formulamacrofile`.

The following block name is set based on whether or not a feature is used in the documentation:

CITATIONS_PRESENT

Content within this block is copied to the output when in the documentation citations are present and the relevant .. are present. It is to be used in combination with the above mentioned `$latexcitereference`, `$latexbibstyle` and `$latexbibfiles`.

]]> See also section \ref cfg_latex_cmd_name "LATEX_CMD_NAME" for selecting the engine. ]]> Note that which sources are shown also depends on other settings such as \ref cfg_source_browser "SOURCE_BROWSER". ]]> Note: WordPad (write) and others do not support links. ]]> See also section \ref doxygen_usage for information on how to generate the default style sheet that doxygen normally uses. ]]> doxygen -e rtf extensionFile. ]]> Note that which sources are shown also depends on other settings such as \ref cfg_source_browser "SOURCE_BROWSER". ]]> Note that this feature is still experimental and incomplete at the moment. ]]> name or name=definition (no spaces). If the definition and the \c "=" are omitted, \c "=1" is assumed. To prevent a macro definition from being undefined via \c \#undef or recursively expanded use the := operator instead of the \c = operator. ]]> Graphviz, a graph visualization toolkit from AT\&T and Lucent Bell Labs. The other options in this section have no effect if this option is set to \c NO ]]> Note that enabling this option will significantly increase the time of a run. So in most cases it will be better to enable call graphs for selected functions only using the \ref cmdcallgraph "\\callgraph" command. Disabling a call graph can be accomplished by means of the command \ref cmdhidecallgraph "\\hidecallgraph". ]]> Note that enabling this option will significantly increase the time of a run. So in most cases it will be better to enable caller graphs for selected functions only using the \ref cmdcallergraph "\\callergraph" command. Disabling a caller graph can be accomplished by means of the command \ref cmdhidecallergraph "\\hidecallergraph". ]]> Graphviz). \note If you choose \c svg you need to set \ref cfg_html_file_extension "HTML_FILE_EXTENSION" to \c xhtml in order to make the SVG files visible in IE 9+ (other browsers do not have this requirement). ]]> Note that this requires a modern browser other than Internet Explorer. Tested and working are Firefox, Chrome, Safari, and Opera. \note For IE 9+ you need to set \ref cfg_html_file_extension "HTML_FILE_EXTENSION" to \c xhtml in order to make the SVG files visible. Older versions of IE do not have SVG support. ]]> Warning: Depending on the platform used, enabling this option may lead to badly anti-aliased labels on the edges of a graph (i.e. they become hard to read). ]]> 1.8.10) support this, this feature is disabled by default. ]]> Note: This setting is not only used for dot files but also for msc and plantuml temporary files. ]]>