doc/gbuild/doxygen.cfg

23 # This file describes the settings to be used by the documentation system
37 # This tag specifies the encoding used for all characters in the config file
38 # that follow. The default is UTF-8 which is also the encoding used for all
50 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
52 # if some version control system is used.
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
59 # where doxygen was started. If left blank the current directory will be used.
72 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
100 # that is used to form the text in various listings. Each string
103 # used as the annotated text. Otherwise, the brief description is used as-is.
104 # If left blank, the following values are used ("$name" is automatically
126 # to NO the shortest path that makes the file name unique will be used.
131 # can be used to strip a user-defined part of the path. Stripping is
133 # the path. The tag can be used to show relative paths in the file list.
134 # If left blank the directory from which doxygen is run is used as the
139 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
143 # definition is used. Otherwise one should specify the include paths that
172 # comments) as a brief description. This used to be the default behaviour.
190 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
195 # This tag can be used to specify a number of aliases that acts
206 # For instance, some of the names that are used will be different. The list
270 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
297 # When the cache is full, less often used symbols will be written to disk.
444 # The GENERATE_TODOLIST tag can be used to enable (YES) or
450 # The GENERATE_TESTLIST tag can be used to enable (YES) or
456 # The GENERATE_BUGLIST tag can be used to enable (YES) or
462 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
468 # The ENABLED_SECTIONS tag can be used to enable conditional
485 # list will mention the files that were used to generate the documentation.
508 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
514 # is used as the file version. See the manual for examples.
518 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
522 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
531 # The QUIET tag can be used to turn on/off the messages that are generated
532 # by doxygen. Possible values are YES and NO. If left blank NO is used.
536 # The WARNINGS tag can be used to turn on/off the warning messages that are
538 # NO is used.
572 # The WARN_LOGFILE tag can be used to specify a file to which warning
582 # The INPUT tag can be used to specify the files and/or directories that contain
589 # This tag can be used to specify the character encoding of the source files
606 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
608 # If left blank NO is used.
612 # The EXCLUDE tag can be used to specify files and/or directories that should
618 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
632 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
635 # wildcard * is used, a substring. Examples: ANamespace, AClass,
640 # The EXAMPLE_PATH tag can be used to specify one or more files or
654 # searched for input files to be used with the \include or \dontinclude
656 # Possible values are YES and NO. If left blank NO is used.
660 # The IMAGE_PATH tag can be used to specify one or more files or
666 # The INPUT_FILTER tag can be used to specify a program that doxygen should
677 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
683 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
689 # INPUT_FILTER) will be used to filter the input files when producing source
724 # called/used by that function will be listed.
761 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
768 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
782 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
784 # put in front of it. If left blank `html' will be used as the default path.
788 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
794 # The HTML_HEADER tag can be used to specify a personal HTML header for
800 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
806 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
807 # style sheet that is used by each HTML page. It can be used to
817 # NO a bullet list will be used.
830 # will be generated that can be used as input for Apple's Xcode 3
856 # will be generated that can be used as input for tools like the
863 # be used to specify the file name of the resulting .chm file. You
870 # be used to specify the location (absolute path including file name) of
883 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
900 # are set, an additional index file will be generated that can be used as input for
907 # be used to specify the file name of the resulting .qch file.
942 # be used to specify the location of Qt's qhelpgenerator.
948 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
954 # This tag can be used to set the number of enum values (range [1..20])
959 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
977 # used to set the initial width (in pixels) of the frame in which the tree
999 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1001 # put in front of it. If left blank `latex' will be used as the default path.
1005 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1006 # invoked. If left blank `latex' will be used as the default command name.
1010 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1011 # generate index for LaTeX. If left blank `makeindex' will be used as the
1022 # The PAPER_TYPE tag can be used to set the paper type that is used
1024 # executive. If left blank a4wide will be used.
1033 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1047 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1056 # This option is also used when generating formulas in HTML.
1076 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1078 # put in front of it. If left blank `rtf' will be used as the default path.
1103 # Set optional variables used in the generation of an rtf document.
1117 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1119 # put in front of it. If left blank `man' will be used as the default path.
1146 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1148 # put in front of it. If left blank `xml' will be used as the default path.
1152 # The XML_SCHEMA tag can be used to specify an XML schema,
1153 # which can be used by a validating XML parser to check the
1158 # The XML_DTD tag can be used to specify an XML DTD,
1159 # which can be used by a validating XML parser to check the
1246 # The INCLUDE_PATH tag can be used to specify one or more directories that
1255 # be used.
1259 # The PREDEFINED tag can be used to specify one or more macro names that
1270 # this tag can be used to specify a list of macro names that should be expanded.
1271 # The macro definition that is found in the sources will be used.
1279 # function macros are typically used for boiler-plate code, and will confuse
1288 # The TAGFILES option can be used to specify one or more tagfiles.
1375 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1459 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1461 # If left blank png will be used.
1465 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1470 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1476 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1486 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1498 # seem to support this out of the box. Warning: Depending on the platform used,
1518 # remove the intermediate dot files that are used to generate
1528 # used. If set to NO the values of all tags below this one will be ignored.