doc/gbuild/doxygen.cfg

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
94 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
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
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
170 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
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
190 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
243 # set this tag to YES in order to let doxygen match functions declarations and
250 # If you use Microsoft's C++/CLI language, you should set this option to YES to
263 # will make doxygen to replace the get and set methods by a property in the
266 # methods anyway, you should set this option to NO.
271 # tag is set to YES, then doxygen will reuse the documentation of the first
315 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
318 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
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.
338 # This flag is only useful for Objective-C code. When set to YES local
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
393 # and Mac users are advised to set this option to NO.
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
438 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
484 # at the bottom of the documentation of classes and structs. If set to YES the
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
653 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
688 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
690 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
698 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
701 # VERBATIM_HEADERS is set to NO.
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
777 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
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
832 # To create a documentation set, doxygen will generate a Makefile in the
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
849 # should uniquely identify the documentation set bundle. This should be a
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
894 # The TOC_EXPAND flag can be set to YES to add extra items for group members
899 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
900 # are set, an additional index file will be generated that can be used as input for
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
954 # This tag can be used to set the number of enum values (range [1..20])
961 # If the tag value is set to FRAME, a side panel will be generated
977 # used to set the initial width (in pixels) of the frame in which the tree
994 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
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
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
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
1099 # replacements, missing definitions are set to their default value.
1112 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
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
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
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
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
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
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
1360 # have no effect if this option is set to NO (the default)
1375 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1382 # different font using DOT_FONTNAME you can set the path where dot
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
1418 # tags are set to YES then doxygen will generate a graph for each documented
1425 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
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
1459 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
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
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.