doc/doxygen/Doxyfile.in

5 # This file describes the settings to be used by the documentation system
8 # All text after a hash (#) is considered a comment and will be ignored
11 # For lists items can also be appended using:
13 # Values that contain spaces should be placed between quotes (" ")
24 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
25 # This could be handy for archiving the generated documentation or
31 # base path where the generated documentation will be put.
32 # If a relative path is entered, it will be relative to the location
33 # where doxygen was started. If left blank the current directory will be used.
40 # Enabling this option can be useful when feeding doxygen a huge amount of
58 # This tag can be used to specify the encoding used in the generated output.
78 # brief descriptions will be completely suppressed.
84 # in this list, if found as the leading text of the brief description, will be
103 # operators of the base classes will not be shown.
109 # to NO the shortest path that makes the file name unique will be used.
114 # can be used to strip a user-defined part of the path. Stripping is
116 # the path. The tag can be used to show relative paths in the file list.
122 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
132 # (but less readable) file names. This can be useful is your file systems
145 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
147 # comments) as a brief description. This used to be the default behaviour.
168 # be part of the file/class/namespace that contains it.
172 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
177 # This tag can be used to specify a number of aliases that acts
188 # For instance, some of the names that are used will be different. The list
189 # of all members will be omitted, etc.
195 # For instance, namespaces will be presented as packages, qualified scopes
212 # all members of a group must be documented explicitly.
217 # the same type (for instance a group of public functions) to be put as a
219 # NO to prevent subgrouping. Alternatively, this can be done per class using
230 # Private class members and static file members will be hidden unless
236 # will be included in the documentation.
241 # will be included in the documentation.
246 # defined locally in source files will be included in the documentation.
260 # If set to NO (the default) these members will be included in the
268 # If set to NO (the default) these classes will be included in the various
275 # If set to NO (the default) these declarations will be included in the
282 # If set to NO (the default) these blocks will be appended to the
289 # to NO (the default) then the documentation will be excluded.
304 # documentation. If set to YES the scope will be hidden.
333 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
335 # NO (the default), the class list will be sorted only by class name,
343 # The GENERATE_TODOLIST tag can be used to enable (YES) or
349 # The GENERATE_TESTLIST tag can be used to enable (YES) or
355 # The GENERATE_BUGLIST tag can be used to enable (YES) or
361 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
367 # The ENABLED_SECTIONS tag can be used to enable conditional
375 # here it will be hidden. Use a value of 0 to hide initializers completely.
377 # documentation can be controlled using \showinitializer or \hideinitializer
394 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
408 # The QUIET tag can be used to turn on/off the messages that are generated
413 # The WARNINGS tag can be used to turn on/off the warning messages that are
421 # automatically be disabled.
432 # This WARN_NO_PARAMDOC option can be abled to get warnings for
442 # tags, which will be replaced by the file and line number from which the
444 # $version, which will be replaced by the version of the file (if it could
445 # be obtained via FILE_VERSION_FILTER)
449 # The WARN_LOGFILE tag can be used to specify a file to which warning
450 # and error messages should be written. If left blank the output is written
459 # The INPUT tag can be used to specify the files and/or directories that contain
486 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
487 # should be searched for input files as well. Possible values are YES and NO.
492 # The EXCLUDE tag can be used to specify files and/or directories that should
498 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
512 # The EXAMPLE_PATH tag can be used to specify one or more files or
525 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
526 # searched for input files to be used with the \include or \dontinclude
532 # The IMAGE_PATH tag can be used to specify one or more files or
538 # The INPUT_FILTER tag can be used to specify a program that doxygen should
543 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
548 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
558 # INPUT_FILTER) will be used to filter the input files when producing source
568 # be generated. Documented entities will be cross-referenced with these sources.
587 # functions referencing it will be listed.
593 # called/used by that function will be listed.
623 # of all compounds will be generated. Enable this if the project
629 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
630 # in which this list will be split (can be a number in the range [1..20])
635 # classes will be put under the same header in the alphabetical index.
636 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
637 # should be ignored while generating the index headers.
650 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
651 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
652 # put in front of it. If left blank `html' will be used as the default path.
656 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
662 # The HTML_HEADER tag can be used to specify a personal HTML header for
668 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
674 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
675 # style sheet that is used by each HTML page. It can be used to
679 # stylesheet in the HTML output directory as well, or it will be erased!
684 # files or namespaces will be aligned in HTML using tables. If set to
685 # NO a bullet list will be used.
690 # will be generated that can be used as input for tools like the
697 # be used to specify the file name of the resulting .chm file. You
698 # can add a path in front of the file if the result should not be
704 # be used to specify the location (absolute path including file name) of
712 # it should be included in the master .chm file (NO).
722 # The TOC_EXPAND flag can be set to YES to add extra items for group members
727 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
733 # This tag can be used to set the number of enum values (range [1..20])
738 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
747 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
762 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
763 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
764 # put in front of it. If left blank `latex' will be used as the default path.
768 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
769 # invoked. If left blank `latex' will be used as the default command name.
773 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
774 # generate index for LaTeX. If left blank `makeindex' will be used as the
780 # LaTeX documents. This may be useful for small projects and may help to
785 # The PAPER_TYPE tag can be used to set the paper type that is used
787 # executive. If left blank a4wide will be used.
791 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
792 # packages that should be included in the LaTeX output.
796 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
810 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
839 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
840 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
841 # put in front of it. If left blank `rtf' will be used as the default path.
846 # RTF documents. This may be useful for small projects and may help to
880 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
881 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
882 # put in front of it. If left blank `man' will be used as the default path.
895 # would be unable to find the correct page. The default is NO.
909 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
910 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
911 # put in front of it. If left blank `xml' will be used as the default path.
915 # The XML_SCHEMA tag can be used to specify an XML schema,
916 # which can be used by a validating XML parser to check the
921 # The XML_DTD tag can be used to specify an XML DTD,
922 # which can be used by a validating XML parser to check the
959 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
964 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
965 # nicely formatted so it can be parsed by a human reader.  This is useful
967 # tag is set to NO the size of the Perl module output will be much smaller
991 # compilation will be performed. Macro expansion can be done in a controlled
1003 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1007 # The INCLUDE_PATH tag can be used to specify one or more directories that
1008 # contain include files that are not input files but should be processed by
1016 # be used.
1020 # The PREDEFINED tag can be used to specify one or more macro names that
1031 # this tag can be used to specify a list of macro names that should be expanded.
1032 # The macro definition that is found in the sources will be used.
1049 # The TAGFILES option can be used to specify one or more tagfiles.
1051 # can be added for each tagfile. The format of a tag file without
1056 # where "loc1" and "loc2" can be relative or absolute paths or
1058 # does not have to be run to correct the links.
1071 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1073 # will be listed.
1077 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1079 # be listed.
1083 # The PERL_PATH should be the absolute path and name of the perl script
1161 # So in most cases it will be better to enable call graphs for selected
1169 # So in most cases it will be better to enable caller graphs for selected
1186 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1188 # If left blank png will be used.
1192 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1193 # found. If left blank, it is assumed the dot tool can be found in the path.
1197 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1203 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1211 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1219 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1221 # from the root by following a path via at most 3 edges will be shown. Nodes
1222 # that lay further from the root node will be omitted. Note that setting this
1224 # code bases. Also note that a graph may be further truncated if the graph's
1262 # The SEARCHENGINE tag specifies whether or not a search engine should be
1263 # used. If set to NO the values of all tags below this one will be ignored.