## Configuration

### Format

A configuration file is a free-form ASCII text file with a structure that is similar to that of a Makefile, 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. Comments may be placed anywhere within the file (except within quotes). Comments begin with the # character and end at the end of the line.

The file essentially consists of a list of assignment statements. Each statement consists of a `TAG_NAME` written in capitals, followed by the `=` character and one or more values. If the same tag is assigned more than once, the last assignment overwrites any earlier assignment. For options 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 character of a line. Environment variables can be expanded using the pattern `$(ENV_VARIABLE_NAME)`.

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

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

- ALIASES
- ALLEXTERNALS
- ALPHABETICAL_INDEX
- ALWAYS_DETAILED_SEC
- BIN_ABSPATH
- BINARY_TOC
- BRIEF_MEMBER_DESC
- CASE_SENSE_NAMES
- CGI_NAME
- CGI_URL
- CLASS_DIAGRAMS
- CLASS_GRAPH
- COLLABORATION_GRAPH
- COLS_IN_ALPHA_INDEX
- COMPACT_LATEX
- COMPACT_RTF
- DISABLE_INDEX
- DISTRIBUTE_GROUP_DOC
- DOC_ABSPATH
- DOC_URL
- DOT_PATH
- DOTFILE_DIRS
- ENABLE_PREPROCESSING
- ENUM_VALUES_PER_LINE
- ENABLED_SECTIONS
- EXAMPLE_PATH
- EXAMPLE_PATTERNS
- EXCLUDE
- EXCLUDE_PATTERNS
- EXPAND_AS_DEFINED
- EXPAND_ONLY_PREDEF
- EXT_DOC_PATHS
- EXTRA_PACKAGES
- EXTRACT_ALL
- EXTRACT_PRIVATE
- EXTRACT_STATIC
- FILE_PATTERNS
- FILTER_SOURCE_FILES
- FULL_PATH_NAMES
- GENERATE_BUGLIST
- GENERATE_CHI
- GENERATE_HTML
- GENERATE_HTMLHELP
- GENERATE_LATEX
- GENERATE_LEGEND
- GENERATE_MAN
- GENERATE_RTF
- GENERATE_TAGFILE
- GENERATE_TESTLIST
- GENERATE_TODOLIST
- GENERATE_TREEVIEW
- GRAPHICAL_HIERARCHY
- HAVE_DOT
- HIDE_SCOPE_NAMES
- HIDE_UNDOC_CLASSES
- HIDE_UNDOC_MEMBERS
- HTML_ALIGN_MEMBERS
- HTML_FOOTER
- HTML_HEADER
- HTML_OUTPUT
- HTML_STYLESHEET
- IGNORE_PREFIX
- IMAGE_PATH
- INCLUDE_GRAPH
- INCLUDE_PATH
- INHERIT_DOCS
- INLINE_INFO
- INLINE_SOURCES
- INPUT
- INPUT_FILTER
- INTERNAL_DOCS
- JAVADOC_AUTOBRIEF
- LATEX_BATCHMODE
- LATEX_HEADER
- LATEX_OUTPUT
- MACRO_EXPANSION
- MAN_EXTENSION
- MAN_LINKS
- MAN_OUTPUT
- MAX_DOT_GRAPH_HEIGHT
- MAX_DOT_GRAPH_WIDTH
- MAX_INITIALIZER_LINES
- OPTIMIZE_OUTPUT_FOR_C
- OUTPUT_DIRECTORY
- OUTPUT_LANGUAGE
- PAPER_TYPE
- PDF_HYPERLINKS
- PERL_PATH
- PREDEFINED
- PROJECT_NAME
- PROJECT_NUMBER
- QUIET
- RECURSIVE
- REPEAT_BRIEF
- RTF_EXTENSIONS_FILE
- RTF_HYPERLINKS
- RTF_OUTPUT
- RTF_STYLESHEET_FILE
- SEARCH_INCLUDES
- SEARCHENGINE
- SHORT_NAMES
- SHOW_INCLUDE_FILES
- SHOW_USED_FILES
- SKIP_FUNCTION_MACROS
- SORT_MEMBER_DOCS
- SOURCE_BROWSER
- STRIP_CODE_COMMENTS
- STRIP_FROM_PATH
- TAB_SIZE
- TAGFILES
- TEMPLATE_RELATIONS
- TOC_EXPAND
- TREEVIEW_WIDTH
- VERBATIM_HEADERS
- WARN_FORMAT
- WARN_IF_UNDOCUMENTED
- WARN_LOGFILE
- WARNINGS

