Manual: Configuration

Loading...
Searching...
No Matches
Configuration

# Format

A configuration file is a free-form ASCII text file with a structure that is similar to that of a `Makefile`, with the default name `Doxyfile`. It is parsed by `doxygen`. The file may contain tabs and newlines for formatting purposes. The statements in the file are case-sensitive.

The configuration file essentially consists of a list of assignment statements. Each statement consists of a `TAG_NAME` written in capitals, followed by the equal sign (`=`) 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 (`\`) as the last non-whitespace character of a line.

Comments begin with the hash character (`#`) and end at the end of the line. Comments may be placed anywhere within the file (except within quotes). Comments beginning with two hash characters (`##`) are kept while updating the configuration file when they are placed in front of a `TAG_NAME`, or at the beginning or end of the configuration file.

Environment variables can be expanded using the pattern `$(ENV_VARIABLE_NAME)`. A small example:

    DOT_PATH      = $(YOUR_DOT_PATH)

You can also include part of a configuration file from another configuration file using a `@INCLUDE` tag as follows:

    @INCLUDE = config_file_name

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.:

    @INCLUDE_PATH = my_config_dir

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.

- ABBREVIATE_BRIEF
- ALIASES
- ALLEXTERNALS
- ALLOW_UNICODE_NAMES
- ALPHABETICAL_INDEX
- ALWAYS_DETAILED_SEC
- AUTOLINK_IGNORE_WORDS
- AUTOLINK_SUPPORT
- BINARY_TOC
- BRIEF_MEMBER_DESC
- BUILTIN_STL_SUPPORT
- CALLER_GRAPH
- CALL_GRAPH
- CASE_SENSE_NAMES
- CHM_FILE
- CHM_INDEX_ENCODING
- CITE_BIB_FILES
- CLANG_ADD_INC_PATHS
- CLANG_ASSISTED_PARSING
- CLANG_DATABASE_PATH
- CLANG_OPTIONS
- CLASS_GRAPH
- COLLABORATION_GRAPH
- COMPACT_LATEX
- COMPACT_RTF
- CPP_CLI_SUPPORT
- CREATE_SUBDIRS
- CREATE_SUBDIRS_LEVEL
- DIAFILE_DIRS
- DIA_PATH
- DIRECTORY_GRAPH
- DIR_GRAPH_MAX_DEPTH
- DISABLE_INDEX
- DISTRIBUTE_GROUP_DOC
- DOCBOOK_OUTPUT
- DOCSET_BUNDLE_ID
- DOCSET_FEEDNAME
- DOCSET_FEEDURL
- DOCSET_PUBLISHER_ID
- DOCSET_PUBLISHER_NAME
- DOTFILE_DIRS
- DOT_CLEANUP
- DOT_COMMON_ATTR
- DOT_EDGE_ATTR
- DOT_FONTPATH
- DOT_GRAPH_MAX_NODES
- DOT_IMAGE_FORMAT
- DOT_MULTI_TARGETS
- DOT_NODE_ATTR
- DOT_NUM_THREADS
- DOT_PATH
- DOT_UML_DETAILS
- DOT_WRAP_THRESHOLD
- DOXYFILE_ENCODING
- ECLIPSE_DOC_ID
- ENABLED_SECTIONS
- ENABLE_PREPROCESSING
- ENUM_VALUES_PER_LINE
- EXAMPLE_PATH
- EXAMPLE_PATTERNS
- EXAMPLE_RECURSIVE
- EXCLUDE
- EXCLUDE_PATTERNS
- EXCLUDE_SYMBOLS
- EXCLUDE_SYMLINKS
- EXPAND_AS_DEFINED
- EXPAND_ONLY_PREDEF
- EXTENSION_MAPPING
- EXTERNAL_GROUPS
- EXTERNAL_PAGES
- EXTERNAL_SEARCH
- EXTERNAL_SEARCH_ID
- EXTERNAL_TOOL_PATH
- EXTRACT_ALL
- EXTRACT_ANON_NSPACES
- EXTRACT_LOCAL_CLASSES
- EXTRACT_LOCAL_METHODS
- EXTRACT_PACKAGE
- EXTRACT_PRIVATE
- EXTRACT_PRIV_VIRTUAL
- EXTRACT_STATIC
- EXTRA_PACKAGES
- EXTRA_SEARCH_MAPPINGS
- EXT_LINKS_IN_WINDOW
- FILE_PATTERNS
- FILE_VERSION_FILTER
- FILTER_PATTERNS
- FILTER_SOURCE_FILES
- FILTER_SOURCE_PATTERNS
- FORCE_LOCAL_INCLUDES
- FORMULA_FONTSIZE
- FORMULA_MACROFILE
- FORTRAN_COMMENT_AFTER
- FULL_PATH_NAMES
- FULL_SIDEBAR
- GENERATE_AUTOGEN_DEF
- GENERATE_BUGLIST
- GENERATE_CHI
- GENERATE_DEPRECATEDLIST
- GENERATE_DOCBOOK
- GENERATE_DOCSET
- GENERATE_ECLIPSEHELP
- GENERATE_HTML
- GENERATE_HTMLHELP
- GENERATE_LATEX
- GENERATE_LEGEND
- GENERATE_MAN
- GENERATE_PERLMOD
- GENERATE_QHP
- GENERATE_RTF
- GENERATE_SQLITE3
- GENERATE_TAGFILE
- GENERATE_TESTLIST
- GENERATE_TODOLIST
- GENERATE_TREEVIEW
- GENERATE_XML
- GRAPHICAL_HIERARCHY
- GROUP_GRAPHS
- GROUP_NESTED_COMPOUNDS
- HAVE_DOT
- HHC_LOCATION
- HIDE_COMPOUND_REFERENCE
- HIDE_FRIEND_COMPOUNDS
- HIDE_IN_BODY_DOCS
- HIDE_SCOPE_NAMES
- HIDE_UNDOC_CLASSES
- HIDE_UNDOC_MEMBERS
- HIDE_UNDOC_NAMESPACES
- HIDE_UNDOC_RELATIONS
- HTML_CODE_FOLDING
- HTML_COLORSTYLE
- HTML_COLORSTYLE_GAMMA
- HTML_COLORSTYLE_HUE
- HTML_COLORSTYLE_SAT
- HTML_COPY_CLIPBOARD
- HTML_DYNAMIC_MENUS
- HTML_DYNAMIC_SECTIONS
- HTML_EXTRA_FILES
- HTML_EXTRA_STYLESHEET
- HTML_FILE_EXTENSION
- HTML_FOOTER
- HTML_FORMULA_FORMAT
- HTML_HEADER
- HTML_INDEX_NUM_ENTRIES
- HTML_OUTPUT
- HTML_PROJECT_COOKIE
- HTML_STYLESHEET
- IDL_PROPERTY_SUPPORT
- IGNORE_PREFIX
- IMAGE_PATH
- IMPLICIT_DIR_DOCS
- INCLUDED_BY_GRAPH
- INCLUDE_FILE_PATTERNS
- INCLUDE_GRAPH
- INCLUDE_PATH
- INHERIT_DOCS
- INLINE_GROUPED_CLASSES
- INLINE_INFO
- INLINE_INHERITED_MEMB
- INLINE_SIMPLE_STRUCTS
- INLINE_SOURCES
- INPUT
- INPUT_ENCODING
- INPUT_FILE_ENCODING
- INPUT_FILTER
- INTERACTIVE_SVG
- INTERNAL_DOCS
- JAVADOC_AUTOBRIEF
- JAVADOC_BANNER
- LATEX_BATCHMODE
- LATEX_BIB_STYLE
- LATEX_CMD_NAME
- LATEX_EMOJI_DIRECTORY
- LATEX_EXTRA_FILES
- LATEX_EXTRA_STYLESHEET
- LATEX_FOOTER
- LATEX_HEADER
- LATEX_HIDE_INDICES
- LATEX_MAKEINDEX_CMD
- LATEX_OUTPUT
- LAYOUT_FILE
- LOOKUP_CACHE_SIZE
- MACRO_EXPANSION
- MAKEINDEX_CMD_NAME
- MAN_EXTENSION
- MAN_LINKS
- MAN_OUTPUT
- MAN_SUBDIR
- MARKDOWN_ID_STYLE
- MARKDOWN_SUPPORT
- MATHJAX_CODEFILE
- MATHJAX_EXTENSIONS
- MATHJAX_FORMAT
- MATHJAX_RELPATH
- MATHJAX_VERSION
- MAX_DOT_GRAPH_DEPTH
- MAX_INITIALIZER_LINES
- MSCFILE_DIRS
- MSCGEN_TOOL
- MULTILINE_CPP_IS_BRIEF
- NUM_PROC_THREADS
- OBFUSCATE_EMAILS
- OPTIMIZE_FOR_FORTRAN
- OPTIMIZE_OUTPUT_FOR_C
- OPTIMIZE_OUTPUT_JAVA
- OPTIMIZE_OUTPUT_SLICE
- OPTIMIZE_OUTPUT_VHDL
- OUTPUT_DIRECTORY
- OUTPUT_LANGUAGE
- PAPER_TYPE
- PDF_HYPERLINKS
- PERLMOD_LATEX
- PERLMOD_MAKEVAR_PREFIX
- PERLMOD_PRETTY
- PLANTUMLFILE_DIRS
- PLANTUML_CFG_FILE
- PLANTUML_INCLUDE_PATH
- PLANTUML_JAR_PATH
- PREDEFINED
- PROJECT_BRIEF
- PROJECT_ICON
- PROJECT_LOGO
- PROJECT_NAME
- PROJECT_NUMBER
- PYTHON_DOCSTRING
- QCH_FILE
- QHG_LOCATION
- QHP_CUST_FILTER_ATTRS
- QHP_CUST_FILTER_NAME
- QHP_NAMESPACE
- QHP_SECT_FILTER_ATTRS
- QHP_VIRTUAL_FOLDER
- QT_AUTOBRIEF
- QUIET
- RECURSIVE
- REFERENCED_BY_RELATION
- REFERENCES_LINK_SOURCE
- REFERENCES_RELATION
- REPEAT_BRIEF
- RESOLVE_UNNAMED_PARAMS
- RTF_EXTENSIONS_FILE
- RTF_EXTRA_FILES
- RTF_HYPERLINKS
- RTF_OUTPUT
- RTF_STYLESHEET_FILE
- SEARCHDATA_FILE
- SEARCHENGINE
- SEARCHENGINE_URL
- SEARCH_INCLUDES
- SEPARATE_MEMBER_PAGES
- SERVER_BASED_SEARCH
- SHORT_NAMES
- SHOW_ENUM_VALUES
- SHOW_FILES
- SHOW_GROUPED_MEMB_INC
- SHOW_HEADERFILE
- SHOW_INCLUDE_FILES
- SHOW_NAMESPACES
- SHOW_USED_FILES
- SIP_SUPPORT
- SITEMAP_URL
- SKIP_FUNCTION_MACROS
- SORT_BRIEF_DOCS
- SORT_BY_SCOPE_NAME
- SORT_GROUP_NAMES
- SORT_MEMBERS_CTORS_1ST
- SORT_MEMBER_DOCS
- SOURCE_BROWSER
- SOURCE_TOOLTIPS
- SQLITE3_OUTPUT
- SQLITE3_RECREATE_DB
- STRICT_PROTO_MATCHING
- STRIP_CODE_COMMENTS
- STRIP_FROM_INC_PATH
- STRIP_FROM_PATH
- SUBGROUPING
- TAB_SIZE
- TAGFILES
- TEMPLATE_RELATIONS
- TIMESTAMP
- TOC_EXPAND
- TOC_INCLUDE_HEADINGS
- TREEVIEW_WIDTH
- TYPEDEF_HIDES_STRUCT
- UML_LIMIT_NUM_FIELDS
- UML_LOOK
- USE_HTAGS
- USE_MATHJAX
- USE_MDFILE_AS_MAINPAGE
- USE_PDFLATEX
- VERBATIM_HEADERS
- WARNINGS
- WARN_AS_ERROR
- WARN_FORMAT
- WARN_IF_DOC_ERROR
- WARN_IF_INCOMPLETE_DOC
- WARN_IF_UNDOCUMENTED
- WARN_IF_UNDOC_ENUM_VAL
- WARN_LAYOUT_FILE
- WARN_LINE_FORMAT
- WARN_LOGFILE
- WARN_NO_PARAMDOC
- XML_NS_MEMB_FILE_SCOPE
- XML_OUTPUT
- XML_PROGRAMLISTING

# Project related configuration options

`DOXYFILE_ENCODING`

  This tag specifies the encoding used for all characters in the configuration file that follow. The default is UTF-8 which is also the encoding used for all text before the first occurrence of this tag. Doxygen uses `libiconv` (or the iconv built into `libc`) for the transcoding. See https://www.gnu.org/software/libiconv/ for the list of possible encodings.

  The default value is: `UTF-8`.

`PROJECT_NAME`

  The `PROJECT_NAME` tag is a single word (or a sequence of words surrounded by double-quotes, unless you are using Doxywizard) that should identify the project for which the documentation is generated. This name is used in the title of most generated pages and in a few other places.

  The default value is: `My Project`.

`PROJECT_NUMBER`

  The `PROJECT_NUMBER` tag can be used to enter a project or revision number. This could be handy for archiving the generated documentation or if some version control system is used.

`PROJECT_BRIEF`

  Using the `PROJECT_BRIEF` tag one can provide an optional one line description for a project that appears at the top of each page and should give viewers a quick idea about the purpose of the project. Keep the description short.

`PROJECT_LOGO`

  With the `PROJECT_LOGO` tag one can specify a logo or an icon that is included in the documentation. The maximum height of the logo should not exceed 55 pixels and the maximum width should not exceed 200 pixels. Doxygen will copy the logo to the output directory.

`PROJECT_ICON`

  With the `PROJECT_ICON` tag one can specify an icon that is included in the tabs when the HTML document is shown. Doxygen will copy the logo to the output directory.

`OUTPUT_DIRECTORY`

  The `OUTPUT_DIRECTORY` tag is used to specify the (relative or absolute) path into which the generated documentation will be written. If a relative path is entered, it will be relative to the location where Doxygen was started. If left blank the current directory will be used.

`CREATE_SUBDIRS`

  If the `CREATE_SUBDIRS` tag is set to `YES` then Doxygen will create up to 4096 sub-directories (in 2 levels) under the output directory of each output format and will distribute the generated files over these directories. Enabling this option can be useful when feeding Doxygen a huge amount of source files, where putting all generated files in the same directory would otherwise cause performance problems for the file system. Adapt `CREATE_SUBDIRS_LEVEL` to control the number of sub-directories.

  The default value is: `NO`.

`CREATE_SUBDIRS_LEVEL`

  Controls the number of sub-directories that will be created when `CREATE_SUBDIRS` tag is set to `YES`. Level 0 represents 16 directories, and every level increment doubles the number of directories, resulting in 4096 directories at level 8 which is the default and also the maximum value. The sub-directories are organized in 2 levels, the first level always has a fixed number of 16 directories.

  Minimum value: `0`, maximum value: `8`, default value: `8`.

  This tag requires that the tag CREATE_SUBDIRS is set to `YES`.

`ALLOW_UNICODE_NAMES`

  If the `ALLOW_UNICODE_NAMES` tag is set to `YES`, Doxygen 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`.

`OUTPUT_LANGUAGE`

  The `OUTPUT_LANGUAGE` tag is used to specify the language in which all documentation generated by Doxygen is written. Doxygen will use this information to generate all constant output in the proper language.

  Possible values are: `Afrikaans`, `Arabic`, `Armenian`, `Brazilian`, `Bulgarian`, `Catalan`, `Chinese`, `Chinese-Traditional`, `Croatian`, `Czech`, `Danish`, `Dutch`, `English` (United States), `Esperanto`, `Farsi` (Persian), `Finnish`, `French`, `German`, `Greek`, `Hindi`, `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`.

`BRIEF_MEMBER_DESC`

  If the `BRIEF_MEMBER_DESC` tag is set to `YES`, Doxygen will include brief member descriptions after the members that are listed in the file and class documentation (similar to `Javadoc`). Set to `NO` to disable this.

  The default value is: `YES`.

`REPEAT_BRIEF`

  If the `REPEAT_BRIEF` tag is set to `YES`, Doxygen will prepend the brief description of a member or function before the detailed description
  Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to `NO`, the brief descriptions will be completely suppressed.

  The default value is: `YES`.

`ABBREVIATE_BRIEF`

  This tag implements a quasi-intelligent brief description abbreviator that is used to form the text in various listings. Each string in this list, if found as the leading text of the brief description, will be stripped from the text and the result, after processing the whole list, is used as the annotated text. Otherwise, the brief description is used as-is. If left blank, the following values are used (`$name` is automatically replaced with the name of the entity): `The $name class`, `The $name widget`, `The $name file`, `is`, `provides`, `specifies`, `contains`, `represents`, `a`, `an` and `the`.

`ALWAYS_DETAILED_SEC`

  If the `ALWAYS_DETAILED_SEC` and REPEAT_BRIEF tags are both set to `YES` then Doxygen will generate a detailed section even if there is only a brief description.

  The default value is: `NO`.

`INLINE_INHERITED_MEMB`

  If the `INLINE_INHERITED_MEMB` tag is set to `YES`, Doxygen 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`.

`FULL_PATH_NAMES`

  If the `FULL_PATH_NAMES` tag is set to `YES`, Doxygen will prepend the full path before files name in the file list and in the header files. If set to `NO` the shortest path that makes the file name unique will be used

  The default value is: `YES`.

`STRIP_FROM_PATH`

  The `STRIP_FROM_PATH` tag can be used to strip a user-defined part of the path. Stripping is only done if one of the specified strings matches the left-hand part of the path. The tag can be used to show relative paths in the file list. If left blank the directory from which Doxygen is run is used as the path to strip.
  Note that you can specify absolute paths here, but also relative paths, which will be relative from the directory where Doxygen is started.

  This tag requires that the tag FULL_PATH_NAMES is set to `YES`.

`STRIP_FROM_INC_PATH`

  The `STRIP_FROM_INC_PATH` tag can be used to strip a user-defined part of the path mentioned in the documentation of a class, which tells the reader which header file to include in order to use a class. If left blank only the name of the header file containing the class definition is used. Otherwise one should specify the list of include paths that are normally passed to the compiler using the `-I` flag.

`SHORT_NAMES`

  If the `SHORT_NAMES` tag is set to `YES`, Doxygen will generate much shorter (but less readable) file names. This can be useful if your file system doesn't support long names like on DOS, Mac, or CD-ROM.

  The default value is: `NO`.

`JAVADOC_AUTOBRIEF`

  If the `JAVADOC_AUTOBRIEF` tag is set to `YES` then Doxygen will interpret the first line (until the first dot, question mark or exclamation mark) of a Javadoc-style comment as the brief description. If set to `NO`, the Javadoc-style will behave just like regular Qt-style comments (thus requiring an explicit @brief command for a brief description.)

  The default value is: `NO`.

`JAVADOC_BANNER`

  If the `JAVADOC_BANNER` tag is set to `YES` then Doxygen will interpret a line such as

      /***************

  as being the beginning of a Javadoc-style comment "banner". If set to `NO`, the Javadoc-style will behave just like regular comments and it will not be interpreted by Doxygen.

  The default value is: `NO`.

`QT_AUTOBRIEF`

  If the `QT_AUTOBRIEF` tag is set to `YES` then Doxygen will interpret the first line (until the first dot, question mark or exclamation mark) of a Qt-style comment as the brief description. If set to `NO`, the Qt-style will behave just like regular Qt-style comments (thus requiring an explicit \brief command for a brief description.)

  The default value is: `NO`.

`MULTILINE_CPP_IS_BRIEF`

  The `MULTILINE_CPP_IS_BRIEF` tag can be set to `YES` to make Doxygen treat a multi-line C++ special comment block (i.e. a block of `//!` or `///` comments) as a brief description. This used to be the default behavior. The new default is to treat a multi-line C++ comment block as a detailed description. Set this tag to `YES` if you prefer the old behavior instead.
  Note that setting this tag to `YES` also means that rational rose comments are not recognized any more.

  The default value is: `NO`.

`PYTHON_DOCSTRING`

  By default Python docstrings are displayed as preformatted text and Doxygen's special commands cannot be used. By setting `PYTHON_DOCSTRING` to `NO` the Doxygen's special commands can be used and the contents of the docstring documentation blocks is shown as Doxygen documentation.

  The default value is: `YES`.

`INHERIT_DOCS`

  If the `INHERIT_DOCS` tag is set to `YES` then an undocumented member inherits the documentation from any documented member that it re-implements.

  The default value is: `YES`.

`SEPARATE_MEMBER_PAGES`

  If the `SEPARATE_MEMBER_PAGES` tag is set to `YES` then Doxygen 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 that contains it.

  The default value is: `NO`.

`TAB_SIZE`

  The `TAB_SIZE` tag can be used to set the number of spaces in a tab. Doxygen uses this value to replace tabs by spaces in code fragments.

  Minimum value: `1`, maximum value: `16`, default value: `4`.

`ALIASES`

  This tag can be used to specify a number of aliases that act as commands in the documentation. An alias has the form:

       name=value

  For example adding

       "sideeffect=@par Side Effects:^^"

  will allow you to put the command `\sideeffect` (or `@sideeffect`) in the documentation, which will result in a user-defined paragraph with heading "Side Effects:". Note that you cannot put \n's in the value part of an alias to insert newlines (in the resulting output). You can put `^^` in the value part of an alias to insert a newline as if a physical newline was in the original file. When you need a literal `{` or `}` or `,` in the value part of an alias you have to escape them by means of a backslash (`\`), this can lead to conflicts with the commands `\{` and `\}` for these it is advised to use the version `@{` and `@}` or use a double escape (`\\{` and `\\}`)

`OPTIMIZE_OUTPUT_FOR_C`

  Set the `OPTIMIZE_OUTPUT_FOR_C` tag to `YES` if your project consists of C sources only. Doxygen will then generate output that is more tailored for C. For instance, some of the names that are used will be different. The list of all members will be omitted, etc.

  The default value is: `NO`.

`OPTIMIZE_OUTPUT_JAVA`

  Set the `OPTIMIZE_OUTPUT_JAVA` tag to `YES` if your project consists of Java or Python sources only. Doxygen will then generate output that is more tailored for that language. For instance, namespaces will be presented as packages, qualified scopes will look different, etc.

  The default value is: `NO`.

`OPTIMIZE_FOR_FORTRAN`

  Set the `OPTIMIZE_FOR_FORTRAN` tag to `YES` if your project consists of Fortran sources. Doxygen will then generate output that is tailored for Fortran.

  The default value is: `NO`.

`OPTIMIZE_OUTPUT_VHDL`

  Set the `OPTIMIZE_OUTPUT_VHDL` tag to `YES` if your project consists of VHDL sources. Doxygen will then generate output that is tailored for VHDL.

  The default value is: `NO`.

`OPTIMIZE_OUTPUT_SLICE`

  Set the `OPTIMIZE_OUTPUT_SLICE` tag to `YES` if your project consists of Slice sources only. Doxygen will then generate output that is more tailored for that language. For instance, namespaces will be presented as modules, types will be separated into more groups, etc.

  The default value is: `NO`.

`EXTENSION_MAPPING`

  Doxygen selects the parser to use depending on the extension of the files it parses. With this tag you can assign which parser to use for a given extension. Doxygen has a built-in mapping, but you can override or extend it using this tag. The format is `ext=language`, where `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 FILE_PATTERNS otherwise the files are not read by Doxygen. When specifying `no_extension` you should add `*` to the FILE_PATTERNS.
  Note see also the list of default file extension mappings.

`MARKDOWN_SUPPORT`

  If the `MARKDOWN_SUPPORT` tag is enabled then Doxygen pre-processes all comments according to the Markdown format, which allows for more readable documentation. See https://daringfireball.net/projects/markdown/ for details. The output of markdown processing is further processed by Doxygen, so you can mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in case of backward compatibilities issues.

  The default value is: `YES`.

`TOC_INCLUDE_HEADINGS`

  When the `TOC_INCLUDE_HEADINGS` tag is set to a non-zero value, all headings up to that level are automatically included in the table of contents, even if they do not have an id attribute.

  Note
    This feature currently applies only to Markdown headings.

  Minimum value: `0`, maximum value: `99`, default value: `6`.

  This tag requires that the tag MARKDOWN_SUPPORT is set to `YES`.

`MARKDOWN_ID_STYLE`

  The `MARKDOWN_ID_STYLE` tag can be used to specify the algorithm used to generate identifiers for the Markdown headings. Note: Every identifier is unique.

  Possible values are: `DOXYGEN` use a fixed 'autotoc_md' string followed by a sequence number starting at 0 and `GITHUB` use the lower case version of title with any whitespace replaced by '-' and punctuation characters removed.

  The default value is: `DOXYGEN`.

  This tag requires that the tag MARKDOWN_SUPPORT is set to `YES`.

`AUTOLINK_SUPPORT`

  When enabled Doxygen tries to link words that correspond to documented classes, or namespaces to their corresponding documentation. Such a link can be prevented in individual cases by putting a `%` sign in front of the word or globally by setting `AUTOLINK_SUPPORT` to `NO`. Words listed in the `AUTOLINK_IGNORE_WORDS` tag are excluded from automatic linking.

  The default value is: `YES`.

`AUTOLINK_IGNORE_WORDS`

  This tag specifies a list of words that, when matching the start of a word in the documentation, will suppress auto links generation, if it is enabled via AUTOLINK_SUPPORT. This list does not affect affect links explicitly created using # or the \link or \ref commands.

  This tag requires that the tag AUTOLINK_SUPPORT is set to `YES`.

`BUILTIN_STL_SUPPORT`

  If you use STL classes (i.e. `std::string`, `std::vector`, etc.) but do not want to include (a tag file for) the STL sources as input, then you should set this tag to `YES` in order to let Doxygen match functions declarations and definitions whose arguments contain STL classes (e.g. `func(std::string`); versus `func(std::string) {}`). This also makes the inheritance and collaboration diagrams that involve STL classes more complete and accurate.

  The default value is: `NO`.

`CPP_CLI_SUPPORT`

  If you use Microsoft's C++/CLI language, you should set this option to `YES` to enable parsing support.

  The default value is: `NO`.

`SIP_SUPPORT`

  Set the `SIP_SUPPORT` tag to `YES` if your project consists of 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.

  The default value is: `NO`.

`IDL_PROPERTY_SUPPORT`

  For Microsoft's IDL there are `propget` and `propput` attributes to indicate getter and setter methods for a property. Setting this option to `YES` will make Doxygen to replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to `NO`.

  The default value is: `YES`.

`DISTRIBUTE_GROUP_DOC`

  If member grouping is used in the documentation and the `DISTRIBUTE_GROUP_DOC` tag is set to `YES` then Doxygen 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`.

`GROUP_NESTED_COMPOUNDS`

  If one adds a struct or class to a group and this option is enabled, then also any nested class or struct is added to the same group. By default this option is disabled and one has to add nested compounds explicitly via \ingroup.

  The default value is: `NO`.

`SUBGROUPING`

  Set the `SUBGROUPING` tag to `YES` to allow class member groups of the same type (for instance a group of public functions) to be put as a subgroup of that type (e.g. under the Public Functions section). Set it to `NO` to prevent subgrouping. Alternatively, this can be done per class using the \nosubgrouping command.

  The default value is: `YES`.

`INLINE_GROUPED_CLASSES`

  When the `INLINE_GROUPED_CLASSES` tag is set to `YES`, classes, structs and unions are shown inside the group in which they are included (e.g. using \ingroup) instead of on a separate page (for HTML and Man pages) or section (for and RTF).
  Note that this feature does not work in combination with SEPARATE_MEMBER_PAGES.

  The default value is: `NO`.

`INLINE_SIMPLE_STRUCTS`

  When the `INLINE_SIMPLE_STRUCTS` tag is set to `YES`, 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 (i.e. file, namespace, or group documentation), provided this scope is documented. If set to `NO`, structs, classes, and unions are shown on a separate page (for HTML and Man pages) or section (for and RTF).

  The default value is: `NO`.

`TYPEDEF_HIDES_STRUCT`

  When `TYPEDEF_HIDES_STRUCT` tag is enabled, a typedef of a struct, union, or enum is documented as struct, union, or enum with the name of the typedef. So `typedef struct TypeS {} TypeT`, will appear in the documentation as a struct with name `TypeT`. When disabled the typedef will appear as a member of a file, namespace, or class. And the struct will be named `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.

  The default value is: `NO`.

`LOOKUP_CACHE_SIZE`

  The size of the symbol lookup cache can be set using `LOOKUP_CACHE_SIZE`. This cache is used to resolve symbols given their name and scope. Since this can be an expensive process and often the same symbol appears multiple times in the code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small Doxygen will become slower. If the cache is too large, memory is wasted. The cache size is given by this formula: . The valid range is 0..9, the default is 0, corresponding to a cache size of symbols. At the end of a run Doxygen will report the cache usage and suggest the optimal cache size from a speed point of view.

  Minimum value: `0`, maximum value: `9`, default value: `0`.

`NUM_PROC_THREADS`

  The `NUM_PROC_THREADS` specifies the number of threads Doxygen is allowed to use during processing. When set to `0` Doxygen will based this on the number of cores available in the system. You can set it explicitly to a value larger than 0 to get more control over the balance between CPU load and processing speed. At this moment only the input processing can be done using multiple threads. Since this is still an experimental feature the default is set to 1, which effectively disables parallel processing. Please report any issues you encounter. Generating dot graphs in parallel is controlled by the `DOT_NUM_THREADS` setting.

  Minimum value: `0`, maximum value: `32`, default value: `1`.

`TIMESTAMP`

  If the `TIMESTAMP` tag is set different from `NO` then each generated page will contain the date or date and time when the page was generated. Setting this to `NO` can help when comparing the output of multiple runs.

  Possible values are: `YES`, `NO`, `DATETIME` and `DATE`.

  The default value is: `NO`.

# Build related configuration options

`EXTRACT_ALL`

  If the `EXTRACT_ALL` tag is set to `YES`, Doxygen will assume all entities in documentation are documented, even if no documentation was available. Private class members and static file members will be hidden unless the EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to `YES`.

  Note
    This will also disable the warnings about undocumented members that are normally produced when WARNINGS is set to `YES`.

  The default value is: `NO`.

`EXTRACT_PRIVATE`

  If the `EXTRACT_PRIVATE` tag is set to `YES`, all private members of a class will be included in the documentation.

  The default value is: `NO`.

`EXTRACT_PRIV_VIRTUAL`

  If the `EXTRACT_PRIV_VIRTUAL` tag is set to `YES`, documented private virtual methods of a class will be included in the documentation.

  The default value is: `NO`.

`EXTRACT_PACKAGE`

  If the `EXTRACT_PACKAGE` tag is set to `YES`, all members with package or internal scope will be included in the documentation.

  The default value is: `NO`.

`EXTRACT_STATIC`

  If the `EXTRACT_STATIC` tag is set to `YES`, all static members of a file will be included in the documentation.

  The default value is: `NO`.

`EXTRACT_LOCAL_CLASSES`

  If the `EXTRACT_LOCAL_CLASSES` tag is set to `YES`, 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. Does not have any effect for Java sources.

  The default value is: `YES`.

`EXTRACT_LOCAL_METHODS`

  This flag is only useful for Objective-C code. If set to `YES`, 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_ANON_NSPACES`

  If this flag is set to `YES`, the members of anonymous namespaces will be extracted and appear in the documentation as a namespace called 'anonymous_namespace{file}', where file will be replaced with the base name of the file that contains the anonymous namespace. By default anonymous namespace are hidden.

  The default value is: `NO`.

`RESOLVE_UNNAMED_PARAMS`

  If this flag is set to `YES`, the name of an unnamed parameter in a declaration will be determined by the corresponding definition. By default unnamed parameters remain unnamed in the output.

  The default value is: `YES`.

`HIDE_UNDOC_MEMBERS`

  If the `HIDE_UNDOC_MEMBERS` tag is set to `YES`, Doxygen 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 option has no effect if EXTRACT_ALL is enabled.

  The default value is: `NO`.

`HIDE_UNDOC_CLASSES`

  If the `HIDE_UNDOC_CLASSES` tag is set to `YES`, Doxygen will hide all undocumented classes that are normally visible in the class hierarchy. If set to `NO`, these classes will be included in the various overviews. This option will also hide undocumented C++ concepts if enabled. This option has no effect if EXTRACT_ALL is enabled.

  The default value is: `NO`.

`HIDE_UNDOC_NAMESPACES`

  If the `HIDE_UNDOC_NAMESPACES` tag is set to `YES`, Doxygen will hide all undocumented namespaces that are normally visible in the namespace hierarchy. If set to `NO`, these namespaces will be included in the various overviews. This option has no effect if EXTRACT_ALL is enabled.

  The default value is: `YES`.

`HIDE_FRIEND_COMPOUNDS`

  If the `HIDE_FRIEND_COMPOUNDS` tag is set to `YES`, Doxygen will hide all friend declarations. If set to `NO`, these declarations will be included in the documentation.

  The default value is: `NO`.

`HIDE_IN_BODY_DOCS`

  If the `HIDE_IN_BODY_DOCS` tag is set to `YES`, Doxygen 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`.

`INTERNAL_DOCS`

  The `INTERNAL_DOCS` tag determines if documentation that is typed after a \internal command is included. If the tag is set to `NO` then the documentation will be excluded. Set it to `YES` to include the internal documentation.

  The default value is: `NO`.

`CASE_SENSE_NAMES`

  With the correct setting of option `CASE_SENSE_NAMES` Doxygen will better be able to match the capabilities of the underlying filesystem.

  In case the filesystem is case sensitive (i.e. it supports files in the same directory whose names only differ in casing), the option must be set to `YES` to properly deal with such files in case they appear in the input.

  For filesystems that are not case sensitive the option should be set to `NO` to properly deal with output files written for symbols that only differ in casing, such as for two classes, one named `CLASS` and the other named `Class`, and to also support references to files without having to specify the exact matching casing.

  On Windows (including Cygwin) and macOS, users should typically set this option to `NO`, whereas on Linux or other Unix flavors it should typically be set to `YES`.

  Possible values are: `SYSTEM`, `NO` and `YES`.

  The default value is: `SYSTEM`.

`HIDE_SCOPE_NAMES`

  If the `HIDE_SCOPE_NAMES` tag is set to `NO` then Doxygen will show members 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_COMPOUND_REFERENCE`

  If the `HIDE_COMPOUND_REFERENCE` tag is set to `NO` (default) then Doxygen 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`.

`SHOW_HEADERFILE`

  If the `SHOW_HEADERFILE` tag is set to `YES` then the documentation for a class will show which file needs to be included to use the class.

  The default value is: `YES`.

`SHOW_INCLUDE_FILES`

  If the `SHOW_INCLUDE_FILES` tag is set to `YES` then Doxygen will put a list of the files that are included by a file in the documentation of that file.

  The default value is: `YES`.

`SHOW_GROUPED_MEMB_INC`

  If the `SHOW_GROUPED_MEMB_INC` tag is set to `YES` then Doxygen will add for each grouped member an include statement to the documentation, telling the reader which file to include in order to use the member.

  The default value is: `NO`.

`FORCE_LOCAL_INCLUDES`

  If the `FORCE_LOCAL_INCLUDES` tag is set to `YES` then Doxygen will list include files with double quotes in the documentation rather than with sharp brackets.

  The default value is: `NO`.

`INLINE_INFO`

  If the `INLINE_INFO` tag is set to `YES` then a tag [inline] is inserted in the documentation for inline members.

  The default value is: `YES`.

`SORT_MEMBER_DOCS`

  If the `SORT_MEMBER_DOCS` tag is set to `YES` then Doxygen will sort the (detailed) documentation of file and class members alphabetically by member name. If set to `NO`, the members will appear in declaration order.

  The default value is: `YES`.

`SORT_BRIEF_DOCS`

  If the `SORT_BRIEF_DOCS` tag is set to `YES` then Doxygen will sort the brief descriptions of file, namespace and class members alphabetically by member name. If set to `NO`, the members will appear in declaration order. Note that this will also influence the order of the classes in the class list.

  The default value is: `NO`.

`SORT_MEMBERS_CTORS_1ST`

  If the `SORT_MEMBERS_CTORS_1ST` tag is set to `YES` then Doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to `NO` the constructors will appear in the respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.

  Note
    If SORT_BRIEF_DOCS is set to `NO` this option is ignored for sorting brief member documentation.
    If SORT_MEMBER_DOCS is set to `NO` this option is ignored for sorting detailed member documentation.

  The default value is: `NO`.

`SORT_GROUP_NAMES`

  If the `SORT_GROUP_NAMES` tag is set to `YES` then Doxygen will sort the hierarchy of group names into alphabetical order. If set to `NO` the group names will appear in their defined order.

  The default value is: `NO`.

`SORT_BY_SCOPE_NAME`

  If the `SORT_BY_SCOPE_NAME` tag is set to `YES`, 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.

  Note
    This option is not very useful if HIDE_SCOPE_NAMES is set to `YES`.
    This option applies only to the class list, not to the alphabetical list.

  The default value is: `NO`.

`STRICT_PROTO_MATCHING`

  If the `STRICT_PROTO_MATCHING` option is enabled and Doxygen fails to do proper type resolution of all parameters of a function it will reject a match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling `STRICT_PROTO_MATCHING` Doxygen will still accept a match between prototype and implementation in such cases.

  The default value is: `NO`.

`GENERATE_TODOLIST`

  The `GENERATE_TODOLIST` tag can be 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_TESTLIST`

  The `GENERATE_TESTLIST` tag can be 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_BUGLIST`

  The `GENERATE_BUGLIST` tag can be 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_DEPRECATEDLIST`

  The `GENERATE_DEPRECATEDLIST` tag can be 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`.

`ENABLED_SECTIONS`

  The `ENABLED_SECTIONS` tag can be used to enable conditional documentation sections, marked by \if <section_label> ... \endif and \cond <section_label> ... \endcond blocks.

`MAX_INITIALIZER_LINES`

  The `MAX_INITIALIZER_LINES` tag determines the maximum number of lines that the initial value of a variable or macro / define can have for it to appear in the documentation. If the initializer consists of more lines than specified here it will be hidden. Use a value of 0 to hide initializers completely. The appearance of the value of individual variables and macros / defines can be controlled using \showinitializer or \hideinitializer command in the documentation regardless of this setting.

  Minimum value: `0`, maximum value: `10000`, default value: `30`.

`SHOW_USED_FILES`

  Set the `SHOW_USED_FILES` tag to `NO` to disable the list of files generated at the bottom of the documentation of classes and structs. If set to `YES`, the list will mention the files that were used to generate the documentation.

  The default value is: `YES`.

`SHOW_FILES`

  Set the `SHOW_FILES` 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_NAMESPACES`

  Set the `SHOW_NAMESPACES` 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`.

`FILE_VERSION_FILTER`

  The `FILE_VERSION_FILTER` tag can be used to specify a program or script that Doxygen should invoke to get the current version for each file (typically from the version control system). Doxygen will invoke the program by executing (via `popen()`) the command `command input-file`, where `command` is the value of the `FILE_VERSION_FILTER` tag, and `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:

       FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"

  Example shell script for CVS:

      #!/bin/sh
      cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\‍([0-9][0-9\.]*\‍).*/\1/p'

  Example shell script for Subversion:

      #!/bin/sh
      svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p'

  Example filter for ClearCase:

      FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"

`LAYOUT_FILE`

  The `LAYOUT_FILE` tag can be used to specify a layout file which will be parsed by Doxygen. The layout file controls the global structure of the generated output files in an output format independent way. To create the layout file that represents Doxygen's defaults, run Doxygen with the `-l` option. You can optionally specify a file name after the option, if omitted `DoxygenLayout.xml` will be used as the name of the layout file. See also section Changing the layout of pages for information.
  Note that if you run Doxygen from a directory containing a file called `DoxygenLayout.xml`, Doxygen will parse it automatically even if the `LAYOUT_FILE` tag is left empty.

`CITE_BIB_FILES`

  The `CITE_BIB_FILES` tag can be used to specify one or more `bib` files containing the reference definitions. This must be a list of `.bib` files. The `.bib` extension is automatically appended if omitted. This requires the `bibtex` tool to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. For the style of the bibliography can be controlled using LATEX_BIB_STYLE. To use this feature you need `bibtex` and `perl` available in the search path. See also \cite for info how to create references.

`EXTERNAL_TOOL_PATH`
  The `EXTERNAL_TOOL_PATH` tag can be used to extend the search path (PATH environment variable) so that external tools such as `latex` and `gs` can be found.
  Note
    Directories specified with EXTERNAL_TOOL_PATH are added in front of the path already specified by the PATH variable, and are added in the order specified.
    This option is particularly useful for macOS version 14 (Sonoma) and higher, when running Doxygen from Doxywizard, because in this case any user-defined changes to the PATH are ignored. A typical example on macOS is to set

        EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin

    together with the standard path, the full search path used by doxygen when launching external tools will then become

        PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin

# Configuration options related to warning and progress messages

`QUIET`

  The `QUIET` tag can be used to turn on/off the messages that are generated to standard output by Doxygen. If `QUIET` is set to `YES` this implies that the messages are off.

  The default value is: `NO`.

`WARNINGS`

  The `WARNINGS` tag can be used to turn on/off the warning messages that are generated to standard error (`stderr`) by Doxygen. If `WARNINGS` is set to `YES` this implies that the warnings are on.
  Tip: Turn warnings on while writing the documentation.

  The default value is: `YES`.

`WARN_IF_UNDOCUMENTED`

  If the `WARN_IF_UNDOCUMENTED` tag is set to `YES` then Doxygen will generate warnings for undocumented members. If EXTRACT_ALL is set to `YES` then this flag will automatically be disabled.

  The default value is: `YES`.

`WARN_IF_DOC_ERROR`

  If the `WARN_IF_DOC_ERROR` tag is set to `YES`, Doxygen will generate warnings for potential errors in the documentation, such as documenting some parameters in a documented function twice, or documenting parameters that don't exist or using markup commands wrongly.

  The default value is: `YES`.

`WARN_IF_INCOMPLETE_DOC`

  If `WARN_IF_INCOMPLETE_DOC` is set to `YES`, Doxygen will warn about incomplete function parameter documentation. If set to `NO`, Doxygen will accept that some parameters have no documentation without warning.

  The default value is: `YES`.

`WARN_NO_PARAMDOC`

  This `WARN_NO_PARAMDOC` option can be enabled to get warnings for functions that are documented, but have no documentation for their parameters or return value. If set to `NO`, Doxygen will only warn about wrong parameter documentation, but not about the absence of documentation. If EXTRACT_ALL is set to `YES` then this flag will automatically be disabled. See also WARN_IF_INCOMPLETE_DOC

  The default value is: `NO`.

`WARN_IF_UNDOC_ENUM_VAL`

  If `WARN_IF_UNDOC_ENUM_VAL` option is set to `YES`, Doxygen will warn about undocumented enumeration values. If set to `NO`, Doxygen will accept undocumented enumeration values. If EXTRACT_ALL is set to `YES` then this flag will automatically be disabled.

  The default value is: `NO`.

`WARN_LAYOUT_FILE`

  If `WARN_LAYOUT_FILE` option is set to `YES`, Doxygen will warn about issues found while parsing the user defined layout file, such as missing or wrong elements. See also LAYOUT_FILE for details. If set to `NO`, problems with the layout file will be suppressed.

  The default value is: `YES`.

`WARN_AS_ERROR`

  If the `WARN_AS_ERROR` tag is set to `YES` then Doxygen will immediately stop when a warning is encountered. If the `WARN_AS_ERROR` tag is set to `FAIL_ON_WARNINGS` then Doxygen will continue running as if `WARN_AS_ERROR` tag is set to `NO`, but at the end of the Doxygen process Doxygen will return with a non-zero status. If the `WARN_AS_ERROR` tag is set to `FAIL_ON_WARNINGS_PRINT` then Doxygen behaves like `FAIL_ON_WARNINGS` but in case no WARN_LOGFILE is defined Doxygen will not write the warning messages in between other messages but write them at the end of a run, in case a WARN_LOGFILE is defined the warning messages will be besides being in the defined file also be shown at the end of a run, unless the WARN_LOGFILE is defined as `-` i.e. standard output (`stdout`) in that case the behavior will remain as with the setting `FAIL_ON_WARNINGS`.

  Possible values are: `NO`, `YES`, `FAIL_ON_WARNINGS` and `FAIL_ON_WARNINGS_PRINT`.

  The default value is: `NO`.

`WARN_FORMAT`

  The `WARN_FORMAT` tag determines the format of the warning messages that Doxygen can produce. The string should contain the `$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 FILE_VERSION_FILTER)

  See also
    WARN_LINE_FORMAT

  The default value is: `$file:$line: $text`.

`WARN_LINE_FORMAT`

  In the `$text` part of the WARN_FORMAT command it is possible that a reference to a more specific place is given. To make it easier to jump to this place (outside of Doxygen) the user can define a custom "cut" / "paste" string.

  Example:

        WARN_LINE_FORMAT = "'vi $file +$line'"

  See also
    WARN_FORMAT

  The default value is: `at line $line of file $file`.

`WARN_LOGFILE`

  The `WARN_LOGFILE` tag can be used to specify a file to which warning and error messages should be written. If left blank the output is written to standard error (`stderr`). In case the file specified cannot be opened for writing the warning and error messages are written to standard error. When as file `-` is specified the warning and error messages are written to standard output (`stdout`).

# Configuration options related to the input files

`INPUT`

  The `INPUT` tag is used to specify the files and/or directories that contain documented source files. You may enter file names like `myfile.cpp` or directories like `/usr/src/myproject`. Separate the files or directories with spaces. See also FILE_PATTERNS and EXTENSION_MAPPING

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

`INPUT_ENCODING`

  This tag can be used to specify the character encoding of the source files that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses `libiconv` (or the `iconv` built into `libc`) for the transcoding. See the libiconv documentation for the list of possible encodings.

  See also
    INPUT_FILE_ENCODING

  The default value is: `UTF-8`.

`INPUT_FILE_ENCODING`

  This tag can be used to specify the character encoding of the source files that Doxygen parses. The `INPUT_FILE_ENCODING` tag can be used to specify character encoding on a per file pattern basis. Doxygen will compare the file name with each pattern and apply the encoding instead of the default INPUT_ENCODING if there is a match. The character encodings are a list of the form: pattern=encoding (like `*.php=ISO-8859-1`).

  See also
    INPUT_ENCODING for further information on supported encodings.

`FILE_PATTERNS`

  If the value of the INPUT tag contains directories, you can use the `FILE_PATTERNS` tag to specify one or more wildcard patterns (like `*.cpp` and `*.h`) to filter out the source-files in the directories.
  Note that for custom extensions or not directly supported extensions you also need to set 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 default file extension mappings.
  If left blank the following patterns are tested: `*.c`, `*.cc`, `*.cxx`, `*.cxxm`, `*.cpp`, `*.cppm`, `*.ccm`, `*.c++`, `*.c++m`, `*.java`, `*.ii`, `*.ixx`, `*.ipp`, `*.i++`, `*.inl`, `*.idl`, `*.ddl`, `*.odl`, `*.h`, `*.hh`, `*.hxx`, `*.hpp`, `*.h++`, `*.ixx`, `*.l`, `*.cs`, `*.d`, `*.php`, `*.php4`, `*.php5`, `*.phtml`, `*.inc`, `*.m`, `*.markdown`, `*.md`, `*.mm`, `*.dox` (to be provided as Doxygen C comment), `*.py`, `*.pyw`, `*.f90`, `*.f95`, `*.f03`, `*.f08`, `*.f18`, `*.f`, `*.for`, `*.vhd`, `*.vhdl`, `*.ucf`, `*.qsf` and `*.ice`.

`RECURSIVE`

  The `RECURSIVE` tag can be used to specify whether or not subdirectories should be searched for input files as well.

  The default value is: `NO`.

`EXCLUDE`

  The `EXCLUDE` tag can be used to specify files and/or directories that should be excluded from the INPUT source files. This way you can easily exclude a subdirectory from a directory tree whose root is specified with the INPUT tag.
  Note that relative paths are relative to the directory from which Doxygen is run.

`EXCLUDE_SYMLINKS`

  The `EXCLUDE_SYMLINKS` tag can be used to select whether or not files or directories that are symbolic links (a Unix file system feature) are excluded from the input.

  The default value is: `NO`.

`EXCLUDE_PATTERNS`

  If the value of the INPUT tag contains directories, you can use the `EXCLUDE_PATTERNS` tag to specify one or more wildcard patterns to exclude certain files from those directories.
  Note that the wildcards are matched against the file with absolute path, so to exclude all test directories for example use the pattern `*``/test/``*`

`EXCLUDE_SYMBOLS`

  The `EXCLUDE_SYMBOLS` tag can be used to specify one or more symbol names (namespaces, classes, functions, etc.) that should be excluded from the output. The symbol name can be a fully qualified name, a word, or if the wildcard `*` is used, a substring. Examples: `ANamespace`, `AClass`, `ANamespace::AClass`, `ANamespace::*Test`

`EXAMPLE_PATH`

  The `EXAMPLE_PATH` tag can be used to specify one or more files or directories that contain example code fragments that are included (see the \include command).

`EXAMPLE_PATTERNS`

  If the value of the EXAMPLE_PATH tag contains directories, you can use the `EXAMPLE_PATTERNS` tag to specify one or more wildcard pattern (like `*.cpp` and `*.h`) to filter out the source-files in the directories. If left blank all files are included.

`EXAMPLE_RECURSIVE`

  If the `EXAMPLE_RECURSIVE` tag is set to `YES` then subdirectories will be searched for input files to be used with the \include or \dontinclude commands irrespective of the value of the RECURSIVE tag.

  The default value is: `NO`.

`IMAGE_PATH`

  The `IMAGE_PATH` tag can be used to specify one or more files or directories that contain images that are to be included in the documentation (see the \image command).

`INPUT_FILTER`

  The `INPUT_FILTER` tag can be used to specify a program that Doxygen should invoke to filter for each input file. Doxygen will invoke the filter program by executing (via `popen()`) the command:
  `<filter> <input-file>`
  where `<filter>` is the value of the `INPUT_FILTER` tag, and `<input-file>` is the name of an input file. Doxygen will then use the output that the filter program writes to standard output. If 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 Doxygen will use the data processed and written to standard output for further processing, therefore nothing else, like debug statements or used commands (so in case of a Windows batch file always use `@echo OFF`), should be written to standard output.
  Note that for custom extensions or not directly supported extensions you also need to set EXTENSION_MAPPING for the extension otherwise the files are not properly processed by Doxygen.

`FILTER_PATTERNS`

  The `FILTER_PATTERNS` tag can be used to specify filters on a per file pattern basis. Doxygen will compare the file name with each pattern and apply the filter if there is a match. The filters are a list of the form: pattern=filter (like `*.cpp=my_cpp_filter`). See INPUT_FILTER for further information on how filters are used. If the `FILTER_PATTERNS` tag is empty or if none of the patterns match the file name, INPUT_FILTER is applied.
  Note that for custom extensions or not directly supported extensions you also need to set EXTENSION_MAPPING for the extension otherwise the files are not properly processed by Doxygen.

`FILTER_SOURCE_FILES`

  If the `FILTER_SOURCE_FILES` tag is set to `YES`, the input filter (if set using INPUT_FILTER) will also be used to filter the input files that are used for producing the source files to browse (i.e. when SOURCE_BROWSER is set to `YES`).

  The default value is: `NO`.

`FILTER_SOURCE_PATTERNS`

  The `FILTER_SOURCE_PATTERNS` tag can be used to specify source filters per file pattern. A pattern will override the setting for FILTER_PATTERN (if any) and it is also possible to disable source filtering for a specific pattern using `*.ext=` (so without naming a filter).

  This tag requires that the tag FILTER_SOURCE_FILES is set to `YES`.

`USE_MDFILE_AS_MAINPAGE`

  If the `USE_MDFILE_AS_MAINPAGE` tag refers to the name of a markdown file that is part of the input, its contents will be placed on the main page (`index.html`). This can be useful if you have a project on for instance GitHub and want to reuse the introduction page also for the Doxygen output.

`IMPLICIT_DIR_DOCS`

  If the `IMPLICIT_DIR_DOCS` tag is set to `YES`, any `README.md` file found in sub-directories of the project's root, is used as the documentation for that sub-directory, except when the `README.md` starts with a \dir, \page or \mainpage command. If set to `NO`, the `README.md` file needs to start with an explicit \dir command in order to be used as directory documentation.

  The default value is: `YES`.

`FORTRAN_COMMENT_AFTER`

  The Fortran standard specifies that for fixed formatted Fortran code all characters from position 72 are to be considered as comment. A common extension is to allow longer lines before the automatic comment starts. The setting `FORTRAN_COMMENT_AFTER` will also make it possible that longer lines can be processed before the automatic comment starts.

  Minimum value: `7`, maximum value: `10000`, default value: `72`.

# Configuration options related to source browsing

`SOURCE_BROWSER`

  If the `SOURCE_BROWSER` tag is set to `YES` then a list of source files will be generated. Documented entities will be cross-referenced with these sources.
  Note: To get rid of all source code in the generated output, make sure that also VERBATIM_HEADERS is set to `NO`.

  The default value is: `NO`.

`INLINE_SOURCES`

  Setting the `INLINE_SOURCES` tag to `YES` will include the body of functions, multi-line macros, enums or list initialized variables directly into the documentation.

  The default value is: `NO`.

`STRIP_CODE_COMMENTS`

  Setting the `STRIP_CODE_COMMENTS` tag to `YES` will instruct Doxygen to 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`.

`REFERENCED_BY_RELATION`

  If the `REFERENCED_BY_RELATION` tag is set to `YES` then for each documented entity all documented functions referencing it will be listed.

  The default value is: `NO`.

`REFERENCES_RELATION`

  If the `REFERENCES_RELATION` tag is set to `YES` then for each documented function all documented entities called/used by that function will be listed.

  The default value is: `NO`.

`REFERENCES_LINK_SOURCE`

  If the `REFERENCES_LINK_SOURCE` tag is set to `YES` and SOURCE_BROWSER tag is set to `YES` then the hyperlinks from functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will link to the documentation.

  The default value is: `YES`.

`SOURCE_TOOLTIPS`

  If `SOURCE_TOOLTIPS` is enabled (the default) then hovering a hyperlink in the source code will show a tooltip with additional information such as prototype, brief description and links to the definition and documentation. Since this will make the HTML file larger and loading of large files a bit slower, you can opt to disable this feature.

  The default value is: `YES`.

  This tag requires that the tag SOURCE_BROWSER is set to `YES`.

`USE_HTAGS`

  If the `USE_HTAGS` tag is set to `YES` then the references to source code will point to the HTML generated by the `htags(1)` tool instead of Doxygen built-in source browser. The `htags` tool is part of GNU's global source tagging system (see https://www.gnu.org/software/global/global.html). You will need version 4.8.6 or higher.
  To use it do the following:

  1. Install the latest version of `global`
  2. Enable SOURCE_BROWSER and `USE_HTAGS` in the configuration file
  3. Make sure the INPUT points to the root of the source tree
  4. Run `doxygen` as normal
     Doxygen will invoke `htags` (and that will in turn invoke `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 `htags`.

  The default value is: `NO`.

  This tag requires that the tag SOURCE_BROWSER is set to `YES`.

`VERBATIM_HEADERS`

  If the `VERBATIM_HEADERS` tag is set the `YES` then Doxygen will generate a verbatim copy of the header file for each class for which an include is specified. Set to `NO` to disable this.

  See also
    Section \class.

  The default value is: `YES`.

`CLANG_ASSISTED_PARSING`

  If the `CLANG_ASSISTED_PARSING` tag is set to `YES` then Doxygen will use the 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.

  The default value is: `NO`.

`CLANG_ADD_INC_PATHS`

  If the `CLANG_ASSISTED_PARSING` tag is set to `YES` and the `CLANG_ADD_INC_PATHS` tag is set to `YES` then Doxygen will add the directory of each input to the include path.

  The default value is: `YES`.

  This tag requires that the tag CLANG_ASSISTED_PARSING is set to `YES`.

`CLANG_OPTIONS`

  If clang assisted parsing is enabled you can provide the compiler with command line options that you would normally use when invoking the compiler. Note that the include paths will already be set by Doxygen for the files and directories specified with INPUT and INCLUDE_PATH.

  This tag requires that the tag CLANG_ASSISTED_PARSING is set to `YES`.

`CLANG_DATABASE_PATH`

  If clang assisted parsing is enabled you can provide the clang parser with the path to the directory containing a file called `compile_commands.json`. This file is the 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 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.

# Configuration options related to the alphabetical class index

`ALPHABETICAL_INDEX`

  If the `ALPHABETICAL_INDEX` tag is set to `YES`, an alphabetical index of all compounds will be generated. Enable this if the project contains a lot of classes, structs, unions or interfaces.

  The default value is: `YES`.

`IGNORE_PREFIX`

  The `IGNORE_PREFIX` tag can be used to specify a prefix (or a list of prefixes) that should be ignored while generating the index headers. The `IGNORE_PREFIX` tag works for classes, function and member names. The entity will be placed in the alphabetical list under the first letter of the entity name that remains after removing the prefix.

  This tag requires that the tag ALPHABETICAL_INDEX is set to `YES`.

# Configuration options related to the HTML output

`GENERATE_HTML`

  If the `GENERATE_HTML` tag is set to `YES`, Doxygen will generate HTML output

  The default value is: `YES`.

`HTML_OUTPUT`

  The `HTML_OUTPUT` tag is used to specify where the HTML docs will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it.

  The default directory is: `html`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_FILE_EXTENSION`

  The `HTML_FILE_EXTENSION` tag can be used to specify the file extension for each generated HTML page (for example: `.htm, .php, .asp`).

  The default value is: `.html`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_HEADER`

  The `HTML_HEADER` tag can be used to specify a user-defined HTML header file for each generated HTML page. If the tag is left blank Doxygen will generate a standard header.
  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 GENERATE_TREEVIEW). It is highly recommended to start with a default header using

      doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile

  and then modify the file `new_header.html`.

  See also section 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. The following markers have a special meaning inside the header and footer:
    `$title`
      will be replaced with the title of the page.
    `$datetime`
      will be replaced with the current date and time.
    `$date`
      will be replaced with the current date.
    `$time`
      will be replaced with the current time.
    `$year`
      will be replaces with the current year.
    `$showdate(<format>)`
      will be replaced with the current date and time according to the format as specified by `<format>`. The `<format>` follows the rules as specified for the \showdate command with the exception that no `)` is allowed in the `<format>`.
    `$doxygenversion`
      will be replaced with the version of Doxygen
    `$projectname`
      will be replaced with the name of the project (see PROJECT_NAME)
    `$projectnumber`
      will be replaced with the project number (see PROJECT_NUMBER)
    `$projectbrief`
      will be replaced with the project brief description (see PROJECT_BRIEF)
    `$projectlogo`
      will be replaced with the project logo (see PROJECT_LOGO)
    `$generatedby`
      will be replaced with the output language dependent version of the text "Generated by" or when the 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 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 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 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 SEARCHENGINE is disabled).
    `$searchbox`
      will be replaced with the HTML code needed for the search box to be shown (or an empty string when 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 USE_MATHJAX is disabled).
    `$relpath^`
      If 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 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:

       <!--BEGIN BLOCKNAME-->
       Some context copied when condition BLOCKNAME holds
       <!--END BLOCKNAME-->
       <!--BEGIN !BLOCKNAME-->
       Some context copied when condition BLOCKNAME does not hold
       <!--END !BLOCKNAME-->

  The following block names are supported:

  `DISABLE_INDEX`
    Content within this block is copied to the output if the DISABLE_INDEX option is enabled (so when the index is disabled).
  `GENERATE_TREEVIEW`
    Content within this block is copied to the output if the GENERATE_TREEVIEW option is enabled.
  `SEARCHENGINE`
    Content within this block is copied to the output if the SEARCHENGINE option is enabled.
  `PROJECT_NAME`
    Content within the block is copied to the output if the PROJECT_NAME option is not empty.
  `PROJECT_NUMBER`
    Content within the block is copied to the output if the PROJECT_NUMBER option is not empty.
  `PROJECT_BRIEF`
    Content within the block is copied to the output if the PROJECT_BRIEF option is not empty.
  `PROJECT_LOGO`
    Content within the block is copied to the output if the PROJECT_LOGO option is not empty.
  `FULL_SIDEBAR`
    Content within the block is copied to the output if the FULL_SIDEBAR, DISABLE_INDEX and 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 PROJECT_NAME, PROJECT_BRIEF, PROJECT_LOGO is filled in or if both DISABLE_INDEX and SEARCHENGINE are enabled.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_FOOTER`

  The `HTML_FOOTER` tag can be used to specify a user-defined HTML footer for each generated HTML page. If the tag is left blank Doxygen will generate a standard footer.

  See HTML_HEADER for more information on how to generate a default footer and what special commands can be used inside the footer.

  See also section Doxygen usage for information on how to generate the default footer that Doxygen normally uses.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_STYLESHEET`

  The `HTML_STYLESHEET` tag can be used to specify a user-defined cascading style sheet that is used by each HTML page. It can be used to fine-tune the look of the HTML output. If left blank Doxygen will generate a default style sheet.

  See also section Doxygen usage for information on how to generate the style sheet that Doxygen normally uses.

  Note
    It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as it is more robust and this tag (`HTML_STYLESHEET`) will in the future become obsolete.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_EXTRA_STYLESHEET`
  The `HTML_EXTRA_STYLESHEET` tag can be used to specify additional user-defined cascading style sheets that are included after the standard style sheets created by Doxygen. Using this option one can overrule certain style aspects. This is preferred over using HTML_STYLESHEET since it does not replace the standard style sheet and is therefore more robust against future updates. Doxygen will copy the style sheet files to the output directory.
  Note
    The order of the extra style sheet files is of importance (e.g. the last style sheet in the list overrules the setting of the previous ones in the list).
    Since the styling of scrollbars can currently not be overruled in Webkit/Chromium, the styling will be left out of the default doxygen.css if one or more extra stylesheets have been specified. So if scrollbar customization is desired it has to be added explicitly. Here is an example style sheet that gives the contents area a fixed width:

        body {
                background-color: #CCC;
                color: black;
                margin: 0;
        }

        div.contents {
                margin-bottom: 10px;
                padding: 12px;
                margin-left: auto;
                margin-right: auto;
                width: 960px;
                background-color: white;
                border-radius: 8px;
        }

        #titlearea {
                background-color: white;
        }

        hr.footer {
                display: none;
        }

        .footer {
                background-color: #AAA;
        }

  This tag requires that the tag GENERATE_HTML is set to `YES`.
