Lines Matching full: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:
21 # file that follow. The default is UTF-8 which is also the encoding used for all
25 # The default value is: UTF-8.
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
31 # project for which the documentation is generated. This name is used in the
33 # The default value is: My Project.
39 # control system is used.
49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 # into which the generated documentation will be written. If a relative path is
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
69 # The default value is: NO.
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
77 # The default value is: NO.
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82 # documentation generated by doxygen is written. Doxygen will use this
92 # The default value is: English.
96 # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
97 # documentation generated by doxygen is written. Doxygen will use this
100 # The default value is: None.
104 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
107 # The default value is: YES.
111 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
116 # The default value is: YES.
120 # This tag implements a quasi-intelligent brief description abbreviator that is
123 # and the result, after processing the whole list, is used as the annotated
124 # text. Otherwise, the brief description is used as-is. If left blank, the
125 # following values are used ($name is automatically replaced with the name of
126 # the entity):The $name class, The $name widget, The $name file, is, provides,
132 # doxygen will generate a detailed section even if there is only a brief
134 # The default value is: NO.
138 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
142 # The default value is: NO.
146 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
149 # The default value is: YES.
154 # Stripping is only done if one of the specified strings matches the left-hand
156 # If left blank the directory from which doxygen is run is used as the path to
160 # will be relative from the directory where doxygen is started.
161 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
168 # the header file containing the class definition is used. Otherwise one should
174 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
175 # less readable) file names. This can be useful is your file systems doesn't
177 # The default value is: NO.
181 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
186 # The default value is: NO.
190 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
196 # The default value is: NO.
200 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
204 # The default value is: NO.
210 # a brief description. This used to be the default behavior. The new default is
216 # The default value is: NO.
223 # documentation blocks is shown as doxygen documentation.
224 # The default value is: YES.
228 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
230 # The default value is: YES.
234 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
237 # The default value is: NO.
259 # commands \{ and \} for these it is advised to use the version @{ and @} or use
265 # only. Doxygen will then generate output that is more tailored for C. For
268 # The default value is: NO.
273 # Python sources only. Doxygen will then generate output that is more tailored
276 # The default value is: NO.
281 # sources. Doxygen will then generate output that is tailored for Fortran.
282 # The default value is: NO.
287 # sources. Doxygen will then generate output that is tailored for VHDL.
288 # The default value is: NO.
293 # sources only. Doxygen will then generate output that is more tailored for that
296 # The default value is: NO.
303 # using this tag. The format is ext=language, where ext is a file extension, and
304 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
308 # tries to guess whether the code is fixed or free formatted code, this is the
310 # as Fortran files (default is PHP), and .f files as C (default is Fortran),
323 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
326 # The output of markdown processing is further processed by doxygen, so you can
329 # The default value is: YES.
333 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
338 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
346 # The default value is: YES.
356 # The default value is: NO.
362 # The default value is: NO.
369 # of private inheritance when no explicit protection keyword is present.
370 # The default value is: NO.
378 # type. If this is not the case, or you want to show the methods anyway, you
380 # The default value is: YES.
384 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
385 # tag is set to YES then doxygen will reuse the documentation of the first
388 # The default value is: NO.
392 # If one adds a struct or class to a group and this option is enabled, then also
393 # any nested class or struct is added to the same group. By default this option
394 # is disabled and one has to add nested compounds explicitly via \ingroup.
395 # The default value is: NO.
404 # The default value is: YES.
408 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
415 # The default value is: NO.
419 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
422 # namespace, or group documentation), provided this scope is documented. If set
425 # The default value is: NO.
429 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
430 # enum is documented as struct, union, or enum with the name of the typedef. So
435 # types are typedef'ed and only the typedef is referenced, never the tag name.
436 # The default value is: NO.
441 # cache is used to resolve symbols given their name and scope. Since this can be
443 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
444 # doxygen will become slower. If the cache is too large, memory is wasted. The
445 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
446 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
453 # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
458 # threads. Since this is still an experimental feature the default is set to 1,
460 # encounter. Generating dot graphs in parallel is controlled by the
470 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
475 # normally produced when WARNINGS is set to YES.
476 # The default value is: NO.
480 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
482 # The default value is: NO.
486 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
488 # The default value is: NO.
492 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
494 # The default value is: NO.
498 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
500 # The default value is: NO.
504 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
508 # The default value is: YES.
512 # This flag is only useful for Objective-C code. If set to YES, local methods,
516 # The default value is: NO.
520 # If this flag is set to YES, the members of anonymous namespaces will be
525 # The default value is: NO.
529 # If this flag is set to YES, the name of an unnamed parameter in a declaration
532 # The default value is: YES.
536 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
539 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
540 # The default value is: NO.
544 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
547 # has no effect if EXTRACT_ALL is enabled.
548 # The default value is: NO.
552 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
555 # The default value is: NO.
559 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
562 # The default value is: NO.
566 # The INTERNAL_DOCS tag determines if documentation that is typed after a
567 # \internal command is included. If the tag is set to NO then the documentation
569 # The default value is: NO.
575 # filesystem is case sensitive (i.e. it supports files in the same directory
585 # The default value is: system dependent.
589 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
592 # The default value is: NO.
596 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
599 # The default value is: NO.
603 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
605 # The default value is: YES.
609 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
612 # The default value is: NO.
616 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
618 # The default value is: NO.
622 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
624 # The default value is: YES.
628 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
631 # The default value is: YES.
635 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
639 # The default value is: NO.
643 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
647 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
649 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
651 # The default value is: NO.
655 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
658 # The default value is: NO.
662 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
665 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
668 # The default value is: NO.
672 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
674 # the prototype and the implementation of a member function even if there is
675 # only one candidate or it is obvious which candidate to choose by doing a
678 # The default value is: NO.
683 # list. This list is created by putting \todo commands in the documentation.
684 # The default value is: YES.
689 # list. This list is created by putting \test commands in the documentation.
690 # The default value is: YES.
695 # list. This list is created by putting \bug commands in the documentation.
696 # The default value is: YES.
701 # the deprecated list. This list is created by putting \deprecated commands in
703 # The default value is: YES.
727 # The default value is: YES.
734 # The default value is: YES.
741 # The default value is: YES.
748 # popen()) the command command input-file, where command is the value of the
749 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
750 # by doxygen. Whatever the program writes to standard output is used as the file
764 # tag is left empty.
770 # extension is automatically appended if omitted. This requires the bibtex tool
783 # standard output by doxygen. If QUIET is set to YES this implies that the
785 # The default value is: NO.
790 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
794 # The default value is: YES.
798 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
799 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
801 # The default value is: YES.
805 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
809 # The default value is: YES.
817 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
818 # The default value is: NO.
822 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
823 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
824 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
827 # The default value is: NO.
837 # The default value is: $file:$line: $text.
842 # messages should be written. If left blank the output is written to standard
851 # The INPUT tag is used to specify the files and/or directories that contain
855 # Note: If this tag is empty the current directory is searched.
869 # The default value is: UTF-8.
895 # The default value is: NO.
901 # subdirectory from a directory tree whose root is specified with the INPUT tag.
903 # Note that relative paths are relative to the directory from which doxygen is
911 # The default value is: NO.
927 # wildcard * is used, a substring. Examples: ANamespace, AClass,
948 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
951 # The default value is: NO.
967 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
969 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
972 # Note that the filter must not add or remove lines; it is applied before the
973 # code is scanned, but not when the output code is generated. If lines are added
984 # filter if there is a match. The filters are a list of the form: pattern=filter
986 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
987 # patterns match the file name, INPUT_FILTER is applied.
995 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
997 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
998 # The default value is: NO.
1004 # it is also possible to disable source filtering for a specific pattern using
1006 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1011 # is part of the input, its contents will be placed on the main page
1021 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1025 # also VERBATIM_HEADERS is set to NO.
1026 # The default value is: NO.
1032 # The default value is: NO.
1039 # The default value is: YES.
1043 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1045 # The default value is: NO.
1049 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1051 # The default value is: NO.
1055 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1059 # The default value is: YES.
1063 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1068 # The default value is: YES.
1069 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1073 # If the USE_HTAGS tag is set to YES then the references to source code will
1075 # source browser. The htags tool is part of GNU's global source tagging system
1090 # The default value is: NO.
1091 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1095 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1096 # verbatim copy of the header file for each class for which an include is
1099 # The default value is: YES.
1103 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1110 # The default value is: NO.
1114 # If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to
1116 # The default value is: YES.
1120 # If clang assisted parsing is enabled you can provide the compiler with command
1124 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1128 # If clang assisted parsing is enabled you can provide the clang parser with the
1130 # file is the compilation database (see:
1132 # options used when the source files were built. This is equivalent to
1145 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1148 # The default value is: YES.
1156 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1164 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1165 # The default value is: YES.
1169 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1170 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1172 # The default directory is: html.
1173 # This tag requires that the tag GENERATE_HTML is set to YES.
1179 # The default value is: .html.
1180 # This tag requires that the tag GENERATE_HTML is set to YES.
1185 # each generated HTML page. If the tag is left blank doxygen will generate a
1189 # that doxygen needs, which is dependent on the configuration options used (e.g.
1190 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1197 # Note: The header is subject to change so you typically have to regenerate the
1200 # This tag requires that the tag GENERATE_HTML is set to YES.
1205 # generated HTML page. If the tag is left blank doxygen will generate a standard
1210 # This tag requires that the tag GENERATE_HTML is set to YES.
1215 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1219 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1220 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1222 # This tag requires that the tag GENERATE_HTML is set to YES.
1229 # This is preferred over using HTML_STYLESHEET since it does not replace the
1230 # standard style sheet and is therefore more robust against future updates.
1232 # Note: The order of the extra style sheet files is of importance (e.g. the last
1235 # This tag requires that the tag GENERATE_HTML is set to YES.
1244 # files will be copied as-is; there are no commands or markers available.
1245 # This tag requires that the tag GENERATE_HTML is set to YES.
1251 # this color. Hue is specified as an angle on a colorwheel, see
1253 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1254 # purple, and 360 is red again.
1256 # This tag requires that the tag GENERATE_HTML is set to YES.
1264 # This tag requires that the tag GENERATE_HTML is set to YES.
1271 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1275 # This tag requires that the tag GENERATE_HTML is set to YES.
1279 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1282 # documentation is up to date.
1283 # The default value is: NO.
1284 # This tag requires that the tag GENERATE_HTML is set to YES.
1288 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1294 # The default value is: YES.
1295 # This tag requires that the tag GENERATE_HTML is set to YES.
1299 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1302 # The default value is: NO.
1303 # This tag requires that the tag GENERATE_HTML is set to YES.
1312 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1316 # This tag requires that the tag GENERATE_HTML is set to YES.
1320 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1330 # The default value is: NO.
1331 # This tag requires that the tag GENERATE_HTML is set to YES.
1338 # The default value is: Doxygen generated docs.
1339 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1346 # The default value is: org.doxygen.Project.
1347 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1354 # The default value is: org.doxygen.Publisher.
1355 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1360 # The default value is: Publisher.
1361 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1365 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1367 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1378 # The default value is: NO.
1379 # This tag requires that the tag GENERATE_HTML is set to YES.
1386 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1394 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1398 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1400 # The default value is: NO.
1401 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1405 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1407 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1411 # The BINARY_TOC flag controls whether a binary table of contents is generated
1414 # The default value is: NO.
1415 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1421 # The default value is: NO.
1422 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1426 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1430 # The default value is: NO.
1431 # This tag requires that the tag GENERATE_HTML is set to YES.
1435 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1436 # the file name of the resulting .qch file. The path specified is relative to
1438 # This tag requires that the tag GENERATE_QHP is set to YES.
1446 # The default value is: org.doxygen.Project.
1447 # This tag requires that the tag GENERATE_QHP is set to YES.
1455 # The default value is: doc.
1456 # This tag requires that the tag GENERATE_QHP is set to YES.
1460 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1464 # This tag requires that the tag GENERATE_QHP is set to YES.
1472 # This tag requires that the tag GENERATE_QHP is set to YES.
1479 # This tag requires that the tag GENERATE_QHP is set to YES.
1486 # This tag requires that the tag GENERATE_QHP is set to YES.
1490 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1497 # The default value is: NO.
1498 # This tag requires that the tag GENERATE_HTML is set to YES.
1505 # The default value is: org.doxygen.Project.
1506 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1516 # The default value is: NO.
1517 # This tag requires that the tag GENERATE_HTML is set to YES.
1521 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1523 # value is set to YES, a side panel will be generated containing a tree-like
1524 # index structure (just like the one that is generated for HTML Help). For this
1525 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1533 # The default value is: NO.
1534 # This tag requires that the tag GENERATE_HTML is set to YES.
1544 # This tag requires that the tag GENERATE_HTML is set to YES.
1548 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1549 # to set the initial width (in pixels) of the frame in which the tree is shown.
1551 # This tag requires that the tag GENERATE_HTML is set to YES.
1555 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1557 # The default value is: NO.
1558 # This tag requires that the tag GENERATE_HTML is set to YES.
1562 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1568 # The default value is: png.
1569 # This tag requires that the tag GENERATE_HTML is set to YES.
1578 # This tag requires that the tag GENERATE_HTML is set to YES.
1588 # The default value is: YES.
1589 # This tag requires that the tag GENERATE_HTML is set to YES.
1605 # The default value is: NO.
1606 # This tag requires that the tag GENERATE_HTML is set to YES.
1610 # When MathJax is enabled you can set the default output format to be used for
1613 # Possible values are: HTML-CSS (which is slower, but has the best
1615 # The default value is: HTML-CSS.
1616 # This tag requires that the tag USE_MATHJAX is set to YES.
1620 # When MathJax is enabled you need to specify the location relative to the HTML
1623 # is located at the same level as the HTML output directory, then
1626 # MathJax. However, it is strongly recommended to install a local copy of
1628 # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
1629 # This tag requires that the tag USE_MATHJAX is set to YES.
1636 # This tag requires that the tag USE_MATHJAX is set to YES.
1645 # This tag requires that the tag USE_MATHJAX is set to YES.
1649 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1653 # there is already a search function so this one should typically be disabled.
1655 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1657 # (what the <access key> is depends on the OS and browser, but it is typically
1661 # the search. The filter options can be selected when the cursor is inside the
1665 # The default value is: YES.
1666 # This tag requires that the tag GENERATE_HTML is set to YES.
1670 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1674 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1677 # The default value is: NO.
1678 # This tag requires that the tag SEARCHENGINE is set to YES.
1682 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1694 # The default value is: NO.
1695 # This tag requires that the tag SEARCHENGINE is set to YES.
1700 # which will return the search results when EXTERNAL_SEARCH is enabled.
1707 # This tag requires that the tag SEARCHENGINE is set to YES.
1712 # search data is written to a file for indexing by an external tool. With the
1714 # The default file is: searchdata.xml.
1715 # This tag requires that the tag SEARCHENGINE is set to YES.
1720 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1723 # This tag requires that the tag SEARCHENGINE is set to YES.
1731 # to a relative location where the documentation can be found. The format is:
1733 # This tag requires that the tag SEARCHENGINE is set to YES.
1741 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1742 # The default value is: YES.
1746 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1747 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1749 # The default directory is: latex.
1750 # This tag requires that the tag GENERATE_LATEX is set to YES.
1757 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1758 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1759 # chosen this is overwritten by pdflatex. For specific output languages the
1762 # This tag requires that the tag GENERATE_LATEX is set to YES.
1768 # Note: This tag is used in the Makefile / make.bat.
1771 # The default file is: makeindex.
1772 # This tag requires that the tag GENERATE_LATEX is set to YES.
1777 # generate index for LaTeX. In case there is no backslash (\) as first character
1779 # Note: This tag is used in the generated output file (.tex).
1781 # The default value is: makeindex.
1782 # This tag requires that the tag GENERATE_LATEX is set to YES.
1786 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1789 # The default value is: NO.
1790 # This tag requires that the tag GENERATE_LATEX is set to YES.
1794 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1798 # The default value is: a4.
1799 # This tag requires that the tag GENERATE_LATEX is set to YES.
1811 # This tag requires that the tag GENERATE_LATEX is set to YES.
1817 # chapter. If it is left blank doxygen will generate a standard header. See
1825 # string, for the replacement values of the other commands the user is referred
1827 # This tag requires that the tag GENERATE_LATEX is set to YES.
1833 # chapter. If it is left blank doxygen will generate a standard footer. See
1838 # This tag requires that the tag GENERATE_LATEX is set to YES.
1846 # Note: The order of the extra style sheet files is of importance (e.g. the last
1849 # This tag requires that the tag GENERATE_LATEX is set to YES.
1855 # directory. Note that the files will be copied as-is; there are no commands or
1857 # This tag requires that the tag GENERATE_LATEX is set to YES.
1861 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1865 # The default value is: YES.
1866 # This tag requires that the tag GENERATE_LATEX is set to YES.
1870 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1875 # The default value is: YES.
1876 # This tag requires that the tag GENERATE_LATEX is set to YES.
1880 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1882 # if errors occur, instead of asking the user for help. This option is also used
1884 # The default value is: NO.
1885 # This tag requires that the tag GENERATE_LATEX is set to YES.
1889 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1891 # The default value is: NO.
1892 # This tag requires that the tag GENERATE_LATEX is set to YES.
1896 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1901 # The default value is: NO.
1902 # This tag requires that the tag GENERATE_LATEX is set to YES.
1909 # The default value is: plain.
1910 # This tag requires that the tag GENERATE_LATEX is set to YES.
1914 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1917 # The default value is: NO.
1918 # This tag requires that the tag GENERATE_LATEX is set to YES.
1922 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1923 # path from which the emoji images will be read. If a relative path is entered,
1926 # This tag requires that the tag GENERATE_LATEX is set to YES.
1934 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1935 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1937 # The default value is: NO.
1941 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1942 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1944 # The default directory is: rtf.
1945 # This tag requires that the tag GENERATE_RTF is set to YES.
1949 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1952 # The default value is: NO.
1953 # This tag requires that the tag GENERATE_RTF is set to YES.
1957 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1964 # The default value is: NO.
1965 # This tag requires that the tag GENERATE_RTF is set to YES.
1969 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1975 # This tag requires that the tag GENERATE_RTF is set to YES.
1979 # Set optional variables used in the generation of an RTF document. Syntax is
1982 # This tag requires that the tag GENERATE_RTF is set to YES.
1986 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1991 # The default value is: NO.
1992 # This tag requires that the tag GENERATE_RTF is set to YES.
2000 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2002 # The default value is: NO.
2006 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2007 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2010 # The default directory is: man.
2011 # This tag requires that the tag GENERATE_MAN is set to YES.
2015 # The MAN_EXTENSION tag determines the extension that is added to the generated
2017 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2019 # The default value is: .3.
2020 # This tag requires that the tag GENERATE_MAN is set to YES.
2027 # This tag requires that the tag GENERATE_MAN is set to YES.
2031 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2035 # The default value is: NO.
2036 # This tag requires that the tag GENERATE_MAN is set to YES.
2044 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2046 # The default value is: NO.
2050 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2051 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2053 # The default directory is: xml.
2054 # This tag requires that the tag GENERATE_XML is set to YES.
2058 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2062 # The default value is: YES.
2063 # This tag requires that the tag GENERATE_XML is set to YES.
2067 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2069 # The default value is: NO.
2070 # This tag requires that the tag GENERATE_XML is set to YES.
2078 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2080 # The default value is: NO.
2084 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2085 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2087 # The default directory is: docbook.
2088 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2092 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2096 # The default value is: NO.
2097 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2105 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2108 # is still experimental and incomplete at the moment.
2109 # The default value is: NO.
2117 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2120 # Note that this feature is still experimental and incomplete at the moment.
2121 # The default value is: NO.
2125 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2128 # The default value is: NO.
2129 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2133 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2134 # formatted so it can be parsed by a human reader. This is useful if you want to
2135 # understand what is going on. On the other hand, if this tag is set to NO, the
2138 # The default value is: YES.
2139 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2144 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2147 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2155 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2157 # The default value is: YES.
2161 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2165 # The default value is: NO.
2166 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2171 # the macro expansion is limited to the macros specified with the PREDEFINED and
2173 # The default value is: NO.
2174 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2178 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2179 # INCLUDE_PATH will be searched if a #include is found.
2180 # The default value is: YES.
2181 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2188 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2196 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2201 # defined before the preprocessor is started (similar to the -D option of e.g.
2202 # gcc). The argument of the tag is a list of macros of the form: name or
2204 # is assumed. To prevent a macro definition from being undefined via #undef or
2206 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2212 # macro definition that is found in the sources will be used. Use the PREDEFINED
2215 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2219 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2224 # The default value is: YES.
2225 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2235 # a tag file without this location is as follows:
2237 # Adding location for the tag files is done as follows:
2243 # the path). If a tag file is not located in the directory in which doxygen is
2248 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2249 # tag file that is based on the input files it reads. See section "Linking to
2254 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2257 # The default value is: NO.
2261 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2264 # The default value is: YES.
2268 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2271 # The default value is: YES.
2279 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2282 # disabled, but it is recommended to install and use dot, since it yields more
2284 # The default value is: YES.
2291 # If left empty dia is assumed to be found in the default search path.
2296 # and usage relations if the target is undocumented or is not a class.
2297 # The default value is: YES.
2301 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2302 # available from the path. This tool is part of Graphviz (see:
2304 # Bell Labs. The other options in this section have no effect if this option is
2306 # The default value is: YES.
2310 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2316 # This tag requires that the tag HAVE_DOT is set to YES.
2322 # sure dot is able to find the font, which can be done by putting it in a
2325 # The default value is: Helvetica.
2326 # This tag requires that the tag HAVE_DOT is set to YES.
2333 # This tag requires that the tag HAVE_DOT is set to YES.
2340 # This tag requires that the tag HAVE_DOT is set to YES.
2344 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2347 # The default value is: YES.
2348 # This tag requires that the tag HAVE_DOT is set to YES.
2352 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2356 # The default value is: YES.
2357 # This tag requires that the tag HAVE_DOT is set to YES.
2361 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2363 # The default value is: YES.
2364 # This tag requires that the tag HAVE_DOT is set to YES.
2368 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2371 # The default value is: NO.
2372 # This tag requires that the tag HAVE_DOT is set to YES.
2376 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2381 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2382 # but if the number exceeds 15, the total amount of fields shown is limited to
2385 # This tag requires that the tag UML_LOOK is set to YES.
2389 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2391 # tag is set to YES, doxygen will add type and arguments for attributes and
2392 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2397 # The default value is: NO.
2398 # This tag requires that the tag UML_LOOK is set to YES.
2407 # This tag requires that the tag HAVE_DOT is set to YES.
2411 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2414 # The default value is: NO.
2415 # This tag requires that the tag HAVE_DOT is set to YES.
2423 # The default value is: YES.
2424 # This tag requires that the tag HAVE_DOT is set to YES.
2432 # The default value is: YES.
2433 # This tag requires that the tag HAVE_DOT is set to YES.
2437 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2444 # The default value is: NO.
2445 # This tag requires that the tag HAVE_DOT is set to YES.
2449 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2456 # The default value is: NO.
2457 # This tag requires that the tag HAVE_DOT is set to YES.
2461 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2463 # The default value is: YES.
2464 # This tag requires that the tag HAVE_DOT is set to YES.
2468 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2472 # The default value is: YES.
2473 # This tag requires that the tag HAVE_DOT is set to YES.
2489 # The default value is: png.
2490 # This tag requires that the tag HAVE_DOT is set to YES.
2494 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2501 # The default value is: NO.
2502 # This tag requires that the tag HAVE_DOT is set to YES.
2507 # found. If left blank, it is assumed the dot tool can be found in the path.
2508 # This tag requires that the tag HAVE_DOT is set to YES.
2515 # This tag requires that the tag HAVE_DOT is set to YES.
2532 # path where java can find the plantuml.jar file. If left blank, it is assumed
2533 # PlantUML is not used or called during a preprocessing step. Doxygen will
2551 # larger than this value, doxygen will truncate the graph, which is visualized
2553 # children of the root node in a graph is already larger than
2557 # This tag requires that the tag HAVE_DOT is set to YES.
2569 # This tag requires that the tag HAVE_DOT is set to YES.
2574 # background. This is disabled by default, because dot on Windows does not seem
2580 # The default value is: NO.
2581 # This tag requires that the tag HAVE_DOT is set to YES.
2588 # this, this feature is disabled by default.
2589 # The default value is: NO.
2590 # This tag requires that the tag HAVE_DOT is set to YES.
2594 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2597 # The default value is: YES.
2598 # This tag requires that the tag HAVE_DOT is set to YES.
2602 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2605 # Note: This setting is not only used for dot files but also for msc and
2607 # The default value is: YES.