doc/gbuild/doxygen.cfg

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.
63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
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
104 # If left blank, the following values are used ("$name" is automatically
111 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
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
125 # path before files name in the file list and in the header files. If set
130 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
134 # If left blank the directory from which doxygen is run is used as the
142 # If left blank only the name of the header file containing the class
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
156 # comment as the brief description. If set to NO, the JavaDoc
162 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
164 # comment as the brief description. If set to NO, the comments
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
185 # a new page for each member. If set to NO, the documentation of a member will
241 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
250 # If you use Microsoft's C++/CLI language, you should set this option to YES to
265 # setting a simple type. If this is not the case, or you want to show the
270 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
302 # If the system has enough physical memory increasing the cache will improve the
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)
334 # If set to NO only classes defined in header files are included.
341 # If set to NO (the default) only methods in the interface are included.
345 # If this flag is set to YES, the members of anonymous namespaces will be
353 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
355 # If set to NO (the default) these members will be included in the
361 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
363 # If set to NO (the default) these classes will be included in the various
368 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
370 # If set to NO (the default) these declarations will be included in the
375 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
377 # If set to NO (the default) these blocks will be appended to the
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
390 # file names in lower-case letters. If set to YES upper-case letters are also
397 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
399 # documentation. If set to YES the scope will be hidden.
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
416 # alphabetically by member name. If set to NO the members will appear in
421 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
423 # by member name. If set to NO (the default) the members will appear in
428 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
429 # hierarchy of group names into alphabetical order. If set to NO (the default)
434 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
435 # sorted by fully-qualified names, including namespaces. If set to
475 # the documentation. If the initializer consists of more lines than specified
484 # at the bottom of the documentation of classes and structs. If set to YES the
489 # If the sources in your project are distributed over multiple directories
532 # by doxygen. Possible values are YES and NO. If left blank NO is used.
537 # generated by doxygen. Possible values are YES and NO. If left blank
542 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
543 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
548 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
557 # or return value. If set to NO (the default) doxygen will only warn about
573 # and error messages should be written. If left blank the output is written
597 # If the value of the INPUT tag contains directories, you can use the
599 # and *.h) to filter out the source-files in the directories. If left
608 # If left blank NO is used.
624 # If the value of the INPUT tag contains directories, you can use the
646 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
648 # and *.h) to filter out the source-files in the directories. If left
653 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
656 # Possible values are YES and NO. If left blank NO is used.
672 # If FILTER_PATTERNS is specified, this tag will be
683 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
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
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)
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
760 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
777 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
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.
789 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
795 # each generated HTML page. If it is left blank doxygen will generate a
801 # each generated HTML page. If it is left blank doxygen will generate a
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,
816 # files or namespaces will be aligned in HTML using tables. If set to
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
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
871 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
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
924 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
941 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
943 # If non-empty doxygen will try to run qhelpgenerator on the generated
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
994 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
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.
1006 # invoked. If left blank `latex' will be used as the default command name.
1011 # generate index for LaTeX. If left blank `makeindex' will be used as the
1016 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1024 # executive. If left blank a4wide will be used.
1035 # the first chapter. If it is left blank doxygen will generate a
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.
1060 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1070 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
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.
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
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.
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
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.
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
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
1229 # names in the source code. If set to NO (the default) only conditional
1235 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1241 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1254 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1262 # or name=definition (no spaces). If the definition and the = are
1269 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1276 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1298 # URLs. If a location is present for each tag, the installdox tool
1302 # If a tag file is not located in the directory in which doxygen
1312 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1313 # in the class index. If set to NO only the inherited external classes
1318 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1319 # in the modules index. If set to NO, only the current project's groups will
1333 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1346 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1351 # If set to YES, the inheritance and collaboration graphs will hide
1357 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1381 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1387 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1394 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1401 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1406 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1412 # If set to YES, the inheritance and collaboration graphs will show the
1417 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1424 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1431 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1439 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1447 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1452 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1461 # If left blank png will be used.
1466 # found. If left blank, it is assumed the dot tool can be found in the path.
1477 # nodes that will be shown in the graph. If the number of nodes in a graph
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
1528 # used. If set to NO the values of all tags below this one will be ignored.