Lines Matching +full:if +full:- +full:no +full:- +full:files +full:- +full:found
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
48 # could be handy for archiving the generated documentation or if some version
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
81 # and will distribute the generated files over these directories. Enabling this
82 # option can be useful when feeding Doxygen a huge amount of source files, where
83 # putting all generated files in the same directory would otherwise causes
85 # control the number of sub-directories.
86 # The default value is: NO.
88 CREATE_SUBDIRS = NO
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
105 # The default value is: NO.
107 ALLOW_UNICODE_NAMES = NO
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
126 # documentation (similar to Javadoc). Set to NO to disable this.
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
154 # The default value is: NO.
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
162 # The default value is: NO.
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
176 # If left blank the directory from which Doxygen is run is used as the path to
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
196 # support long names like on DOS, Mac, or CD-ROM.
197 # The default value is: NO.
199 SHORT_NAMES = NO
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-
206 # The default value is: NO.
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
216 # The default value is: NO.
218 JAVADOC_BANNER = NO
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
224 # The default value is: NO.
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.
236 # The default value is: NO.
238 MULTILINE_CPP_IS_BRIEF = NO
241 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
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
257 # The default value is: NO.
259 SEPARATE_MEMBER_PAGES = NO
273 # documentation, which will result in a user-defined paragraph with heading
276 # of an alias to insert a newline as if a physical newline was in the original
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
303 # The default value is: NO.
307 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
311 # The default value is: NO.
313 OPTIMIZE_OUTPUT_JAVA = NO
315 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
317 # The default value is: NO.
319 OPTIMIZE_FOR_FORTRAN = NO
321 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
323 # The default value is: NO.
325 OPTIMIZE_OUTPUT_VHDL = NO
327 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
331 # The default value is: NO.
333 OPTIMIZE_OUTPUT_SLICE = NO
335 # Doxygen selects the parser to use depending on the extension of the files it
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,
344 # default for Fortran type files). For instance to make Doxygen treat .inc files
345 # as Fortran files (default is PHP), and .f files as C (default is Fortran),
348 # Note: For files without extension you can use no_extension as a placeholder.
351 # the files are not read by Doxygen. When specifying no_extension you should add
358 # If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments
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
382 # with any whitespace replaced by '-' and punctuation characters removed.
391 # globally by setting AUTOLINK_SUPPORT to NO.
396 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
402 # The default value is: NO.
404 BUILTIN_STL_SUPPORT = NO
406 # If you use Microsoft's C++/CLI language, you should set this option to YES to
408 # The default value is: NO.
412 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
415 # inheritance when no explicit protection keyword is present.
416 # The default value is: NO.
418 SIP_SUPPORT = NO
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
425 # should set this option to NO.
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
434 # The default value is: NO.
436 DISTRIBUTE_GROUP_DOC = NO
438 # If one adds a struct or class to a group and this option is enabled, then also
441 # The default value is: NO.
443 GROUP_NESTED_COMPOUNDS = NO
447 # type (e.g. under the Public Functions section). Set it to NO to prevent
461 # The default value is: NO.
463 INLINE_GROUPED_CLASSES = NO
468 # namespace, or group documentation), provided this scope is documented. If set
469 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
471 # The default value is: NO.
473 INLINE_SIMPLE_STRUCTS = NO
482 # The default value is: NO.
484 TYPEDEF_HIDES_STRUCT = NO
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
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.
515 # Possible values are: YES, NO, DATETIME and DATE.
516 # The default value is: NO.
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
530 # The default value is: NO.
534 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
536 # The default value is: NO.
538 EXTRACT_PRIVATE = NO
540 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
542 # The default value is: NO.
544 EXTRACT_PRIV_VIRTUAL = NO
546 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
548 # The default value is: NO.
552 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
554 # The default value is: NO.
558 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
559 # locally in source files will be included in the documentation. If set to NO,
560 # only classes defined in header files are included. Does not have any effect
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
570 # The default value is: NO.
574 # If this flag is set to YES, the members of anonymous namespaces will be
579 # The default value is: NO.
581 EXTRACT_ANON_NSPACES = NO
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
592 # members will be included in the various overviews, but no documentation
593 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
594 # The default value is: NO.
596 HIDE_UNDOC_MEMBERS = NO
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
600 # to NO, these classes will be included in the various overviews. This option
601 # will also hide undocumented C++ concepts if enabled. This option has no effect
602 # if EXTRACT_ALL is enabled.
603 # The default value is: NO.
605 HIDE_UNDOC_CLASSES = NO
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
610 # The default value is: NO.
612 HIDE_FRIEND_COMPOUNDS = NO
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
617 # The default value is: NO.
619 HIDE_IN_BODY_DOCS = NO
621 # The INTERNAL_DOCS tag determines if documentation that is typed after a
622 # \internal command is included. If the tag is set to NO then the documentation
624 # The default value is: NO.
626 INTERNAL_DOCS = NO
630 # filesystem is case sensitive (i.e. it supports files in the same directory
632 # deal with such files in case they appear in the input. For filesystems that
633 # are not case sensitive the option should be set to NO to properly deal with
634 # output files written for symbols that only differ in casing, such as for two
636 # references to files without having to specify the exact matching casing. On
638 # to NO, whereas on Linux or other Unix flavors it should typically be set to
640 # Possible values are: SYSTEM, NO and YES.
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
648 # The default value is: NO.
650 HIDE_SCOPE_NAMES = NO
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
655 # The default value is: NO.
657 HIDE_COMPOUND_REFERENCE= NO
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
666 # the files that are included by a file in the documentation of that file.
671 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
674 # The default value is: NO.
678 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include
679 # files with double quotes in the documentation rather than with sharp brackets.
680 # The default value is: NO.
682 FORCE_LOCAL_INCLUDES = NO
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
701 # The default value is: NO.
703 SORT_BRIEF_DOCS = NO
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
713 # The default value is: NO.
715 SORT_MEMBERS_CTORS_1ST = NO
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
720 # The default value is: NO.
724 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
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.
730 # The default value is: NO.
734 # If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper
736 # the prototype and the implementation of a member function even if there is
740 # The default value is: NO.
744 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
748 GENERATE_TODOLIST = NO
750 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
754 GENERATE_TESTLIST = NO
756 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
760 GENERATE_BUGLIST = NO
762 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
770 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
777 # documentation. If the initializer consists of more lines than specified here
786 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
787 # the bottom of the documentation of classes and structs. If set to YES, the
788 # list will mention the files that were used to generate the documentation.
793 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
794 # will remove the Files entry from the Quick Index and from the Folder Tree View
795 # (if specified).
800 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
802 # Folder Tree View (if specified).
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
819 # output files in an output format independent way. To create the layout file
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
832 # the reference definitions. This must be a list of .bib files. The .bib
833 # extension is automatically appended if omitted. This requires the bibtex tool
843 # found.
848 # higher, when running Doxygen from Doxywizard, because in this case any user-
857 #---------------------------------------------------------------------------
859 #---------------------------------------------------------------------------
862 # standard output by Doxygen. If QUIET is set to YES this implies that the
864 # The default value is: NO.
869 # generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES
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
894 # parameters have no documentation without warning.
900 # are documented, but have no documentation for their parameters or return
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
905 # The default value is: NO.
907 WARN_NO_PARAMDOC = NO
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
913 # The default value is: NO.
915 WARN_IF_UNDOC_ENUM_VAL = NO
917 # If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when
918 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
919 # then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
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
922 # like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not
926 # the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
928 # Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
929 # The default value is: NO.
931 WARN_AS_ERROR = NO
937 # be replaced by the version of the file (if it could be obtained via
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 #---------------------------------------------------------------------------
964 # Configuration options related to the input files
965 #---------------------------------------------------------------------------
967 # The INPUT tag is used to specify the files and/or directories that contain
968 # documented source files. You may enter file names like myfile.cpp or
969 # directories like /usr/src/myproject. Separate the files or directories with
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
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.
1009 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1015 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
1028 # be searched for input files as well.
1029 # The default value is: NO.
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
1046 # The default value is: NO.
1048 EXCLUDE_SYMLINKS = NO
1050 # If the value of the INPUT tag contains directories, you can use the
1052 # certain files from those directories.
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
1079 # files are included.
1083 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1084 # searched for input files to be used with the \include or \dontinclude commands
1086 # The default value is: NO.
1090 # The IMAGE_PATH tag can be used to specify one or more files or directories
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
1117 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
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
1130 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1135 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1136 # INPUT_FILTER) will also be used to filter the input files that are used for
1137 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1138 # The default value is: NO.
1140 FILTER_SOURCE_FILES = NO
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
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.
1174 # also VERBATIM_HEADERS is set to NO.
1175 # The default value is: NO.
1177 SOURCE_BROWSER = NO
1180 # multi-line macros, enums or list initialized variables directly into the
1182 # The default value is: NO.
1184 INLINE_SOURCES = NO
1193 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1195 # The default value is: NO.
1197 REFERENCED_BY_RELATION = NO
1199 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1201 # The default value is: NO.
1203 REFERENCES_RELATION = NO
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
1216 # will make the HTML file larger and loading of large files a bit slower, you
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
1240 # The default value is: NO.
1243 USE_HTAGS = NO
1245 # If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a
1247 # specified. Set to NO to disable this.
1253 # If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the
1257 # which Doxygen's built-in parser lacks the necessary type information.
1259 # generated with the -Duse_libclang=ON option for CMake.
1260 # The default value is: NO.
1262 CLANG_ASSISTED_PARSING = NO
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
1274 # the include paths will already be set by Doxygen for the files and directories
1280 # If clang assisted parsing is enabled you can provide the clang parser with the
1284 # options used when the source files were built. This is equivalent to
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
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
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
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
1384 # Doxygen will copy the style sheet files to the output directory.
1385 # Note: The order of the extra style sheet files is of importance (e.g. the last
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
1401 # other source files which should be copied to the HTML output directory. Note
1402 # that these files will be copied to the base HTML output directory. Use the
1403 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1404 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
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
1468 # The default value is: NO.
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:
1513 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1523 # The default value is: NO.
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
1566 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1573 # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1577 # files are now used as the Windows 98 help format, and will replace the old
1579 # HTML files also contain an index, a table of contents, and you can search for
1581 # compressed HTML files.
1582 # The default value is: NO.
1585 GENERATE_HTMLHELP = NO
1588 # file. You can add a path in front of the file if the result should not be
1592 CHM_FILE = NO
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
1603 # (YES) or that it should be included in the main .chm file (NO).
1604 # The default value is: NO.
1607 GENERATE_CHI = NO
1616 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1618 # The default value is: NO.
1625 # The default value is: NO.
1628 TOC_EXPAND = NO
1633 # and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
1634 # is specified no sitemap is generated. For information about the sitemap
1640 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1644 # The default value is: NO.
1647 GENERATE_QHP = NO
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).
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
1705 # generated, together with the HTML files, they form an Eclipse help plugin. To
1707 # Eclipse, the contents of the directory containing the HTML and XML files needs
1711 # The default value is: NO.
1714 GENERATE_ECLIPSEHELP = NO
1717 # the directory name containing the HTML and XML files should also have this
1724 # If you want full control over the layout of the generated HTML pages it might
1727 # of each HTML page. A value of NO enables the index and the value YES disables
1729 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1730 # The default value is: NO.
1733 DISABLE_INDEX = NO
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
1742 # further fine tune the look of the index (see "Fine-tuning the output"). As an
1747 # The default value is: NO.
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
1758 # DISABLE_INDEX is set to NO, this option has no effect.
1759 # The default value is: NO.
1762 FULL_SIDEBAR = NO
1776 # The default value is: NO.
1778 SHOW_ENUM_VALUES = NO
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
1788 # external symbols imported via tag files in a separate window.
1789 # The default value is: NO.
1792 EXT_LINKS_IN_WINDOW = NO
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
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
1833 # The default value is: NO.
1836 USE_MATHJAX = NO
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
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
1883 # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1895 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1929 # The default value is: NO.
1932 SERVER_BASED_SEARCH = NO
1934 # When EXTERNAL_SEARCH tag is enabled Doxygen will no longer generate the PHP
1946 # The default value is: NO.
1949 EXTERNAL_SEARCH = NO
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.
1996 GENERATE_LATEX = NO
1998 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
2029 # generate index for LaTeX. In case there is no backslash (\) as first character
2038 # If the COMPACT_LATEX tag is set to YES, Doxygen generates more compact LaTeX
2041 # The default value is: NO.
2044 COMPACT_LATEX = NO
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
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
2099 # will copy the style sheet files to the output directory.
2100 # Note: The order of the extra style sheet files is of importance (e.g. the last
2108 # other source files which should be copied to the LATEX_OUTPUT output
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
2126 # files. Set this option to YES, to get a higher quality PDF documentation.
2135 # Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
2136 # mode nothing is printed on the terminal, errors are scrolled as if <return> is
2137 # hit at every error; missing files that TeX tries to input or request from
2140 # but there is no possibility of user interaction just like in batch mode,
2141 # SCROLL In scroll mode, TeX will stop only for missing files to input or if
2144 # The default value is: NO.
2147 LATEX_BATCHMODE = NO
2149 # If the LATEX_HIDE_INDICES tag is set to YES then Doxygen will not include the
2151 # The default value is: NO.
2154 LATEX_HIDE_INDICES = NO
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
2179 # The default value is: NO.
2181 GENERATE_RTF = NO
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
2194 # The default value is: NO.
2197 COMPACT_RTF = NO
2199 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2206 # The default value is: NO.
2223 # generated using doxygen -e rtf extensionFile.
2229 # other source files which should be copied to the RTF_OUTPUT output directory.
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
2241 # classes and files.
2242 # The default value is: NO.
2244 GENERATE_MAN = NO
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
2273 # man page(s). These additional files only source the real man page, but without
2275 # The default value is: NO.
2278 MAN_LINKS = NO
2280 #---------------------------------------------------------------------------
2282 #---------------------------------------------------------------------------
2284 # If the GENERATE_XML tag is set to YES, Doxygen will generate an XML file that
2286 # The default value is: NO.
2290 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
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
2309 # The default value is: NO.
2312 XML_NS_MEMB_FILE_SCOPE = NO
2314 #---------------------------------------------------------------------------
2316 #---------------------------------------------------------------------------
2318 # If the GENERATE_DOCBOOK tag is set to YES, Doxygen will generate Docbook files
2320 # The default value is: NO.
2322 GENERATE_DOCBOOK = NO
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
2340 # The default value is: NO.
2342 GENERATE_AUTOGEN_DEF = NO
2344 #---------------------------------------------------------------------------
2346 #---------------------------------------------------------------------------
2348 # If the GENERATE_SQLITE3 tag is set to YES Doxygen will generate a Sqlite3
2349 # database with symbols found by Doxygen stored in tables.
2350 # The default value is: NO.
2352 GENERATE_SQLITE3 = NO
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
2378 # The default value is: NO.
2380 GENERATE_PERLMOD = NO
2382 # If the PERLMOD_LATEX tag is set to YES, Doxygen will generate the necessary
2385 # The default value is: NO.
2388 PERLMOD_LATEX = NO
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
2402 # so different doxyrules.make files included by the same Makefile don't
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
2422 # The default value is: NO.
2427 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2430 # The default value is: NO.
2433 EXPAND_ONLY_PREDEF = NO
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.
2443 # contain include files that are not input files but should be processed by the
2445 # RECURSIVE has no effect here.
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
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
2532 # macro definition that is found in the sources will be used. Use the PREDEFINED
2533 # tag if you want to use a different macro definition that overrules the
2534 # definition found in the source code.
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
2547 SKIP_FUNCTION_MACROS = NO
2549 #---------------------------------------------------------------------------
2551 #---------------------------------------------------------------------------
2553 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2557 # Adding location for the tag files is done as follows:
2561 # of tag files.
2563 # the path). If a tag file is not located in the directory in which Doxygen is
2569 # tag file that is based on the input files it reads. See section "Linking to
2570 # external documentation" for more information about the usage of tag files.
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
2577 # The default value is: NO.
2579 ALLEXTERNALS = NO
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
2609 # set to NO
2610 # The default value is: NO.
2612 HAVE_DOT = NO
2625 # subgraphs. When you want a differently looking font in the dot files that
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
2672 # Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
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
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
2700 # If the UML_LOOK tag is set to YES, Doxygen will generate inheritance and
2703 # The default value is: NO.
2706 UML_LOOK = NO
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
2712 # for no limit. Note that the threshold may be exceeded by 50% before the limit
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
2728 # Possible values are: NO, YES and NONE.
2729 # The default value is: NO.
2732 DOT_UML_DETAILS = NO
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
2746 # The default value is: NO.
2749 TEMPLATE_RELATIONS = NO
2751 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2754 # files. Explicit enabling an include graph, when INCLUDE_GRAPH is set to NO,
2762 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2765 # files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
2766 # to NO, can be accomplished by means of the command \includedbygraph. Disabling
2774 # If the CALL_GRAPH tag is set to YES then Doxygen will generate a call
2781 # The default value is: NO.
2784 CALL_GRAPH = NO
2786 # If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller
2793 # The default value is: NO.
2796 CALLER_GRAPH = NO
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
2808 # files in the directories. Explicit enabling a directory graph, when
2809 # DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
2828 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2829 # to make the SVG files visible in IE 9+ (other browsers do not have this
2839 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2845 # the SVG files visible. Older versions of IE do not have SVG support.
2846 # The default value is: NO.
2849 INTERACTIVE_SVG = NO
2852 # found. If left blank, it is assumed the dot tool can be found in the path.
2858 # contain dot files that are included in the documentation (see the \dotfile
2867 # If left empty dia is assumed to be found in the default search path.
2872 # contain dia files that are included in the documentation (see the \diafile
2879 # to be used. If left blank, it is assumed PlantUML is not used or called during
2890 # When using PlantUML, the specified paths are searched for files specified by
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
2913 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2920 # files in one run (i.e. multiple -o and -T options on the command line). This
2923 # The default value is: NO.
2926 DOT_MULTI_TARGETS = NO
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
2939 # files that are used to generate the various graphs.
2941 # Note: This setting is not only used for dot files but also for msc temporary
2942 # files.
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,
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
2958 # contain msc files that are included in the documentation (see the \mscfile