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     is \
142 # doxygen will generate a detailed section even if there is only a brief
144 # The default value is: NO.
148 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
152 # The default value is: NO.
156 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
159 # The default value is: YES.
164 # Stripping is only done if one of the specified strings matches the left-hand
166 # If left blank the directory from which doxygen is run is used as the path to
170 # will be relative from the directory where doxygen is started.
171 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
178 # the header file containing the class definition is used. Otherwise one should
184 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
185 # less readable) file names. This can be useful is your file systems doesn't
187 # The default value is: NO.
191 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
196 # The default value is: NO.
200 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
206 # The default value is: NO.
210 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
214 # The default value is: NO.
220 # a brief description. This used to be the default behavior. The new default is
226 # The default value is: NO.
230 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
232 # The default value is: YES.
236 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
239 # The default value is: NO.
261 # commands \{ and \} for these it is advised to use the version @{ and @} or use
273 # only. Doxygen will then generate output that is more tailored for C. For
276 # The default value is: NO.
281 # Python sources only. Doxygen will then generate output that is more tailored
284 # The default value is: NO.
289 # sources. Doxygen will then generate output that is tailored for Fortran.
290 # The default value is: NO.
295 # sources. Doxygen will then generate output that is tailored for VHDL.
296 # The default value is: NO.
301 # sources only. Doxygen will then generate output that is more tailored for that
304 # The default value is: NO.
311 # using this tag. The format is ext=language, where ext is a file extension, and
312 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
316 # tries to guess whether the code is fixed or free formatted code, this is the
318 # .inc files as Fortran files (default is PHP), and .f files as C (default is
328 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
331 # The output of markdown processing is further processed by doxygen, so you can
334 # The default value is: YES.
338 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
343 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
351 # The default value is: YES.
361 # The default value is: NO.
367 # The default value is: NO.
374 # of private inheritance when no explicit protection keyword is present.
375 # The default value is: NO.
383 # type. If this is not the case, or you want to show the methods anyway, you
385 # The default value is: YES.
389 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
390 # tag is set to YES then doxygen will reuse the documentation of the first
393 # The default value is: NO.
397 # If one adds a struct or class to a group and this option is enabled, then also
398 # any nested class or struct is added to the same group. By default this option
399 # is disabled and one has to add nested compounds explicitly via \ingroup.
400 # The default value is: NO.
409 # The default value is: YES.
413 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
420 # The default value is: NO.
424 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
427 # namespace, or group documentation), provided this scope is documented. If set
430 # The default value is: NO.
434 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
435 # enum is documented as struct, union, or enum with the name of the typedef. So
440 # types are typedef'ed and only the typedef is referenced, never the tag name.
441 # The default value is: NO.
446 # cache is used to resolve symbols given their name and scope. Since this can be
448 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
449 # doxygen will become slower. If the cache is too large, memory is wasted. The
450 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
451 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
462 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
467 # normally produced when WARNINGS is set to YES.
468 # The default value is: NO.
472 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
474 # The default value is: NO.
478 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
480 # The default value is: NO.
484 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
486 # The default value is: NO.
490 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
492 # The default value is: NO.
496 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
500 # The default value is: YES.
504 # This flag is only useful for Objective-C code. If set to YES, local methods,
508 # The default value is: NO.
512 # If this flag is set to YES, the members of anonymous namespaces will be
517 # The default value is: NO.
521 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
524 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
525 # The default value is: NO.
529 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
532 # has no effect if EXTRACT_ALL is enabled.
533 # The default value is: NO.
537 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
540 # The default value is: NO.
544 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
547 # The default value is: NO.
551 # The INTERNAL_DOCS tag determines if documentation that is typed after a
552 # \internal command is included. If the tag is set to NO then the documentation
554 # The default value is: NO.
558 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
560 # allowed. This is useful if you have classes or files whose names only differ
563 # The default value is: system dependent.
567 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
570 # The default value is: NO.
574 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
577 # The default value is: NO.
581 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
583 # The default value is: YES.
587 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
590 # The default value is: NO.
594 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
596 # The default value is: NO.
600 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
602 # The default value is: YES.
606 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
609 # The default value is: YES.
613 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
617 # The default value is: NO.
621 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
625 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
627 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
629 # The default value is: NO.
633 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
636 # The default value is: NO.
640 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
643 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
646 # The default value is: NO.
650 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
652 # the prototype and the implementation of a member function even if there is
653 # only one candidate or it is obvious which candidate to choose by doing a
656 # The default value is: NO.
661 # list. This list is created by putting \todo commands in the documentation.
662 # The default value is: YES.
667 # list. This list is created by putting \test commands in the documentation.
668 # The default value is: YES.
673 # list. This list is created by putting \bug commands in the documentation.
674 # The default value is: YES.
679 # the deprecated list. This list is created by putting \deprecated commands in
681 # The default value is: YES.
705 # The default value is: YES.
712 # The default value is: YES.
719 # The default value is: YES.
726 # popen()) the command command input-file, where command is the value of the
727 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
728 # by doxygen. Whatever the program writes to standard output is used as the file
742 # tag is left empty.
748 # extension is automatically appended if omitted. This requires the bibtex tool
761 # standard output by doxygen. If QUIET is set to YES this implies that the
763 # The default value is: NO.
768 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
772 # The default value is: YES.
776 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
777 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
779 # The default value is: YES.
783 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
787 # The default value is: YES.
795 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
796 # The default value is: NO.
800 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
801 # a warning is encountered.
802 # The default value is: NO.
812 # The default value is: $file:$line: $text.
817 # messages should be written. If left blank the output is written to standard
826 # The INPUT tag is used to specify the files and/or directories that contain
830 # Note: If this tag is empty the current directory is searched.
839 # The default value is: UTF-8.
909 # The default value is: NO.
915 # subdirectory from a directory tree whose root is specified with the INPUT tag.
917 # Note that relative paths are relative to the directory from which doxygen is
925 # The default value is: NO.
941 # wildcard * is used, a substring. Examples: ANamespace, AClass,
962 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
965 # The default value is: NO.
981 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
983 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
986 # Note that the filter must not add or remove lines; it is applied before the
987 # code is scanned, but not when the output code is generated. If lines are added
998 # filter if there is a match. The filters are a list of the form: pattern=filter
1000 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1001 # patterns match the file name, INPUT_FILTER is applied.
1009 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1011 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1012 # The default value is: NO.
1018 # it is also possible to disable source filtering for a specific pattern using
1020 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1025 # is part of the input, its contents will be placed on the main page
1035 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1039 # also VERBATIM_HEADERS is set to NO.
1040 # The default value is: NO.
1046 # The default value is: NO.
1053 # The default value is: YES.
1057 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1059 # The default value is: NO.
1063 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1065 # The default value is: NO.
1069 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1073 # The default value is: YES.
1077 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1082 # The default value is: YES.
1083 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1087 # If the USE_HTAGS tag is set to YES then the references to source code will
1089 # source browser. The htags tool is part of GNU's global source tagging system
1104 # The default value is: NO.
1105 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1109 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1110 # verbatim copy of the header file for each class for which an include is
1113 # The default value is: YES.
1117 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1124 # The default value is: NO.
1128 # If clang assisted parsing is enabled you can provide the compiler with command
1132 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1136 # If clang assisted parsing is enabled you can provide the clang parser with the
1139 # were built. This is equivalent to specifying the "-p" option to a clang tool,
1150 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1153 # The default value is: YES.
1160 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1168 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1176 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1177 # The default value is: YES.
1181 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1182 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1184 # The default directory is: html.
1185 # This tag requires that the tag GENERATE_HTML is set to YES.
1191 # The default value is: .html.
1192 # This tag requires that the tag GENERATE_HTML is set to YES.
1197 # each generated HTML page. If the tag is left blank doxygen will generate a
1201 # that doxygen needs, which is dependent on the configuration options used (e.g.
1202 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1209 # Note: The header is subject to change so you typically have to regenerate the
1212 # This tag requires that the tag GENERATE_HTML is set to YES.
1217 # generated HTML page. If the tag is left blank doxygen will generate a standard
1222 # This tag requires that the tag GENERATE_HTML is set to YES.
1227 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1231 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1232 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1234 # This tag requires that the tag GENERATE_HTML is set to YES.
1241 # This is preferred over using HTML_STYLESHEET since it does not replace the
1242 # standard style sheet and is therefore more robust against future updates.
1244 # Note: The order of the extra style sheet files is of importance (e.g. the last
1247 # This tag requires that the tag GENERATE_HTML is set to YES.
1256 # files will be copied as-is; there are no commands or markers available.
1257 # This tag requires that the tag GENERATE_HTML is set to YES.
1263 # this color. Hue is specified as an angle on a colorwheel, see
1265 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1266 # purple, and 360 is red again.
1268 # This tag requires that the tag GENERATE_HTML is set to YES.
1276 # This tag requires that the tag GENERATE_HTML is set to YES.
1283 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1287 # This tag requires that the tag GENERATE_HTML is set to YES.
1291 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1294 # documentation is up to date.
1295 # The default value is: NO.
1296 # This tag requires that the tag GENERATE_HTML is set to YES.
1300 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1306 # The default value is: YES.
1307 # This tag requires that the tag GENERATE_HTML is set to YES.
1311 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1314 # The default value is: NO.
1315 # This tag requires that the tag GENERATE_HTML is set to YES.
1324 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1328 # This tag requires that the tag GENERATE_HTML is set to YES.
1332 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1341 # The default value is: NO.
1342 # This tag requires that the tag GENERATE_HTML is set to YES.
1349 # The default value is: Doxygen generated docs.
1350 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1357 # The default value is: org.doxygen.Project.
1358 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1365 # The default value is: org.doxygen.Publisher.
1366 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1371 # The default value is: Publisher.
1372 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1376 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1378 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1389 # The default value is: NO.
1390 # This tag requires that the tag GENERATE_HTML is set to YES.
1397 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1405 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1409 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1411 # The default value is: NO.
1412 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1416 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1418 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1422 # The BINARY_TOC flag controls whether a binary table of contents is generated
1425 # The default value is: NO.
1426 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1432 # The default value is: NO.
1433 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1437 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1441 # The default value is: NO.
1442 # This tag requires that the tag GENERATE_HTML is set to YES.
1446 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1447 # the file name of the resulting .qch file. The path specified is relative to
1449 # This tag requires that the tag GENERATE_QHP is set to YES.
1456 # The default value is: org.doxygen.Project.
1457 # This tag requires that the tag GENERATE_QHP is set to YES.
1465 # The default value is: doc.
1466 # This tag requires that the tag GENERATE_QHP is set to YES.
1470 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1474 # This tag requires that the tag GENERATE_QHP is set to YES.
1482 # This tag requires that the tag GENERATE_QHP is set to YES.
1489 # This tag requires that the tag GENERATE_QHP is set to YES.
1496 # This tag requires that the tag GENERATE_QHP is set to YES.
1500 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1507 # The default value is: NO.
1508 # This tag requires that the tag GENERATE_HTML is set to YES.
1515 # The default value is: org.doxygen.Project.
1516 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1526 # The default value is: NO.
1527 # This tag requires that the tag GENERATE_HTML is set to YES.
1531 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1533 # value is set to YES, a side panel will be generated containing a tree-like
1534 # index structure (just like the one that is generated for HTML Help). For this
1535 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1543 # The default value is: NO.
1544 # This tag requires that the tag GENERATE_HTML is set to YES.
1554 # This tag requires that the tag GENERATE_HTML is set to YES.
1558 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1559 # to set the initial width (in pixels) of the frame in which the tree is shown.
1561 # This tag requires that the tag GENERATE_HTML is set to YES.
1565 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1567 # The default value is: NO.
1568 # This tag requires that the tag GENERATE_HTML is set to YES.
1577 # This tag requires that the tag GENERATE_HTML is set to YES.
1587 # The default value is: YES.
1588 # This tag requires that the tag GENERATE_HTML is set to YES.
1604 # The default value is: NO.
1605 # This tag requires that the tag GENERATE_HTML is set to YES.
1609 # When MathJax is enabled you can set the default output format to be used for
1612 # Possible values are: HTML-CSS (which is slower, but has the best
1614 # The default value is: HTML-CSS.
1615 # This tag requires that the tag USE_MATHJAX is set to YES.
1619 # When MathJax is enabled you need to specify the location relative to the HTML
1622 # is located at the same level as the HTML output directory, then
1625 # MathJax. However, it is strongly recommended to install a local copy of
1627 # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
1628 # This tag requires that the tag USE_MATHJAX is set to YES.
1635 # This tag requires that the tag USE_MATHJAX is set to YES.
1643 # This tag requires that the tag USE_MATHJAX is set to YES.
1647 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1651 # there is already a search function so this one should typically be disabled.
1653 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1655 # (what the <access key> is depends on the OS and browser, but it is typically
1659 # the search. The filter options can be selected when the cursor is inside the
1663 # The default value is: YES.
1664 # This tag requires that the tag GENERATE_HTML is set to YES.
1668 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1672 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1675 # The default value is: NO.
1676 # This tag requires that the tag SEARCHENGINE is set to YES.
1680 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1691 # The default value is: NO.
1692 # This tag requires that the tag SEARCHENGINE is set to YES.
1697 # which will return the search results when EXTERNAL_SEARCH is enabled.
1703 # This tag requires that the tag SEARCHENGINE is set to YES.
1708 # search data is written to a file for indexing by an external tool. With the
1710 # The default file is: searchdata.xml.
1711 # This tag requires that the tag SEARCHENGINE is set to YES.
1716 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1719 # This tag requires that the tag SEARCHENGINE is set to YES.
1727 # to a relative location where the documentation can be found. The format is:
1729 # This tag requires that the tag SEARCHENGINE is set to YES.
1737 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1738 # The default value is: YES.
1742 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1743 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1745 # The default directory is: latex.
1746 # This tag requires that the tag GENERATE_LATEX is set to YES.
1753 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1754 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1755 # chosen this is overwritten by pdflatex. For specific output languages the
1758 # This tag requires that the tag GENERATE_LATEX is set to YES.
1764 # Note: This tag is used in the Makefile / make.bat.
1767 # The default file is: makeindex.
1768 # This tag requires that the tag GENERATE_LATEX is set to YES.
1773 # generate index for LaTeX. In case there is no backslash (\) as first character
1775 # Note: This tag is used in the generated output file (.tex).
1777 # The default value is: makeindex.
1778 # This tag requires that the tag GENERATE_LATEX is set to YES.
1782 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1785 # The default value is: NO.
1786 # This tag requires that the tag GENERATE_LATEX is set to YES.
1790 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1794 # The default value is: a4.
1795 # This tag requires that the tag GENERATE_LATEX is set to YES.
1807 # This tag requires that the tag GENERATE_LATEX is set to YES.
1813 # chapter. If it is left blank doxygen will generate a standard header. See
1821 # string, for the replacement values of the other commands the user is referred
1823 # This tag requires that the tag GENERATE_LATEX is set to YES.
1829 # chapter. If it is left blank doxygen will generate a standard footer. See
1834 # This tag requires that the tag GENERATE_LATEX is set to YES.
1842 # Note: The order of the extra style sheet files is of importance (e.g. the last
1845 # This tag requires that the tag GENERATE_LATEX is set to YES.
1851 # directory. Note that the files will be copied as-is; there are no commands or
1853 # This tag requires that the tag GENERATE_LATEX is set to YES.
1857 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1861 # The default value is: YES.
1862 # This tag requires that the tag GENERATE_LATEX is set to YES.
1866 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1869 # The default value is: YES.
1870 # This tag requires that the tag GENERATE_LATEX is set to YES.
1874 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1876 # if errors occur, instead of asking the user for help. This option is also used
1878 # The default value is: NO.
1879 # This tag requires that the tag GENERATE_LATEX is set to YES.
1883 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1885 # The default value is: NO.
1886 # This tag requires that the tag GENERATE_LATEX is set to YES.
1890 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1895 # The default value is: NO.
1896 # This tag requires that the tag GENERATE_LATEX is set to YES.
1903 # The default value is: plain.
1904 # This tag requires that the tag GENERATE_LATEX is set to YES.
1908 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1911 # The default value is: NO.
1912 # This tag requires that the tag GENERATE_LATEX is set to YES.
1916 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1917 # path from which the emoji images will be read. If a relative path is entered,
1920 # This tag requires that the tag GENERATE_LATEX is set to YES.
1928 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1929 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1931 # The default value is: NO.
1935 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1936 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1938 # The default directory is: rtf.
1939 # This tag requires that the tag GENERATE_RTF is set to YES.
1943 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1946 # The default value is: NO.
1947 # This tag requires that the tag GENERATE_RTF is set to YES.
1951 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1958 # The default value is: NO.
1959 # This tag requires that the tag GENERATE_RTF is set to YES.
1963 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1969 # This tag requires that the tag GENERATE_RTF is set to YES.
1973 # Set optional variables used in the generation of an RTF document. Syntax is
1976 # This tag requires that the tag GENERATE_RTF is set to YES.
1980 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1985 # The default value is: NO.
1986 # This tag requires that the tag GENERATE_RTF is set to YES.
1994 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1996 # The default value is: NO.
2000 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2001 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2004 # The default directory is: man.
2005 # This tag requires that the tag GENERATE_MAN is set to YES.
2009 # The MAN_EXTENSION tag determines the extension that is added to the generated
2011 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2013 # The default value is: .3.
2014 # This tag requires that the tag GENERATE_MAN is set to YES.
2021 # This tag requires that the tag GENERATE_MAN is set to YES.
2025 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2029 # The default value is: NO.
2030 # This tag requires that the tag GENERATE_MAN is set to YES.
2038 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2040 # The default value is: NO.
2044 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2045 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2047 # The default directory is: xml.
2048 # This tag requires that the tag GENERATE_XML is set to YES.
2052 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2056 # The default value is: YES.
2057 # This tag requires that the tag GENERATE_XML is set to YES.
2061 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2063 # The default value is: NO.
2064 # This tag requires that the tag GENERATE_XML is set to YES.
2072 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2074 # The default value is: NO.
2078 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2079 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2081 # The default directory is: docbook.
2082 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2086 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2090 # The default value is: NO.
2091 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2099 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2102 # is still experimental and incomplete at the moment.
2103 # The default value is: NO.
2111 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2114 # Note that this feature is still experimental and incomplete at the moment.
2115 # The default value is: NO.
2119 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2122 # The default value is: NO.
2123 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2127 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2128 # formatted so it can be parsed by a human reader. This is useful if you want to
2129 # understand what is going on. On the other hand, if this tag is set to NO, the
2132 # The default value is: YES.
2133 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2138 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2141 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2149 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2151 # The default value is: YES.
2155 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2159 # The default value is: NO.
2160 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2165 # the macro expansion is limited to the macros specified with the PREDEFINED and
2167 # The default value is: NO.
2168 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2172 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2173 # INCLUDE_PATH will be searched if a #include is found.
2174 # The default value is: YES.
2175 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2182 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2190 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2195 # defined before the preprocessor is started (similar to the -D option of e.g.
2196 # gcc). The argument of the tag is a list of macros of the form: name or
2198 # is assumed. To prevent a macro definition from being undefined via #undef or
2200 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2206 # macro definition that is found in the sources will be used. Use the PREDEFINED
2209 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2213 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2218 # The default value is: YES.
2219 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2229 # a tag file without this location is as follows:
2231 # Adding location for the tag files is done as follows:
2237 # the path). If a tag file is not located in the directory in which doxygen is
2242 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2243 # tag file that is based on the input files it reads. See section "Linking to
2248 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2251 # The default value is: NO.
2255 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2258 # The default value is: YES.
2262 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2265 # The default value is: YES.
2273 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2276 # disabled, but it is recommended to install and use dot, since it yields more
2278 # The default value is: YES.
2285 # If left empty dia is assumed to be found in the default search path.
2290 # and usage relations if the target is undocumented or is not a class.
2291 # The default value is: YES.
2295 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2296 # available from the path. This tool is part of Graphviz (see:
2298 # Bell Labs. The other options in this section have no effect if this option is
2300 # The default value is: YES.
2304 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2310 # This tag requires that the tag HAVE_DOT is set to YES.
2316 # sure dot is able to find the font, which can be done by putting it in a
2319 # The default value is: Helvetica.
2320 # This tag requires that the tag HAVE_DOT is set to YES.
2327 # This tag requires that the tag HAVE_DOT is set to YES.
2334 # This tag requires that the tag HAVE_DOT is set to YES.
2338 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2341 # The default value is: YES.
2342 # This tag requires that the tag HAVE_DOT is set to YES.
2346 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2350 # The default value is: YES.
2351 # This tag requires that the tag HAVE_DOT is set to YES.
2355 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2357 # The default value is: YES.
2358 # This tag requires that the tag HAVE_DOT is set to YES.
2362 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2365 # The default value is: NO.
2366 # This tag requires that the tag HAVE_DOT is set to YES.
2370 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2375 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2376 # but if the number exceeds 15, the total amount of fields shown is limited to
2379 # This tag requires that the tag HAVE_DOT is set to YES.
2383 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2386 # The default value is: NO.
2387 # This tag requires that the tag HAVE_DOT is set to YES.
2395 # The default value is: YES.
2396 # This tag requires that the tag HAVE_DOT is set to YES.
2404 # The default value is: YES.
2405 # This tag requires that the tag HAVE_DOT is set to YES.
2409 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2416 # The default value is: NO.
2417 # This tag requires that the tag HAVE_DOT is set to YES.
2421 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2428 # The default value is: NO.
2429 # This tag requires that the tag HAVE_DOT is set to YES.
2433 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2435 # The default value is: YES.
2436 # This tag requires that the tag HAVE_DOT is set to YES.
2440 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2444 # The default value is: YES.
2445 # This tag requires that the tag HAVE_DOT is set to YES.
2461 # The default value is: png.
2462 # This tag requires that the tag HAVE_DOT is set to YES.
2466 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2473 # The default value is: NO.
2474 # This tag requires that the tag HAVE_DOT is set to YES.
2479 # found. If left blank, it is assumed the dot tool can be found in the path.
2480 # This tag requires that the tag HAVE_DOT is set to YES.
2487 # This tag requires that the tag HAVE_DOT is set to YES.
2504 # path where java can find the plantuml.jar file. If left blank, it is assumed
2505 # PlantUML is not used or called during a preprocessing step. Doxygen will
2523 # larger than this value, doxygen will truncate the graph, which is visualized
2525 # children of the root node in a graph is already larger than
2529 # This tag requires that the tag HAVE_DOT is set to YES.
2541 # This tag requires that the tag HAVE_DOT is set to YES.
2546 # background. This is disabled by default, because dot on Windows does not seem
2552 # The default value is: NO.
2553 # This tag requires that the tag HAVE_DOT is set to YES.
2560 # this, this feature is disabled by default.
2561 # The default value is: NO.
2562 # This tag requires that the tag HAVE_DOT is set to YES.
2566 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2569 # The default value is: YES.
2570 # This tag requires that the tag HAVE_DOT is set to YES.
2574 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2576 # The default value is: YES.
2577 # This tag requires that the tag HAVE_DOT is set to YES.