`HTML_EXTRA_FILES`

  The `HTML_EXTRA_FILES` tag can be used to specify one or more extra images or other source files which should be copied to the HTML output directory. Note that these files will be copied to the base HTML output directory. Use the `$relpath^` marker in the HTML_HEADER and/or HTML_FOOTER files to load these files. In the 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.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_COLORSTYLE`

  The `HTML_COLORSTYLE` tag can be used to specify if the generated HTML output should be rendered with a dark or light theme.

  Possible values are: `LIGHT` always generates light mode output, `DARK` always generates dark mode output, `AUTO_LIGHT` automatically sets the mode according to the user preference, uses light mode if no preference is set (the default), `AUTO_DARK` automatically sets the mode according to the user preference, uses dark mode if no preference is set and `TOGGLE` allows a user to switch between light and dark mode via a button.

  The default value is: `AUTO_LIGHT`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_COLORSTYLE_HUE`

  The `HTML_COLORSTYLE_HUE` tag controls the color of the HTML output. Doxygen will adjust the colors in the style sheet and background images according to this color. Hue is specified as an angle on a color-wheel, see https://en.wikipedia.org/wiki/Hue for more information. For instance the value 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 purple, and 360 is red again.

  Minimum value: `0`, maximum value: `359`, default value: `220`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_COLORSTYLE_SAT`

  The `HTML_COLORSTYLE_SAT` tag controls the purity (or saturation) of the colors in the HTML output. For a value of 0 the output will use gray-scales only. A value of 255 will produce the most vivid colors.

  Minimum value: `0`, maximum value: `255`, default value: `100`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_COLORSTYLE_GAMMA`

  The `HTML_COLORSTYLE_GAMMA` tag controls the gamma correction applied to the luminance component of the colors in the HTML output. Values below 100 gradually make the output lighter, whereas values above 100 make the output darker. The value divided by 100 is the actual gamma applied, so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not change the gamma.

  Minimum value: `40`, maximum value: `240`, default value: `80`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_DYNAMIC_MENUS`

  If the `HTML_DYNAMIC_MENUS` tag is set to `YES` then the generated HTML documentation will contain a main index with vertical navigation menus that are dynamically created via JavaScript. If disabled, the navigation index will consists of multiple levels of tabs that are statically embedded in every HTML page. Disable this option to support browsers that do not have JavaScript, like the Qt help browser.

  The default value is: `YES`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_DYNAMIC_SECTIONS`

  If the `HTML_DYNAMIC_SECTIONS` tag is set to `YES` then the generated HTML documentation will contain sections that can be hidden and shown after the page has loaded.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_CODE_FOLDING`

  If the `HTML_CODE_FOLDING` tag is set to `YES` then classes and functions can be dynamically folded and expanded in the generated HTML source code.

  The default value is: `YES`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_COPY_CLIPBOARD`

  If the `HTML_COPY_CLIPBOARD` tag is set to `YES` then Doxygen will show an icon in the top right corner of code and text fragments that allows the user to copy its content to the clipboard. Note this only works if supported by the browser and the web page is served via a secure context, i.e. using the https: or file: protocol.

  The default value is: `YES`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_PROJECT_COOKIE`

  Doxygen stores a couple of settings persistently in the browser (via e.g. cookies). By default these settings apply to all HTML pages generated by Doxygen across all projects. The `HTML_PROJECT_COOKIE` tag can be used to store the settings under a project specific key, such that the user preferences will be stored separately.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_INDEX_NUM_ENTRIES`

  With `HTML_INDEX_NUM_ENTRIES` one can control the preferred number of entries shown in the various tree structured indices initially; the user can expand and collapse entries dynamically later on. Doxygen will expand the tree to such a level that at most the specified number of entries are visible (unless a fully collapsed tree already exceeds this amount). So setting the number of entries 1 will produce a full collapsed tree by default. 0 is a special value representing an infinite number of entries and will result in a full expanded tree by default.

  Minimum value: `0`, maximum value: `9999`, default value: `100`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`GENERATE_DOCSET`

  If the `GENERATE_DOCSET` tag is set to `YES`, additional index files will be generated that can be used as input for 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 `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.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`DOCSET_FEEDNAME`

  This tag determines the name of the docset feed. A documentation feed provides an umbrella under which multiple documentation sets from a single provider (such as a company or product suite) can be grouped.

  The default value is: `Doxygen generated docs`.

  This tag requires that the tag GENERATE_DOCSET is set to `YES`.

`DOCSET_FEEDURL`

  This tag determines the URL of the docset feed. A documentation feed provides an umbrella under which multiple documentation sets from a single provider (such as a company or product suite) can be grouped.

  This tag requires that the tag GENERATE_DOCSET is set to `YES`.

`DOCSET_BUNDLE_ID`

  This tag specifies a string that should uniquely identify the documentation set bundle. This should be a reverse domain-name style string, e.g. `com.mycompany.MyDocSet`. Doxygen will append `.docset` to the name.

  The default value is: `org.doxygen.Project`.

  This tag requires that the tag GENERATE_DOCSET is set to `YES`.

`DOCSET_PUBLISHER_ID`

  The `DOCSET_PUBLISHER_ID` tag specifies a string that should uniquely identify the documentation publisher. This should be a reverse domain-name style string, e.g. `com.mycompany.MyDocSet.documentation`.

  The default value is: `org.doxygen.Publisher`.

  This tag requires that the tag GENERATE_DOCSET is set to `YES`.

`DOCSET_PUBLISHER_NAME`

  The `DOCSET_PUBLISHER_NAME` tag identifies the documentation publisher.

  The default value is: `Publisher`.

  This tag requires that the tag GENERATE_DOCSET is set to `YES`.

`GENERATE_HTMLHELP`

  If the `GENERATE_HTMLHELP` tag is set to `YES` then Doxygen generates three additional HTML index files: `index.hhp`, `index.hhc`, and `index.hhk`. The `index.hhp` is a project file that can be read by Microsoft's HTML Help Workshop on Windows. In the beginning of 2021 Microsoft took the original page, with a.o. the download links, offline (the HTML help workshop was already many years in maintenance mode). You can download the HTML help workshop from the web archives at 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.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`CHM_FILE`

  The `CHM_FILE` tag can be used to specify the file name of the resulting `.chm` file. You can add a path in front of the file if the result should not be written to the html output directory.

  This tag requires that the tag GENERATE_HTMLHELP is set to `YES`.

`HHC_LOCATION`

  The `HHC_LOCATION` tag can be used to specify the location (absolute path including file name) of the HTML help compiler (`hhc.exe`). If non-empty, Doxygen 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 that the tag GENERATE_HTMLHELP is set to `YES`.

`GENERATE_CHI`

  The `GENERATE_CHI` flag controls if a separate `.chi` index file is generated (`YES`) or that it should be included in the main `.chm` file (`NO`).

  The default value is: `NO`.

  This tag requires that the tag GENERATE_HTMLHELP is set to `YES`.

`CHM_INDEX_ENCODING`

  The `CHM_INDEX_ENCODING` is used to encode HtmlHelp index (`hhk`), content (`hhc`) and project file content.

  This tag requires that the tag GENERATE_HTMLHELP is set to `YES`.

`BINARY_TOC`

  The `BINARY_TOC` flag controls whether a binary table of contents is generated (`YES`) or a normal table of contents (`NO`) in the `.chm` file. Furthermore it enables the `Previous` and `Next` buttons.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_HTMLHELP is set to `YES`.

`TOC_EXPAND`

  The `TOC_EXPAND` flag can be set to `YES` to add extra items for group members to the table of contents of the HTML help documentation and to the tree view.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_HTMLHELP is set to `YES`.

`SITEMAP_URL`

  The `SITEMAP_URL` tag is used to specify the full URL of the place where the generated documentation will be placed on the server by the user during the deployment of the documentation. The generated sitemap is called `sitemap.xml` and placed on the directory specified by HTML_OUTPUT. In case no `SITEMAP_URL` is specified no sitemap is generated. For information about the sitemap protocol see https://www.sitemaps.org

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`GENERATE_QHP`

  If the `GENERATE_QHP` tag is set to `YES` and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help (`.qch`) of the generated HTML documentation.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`QCH_FILE`

  If the QHG_LOCATION tag is specified, the `QCH_FILE` tag can be used to specify the file name of the resulting `.qch` file. The path specified is relative to the HTML output folder.

  This tag requires that the tag GENERATE_QHP is set to `YES`.

`QHP_NAMESPACE`

  The `QHP_NAMESPACE` tag specifies the namespace to use when generating Qt Help Project output. For more information please see Qt Help Project / Namespace.

  The default value is: `org.doxygen.Project`.

  This tag requires that the tag GENERATE_QHP is set to `YES`.

`QHP_VIRTUAL_FOLDER`

  The `QHP_VIRTUAL_FOLDER` tag specifies the namespace to use when generating Qt Help Project output. For more information please see Qt Help Project / Virtual Folders.

  The default value is: `doc`.

  This tag requires that the tag GENERATE_QHP is set to `YES`.

`QHP_CUST_FILTER_NAME`

  If the `QHP_CUST_FILTER_NAME` tag is set, it specifies the name of a custom filter to add. For more information please see Qt Help Project / Custom Filters.

  This tag requires that the tag GENERATE_QHP is set to `YES`.

`QHP_CUST_FILTER_ATTRS`

  The `QHP_CUST_FILTER_ATTRS` tag specifies the list of the attributes of the custom filter to add. For more information please see Qt Help Project / Custom Filters.

  This tag requires that the tag GENERATE_QHP is set to `YES`.

`QHP_SECT_FILTER_ATTRS`

  The `QHP_SECT_FILTER_ATTRS` tag specifies the list of the attributes this project's filter section matches. Qt Help Project / Filter Attributes.

  This tag requires that the tag GENERATE_QHP is set to `YES`.

`QHG_LOCATION`

  The `QHG_LOCATION` tag can be used to specify the location (absolute path including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to run qhelpgenerator on the generated `.qhp` file.

  This tag requires that the tag GENERATE_QHP is set to `YES`.

`GENERATE_ECLIPSEHELP`

  If the `GENERATE_ECLIPSEHELP` tag is set to `YES`, additional index files will be generated, together with the HTML files, they form an `Eclipse` help plugin.

  To install this plugin and make it available under the help contents menu in `Eclipse`, the contents of the directory containing the HTML and XML files needs to 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 value.

  After copying `Eclipse` needs to be restarted before the help appears.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`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.doxygen.Project`.

  This tag requires that the tag GENERATE_ECLIPSEHELP is set to `YES`.

`DISABLE_INDEX`

  If you want full control over the layout of the generated HTML pages it might be necessary to disable the index and replace it with your own. The `DISABLE_INDEX` tag can be used to turn on/off the condensed index (tabs) at top of each HTML page. A value of `NO` enables the index and the value `YES` disables it. 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_TREEVIEW to `YES`.

  The default value is: `YES`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`GENERATE_TREEVIEW`

  The `GENERATE_TREEVIEW` tag is used to specify whether a tree-like index structure should be generated to display hierarchical information. If the tag value is set to `YES`, a side panel will be generated containing a tree-like index structure (just like the one that is generated for HTML Help). For this to work a browser that supports JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). Windows users are probably better off using the HTML help feature.

  Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can further fine tune the look of the index (see Fine-tuning the output). As an example, the default style sheet generated by Doxygen has an example that shows how to put an image at the root of the tree instead of the PROJECT_NAME.

  Since the tree basically has the same information as the tab index, you could consider setting DISABLE_INDEX to `YES` when enabling this option.

  The default value is: `YES`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`FULL_SIDEBAR`

  When both GENERATE_TREEVIEW and DISABLE_INDEX are set to `YES`, then the `FULL_SIDEBAR` option determines if the side bar is limited to only the treeview area (value `NO`) or if it should extend to the full height of the window (value `YES`). Setting this to `YES` gives a layout similar to https://docs.readthedocs.io with more room for contents, but less room for the project logo, title, and description.

  If either GENERATE_TREEVIEW or DISABLE_INDEX is set to `NO`, this option has no effect.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`ENUM_VALUES_PER_LINE`

  The `ENUM_VALUES_PER_LINE` tag can be used to set the number of enum values that Doxygen will group on one line in the generated HTML documentation.
  Note that a value of 0 will completely suppress the enum values from appearing in the overview section.

  Minimum value: `0`, maximum value: `20`, default value: `4`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`SHOW_ENUM_VALUES`

  When the `SHOW_ENUM_VALUES` tag is set doxygen will show the specified enumeration values besides the enumeration mnemonics.

  The default value is: `NO`.

`TREEVIEW_WIDTH`

  If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used to set the initial width (in pixels) of the frame in which the tree is shown.

  Minimum value: `0`, maximum value: `1500`, default value: `250`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`EXT_LINKS_IN_WINDOW`

  If the `EXT_LINKS_IN_WINDOW` option is set to `YES`, Doxygen will open links to external symbols imported via tag files in a separate window.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`OBFUSCATE_EMAILS`

  If the `OBFUSCATE_EMAILS` tag is set to `YES`, Doxygen will obfuscate email addresses.

  The default value is: `YES`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`HTML_FORMULA_FORMAT`

  If the `HTML_FORMULA_FORMAT` option is set to `svg`, Doxygen will use the pdf2svg tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see https://inkscape.org) to generate formulas as SVG images instead of PNGs for the HTML output. These images will generally look nicer at scaled resolutions.

  Possible values are: `png` (the default) and `svg` (looks nicer but requires the pdf2svg or inkscape tool).

  The default value is: `png`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`FORMULA_FONTSIZE`

  Use this tag to change the font size of formulas included as images in the HTML documentation. When you change the font size after a successful Doxygen run you need to manually remove any `form_*.png` images from the HTML output directory to force them to be regenerated.

  Minimum value: `8`, maximum value: `50`, default value: `10`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`FORMULA_MACROFILE`

  The `FORMULA_MACROFILE` can contain `\newcommand` and `\renewcommand` commands to create new commands to be used in formulas as building blocks. See the section Including formulas for details.

`USE_MATHJAX`

  Enable the `USE_MATHJAX` option to render formulas using MathJax (see https://www.mathjax.org) which uses client side JavaScript for the rendering instead of using pre-rendered bitmaps. Use this if you do not have installed or if you want to formulas look prettier in the HTML output. When enabled you may also need to install MathJax separately and configure the path to it using the MATHJAX_RELPATH option.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`MATHJAX_VERSION`

  With `MATHJAX_VERSION` it is possible to specify the MathJax version to be used. Note that the different versions of MathJax have different requirements with regards to the different settings, so it is possible that also other MathJax settings have to be changed when switching between the different MathJax versions.

  Possible values are: `MathJax_2` and `MathJax_3`.

  The default value is: `MathJax_2`.

  This tag requires that the tag USE_MATHJAX is set to `YES`.

`MATHJAX_FORMAT`

  When MathJax is enabled you can set the default output format to be used for the MathJax output. For more details about the output format see MathJax version 2 and MathJax version 3.

  Possible values are: `HTML-CSS` (which is slower, but has the best compatibility. This is the name for Mathjax version 2, for MathJax version 3 this will be translated into `chtml`), `NativeMML` (i.e. MathML. Only supported for MathJax 2. For MathJax version 3 `chtml` will be used instead.), `chtml` (This is the name for Mathjax version 3, for MathJax version 2 this will be translated into `HTML-CSS`) and `SVG`.

  The default value is: `HTML-CSS`.

  This tag requires that the tag USE_MATHJAX is set to `YES`.

`MATHJAX_RELPATH`

  When MathJax is enabled you need to specify the location relative to the HTML output directory using the `MATHJAX_RELPATH` option. The destination directory should contain the `MathJax.js` script. For instance, if the `mathjax` directory is located at the same level as the HTML output directory, then `MATHJAX_RELPATH` should be `../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

  This tag requires that the tag USE_MATHJAX is set to `YES`.

