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.
57 PROJECT_BRIEF          = "libcbor is a C library for parsing and generating CBOR, the general-purpose schema-less binary data format."
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
280 # only. Doxygen will then generate output that is more tailored for C. For
283 # The default value is: NO.
288 # Python sources only. Doxygen will then generate output that is more tailored
291 # The default value is: NO.
296 # sources. Doxygen will then generate output that is tailored for Fortran.
297 # The default value is: NO.
302 # sources. Doxygen will then generate output that is tailored for VHDL.
303 # The default value is: NO.
308 # sources only. Doxygen will then generate output that is more tailored for that
311 # The default value is: NO.
318 # using this tag. The format is ext=language, where ext is a file extension, and
319 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
323 # tries to guess whether the code is fixed or free formatted code, this is the
325 # as Fortran files (default is PHP), and .f files as C (default is Fortran),
338 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
341 # The output of markdown processing is further processed by doxygen, so you can
344 # The default value is: YES.
348 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
353 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
361 # The default value is: YES.
371 # The default value is: NO.
377 # The default value is: NO.
384 # of private inheritance when no explicit protection keyword is present.
385 # The default value is: NO.
393 # type. If this is not the case, or you want to show the methods anyway, you
395 # The default value is: YES.
399 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
400 # tag is set to YES then doxygen will reuse the documentation of the first
403 # The default value is: NO.
407 # If one adds a struct or class to a group and this option is enabled, then also
408 # any nested class or struct is added to the same group. By default this option
409 # is disabled and one has to add nested compounds explicitly via \ingroup.
410 # The default value is: NO.
419 # The default value is: YES.
423 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
430 # The default value is: NO.
434 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
437 # namespace, or group documentation), provided this scope is documented. If set
440 # The default value is: NO.
444 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
445 # enum is documented as struct, union, or enum with the name of the typedef. So
450 # types are typedef'ed and only the typedef is referenced, never the tag name.
451 # The default value is: NO.
456 # cache is used to resolve symbols given their name and scope. Since this can be
458 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
459 # doxygen will become slower. If the cache is too large, memory is wasted. The
460 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
461 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
468 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
473 # threads. Since this is still an experimental feature the default is set to 1,
475 # encounter. Generating dot graphs in parallel is controlled by the
485 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
490 # normally produced when WARNINGS is set to YES.
491 # The default value is: NO.
495 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
497 # The default value is: NO.
501 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
503 # The default value is: NO.
507 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
509 # The default value is: NO.
513 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
515 # The default value is: NO.
519 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
523 # The default value is: YES.
527 # This flag is only useful for Objective-C code. If set to YES, local methods,
531 # The default value is: NO.
535 # If this flag is set to YES, the members of anonymous namespaces will be
540 # The default value is: NO.
544 # If this flag is set to YES, the name of an unnamed parameter in a declaration
547 # The default value is: YES.
551 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
554 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
555 # The default value is: NO.
559 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
563 # if EXTRACT_ALL is enabled.
564 # The default value is: NO.
568 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
571 # The default value is: NO.
575 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
578 # The default value is: NO.
582 # The INTERNAL_DOCS tag determines if documentation that is typed after a
583 # \internal command is included. If the tag is set to NO then the documentation
585 # The default value is: NO.
591 # filesystem is case sensitive (i.e. it supports files in the same directory
602 # The default value is: SYSTEM.
606 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
609 # The default value is: NO.
613 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
616 # The default value is: NO.
620 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
622 # The default value is: YES.
626 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
628 # The default value is: YES.
632 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
635 # The default value is: NO.
639 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
641 # The default value is: NO.
645 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
647 # The default value is: YES.
651 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
654 # The default value is: YES.
658 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
662 # The default value is: NO.
666 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
670 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
672 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
674 # The default value is: NO.
678 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
681 # The default value is: NO.
685 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
688 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
691 # The default value is: NO.
695 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
697 # the prototype and the implementation of a member function even if there is
698 # only one candidate or it is obvious which candidate to choose by doing a
701 # The default value is: NO.
706 # list. This list is created by putting \todo commands in the documentation.
707 # The default value is: YES.
712 # list. This list is created by putting \test commands in the documentation.
713 # The default value is: YES.
718 # list. This list is created by putting \bug commands in the documentation.
719 # The default value is: YES.
724 # the deprecated list. This list is created by putting \deprecated commands in
726 # The default value is: YES.
750 # The default value is: YES.
757 # The default value is: YES.
764 # The default value is: YES.
771 # popen()) the command command input-file, where command is the value of the
772 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
773 # by doxygen. Whatever the program writes to standard output is used as the file
788 # tag is left empty.
794 # extension is automatically appended if omitted. This requires the bibtex tool
807 # standard output by doxygen. If QUIET is set to YES this implies that the
809 # The default value is: NO.
814 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
818 # The default value is: YES.
822 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
823 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
825 # The default value is: YES.
829 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
833 # The default value is: YES.
837 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
840 # The default value is: YES.
847 # documentation, but not about the absence of documentation. If EXTRACT_ALL is
850 # The default value is: NO.
854 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
856 # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
858 # The default value is: NO.
862 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
863 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
864 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
867 # The default value is: NO.
878 # The default value is: $file:$line: $text.
882 # In the $text part of the WARN_FORMAT command it is possible that a reference
883 # to a more specific place is given. To make it easier to jump to this place
888 # The default value is: at line $line of file $file.
893 # messages should be written. If left blank the output is written to standard
895 # warning and error messages are written to standard error. When as file - is
905 # The INPUT tag is used to specify the files and/or directories that contain
909 # Note: If this tag is empty the current directory is searched.
920 # The default value is: UTF-8.
928 # INPUT_ENCODING) if there is a match. The character encodings are a list of the
956 # The default value is: NO.
962 # subdirectory from a directory tree whose root is specified with the INPUT tag.
964 # Note that relative paths are relative to the directory from which doxygen is
972 # The default value is: NO.
988 # wildcard * is used, a substring. Examples: ANamespace, AClass,
1009 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1012 # The default value is: NO.
1028 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1030 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1033 # Note that the filter must not add or remove lines; it is applied before the
1034 # code is scanned, but not when the output code is generated. If lines are added
1050 # filter if there is a match. The filters are a list of the form: pattern=filter
1052 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1053 # patterns match the file name, INPUT_FILTER is applied.
1061 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1063 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1064 # The default value is: NO.
1070 # it is also possible to disable source filtering for a specific pattern using
1072 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1077 # is part of the input, its contents will be placed on the main page
1085 # extension is to allow longer lines before the automatic comment starts. The
1096 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1100 # also VERBATIM_HEADERS is set to NO.
1101 # The default value is: NO.
1107 # The default value is: NO.
1114 # The default value is: YES.
1118 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1120 # The default value is: NO.
1124 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1126 # The default value is: NO.
1130 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1134 # The default value is: YES.
1138 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1143 # The default value is: YES.
1144 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1148 # If the USE_HTAGS tag is set to YES then the references to source code will
1150 # source browser. The htags tool is part of GNU's global source tagging system
1165 # The default value is: NO.
1166 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1170 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1171 # verbatim copy of the header file for each class for which an include is
1174 # The default value is: YES.
1182 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1185 # The default value is: YES.
1194 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1202 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1203 # The default value is: YES.
1207 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1208 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1210 # The default directory is: html.
1211 # This tag requires that the tag GENERATE_HTML is set to YES.
1217 # The default value is: .html.
1218 # This tag requires that the tag GENERATE_HTML is set to YES.
1223 # each generated HTML page. If the tag is left blank doxygen will generate a
1227 # that doxygen needs, which is dependent on the configuration options used (e.g.
1228 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1235 # Note: The header is subject to change so you typically have to regenerate the
1238 # This tag requires that the tag GENERATE_HTML is set to YES.
1243 # generated HTML page. If the tag is left blank doxygen will generate a standard
1248 # This tag requires that the tag GENERATE_HTML is set to YES.
1253 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1257 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1258 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1260 # This tag requires that the tag GENERATE_HTML is set to YES.
1267 # This is preferred over using HTML_STYLESHEET since it does not replace the
1268 # standard style sheet and is therefore more robust against future updates.
1270 # Note: The order of the extra style sheet files is of importance (e.g. the last
1276 # customization is desired it has to be added explicitly. For an example see the
1278 # This tag requires that the tag GENERATE_HTML is set to YES.
1287 # files will be copied as-is; there are no commands or markers available.
1288 # This tag requires that the tag GENERATE_HTML is set to YES.
1296 # the user preference, use light mode if no preference is set (the default),
1298 # dark mode if no preference is set and TOGGLE allow to user to switch between
1300 # The default value is: AUTO_LIGHT.
1301 # This tag requires that the tag GENERATE_HTML is set to YES.
1307 # this color. Hue is specified as an angle on a color-wheel, see
1309 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1310 # purple, and 360 is red again.
1312 # This tag requires that the tag GENERATE_HTML is set to YES.
1320 # This tag requires that the tag GENERATE_HTML is set to YES.
1327 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1331 # This tag requires that the tag GENERATE_HTML is set to YES.
1335 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1338 # documentation is up to date.
1339 # The default value is: NO.
1340 # This tag requires that the tag GENERATE_HTML is set to YES.
1344 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1350 # The default value is: YES.
1351 # This tag requires that the tag GENERATE_HTML is set to YES.
1355 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1358 # The default value is: NO.
1359 # This tag requires that the tag GENERATE_HTML is set to YES.
1368 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1372 # This tag requires that the tag GENERATE_HTML is set to YES.
1376 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1386 # The default value is: NO.
1387 # This tag requires that the tag GENERATE_HTML is set to YES.
1394 # The default value is: Doxygen generated docs.
1395 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1402 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1409 # The default value is: org.doxygen.Project.
1410 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1417 # The default value is: org.doxygen.Publisher.
1418 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1423 # The default value is: Publisher.
1424 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1428 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1430 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1445 # The default value is: NO.
1446 # This tag requires that the tag GENERATE_HTML is set to YES.
1453 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1461 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1465 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1467 # The default value is: NO.
1468 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1472 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1474 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1478 # The BINARY_TOC flag controls whether a binary table of contents is generated
1481 # The default value is: NO.
1482 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1488 # The default value is: NO.
1489 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1493 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1497 # The default value is: NO.
1498 # This tag requires that the tag GENERATE_HTML is set to YES.
1502 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1503 # the file name of the resulting .qch file. The path specified is relative to
1505 # This tag requires that the tag GENERATE_QHP is set to YES.
1513 # The default value is: org.doxygen.Project.
1514 # This tag requires that the tag GENERATE_QHP is set to YES.
1522 # The default value is: doc.
1523 # This tag requires that the tag GENERATE_QHP is set to YES.
1527 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1531 # This tag requires that the tag GENERATE_QHP is set to YES.
1539 # This tag requires that the tag GENERATE_QHP is set to YES.
1546 # This tag requires that the tag GENERATE_QHP is set to YES.
1553 # This tag requires that the tag GENERATE_QHP is set to YES.
1557 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1564 # The default value is: NO.
1565 # This tag requires that the tag GENERATE_HTML is set to YES.
1572 # The default value is: org.doxygen.Project.
1573 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1583 # The default value is: NO.
1584 # This tag requires that the tag GENERATE_HTML is set to YES.
1588 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1590 # value is set to YES, a side panel will be generated containing a tree-like
1591 # index structure (just like the one that is generated for HTML Help). For this
1592 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1600 # The default value is: NO.
1601 # This tag requires that the tag GENERATE_HTML is set to YES.
1606 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1611 # DISABLE_INDEX is set to NO, this option has no effect.
1612 # The default value is: NO.
1613 # This tag requires that the tag GENERATE_HTML is set to YES.
1623 # This tag requires that the tag GENERATE_HTML is set to YES.
1627 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1628 # to set the initial width (in pixels) of the frame in which the tree is shown.
1630 # This tag requires that the tag GENERATE_HTML is set to YES.
1634 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1636 # The default value is: NO.
1637 # This tag requires that the tag GENERATE_HTML is set to YES.
1641 # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1643 # The default value is: YES.
1644 # This tag requires that the tag GENERATE_HTML is set to YES.
1648 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1654 # The default value is: png.
1655 # This tag requires that the tag GENERATE_HTML is set to YES.
1664 # This tag requires that the tag GENERATE_HTML is set to YES.
1680 # The default value is: NO.
1681 # This tag requires that the tag GENERATE_HTML is set to YES.
1685 # With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1687 # regards to the different settings, so it is possible that also other MathJax
1691 # The default value is: MathJax_2.
1692 # This tag requires that the tag USE_MATHJAX is set to YES.
1696 # When MathJax is enabled you can set the default output format to be used for
1702 # Possible values are: HTML-CSS (which is slower, but has the best
1703 # compatibility. This is the name for Mathjax version 2, for MathJax version 3
1706 # is the name for Mathjax version 3, for MathJax version 2 this will be
1708 # The default value is: HTML-CSS.
1709 # This tag requires that the tag USE_MATHJAX is set to YES.
1713 # When MathJax is enabled you need to specify the location relative to the HTML
1716 # is located at the same level as the HTML output directory, then
1719 # MathJax. However, it is strongly recommended to install a local copy of
1720 # MathJax from https://www.mathjax.org before deployment. The default value is:
1723 # This tag requires that the tag USE_MATHJAX is set to YES.
1735 # This tag requires that the tag USE_MATHJAX is set to YES.
1744 # This tag requires that the tag USE_MATHJAX is set to YES.
1748 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1752 # there is already a search function so this one should typically be disabled.
1754 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1756 # (what the <access key> is depends on the OS and browser, but it is typically
1760 # the search. The filter options can be selected when the cursor is inside the
1764 # The default value is: YES.
1765 # This tag requires that the tag GENERATE_HTML is set to YES.
1769 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1773 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1776 # The default value is: NO.
1777 # This tag requires that the tag SEARCHENGINE is set to YES.
1781 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1793 # The default value is: NO.
1794 # This tag requires that the tag SEARCHENGINE is set to YES.
1799 # which will return the search results when EXTERNAL_SEARCH is enabled.
1806 # This tag requires that the tag SEARCHENGINE is set to YES.
1811 # search data is written to a file for indexing by an external tool. With the
1813 # The default file is: searchdata.xml.
1814 # This tag requires that the tag SEARCHENGINE is set to YES.
1819 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1822 # This tag requires that the tag SEARCHENGINE is set to YES.
1830 # to a relative location where the documentation can be found. The format is:
1832 # This tag requires that the tag SEARCHENGINE is set to YES.
1840 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1841 # The default value is: YES.
1845 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1846 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1848 # The default directory is: latex.
1849 # This tag requires that the tag GENERATE_LATEX is set to YES.
1856 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1857 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1858 # chosen this is overwritten by pdflatex. For specific output languages the
1861 # This tag requires that the tag GENERATE_LATEX is set to YES.
1867 # Note: This tag is used in the Makefile / make.bat.
1870 # The default file is: makeindex.
1871 # This tag requires that the tag GENERATE_LATEX is set to YES.
1876 # generate index for LaTeX. In case there is no backslash (\) as first character
1878 # Note: This tag is used in the generated output file (.tex).
1880 # The default value is: makeindex.
1881 # This tag requires that the tag GENERATE_LATEX is set to YES.
1885 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1888 # The default value is: NO.
1889 # This tag requires that the tag GENERATE_LATEX is set to YES.
1893 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1897 # The default value is: a4.
1898 # This tag requires that the tag GENERATE_LATEX is set to YES.
1910 # This tag requires that the tag GENERATE_LATEX is set to YES.
1916 # first chapter. If it is left blank doxygen will generate a standard header. It
1917 # is highly recommended to start with a default header using
1923 # Note: The header is subject to change so you typically have to regenerate the
1927 # This tag requires that the tag GENERATE_LATEX is set to YES.
1933 # last chapter. If it is left blank doxygen will generate a standard footer. See
1939 # This tag requires that the tag GENERATE_LATEX is set to YES.
1947 # Note: The order of the extra style sheet files is of importance (e.g. the last
1950 # This tag requires that the tag GENERATE_LATEX is set to YES.
1956 # directory. Note that the files will be copied as-is; there are no commands or
1958 # This tag requires that the tag GENERATE_LATEX is set to YES.
1962 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1966 # The default value is: YES.
1967 # This tag requires that the tag GENERATE_LATEX is set to YES.
1971 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1976 # The default value is: YES.
1977 # This tag requires that the tag GENERATE_LATEX is set to YES.
1981 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1984 # The default value is: NO.
1985 # This tag requires that the tag GENERATE_LATEX is set to YES.
1989 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1991 # The default value is: NO.
1992 # This tag requires that the tag GENERATE_LATEX is set to YES.
1999 # The default value is: plain.
2000 # This tag requires that the tag GENERATE_LATEX is set to YES.
2004 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
2007 # The default value is: NO.
2008 # This tag requires that the tag GENERATE_LATEX is set to YES.
2012 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2013 # path from which the emoji images will be read. If a relative path is entered,
2016 # This tag requires that the tag GENERATE_LATEX is set to YES.
2024 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2025 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
2027 # The default value is: NO.
2031 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2032 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2034 # The default directory is: rtf.
2035 # This tag requires that the tag GENERATE_RTF is set to YES.
2039 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2042 # The default value is: NO.
2043 # This tag requires that the tag GENERATE_RTF is set to YES.
2047 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2054 # The default value is: NO.
2055 # This tag requires that the tag GENERATE_RTF is set to YES.
2059 # Load stylesheet definitions from file. Syntax is similar to doxygen's
2065 # This tag requires that the tag GENERATE_RTF is set to YES.
2069 # Set optional variables used in the generation of an RTF document. Syntax is
2072 # This tag requires that the tag GENERATE_RTF is set to YES.
2080 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2082 # The default value is: NO.
2086 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2087 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2090 # The default directory is: man.
2091 # This tag requires that the tag GENERATE_MAN is set to YES.
2095 # The MAN_EXTENSION tag determines the extension that is added to the generated
2097 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2099 # The default value is: .3.
2100 # This tag requires that the tag GENERATE_MAN is set to YES.
2107 # This tag requires that the tag GENERATE_MAN is set to YES.
2111 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2115 # The default value is: NO.
2116 # This tag requires that the tag GENERATE_MAN is set to YES.
2124 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2126 # The default value is: NO.
2130 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2131 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2133 # The default directory is: xml.
2134 # This tag requires that the tag GENERATE_XML is set to YES.
2138 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2142 # The default value is: YES.
2143 # This tag requires that the tag GENERATE_XML is set to YES.
2147 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2149 # The default value is: NO.
2150 # This tag requires that the tag GENERATE_XML is set to YES.
2158 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2160 # The default value is: NO.
2164 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2165 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2167 # The default directory is: docbook.
2168 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2176 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2179 # is still experimental and incomplete at the moment.
2180 # The default value is: NO.
2188 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2191 # Note that this feature is still experimental and incomplete at the moment.
2192 # The default value is: NO.
2196 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2199 # The default value is: NO.
2200 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2204 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2205 # formatted so it can be parsed by a human reader. This is useful if you want to
2206 # understand what is going on. On the other hand, if this tag is set to NO, the
2209 # The default value is: YES.
2210 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2215 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2218 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2226 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2228 # The default value is: YES.
2232 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2236 # The default value is: NO.
2237 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2242 # the macro expansion is limited to the macros specified with the PREDEFINED and
2244 # The default value is: NO.
2245 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2249 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2250 # INCLUDE_PATH will be searched if a #include is found.
2251 # The default value is: YES.
2252 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2258 # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2260 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2268 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2273 # defined before the preprocessor is started (similar to the -D option of e.g.
2274 # gcc). The argument of the tag is a list of macros of the form: name or
2276 # is assumed. To prevent a macro definition from being undefined via #undef or
2278 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2286 # macro definition that is found in the sources will be used. Use the PREDEFINED
2289 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2293 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2298 # The default value is: YES.
2299 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2309 # a tag file without this location is as follows:
2311 # Adding location for the tag files is done as follows:
2317 # the path). If a tag file is not located in the directory in which doxygen is
2322 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2323 # tag file that is based on the input files it reads. See section "Linking to
2328 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2331 # The default value is: NO.
2335 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2338 # The default value is: YES.
2342 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2345 # The default value is: YES.
2356 # If left empty dia is assumed to be found in the default search path.
2361 # and usage relations if the target is undocumented or is not a class.
2362 # The default value is: YES.
2366 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2367 # available from the path. This tool is part of Graphviz (see:
2369 # Bell Labs. The other options in this section have no effect if this option is
2371 # The default value is: NO.
2375 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2381 # This tag requires that the tag HAVE_DOT is set to YES.
2385 # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2389 # Edge and Graph Attributes specification</a> You need to make sure dot is able
2392 # directory containing the font. Default graphviz fontsize is 14.
2393 # The default value is: fontname=Helvetica,fontsize=10.
2394 # This tag requires that the tag HAVE_DOT is set to YES.
2398 # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2402 # The default value is: labelfontname=Helvetica,labelfontsize=10.
2403 # This tag requires that the tag HAVE_DOT is set to YES.
2407 # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2410 # The default value is: shape=box,height=0.2,width=0.4.
2411 # This tag requires that the tag HAVE_DOT is set to YES.
2417 # This tag requires that the tag HAVE_DOT is set to YES.
2421 # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
2423 # relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
2424 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
2428 # The default value is: YES.
2432 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2436 # The default value is: YES.
2437 # This tag requires that the tag HAVE_DOT is set to YES.
2441 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2444 # The default value is: YES.
2445 # This tag requires that the tag HAVE_DOT is set to YES.
2449 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2452 # The default value is: NO.
2453 # This tag requires that the tag HAVE_DOT is set to YES.
2457 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2462 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2463 # but if the number exceeds 15, the total amount of fields shown is limited to
2466 # This tag requires that the tag UML_LOOK is set to YES.
2470 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2472 # tag is set to YES, doxygen will add type and arguments for attributes and
2473 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2478 # The default value is: NO.
2479 # This tag requires that the tag UML_LOOK is set to YES.
2488 # This tag requires that the tag HAVE_DOT is set to YES.
2492 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2495 # The default value is: NO.
2496 # This tag requires that the tag HAVE_DOT is set to YES.
2504 # The default value is: YES.
2505 # This tag requires that the tag HAVE_DOT is set to YES.
2513 # The default value is: YES.
2514 # This tag requires that the tag HAVE_DOT is set to YES.
2518 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2525 # The default value is: NO.
2526 # This tag requires that the tag HAVE_DOT is set to YES.
2530 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2537 # The default value is: NO.
2538 # This tag requires that the tag HAVE_DOT is set to YES.
2542 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2544 # The default value is: YES.
2545 # This tag requires that the tag HAVE_DOT is set to YES.
2549 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2553 # The default value is: YES.
2554 # This tag requires that the tag HAVE_DOT is set to YES.
2561 # This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2575 # The default value is: png.
2576 # This tag requires that the tag HAVE_DOT is set to YES.
2580 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2587 # The default value is: NO.
2588 # This tag requires that the tag HAVE_DOT is set to YES.
2593 # found. If left blank, it is assumed the dot tool can be found in the path.
2594 # This tag requires that the tag HAVE_DOT is set to YES.
2601 # This tag requires that the tag HAVE_DOT is set to YES.
2619 # to be used. If left blank, it is assumed PlantUML is not used or called during
2637 # larger than this value, doxygen will truncate the graph, which is visualized
2639 # children of the root node in a graph is already larger than
2643 # This tag requires that the tag HAVE_DOT is set to YES.
2655 # This tag requires that the tag HAVE_DOT is set to YES.
2662 # this, this feature is disabled by default.
2663 # The default value is: NO.
2664 # This tag requires that the tag HAVE_DOT is set to YES.
2668 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2672 # graphical representation for inheritance and collaboration diagrams is used.
2673 # The default value is: YES.
2674 # This tag requires that the tag HAVE_DOT is set to YES.
2678 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2681 # Note: This setting is not only used for dot files but also for msc temporary
2683 # The default value is: YES.