### General options

`PROJECT_NAME`
  The `PROJECT_NAME` tag is a single word (or a sequence of words surrounded by double-quotes) 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.

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

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

`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. The default language is English, other supported languages are: Dutch, French, Italian, Czech, Swedish, German, Finnish, Hungarian, Japanese, Korean, Spanish, Russian, Croatian, Polish and Portuguese.

`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` and `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`
`EXTRACT_PRIVATE`
  If the `EXTRACT_PRIVATE` tag is set to `YES` all private members of a class will be included in the documentation.

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

`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` (the default) 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.

`HIDE_UNDOC_CLASSES`
  If the `HIDE_UNDOC_CLASSESS` tag is set to `YES`, doxygen will hide all undocumented classes. If set to `NO` (the default) these classes will be included in the various overviews. This option has no effect if `EXTRACT_ALL` is enabled.

`BRIEF_MEMBER_DESC`
  If the `BRIEF_MEMBER_DESC` tag is set to `YES` (the default) 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.

`REPEAT_BRIEF`
  If the `REPEAT_BRIEF` tag is set to `YES` (the default) 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.
`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.

`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

`STRIP_FROM_PATH`
  If the `FULL_PATH_NAMES` tag is set to `YES` then 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.

`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` (the default) then the documentation will be excluded. Set it to `YES` to include the internal documentation.

`CLASS_DIAGRAMS`
  If the `CLASS_DIAGRAMS` tag is set to `YES` (the default) doxygen will generate a class diagram (in HTML and ) for classes with base or super classes. Setting the tag to `NO` turns the diagrams off.

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

`INLINE_SOURCES`
  Setting the `INLINE_SOURCES` tag to `YES` will include the body of functions, classes and enums directly into the documentation.

`STRIP_CODE_COMMENTS`
  Setting the `STRIP_CODE_COMMENTS` tag to `YES` (the default) will instruct doxygen to hide any special comment blocks from generated source code fragments. Normal C and C++ comments will always remain visible.

`CASE_SENSE_NAMES`
  If the `CASE_SENSE_NAMES` tag is set to `NO` (the default) then doxygen will only generate file names in lower case letters. If set to `YES` upper case letters are also allowed. This is useful if you have classes or files whose names only differ in case and if your file system supports case sensitive file names.

`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 is your file systems doesn't support long names like on DOS, Mac, or CD-ROM.

`HIDE_SCOPE_NAMES`
  If the `HIDE_SCOPE_NAMES` tag is set to `NO` (the default) then doxygen will show members with their full class and namespace scopes in the documentation. If set to `YES` the scope will be hidden.

`VERBATIM_HEADERS`
  If the `VERBATIM_HEADERS` tag is set the `YES` (the default) 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.
`SHOW_INCLUDE_FILES`
  If the SHOW_INCLUDE_FILES tag is set to YES (the default) then doxygen will put list of the files that are included by a file in the documentation of that file.

`JAVADOC_AUTOBRIEF`
  If the `JAVADOC_AUTOBRIEF` is set to `YES` then doxygen will interpret the first line (until the first dot) of a JavaDoc-style comment as the brief description. If set to NO (the default), the Javadoc-style will behave just like the Qt-style comments.

`INHERIT_DOCS`
  If the `INHERIT_DOCS` tag is set to `YES` (the default) then an undocumented member inherits the documentation from any documented member that it reimplements.

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

`SORT_MEMBER_DOCS`
  If the `SORT_MEMBER_DOCS` tag is set to `YES` (the default) 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.

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

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

`ENABLED_SECTIONS`
  The `ENABLED_SECTIONS` tag can be used to enable conditional documentation sections, marked by \if <section-label> ... \endif blocks.

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

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

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

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

       name=value

  For example adding

       "sideeffect=\par Side Effects:\n"

  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:". You can put \n's in the value part of an alias to insert newlines.

`MAX_INITIALIZER_LINES`
  The `MAX_INITIALIZER_LINES` tag determines the maximum number of lines that the initial value of a variable or define can be. 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 defines can be controlled using \showinitializer or \hideinitializer command in the documentation.

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

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