`MATHJAX_EXTENSIONS`

  The `MATHJAX_EXTENSIONS` tag can be used to specify one or more MathJax extension names that should be enabled during MathJax rendering. For example for MathJax version 2 (see https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):

      MATHJAX_EXTENSIONS     = TeX/AMSmath TeX/AMSsymbols

  For example for MathJax version 3 (see http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):

      MATHJAX_EXTENSIONS     = ams

  This tag requires that the tag USE_MATHJAX is set to `YES`.

`MATHJAX_CODEFILE`

  The `MATHJAX_CODEFILE` tag can be used to specify a file with JavaScript pieces of code that will be used on startup of the MathJax code. See the MathJax site for more details. As an example to disable the "Math Renderer" menu item in the "Math Settings" menu of MathJax:

      MATHJAX_CODEFILE = disableRenderer.js

  with in the file `disableRenderer.js`:

        MathJax.Hub.Config({
         menuSettings: {
          showRenderer: false,
         }
        });

  This tag requires that the tag USE_MATHJAX is set to `YES`.

`SEARCHENGINE`

  When the `SEARCHENGINE` tag is enabled Doxygen will generate a search box for the HTML output. The underlying search engine uses JavaScript and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should typically be disabled. For large projects the JavaScript based search engine can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.

  It is possible to search using the keyboard; to jump to the search box use `<access key> + S` (what the `<access key>` is depends on the OS and browser, but it is typically `<CTRL>`, `<ALT>`/`<option>`, or both). Inside the search box use the `<cursor down key>` to jump into the search results window, the results can be navigated using the `<cursor keys>`. Press `<Enter>` to select an item or `<escape>` to cancel the search. The filter options can be selected when the cursor is inside the search box by pressing `<Shift>+<cursor down>`. Also here use the `<cursor keys>` to select a filter and `<Enter>` or `<escape>` to activate or cancel the filter option.

  The default value is: `YES`.

  This tag requires that the tag GENERATE_HTML is set to `YES`.

