doc/gbuild/doxygen.cfg

23 # This file describes the settings to be used by the documentation system
26 # All text after a hash (#) is considered a comment and will be ignored
29 # For lists items can also be appended using:
31 # Values that contain spaces should be placed between quotes (" ")
50 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
51 # This could be handy for archiving the generated documentation or
57 # base path where the generated documentation will be put.
58 # If a relative path is entered, it will be relative to the location
59 # where doxygen was started. If left blank the current directory will be used.
66 # Enabling this option can be useful when feeding doxygen a huge amount of
95 # brief descriptions will be completely suppressed.
101 # in this list, if found as the leading text of the brief description, will be
120 # operators of the base classes will not be shown.
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.
139 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
149 # (but less readable) file names. This can be useful is your file systems
170 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
172 # comments) as a brief description. This used to be the default behaviour.
186 # be part of the file/class/namespace that contains it.
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
207 # of all members will be omitted, etc.
213 # Java. For instance, namespaces will be presented as packages, qualified
273 # all members of a group must be documented explicitly.
278 # the same type (for instance a group of public functions) to be put as a
280 # NO to prevent subgrouping. Alternatively, this can be done per class using
289 # namespace, or class. And the struct will be named TypeS. This can typically
290 # be useful for C code in case the coding convention dictates that all compound
297 # When the cache is full, less often used symbols will be written to disk.
300 # doxygen to be busy swapping symbols to and from disk most of the time
317 # Private class members and static file members will be hidden unless
323 # will be included in the documentation.
328 # will be included in the documentation.
333 # defined locally in source files will be included in the documentation.
345 # If this flag is set to YES, the members of anonymous namespaces will be
347 # 'anonymous_namespace{file}', where file will be replaced with the base
355 # If set to NO (the default) these members will be included in the
363 # If set to NO (the default) these classes will be included in the various
370 # If set to NO (the default) these declarations will be included in the
377 # If set to NO (the default) these blocks will be appended to the
384 # to NO (the default) then the documentation will be excluded.
399 # documentation. If set to YES the scope will be hidden.
434 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
436 # NO (the default), the class list will be sorted only by class name,
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
476 # here it will be hidden. Use a value of 0 to hide initializers completely.
478 # documentation can be controlled using \showinitializer or \hideinitializer
508 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
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
536 # The WARNINGS tag can be used to turn on/off the warning messages that are
544 # automatically be disabled.
555 # This WARN_NO_PARAMDOC option can be abled to get warnings for
565 # tags, which will be replaced by the file and line number from which the
567 # $version, which will be replaced by the version of the file (if it could
568 # be obtained via FILE_VERSION_FILTER)
572 # The WARN_LOGFILE tag can be used to specify a file to which warning
573 # and error messages should be written. If left blank the output is written
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
607 # should be searched for input files as well. Possible values are YES and NO.
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
633 # (namespaces, classes, functions, etc.) that should be excluded from the
634 # output. The symbol name can be a fully qualified name, a word, or if the
640 # The EXAMPLE_PATH tag can be used to specify one or more files or
653 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
654 # searched for input files to be used with the \include or \dontinclude
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
672 # If FILTER_PATTERNS is specified, this tag will be
677 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
689 # INPUT_FILTER) will be used to filter the input files when producing source
699 # be generated. Documented entities will be cross-referenced with these sources.
718 # functions referencing it will be listed.
724 # called/used by that function will be listed.
755 # of all compounds will be generated. Enable this if the project
761 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
762 # in which this list will be split (can be a number in the range [1..20])
767 # classes will be put under the same header in the alphabetical index.
768 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
769 # should be ignored while generating the index headers.
782 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
783 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
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
811 # stylesheet in the HTML output directory as well, or it will be erased!
816 # files or namespaces will be aligned in HTML using tables. If set to
817 # NO a bullet list will be used.
822 # documentation will contain sections that can be hidden and shown after the
830 # will be generated that can be used as input for Apple's Xcode 3
844 # can be grouped.
849 # should uniquely identify the documentation set bundle. This should be a
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
864 # can add a path in front of the file if the result should not be
870 # be used to specify the location (absolute path including file name) of
878 # it should be included in the master .chm file (NO).
894 # The TOC_EXPAND flag can be set to YES to add extra items for group members
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])
960 # structure should be generated to display hierarchical information.
961 # If the tag value is set to FRAME, a side panel will be generated
976 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
986 # to force them to be regenerated.
999 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1000 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
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
1017 # LaTeX documents. This may be useful for small projects and may help to
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.
1028 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1029 # packages that should be included in the LaTeX output.
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
1076 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1077 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1078 # put in front of it. If left blank `rtf' will be used as the default path.
1083 # RTF documents. This may be useful for small projects and may help to
1117 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1118 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1119 # put in front of it. If left blank `man' will be used as the default path.
1132 # would be unable to find the correct page. The default is NO.
1146 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1147 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
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
1196 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1201 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1202 # nicely formatted so it can be parsed by a human reader.
1206 # tag is set to NO the size of the Perl module output will be much smaller
1230 # compilation will be performed. Macro expansion can be done in a controlled
1242 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1246 # The INCLUDE_PATH tag can be used to specify one or more directories that
1247 # contain include files that are not input files but should be processed by
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.
1288 # The TAGFILES option can be used to specify one or more tagfiles.
1290 # can be added for each tagfile. The format of a tag file without
1297 # where "loc1" and "loc2" can be relative or absolute paths or
1299 # does not have to be run to correct the links.
1312 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1314 # will be listed.
1318 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1320 # be listed.
1324 # The PERL_PATH should be the absolute path and name of the perl script
1346 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1369 # which can be done by putting it in a standard location or by setting the
1375 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1434 # the time of a run. So in most cases it will be better to enable call graphs
1442 # the time of a run. So in most cases it will be better to enable caller
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
1466 # found. If left blank, it is assumed the dot tool can be found in the path.
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
1477 # nodes that will be shown in the graph. If the number of nodes in a graph
1481 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1482 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1486 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1488 # from the root by following a path via at most 3 edges will be shown. Nodes
1489 # that lay further from the root node will be omitted. Note that setting this
1491 # code bases. Also note that the size of a graph can be further restricted by
1527 # The SEARCHENGINE tag specifies whether or not a search engine should be
1528 # used. If set to NO the values of all tags below this one will be ignored.