### 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. Possible values are `YES` and `NO`, where `YES` implies that the messages are off. If left blank `NO` is used.

`WARNINGS`
  The `WARNINGS` tag can be used to turn on/off the warning messages that are generated to standard error by doxygen. Possible values are `YES` and `NO`, where `YES` implies that the warnings are on. If left blank `NO` is used.

  Tip: Turn warnings on while writing the documentation.

`WARN_IF_UNDOCUMENTED`
  If `WARN_IF_UNDOCUMENTED` 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.

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

`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 stderr.

### Input related options

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

  Note: This tag (and only this tag) is required.

`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. If left blank all files are included (i.e. wildcard `*`).

`RECURSIVE`
  The `RECURSIVE` tag can be used to specify whether or not subdirectories should be searched for input files as well. Possible values are `YES` and `NO`. If left blank `NO` is used.

`EXCLUDE`
  The `EXCLUDE` tag can be used to specify files and/or directories that should 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.

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

`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 in section \include).

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

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

`FILTER_SOURCE_FILES`
  If the `FILTER_SOURCE_FILES` tag is set to `YES`, the input filter (if set using `INPUT_FILTER` ) will be used to filter the input files when producing source files to browse.

### Alphabetical index options

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

`COLS_IN_ALPHA_INDEX`
  If the alphabetical index is enabled (see `ALPHABETICAL_INDEX)` then the `COLS_IN_ALPHA_INDEX` tag can be used to specify the number of columns in which this list will be split (can be a number in the range [1..20])

`IGNORE_PREFIX`
  In case all classes in a project start with a common prefix, all classes will be put under the same header in the alphabetical index. 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.

### HTML related options

`GENERATE_HTML`
  If the `GENERATE_HTML` tag is set to `YES` (the default) doxygen will generate HTML output

`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. If left blank `html' will be used as the default path.

`HTML_HEADER`
  The `HTML_HEADER` tag can be used to specify a user defined HTML header file for each generated HTML page. To get valid HTML the header file should contain at least a `<HTML>` and a `<BODY>` tag, but it is good idea to include the style sheet that is generated by doxygen as well. Minimal example:

        <HTML>
          <HEAD>
            <TITLE>My title</TITLE>
            <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
          </HEAD>
          <BODY BGCOLOR="#FFFFFF">

  If the tag is left blank doxygen will generate a standard header.

  The following commands have a special meaning inside the header: `$title`, `$datetime`, `$date`, `$doxygenversion`, `$projectname`, `$projectnumber`. Doxygen will replace them by respectively the title of the page, the current date and time, only the current date, the version number of doxygen, the project name (see `PROJECT_NAME)`, or the project number (see `PROJECT_NUMBER)`.

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

`HTML_FOOTER`
  The `HTML_FOOTER` tag can be used to specify a user defined HTML footer for each generated HTML page. To get valid HTML the header file should contain at least a `</BODY>` and a `</HTML>` tag. A minimal example:

          </BODY>
        </HTML>

  If the tag is left blank doxygen will generate a standard footer.

  The following commands have a special meaning inside the header: `$title`, `$datetime`, `$date`, `$doxygenversion`, `$projectname`, `$projectnumber`. Doxygen will replace them by respectively the title of the page, the current date and time, only the current date, the version number of doxygen, the project name (see `PROJECT_NAME)`, or the project number (see `PROJECT_NUMBER)`.

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

`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 the tag is 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.

`HTML_ALIGN_MEMBERS`
  If the `HTML_ALIGN_MEMBERS` tag is set to `YES`, the members of classes, files or namespaces will be aligned in HTML using tables. If set to `NO` a bullet list will be used.

  Note: Setting this tag to `NO` will become obsolete in the future, since I only intent to support and test the aligned representation.

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

  The HTML Help Workshop contains a compiler that can convert all HTML output generated by doxygen into a single compressed HTML file (.chm). Compressed 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 (which basically renders `doxysearch` obsolete on Windows). The HTML workshop also contains a viewer for compressed HTML files.

`GENERATE_CHI`
  If the `GENERATE_HTMLHELP` tag is set to `YES`, the `GENERATE_CHI` flag controls if a separate .chi index file is generated (`YES`) or that it should be included in the master .chm file (`NO`).

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

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