`SERVER_BASED_SEARCH`

  When the `SERVER_BASED_SEARCH` tag is enabled 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 the EXTERNAL_SEARCH setting. When disabled, Doxygen 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. See the section External Indexing and Searching for details.

  The default value is: `NO`.

  This tag requires that the tag SEARCHENGINE is set to `YES`.

`EXTERNAL_SEARCH`

  When `EXTERNAL_SEARCH` tag is enabled Doxygen will no longer generate the PHP script for searching. Instead the search results are written to an XML file which needs to be processed by an external indexer. Doxygen will invoke an external search engine pointed to by the SEARCHENGINE_URL option to obtain the search results.
  Doxygen ships with an example indexer (`doxyindexer`) and search engine (`doxysearch.cgi`) which are based on the open source search engine library Xapian.
  See the section External Indexing and Searching for details.

  The default value is: `NO`.

  This tag requires that the tag SEARCHENGINE is set to `YES`.

`SEARCHENGINE_URL`

  The `SEARCHENGINE_URL` should point to a search engine hosted by a web server which will return the search results when EXTERNAL_SEARCH is enabled.
  Doxygen ships with an example indexer (`doxyindexer`) and search engine (`doxysearch.cgi`) which are based on the open source search engine library Xapian. See the section External Indexing and Searching for details.

  This tag requires that the tag SEARCHENGINE is set to `YES`.

