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                          is \
156 # doxygen will generate a detailed section even if there is only a brief
158 # The default value is: NO.
162 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
166 # The default value is: NO.
170 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
173 # The default value is: YES.
178 # Stripping is only done if one of the specified strings matches the left-hand
180 # If left blank the directory from which doxygen is run is used as the path to
184 # will be relative from the directory where doxygen is started.
185 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
192 # the header file containing the class definition is used. Otherwise one should
198 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
199 # less readable) file names. This can be useful is your file systems doesn't
201 # The default value is: NO.
205 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
210 # The default value is: NO.
214 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
220 # The default value is: NO.
224 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
228 # The default value is: NO.
234 # a brief description. This used to be the default behavior. The new default is
240 # The default value is: NO.
247 # documentation blocks is shown as doxygen documentation.
248 # The default value is: YES.
252 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
254 # The default value is: YES.
258 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
261 # The default value is: NO.
283 # with the commands \{ and \} for these it is advised to use the version @{ and
289 # only. Doxygen will then generate output that is more tailored for C. For
292 # The default value is: NO.
297 # Python sources only. Doxygen will then generate output that is more tailored
300 # The default value is: NO.
305 # sources. Doxygen will then generate output that is tailored for Fortran.
306 # The default value is: NO.
311 # sources. Doxygen will then generate output that is tailored for VHDL.
312 # The default value is: NO.
317 # sources only. Doxygen will then generate output that is more tailored for that
320 # The default value is: NO.
327 # using this tag. The format is ext=language, where ext is a file extension, and
328 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
332 # tries to guess whether the code is fixed or free formatted code, this is the
334 # as Fortran files (default is PHP), and .f files as C (default is Fortran),
347 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
350 # The output of markdown processing is further processed by doxygen, so you can
353 # The default value is: YES.
357 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
362 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
370 # The default value is: YES.
380 # The default value is: NO.
386 # The default value is: NO.
393 # of private inheritance when no explicit protection keyword is present.
394 # The default value is: NO.
402 # type. If this is not the case, or you want to show the methods anyway, you
404 # The default value is: YES.
408 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
409 # tag is set to YES then doxygen will reuse the documentation of the first
412 # The default value is: NO.
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.
419 # The default value is: NO.
428 # The default value is: YES.
432 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
439 # The default value is: NO.
443 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
446 # namespace, or group documentation), provided this scope is documented. If set
449 # The default value is: NO.
453 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
454 # enum is documented as struct, union, or enum with the name of the typedef. So
459 # types are typedef'ed and only the typedef is referenced, never the tag name.
460 # The default value is: NO.
465 # cache is used to resolve symbols given their name and scope. Since this can be
467 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
468 # doxygen will become slower. If the cache is too large, memory is wasted. The
469 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
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
482 # threads. Since this is still an experimental feature the default is set to 1,
484 # encounter. Generating dot graphs in parallel is controlled by the
494 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
499 # normally produced when WARNINGS is set to YES.
500 # The default value is: NO.
504 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
506 # The default value is: NO.
510 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
512 # The default value is: NO.
516 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
518 # The default value is: NO.
522 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
524 # The default value is: NO.
528 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
532 # The default value is: YES.
536 # This flag is only useful for Objective-C code. If set to YES, local methods,
540 # The default value is: NO.
544 # If this flag is set to YES, the members of anonymous namespaces will be
549 # The default value is: NO.
553 # If this flag is set to YES, the name of an unnamed parameter in a declaration
556 # The default value is: YES.
560 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
563 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
564 # The default value is: NO.
568 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
572 # if EXTRACT_ALL is enabled.
573 # The default value is: NO.
577 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
580 # The default value is: NO.
584 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
587 # The default value is: NO.
591 # The INTERNAL_DOCS tag determines if documentation that is typed after a
592 # \internal command is included. If the tag is set to NO then the documentation
594 # The default value is: NO.
600 # filesystem is case sensitive (i.e. it supports files in the same directory
611 # The default value is: SYSTEM.
615 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
618 # The default value is: NO.
622 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
625 # The default value is: NO.
629 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
631 # The default value is: YES.
635 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
637 # The default value is: YES.
641 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
644 # The default value is: NO.
648 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
650 # The default value is: NO.
654 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
656 # The default value is: YES.
660 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
663 # The default value is: YES.
667 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
671 # The default value is: NO.
675 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort 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
683 # The default value is: NO.
687 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
690 # The default value is: NO.
694 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
697 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
700 # The default value is: NO.
704 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
706 # the prototype and the implementation of a member function even if there is
707 # only one candidate or it is obvious which candidate to choose by doing a
710 # The default value is: NO.
715 # list. This list is created by putting \todo commands in the documentation.
716 # The default value is: YES.
721 # list. This list is created by putting \test commands in the documentation.
722 # The default value is: YES.
727 # list. This list is created by putting \bug commands in the documentation.
728 # The default value is: YES.
733 # the deprecated list. This list is created by putting \deprecated commands in
735 # The default value is: YES.
759 # The default value is: YES.
766 # The default value is: YES.
773 # The default value is: YES.
780 # popen()) the command command input-file, where command is the value of the
781 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
782 # by doxygen. Whatever the program writes to standard output is used as the file
797 # tag is left empty.
803 # extension is automatically appended if omitted. This requires the bibtex tool
816 # standard output by doxygen. If QUIET is set to YES this implies that the
818 # The default value is: NO.
823 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
827 # The default value is: 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
834 # The default value is: YES.
838 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
842 # The default value is: YES.
846 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
849 # The default value is: YES.
856 # documentation, but not about the absence of documentation. If EXTRACT_ALL is
859 # The default value is: NO.
863 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
865 # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
867 # The default value is: NO.
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
876 # The default value is: NO.
887 # The default value is: $file:$line: $text.
891 # In the $text part of the WARN_FORMAT command it is possible that a reference
892 # to a more specific place is given. To make it easier to jump to this place
897 # The default value is: at line $line of file $file.
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
914 # The INPUT tag is used to specify the files and/or directories that contain
918 # Note: If this tag is empty the current directory is searched.
928 # The default value is: UTF-8.
936 # INPUT_ENCODING) if there is a match. The character encodings are a list of the
1009 # The default value is: NO.
1015 # subdirectory from a directory tree whose root is specified with the INPUT tag.
1017 # Note that relative paths are relative to the directory from which doxygen is
1025 # The default value is: NO.
1041 # wildcard * is used, a substring. Examples: ANamespace, AClass,
1062 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1065 # The default value is: NO.
1081 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1083 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1086 # Note that the filter must not add or remove lines; it is applied before the
1087 # code is scanned, but not when the output code is generated. If lines are added
1103 # filter if there is a match. The filters are a list of the form: pattern=filter
1105 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1106 # patterns match the file name, INPUT_FILTER is applied.
1114 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1116 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1117 # The default value is: NO.
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.
1130 # is part of the input, its contents will be placed on the main page
1138 # extension is to allow longer lines before the automatic comment starts. The
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.
1154 # The default value is: NO.
1160 # The default value is: NO.
1167 # The default value is: YES.
1171 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1173 # The default value is: NO.
1177 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1179 # The default value is: NO.
1183 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1187 # The default value is: YES.
1191 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1196 # The default value is: YES.
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
1203 # source browser. The htags tool is part of GNU's global source tagging system
1218 # The default value is: NO.
1219 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1223 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1224 # verbatim copy of the header file for each class for which an include is
1227 # The default value is: YES.
1235 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1238 # The default value is: YES.
1247 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1255 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1256 # The default value is: YES.
1260 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1261 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1263 # The default directory is: html.
1264 # This tag requires that the tag GENERATE_HTML is set to YES.
1270 # The default value is: .html.
1271 # This tag requires that the tag GENERATE_HTML is set to YES.
1276 # each generated HTML page. If the tag is left blank doxygen will generate a
1280 # that doxygen needs, which is dependent on the configuration options used (e.g.
1281 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1288 # Note: The header is subject to change so you typically have to regenerate the
1291 # This tag requires that the tag GENERATE_HTML is set to YES.
1296 # generated HTML page. If the tag is left blank doxygen will generate a standard
1301 # This tag requires that the tag GENERATE_HTML is set to YES.
1306 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1310 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1311 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1313 # This tag requires that the tag GENERATE_HTML is set to YES.
1320 # This is preferred over using HTML_STYLESHEET since it does not replace the
1321 # standard style sheet and is therefore more robust against future updates.
1323 # Note: The order of the extra style sheet files is of importance (e.g. the last
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.
1340 # files will be copied as-is; there are no commands or markers available.
1341 # This tag requires that the tag GENERATE_HTML is set to YES.
1349 # the user preference, use light mode if no preference is set (the default),
1351 # dark mode if no preference is set and TOGGLE allow to user to switch between
1353 # The default value is: AUTO_LIGHT.
1354 # This tag requires that the tag GENERATE_HTML is set to YES.
1360 # this color. Hue is specified as an angle on a color-wheel, see
1362 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1363 # purple, and 360 is red again.
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.
1380 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
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
1391 # documentation is up to date.
1392 # The default value is: NO.
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
1403 # The default value is: YES.
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
1411 # The default value is: NO.
1412 # This tag requires that the tag GENERATE_HTML is set to YES.
1421 # entries 1 will produce a full collapsed tree by default. 0 is a special value
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
1439 # The default value is: NO.
1440 # This tag requires that the tag GENERATE_HTML is set to YES.
1447 # The default value is: Doxygen generated docs.
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.
1462 # The default value is: org.doxygen.Project.
1463 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1470 # The default value is: org.doxygen.Publisher.
1471 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1476 # The default value is: Publisher.
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
1483 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1498 # The default value is: NO.
1499 # This tag requires that the tag GENERATE_HTML is set to YES.
1506 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1514 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1518 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1520 # The default value is: NO.
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.
1531 # The BINARY_TOC flag controls whether a binary table of contents is generated
1534 # The default value is: NO.
1535 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1541 # The default value is: NO.
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
1550 # The default value is: NO.
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.
1566 # The default value is: org.doxygen.Project.
1567 # This tag requires that the tag GENERATE_QHP is set to YES.
1575 # The default value is: doc.
1576 # This tag requires that the tag GENERATE_QHP is set to YES.
1580 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1584 # This tag requires that the tag GENERATE_QHP is set to YES.
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.
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
1617 # The default value is: NO.
1618 # This tag requires that the tag GENERATE_HTML is set to YES.
1625 # The default value is: org.doxygen.Project.
1626 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1636 # The default value is: NO.
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
1643 # value is set to YES, a side panel will be generated containing a tree-like
1644 # index structure (just like the one that is generated for HTML Help). For this
1645 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1653 # The default value is: NO.
1654 # This tag requires that the tag GENERATE_HTML is set to YES.
1659 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1664 # DISABLE_INDEX is set to NO, this option has no effect.
1665 # The default value is: NO.
1666 # This tag requires that the tag GENERATE_HTML is set to YES.
1676 # This tag requires that the tag GENERATE_HTML is set to YES.
1680 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
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
1689 # The default value is: NO.
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
1696 # The default value is: YES.
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
1707 # The default value is: png.
1708 # This tag requires that the tag GENERATE_HTML is set to YES.
1717 # This tag requires that the tag GENERATE_HTML is set to YES.
1733 # The default value is: NO.
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
1744 # The default value is: MathJax_2.
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
1755 # Possible values are: HTML-CSS (which is slower, but has the best
1756 # compatibility. This is the name for Mathjax version 2, for MathJax version 3
1759 # is the name for Mathjax version 3, for MathJax version 2 this will be
1761 # The default value is: HTML-CSS.
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
1769 # is located at the same level as the HTML output directory, then
1772 # MathJax. However, it is strongly recommended to install a local copy of
1773 # MathJax from https://www.mathjax.org before deployment. The default value is:
1776 # This tag requires that the tag USE_MATHJAX is set to YES.
1788 # This tag requires that the tag USE_MATHJAX is set to YES.
1797 # This tag requires that the tag USE_MATHJAX is set to YES.
1801 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1805 # there is already a search function so this one should typically be disabled.
1807 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1809 # (what the <access key> is depends on the OS and browser, but it is typically
1813 # the search. The filter options can be selected when the cursor is inside the
1817 # The default value is: YES.
1818 # This tag requires that the tag GENERATE_HTML is set to YES.
1822 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1826 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1829 # The default value is: NO.
1830 # This tag requires that the tag SEARCHENGINE is set to YES.
1834 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1846 # The default value is: NO.
1847 # This tag requires that the tag SEARCHENGINE is set to YES.
1852 # which will return the search results when EXTERNAL_SEARCH is enabled.
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
1866 # The default file is: searchdata.xml.
1867 # This tag requires that the tag SEARCHENGINE is set to YES.
1872 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1875 # This tag requires that the tag SEARCHENGINE is set to YES.
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.
1893 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1894 # The default value is: YES.
1898 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1899 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1901 # The default directory is: latex.
1902 # This tag requires that the tag GENERATE_LATEX is set to YES.
1909 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1910 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1911 # chosen this is overwritten by pdflatex. For specific output languages the
1914 # This tag requires that the tag GENERATE_LATEX is set to YES.
1920 # Note: This tag is used in the Makefile / make.bat.
1923 # The default file is: makeindex.
1924 # This tag requires that the tag GENERATE_LATEX is set to YES.
1929 # generate index for LaTeX. In case there is no backslash (\) as first character
1931 # Note: This tag is used in the generated output file (.tex).
1933 # The default value is: makeindex.
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
1941 # The default value is: NO.
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
1950 # The default value is: a4.
1951 # This tag requires that the tag GENERATE_LATEX is set to YES.
1963 # This tag requires that the tag GENERATE_LATEX is set to YES.
1969 # first chapter. If it is left blank doxygen will generate a standard header. It
1970 # is highly recommended to start with a default header using
1976 # Note: The header is subject to change so you typically have to regenerate the
1980 # This tag requires that the tag GENERATE_LATEX is set to YES.
1986 # last chapter. If it is left blank doxygen will generate a standard footer. See
1992 # This tag requires that the tag GENERATE_LATEX is set to YES.
2000 # Note: The order of the extra style sheet files is of importance (e.g. the last
2003 # This tag requires that the tag GENERATE_LATEX is set to YES.
2009 # directory. Note that the files will be copied as-is; there are no commands or
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
2019 # The default value is: YES.
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
2029 # The default value is: YES.
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
2037 # The default value is: NO.
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
2044 # The default value is: NO.
2045 # This tag requires that the tag GENERATE_LATEX is set to YES.
2052 # The default value is: plain.
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
2060 # The default value is: NO.
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)
2066 # path from which the emoji images will be read. If a relative path is entered,
2069 # This tag requires that the tag GENERATE_LATEX is set to YES.
2077 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2078 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
2080 # The default value is: NO.
2084 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2085 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2087 # The default directory is: rtf.
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
2095 # The default value is: NO.
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
2107 # The default value is: NO.
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
2118 # This tag requires that the tag GENERATE_RTF is set to YES.
2122 # Set optional variables used in the generation of an RTF document. Syntax is
2125 # This tag requires that the tag GENERATE_RTF is set to YES.
2133 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2135 # The default value is: NO.
2139 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2140 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2143 # The default directory is: man.
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
2150 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2152 # The default value is: .3.
2153 # This tag requires that the tag GENERATE_MAN is set to YES.
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
2168 # The default value is: NO.
2169 # This tag requires that the tag GENERATE_MAN is set to YES.
2177 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2179 # The default value is: NO.
2183 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2184 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2186 # The default directory is: xml.
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
2195 # The default value is: YES.
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
2202 # The default value is: NO.
2203 # This tag requires that the tag GENERATE_XML is set to YES.
2211 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2213 # The default value is: NO.
2217 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2218 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2220 # The default directory is: docbook.
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
2232 # is still experimental and incomplete at the moment.
2233 # The default value is: NO.
2241 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2244 # Note that this feature is still experimental and incomplete at the moment.
2245 # The default value is: NO.
2249 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2252 # The default value is: NO.
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
2262 # The default value is: YES.
2263 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2268 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2271 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2279 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2281 # The default value is: YES.
2285 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2289 # The default value is: NO.
2290 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2295 # the macro expansion is limited to the macros specified with the PREDEFINED and
2297 # The default value is: NO.
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
2303 # INCLUDE_PATH will be searched if a #include is found.
2304 # The default value is: YES.
2305 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2311 # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2313 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2321 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2326 # defined before the preprocessor is started (similar to the -D option of e.g.
2327 # gcc). The argument of the tag is a list of macros of the form: name or
2329 # is assumed. To prevent a macro definition from being undefined via #undef or
2331 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2337 # macro definition that is found in the sources will be used. Use the PREDEFINED
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
2349 # The default value is: YES.
2350 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2360 # a tag file without this location is as follows:
2362 # Adding location for the tag files is done as follows:
2368 # the path). If a tag file is not located in the directory in which doxygen is
2373 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
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
2382 # The default value is: NO.
2386 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2389 # The default value is: YES.
2393 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2396 # The default value is: YES.
2407 # If left empty dia is assumed to be found in the default search path.
2412 # and usage relations if the target is undocumented or is not a class.
2413 # The default value is: YES.
2417 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2418 # available from the path. This tool is part of Graphviz (see:
2420 # Bell Labs. The other options in this section have no effect if this option is
2422 # The default value is: NO.
2426 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2432 # This tag requires that the tag HAVE_DOT is set to YES.
2436 # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2440 # Edge and Graph Attributes specification</a> You need to make sure dot is able
2443 # directory containing the font. Default graphviz fontsize is 14.
2444 # The default value is: fontname=Helvetica,fontsize=10.
2445 # This tag requires that the tag HAVE_DOT is set to YES.
2449 # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2453 # The default value is: labelfontname=Helvetica,labelfontsize=10.
2454 # This tag requires that the tag HAVE_DOT is set to YES.
2458 # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2461 # The default value is: shape=box,height=0.2,width=0.4.
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,
2475 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
2479 # The default value is: YES.
2483 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2487 # The default value is: YES.
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
2495 # The default value is: YES.
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
2503 # The default value is: NO.
2504 # This tag requires that the tag HAVE_DOT is set to YES.
2508 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
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
2529 # The default value is: NO.
2530 # This tag requires that the tag UML_LOOK is set to YES.
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
2546 # The default value is: NO.
2547 # This tag requires that the tag HAVE_DOT is set to YES.
2555 # The default value is: YES.
2556 # This tag requires that the tag HAVE_DOT is set to YES.
2564 # The default value is: YES.
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
2576 # The default value is: NO.
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
2588 # The default value is: NO.
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
2595 # The default value is: YES.
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
2604 # The default value is: YES.
2605 # This tag requires that the tag HAVE_DOT is set to YES.
2612 # This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2626 # The default value is: png.
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
2638 # The default value is: NO.
2639 # This tag requires that the tag HAVE_DOT is set to YES.
2644 # found. If left blank, it is assumed the dot tool can be found in the path.
2645 # This tag requires that the tag HAVE_DOT is set to YES.
2652 # This tag requires that the tag HAVE_DOT is set to YES.
2670 # to be used. If left blank, it is assumed PlantUML is not used or called during
2688 # larger than this value, doxygen will truncate the graph, which is visualized
2690 # children of the root node in a graph is already larger than
2694 # This tag requires that the tag HAVE_DOT is set to YES.
2706 # This tag requires that the tag HAVE_DOT is set to YES.
2713 # this, this feature is disabled by default.
2714 # The default value is: NO.
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
2723 # graphical representation for inheritance and collaboration diagrams is used.
2724 # The default value is: YES.
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
2732 # Note: This setting is not only used for dot files but also for msc temporary
2734 # The default value is: YES.