Lines Matching refs:is

6 # All text after a double hash (##) is considered a comment and is placed in
7 # front of the TAG it is preceding.
9 # All text after a single hash (#) is considered a comment and will be ignored.
10 # The format is:
31 # file that follow. The default is UTF-8 which is also the encoding used for all
35 # The default value is: UTF-8.
39 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
41 # project for which the documentation is generated. This name is used in the
43 # The default value is: My Project.
49 # control system is used.
59 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
66 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
67 # into which the generated documentation will be written. If a relative path is
73 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
80 # The default value is: NO.
85 # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
87 # directories at level 8 which is the default and also the maximum value. The
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
99 # The default value is: NO.
103 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
104 # documentation generated by doxygen is written. Doxygen will use this
114 # The default value is: English.
118 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
121 # The default value is: YES.
125 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
130 # The default value is: YES.
134 # This tag implements a quasi-intelligent brief description abbreviator that is
137 # and the result, after processing the whole list, is used as the annotated
138 # text. Otherwise, the brief description is used as-is. If left blank, the
139 # following values are used ($name is automatically replaced with the name of
140 # the entity):The $name class, The $name widget, The $name file, is, provides,
146 # doxygen will generate a detailed section even if there is only a brief
148 # The default value is: NO.
152 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
156 # The default value is: NO.
160 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
163 # The default value is: YES.
168 # Stripping is only done if one of the specified strings matches the left-hand
170 # If left blank the directory from which doxygen is run is used as the path to
174 # will be relative from the directory where doxygen is started.
175 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
182 # the header file containing the class definition is used. Otherwise one should
188 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
189 # less readable) file names. This can be useful is your file systems doesn't
191 # The default value is: NO.
195 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
200 # The default value is: NO.
204 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
210 # The default value is: NO.
214 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
218 # The default value is: NO.
224 # a brief description. This used to be the default behavior. The new default is
230 # The default value is: NO.
237 # documentation blocks is shown as doxygen documentation.
238 # The default value is: YES.
242 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
244 # The default value is: YES.
248 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
251 # The default value is: NO.
273 # with the commands \{ and \} for these it is advised to use the version @{ and
279 # only. Doxygen will then generate output that is more tailored for C. For
282 # The default value is: NO.
287 # Python sources only. Doxygen will then generate output that is more tailored
290 # The default value is: NO.
295 # sources. Doxygen will then generate output that is tailored for Fortran.
296 # The default value is: NO.
301 # sources. Doxygen will then generate output that is tailored for VHDL.
302 # The default value is: NO.
307 # sources only. Doxygen will then generate output that is more tailored for that
310 # The default value is: NO.
317 # using this tag. The format is ext=language, where ext is a file extension, and
318 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
322 # tries to guess whether the code is fixed or free formatted code, this is the
324 # as Fortran files (default is PHP), and .f files as C (default is Fortran),
337 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
340 # The output of markdown processing is further processed by doxygen, so you can
343 # The default value is: YES.
347 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
352 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
357 # generate identifiers for the Markdown headings. Note: Every identifier is
362 # The default value is: DOXYGEN.
363 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
371 # The default value is: YES.
381 # The default value is: NO.
387 # The default value is: NO.
394 # of private inheritance when no explicit protection keyword is present.
395 # The default value is: NO.
403 # type. If this is not the case, or you want to show the methods anyway, you
405 # The default value is: YES.
409 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
410 # tag is set to YES then doxygen will reuse the documentation of the first
413 # The default value is: NO.
417 # If one adds a struct or class to a group and this option is enabled, then also
418 # any nested class or struct is added to the same group. By default this option
419 # is disabled and one has to add nested compounds explicitly via \ingroup.
420 # The default value is: NO.
429 # The default value is: YES.
433 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
440 # The default value is: NO.
444 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
447 # namespace, or group documentation), provided this scope is documented. If set
450 # The default value is: NO.
454 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
455 # enum is documented as struct, union, or enum with the name of the typedef. So
460 # types are typedef'ed and only the typedef is referenced, never the tag name.
461 # The default value is: NO.
466 # cache is used to resolve symbols given their name and scope. Since this can be
468 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
469 # doxygen will become slower. If the cache is too large, memory is wasted. The
470 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
471 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
478 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
483 # threads. Since this is still an experimental feature the default is set to 1,
485 # encounter. Generating dot graphs in parallel is controlled by the
491 # If the TIMESTAMP tag is set different from NO then each generated page will
495 # The default value is: NO.
503 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
508 # normally produced when WARNINGS is set to YES.
509 # The default value is: NO.
513 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
515 # The default value is: NO.
519 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
521 # The default value is: NO.
525 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
527 # The default value is: NO.
531 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
533 # The default value is: NO.
537 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
541 # The default value is: YES.
545 # This flag is only useful for Objective-C code. If set to YES, local methods,
549 # The default value is: NO.
553 # If this flag is set to YES, the members of anonymous namespaces will be
558 # The default value is: NO.
562 # If this flag is set to YES, the name of an unnamed parameter in a declaration
565 # The default value is: YES.
569 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
572 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
573 # The default value is: NO.
577 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
581 # if EXTRACT_ALL is enabled.
582 # The default value is: NO.
586 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
589 # The default value is: NO.
593 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
596 # The default value is: NO.
600 # The INTERNAL_DOCS tag determines if documentation that is typed after a
601 # \internal command is included. If the tag is set to NO then the documentation
603 # The default value is: NO.
609 # filesystem is case sensitive (i.e. it supports files in the same directory
620 # The default value is: SYSTEM.
624 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
627 # The default value is: NO.
631 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
634 # The default value is: NO.
638 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
640 # The default value is: YES.
644 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
646 # The default value is: YES.
650 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
653 # The default value is: NO.
657 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
659 # The default value is: NO.
663 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
665 # The default value is: YES.
669 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
672 # The default value is: YES.
676 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
680 # The default value is: NO.
684 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
688 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
690 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
692 # The default value is: NO.
696 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
699 # The default value is: NO.
703 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
706 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
709 # The default value is: NO.
713 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
715 # the prototype and the implementation of a member function even if there is
716 # only one candidate or it is obvious which candidate to choose by doing a
719 # The default value is: NO.
724 # list. This list is created by putting \todo commands in the documentation.
725 # The default value is: YES.
730 # list. This list is created by putting \test commands in the documentation.
731 # The default value is: YES.
736 # list. This list is created by putting \bug commands in the documentation.
737 # The default value is: YES.
742 # the deprecated list. This list is created by putting \deprecated commands in
744 # The default value is: YES.
768 # The default value is: YES.
775 # The default value is: YES.
782 # The default value is: YES.
789 # popen()) the command command input-file, where command is the value of the
790 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
791 # by doxygen. Whatever the program writes to standard output is used as the file
806 # tag is left empty.
812 # extension is automatically appended if omitted. This requires the bibtex tool
825 # standard output by doxygen. If QUIET is set to YES this implies that the
827 # The default value is: NO.
832 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
836 # The default value is: YES.
840 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
841 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
843 # The default value is: YES.
847 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
851 # The default value is: YES.
855 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
858 # The default value is: YES.
865 # documentation, but not about the absence of documentation. If EXTRACT_ALL is
868 # The default value is: NO.
872 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
874 # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
876 # The default value is: NO.
880 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
881 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
882 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
884 # If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves
885 # like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not
887 # of a run, in case a WARN_LOGFILE is defined the warning messages will be
889 # the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
892 # The default value is: NO.
903 # The default value is: $file:$line: $text.
907 # In the $text part of the WARN_FORMAT command it is possible that a reference
908 # to a more specific place is given. To make it easier to jump to this place
913 # The default value is: at line $line of file $file.
918 # messages should be written. If left blank the output is written to standard
920 # warning and error messages are written to standard error. When as file - is
930 # The INPUT tag is used to specify the files and/or directories that contain
934 # Note: If this tag is empty the current directory is searched.
944 # The default value is: UTF-8.
952 # INPUT_ENCODING) if there is a match. The character encodings are a list of the
980 # The default value is: NO.
986 # subdirectory from a directory tree whose root is specified with the INPUT tag.
988 # Note that relative paths are relative to the directory from which doxygen is
1017 # The default value is: NO.
1033 # wildcard * is used, a substring. Examples: ANamespace, AClass,
1051 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1054 # The default value is: NO.
1070 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1072 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1075 # Note that the filter must not add or remove lines; it is applied before the
1076 # code is scanned, but not when the output code is generated. If lines are added
1092 # filter if there is a match. The filters are a list of the form: pattern=filter
1094 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1095 # patterns match the file name, INPUT_FILTER is applied.
1103 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1105 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1106 # The default value is: NO.
1112 # it is also possible to disable source filtering for a specific pattern using
1114 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1119 # is part of the input, its contents will be placed on the main page
1127 # extension is to allow longer lines before the automatic comment starts. The
1138 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1142 # also VERBATIM_HEADERS is set to NO.
1143 # The default value is: NO.
1149 # The default value is: NO.
1156 # The default value is: YES.
1160 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1162 # The default value is: NO.
1166 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1168 # The default value is: NO.
1172 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1176 # The default value is: YES.
1180 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1185 # The default value is: YES.
1186 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1190 # If the USE_HTAGS tag is set to YES then the references to source code will
1192 # source browser. The htags tool is part of GNU's global source tagging system
1207 # The default value is: NO.
1208 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1212 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1213 # verbatim copy of the header file for each class for which an include is
1216 # The default value is: YES.
1220 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1227 # The default value is: NO.
1231 # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
1232 # tag is set to YES then doxygen will add the directory of each input to the
1234 # The default value is: YES.
1235 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1239 # If clang assisted parsing is enabled you can provide the compiler with command
1243 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1247 # If clang assisted parsing is enabled you can provide the clang parser with the
1249 # file is the compilation database (see:
1251 # options used when the source files were built. This is equivalent to
1264 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1267 # The default value is: YES.
1276 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1284 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1285 # The default value is: YES.
1289 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1290 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1292 # The default directory is: html.
1293 # This tag requires that the tag GENERATE_HTML is set to YES.
1299 # The default value is: .html.
1300 # This tag requires that the tag GENERATE_HTML is set to YES.
1305 # each generated HTML page. If the tag is left blank doxygen will generate a
1309 # that doxygen needs, which is dependent on the configuration options used (e.g.
1310 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1317 # Note: The header is subject to change so you typically have to regenerate the
1320 # This tag requires that the tag GENERATE_HTML is set to YES.
1325 # generated HTML page. If the tag is left blank doxygen will generate a standard
1330 # This tag requires that the tag GENERATE_HTML is set to YES.
1335 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1339 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1340 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1342 # This tag requires that the tag GENERATE_HTML is set to YES.
1349 # This is preferred over using HTML_STYLESHEET since it does not replace the
1350 # standard style sheet and is therefore more robust against future updates.
1352 # Note: The order of the extra style sheet files is of importance (e.g. the last
1358 # customization is desired it has to be added explicitly. For an example see the
1360 # This tag requires that the tag GENERATE_HTML is set to YES.
1369 # files will be copied as-is; there are no commands or markers available.
1370 # This tag requires that the tag GENERATE_HTML is set to YES.
1378 # the user preference, use light mode if no preference is set (the default),
1380 # dark mode if no preference is set and TOGGLE allow to user to switch between
1382 # The default value is: AUTO_LIGHT.
1383 # This tag requires that the tag GENERATE_HTML is set to YES.
1389 # this color. Hue is specified as an angle on a color-wheel, see
1391 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1392 # purple, and 360 is red again.
1394 # This tag requires that the tag GENERATE_HTML is set to YES.
1402 # This tag requires that the tag GENERATE_HTML is set to YES.
1409 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1413 # This tag requires that the tag GENERATE_HTML is set to YES.
1417 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1423 # The default value is: YES.
1424 # This tag requires that the tag GENERATE_HTML is set to YES.
1428 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1431 # The default value is: NO.
1432 # This tag requires that the tag GENERATE_HTML is set to YES.
1441 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1445 # This tag requires that the tag GENERATE_HTML is set to YES.
1449 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1459 # The default value is: NO.
1460 # This tag requires that the tag GENERATE_HTML is set to YES.
1467 # The default value is: Doxygen generated docs.
1468 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1475 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1482 # The default value is: org.doxygen.Project.
1483 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1490 # The default value is: org.doxygen.Publisher.
1491 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1496 # The default value is: Publisher.
1497 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1501 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1503 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1518 # The default value is: NO.
1519 # This tag requires that the tag GENERATE_HTML is set to YES.
1526 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1534 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1538 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1540 # The default value is: NO.
1541 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1545 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1547 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1551 # The BINARY_TOC flag controls whether a binary table of contents is generated
1554 # The default value is: NO.
1555 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1561 # The default value is: NO.
1562 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1566 # The SITEMAP_URL tag is used to specify the full URL of the place where the
1568 # deployment of the documentation. The generated sitemap is called sitemap.xml
1570 # is specified no sitemap is generated. For information about the sitemap
1572 # This tag requires that the tag GENERATE_HTML is set to YES.
1576 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1580 # The default value is: NO.
1581 # This tag requires that the tag GENERATE_HTML is set to YES.
1585 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1586 # the file name of the resulting .qch file. The path specified is relative to
1588 # This tag requires that the tag GENERATE_QHP is set to YES.
1596 # The default value is: org.doxygen.Project.
1597 # This tag requires that the tag GENERATE_QHP is set to YES.
1605 # The default value is: doc.
1606 # This tag requires that the tag GENERATE_QHP is set to YES.
1610 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1614 # This tag requires that the tag GENERATE_QHP is set to YES.
1622 # This tag requires that the tag GENERATE_QHP is set to YES.
1629 # This tag requires that the tag GENERATE_QHP is set to YES.
1636 # This tag requires that the tag GENERATE_QHP is set to YES.
1640 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1647 # The default value is: NO.
1648 # This tag requires that the tag GENERATE_HTML is set to YES.
1655 # The default value is: org.doxygen.Project.
1656 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1666 # The default value is: NO.
1667 # This tag requires that the tag GENERATE_HTML is set to YES.
1671 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1673 # value is set to YES, a side panel will be generated containing a tree-like
1674 # index structure (just like the one that is generated for HTML Help). For this
1675 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1683 # The default value is: NO.
1684 # This tag requires that the tag GENERATE_HTML is set to YES.
1689 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1694 # DISABLE_INDEX is set to NO, this option has no effect.
1695 # The default value is: NO.
1696 # This tag requires that the tag GENERATE_HTML is set to YES.
1706 # This tag requires that the tag GENERATE_HTML is set to YES.
1710 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1711 # to set the initial width (in pixels) of the frame in which the tree is shown.
1713 # This tag requires that the tag GENERATE_HTML is set to YES.
1717 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1719 # The default value is: NO.
1720 # This tag requires that the tag GENERATE_HTML is set to YES.
1724 # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1726 # The default value is: YES.
1727 # This tag requires that the tag GENERATE_HTML is set to YES.
1731 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1737 # The default value is: png.
1738 # This tag requires that the tag GENERATE_HTML is set to YES.
1747 # This tag requires that the tag GENERATE_HTML is set to YES.
1763 # The default value is: NO.
1764 # This tag requires that the tag GENERATE_HTML is set to YES.
1768 # With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1770 # regards to the different settings, so it is possible that also other MathJax
1774 # The default value is: MathJax_2.
1775 # This tag requires that the tag USE_MATHJAX is set to YES.
1779 # When MathJax is enabled you can set the default output format to be used for
1785 # Possible values are: HTML-CSS (which is slower, but has the best
1786 # compatibility. This is the name for Mathjax version 2, for MathJax version 3
1789 # is the name for Mathjax version 3, for MathJax version 2 this will be
1791 # The default value is: HTML-CSS.
1792 # This tag requires that the tag USE_MATHJAX is set to YES.
1796 # When MathJax is enabled you need to specify the location relative to the HTML
1799 # is located at the same level as the HTML output directory, then
1802 # MathJax. However, it is strongly recommended to install a local copy of
1803 # MathJax from https://www.mathjax.org before deployment. The default value is:
1806 # This tag requires that the tag USE_MATHJAX is set to YES.
1818 # This tag requires that the tag USE_MATHJAX is set to YES.
1827 # This tag requires that the tag USE_MATHJAX is set to YES.
1831 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1835 # there is already a search function so this one should typically be disabled.
1837 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1839 # (what the <access key> is depends on the OS and browser, but it is typically
1843 # the search. The filter options can be selected when the cursor is inside the
1847 # The default value is: YES.
1848 # This tag requires that the tag GENERATE_HTML is set to YES.
1852 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1856 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1859 # The default value is: NO.
1860 # This tag requires that the tag SEARCHENGINE is set to YES.
1864 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1876 # The default value is: NO.
1877 # This tag requires that the tag SEARCHENGINE is set to YES.
1882 # which will return the search results when EXTERNAL_SEARCH is enabled.
1889 # This tag requires that the tag SEARCHENGINE is set to YES.
1894 # search data is written to a file for indexing by an external tool. With the
1896 # The default file is: searchdata.xml.
1897 # This tag requires that the tag SEARCHENGINE is set to YES.
1902 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1905 # This tag requires that the tag SEARCHENGINE is set to YES.
1913 # to a relative location where the documentation can be found. The format is:
1915 # This tag requires that the tag SEARCHENGINE is set to YES.
1923 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1924 # The default value is: YES.
1928 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1929 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1931 # The default directory is: latex.
1932 # This tag requires that the tag GENERATE_LATEX is set to YES.
1939 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1940 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1941 # chosen this is overwritten by pdflatex. For specific output languages the
1944 # This tag requires that the tag GENERATE_LATEX is set to YES.
1950 # Note: This tag is used in the Makefile / make.bat.
1953 # The default file is: makeindex.
1954 # This tag requires that the tag GENERATE_LATEX is set to YES.
1959 # generate index for LaTeX. In case there is no backslash (\) as first character
1961 # Note: This tag is used in the generated output file (.tex).
1963 # The default value is: makeindex.
1964 # This tag requires that the tag GENERATE_LATEX is set to YES.
1968 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1971 # The default value is: NO.
1972 # This tag requires that the tag GENERATE_LATEX is set to YES.
1976 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1980 # The default value is: a4.
1981 # This tag requires that the tag GENERATE_LATEX is set to YES.
1993 # This tag requires that the tag GENERATE_LATEX is set to YES.
1999 # first chapter. If it is left blank doxygen will generate a standard header. It
2000 # is highly recommended to start with a default header using
2006 # Note: The header is subject to change so you typically have to regenerate the
2010 # This tag requires that the tag GENERATE_LATEX is set to YES.
2016 # last chapter. If it is left blank doxygen will generate a standard footer. See
2022 # This tag requires that the tag GENERATE_LATEX is set to YES.
2030 # Note: The order of the extra style sheet files is of importance (e.g. the last
2033 # This tag requires that the tag GENERATE_LATEX is set to YES.
2039 # directory. Note that the files will be copied as-is; there are no commands or
2041 # This tag requires that the tag GENERATE_LATEX is set to YES.
2045 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2049 # The default value is: YES.
2050 # This tag requires that the tag GENERATE_LATEX is set to YES.
2054 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
2059 # The default value is: YES.
2060 # This tag requires that the tag GENERATE_LATEX is set to YES.
2066 # mode nothing is printed on the terminal, errors are scrolled as if <return> is
2070 # but there is no possibility of user interaction just like in batch mode,
2072 # keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
2074 # The default value is: NO.
2075 # This tag requires that the tag GENERATE_LATEX is set to YES.
2079 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2081 # The default value is: NO.
2082 # This tag requires that the tag GENERATE_LATEX is set to YES.
2089 # The default value is: plain.
2090 # This tag requires that the tag GENERATE_LATEX is set to YES.
2094 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2095 # path from which the emoji images will be read. If a relative path is entered,
2098 # This tag requires that the tag GENERATE_LATEX is set to YES.
2106 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2107 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
2109 # The default value is: NO.
2113 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2114 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2116 # The default directory is: rtf.
2117 # This tag requires that the tag GENERATE_RTF is set to YES.
2121 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2124 # The default value is: NO.
2125 # This tag requires that the tag GENERATE_RTF is set to YES.
2129 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2136 # The default value is: NO.
2137 # This tag requires that the tag GENERATE_RTF is set to YES.
2141 # Load stylesheet definitions from file. Syntax is similar to doxygen's
2147 # This tag requires that the tag GENERATE_RTF is set to YES.
2151 # Set optional variables used in the generation of an RTF document. Syntax is
2154 # This tag requires that the tag GENERATE_RTF is set to YES.
2162 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2164 # The default value is: NO.
2168 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2169 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2172 # The default directory is: man.
2173 # This tag requires that the tag GENERATE_MAN is set to YES.
2177 # The MAN_EXTENSION tag determines the extension that is added to the generated
2179 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2181 # The default value is: .3.
2182 # This tag requires that the tag GENERATE_MAN is set to YES.
2189 # This tag requires that the tag GENERATE_MAN is set to YES.
2193 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2197 # The default value is: NO.
2198 # This tag requires that the tag GENERATE_MAN is set to YES.
2206 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2208 # The default value is: NO.
2212 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2213 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2215 # The default directory is: xml.
2216 # This tag requires that the tag GENERATE_XML is set to YES.
2220 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2224 # The default value is: YES.
2225 # This tag requires that the tag GENERATE_XML is set to YES.
2229 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2231 # The default value is: NO.
2232 # This tag requires that the tag GENERATE_XML is set to YES.
2240 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2242 # The default value is: NO.
2246 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2247 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2249 # The default directory is: docbook.
2250 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2258 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2261 # is still experimental and incomplete at the moment.
2262 # The default value is: NO.
2270 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2273 # Note that this feature is still experimental and incomplete at the moment.
2274 # The default value is: NO.
2278 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2281 # The default value is: NO.
2282 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2286 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2287 # formatted so it can be parsed by a human reader. This is useful if you want to
2288 # understand what is going on. On the other hand, if this tag is set to NO, the
2291 # The default value is: YES.
2292 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2297 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2300 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2308 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2310 # The default value is: YES.
2314 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2318 # The default value is: NO.
2319 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2324 # the macro expansion is limited to the macros specified with the PREDEFINED and
2326 # The default value is: NO.
2327 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2331 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2332 # INCLUDE_PATH will be searched if a #include is found.
2333 # The default value is: YES.
2334 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2340 # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2342 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2350 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2355 # defined before the preprocessor is started (similar to the -D option of e.g.
2356 # gcc). The argument of the tag is a list of macros of the form: name or
2358 # is assumed. To prevent a macro definition from being undefined via #undef or
2360 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2366 # macro definition that is found in the sources will be used. Use the PREDEFINED
2369 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2373 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2378 # The default value is: YES.
2379 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2389 # a tag file without this location is as follows:
2391 # Adding location for the tag files is done as follows:
2397 # the path). If a tag file is not located in the directory in which doxygen is
2402 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2403 # tag file that is based on the input files it reads. See section "Linking to
2408 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2411 # The default value is: NO.
2415 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2418 # The default value is: YES.
2422 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2425 # The default value is: YES.
2434 # and usage relations if the target is undocumented or is not a class.
2435 # The default value is: YES.
2439 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2440 # available from the path. This tool is part of Graphviz (see:
2442 # Bell Labs. The other options in this section have no effect if this option is
2444 # The default value is: NO.
2448 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2454 # This tag requires that the tag HAVE_DOT is set to YES.
2458 # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2462 # Edge and Graph Attributes specification</a> You need to make sure dot is able
2465 # directory containing the font. Default graphviz fontsize is 14.
2466 # The default value is: fontname=Helvetica,fontsize=10.
2467 # This tag requires that the tag HAVE_DOT is set to YES.
2471 # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2475 # The default value is: labelfontname=Helvetica,labelfontsize=10.
2476 # This tag requires that the tag HAVE_DOT is set to YES.
2480 # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2483 # The default value is: shape=box,height=0.2,width=0.4.
2484 # This tag requires that the tag HAVE_DOT is set to YES.
2490 # This tag requires that the tag HAVE_DOT is set to YES.
2494 # If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
2496 # inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
2497 # HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2498 # the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
2499 # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2500 # If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
2503 # The default value is: YES.
2507 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2511 # The default value is: YES.
2512 # This tag requires that the tag HAVE_DOT is set to YES.
2516 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2519 # The default value is: YES.
2520 # This tag requires that the tag HAVE_DOT is set to YES.
2524 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2527 # The default value is: NO.
2528 # This tag requires that the tag HAVE_DOT is set to YES.
2532 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2537 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2538 # but if the number exceeds 15, the total amount of fields shown is limited to
2541 # This tag requires that the tag UML_LOOK is set to YES.
2545 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2547 # tag is set to YES, doxygen will add type and arguments for attributes and
2548 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2553 # The default value is: NO.
2554 # This tag requires that the tag UML_LOOK is set to YES.
2563 # This tag requires that the tag HAVE_DOT is set to YES.
2567 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2570 # The default value is: NO.
2571 # This tag requires that the tag HAVE_DOT is set to YES.
2579 # The default value is: YES.
2580 # This tag requires that the tag HAVE_DOT is set to YES.
2588 # The default value is: YES.
2589 # This tag requires that the tag HAVE_DOT is set to YES.
2593 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2600 # The default value is: NO.
2601 # This tag requires that the tag HAVE_DOT is set to YES.
2605 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2612 # The default value is: NO.
2613 # This tag requires that the tag HAVE_DOT is set to YES.
2617 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2619 # The default value is: YES.
2620 # This tag requires that the tag HAVE_DOT is set to YES.
2624 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2628 # The default value is: YES.
2629 # This tag requires that the tag HAVE_DOT is set to YES.
2636 # This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2650 # The default value is: png.
2651 # This tag requires that the tag HAVE_DOT is set to YES.
2655 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2662 # The default value is: NO.
2663 # This tag requires that the tag HAVE_DOT is set to YES.
2668 # found. If left blank, it is assumed the dot tool can be found in the path.
2669 # This tag requires that the tag HAVE_DOT is set to YES.
2676 # This tag requires that the tag HAVE_DOT is set to YES.
2683 # If left empty dia is assumed to be found in the default search path.
2695 # to be used. If left blank, it is assumed PlantUML is not used or called during
2713 # larger than this value, doxygen will truncate the graph, which is visualized
2715 # children of the root node in a graph is already larger than
2719 # This tag requires that the tag HAVE_DOT is set to YES.
2731 # This tag requires that the tag HAVE_DOT is set to YES.
2738 # this, this feature is disabled by default.
2739 # The default value is: NO.
2740 # This tag requires that the tag HAVE_DOT is set to YES.
2744 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2748 # graphical representation for inheritance and collaboration diagrams is used.
2749 # The default value is: YES.
2750 # This tag requires that the tag HAVE_DOT is set to YES.
2754 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2757 # Note: This setting is not only used for dot files but also for msc temporary
2759 # The default value is: YES.
2764 # command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will