`SEARCHDATA_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 tool. With the `SEARCHDATA_FILE` tag the name of this file can be specified.

  The default file is: `searchdata.xml`.

  This tag requires that the tag SEARCHENGINE is set to `YES`.

`EXTERNAL_SEARCH_ID`

  When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the `EXTERNAL_SEARCH_ID` tag can be used as an identifier for the project. This is useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple projects and redirect the results back to the right project.

  This tag requires that the tag SEARCHENGINE is set to `YES`.

`EXTRA_SEARCH_MAPPINGS`

  The `EXTRA_SEARCH_MAPPINGS` tag can be used to enable searching through Doxygen projects other than the one defined by this configuration file, but that are all added to the same external search index. Each project needs to have a unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of to a relative location where the documentation can be found.

  The format is:

      EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...

  This tag requires that the tag SEARCHENGINE is set to `YES`.

# Configuration options related to the LaTeX output

`GENERATE_LATEX`

  If the `GENERATE_LATEX` tag is set to `YES`, Doxygen will generate output.

  The default value is: `YES`.

`LATEX_OUTPUT`

  The `LATEX_OUTPUT` tag is used to specify where the docs will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it.

  The default directory is: `latex`.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`LATEX_CMD_NAME`

  The `LATEX_CMD_NAME` tag can be used to specify the command name to be invoked.
  Note that when not enabling USE_PDFLATEX the default is `latex` when enabling USE_PDFLATEX the default is `pdflatex` and when in the later case `latex` is chosen this is overwritten by `pdflatex`. For specific output languages the default can have been set differently, this depends on the implementation of the output language.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`MAKEINDEX_CMD_NAME`

  The `MAKEINDEX_CMD_NAME` tag can be used to specify the command name to generate index for .

  Note
    This tag is used in the `Makefile` / `make.bat`.
  See also
    LATEX_MAKEINDEX_CMD for the part in the generated output file (`.tex`).

  The default file is: `makeindex`.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`LATEX_MAKEINDEX_CMD`

  The `LATEX_MAKEINDEX_CMD` tag can be used to specify the command name to generate index for . In case there is no backslash (`\`) as first character it will be automatically added in the code.

  Note
    This tag is used in the generated output file (`.tex`).
  See also
    MAKEINDEX_CMD_NAME for the part in the `Makefile` / `make.bat`.

  The default value is: `makeindex`.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`COMPACT_LATEX`

  If the `COMPACT_LATEX` tag is set to `YES`, Doxygen generates more compact documents. This may be useful for small projects and may help to save some trees in general.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`PAPER_TYPE`

  The `PAPER_TYPE` tag can be used to set the paper type that is 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 that the tag GENERATE_LATEX is set to `YES`.

`EXTRA_PACKAGES`

  The `EXTRA_PACKAGES` tag can be used to specify one or more package names that should be included in the output. The package can be specified just by its name or with the correct syntax as to be used with the `\usepackage` command.

  To get the `times` font for instance you can specify :

        EXTRA_PACKAGES=times
      or
        EXTRA_PACKAGES={times}

  To use the option `intlimits` with the `amsmath` package you can specify:

         EXTRA_PACKAGES=[intlimits]{amsmath}

  If left blank no extra packages will be included.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`LATEX_HEADER`

  The `LATEX_HEADER` tag can be used to specify a user-defined header for the generated document. The header should contain everything until the first chapter. If it is left blank Doxygen will generate a standard header.

  It is highly recommended to start with a default header using

      doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty

  and then modify the file `new_header.tex`.

  See also section Doxygen usage for information on how to generate the default header that Doxygen normally uses.

  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 the current date and time.
    `$date`
      will be replaced with the current date.
    `$time`
      will be replaced with the current time.
    `$year`
      will be replaces with the current year.
    `$showdate(<format>)`
      will be replaced with the current date and time according to the format as specified by `<format>`. The `<format>` follows the rules as specified for the \showdate command with the exception that no `)` is allowed in the `<format>`.
    `$doxygenversion`
      will be replaced with the version of Doxygen
    `$projectname`
      will be replaced with the name of the project (see PROJECT_NAME)
    `$projectnumber`
      will be replaced with the project number (see PROJECT_NUMBER)
    `$projectbrief`
      will be replaced with the project brief description (see PROJECT_BRIEF)
    `$projectlogo`
      will be replaced with the project logo (see 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 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 set by 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 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 PAPER_TYPE and the word "paper" is directly appended to it to have a correct paper type.
    `$langISO`
      will be replaced by the ISO language name.
    `$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 LATEX_EMOJI_DIRECTORY with the backslashes replaced by forward slashes (so usable by ). In case the LATEX_EMOJI_DIRECTORY is empty, the current directory will be used.
    `$makeindex`
      will be replaced by the command as set in 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 EXTRA_PACKAGES.
    `$extralatexstylesheet`
      will be replaced by commands for using the packages set in 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 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:

       %%BEGIN BLOCKNAME
       Some context copied when condition BLOCKNAME holds
       %%END BLOCKNAME
       %%BEGIN !BLOCKNAME
       Some context copied when condition BLOCKNAME does not hold
       %%END !BLOCKNAME

  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 COMPACT_LATEX option is enabled.
  `PDF_HYPERLINKS`
    Content within this block is copied to the output when the PDF_HYPERLINKS option is enabled.
  `USE_PDFLATEX`
    Content within this block is copied to the output when the USE_PDFLATEX option is enabled.
  `LATEX_BATCHMODE`
    Content within this block is copied to the output when the LATEX_BATCHMODE option is enabled.
  `TIMESTAMP`
    Content within this block is copied to the output when the 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 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`.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`LATEX_FOOTER`

  The `LATEX_FOOTER` tag can be used to specify a user-defined footer for the generated document. The footer should contain everything after the last chapter. If it is left blank Doxygen will generate a standard footer.

  See LATEX_HEADER for more information on how to generate a default footer and what special commands can be used inside the footer.

  See also section Doxygen usage for information on how to generate the default footer that Doxygen normally uses.

  Note: Only use a user-defined footer if you know what you are doing!

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`LATEX_EXTRA_STYLESHEET`
  The `LATEX_EXTRA_STYLESHEET` tag can be used to specify additional user-defined style sheets that are included after the standard style sheets created by Doxygen. Using this option one can overrule certain style aspects. Doxygen will copy the style sheet files to the output directory.
  Note
    The order of the extra style sheet files is of importance (e.g. the last style sheet in the list overrules the setting of the previous ones in the list).
  This tag requires that the tag GENERATE_LATEX is set to `YES`.
`LATEX_EXTRA_FILES`

  The `LATEX_EXTRA_FILES` tag can be used to specify one or more extra images or other source files which should be copied to the LATEX_OUTPUT output directory. Note that the files will be copied as-is; there are no commands or markers available.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`PDF_HYPERLINKS`

  If the `PDF_HYPERLINKS` tag is set to `YES`, the that is generated is prepared for conversion to PDF (using `ps2pdf` or `pdflatex`). The PDF file will contain links (just like the HTML output) instead of page references. This makes the output suitable for online browsing using a PDF viewer.

  The default value is: `YES`.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`USE_PDFLATEX`

  If the `USE_PDFLATEX` tag is set to `YES`, Doxygen will use the engine as specified with LATEX_CMD_NAME to generate the PDF file directly from the files. Set this option to `YES`, to get a higher quality PDF documentation.
  See also section LATEX_CMD_NAME for selecting the engine.

  The default value is: `YES`.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`LATEX_BATCHMODE`

  The `LATEX_BATCHMODE` tag signals the behavior of in case of an error.

  Possible values are: `NO` same as ERROR_STOP, `YES` same as BATCH, `BATCH` In batch mode nothing is printed on the terminal, errors are scrolled as if <return> is hit at every error; missing files that TeX tries to input or request from keyboard input (\read on a not open input stream) cause the job to abort, `NON_STOP` In nonstop mode the diagnostic message will appear on the terminal, but there is no possibility of user interaction just like in batch mode, `SCROLL` In scroll mode, TeX will stop only for missing files to input or if keyboard input is necessary and `ERROR_STOP` In errorstop mode, TeX will stop at each error, asking for user intervention.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`LATEX_HIDE_INDICES`

  If the `LATEX_HIDE_INDICES` tag is set to `YES` then Doxygen will not include the index chapters (such as File Index, Compound Index, etc.) in the output.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`LATEX_BIB_STYLE`

  The `LATEX_BIB_STYLE` tag can be used to specify the style to use for the bibliography, e.g. `plainnat`, or `ieeetr`. See https://en.wikipedia.org/wiki/BibTeX and \cite for more info.

  The default value is: `plainnat`.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

`LATEX_EMOJI_DIRECTORY`

  The `LATEX_EMOJI_DIRECTORY` tag is used to specify the (relative or absolute) path from which the emoji images will be read. If a relative path is entered, it will be relative to the LATEX_OUTPUT directory. If left blank the LATEX_OUTPUT directory will be used.

  This tag requires that the tag GENERATE_LATEX is set to `YES`.

# Configuration options related to the RTF output

`GENERATE_RTF`

  If the `GENERATE_RTF` tag is set to `YES`, Doxygen will generate RTF output. The RTF output is optimized for Word 97 and may not look too pretty with other RTF readers/editors.

  The default value is: `NO`.

`RTF_OUTPUT`

  The `RTF_OUTPUT` tag is used to specify where the RTF docs will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it.

  The default directory is: `rtf`.

  This tag requires that the tag GENERATE_RTF is set to `YES`.

`COMPACT_RTF`

  If the `COMPACT_RTF` tag is set to `YES`, Doxygen generates more compact RTF documents. This may be useful for small projects and may help to save some trees in general.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_RTF is set to `YES`.

`RTF_HYPERLINKS`

  If the `RTF_HYPERLINKS` tag is set to `YES`, the RTF that is generated will contain hyperlink fields. The RTF file will contain links (just like the HTML output) instead of page references. This makes the output suitable for online browsing using Word or some other Word compatible readers that support those fields.

  Note: WordPad (write) and others do not support links.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_RTF is set to `YES`.

`RTF_STYLESHEET_FILE`

  Load stylesheet definitions from file. Syntax is similar to Doxygen's configuration file, i.e. a series of assignments. You only have to provide replacements, missing definitions are set to their default value.
  See also section Doxygen usage for information on how to generate the default style sheet that Doxygen normally uses.

  This tag requires that the tag GENERATE_RTF is set to `YES`.

`RTF_EXTENSIONS_FILE`

  Set optional variables used in the generation of an RTF document. Syntax is similar to Doxygen's configuration file. A template extensions file can be generated using `doxygen -e rtf extensionFile`.

  This tag requires that the tag GENERATE_RTF is set to `YES`.

`RTF_EXTRA_FILES`

  The `RTF_EXTRA_FILES` tag can be used to specify one or more extra images or other source files which should be copied to the RTF_OUTPUT output directory. Note that the files will be copied as-is; there are no commands or markers available.

  This tag requires that the tag GENERATE_RTF is set to `YES`.

# Configuration options related to the man page output

`GENERATE_MAN`

  If the `GENERATE_MAN` tag is set to `YES`, Doxygen will generate man pages for classes and files.

  The default value is: `NO`.

`MAN_OUTPUT`

  The `MAN_OUTPUT` tag is used to specify where the man pages will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it. A directory `man3` will be created inside the directory specified by `MAN_OUTPUT`.

  The default directory is: `man`.

  This tag requires that the tag GENERATE_MAN is set to `YES`.

`MAN_EXTENSION`

  The `MAN_EXTENSION` tag determines the extension that 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 the `MAN_EXTENSION` tag is optional.

  The default value is: `.3`.

  This tag requires that the tag GENERATE_MAN is set to `YES`.

`MAN_SUBDIR`

  The `MAN_SUBDIR` tag determines the name of the directory created within `MAN_OUTPUT` in which the man pages are placed. If defaults to man followed by `MAN_EXTENSION` with the initial . removed.

  This tag requires that the tag GENERATE_MAN is set to `YES`.

`MAN_LINKS`

  If the `MAN_LINKS` tag is set to `YES` and Doxygen generates man output, then it will generate one additional man file for each entity documented in the real man page(s). These additional files only source the real man page, but without them the `man` command would be unable to find the correct page.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_MAN is set to `YES`.

# Configuration options related to the XML output

`GENERATE_XML`

  If the `GENERATE_XML` tag is set to `YES`, Doxygen will generate an XML file that captures the structure of the code including all documentation.

  The default value is: `NO`.

`XML_OUTPUT`

  The `XML_OUTPUT` tag is used to specify where the XML pages will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it.

  The default directory is: `xml`.

  This tag requires that the tag GENERATE_XML is set to `YES`.

`XML_PROGRAMLISTING`

  If the `XML_PROGRAMLISTING` tag is set to `YES`, Doxygen will dump the program listings (including syntax highlighting and cross-referencing information) to the XML output. Note that enabling this will significantly increase the size of the XML output.

  The default value is: `YES`.

  This tag requires that the tag GENERATE_XML is set to `YES`.

`XML_NS_MEMB_FILE_SCOPE`

  If the `XML_NS_MEMB_FILE_SCOPE` tag is set to `YES`, Doxygen will include namespace members in file scope as well, matching the HTML output.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_XML is set to `YES`.

# Configuration options related to the DOCBOOK output

`GENERATE_DOCBOOK`

  If the `GENERATE_DOCBOOK` tag is set to `YES`, Doxygen will generate Docbook files that can be used to generate PDF.

  The default value is: `NO`.

`DOCBOOK_OUTPUT`

  The `DOCBOOK_OUTPUT` tag is used to specify where the Docbook pages will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it.

  The default directory is: `docbook`.

  This tag requires that the tag GENERATE_DOCBOOK is set to `YES`.

# Configuration options for the AutoGen Definitions output

`GENERATE_AUTOGEN_DEF`

  If the `GENERATE_AUTOGEN_DEF` tag is set to `YES`, Doxygen will generate an AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures the structure of the code including all documentation. Note that this feature is still experimental and incomplete at the moment.

  The default value is: `NO`.

# Configuration options related to Sqlite3 output

`GENERATE_SQLITE3`

  If the `GENERATE_SQLITE3` tag is set to `YES` Doxygen will generate a `Sqlite3` database with symbols found by Doxygen stored in tables.

  The default value is: `NO`.

`SQLITE3_OUTPUT`

  The `SQLITE3_OUTPUT` tag is used to specify where the `Sqlite3` database will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it.

  The default directory is: `sqlite3`.

  This tag requires that the tag GENERATE_SQLITE3 is set to `YES`.

`SQLITE3_RECREATE_DB`

  The `SQLITE3_RECREATE_DB` tag is set to `YES`, the existing doxygen_sqlite3.db database file will be recreated with each Doxygen run. If set to `NO`, Doxygen will warn if a database file is already found and not modify it.

  The default value is: `YES`.

  This tag requires that the tag GENERATE_SQLITE3 is set to `YES`.

# Configuration options related to the Perl module output

`GENERATE_PERLMOD`

  If the `GENERATE_PERLMOD` tag is set to `YES`, Doxygen will generate a Perl module file that captures the structure of the code including all documentation.
  Note that this feature is still experimental and incomplete at the moment.

  The default value is: `NO`.

`PERLMOD_LATEX`

  If the `PERLMOD_LATEX` tag is set to `YES`, Doxygen will generate the necessary `Makefile` rules, `Perl` scripts and code to be able to generate PDF and DVI output from the Perl module output.

  The default value is: `NO`.

  This tag requires that the tag GENERATE_PERLMOD is set to `YES`.

`PERLMOD_PRETTY`

  If the `PERLMOD_PRETTY` tag is set to `YES`, the Perl module output will be nicely formatted so it can be parsed by a human reader. This is useful if you want to understand what is going on. On the other hand, if this tag is set to `NO`, the size of the Perl module output will be much smaller and Perl will parse it just the same.

  The default value is: `YES`.

  This tag requires that the tag GENERATE_PERLMOD is set to `YES`.

`PERLMOD_MAKEVAR_PREFIX`

  The names of the make variables in the generated `doxyrules.make` file are prefixed with the string contained in `PERLMOD_MAKEVAR_PREFIX`. This is useful so different `doxyrules.make` files included by the same `Makefile` don't overwrite each other's variables.

  This tag requires that the tag GENERATE_PERLMOD is set to `YES`.

# Configuration options related to the preprocessor

`ENABLE_PREPROCESSING`

  If the `ENABLE_PREPROCESSING` tag is set to `YES`, Doxygen will evaluate all C-preprocessor directives found in the sources and include files.

  The default value is: `YES`.

`MACRO_EXPANSION`

  If the `MACRO_EXPANSION` tag is set to `YES`, Doxygen 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_PREDEF to `YES`.

  The default value is: `NO`.

  This tag requires that the tag ENABLE_PREPROCESSING is set to `YES`.

`EXPAND_ONLY_PREDEF`

  If the `EXPAND_ONLY_PREDEF` and MACRO_EXPANSION tags are both set to `YES` then the macro expansion is limited to the macros specified with the PREDEFINED and EXPAND_AS_DEFINED tags.

  The default value is: `NO`.

  This tag requires that the tag ENABLE_PREPROCESSING is set to `YES`.

`SEARCH_INCLUDES`

  If the `SEARCH_INCLUDES` tag is set to `YES`, the include files in the INCLUDE_PATH will be searched if a `#include` is found.

  The default value is: `YES`.

  This tag requires that the tag ENABLE_PREPROCESSING is set to `YES`.

