Lines Matching refs:to

3 # This file describes the settings to be used by the documentation system
18 # Use doxygen to compare the used configuration file with the template
21 # Use doxygen to compare the used configuration file with the template
47 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
62 # the logo to the output directory.
66 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
68 # entered, it will be relative to the location where doxygen was started. If
73 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
78 # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
85 # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
91 # This tag requires that the tag CREATE_SUBDIRS is set to YES.
95 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
96 # characters to appear in the names of generated files. If set to NO, non-ASCII
103 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
105 # information to generate all constant output in the proper language.
118 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
120 # documentation (similar to Javadoc). Set to NO to disable this.
125 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
128 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
135 # used to form the text in various listings. Each string in this list, if found
155 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
162 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
170 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
171 # before files name in the file list and in the header files. If set to NO the
177 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
179 # part of the path. The tag can be used to show relative paths in the file list.
180 # If left blank the directory from which doxygen is run is used as the path to
185 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
189 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
191 # header file to include in order to use a class. If left blank only the name of
193 # specify the list of include paths that are normally passed to the compiler
198 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
205 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
207 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
214 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
217 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
224 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
226 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
232 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
234 # a brief description. This used to be the default behavior. The new default is
235 # to treat a multi-line C++ comment block as a detailed description. Set this
236 # tag to YES if you prefer the old behavior instead.
238 # Note that setting this tag to YES also means that rational rose comments are
245 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
252 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
258 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
259 # page for each member. If set to NO, the documentation of a member will be part
265 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
266 # uses this value to replace tabs by spaces in code fragments.
271 # This tag can be used to specify a number of aliases that act as commands in
276 # will allow you to put the command \sideeffect (or @sideeffect) in the
279 # to insert newlines (in the resulting output). You can put ^^ in the value part
280 # of an alias to insert a newline as if a physical newline was in the original
282 # have to escape them by means of a backslash (\), this can lead to conflicts
283 # with the commands \{ and \} for these it is advised to use the version @{ and
288 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
296 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
304 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
310 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
316 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
324 # Doxygen selects the parser to use depending on the extension of the files it
325 # parses. With this tag you can assign which parser to use for a given
332 # tries to guess whether the code is fixed or free formatted code, this is the
333 # default for Fortran type files). For instance to make doxygen treat .inc files
339 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
341 # * to the FILE_PATTERNS.
348 # according to the Markdown format, which allows for more readable
357 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
358 # to that level are automatically included in the table of contents, even if
360 # Note: This feature currently applies only to Markdown headings.
362 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
366 # When enabled doxygen tries to link words that correspond to documented
367 # classes, or namespaces to their corresponding documentation. Such a link can
369 # globally by setting AUTOLINK_SUPPORT to NO.
375 # to include (a tag file for) the STL sources as input, then you should set this
376 # tag to YES in order to let doxygen match functions declarations and
384 # If you use Microsoft's C++/CLI language, you should set this option to YES to
390 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
398 # For Microsoft's IDL there are propget and propput attributes to indicate
399 # getter and setter methods for a property. Setting this option to YES will make
400 # doxygen to replace the get and set methods by a property in the documentation.
402 # type. If this is not the case, or you want to show the methods anyway, you
403 # should set this option to NO.
409 # tag is set to YES then doxygen will reuse the documentation of the first
416 # If one adds a struct or class to a group and this option is enabled, then also
417 # any nested class or struct is added to the same group. By default this option
418 # is disabled and one has to add nested compounds explicitly via \ingroup.
423 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
424 # (for instance a group of public functions) to be put as a subgroup of that
425 # type (e.g. under the Public Functions section). Set it to NO to prevent
432 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
443 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
447 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
465 # cache is used to resolve symbols given their name and scope. Since this can be
470 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
477 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
478 # during processing. When set to 0 doxygen will based this on the number of
479 # cores available in the system. You can set it explicitly to a value larger
480 # than 0 to get more control over the balance between CPU load and processing
482 # threads. Since this is still an experimental feature the default is set to 1,
494 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
497 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
499 # normally produced when WARNINGS is set to YES.
504 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
510 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
516 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
522 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
528 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
529 # locally in source files will be included in the documentation. If set to NO,
536 # This flag is only useful for Objective-C code. If set to YES, local methods,
538 # included in the documentation. If set to NO, only methods in the interface are
544 # If this flag is set to YES, the members of anonymous namespaces will be
553 # If this flag is set to YES, the name of an unnamed parameter in a declaration
560 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
561 # undocumented members inside documented classes or files. If set to NO these
568 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
570 # to NO, these classes will be included in the various overviews. This option
577 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
578 # declarations. If set to NO, these declarations will be included in the
584 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
585 # documentation blocks found inside the body of a function. If set to NO, these
586 # blocks will be appended to the function's detailed documentation block.
592 # \internal command is included. If the tag is set to NO then the documentation
593 # will be excluded. Set it to YES to include the internal documentation.
599 # able to match the capabilities of the underlying filesystem. In case the
601 # whose names only differ in casing), the option must be set to YES to properly
603 # are not case sensitive the option should be set to NO to properly deal with
605 # classes, one named CLASS and the other named Class, and to also support
606 # references to files without having to specify the exact matching casing. On
608 # to NO, whereas on Linux or other Unix flavors it should typically be set to
615 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
616 # their full class and namespace scopes in the documentation. If set to YES, the
622 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
623 # append additional text to a page's title, such as Class Reference. If set to
629 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
630 # will show which file needs to be included to use the class.
635 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
641 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
642 # grouped member an include statement to the documentation, telling the reader
643 # which file to include in order to use the member.
648 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
654 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
660 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
662 # name. If set to NO, the members will appear in declaration order.
667 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
669 # name. If set to NO, the members will appear in declaration order. Note that
675 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
677 # destructors are listed first. If set to NO the constructors will appear in the
679 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
681 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
687 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
688 # of group names into alphabetical order. If set to NO the group names will
694 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
695 # fully-qualified names, including namespaces. If set to NO, the class list will
697 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
698 # Note: This option applies only to the class list, not to the alphabetical
704 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
707 # only one candidate or it is obvious which candidate to choose by doing a
714 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
720 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
726 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
732 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
739 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
746 # initial value of a variable or macro / define can have for it to appear in the
748 # it will be hidden. Use a value of 0 to hide initializers completely. The
756 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
757 # the bottom of the documentation of classes and structs. If set to YES, the
758 # list will mention the files that were used to generate the documentation.
763 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
770 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
777 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
778 # doxygen should invoke to get the current version for each file (typically from
782 # by doxygen. Whatever the program writes to standard output is used as the file
787 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
801 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
804 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
807 # search path. See also \cite for info how to create references.
812 # Configuration options related to warning and progress messages
815 # The QUIET tag can be used to turn on/off the messages that are generated to
816 # standard output by doxygen. If QUIET is set to YES this implies that the
822 # The WARNINGS tag can be used to turn on/off the warning messages that are
823 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
831 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
832 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
838 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
846 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
847 # function parameter documentation. If set to NO, doxygen will accept that some
853 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
855 # value. If set to NO, doxygen will only warn about wrong parameter
857 # set to YES then this flag will automatically be disabled. See also
863 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
864 # undocumented enumeration values. If set to NO, doxygen will accept
865 # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
871 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
872 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
873 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
892 # to a more specific place is given. To make it easier to jump to this place
901 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
902 # messages should be written. If left blank the output is written to standard
904 # warning and error messages are written to standard error. When as file - is
905 # specified the warning and error messages are written to standard output
911 # Configuration options related to the input files
914 # The INPUT tag is used to specify the files and/or directories that contain
922 # This tag can be used to specify the character encoding of the source files
932 # This tag can be used to specify the character encoding of the source files
933 # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
943 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
944 # *.h) to filter out the source-files in the directories.
947 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
956 # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
1007 # The RECURSIVE tag can be used to specify whether or not subdirectories should
1013 # The EXCLUDE tag can be used to specify files and/or directories that should be
1017 # Note that relative paths are relative to the directory from which doxygen is
1022 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1030 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1033 # Note that the wildcards are matched against the file with absolute path, so to
1038 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1044 # Note that the wildcards are matched against the file with absolute path, so to
1049 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
1056 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1057 # *.h) to filter out the source-files in the directories. If left blank all
1062 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1063 # searched for input files to be used with the \include or \dontinclude commands
1069 # The IMAGE_PATH tag can be used to specify one or more files or directories
1070 # that contain images that are to be included in the documentation (see the
1075 # The INPUT_FILTER tag can be used to specify a program that doxygen should
1076 # invoke to filter for each input file. Doxygen will invoke the filter program
1083 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1090 # Note that doxygen will use the data processed and written to standard output
1093 # written to standard output.
1096 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1101 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1109 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1114 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1115 # INPUT_FILTER) will also be used to filter the input files that are used for
1116 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1121 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1123 # it is also possible to disable source filtering for a specific pattern using
1125 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1129 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1132 # and want to reuse the introduction page also for the doxygen output.
1137 # characters from position 72 are to be considered as comment. A common
1138 # extension is to allow longer lines before the automatic comment starts. The
1146 # Configuration options related to source browsing
1149 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1153 # also VERBATIM_HEADERS is set to NO.
1158 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1164 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1171 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1177 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1183 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1184 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1185 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1186 # link to the documentation.
1193 # brief description and links to the definition and documentation. Since this
1195 # can opt to disable this feature.
1197 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1201 # If the USE_HTAGS tag is set to YES then the references to source code will
1202 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1210 # - Make sure the INPUT points to the root of the source tree
1216 # The result: instead of the source browser generated by doxygen, the links to
1217 # source code will now point to the output of htags.
1219 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1225 # specified. Set to NO to disable this.
1232 # Configuration options related to the alphabetical class index
1235 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1242 # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1247 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1252 # Configuration options related to the HTML output
1255 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1260 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1264 # This tag requires that the tag GENERATE_HTML is set to YES.
1268 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1271 # This tag requires that the tag GENERATE_HTML is set to YES.
1275 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1281 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1286 # for information on how to generate the default header that doxygen normally
1288 # Note: The header is subject to change so you typically have to regenerate the
1289 # default header when upgrading to a newer version of doxygen. For a description
1291 # This tag requires that the tag GENERATE_HTML is set to YES.
1295 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1297 # footer. See HTML_HEADER for more information on how to generate a default
1299 # section "Doxygen usage" for information on how to generate the default footer
1301 # This tag requires that the tag GENERATE_HTML is set to YES.
1305 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1306 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1308 # See also section "Doxygen usage" for information on how to generate the style
1310 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1313 # This tag requires that the tag GENERATE_HTML is set to YES.
1317 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1322 # Doxygen will copy the style sheet files to the output directory.
1329 # customization is desired it has to be added explicitly. For an example see the
1331 # This tag requires that the tag GENERATE_HTML is set to YES.
1335 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1336 # other source files which should be copied to the HTML output directory. Note
1337 # that these files will be copied to the base HTML output directory. Use the
1338 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1341 # This tag requires that the tag GENERATE_HTML is set to YES.
1345 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1348 # generate dark mode output, AUTO_LIGHT automatically set the mode according to
1350 # AUTO_DARK automatically set the mode according to the user preference, use
1351 # dark mode if no preference is set and TOGGLE allow to user to switch between
1354 # This tag requires that the tag GENERATE_HTML is set to YES.
1359 # will adjust the colors in the style sheet and background images according to
1365 # This tag requires that the tag GENERATE_HTML is set to YES.
1373 # This tag requires that the tag GENERATE_HTML is set to YES.
1377 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1384 # This tag requires that the tag GENERATE_HTML is set to YES.
1388 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1390 # to YES can help to show when doxygen was last run and thus if the
1391 # documentation is up to date.
1393 # This tag requires that the tag GENERATE_HTML is set to YES.
1397 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1401 # page. Disable this option to support browsers that do not have JavaScript,
1404 # This tag requires that the tag GENERATE_HTML is set to YES.
1408 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1412 # This tag requires that the tag GENERATE_HTML is set to YES.
1418 # and collapse entries dynamically later on. Doxygen will expand the tree to
1425 # This tag requires that the tag GENERATE_HTML is set to YES.
1429 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1440 # This tag requires that the tag GENERATE_HTML is set to YES.
1448 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1455 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1461 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1463 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1471 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1477 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1481 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1499 # This tag requires that the tag GENERATE_HTML is set to YES.
1503 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1505 # written to the html output directory.
1506 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1510 # The HHC_LOCATION tag can be used to specify the location (absolute path
1512 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1513 # The file has to be specified with full path.
1514 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1521 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1525 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1527 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1535 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1539 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1540 # the table of contents of the HTML help documentation and to the tree view.
1542 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1546 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1548 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1551 # This tag requires that the tag GENERATE_HTML is set to YES.
1555 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1556 # the file name of the resulting .qch file. The path specified is relative to
1558 # This tag requires that the tag GENERATE_QHP is set to YES.
1562 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1567 # This tag requires that the tag GENERATE_QHP is set to YES.
1571 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1576 # This tag requires that the tag GENERATE_QHP is set to YES.
1581 # filter to add. For more information please see Qt Help Project / Custom
1584 # This tag requires that the tag GENERATE_QHP is set to YES.
1589 # custom filter to add. For more information please see Qt Help Project / Custom
1592 # This tag requires that the tag GENERATE_QHP is set to YES.
1599 # This tag requires that the tag GENERATE_QHP is set to YES.
1603 # The QHG_LOCATION tag can be used to specify the location (absolute path
1604 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1606 # This tag requires that the tag GENERATE_QHP is set to YES.
1610 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1614 # to be copied into the plugins directory of eclipse. The name of the directory
1616 # After copying Eclipse needs to be restarted before the help appears.
1618 # This tag requires that the tag GENERATE_HTML is set to YES.
1626 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1631 # be necessary to disable the index and replace it with your own. The
1632 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1635 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1637 # This tag requires that the tag GENERATE_HTML is set to YES.
1641 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1642 # structure should be generated to display hierarchical information. If the tag
1643 # value is set to YES, a side panel will be generated containing a tree-like
1645 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1650 # shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1652 # consider setting DISABLE_INDEX to YES when enabling this option.
1654 # This tag requires that the tag GENERATE_HTML is set to YES.
1658 # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
1659 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1660 # area (value NO) or if it should extend to the full height of the window (value
1661 # YES). Setting this to YES gives a layout similar to
1664 # DISABLE_INDEX is set to NO, this option has no effect.
1666 # This tag requires that the tag GENERATE_HTML is set to YES.
1670 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1676 # This tag requires that the tag GENERATE_HTML is set to YES.
1681 # to set the initial width (in pixels) of the frame in which the tree is shown.
1683 # This tag requires that the tag GENERATE_HTML is set to YES.
1687 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1690 # This tag requires that the tag GENERATE_HTML is set to YES.
1694 # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1697 # This tag requires that the tag GENERATE_HTML is set to YES.
1701 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1703 # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1708 # This tag requires that the tag GENERATE_HTML is set to YES.
1712 # Use this tag to change the font size of LaTeX formulas included as images in
1714 # doxygen run you need to manually remove any form_*.png images from the HTML
1715 # output directory to force them to be regenerated.
1717 # This tag requires that the tag GENERATE_HTML is set to YES.
1722 # to create new LaTeX commands to be used in formulas as building blocks. See
1727 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1730 # installed or if you want to formulas look prettier in the HTML output. When
1731 # enabled you may also need to install MathJax separately and configure the path
1732 # to it using the MATHJAX_RELPATH option.
1734 # This tag requires that the tag GENERATE_HTML is set to YES.
1738 # With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1740 # regards to the different settings, so it is possible that also other MathJax
1741 # settings have to be changed when switching between the different MathJax
1745 # This tag requires that the tag USE_MATHJAX is set to YES.
1749 # When MathJax is enabled you can set the default output format to be used for
1762 # This tag requires that the tag USE_MATHJAX is set to YES.
1766 # When MathJax is enabled you need to specify the location relative to the HTML
1770 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1772 # MathJax. However, it is strongly recommended to install a local copy of
1776 # This tag requires that the tag USE_MATHJAX is set to YES.
1780 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1788 # This tag requires that the tag USE_MATHJAX is set to YES.
1792 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1797 # This tag requires that the tag USE_MATHJAX is set to YES.
1807 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1808 # search using the keyboard; to jump to the search box use <access key> + S
1811 # key> to jump into the search results window, the results can be navigated
1812 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1815 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1818 # This tag requires that the tag GENERATE_HTML is set to YES.
1827 # and searching needs to be provided by external tools. See the section
1830 # This tag requires that the tag SEARCHENGINE is set to YES.
1835 # script for searching. Instead the search results are written to an XML file
1836 # which needs to be processed by an external indexer. Doxygen will invoke an
1837 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1847 # This tag requires that the tag SEARCHENGINE is set to YES.
1851 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1859 # This tag requires that the tag SEARCHENGINE is set to YES.
1864 # search data is written to a file for indexing by an external tool. With the
1867 # This tag requires that the tag SEARCHENGINE is set to YES.
1873 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1874 # projects and redirect the results back to the right project.
1875 # This tag requires that the tag SEARCHENGINE is set to YES.
1879 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1881 # all added to the same external search index. Each project needs to have a
1883 # to a relative location where the documentation can be found. The format is:
1885 # This tag requires that the tag SEARCHENGINE is set to YES.
1890 # Configuration options related to the LaTeX output
1893 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1898 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1902 # This tag requires that the tag GENERATE_LATEX is set to YES.
1906 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1914 # This tag requires that the tag GENERATE_LATEX is set to YES.
1918 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1924 # This tag requires that the tag GENERATE_LATEX is set to YES.
1928 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1934 # This tag requires that the tag GENERATE_LATEX is set to YES.
1938 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1939 # documents. This may be useful for small projects and may help to save some
1942 # This tag requires that the tag GENERATE_LATEX is set to YES.
1946 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1951 # This tag requires that the tag GENERATE_LATEX is set to YES.
1955 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1957 # by its name or with the correct syntax as to be used with the LaTeX
1963 # This tag requires that the tag GENERATE_LATEX is set to YES.
1967 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
1970 # is highly recommended to start with a default header using
1973 # information on how to generate the default header that doxygen normally uses.
1976 # Note: The header is subject to change so you typically have to regenerate the
1977 # default header when upgrading to a newer version of doxygen. The following
1980 # This tag requires that the tag GENERATE_LATEX is set to YES.
1984 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
1987 # LATEX_HEADER for more information on how to generate a default footer and what
1989 # usage" for information on how to generate the default footer that doxygen
1992 # This tag requires that the tag GENERATE_LATEX is set to YES.
1996 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1999 # will copy the style sheet files to the output directory.
2003 # This tag requires that the tag GENERATE_LATEX is set to YES.
2007 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2008 # other source files which should be copied to the LATEX_OUTPUT output
2011 # This tag requires that the tag GENERATE_LATEX is set to YES.
2015 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2016 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2020 # This tag requires that the tag GENERATE_LATEX is set to YES.
2024 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
2025 # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
2026 # files. Set this option to YES, to get a higher quality PDF documentation.
2030 # This tag requires that the tag GENERATE_LATEX is set to YES.
2034 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
2035 # command to the generated LaTeX files. This will instruct LaTeX to keep running
2038 # This tag requires that the tag GENERATE_LATEX is set to YES.
2042 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2045 # This tag requires that the tag GENERATE_LATEX is set to YES.
2049 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2053 # This tag requires that the tag GENERATE_LATEX is set to YES.
2057 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
2059 # to NO can help when comparing the output of multiple runs.
2061 # This tag requires that the tag GENERATE_LATEX is set to YES.
2065 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2067 # it will be relative to the LATEX_OUTPUT directory. If left blank the
2069 # This tag requires that the tag GENERATE_LATEX is set to YES.
2074 # Configuration options related to the RTF output
2077 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2084 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2088 # This tag requires that the tag GENERATE_RTF is set to YES.
2092 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2093 # documents. This may be useful for small projects and may help to save some
2096 # This tag requires that the tag GENERATE_RTF is set to YES.
2100 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2108 # This tag requires that the tag GENERATE_RTF is set to YES.
2112 # Load stylesheet definitions from file. Syntax is similar to doxygen's
2113 # configuration file, i.e. a series of assignments. You only have to provide
2114 # replacements, missing definitions are set to their default value.
2116 # See also section "Doxygen usage" for information on how to generate the
2118 # This tag requires that the tag GENERATE_RTF is set to YES.
2123 # similar to doxygen's configuration file. A template extensions file can be
2125 # This tag requires that the tag GENERATE_RTF is set to YES.
2130 # Configuration options related to the man page output
2133 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2139 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2144 # This tag requires that the tag GENERATE_MAN is set to YES.
2148 # The MAN_EXTENSION tag determines the extension that is added to the generated
2153 # This tag requires that the tag GENERATE_MAN is set to YES.
2158 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2160 # This tag requires that the tag GENERATE_MAN is set to YES.
2164 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2167 # them the man command would be unable to find the correct page.
2169 # This tag requires that the tag GENERATE_MAN is set to YES.
2174 # Configuration options related to the XML output
2177 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2183 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2187 # This tag requires that the tag GENERATE_XML is set to YES.
2191 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2192 # listings (including syntax highlighting and cross-referencing information) to
2196 # This tag requires that the tag GENERATE_XML is set to YES.
2200 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2203 # This tag requires that the tag GENERATE_XML is set to YES.
2208 # Configuration options related to the DOCBOOK output
2211 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2212 # that can be used to generate PDF.
2217 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2221 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2229 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2238 # Configuration options related to the Perl module output
2241 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2249 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2250 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2253 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2257 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2258 # formatted so it can be parsed by a human reader. This is useful if you want to
2259 # understand what is going on. On the other hand, if this tag is set to NO, the
2263 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2271 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2276 # Configuration options related to the preprocessor
2279 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2285 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2286 # in the source code. If set to NO, only conditional compilation will be
2288 # EXPAND_ONLY_PREDEF to YES.
2290 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2294 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2295 # the macro expansion is limited to the macros specified with the PREDEFINED and
2298 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2302 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2305 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2309 # The INCLUDE_PATH tag can be used to specify one or more directories that
2313 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2317 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2318 # patterns (like *.h and *.hpp) to filter out the header-files in the
2321 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2325 # The PREDEFINED tag can be used to specify one or more macro names that are
2326 # defined before the preprocessor is started (similar to the -D option of e.g.
2331 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2335 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2336 # tag can be used to specify a list of macro names that should be expanded. The
2338 # tag if you want to use a different macro definition that overrules the
2340 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2344 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2345 # remove all references to function-like macros that are alone on a line, have
2350 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2355 # Configuration options related to external references
2358 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2365 # section "Linking to external documentation" for more information about the use
2369 # run, you must also specify the path to the tagfile here.
2374 # tag file that is based on the input files it reads. See section "Linking to
2379 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2380 # the class index. If set to NO, only the inherited external classes will be
2386 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2387 # in the modules index. If set to NO, only the current project's groups will be
2393 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2394 # the related pages index. If set to NO, only the current project's pages will
2401 # Configuration options related to the dot tool
2405 # then run dia to produce the diagram and insert it in the documentation. The
2406 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2407 # If left empty dia is assumed to be found in the default search path.
2411 # If set to YES the inheritance and collaboration graphs will hide inheritance
2417 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2421 # set to NO
2427 # to run in parallel. When set to 0 doxygen will base this on the number of
2428 # processors available in the system. You can set it explicitly to a value
2429 # larger than 0 to get control over the balance between CPU load and processing
2432 # This tag requires that the tag HAVE_DOT is set to YES.
2440 # Edge and Graph Attributes specification</a> You need to make sure dot is able
2441 # to find the font, which can be done by putting it in a standard location or by
2442 # setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2445 # This tag requires that the tag HAVE_DOT is set to YES.
2454 # This tag requires that the tag HAVE_DOT is set to YES.
2462 # This tag requires that the tag HAVE_DOT is set to YES.
2468 # This tag requires that the tag HAVE_DOT is set to YES.
2472 # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
2474 # relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
2476 # to TEXT the direct and indirect inheritance relations will be shown as texts /
2483 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2488 # This tag requires that the tag HAVE_DOT is set to YES.
2492 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2496 # This tag requires that the tag HAVE_DOT is set to YES.
2500 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2501 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2504 # This tag requires that the tag HAVE_DOT is set to YES.
2510 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2511 # number of items for each type to make the size more manageable. Set this to 0
2513 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2514 # but if the number exceeds 15, the total amount of fields shown is limited to
2517 # This tag requires that the tag UML_LOOK is set to YES.
2521 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2523 # tag is set to YES, doxygen will add type and arguments for attributes and
2524 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2526 # class diagrams will look similar to the default class diagrams but using UML
2530 # This tag requires that the tag UML_LOOK is set to YES.
2534 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2535 # to display on a single line. If the actual line length exceeds this threshold
2537 # to avoid ugly line breaks.
2539 # This tag requires that the tag HAVE_DOT is set to YES.
2543 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2547 # This tag requires that the tag HAVE_DOT is set to YES.
2551 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2556 # This tag requires that the tag HAVE_DOT is set to YES.
2561 # set to YES then doxygen will generate a graph for each documented file showing
2565 # This tag requires that the tag HAVE_DOT is set to YES.
2569 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2573 # So in most cases it will be better to enable call graphs for selected
2577 # This tag requires that the tag HAVE_DOT is set to YES.
2581 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2585 # So in most cases it will be better to enable caller graphs for selected
2589 # This tag requires that the tag HAVE_DOT is set to YES.
2593 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2596 # This tag requires that the tag HAVE_DOT is set to YES.
2600 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2605 # This tag requires that the tag HAVE_DOT is set to YES.
2609 # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
2612 # This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2616 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2620 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2621 # to make the SVG files visible in IE 9+ (other browsers do not have this
2627 # This tag requires that the tag HAVE_DOT is set to YES.
2631 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2636 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2639 # This tag requires that the tag HAVE_DOT is set to YES.
2643 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2645 # This tag requires that the tag HAVE_DOT is set to YES.
2649 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2652 # This tag requires that the tag HAVE_DOT is set to YES.
2656 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2662 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2668 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2669 # path where java can find the plantuml.jar file or to the filename of jar file
2670 # to be used. If left blank, it is assumed PlantUML is not used or called during
2676 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2686 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2694 # This tag requires that the tag HAVE_DOT is set to YES.
2698 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2701 # further from the root node will be omitted. Note that setting this option to 1
2706 # This tag requires that the tag HAVE_DOT is set to YES.
2710 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2715 # This tag requires that the tag HAVE_DOT is set to YES.
2719 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2725 # This tag requires that the tag HAVE_DOT is set to YES.
2729 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2730 # files that are used to generate the various graphs.