Lines Matching +full:- +full:- +full:can +full:- +full:if
12 # For lists, items can also be appended using:
20 # doxygen -x [configFile]
24 # doxygen -x_noenv [configFile]
26 #---------------------------------------------------------------------------
28 #---------------------------------------------------------------------------
31 # file that follow. The default is UTF-8 which is also the encoding used for all
35 # The default value is: UTF-8.
37 DOXYFILE_ENCODING = UTF-8
40 # double-quotes, unless you are using Doxywizard) that should identify the
47 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
48 # could be handy for archiving the generated documentation or if some version
53 # Using the PROJECT_BRIEF tag one can provide an optional one line description
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
73 # into which the generated documentation will be written. If a relative path is
74 # entered, it will be relative to the location where Doxygen was started. If
79 # If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096
80 # sub-directories (in 2 levels) under the output directory of each output format
82 # option can be useful when feeding Doxygen a huge amount of source files, where
85 # control the number of sub-directories.
90 # Controls the number of sub-directories that will be created when
94 # sub-directories are organized in 2 levels, the first level always has a fixed
101 # If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII
102 # characters to appear in the names of generated files. If set to NO, non-ASCII
113 # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
115 # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
116 # English messages), Korean, Korean-en (Korean with English messages), Latvian,
118 # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
124 # If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member
131 # If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief
134 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
140 # This tag implements a quasi-intelligent brief description abbreviator that is
141 # used to form the text in various listings. Each string in this list, if found
144 # text. Otherwise, the brief description is used as-is. If left blank, the
151 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
152 # Doxygen will generate a detailed section even if there is only a brief
158 # If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all
159 # inherited members of a class in the documentation of that class as if those
166 # If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path
167 # before files name in the file list and in the header files. If set to NO the
173 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
174 # Stripping is only done if one of the specified strings matches the left-hand
175 # part of the path. The tag can be used to show relative paths in the file list.
176 # If left blank the directory from which Doxygen is run is used as the path to
179 # Note that you can specify absolute paths here, but also relative paths, which
185 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
187 # header file to include in order to use a class. If left blank only the name of
190 # using the -I flag.
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
196 # support long names like on DOS, Mac, or CD-ROM.
201 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the
202 # first line (until the first dot) of a Javadoc-style comment as the brief
203 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
210 # If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line
213 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
214 # Javadoc-style will behave just like regular comments and it will not be
220 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first
221 # line (until the first dot) of a Qt-style comment as the brief description. If
222 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
228 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a
229 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
231 # to treat a multi-line C++ comment block as a detailed description. Set this
232 # tag to YES if you prefer the old behavior instead.
242 # Doxygen's special commands can be used and the contents of the docstring
248 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
249 # documentation from any documented member that it re-implements.
254 # If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new
255 # page for each member. If set to NO, the documentation of a member will be part
261 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
267 # This tag can be used to specify a number of aliases that act as commands in
273 # documentation, which will result in a user-defined paragraph with heading
275 # to insert newlines (in the resulting output). You can put ^^ in the value part
276 # of an alias to insert a newline as if a physical newline was in the original
278 # have to escape them by means of a backslash (\), this can lead to conflicts
283 "req{1}=\ref ZEPH_\1 \"ZEPH-\1\"" \
292 "no_wait=\qualifier no-wait" \
293 "isr_ok=\qualifier isr-ok" \
294 "pre_kernel_ok=\qualifier pre-kernel-ok" \
296 …"atomic_api=As for all atomic APIs, includes a full/sequentially-consistent memory barrier (where …
299 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
307 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
315 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
321 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
327 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
336 # parses. With this tag you can assign which parser to use for a given
337 # extension. Doxygen has a built-in mapping, but you can override or extend it
340 # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
348 # Note: For files without extension you can use no_extension as a placeholder.
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
368 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
369 # to that level are automatically included in the table of contents, even if
377 # The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
382 # with any whitespace replaced by '-' and punctuation characters removed.
389 # classes, or namespaces to their corresponding documentation. Such a link can
396 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
406 # If you use Microsoft's C++/CLI language, you should set this option to YES to
412 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
423 # This will only work if the methods are indeed getting or setting a simple
424 # type. If this is not the case, or you want to show the methods anyway, you
430 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
432 # member in the group (if any) for the other members of the group. By default
438 # If one adds a struct or class to a group and this option is enabled, then also
448 # subgrouping. Alternatively, this can be done per class using the
468 # namespace, or group documentation), provided this scope is documented. If set
479 # namespace, or class. And the struct will be named TypeS. This can typically be
486 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
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
501 # cores available in the system. You can set it explicitly to a value larger
503 # speed. At this moment only the input processing can be done using multiple
512 # If the TIMESTAMP tag is set different from NO then each generated page will
514 # NO can help when comparing the output of multiple runs.
520 #---------------------------------------------------------------------------
522 #---------------------------------------------------------------------------
524 # If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in
525 # documentation are documented, even if no documentation was available. Private
534 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
540 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
546 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
552 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
558 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
559 # locally in source files will be included in the documentation. If set to NO,
566 # This flag is only useful for Objective-C code. If set to YES, local methods,
568 # included in the documentation. If set to NO, only methods in the interface are
574 # If this flag is set to YES, the members of anonymous namespaces will be
583 # If this flag is set to YES, the name of an unnamed parameter in a declaration
590 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
591 # undocumented members inside documented classes or files. If set to NO these
593 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
598 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
599 # undocumented classes that are normally visible in the class hierarchy. If set
601 # will also hide undocumented C++ concepts if enabled. This option has no effect
602 # if EXTRACT_ALL is enabled.
607 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend
608 # declarations. If set to NO, these declarations will be included in the
614 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
615 # documentation blocks found inside the body of a function. If set to NO, these
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
645 # If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with
646 # their full class and namespace scopes in the documentation. If set to YES, the
652 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will
653 # append additional text to a page's title, such as Class Reference. If set to
659 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
665 # If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of
671 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
678 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include
684 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
690 # If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the
692 # name. If set to NO, the members will appear in declaration order.
697 # If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief
699 # name. If set to NO, the members will appear in declaration order. Note that
705 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the
707 # destructors are listed first. If set to NO the constructors will appear in 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
717 # If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy
718 # of group names into alphabetical order. If set to NO the group names will
724 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
725 # fully-qualified names, including namespaces. If set to NO, the class list will
727 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
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
744 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
750 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
756 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
762 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
769 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
770 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
776 # initial value of a variable or macro / define can have for it to appear in the
777 # documentation. If the initializer consists of more lines than specified here
779 # appearance of the value of individual variables and macros / defines can be
787 # the bottom of the documentation of classes and structs. If set to YES, the
795 # (if specified).
802 # Folder Tree View (if specified).
807 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
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
817 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
820 # that represents Doxygen's defaults, run Doxygen with the -l option. You can
821 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
825 # Note that if you run Doxygen from a directory containing a file called
826 # DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE
831 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
833 # extension is automatically appended if omitted. This requires the bibtex tool
835 # For LaTeX the style of the bibliography can be controlled using
841 # The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH
842 # environment variable) so that external tools such as latex and gs can be
848 # higher, when running Doxygen from Doxywizard, because in this case any user-
857 #---------------------------------------------------------------------------
859 #---------------------------------------------------------------------------
861 # The QUIET tag can be used to turn on/off the messages that are generated to
862 # standard output by Doxygen. If QUIET is set to YES this implies that the
868 # The WARNINGS tag can be used to turn on/off the warning messages that are
869 # generated to standard error (stderr) by Doxygen. If WARNINGS is set to 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
884 # If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for
892 # If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete
893 # function parameter documentation. If set to NO, Doxygen will accept that some
899 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
901 # value. If set to NO, Doxygen will only warn about wrong parameter
902 # documentation, but not about the absence of documentation. If EXTRACT_ALL is
909 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about
910 # undocumented enumeration values. If set to NO, Doxygen will accept
911 # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
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
920 # at the end of the Doxygen process Doxygen will return with a non-zero status.
921 # If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves
926 # the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
934 # can produce. The string should contain the $file, $line, and $text tags, which
937 # be replaced by the version of the file (if it could be obtained via
946 # (outside of Doxygen) the user can define a custom "cut" / "paste" string.
954 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
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
963 #---------------------------------------------------------------------------
965 #---------------------------------------------------------------------------
971 # Note: If this tag is empty the current directory is searched.
984 # This tag can be used to specify the character encoding of the source files
985 # that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
990 # The default value is: UTF-8.
992 INPUT_ENCODING = UTF-8
994 # This tag can be used to specify the character encoding of the source files
995 # that Doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
998 # INPUT_ENCODING) if there is a match. The character encodings are a list of the
999 # form: pattern=encoding (like *.php=ISO-8859-1).
1004 # If the value of the INPUT tag contains directories, you can use the
1006 # *.h) to filter out the source-files in the directories.
1015 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
1027 # The RECURSIVE tag can be used to specify whether or not subdirectories should
1033 # The EXCLUDE tag can be used to specify files and/or directories that should be
1034 # excluded from the INPUT source files. This way you can easily exclude a
1043 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1050 # If the value of the INPUT tag contains directories, you can use the
1059 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1061 # output. The symbol name can be a fully qualified name, a word, or if the
1070 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
1076 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
1078 # *.h) to filter out the source-files in the directories. If left blank all
1083 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1090 # The IMAGE_PATH tag can be used to specify one or more files or directories
1096 # The INPUT_FILTER tag can be used to specify a program that Doxygen should
1100 # <filter> <input-file>
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
1108 # code is scanned, but not when the output code is generated. If lines are added
1122 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
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
1135 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1142 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1143 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1150 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1152 # (index.html). This can be useful if you have a project on for instance GitHub
1160 # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1166 #---------------------------------------------------------------------------
1168 #---------------------------------------------------------------------------
1170 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1171 # generated. Documented entities will be cross-referenced with these sources.
1180 # multi-line macros, enums or list initialized variables directly into the
1193 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1199 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1205 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1213 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1217 # can opt to disable this feature.
1223 # If the USE_HTAGS tag is set to YES then the references to source code will
1224 # point to the HTML generated by the htags(1) tool instead of Doxygen built-in
1230 # - Install the latest version of global
1231 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1232 # - Make sure the INPUT points to the root of the source tree
1233 # - Run doxygen as normal
1245 # If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a
1253 # If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the
1256 # performance. This can be particularly helpful with template rich C++ code for
1257 # which Doxygen's built-in parser lacks the necessary type information.
1259 # generated with the -Duse_libclang=ON option for CMake.
1264 # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
1272 # If clang assisted parsing is enabled you can provide the compiler with command
1280 # If clang assisted parsing is enabled you can provide the clang parser with the
1285 # specifying the -p option to a clang tool, such as clang-check. These options
1289 # generated with the -Duse_libclang=ON option for CMake.
1293 #---------------------------------------------------------------------------
1295 #---------------------------------------------------------------------------
1297 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1298 # compounds will be generated. Enable this if the project contains a lot of
1304 # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1313 #---------------------------------------------------------------------------
1315 #---------------------------------------------------------------------------
1317 # If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output
1322 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1330 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1337 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1338 # each generated HTML page. If the tag is left blank Doxygen will generate a
1345 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1357 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1358 # generated HTML page. If the tag is left blank Doxygen will generate a standard
1360 # footer and what special commands can be used inside the footer. See also
1367 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1368 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1369 # the HTML output. If left blank Doxygen will generate a default style sheet.
1379 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1381 # created by Doxygen. Using this option one can overrule certain style aspects.
1388 # Note: Since the styling of scrollbars can currently not be overruled in
1389 # Webkit/Chromium, the styling will be left out of the default doxygen.css if
1390 # one or more extra stylesheets have been specified. So if scrollbar
1395 HTML_EXTRA_STYLESHEET = @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome.css \
1396 @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome-sidebar-only.css \
1397 … @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome-sidebar-only-darkmode-toggle.css \
1398 @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome-zephyr.css
1400 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1405 # files will be copied as-is; there are no commands or markers available.
1408 HTML_EXTRA_FILES = @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome-darkmode-toggle.js \
1409 @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome-zephyr.js
1411 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
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
1426 # this color. Hue is specified as an angle on a color-wheel, see
1436 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1454 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1456 # are dynamically created via JavaScript. If disabled, the navigation index will
1465 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1466 # documentation will contain sections that can be hidden and shown after the
1473 # If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
1480 # If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in
1482 # its content to the clipboard. Note this only works if supported by the browser
1484 # https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file:
1493 # Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store
1500 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1501 # shown in the various tree structured indices initially; the user can expand
1513 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1514 # generated that can be used as input for Apple's Xcode 3 integrated development
1530 # (such as a company or product suite) can be grouped.
1538 # (such as a company or product suite) can be grouped.
1544 # set bundle. This should be a reverse domain-name style string, e.g.
1552 # the documentation publisher. This should be a reverse domain-name style
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
1570 # in maintenance mode). You can download the HTML help workshop from the web
1573 # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1575 # The HTML Help Workshop contains a compiler that can convert all HTML output
1579 # HTML files also contain an index, a table of contents, and you can search for
1587 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1588 # file. You can add a path in front of the file if the result should not be
1594 # The HHC_LOCATION tag can be used to specify the location (absolute path
1595 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1602 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1623 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1640 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1642 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1649 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1659 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1668 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1674 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1677 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1685 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1692 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1697 # The QHG_LOCATION tag can be used to specify the location (absolute path
1698 # including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to
1704 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1724 # If you want full control over the layout of the generated HTML pages it might
1726 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1729 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1735 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1736 # structure should be generated to display hierarchical information. If the tag
1737 # value is set to YES, a side panel will be generated containing a tree-like
1741 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1742 # further fine tune the look of the index (see "Fine-tuning the output"). As an
1753 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1754 # area (value NO) or if it should extend to the full height of the window (value
1757 # project logo, title, and description. If either GENERATE_TREEVIEW or
1764 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1780 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1787 # If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to
1794 # If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email
1801 # If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg
1821 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1829 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1830 # installed or if you want to formulas look prettier in the HTML output. When
1849 # When MathJax is enabled you can set the default output format to be used for
1852 # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1855 # Possible values are: HTML-CSS (which is slower, but has the best
1860 # translated into HTML-CSS) and SVG.
1861 # The default value is: HTML-CSS.
1864 MATHJAX_FORMAT = HTML-CSS
1868 # should contain the MathJax.js script. For instance, if the mathjax directory
1871 # Content Delivery Network so you can quickly see the result without installing
1874 # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1875 # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1880 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1883 # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1892 # The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces
1895 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1906 # For large projects the JavaScript based search engine can be slow, then
1911 # key> to jump into the search results window, the results can be navigated
1913 # the search. The filter options can be selected when the cursor is inside the
1965 # SEARCHDATA_FILE tag the name of this file can be specified.
1972 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1979 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through Doxygen
1983 # to a relative location where the documentation can be found. The format is:
1989 #---------------------------------------------------------------------------
1991 #---------------------------------------------------------------------------
1993 # If the GENERATE_LATEX tag is set to YES, Doxygen will generate LaTeX output.
1998 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
2006 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
2012 # default can have been set differently, this depends on the implementation of
2018 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
2028 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
2038 # If the COMPACT_LATEX tag is set to YES, Doxygen generates more compact LaTeX
2046 # The PAPER_TYPE tag can be used to set the paper type that is used by the
2055 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
2056 # that should be included in the LaTeX output. The package can be specified just
2058 # \usepackage command. To get the times font for instance you can specify :
2060 # To use the option intlimits with the amsmath package you can specify:
2062 # If left blank no extra packages will be included.
2067 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
2069 # first chapter. If it is left blank Doxygen will generate a standard header. It
2071 # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
2075 # Note: Only use a user-defined header if you know what you are doing!
2084 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2086 # last chapter. If it is left blank Doxygen will generate a standard footer. See
2088 # special commands can be used inside the footer. See also section "Doxygen
2090 # normally uses. Note: Only use a user-defined footer if you know what you are
2096 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2098 # by Doxygen. Using this option one can overrule certain style aspects. Doxygen
2107 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2109 # directory. Note that the files will be copied as-is; there are no commands or
2115 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2124 # If the USE_PDFLATEX tag is set to YES, Doxygen will use the engine as
2136 # mode nothing is printed on the terminal, errors are scrolled as if <return> is
2141 # SCROLL In scroll mode, TeX will stop only for missing files to input or if
2149 # If the LATEX_HIDE_INDICES tag is set to YES then Doxygen will not include the
2156 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2165 # path from which the emoji images will be read. If a relative path is entered,
2166 # it will be relative to the LATEX_OUTPUT directory. If left blank the
2172 #---------------------------------------------------------------------------
2174 #---------------------------------------------------------------------------
2176 # If the GENERATE_RTF tag is set to YES, Doxygen will generate RTF output. The
2183 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2191 # If the COMPACT_RTF tag is set to YES, Doxygen generates more compact RTF
2199 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2222 # similar to Doxygen's configuration file. A template extensions file can be
2223 # generated using doxygen -e rtf extensionFile.
2228 # The RTF_EXTRA_FILES tag can be used to specify one or more extra images or
2230 # Note that the files will be copied as-is; there are no commands or markers
2236 #---------------------------------------------------------------------------
2238 #---------------------------------------------------------------------------
2240 # If the GENERATE_MAN tag is set to YES, Doxygen will generate man pages for
2246 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2265 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2271 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, then it
2280 #---------------------------------------------------------------------------
2282 #---------------------------------------------------------------------------
2284 # If the GENERATE_XML tag is set to YES, Doxygen will generate an XML file that
2290 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2298 # If the XML_PROGRAMLISTING tag is set to YES, Doxygen will dump the program
2299 # listings (including syntax highlighting and cross-referencing information) to
2307 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, Doxygen will include
2314 #---------------------------------------------------------------------------
2316 #---------------------------------------------------------------------------
2318 # If the GENERATE_DOCBOOK tag is set to YES, Doxygen will generate Docbook files
2319 # that can be used to generate PDF.
2325 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2332 #---------------------------------------------------------------------------
2334 #---------------------------------------------------------------------------
2336 # If the GENERATE_AUTOGEN_DEF tag is set to YES, Doxygen will generate an
2344 #---------------------------------------------------------------------------
2346 #---------------------------------------------------------------------------
2348 # If the GENERATE_SQLITE3 tag is set to YES Doxygen will generate a Sqlite3
2355 # put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2363 # database file will be recreated with each Doxygen run. If set to NO, Doxygen
2364 # will warn if a database file is already found and not modify it.
2370 #---------------------------------------------------------------------------
2372 #---------------------------------------------------------------------------
2374 # If the GENERATE_PERLMOD tag is set to YES, Doxygen will generate a Perl module
2382 # If the PERLMOD_LATEX tag is set to YES, Doxygen will generate the necessary
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
2408 #---------------------------------------------------------------------------
2410 #---------------------------------------------------------------------------
2412 # If the ENABLE_PREPROCESSING tag is set to YES, Doxygen will evaluate all
2413 # C-preprocessor directives found in the sources and include files.
2418 # If the MACRO_EXPANSION tag is set to YES, Doxygen will expand all macro names
2419 # in the source code. If set to NO, only conditional compilation will be
2420 # performed. Macro expansion can be done in a controlled way by setting
2427 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
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.
2442 # The INCLUDE_PATH tag can be used to specify one or more directories that
2450 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2451 # patterns (like *.h and *.hpp) to filter out the header-files in the
2452 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2458 # The PREDEFINED tag can be used to specify one or more macro names that are
2459 # defined before the preprocessor is started (similar to the -D option of e.g.
2461 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2530 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2531 # tag can be used to specify a list of macro names that should be expanded. The
2533 # tag if you want to use a different macro definition that overrules the
2539 # If the SKIP_FUNCTION_MACROS tag is set to YES then Doxygen's preprocessor will
2540 # remove all references to function-like macros that are alone on a line, have
2542 # are typically used for boiler-plate code, and will confuse the parser if not
2549 #---------------------------------------------------------------------------
2551 #---------------------------------------------------------------------------
2553 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2559 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2563 # the path). If a tag file is not located in the directory in which Doxygen is
2574 # If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
2575 # will be listed in the class and namespace index. If set to NO, only the
2581 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2582 # in the topic index. If set to NO, only the current project's groups will be
2588 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2589 # the related pages index. If set to NO, only the current project's pages will
2595 #---------------------------------------------------------------------------
2597 #---------------------------------------------------------------------------
2599 # If set to YES the inheritance and collaboration graphs will hide inheritance
2600 # and usage relations if the target is undocumented or is not a class.
2605 # If you set the HAVE_DOT tag to YES then Doxygen will assume the dot tool is
2608 # Bell Labs. The other options in this section have no effect if this option is
2616 # processors available in the system. You can set it explicitly to a value
2626 # Doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2629 # to find the font, which can be done by putting it in a standard location or by
2637 # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2654 # You can set the path where dot can find font specified with fontname in
2660 # If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then Doxygen will
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
2669 # specific class, can be accomplished by means of the command \inheritancegraph.
2670 # Disabling an inheritance graph can be accomplished by means of the command
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
2682 # command \collaborationgraph. Disabling a collaboration graph can be
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
2692 # of the command \groupgraph. Disabling a directory graph can be accomplished by
2700 # If the UML_LOOK tag is set to YES, Doxygen will generate inheritance and
2708 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2709 # class node. If there are many fields or methods and many nodes the graph may
2714 # but if the number exceeds 15, the total amount of fields shown is limited to
2721 # If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and
2722 # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2724 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, Doxygen
2734 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2735 # to display on a single line. If the actual line length exceeds this threshold
2743 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2751 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2755 # can be accomplished by means of the command \includegraph. Disabling an
2756 # include graph can be accomplished by means of the command \hideincludegraph.
2762 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2766 # to NO, can be accomplished by means of the command \includedbygraph. Disabling
2767 # an included by graph can be accomplished by means of the command
2774 # If the CALL_GRAPH tag is set to YES then Doxygen will generate a call
2779 # functions only using the \callgraph command. Disabling a call graph can be
2786 # If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller
2791 # functions only using the \callergraph command. Disabling a caller graph can be
2798 # If the GRAPHICAL_HIERARCHY tag is set to YES then Doxygen will graphical
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
2810 # \directorygraph. Disabling a directory graph can be accomplished by means of
2817 # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
2824 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2828 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2839 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2851 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2852 # found. If left blank, it is assumed the dot tool can be found in the path.
2857 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2864 # You can include diagrams made with dia in Doxygen documentation. Doxygen will
2867 # If left empty dia is assumed to be found in the default search path.
2871 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2878 # path where java can find the plantuml.jar file or to the filename of jar file
2879 # to be used. If left blank, it is assumed PlantUML is not used or called during
2885 # When using PlantUML, the PLANTUML_CFG_FILE tag can be used to specify a
2895 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2896 # that will be shown in the graph. If the number of nodes in a graph becomes
2898 # by representing a node as a red box. Note that if the number of direct
2901 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2907 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2912 # note that the size of a graph can be further restricted by
2920 # files in one run (i.e. multiple -o and -T options on the command line). This
2928 # If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page
2938 # If the DOT_CLEANUP tag is set to YES, Doxygen will remove the intermediate
2947 # You can define message sequence charts within Doxygen comments using the \msc
2948 # command. If the MSCGEN_TOOL tag is left empty (the default), then Doxygen will
2949 # use a built-in version of mscgen tool to produce the charts. Alternatively,
2950 # the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
2951 # specifying prog as the value, Doxygen will call the tool as prog -T
2952 # <outfile_format> -o <outputfile> <inputfile>. The external tool should support
2957 # The MSCFILE_DIRS tag can be used to specify one or more directories that