`INCLUDE_PATH`

  The `INCLUDE_PATH` tag can be used to specify one or more directories that contain include files that are not input files but should be processed by the preprocessor.

  Note that the `INCLUDE_PATH` is not recursive, so the setting of RECURSIVE has no effect here.

  This tag requires that the tag SEARCH_INCLUDES is set to `YES`.

`INCLUDE_FILE_PATTERNS`

  You can use the `INCLUDE_FILE_PATTERNS` tag to specify one or more wildcard patterns (like `*.h` and `*.hpp`) to filter out the header-files in the directories. If left blank, the patterns specified with FILE_PATTERNS will be used.

  This tag requires that the tag ENABLE_PREPROCESSING is set to `YES`.

`PREDEFINED`

  The `PREDEFINED` tag can be used to specify one or more macro names that are defined before the preprocessor is started (similar to the `-D` option of e.g. `gcc`). The argument of the tag is a list of macros of the form: `name` or `name=definition` (no spaces). If the definition and the `"="` are omitted, `"=1"` is assumed. To prevent a macro definition from being undefined via `#undef` or recursively expanded use the `:=` operator instead of the `=` operator.

  This tag requires that the tag ENABLE_PREPROCESSING is set to `YES`.

`EXPAND_AS_DEFINED`

  If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to `YES` then this tag can be used to specify a list of macro names that should be expanded. The macro definition that is found in the sources will be used. Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code.

  This tag requires that the tag ENABLE_PREPROCESSING is set to `YES`.

