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 # With the PROJECT_ICON tag one can specify an icon that is included in the tabs
67 # when the HTML document is shown. Doxygen will copy the logo to the output
72 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
73 # into which the generated documentation will be written. If a relative path is
79 # If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096
86 # The default value is: NO.
91 # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
93 # directories at level 8 which is the default and also the maximum value. The
97 # This tag requires that the tag CREATE_SUBDIRS is set to YES.
101 # If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII
105 # The default value is: NO.
109 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
110 # documentation generated by Doxygen is written. Doxygen will use this
120 # The default value is: English.
124 # If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member
127 # The default value is: YES.
131 # If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief
136 # The default value is: YES.
140 # This tag implements a quasi-intelligent brief description abbreviator that is
143 # and the result, after processing the whole list, is used as the annotated
144 # text. Otherwise, the brief description is used as-is. If left blank, the
145 # following values are used ($name is automatically replaced with the name of
146 # the entity):The $name class, The $name widget, The $name file, is, provides,
152 # Doxygen will generate a detailed section even if there is only a brief
154 # The default value is: NO.
158 # If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all
162 # The default value is: NO.
166 # If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path
169 # The default value is: YES.
174 # Stripping is only done if one of the specified strings matches the left-hand
176 # If left blank the directory from which Doxygen is run is used as the path to
180 # will be relative from the directory where Doxygen is started.
181 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
188 # the header file containing the class definition is used. Otherwise one should
194 # If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but
195 # less readable) file names. This can be useful is your file systems doesn't
197 # The default value is: NO.
201 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the
206 # The default value is: NO.
210 # If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line
216 # The default value is: NO.
220 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first
224 # The default value is: NO.
230 # a brief description. This used to be the default behavior. The new default is
236 # The default value is: NO.
243 # documentation blocks is shown as Doxygen documentation.
244 # The default value is: YES.
248 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
250 # The default value is: YES.
254 # If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new
257 # The default value is: NO.
279 # with the commands \{ and \} for these it is advised to use the version @{ and
286 …kconfig_dep{1}=\attention Available only when the following Kconfig option is enabled: \kconfig{\1…
300 # only. Doxygen will then generate output that is more tailored for C. For
303 # The default value is: NO.
308 # Python sources only. Doxygen will then generate output that is more tailored
311 # The default value is: NO.
316 # sources. Doxygen will then generate output that is tailored for Fortran.
317 # The default value is: NO.
322 # sources. Doxygen will then generate output that is tailored for VHDL.
323 # The default value is: NO.
328 # sources only. Doxygen will then generate output that is more tailored for that
331 # The default value is: NO.
338 # using this tag. The format is ext=language, where ext is a file extension, and
339 # language is one of the parsers supported by Doxygen: IDL, Java, JavaScript,
343 # tries to guess whether the code is fixed or free formatted code, this is the
345 # as Fortran files (default is PHP), and .f files as C (default is Fortran),
358 # If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments
361 # The output of markdown processing is further processed by Doxygen, so you can
364 # The default value is: YES.
368 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
373 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
378 # generate identifiers for the Markdown headings. Note: Every identifier is
383 # The default value is: DOXYGEN.
384 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
392 # The default value is: YES.
402 # The default value is: NO.
408 # The default value is: NO.
415 # inheritance when no explicit protection keyword is present.
416 # The default value is: NO.
424 # type. If this is not the case, or you want to show the methods anyway, you
426 # The default value is: YES.
430 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
431 # tag is set to YES then Doxygen will reuse the documentation of the first
434 # The default value is: NO.
438 # If one adds a struct or class to a group and this option is enabled, then also
439 # any nested class or struct is added to the same group. By default this option
440 # is disabled and one has to add nested compounds explicitly via \ingroup.
441 # The default value is: NO.
450 # The default value is: YES.
454 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
461 # The default value is: NO.
465 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
468 # namespace, or group documentation), provided this scope is documented. If set
471 # The default value is: NO.
475 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
476 # enum is documented as struct, union, or enum with the name of the typedef. So
481 # types are typedef'ed and only the typedef is referenced, never the tag name.
482 # The default value is: NO.
487 # cache is used to resolve symbols given their name and scope. Since this can be
489 # code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small
490 # Doxygen will become slower. If the cache is too large, memory is wasted. The
491 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
492 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
499 # The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use
504 # threads. Since this is still an experimental feature the default is set to 1,
506 # encounter. Generating dot graphs in parallel is controlled by the
512 # If the TIMESTAMP tag is set different from NO then each generated page will
516 # The default value is: NO.
524 # If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in
529 # normally produced when WARNINGS is set to YES.
530 # The default value is: NO.
534 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
536 # The default value is: NO.
540 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
542 # The default value is: NO.
546 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
548 # The default value is: NO.
552 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
554 # The default value is: NO.
558 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
562 # The default value is: YES.
566 # This flag is only useful for Objective-C code. If set to YES, local methods,
570 # The default value is: NO.
574 # If this flag is set to YES, the members of anonymous namespaces will be
579 # The default value is: NO.
583 # If this flag is set to YES, the name of an unnamed parameter in a declaration
586 # The default value is: YES.
590 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
593 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
594 # The default value is: NO.
598 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
602 # if EXTRACT_ALL is enabled.
603 # The default value is: NO.
607 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend
610 # The default value is: NO.
614 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
617 # The default value is: NO.
621 # The INTERNAL_DOCS tag determines if documentation that is typed after a
622 # \internal command is included. If the tag is set to NO then the documentation
624 # The default value is: NO.
630 # filesystem is case sensitive (i.e. it supports files in the same directory
641 # The default value is: SYSTEM.
645 # If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with
648 # The default value is: NO.
652 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will
655 # The default value is: NO.
659 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
661 # The default value is: YES.
665 # If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of
667 # The default value is: YES.
671 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
674 # The default value is: NO.
678 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include
680 # The default value is: NO.
684 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
686 # The default value is: YES.
690 # If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the
693 # The default value is: YES.
697 # If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief
701 # The default value is: NO.
705 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the
709 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
711 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
713 # The default value is: NO.
717 # If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy
720 # The default value is: NO.
724 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
727 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
730 # The default value is: NO.
734 # If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper
736 # the prototype and the implementation of a member function even if there is
737 # only one candidate or it is obvious which candidate to choose by doing a
740 # The default value is: NO.
745 # list. This list is created by putting \todo commands in the documentation.
746 # The default value is: YES.
751 # list. This list is created by putting \test commands in the documentation.
752 # The default value is: YES.
757 # list. This list is created by putting \bug commands in the documentation.
758 # The default value is: YES.
763 # the deprecated list. This list is created by putting \deprecated commands in
765 # The default value is: YES.
789 # The default value is: YES.
796 # The default value is: YES.
803 # The default value is: YES.
810 # popen()) the command command input-file, where command is the value of the
811 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
812 # by Doxygen. Whatever the program writes to standard output is used as the file
827 # tag is left empty.
833 # extension is automatically appended if omitted. This requires the bibtex tool
847 # Note: This option is particularly useful for macOS version 14 (Sonoma) and
849 # defined changes to the PATH are ignored. A typical example on macOS is to set
862 # standard output by Doxygen. If QUIET is set to YES this implies that the
864 # The default value is: NO.
869 # generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES
873 # The default value is: YES.
877 # If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate
878 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
880 # The default value is: YES.
884 # If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for
888 # The default value is: YES.
892 # If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete
895 # The default value is: YES.
902 # documentation, but not about the absence of documentation. If EXTRACT_ALL is
905 # The default value is: NO.
909 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about
911 # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
913 # The default value is: NO.
917 # If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when
918 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
919 # then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
921 # If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves
922 # like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not
924 # of a run, in case a WARN_LOGFILE is defined the warning messages will be
926 # the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
929 # The default value is: NO.
940 # The default value is: $file:$line: $text.
944 # In the $text part of the WARN_FORMAT command it is possible that a reference
945 # to a more specific place is given. To make it easier to jump to this place
950 # The default value is: at line $line of file $file.
955 # messages should be written. If left blank the output is written to standard
957 # warning and error messages are written to standard error. When as file - is
967 # The INPUT tag is used to specify the files and/or directories that contain
971 # Note: If this tag is empty the current directory is searched.
990 # The default value is: UTF-8.
998 # INPUT_ENCODING) if there is a match. The character encodings are a list of the
1029 # The default value is: NO.
1035 # subdirectory from a directory tree whose root is specified with the INPUT tag.
1037 # Note that relative paths are relative to the directory from which Doxygen is
1046 # The default value is: NO.
1062 # wildcard * is used, a substring. Examples: ANamespace, AClass,
1083 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1086 # The default value is: NO.
1102 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1104 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1107 # Note that the filter must not add or remove lines; it is applied before the
1108 # code is scanned, but not when the output code is generated. If lines are added
1124 # filter if there is a match. The filters are a list of the form: pattern=filter
1126 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1127 # patterns match the file name, INPUT_FILTER is applied.
1135 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1137 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1138 # The default value is: NO.
1144 # it is also possible to disable source filtering for a specific pattern using
1146 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1151 # is part of the input, its contents will be placed on the main page
1159 # extension is to allow longer lines before the automatic comment starts. The
1170 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1174 # also VERBATIM_HEADERS is set to NO.
1175 # The default value is: NO.
1182 # The default value is: NO.
1189 # The default value is: YES.
1193 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1195 # The default value is: NO.
1199 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1201 # The default value is: NO.
1205 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1209 # The default value is: YES.
1213 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1218 # The default value is: YES.
1219 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1223 # If the USE_HTAGS tag is set to YES then the references to source code will
1225 # source browser. The htags tool is part of GNU's global source tagging system
1240 # The default value is: NO.
1241 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1245 # If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a
1246 # verbatim copy of the header file for each class for which an include is
1249 # The default value is: YES.
1253 # If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the
1260 # The default value is: NO.
1264 # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
1265 # tag is set to YES then Doxygen will add the directory of each input to the
1267 # The default value is: YES.
1268 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1272 # If clang assisted parsing is enabled you can provide the compiler with command
1276 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1280 # If clang assisted parsing is enabled you can provide the clang parser with the
1282 # file is the compilation database (see:
1284 # options used when the source files were built. This is equivalent to
1297 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1300 # The default value is: YES.
1309 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1317 # If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output
1318 # The default value is: YES.
1322 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1323 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1325 # The default directory is: html.
1326 # This tag requires that the tag GENERATE_HTML is set to YES.
1332 # The default value is: .html.
1333 # This tag requires that the tag GENERATE_HTML is set to YES.
1338 # each generated HTML page. If the tag is left blank Doxygen will generate a
1342 # that Doxygen needs, which is dependent on the configuration options used (e.g.
1343 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1350 # Note: The header is subject to change so you typically have to regenerate the
1353 # This tag requires that the tag GENERATE_HTML is set to YES.
1358 # generated HTML page. If the tag is left blank Doxygen will generate a standard
1363 # This tag requires that the tag GENERATE_HTML is set to YES.
1368 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1372 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1373 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1375 # This tag requires that the tag GENERATE_HTML is set to YES.
1382 # This is preferred over using HTML_STYLESHEET since it does not replace the
1383 # standard style sheet and is therefore more robust against future updates.
1385 # Note: The order of the extra style sheet files is of importance (e.g. the last
1391 # customization is desired it has to be added explicitly. For an example see the
1393 # This tag requires that the tag GENERATE_HTML is set to YES.
1405 # files will be copied as-is; there are no commands or markers available.
1406 # This tag requires that the tag GENERATE_HTML is set to YES.
1415 # to the user preference, uses light mode if no preference is set (the default),
1417 # dark mode if no preference is set and TOGGLE allows a user to switch between
1419 # The default value is: AUTO_LIGHT.
1420 # This tag requires that the tag GENERATE_HTML is set to YES.
1426 # this color. Hue is specified as an angle on a color-wheel, see
1428 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1429 # purple, and 360 is red again.
1431 # This tag requires that the tag GENERATE_HTML is set to YES.
1439 # This tag requires that the tag GENERATE_HTML is set to YES.
1446 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1450 # This tag requires that the tag GENERATE_HTML is set to YES.
1454 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1460 # The default value is: YES.
1461 # This tag requires that the tag GENERATE_HTML is set to YES.
1465 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1468 # The default value is: NO.
1469 # This tag requires that the tag GENERATE_HTML is set to YES.
1473 # If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
1475 # The default value is: YES.
1476 # This tag requires that the tag GENERATE_HTML is set to YES.
1480 # If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in
1483 # and the web page is served via a secure context (see:
1486 # The default value is: YES.
1487 # This tag requires that the tag GENERATE_HTML is set to YES.
1496 # This tag requires that the tag GENERATE_HTML is set to YES.
1505 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1509 # This tag requires that the tag GENERATE_HTML is set to YES.
1513 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1523 # The default value is: NO.
1524 # This tag requires that the tag GENERATE_HTML is set to YES.
1531 # The default value is: Doxygen generated docs.
1532 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1539 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1546 # The default value is: org.doxygen.Project.
1547 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1554 # The default value is: org.doxygen.Publisher.
1555 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1560 # The default value is: Publisher.
1561 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1565 # If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three
1567 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1582 # The default value is: NO.
1583 # This tag requires that the tag GENERATE_HTML is set to YES.
1590 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1598 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1602 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1604 # The default value is: NO.
1605 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1609 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1611 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1615 # The BINARY_TOC flag controls whether a binary table of contents is generated
1618 # The default value is: NO.
1619 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1625 # The default value is: NO.
1626 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1630 # The SITEMAP_URL tag is used to specify the full URL of the place where the
1632 # deployment of the documentation. The generated sitemap is called sitemap.xml
1634 # is specified no sitemap is generated. For information about the sitemap
1636 # This tag requires that the tag GENERATE_HTML is set to YES.
1640 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1644 # The default value is: NO.
1645 # This tag requires that the tag GENERATE_HTML is set to YES.
1649 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1650 # the file name of the resulting .qch file. The path specified is relative to
1652 # This tag requires that the tag GENERATE_QHP is set to YES.
1660 # The default value is: org.doxygen.Project.
1661 # This tag requires that the tag GENERATE_QHP is set to YES.
1669 # The default value is: doc.
1670 # This tag requires that the tag GENERATE_QHP is set to YES.
1674 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1678 # This tag requires that the tag GENERATE_QHP is set to YES.
1686 # This tag requires that the tag GENERATE_QHP is set to YES.
1693 # This tag requires that the tag GENERATE_QHP is set to YES.
1700 # This tag requires that the tag GENERATE_QHP is set to YES.
1704 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1711 # The default value is: NO.
1712 # This tag requires that the tag GENERATE_HTML is set to YES.
1719 # The default value is: org.doxygen.Project.
1720 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1730 # The default value is: NO.
1731 # This tag requires that the tag GENERATE_HTML is set to YES.
1735 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1737 # value is set to YES, a side panel will be generated containing a tree-like
1738 # index structure (just like the one that is generated for HTML Help). For this
1739 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1747 # The default value is: NO.
1748 # This tag requires that the tag GENERATE_HTML is set to YES.
1753 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1758 # DISABLE_INDEX is set to NO, this option has no effect.
1759 # The default value is: NO.
1760 # This tag requires that the tag GENERATE_HTML is set to YES.
1770 # This tag requires that the tag GENERATE_HTML is set to YES.
1774 # When the SHOW_ENUM_VALUES tag is set doxygen will show the specified
1776 # The default value is: NO.
1780 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1781 # to set the initial width (in pixels) of the frame in which the tree is shown.
1783 # This tag requires that the tag GENERATE_HTML is set to YES.
1787 # If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to
1789 # The default value is: NO.
1790 # This tag requires that the tag GENERATE_HTML is set to YES.
1794 # If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email
1796 # The default value is: YES.
1797 # This tag requires that the tag GENERATE_HTML is set to YES.
1801 # If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg
1807 # The default value is: png.
1808 # This tag requires that the tag GENERATE_HTML is set to YES.
1817 # This tag requires that the tag GENERATE_HTML is set to YES.
1833 # The default value is: NO.
1834 # This tag requires that the tag GENERATE_HTML is set to YES.
1838 # With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1840 # regards to the different settings, so it is possible that also other MathJax
1844 # The default value is: MathJax_2.
1845 # This tag requires that the tag USE_MATHJAX is set to YES.
1849 # When MathJax is enabled you can set the default output format to be used for
1855 # Possible values are: HTML-CSS (which is slower, but has the best
1856 # compatibility. This is the name for Mathjax version 2, for MathJax version 3
1859 # is the name for Mathjax version 3, for MathJax version 2 this will be
1861 # The default value is: HTML-CSS.
1862 # This tag requires that the tag USE_MATHJAX is set to YES.
1866 # When MathJax is enabled you need to specify the location relative to the HTML
1869 # is located at the same level as the HTML output directory, then
1872 # MathJax. However, it is strongly recommended to install a local copy of
1873 # MathJax from https://www.mathjax.org before deployment. The default value is:
1876 # This tag requires that the tag USE_MATHJAX is set to YES.
1888 # This tag requires that the tag USE_MATHJAX is set to YES.
1897 # This tag requires that the tag USE_MATHJAX is set to YES.
1901 # When the SEARCHENGINE tag is enabled Doxygen will generate a search box for
1905 # there is already a search function so this one should typically be disabled.
1907 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1909 # (what the <access key> is depends on the OS and browser, but it is typically
1913 # the search. The filter options can be selected when the cursor is inside the
1917 # The default value is: YES.
1918 # This tag requires that the tag GENERATE_HTML is set to YES.
1922 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1926 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1929 # The default value is: NO.
1930 # This tag requires that the tag SEARCHENGINE is set to YES.
1934 # When EXTERNAL_SEARCH tag is enabled Doxygen will no longer generate the PHP
1946 # The default value is: NO.
1947 # This tag requires that the tag SEARCHENGINE is set to YES.
1952 # which will return the search results when EXTERNAL_SEARCH is enabled.
1959 # This tag requires that the tag SEARCHENGINE is set to YES.
1964 # search data is written to a file for indexing by an external tool. With the
1966 # The default file is: searchdata.xml.
1967 # This tag requires that the tag SEARCHENGINE is set to YES.
1972 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1975 # This tag requires that the tag SEARCHENGINE is set to YES.
1983 # to a relative location where the documentation can be found. The format is:
1985 # This tag requires that the tag SEARCHENGINE is set to YES.
1993 # If the GENERATE_LATEX tag is set to YES, Doxygen will generate LaTeX output.
1994 # The default value is: YES.
1998 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1999 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2001 # The default directory is: latex.
2002 # This tag requires that the tag GENERATE_LATEX is set to YES.
2009 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
2010 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
2011 # chosen this is overwritten by pdflatex. For specific output languages the
2014 # This tag requires that the tag GENERATE_LATEX is set to YES.
2020 # Note: This tag is used in the Makefile / make.bat.
2023 # The default file is: makeindex.
2024 # This tag requires that the tag GENERATE_LATEX is set to YES.
2029 # generate index for LaTeX. In case there is no backslash (\) as first character
2031 # Note: This tag is used in the generated output file (.tex).
2033 # The default value is: makeindex.
2034 # This tag requires that the tag GENERATE_LATEX is set to YES.
2038 # If the COMPACT_LATEX tag is set to YES, Doxygen generates more compact LaTeX
2041 # The default value is: NO.
2042 # This tag requires that the tag GENERATE_LATEX is set to YES.
2046 # The PAPER_TYPE tag can be used to set the paper type that is used by the
2050 # The default value is: a4.
2051 # This tag requires that the tag GENERATE_LATEX is set to YES.
2063 # This tag requires that the tag GENERATE_LATEX is set to YES.
2069 # first chapter. If it is left blank Doxygen will generate a standard header. It
2070 # is highly recommended to start with a default header using
2076 # Note: The header is subject to change so you typically have to regenerate the
2080 # This tag requires that the tag GENERATE_LATEX is set to YES.
2086 # last chapter. If it is left blank Doxygen will generate a standard footer. See
2092 # This tag requires that the tag GENERATE_LATEX is set to YES.
2100 # Note: The order of the extra style sheet files is of importance (e.g. the last
2103 # This tag requires that the tag GENERATE_LATEX is set to YES.
2109 # directory. Note that the files will be copied as-is; there are no commands or
2111 # This tag requires that the tag GENERATE_LATEX is set to YES.
2115 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2119 # The default value is: YES.
2120 # This tag requires that the tag GENERATE_LATEX is set to YES.
2124 # If the USE_PDFLATEX tag is set to YES, Doxygen will use the engine as
2129 # The default value is: YES.
2130 # This tag requires that the tag GENERATE_LATEX is set to YES.
2136 # mode nothing is printed on the terminal, errors are scrolled as if <return> is
2140 # but there is no possibility of user interaction just like in batch mode,
2142 # keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
2144 # The default value is: NO.
2145 # This tag requires that the tag GENERATE_LATEX is set to YES.
2149 # If the LATEX_HIDE_INDICES tag is set to YES then Doxygen will not include the
2151 # The default value is: NO.
2152 # This tag requires that the tag GENERATE_LATEX is set to YES.
2159 # The default value is: plain.
2160 # This tag requires that the tag GENERATE_LATEX is set to YES.
2164 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2165 # path from which the emoji images will be read. If a relative path is entered,
2168 # This tag requires that the tag GENERATE_LATEX is set to YES.
2176 # If the GENERATE_RTF tag is set to YES, Doxygen will generate RTF output. The
2177 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
2179 # The default value is: NO.
2183 # The RTF_OUTPUT tag is used to specify where the RTF docs 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: rtf.
2187 # This tag requires that the tag GENERATE_RTF is set to YES.
2191 # If the COMPACT_RTF tag is set to YES, Doxygen generates more compact RTF
2194 # The default value is: NO.
2195 # This tag requires that the tag GENERATE_RTF is set to YES.
2199 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2206 # The default value is: NO.
2207 # This tag requires that the tag GENERATE_RTF is set to YES.
2211 # Load stylesheet definitions from file. Syntax is similar to Doxygen's
2217 # This tag requires that the tag GENERATE_RTF is set to YES.
2221 # Set optional variables used in the generation of an RTF document. Syntax is
2224 # This tag requires that the tag GENERATE_RTF is set to YES.
2230 # Note that the files will be copied as-is; there are no commands or markers
2232 # This tag requires that the tag GENERATE_RTF is set to YES.
2240 # If the GENERATE_MAN tag is set to YES, Doxygen will generate man pages for
2242 # The default value is: NO.
2246 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2247 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2250 # The default directory is: man.
2251 # This tag requires that the tag GENERATE_MAN is set to YES.
2255 # The MAN_EXTENSION tag determines the extension that is added to the generated
2257 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2259 # The default value is: .3.
2260 # This tag requires that the tag GENERATE_MAN is set to YES.
2267 # This tag requires that the tag GENERATE_MAN is set to YES.
2271 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, then it
2275 # The default value is: NO.
2276 # This tag requires that the tag GENERATE_MAN is set to YES.
2284 # If the GENERATE_XML tag is set to YES, Doxygen will generate an XML file that
2286 # The default value is: NO.
2290 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2291 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2293 # The default directory is: xml.
2294 # This tag requires that the tag GENERATE_XML is set to YES.
2298 # If the XML_PROGRAMLISTING tag is set to YES, Doxygen will dump the program
2302 # The default value is: YES.
2303 # This tag requires that the tag GENERATE_XML is set to YES.
2307 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, Doxygen will include
2309 # The default value is: NO.
2310 # This tag requires that the tag GENERATE_XML is set to YES.
2318 # If the GENERATE_DOCBOOK tag is set to YES, Doxygen will generate Docbook files
2320 # The default value is: NO.
2324 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2325 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2327 # The default directory is: docbook.
2328 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2336 # If the GENERATE_AUTOGEN_DEF tag is set to YES, Doxygen will generate an
2339 # is still experimental and incomplete at the moment.
2340 # The default value is: NO.
2348 # If the GENERATE_SQLITE3 tag is set to YES Doxygen will generate a Sqlite3
2350 # The default value is: NO.
2354 # The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
2355 # put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2357 # The default directory is: sqlite3.
2358 # This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2362 # The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db
2364 # will warn if a database file is already found and not modify it.
2365 # The default value is: YES.
2366 # This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2374 # If the GENERATE_PERLMOD tag is set to YES, Doxygen will generate a Perl module
2377 # Note that this feature is still experimental and incomplete at the moment.
2378 # The default value is: NO.
2382 # If the PERLMOD_LATEX tag is set to YES, Doxygen will generate the necessary
2385 # The default value is: NO.
2386 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2390 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2391 # formatted so it can be parsed by a human reader. This is useful if you want to
2392 # understand what is going on. On the other hand, if this tag is set to NO, the
2395 # The default value is: YES.
2396 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2401 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2404 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2412 # If the ENABLE_PREPROCESSING tag is set to YES, Doxygen will evaluate all
2414 # The default value is: YES.
2418 # If the MACRO_EXPANSION tag is set to YES, Doxygen will expand all macro names
2422 # The default value is: NO.
2423 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2428 # the macro expansion is limited to the macros specified with the PREDEFINED and
2430 # The default value is: NO.
2431 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2435 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2436 # INCLUDE_PATH will be searched if a #include is found.
2437 # The default value is: YES.
2438 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2444 # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2446 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2454 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2459 # defined before the preprocessor is started (similar to the -D option of e.g.
2460 # gcc). The argument of the tag is a list of macros of the form: name or
2462 # is assumed. To prevent a macro definition from being undefined via #undef or
2464 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2532 # macro definition that is found in the sources will be used. Use the PREDEFINED
2535 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2539 # If the SKIP_FUNCTION_MACROS tag is set to YES then Doxygen's preprocessor will
2544 # The default value is: YES.
2545 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2555 # a tag file without this location is as follows:
2557 # Adding location for the tag files is done as follows:
2563 # the path). If a tag file is not located in the directory in which Doxygen is
2568 # When a file name is specified after GENERATE_TAGFILE, Doxygen will create a
2569 # tag file that is based on the input files it reads. See section "Linking to
2574 # If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
2577 # The default value is: NO.
2581 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2584 # The default value is: YES.
2588 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2591 # The default value is: YES.
2600 # and usage relations if the target is undocumented or is not a class.
2601 # The default value is: YES.
2605 # If you set the HAVE_DOT tag to YES then Doxygen will assume the dot tool is
2606 # available from the path. This tool is part of Graphviz (see:
2608 # Bell Labs. The other options in this section have no effect if this option is
2610 # The default value is: NO.
2614 # The DOT_NUM_THREADS specifies the number of dot invocations Doxygen is allowed
2620 # This tag requires that the tag HAVE_DOT is set to YES.
2624 # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2628 # Edge and Graph Attributes specification</a> You need to make sure dot is able
2631 # directory containing the font. Default graphviz fontsize is 14.
2632 # The default value is: fontname=Helvetica,fontsize=10.
2633 # This tag requires that the tag HAVE_DOT is set to YES.
2637 # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2641 # The default value is: labelfontname=Helvetica,labelfontsize=10.
2642 # This tag requires that the tag HAVE_DOT is set to YES.
2646 # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2649 # The default value is: shape=box,height=0.2,width=0.4.
2650 # This tag requires that the tag HAVE_DOT is set to YES.
2656 # This tag requires that the tag HAVE_DOT is set to YES.
2660 # If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then Doxygen will
2662 # inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
2663 # HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2664 # the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
2665 # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2666 # If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
2673 # The default value is: YES.
2677 # If the COLLABORATION_GRAPH tag is set to YES then Doxygen will generate a
2681 # when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
2684 # The default value is: YES.
2685 # This tag requires that the tag HAVE_DOT is set to YES.
2689 # If the GROUP_GRAPHS tag is set to YES then Doxygen will generate a graph for
2691 # dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
2695 # The default value is: YES.
2696 # This tag requires that the tag HAVE_DOT is set to YES.
2700 # If the UML_LOOK tag is set to YES, Doxygen will generate inheritance and
2703 # The default value is: NO.
2704 # This tag requires that the tag HAVE_DOT is set to YES.
2708 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2713 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2714 # but if the number exceeds 15, the total amount of fields shown is limited to
2717 # This tag requires that the tag UML_LOOK is set to YES.
2721 # If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and
2723 # tag is set to YES, Doxygen will add type and arguments for attributes and
2724 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, Doxygen
2729 # The default value is: NO.
2730 # This tag requires that the tag UML_LOOK is set to YES.
2739 # This tag requires that the tag HAVE_DOT is set to YES.
2743 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2746 # The default value is: NO.
2747 # This tag requires that the tag HAVE_DOT is set to YES.
2754 # files. Explicit enabling an include graph, when INCLUDE_GRAPH is set to NO,
2757 # The default value is: YES.
2758 # This tag requires that the tag HAVE_DOT is set to YES.
2765 # files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
2769 # The default value is: YES.
2770 # This tag requires that the tag HAVE_DOT is set to YES.
2774 # If the CALL_GRAPH tag is set to YES then Doxygen will generate a call
2781 # The default value is: NO.
2782 # This tag requires that the tag HAVE_DOT is set to YES.
2786 # If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller
2793 # The default value is: NO.
2794 # This tag requires that the tag HAVE_DOT is set to YES.
2798 # If the GRAPHICAL_HIERARCHY tag is set to YES then Doxygen will graphical
2800 # The default value is: YES.
2801 # This tag requires that the tag HAVE_DOT is set to YES.
2805 # If the DIRECTORY_GRAPH tag is set to YES then Doxygen will show the
2809 # DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
2812 # The default value is: YES.
2813 # This tag requires that the tag HAVE_DOT is set to YES.
2820 # This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2834 # The default value is: png.
2835 # This tag requires that the tag HAVE_DOT is set to YES.
2839 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2846 # The default value is: NO.
2847 # This tag requires that the tag HAVE_DOT is set to YES.
2852 # found. If left blank, it is assumed the dot tool can be found in the path.
2853 # This tag requires that the tag HAVE_DOT is set to YES.
2860 # This tag requires that the tag HAVE_DOT is set to YES.
2867 # If left empty dia is assumed to be found in the default search path.
2879 # to be used. If left blank, it is assumed PlantUML is not used or called during
2897 # larger than this value, Doxygen will truncate the graph, which is visualized
2899 # children of the root node in a graph is already larger than
2903 # This tag requires that the tag HAVE_DOT is set to YES.
2915 # This tag requires that the tag HAVE_DOT is set to YES.
2922 # this, this feature is disabled by default.
2923 # The default value is: NO.
2924 # This tag requires that the tag HAVE_DOT is set to YES.
2928 # If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page
2932 # graphical representation for inheritance and collaboration diagrams is used.
2933 # The default value is: YES.
2934 # This tag requires that the tag HAVE_DOT is set to YES.
2938 # If the DOT_CLEANUP tag is set to YES, Doxygen will remove the intermediate
2941 # Note: This setting is not only used for dot files but also for msc temporary
2943 # The default value is: YES.
2948 # command. If the MSCGEN_TOOL tag is left empty (the default), then Doxygen will