llvm/docs/doxygen.cfg.in

3 # This file describes the settings to be used by the documentation system
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
52 # to the output directory.
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
58 # entered, it will be relative to the location where doxygen was started. If
63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
73 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
75 # information to generate all constant output in the proper language.
88 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
90 # documentation (similar to Javadoc). Set to NO to disable this.
95 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
98 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
105 # used to form the text in various listings. Each string in this list, if found
115 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
122 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
130 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
131 # before files name in the file list and in the header files. If set to NO the
137 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
139 # part of the path. The tag can be used to show relative paths in the file list.
140 # If left blank the directory from which doxygen is run is used as the path to
145 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
149 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
151 # header file to include in order to use a class. If left blank only the name of
153 # specify the list of include paths that are normally passed to the compiler
159 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
166 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
168 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
175 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
177 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
183 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
185 # a brief description. This used to be the default behavior. The new default is
186 # to treat a multi-line C++ comment block as a detailed description. Set this
187 # tag to YES if you prefer the old behavior instead.
189 # Note that setting this tag to YES also means that rational rose comments are
195 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
201 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
202 # new page for each member. If set to NO, the documentation of a member will be
208 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
209 # uses this value to replace tabs by spaces in code fragments.
214 # This tag can be used to specify a number of aliases that act as commands in
219 # will allow you to put the command \sideeffect (or @sideeffect) in the
221 # "Side Effects:". You can put \n's in the value part of an alias to insert
226 # This tag can be used to specify a number of word-keyword mappings (TCL only).
228 # will allow you to use the command class in the itcl::class meaning.
232 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
254 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
260 # Doxygen selects the parser to use depending on the extension of the files it
261 # parses. With this tag you can assign which parser to use for a given
265 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
271 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
277 # according to the Markdown format, which allows for more readable
286 # When enabled doxygen tries to link words that correspond to documented
287 # classes, or namespaces to their corresponding documentation. Such a link can
289 # or globally by setting AUTOLINK_SUPPORT to NO.
295 # to include (a tag file for) the STL sources as input, then you should set this
296 # tag to YES in order to let doxygen match functions declarations and
304 # If you use Microsoft's C++/CLI language, you should set this option to YES to
310 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
318 # For Microsoft's IDL there are propget and propput attributes to indicate
319 # getter and setter methods for a property. Setting this option to YES will make
320 # doxygen to replace the get and set methods by a property in the documentation.
322 # type. If this is not the case, or you want to show the methods anyway, you
323 # should set this option to NO.
329 # tag is set to YES, then doxygen will reuse the documentation of the first
336 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
337 # (for instance a group of public functions) to be put as a subgroup of that
338 # type (e.g. under the Public Functions section). Set it to NO to prevent
345 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
356 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
360 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
378 # cache is used to resolve symbols given their name and scope. Since this can be
383 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
394 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
397 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
399 # normally produced when WARNINGS is set to YES.
404 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
410 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
416 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
422 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
423 # locally in source files will be included in the documentation. If set to NO
430 # This flag is only useful for Objective-C code. When set to YES local methods,
432 # included in the documentation. If set to NO only methods in the interface are
438 # If this flag is set to YES, the members of anonymous namespaces will be
447 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
448 # undocumented members inside documented classes or files. If set to NO these
455 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
457 # to NO these classes will be included in the various overviews. This option has
463 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
464 # (class|struct|union) declarations. If set to NO these declarations will be
470 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
471 # documentation blocks found inside the body of a function. If set to NO these
472 # blocks will be appended to the function's detailed documentation block.
478 # \internal command is included. If the tag is set to NO then the documentation
479 # will be excluded. Set it to YES to include the internal documentation.
484 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
485 # names in lower-case letters. If set to YES upper-case letters are also
488 # and Mac users are advised to set this option to NO.
493 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
494 # their full class and namespace scopes in the documentation. If set to YES the
500 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
506 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
507 # grouped member an include statement to the documentation, telling the reader
508 # which file to include in order to use the member.
513 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
519 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
525 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
527 # name. If set to NO the members will appear in declaration order.
532 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
534 # name. If set to NO the members will appear in declaration order. Note that
540 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
542 # destructors are listed first. If set to NO the constructors will appear in the
544 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
546 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
552 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
553 # of group names into alphabetical order. If set to NO the group names will
559 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
560 # fully-qualified names, including namespaces. If set to NO, the class list will
562 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
563 # Note: This option applies only to the class list, not to the alphabetical
569 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
572 # only one candidate or it is obvious which candidate to choose by doing a
579 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
586 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
593 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
599 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
606 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
613 # initial value of a variable or macro / define can have for it to appear in the
615 # it will be hidden. Use a value of 0 to hide initializers completely. The
623 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
624 # the bottom of the documentation of classes and structs. If set to YES the list
625 # will mention the files that were used to generate the documentation.
630 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
637 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
644 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
645 # doxygen should invoke to get the current version for each file (typically from
649 # by doxygen. Whatever the program writes to standard output is used as the file
654 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
667 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
670 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
674 # also \cite for info how to create references.
679 # Configuration options related to warning and progress messages
682 # The QUIET tag can be used to turn on/off the messages that are generated to
683 # standard output by doxygen. If QUIET is set to YES this implies that the
689 # The WARNINGS tag can be used to turn on/off the warning messages that are
690 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
698 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
699 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
705 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
713 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
715 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
731 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
732 # messages should be written. If left blank the output is written to standard
738 # Configuration options related to the input files
741 # The INPUT tag is used to specify the files and/or directories that contain
751 # This tag can be used to specify the character encoding of the source files
761 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
762 # *.h) to filter out the source-files in the directories. If left blank the
771 # The RECURSIVE tag can be used to specify whether or not subdirectories should
777 # The EXCLUDE tag can be used to specify files and/or directories that should be
781 # Note that relative paths are relative to the directory from which doxygen is
786 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
794 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
797 # Note that the wildcards are matched against the file with absolute path, so to
802 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
808 # Note that the wildcards are matched against the file with absolute path, so to
813 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
820 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
821 # *.h) to filter out the source-files in the directories. If left blank all
826 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
827 # searched for input files to be used with the \include or \dontinclude commands
833 # The IMAGE_PATH tag can be used to specify one or more files or directories
834 # that contain images that are to be included in the documentation (see the
839 # The INPUT_FILTER tag can be used to specify a program that doxygen should
840 # invoke to filter for each input file. Doxygen will invoke the filter program
847 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
856 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
865 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
866 # INPUT_FILTER ) will also be used to filter the input files that are used for
867 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
872 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
874 # it is also possible to disable source filtering for a specific pattern using
876 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
880 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
883 # and want to reuse the introduction page also for the doxygen output.
888 # Configuration options related to source browsing
891 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
895 # also VERBATIM_HEADERS is set to NO.
900 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
906 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
913 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
919 # If the REFERENCES_RELATION tag is set to YES then for each documented function
925 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
926 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
927 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
928 # link to the documentation.
935 # brief description and links to the definition and documentation. Since this
937 # can opt to disable this feature.
939 # This tag requires that the tag SOURCE_BROWSER is set to YES.
943 # If the USE_HTAGS tag is set to YES then the references to source code will
944 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
952 # - Make sure the INPUT points to the root of the source tree
958 # The result: instead of the source browser generated by doxygen, the links to
959 # source code will now point to the output of htags.
961 # This tag requires that the tag SOURCE_BROWSER is set to YES.
967 # specified. Set to NO to disable this.
974 # Configuration options related to the alphabetical class index
977 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
984 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
987 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
993 # can be used to specify a prefix (or a list of prefixes) that should be ignored
995 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1000 # Configuration options related to the HTML output
1003 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1008 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1012 # This tag requires that the tag GENERATE_HTML is set to YES.
1016 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1019 # This tag requires that the tag GENERATE_HTML is set to YES.
1023 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1029 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1034 # for information on how to generate the default header that doxygen normally
1036 # Note: The header is subject to change so you typically have to regenerate the
1037 # default header when upgrading to a newer version of doxygen. For a description
1039 # This tag requires that the tag GENERATE_HTML is set to YES.
1043 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1045 # footer. See HTML_HEADER for more information on how to generate a default
1047 # section "Doxygen usage" for information on how to generate the default footer
1049 # This tag requires that the tag GENERATE_HTML is set to YES.
1053 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1054 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1056 # See also section "Doxygen usage" for information on how to generate the style
1058 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1061 # This tag requires that the tag GENERATE_HTML is set to YES.
1065 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1070 # Doxygen will copy the style sheet file to the output directory. For an example
1072 # This tag requires that the tag GENERATE_HTML is set to YES.
1076 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1077 # other source files which should be copied to the HTML output directory. Note
1078 # that these files will be copied to the base HTML output directory. Use the
1079 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1082 # This tag requires that the tag GENERATE_HTML is set to YES.
1087 # will adjust the colors in the stylesheet and background images according to
1093 # This tag requires that the tag GENERATE_HTML is set to YES.
1101 # This tag requires that the tag GENERATE_HTML is set to YES.
1105 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1112 # This tag requires that the tag GENERATE_HTML is set to YES.
1116 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1118 # to NO can help when comparing the output of multiple runs.
1120 # This tag requires that the tag GENERATE_HTML is set to YES.
1124 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1128 # This tag requires that the tag GENERATE_HTML is set to YES.
1134 # and collapse entries dynamically later on. Doxygen will expand the tree to
1141 # This tag requires that the tag GENERATE_HTML is set to YES.
1145 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1155 # This tag requires that the tag GENERATE_HTML is set to YES.
1163 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1169 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1171 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1179 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1185 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1189 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1203 # This tag requires that the tag GENERATE_HTML is set to YES.
1207 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1209 # written to the html output directory.
1210 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1214 # The HHC_LOCATION tag can be used to specify the location (absolute path
1216 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1217 # The file has to be specified with full path.
1218 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1225 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1229 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1231 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1238 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1242 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1243 # the table of contents of the HTML help documentation and to the tree view.
1245 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1249 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1251 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1254 # This tag requires that the tag GENERATE_HTML is set to YES.
1258 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1259 # the file name of the resulting .qch file. The path specified is relative to
1261 # This tag requires that the tag GENERATE_QHP is set to YES.
1265 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1269 # This tag requires that the tag GENERATE_QHP is set to YES.
1273 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1278 # This tag requires that the tag GENERATE_QHP is set to YES.
1283 # filter to add. For more information please see Qt Help Project / Custom
1286 # This tag requires that the tag GENERATE_QHP is set to YES.
1291 # custom filter to add. For more information please see Qt Help Project / Custom
1294 # This tag requires that the tag GENERATE_QHP is set to YES.
1301 # This tag requires that the tag GENERATE_QHP is set to YES.
1305 # The QHG_LOCATION tag can be used to specify the location of Qt's
1306 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1308 # This tag requires that the tag GENERATE_QHP is set to YES.
1312 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1316 # to be copied into the plugins directory of eclipse. The name of the directory
1318 # After copying Eclipse needs to be restarted before the help appears.
1320 # This tag requires that the tag GENERATE_HTML is set to YES.
1328 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1333 # be necessary to disable the index and replace it with your own. The
1334 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1337 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1339 # This tag requires that the tag GENERATE_HTML is set to YES.
1343 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1344 # structure should be generated to display hierarchical information. If the tag
1345 # value is set to YES, a side panel will be generated containing a tree-like
1347 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1351 # sheet generated by doxygen has an example that shows how to put an image at
1354 # DISABLE_INDEX to YES when enabling this option.
1356 # This tag requires that the tag GENERATE_HTML is set to YES.
1360 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1366 # This tag requires that the tag GENERATE_HTML is set to YES.
1371 # to set the initial width (in pixels) of the frame in which the tree is shown.
1373 # This tag requires that the tag GENERATE_HTML is set to YES.
1377 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1380 # This tag requires that the tag GENERATE_HTML is set to YES.
1384 # Use this tag to change the font size of LaTeX formulas included as images in
1386 # doxygen run you need to manually remove any form_*.png images from the HTML
1387 # output directory to force them to be regenerated.
1389 # This tag requires that the tag GENERATE_HTML is set to YES.
1393 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1397 # Note that when changing this option you need to delete any form_*.png files in
1400 # This tag requires that the tag GENERATE_HTML is set to YES.
1404 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1407 # installed or if you want to formulas look prettier in the HTML output. When
1408 # enabled you may also need to install MathJax separately and configure the path
1409 # to it using the MATHJAX_RELPATH option.
1411 # This tag requires that the tag GENERATE_HTML is set to YES.
1415 # When MathJax is enabled you can set the default output format to be used for
1421 # This tag requires that the tag USE_MATHJAX is set to YES.
1425 # When MathJax is enabled you need to specify the location relative to the HTML
1429 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1431 # MathJax. However, it is strongly recommended to install a local copy of
1434 # This tag requires that the tag USE_MATHJAX is set to YES.
1438 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1441 # This tag requires that the tag USE_MATHJAX is set to YES.
1445 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1449 # This tag requires that the tag USE_MATHJAX is set to YES.
1459 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1460 # search using the keyboard; to jump to the search box use <access key> + S
1463 # key> to jump into the search results window, the results can be navigated
1464 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1467 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1470 # This tag requires that the tag GENERATE_HTML is set to YES.
1479 # enabled the indexing and searching needs to be provided by external tools. See
1482 # This tag requires that the tag SEARCHENGINE is set to YES.
1487 # script for searching. Instead the search results are written to an XML file
1488 # which needs to be processed by an external indexer. Doxygen will invoke an
1489 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1498 # This tag requires that the tag SEARCHENGINE is set to YES.
1502 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1509 # This tag requires that the tag SEARCHENGINE is set to YES.
1514 # search data is written to a file for indexing by an external tool. With the
1517 # This tag requires that the tag SEARCHENGINE is set to YES.
1523 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1524 # projects and redirect the results back to the right project.
1525 # This tag requires that the tag SEARCHENGINE is set to YES.
1529 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1531 # all added to the same external search index. Each project needs to have a
1533 # to a relative location where the documentation can be found. The format is:
1535 # This tag requires that the tag SEARCHENGINE is set to YES.
1540 # Configuration options related to the LaTeX output
1543 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1548 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1552 # This tag requires that the tag GENERATE_LATEX is set to YES.
1556 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1561 # written to the output directory.
1563 # This tag requires that the tag GENERATE_LATEX is set to YES.
1567 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1570 # This tag requires that the tag GENERATE_LATEX is set to YES.
1574 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1575 # documents. This may be useful for small projects and may help to save some
1578 # This tag requires that the tag GENERATE_LATEX is set to YES.
1582 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1587 # This tag requires that the tag GENERATE_LATEX is set to YES.
1591 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1596 # This tag requires that the tag GENERATE_LATEX is set to YES.
1600 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1603 # section "Doxygen usage" for information on how to let doxygen write the
1604 # default header to a separate file.
1612 # This tag requires that the tag GENERATE_LATEX is set to YES.
1616 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1621 # This tag requires that the tag GENERATE_LATEX is set to YES.
1625 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1626 # other source files which should be copied to the LATEX_OUTPUT output
1629 # This tag requires that the tag GENERATE_LATEX is set to YES.
1633 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1634 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1638 # This tag requires that the tag GENERATE_LATEX is set to YES.
1642 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1643 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1646 # This tag requires that the tag GENERATE_LATEX is set to YES.
1650 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1651 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1655 # This tag requires that the tag GENERATE_LATEX is set to YES.
1659 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1662 # This tag requires that the tag GENERATE_LATEX is set to YES.
1666 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1672 # This tag requires that the tag GENERATE_LATEX is set to YES.
1676 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1680 # This tag requires that the tag GENERATE_LATEX is set to YES.
1685 # Configuration options related to the RTF output
1688 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1695 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1699 # This tag requires that the tag GENERATE_RTF is set to YES.
1703 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1704 # documents. This may be useful for small projects and may help to save some
1707 # This tag requires that the tag GENERATE_RTF is set to YES.
1711 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1719 # This tag requires that the tag GENERATE_RTF is set to YES.
1723 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1724 # file, i.e. a series of assignments. You only have to provide replacements,
1725 # missing definitions are set to their default value.
1727 # See also section "Doxygen usage" for information on how to generate the
1729 # This tag requires that the tag GENERATE_RTF is set to YES.
1734 # similar to doxygen's config file. A template extensions file can be generated
1736 # This tag requires that the tag GENERATE_RTF is set to YES.
1741 # Configuration options related to the man page output
1744 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1750 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1755 # This tag requires that the tag GENERATE_MAN is set to YES.
1759 # The MAN_EXTENSION tag determines the extension that is added to the generated
1764 # This tag requires that the tag GENERATE_MAN is set to YES.
1768 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1771 # them the man command would be unable to find the correct page.
1773 # This tag requires that the tag GENERATE_MAN is set to YES.
1778 # Configuration options related to the XML output
1781 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1787 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1791 # This tag requires that the tag GENERATE_XML is set to YES.
1795 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1796 # listings (including syntax highlighting and cross-referencing information) to
1800 # This tag requires that the tag GENERATE_XML is set to YES.
1805 # Configuration options related to the DOCBOOK output
1808 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1809 # that can be used to generate PDF.
1814 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1818 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1826 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1835 # Configuration options related to the Perl module output
1838 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1846 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1847 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1850 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1854 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1855 # formatted so it can be parsed by a human reader. This is useful if you want to
1856 # understand what is going on. On the other hand, if this tag is set to NO the
1860 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1868 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1873 # Configuration options related to the preprocessor
1876 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1882 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1883 # in the source code. If set to NO only conditional compilation will be
1885 # EXPAND_ONLY_PREDEF to YES.
1887 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1891 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1892 # the macro expansion is limited to the macros specified with the PREDEFINED and
1895 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1899 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1902 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1906 # The INCLUDE_PATH tag can be used to specify one or more directories that
1909 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1913 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1914 # patterns (like *.h and *.hpp) to filter out the header-files in the
1917 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1921 # The PREDEFINED tag can be used to specify one or more macro names that are
1922 # defined before the preprocessor is started (similar to the -D option of e.g.
1927 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1931 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1932 # tag can be used to specify a list of macro names that should be expanded. The
1934 # tag if you want to use a different macro definition that overrules the
1936 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1940 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1941 # remove all references to function-like macros that are alone on a line, have an
1946 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1951 # Configuration options related to external references
1954 # The TAGFILES tag can be used to specify one or more tag files. For each tag
1961 # section "Linking to external documentation" for more information about the use
1965 # run, you must also specify the path to the tagfile here.
1970 # tag file that is based on the input files it reads. See section "Linking to
1975 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1976 # class index. If set to NO only the inherited external classes will be listed.
1981 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
1982 # the modules index. If set to NO, only the current project's groups will be
1988 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
1989 # the related pages index. If set to NO, only the current project's pages will
2002 # Configuration options related to the dot tool
2005 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2006 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2008 # disabled, but it is recommended to install and use dot, since it yields more
2016 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2017 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2018 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2024 # then run dia to produce the diagram and insert it in the documentation. The
2025 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2026 # If left empty dia is assumed to be found in the default search path.
2030 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2036 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2040 # set to NO
2046 # to run in parallel. When set to 0 doxygen will base this on the number of
2047 # processors available in the system. You can set it explicitly to a value
2048 # larger than 0 to get control over the balance between CPU load and processing
2051 # This tag requires that the tag HAVE_DOT is set to YES.
2056 # generates you can specify the font name using DOT_FONTNAME. You need to make
2057 # sure dot is able to find the font, which can be done by putting it in a
2059 # setting DOT_FONTPATH to the directory containing the font.
2061 # This tag requires that the tag HAVE_DOT is set to YES.
2065 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2068 # This tag requires that the tag HAVE_DOT is set to YES.
2072 # By default doxygen will tell dot to use the default font as specified with
2075 # This tag requires that the tag HAVE_DOT is set to YES.
2079 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2081 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2083 # This tag requires that the tag HAVE_DOT is set to YES.
2087 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2092 # This tag requires that the tag HAVE_DOT is set to YES.
2096 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2099 # This tag requires that the tag HAVE_DOT is set to YES.
2103 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2104 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2107 # This tag requires that the tag HAVE_DOT is set to YES.
2113 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2114 # number of items for each type to make the size more manageable. Set this to 0
2116 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2117 # but if the number exceeds 15, the total amount of fields shown is limited to
2120 # This tag requires that the tag HAVE_DOT is set to YES.
2124 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2128 # This tag requires that the tag HAVE_DOT is set to YES.
2132 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2137 # This tag requires that the tag HAVE_DOT is set to YES.
2142 # set to YES then doxygen will generate a graph for each documented file showing
2146 # This tag requires that the tag HAVE_DOT is set to YES.
2150 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2154 # So in most cases it will be better to enable call graphs for selected
2157 # This tag requires that the tag HAVE_DOT is set to YES.
2161 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2165 # So in most cases it will be better to enable caller graphs for selected
2168 # This tag requires that the tag HAVE_DOT is set to YES.
2172 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2175 # This tag requires that the tag HAVE_DOT is set to YES.
2179 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2184 # This tag requires that the tag HAVE_DOT is set to YES.
2188 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2190 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2191 # to make the SVG files visible in IE 9+ (other browsers do not have this
2195 # This tag requires that the tag HAVE_DOT is set to YES.
2199 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2204 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2207 # This tag requires that the tag HAVE_DOT is set to YES.
2211 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2213 # This tag requires that the tag HAVE_DOT is set to YES.
2217 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2220 # This tag requires that the tag HAVE_DOT is set to YES.
2224 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2230 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2236 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2244 # This tag requires that the tag HAVE_DOT is set to YES.
2248 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2251 # further from the root node will be omitted. Note that setting this option to 1
2256 # This tag requires that the tag HAVE_DOT is set to YES.
2260 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2262 # to support this out of the box.
2264 # Warning: Depending on the platform used, enabling this option may lead to
2265 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2268 # This tag requires that the tag HAVE_DOT is set to YES.
2272 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2277 # This tag requires that the tag HAVE_DOT is set to YES.
2281 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2285 # This tag requires that the tag HAVE_DOT is set to YES.
2289 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2290 # files that are used to generate the various graphs.
2292 # This tag requires that the tag HAVE_DOT is set to YES.