`SKIP_FUNCTION_MACROS`

  If the `SKIP_FUNCTION_MACROS` tag is set to `YES` then Doxygen's preprocessor will remove all references to function-like macros that are alone on a line, have an all uppercase name, 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 that the tag ENABLE_PREPROCESSING is set to `YES`.

# Configuration options related to external references

`TAGFILES`

  The `TAGFILES` tag can be used to specify one or more tag files.

  For each tag file the location of the external documentation should be added. The format of a tag file without this location is as follows:

        TAGFILES = file1 file2 ...

  Adding location for the tag files is done as follows:

        TAGFILES = file1=loc1 "file2 = loc2" ...

  where `loc1` and `loc2` can be relative or absolute paths or URLs. See the section Linking to external documentation for more information about the use of tag files.

  Note
    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 Doxygen is run, you must also specify the path to the tagfile here.

`GENERATE_TAGFILE`

  When a file name is specified after `GENERATE_TAGFILE`, Doxygen will create a tag file that is based on the input files it reads. See section Linking to external documentation for more information about the usage of tag files.

`ALLEXTERNALS`

  If the `ALLEXTERNALS` tag is set to `YES`, all external classes and namespaces will be listed in the class and namespace index. If set to `NO`, only the inherited external classes will be listed.

  The default value is: `NO`.

`EXTERNAL_GROUPS`

  If the `EXTERNAL_GROUPS` tag is set to `YES`, all external groups will be listed in the topic index. If set to `NO`, only the current project's groups will be listed.

  The default value is: `YES`.

`EXTERNAL_PAGES`

  If the `EXTERNAL_PAGES` tag is set to `YES`, 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`.

# Configuration options related to diagram generator tools

`HIDE_UNDOC_RELATIONS`

  If set to `YES` 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`.

`HAVE_DOT`

  If you set the `HAVE_DOT` tag to `YES` then Doxygen will assume the `dot` tool is available from the `path`. This tool is part of 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 `NO`

  The default value is: `NO`.

`DOT_NUM_THREADS`

  The `DOT_NUM_THREADS` specifies the number of `dot` invocations Doxygen is allowed to run in parallel. When set to `0` Doxygen will base this on the number of processors available in the system. You can set it explicitly to a value larger than 0 to get control over the balance between CPU load and processing speed.

  Minimum value: `0`, maximum value: `32`, default value: `0`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`DOT_COMMON_ATTR`

  `DOT_COMMON_ATTR` is common attributes for nodes, edges and labels of subgraphs. When you want a differently looking font in the dot files that Doxygen generates you can specify fontname, fontcolor and fontsize attributes. For details please see Node, Edge and Graph Attributes specification You need to make sure dot is able to find the font, which can be done by putting it in a standard location or by setting the `DOTFONTPATH` environment variable or by setting DOT_FONTPATH to the directory containing the font. Default graphviz fontsize is 14.

  The default value is: `fontname=Helvetica,fontsize=10`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`DOT_EDGE_ATTR`

  `DOT_EDGE_ATTR` is concatenated with DOT_COMMON_ATTR. For elegant style you can add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. Complete documentation about arrows shapes.

  The default value is: `labelfontname=Helvetica,labelfontsize=10`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`DOT_NODE_ATTR`

  `DOT_NODE_ATTR` is concatenated with DOT_COMMON_ATTR. For view without boxes around nodes set 'shape=plain' or 'shape=plaintext' Shapes specification

  The default value is: `shape=box,height=0.2,width=0.4`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`DOT_FONTPATH`

  You can set the path where `dot` can find font specified with fontname in DOT_COMMON_ATTR and others dot attributes.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`CLASS_GRAPH`

  If the `CLASS_GRAPH` tag is set to `YES` or `GRAPH` or `BUILTIN` then Doxygen will generate a graph for each documented class showing the direct and indirect inheritance relations. In case the `CLASS_GRAPH` tag is set to `YES` or `GRAPH` and HAVE_DOT is enabled as well, then `dot` will be used to draw the graph. In case the `CLASS_GRAPH` tag is set to `YES` and HAVE_DOT is disabled or if the `CLASS_GRAPH` tag is set to `BUILTIN`, then the built-in generator will be used. If the `CLASS_GRAPH` tag is set to `TEXT` the direct and indirect inheritance relations will be shown as texts / links. Explicit enabling an inheritance graph or choosing a different representation for an inheritance graph of a specific class, can be accomplished by means of the command \inheritancegraph. Disabling an inheritance graph can be accomplished by means of the command \hideinheritancegraph.

  Possible values are: `NO`, `YES`, `TEXT`, `GRAPH` and `BUILTIN`.

  The default value is: `YES`.

