doc/gbuild/doxygen.cfg

37 # This tag specifies the encoding used for all characters in the config file
39 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
45 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
50 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
72 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
85 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
92 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
99 # This tag implements a quasi-intelligent brief description abbreviator
117 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
124 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
130 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
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
148 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
154 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
162 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
170 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
174 # description. Set this tag to YES if you prefer the old behaviour instead.
178 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
184 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
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
204 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
211 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
218 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
224 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
231 # With this tag you can assign which parser to use for a given extension.
232 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
242 # to include (a tag file for) the STL sources as input, then you should
243 # set this tag to YES in order to let doxygen match functions declarations and
255 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
271 # tag is set to YES, then doxygen will reuse the documentation of the first
277 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
291 # types are typedef'ed and only the typedef is referenced, never the tag name.
315 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
322 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
327 # If the EXTRACT_STATIC tag is set to YES all static members of a file
332 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
353 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
361 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
368 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
375 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
382 # The INTERNAL_DOCS tag determines if documentation
383 # that is typed after a \internal command is included. If the tag is set
389 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
397 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
403 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
409 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
414 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
421 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
428 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
434 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
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
473 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
483 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
490 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
495 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
501 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
508 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
512 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
518 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
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
563 # The WARN_FORMAT tag determines the format of the warning messages that
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
597 # If the value of the INPUT tag contains directories, you can use the
598 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
606 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
612 # The EXCLUDE tag can be used to specify files and/or directories that should
614 # subdirectory from a directory tree whose root is specified with the INPUT tag.
618 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
624 # If the value of the INPUT tag contains directories, you can use the
625 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
632 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
640 # The EXAMPLE_PATH tag can be used to specify one or more files or
646 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
647 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
653 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
655 # commands irrespective of the value of the RECURSIVE tag.
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
669 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
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
688 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
698 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
705 # Setting the INLINE_SOURCES tag to YES will include the body
710 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
716 # If the REFERENCED_BY_RELATION tag is set to YES
722 # If the REFERENCES_RELATION tag is set to YES
728 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
729 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
736 # If the USE_HTAGS tag is set to YES then the references to source code
744 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
754 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
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
777 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
782 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
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
808 # fine-tune the look of the HTML output. If the tag is left blank doxygen
815 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
821 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
829 # If the GENERATE_DOCSET tag is set to YES, additional index files
841 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
848 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
855 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
862 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
869 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
876 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
882 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
888 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
899 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
906 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
912 # The QHP_NAMESPACE tag specifies the namespace to use when generating
918 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
930 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For …
935 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
941 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
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
961 # If the tag value is set to FRAME, a side panel will be generated
967 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
976 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
982 # Use this tag to change the font size of Latex formulas included
994 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
999 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1005 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1010 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1016 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1022 # The PAPER_TYPE tag can be used to set the paper type that is used
1028 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1033 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1036 # standard header. Notice: only use this tag if you know what you are doing!
1040 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1047 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1053 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1070 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1076 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1082 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1088 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1112 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1117 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1123 # The MAN_EXTENSION tag determines the extension that is added to
1128 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1140 # If the GENERATE_XML tag is set to YES Doxygen will
1146 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1152 # The XML_SCHEMA tag can be used to specify an XML schema,
1158 # The XML_DTD tag can be used to specify an XML DTD,
1164 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1175 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1187 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1195 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1201 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1206 # tag is set to NO the size of the Perl module output will be much smaller
1222 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1228 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1241 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1246 # The INCLUDE_PATH tag can be used to specify one or more directories that
1252 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1259 # The PREDEFINED tag can be used to specify one or more macro names that
1261 # gcc). The argument of the tag is a list of macros of the form: name
1270 # this tag can be used to specify a list of macro names that should be expanded.
1272 # Use the PREDEFINED tag if you want to use a different macro definition.
1276 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1290 # can be added for each tagfile. The format of a tag file without
1294 # Adding location for the tag files is done as follows:
1298 # URLs. If a location is present for each tag, the installdox tool
1300 # Note that each tag file must have a unique name
1302 # If a tag file is not located in the directory in which doxygen
1308 # a tag file that is based on the input files it reads.
1312 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1318 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1333 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1335 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1345 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1357 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1375 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1383 # can find it using this tag.
1389 # indirect inheritance relations. Setting this tag to YES will force the
1390 # the CLASS_DIAGRAMS tag to NO.
1406 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1459 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
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
1496 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1504 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1511 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1517 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1527 # The SEARCHENGINE tag specifies whether or not a search engine should be