`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 at top of each page. A value of NO (the default) enables the index and the value YES disables it.

`ENUM_VALUES_PER_LINE`
  This tag can be used to set the number of enum values (range [1..20]) that doxygen will group on one line in the generated HTML documentation.

`GENERATE_TREEVIEW`
  If the `GENERATE_TREEVIEW` tag is set to YES, a side pannel 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 and frames is required (for instance Netscape 4.0+ or Internet explorer 4.0+).

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

### LaTeX related options

`GENERATE_LATEX`
  If the `GENERATE_LATEX` tag is set to `YES` (the default) doxygen will generate output.

`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. If left blank `latex' will be used as the default path.

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

`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).
  - `a4wide` (same as a4, but including the a4wide package).
  - `letter` (8.5 x 11 inches).
  - `legal` (8.5 x 14 inches).
  - `executive` (7.25 x 10.5 inches)
  If left blank a4wide will be used.

`EXTRA_PACKAGES`
  The `EXTRA_PACKAGES` tag can be used to specify one or more package names that should be included in the output. To get the times font for instance you can specify

      EXTRA_PACKAGES = times

  If left blank no extra packages will be included.

`LATEX_HEADER`
  The `LATEX_HEADER` tag can be used to specify a personal 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. See section Doxygen usage for information on how to let doxygen write the default header to a separate file.

  Note:
    Only use a user defined header if you know what you are doing!
  The following commands have a special meaning inside the header: `$title`, `$datetime`, `$date`, `$doxygenversion`, `$projectname`, `$projectnumber`. Doxygen will replace them by respectively the title of the page, the current date and time, only the current date, the version number of doxygen, the project name (see `PROJECT_NAME)`, or the project number (see `PROJECT_NUMBER)`.

`PDF_HYPERLINKS`

  If the `PDF_HYPERLINKS` tag is set to `YES`, the that is generated is prepared for conversion to PDF (using ps2pdf). 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.

`USE_PDFLATEX`

  If the `LATEX_PDFLATEX` tag is set to `YES`, doxygen will use pdflatex to generate the PDF file directly from the files.

`LATEX_BATCHMODE`

  If the `LATEX_BATCHMODE` tag is set to `YES`, doxygen will add the \batchmode. command to the generated files. This will instruct to keep running if errors occur, instead of asking the user for help. This option is also used when generating formulas in HTML.

### RTF related options

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

`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. If left blank `rtf` will be used as the default path.

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

`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 reader that support those fields.
  note:
    WordPad (write) and others do not support links.
`RTF_STYLESHEET_FILE`
  Load stylesheet definitions from file. Syntax is similar to doxygen's config file, i.e. a series of assigments. 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.

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

### Man page related options

`GENERATE_MAN`
  If the `GENERATE_MAN` tag is set to `YES` (the default) doxygen will generate man pages for classes and files.

`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. If left blank `man' will be used as the default path. A directory man3 will be created inside the directory specified by `MAN_OUTPUT`.

`MAN_EXTENSION`
  The `MAN_EXTENSION` tag determines the extension that is added to the generated man pages (default is the subroutine's section .3)

`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 is `NO`.

### Preprocessor related options

`ENABLE_PREPROCESSING`
  If the `ENABLE_PREPROCESSING` tag is set to `YES` (the default) doxygen will evaluate all C-preprocessor directives found in the sources and include files.

`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` (the default) only conditional compilation will be performed. Macro expansion can be done in a controlled way by setting `EXPAND_ONLY_PREDEF` 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.

`SEARCH_INCLUDES`
  If the `SEARCH_INCLUDES` tag is set to `YES` (the default) the includes files in the `INCLUDE_PATH` (see below) will be searched if a #include is found.

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

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

`EXPAND_AS_DEFINED`
  If the `MACRO_EXPANSION` and `EXPAND_PREDEF_ONLY` 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.

`SKIP_FUNCTION_MACROS`
  If the `SKIP_FUNCTION_MACROS` tag is set to `YES` (the default) then doxygen's preprocessor will remove all function-like macros that are alone on a line 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.

### External reference options

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

  See section Doxytag usage for more information about the usage of tag files.

  Optionally an initial location of the external documentation can be added for each tagfile. 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, If a location is present for each tag, the installdox tool (see section Installdox usage for more information) does not have to be run to correct the links.
  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 Doxytag usage for more information about the usage of tag files.

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

`PERL_PATH`
  The `PERL_PATH` should be the absolute path and name of the perl script interpreter (i.e. the result of ``which perl`').

### Dot options

`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)

`CLASS_GRAPH`
  If the `CLASS_GRAPH` and `HAVE_DOT` tags are set to `YES` then doxygen will generate a graph for each documented class showing the direct and indirect inheritance relations. Setting this tag to `YES` will force the the `CLASS_DIAGRAMS` tag to NO.

`COLLABORATION_GRAPH`
  If the `COLLABORATION_GRAPH` and `HAVE_DOT` tags are 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.

`TEMPLATE_RELATIONS`
  If the `TEMPLATE_RELATIONS` and `HAVE_DOT` tags are set to `YES` then doxygen will show the relations between templates and their instances.

`INCLUDE_GRAPH`
  If the `ENABLE_PREPROCESSING`, `SEARCH_INCLUDES`, `INCLUDE_GRAPH`, and `HAVE_DOT` 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.

`INCLUDED_BY_GRAPH`
  If the `ENABLE_PREPROCESSING`, `SEARCH_INCLUDES`, `INCLUDED_BY_GRAPH`, and `HAVE_DOT` tags are set to `YES` then doxygen will generate a graph for each documented header file showing the documented files that directly or indirectly include this file.

`GRAPHICAL_HIERARCHY`
  If the `GRAPHICAL_HIERARCHY` and `HAVE_DOT` tags are set to `YES` then doxygen will graphical hierarchy of all classes instead of a textual one.

`DOT_PATH`
  This 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 on the path.

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

`MAX_DOT_GRAPH_HEIGHT`
  The `MAX_DOT_GRAPH_HEIGHT` tag can be used to set the maximum allows height (in pixels) of the graphs generated by dot. If a graph becomes larger than this value, doxygen will try to truncate the graph, so that it fits within the specified constraint. Beware that most browsers cannot cope with very large images.

`MAX_DOT_GRAPH_WIDTH`
  The `MAX_DOT_GRAPH_WIDTH` tag can be used to set the maximum allowed width (in pixels) of the graphs generated by dot. If a graph becomes larger than this value, doxygen will try to truncate the graph, so that it fits within the specified constraint. Beware that most browsers cannot cope with very large images.

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

`DOT_CLEANUP`
  This tag can be used to cleanup any mess DOT left behind. If left blank, "NO" is assumed.

### Search engine options

`SEARCHENGINE`
  The `SEARCHENGINE` tag specifies whether or not a search should be used. Possible values are `YES` and `NO`. If set to `NO` or left blank, the values of all other tags in this section will be ignored.

`CGI_NAME`
  The `CGI_NAME` tag should be the name of the CGI script that starts the search engine (`doxysearch`) with the correct parameters. A script with this name will be generated by doxygen.

`CGI_URL`
  The `CGI_URL` tag should be the absolute URL to the directory where the cgi binaries are located. See the documentation of your HTTP daemon for details.

`DOC_URL`
  The `DOC_URL` tag should be the absolute URL to the directory where the documentation is located. If left blank the absolute path to the documentation, with `file://` prepended to it, will be used. This is correct for local viewing only.

`DOC_ABSPATH`
  The `DOC_ABSPATH` tag should be the absolute path to the directory where the documentation is located. If left blank the directory on the local machine will be used.

`BIN_ABSPATH`
  The `BIN_ABSPATH` tag must point to the directory where the doxysearch binary is installed.

`EXT_DOC_PATHS`
  The `EXT_DOC_PATHS` tag can be used to specify one or more paths to documentation generated for other projects. This allows doxysearch to search the documentation for these projects as well. All paths must be absolute.

## 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
    PERL_PATH        = /usr/bin/perl
    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
    PERL_PATH        = /usr/local/bin/perl
    SEARCHENGINE     = YES
    CGI_NAME         = search.cgi
    CGI_URL          = http://www.stack.nl/~dimitri/cgi-bin
    DOC_URL          = http://www.stack.nl/~dimitri/qdbttabular
    DOC_ABSPATH      = /home/dimitri/.html/qdbttabular
    BIN_ABSPATH      = /home/dimitri/bin

To regenerate the Qt-1.44 documentation from the sources, you could use the following config 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
    COLS_IN_ALPHA_INDEX   = 3
    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.