`COLLABORATION_GRAPH`

  If the `COLLABORATION_GRAPH` tag is set to `YES` then Doxygen 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. Explicit enabling a collaboration graph, when `COLLABORATION_GRAPH` is set to `NO`, can be accomplished by means of the command \collaborationgraph. Disabling a collaboration graph can be accomplished by means of the command \hidecollaborationgraph.

  The default value is: `YES`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`GROUP_GRAPHS`

  If the `GROUP_GRAPHS` tag is set to `YES` then Doxygen will generate a graph for groups, showing the direct groups dependencies. Explicit enabling a group dependency graph, when `GROUP_GRAPHS` is set to `NO`, can be accomplished by means of the command \groupgraph. Disabling a directory graph can be accomplished by means of the command \hidegroupgraph.

  See also the chapter Grouping in the manual.

  The default value is: `YES`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`UML_LOOK`

  If the `UML_LOOK` tag is set to `YES`, Doxygen 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 that the tag HAVE_DOT 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. The `UML_LIMIT_NUM_FIELDS` threshold limits the number of items for each type to make the size more manageable. Set this to 0 for no limit. Note that the threshold may be exceeded by 50% before the limit is enforced. So when you set the threshold to 10, up to 15 fields may appear, but if the number exceeds 15, the total amount of fields shown is limited to 10.

  Minimum value: `0`, maximum value: `100`, default value: `10`.

  This tag requires that the tag UML_LOOK is set to `YES`.

`DOT_UML_DETAILS`

  If the `DOT_UML_DETAILS` tag is set to `NO`, Doxygen will show attributes and methods without types and arguments in the UML graphs. If the `DOT_UML_DETAILS` tag is set to `YES`, Doxygen will add type and arguments for attributes and methods in the UML graphs. If the `DOT_UML_DETAILS` tag is set to `NONE`, Doxygen will not generate fields with class member information in the UML graphs. The class diagrams will look similar to the default class diagrams but using UML notation for the relationships.

  Possible values are: `NO`, `YES` and `NONE`.

  The default value is: `NO`.

  This tag requires that the tag UML_LOOK is set to `YES`.

`DOT_WRAP_THRESHOLD`

  The `DOT_WRAP_THRESHOLD` tag can be used to set the maximum number of characters to display on a single line. If the actual line length exceeds this threshold significantly it will be wrapped across multiple lines. Some heuristics are applied to avoid ugly line breaks.

  Minimum value: `0`, maximum value: `1000`, default value: `17`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`TEMPLATE_RELATIONS`

  If the `TEMPLATE_RELATIONS` tag is set to `YES` then the inheritance and collaboration graphs will show the relations between templates and their instances.

  The default value is: `NO`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`INCLUDE_GRAPH`

  If the `INCLUDE_GRAPH`, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to `YES` then Doxygen will generate a graph for each documented file showing the direct and indirect include dependencies of the file with other documented files. Explicit enabling an include graph, when `INCLUDE_GRAPH` is is set to `NO`, can be accomplished by means of the command \includegraph. Disabling an include graph can be accomplished by means of the command \hideincludegraph.

  The default value is: `YES`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`INCLUDED_BY_GRAPH`

  If the `INCLUDED_BY_GRAPH`, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to `YES` then Doxygen will generate a graph for each documented file showing the direct and indirect include dependencies of the file with other documented files. Explicit enabling an included by graph, when `INCLUDED_BY_GRAPH` is set to `NO`, can be accomplished by means of the command \includedbygraph. Disabling an included by graph can be accomplished by means of the command \hideincludedbygraph.

  The default value is: `YES`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`CALL_GRAPH`

  If the `CALL_GRAPH` tag is set to `YES` then Doxygen will generate a call dependency graph for every global function or class method.
  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 \callgraph command. Disabling a call graph can be accomplished by means of the command \hidecallgraph.

  The default value is: `NO`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`CALLER_GRAPH`

  If the `CALLER_GRAPH` tag is set to `YES` then Doxygen will generate a caller dependency graph for every global function or class method.
  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 \callergraph command. Disabling a caller graph can be accomplished by means of the command \hidecallergraph.

  The default value is: `NO`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`GRAPHICAL_HIERARCHY`

  If the `GRAPHICAL_HIERARCHY` tag is set to `YES` then Doxygen will graphical hierarchy of all classes instead of a textual one.

  The default value is: `YES`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`DIRECTORY_GRAPH`

  If the `DIRECTORY_GRAPH` tag is set to `YES` then Doxygen will show the dependencies a directory has on other directories in a graphical way. The dependency relations are determined by the `#include` relations between the files in the directories. Explicit enabling a directory graph, when `DIRECTORY_GRAPH` is set to `NO`, can be accomplished by means of the command \directorygraph. Disabling a directory graph can be accomplished by means of the command \hidedirectorygraph.

  The default value is: `YES`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`DIR_GRAPH_MAX_DEPTH`

  The `DIR_GRAPH_MAX_DEPTH` tag can be used to limit the maximum number of levels of child directories generated in directory dependency graphs by `dot`.

  Minimum value: `1`, maximum value: `25`, default value: `1`.

  This tag requires that the tag DIRECTORY_GRAPH is set to `YES`.

`DOT_IMAGE_FORMAT`

  The `DOT_IMAGE_FORMAT` tag can be used to set the image format of the images generated by `dot`. For an explanation of the image formats see the section output formats in the documentation of the `dot` tool (Graphviz).
  Note the formats `svg:cairo` and `svg:cairo:cairo` cannot be used in combination with INTERACTIVE_SVG (the INTERACTIVE_SVG will be set to `NO`).

  Possible values are: `png`, `jpg`, `gif`, `svg`, `png:gd`, `png:gd:gd`, `png:cairo`, `png:cairo:gd`, `png:cairo:cairo`, `png:cairo:gdiplus`, `png:gdiplus`, `png:gdiplus:gdiplus`, `svg:cairo`, `svg:cairo:cairo`, `svg:svg`, `svg:svg:core`, `gif:cairo`, `gif:cairo:gd`, `gif:cairo:gdiplus`, `gif:gdiplus`, `gif:gdiplus:gdiplus`, `gif:gd`, `gif:gd:gd`, `jpg:cairo`, `jpg:cairo:gd`, `jpg:cairo:gdiplus`, `jpg:gd`, `jpg:gd:gd`, `jpg:gdiplus` and `jpg:gdiplus:gdiplus`.

  The default value is: `png`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`INTERACTIVE_SVG`

  If DOT_IMAGE_FORMAT is set to `svg` or `svg:svg` or `svg:svg:core`, then this option can be set to `YES` to enable generation of interactive SVG images that allow zooming and panning.
  Note that this requires a modern browser other than Internet Explorer. Tested and working are Firefox, Chrome, Safari, and Opera.
  Note This option will be automatically disabled when DOT_IMAGE_FORMAT is set to `svg:cairo` or `svg:cairo:cairo`.

  The default value is: `NO`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`DOT_PATH`

  The `DOT_PATH` tag can be used to specify the path where the `dot` tool can be found. If left blank, it is assumed the `dot` tool can be found in the `path`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`DOTFILE_DIRS`

  The `DOTFILE_DIRS` tag can be used to specify one or more directories that contain dot files that are included in the documentation (see the \dotfile command).

  This tag requires that the tag HAVE_DOT is set to `YES`.

`DIA_PATH`

  You can include diagrams made with dia in Doxygen documentation. Doxygen will then run dia to produce the diagram and insert it in the documentation. The DIA_PATH tag allows you to specify the directory where the dia binary resides. If left empty dia is assumed to be found in the default search path.

`DIAFILE_DIRS`

  The `DIAFILE_DIRS` tag can be used to specify one or more directories that contain dia files that are included in the documentation (see the \diafile command).

`PLANTUML_JAR_PATH`

  When using PlantUML, the `PLANTUML_JAR_PATH` tag should be used to specify the path where java can find the `plantuml.jar` file or to the filename of `jar` file to be used. If left blank, it is assumed PlantUML is not used or called during a preprocessing step. Doxygen will generate a warning when it encounters a \startuml command in this case and will not generate output for the diagram.

`PLANTUML_CFG_FILE`

  When using PlantUML, the `PLANTUML_CFG_FILE` tag can be used to specify a configuration file for PlantUML.

`PLANTUML_INCLUDE_PATH`

  When using PlantUML, the specified paths are searched for files specified by the `!include` statement in a PlantUML block.

`PLANTUMLFILE_DIRS`

  The `PLANTUMLFILE_DIRS` tag can be used to specify one or more directories that contain PlantUml files that are included in the documentation (see the \plantumlfile command).

`DOT_GRAPH_MAX_NODES`

  The `DOT_GRAPH_MAX_NODES` tag can be used to set the maximum number of nodes that will be shown in the graph. If the number of nodes in a graph becomes larger than this value, Doxygen will truncate the graph, which is visualized by representing a node as a red box. Note that if the number of direct children of the root node in a graph is already larger than `DOT_GRAPH_MAX_NODES` then the graph will not be shown at all. Also note that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.

  Minimum value: `0`, maximum value: `10000`, default value: `50`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`MAX_DOT_GRAPH_DEPTH`

  The `MAX_DOT_GRAPH_DEPTH` tag can be used to set the maximum depth of the graphs generated by `dot`. A depth value of 3 means that only nodes reachable from the root by following a path via at most 3 edges will be shown. Nodes that lay further from the root node will be omitted. Note that setting this option to 1 or 2 may greatly reduce the computation time needed for large code bases. Also note that the size of a graph can be further restricted by DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.

  Minimum value: `0`, maximum value: `1000`, default value: `0`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`DOT_MULTI_TARGETS`

  Set the `DOT_MULTI_TARGETS` tag to `YES` to allow dot to generate multiple output files in one run (i.e. multiple -o and -T options on the command line). This makes `dot` run faster, but since only newer versions of `dot` (>1.8.10) support this, this feature is disabled by default.

  The default value is: `NO`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`GENERATE_LEGEND`

  If the `GENERATE_LEGEND` tag is set to `YES` Doxygen will generate a legend page explaining the meaning of the various boxes and arrows in the dot generated graphs.

  Note
    This tag requires that UML_LOOK isn't set, i.e. the Doxygen internal graphical representation for inheritance and collaboration diagrams is used.

  The default value is: `YES`.

  This tag requires that the tag HAVE_DOT is set to `YES`.

`DOT_CLEANUP`

  If the `DOT_CLEANUP` tag is set to `YES`, Doxygen will remove the intermediate files that are used to generate the various graphs.
  Note: This setting is not only used for dot files but also for msc temporary files.

  The default value is: `YES`.

`MSCGEN_TOOL`

  You can define message sequence charts within Doxygen comments using the \msc command. If the `MSCGEN_TOOL` tag is left empty (the default), then Doxygen will use a built-in version of mscgen tool to produce the charts. Alternatively, the `MSCGEN_TOOL` tag can also specify the name an external tool. For instance, specifying `prog` as the value, Doxygen will call the tool as `prog -T <outfile_format> -o <outputfile> <inputfile>`. The external tool should support output file formats "png", "eps", "svg", and "ismap".

`MSCFILE_DIRS`

  The `MSCFILE_DIRS` tag can be used to specify one or more directories that contain msc files that are included in the documentation (see the \mscfile command).

# Examples

Suppose you have a simple project consisting of two files: a source file `example.cc` and a header file `example.h`. Then a minimal configuration file is as simple as:

    INPUT            = example.cc example.h

Assuming the example makes use of Qt classes and `perl` is located in `/usr/bin`, a more realistic configuration file would be:

    PROJECT_NAME     = Example
    INPUT            = example.cc example.h
    WARNINGS         = YES
    TAGFILES         = qt.tag
    SEARCHENGINE     = NO

To generate the documentation for the QdbtTabular package I have used the following configuration file:

    PROJECT_NAME     = QdbtTabular
    OUTPUT_DIRECTORY = html
    WARNINGS         = YES
    INPUT            = examples/examples.doc src
    FILE_PATTERNS    = *.cc *.h
    INCLUDE_PATH     = examples
    TAGFILES         = qt.tag
    SEARCHENGINE     = YES

To regenerate the Qt-1.44 documentation from the sources, you could use the following configuration file:

    PROJECT_NAME         = Qt
    OUTPUT_DIRECTORY     = qt_docs
    HIDE_UNDOC_MEMBERS   = YES
    HIDE_UNDOC_CLASSES   = YES
    ENABLE_PREPROCESSING = YES
    MACRO_EXPANSION      = YES
    EXPAND_ONLY_PREDEF   = YES
    SEARCH_INCLUDES      = YES
    FULL_PATH_NAMES      = YES
    STRIP_FROM_PATH      = $(QTDIR)/
    PREDEFINED           = USE_TEMPLATECLASS Q_EXPORT= \
                           QArrayT:=QArray \
                           QListT:=QList \
                           QDictT:=QDict \
                           QQueueT:=QQueue \
                           QVectorT:=QVector \
                           QPtrDictT:=QPtrDict \
                           QIntDictT:=QIntDict \
                           QStackT:=QStack \
                           QDictIteratorT:=QDictIterator \
                           QListIteratorT:=QListIterator \
                           QCacheT:=QCache \
                           QCacheIteratorT:=QCacheIterator \
                           QIntCacheT:=QIntCache \
                           QIntCacheIteratorT:=QIntCacheIterator \
                           QIntDictIteratorT:=QIntDictIterator \
                           QPtrDictIteratorT:=QPtrDictIterator
    INPUT                = $(QTDIR)/doc \
                           $(QTDIR)/src/widgets \
                           $(QTDIR)/src/kernel \
                           $(QTDIR)/src/dialogs \
                           $(QTDIR)/src/tools
    FILE_PATTERNS        = *.cpp *.h q*.doc
    INCLUDE_PATH         = $(QTDIR)/include
    RECURSIVE            = YES

For the Qt-2.1 sources I recommend to use the following settings:

    PROJECT_NAME          = Qt
    PROJECT_NUMBER        = 2.1
    HIDE_UNDOC_MEMBERS    = YES
    HIDE_UNDOC_CLASSES    = YES
    SOURCE_BROWSER        = YES
    INPUT                 = $(QTDIR)/src
    FILE_PATTERNS         = *.cpp *.h q*.doc
    RECURSIVE             = YES
    EXCLUDE_PATTERNS      = *codec.cpp moc_* */compat/* */3rdparty/*
    ALPHABETICAL_INDEX    = YES
    IGNORE_PREFIX         = Q
    ENABLE_PREPROCESSING  = YES
    MACRO_EXPANSION       = YES
    INCLUDE_PATH          = $(QTDIR)/include
    PREDEFINED            = Q_PROPERTY(x)= \
                            Q_OVERRIDE(x)= \
                            Q_EXPORT= \
                            Q_ENUMS(x)= \
                            "QT_STATIC_CONST=static const " \
                            _WS_X11_ \
                            INCLUDE_MENUITEM_DEF
    EXPAND_ONLY_PREDEF    = YES
    EXPAND_AS_DEFINED     = Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \
                            Q_VARIANT_AS

Here Doxygen's preprocessor is used to substitute some macro names that are normally substituted by the C preprocessor, but without doing full macro expansion.

Go to the next section or return to the index.