Lines Matching +full:human +full:- +full:readable +full:- +full:name
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
41 # project for which the documentation is generated. This name is used in the
80 # sub-directories (in 2 levels) under the output directory of each output format
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,
140 # This tag implements a quasi-intelligent brief description abbreviator that is
144 # text. Otherwise, the brief description is used as-is. If left blank, the
145 # following values are used ($name is automatically replaced with the name of
146 # the entity):The $name class, The $name widget, The $name file, is, provides,
167 # before files name in the file list and in the header files. If set to NO the
168 # shortest path that makes the file name unique will be used
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
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.
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.
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-
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
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
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
249 # documentation from any documented member that it re-implements.
269 # name=value
273 # documentation, which will result in a user-defined paragraph with heading
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 …
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,
358 # If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments
359 # according to the Markdown format, which allows for more readable
368 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
382 # with any whitespace replaced by '-' and punctuation characters removed.
476 # enum is documented as struct, union, or enum with the name of the typedef. So
478 # with name TypeT. When disabled the typedef will appear as a member of a file,
481 # types are typedef'ed and only the typedef is referenced, never the tag name.
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
520 #---------------------------------------------------------------------------
522 #---------------------------------------------------------------------------
566 # This flag is only useful for Objective-C code. If set to YES, local methods,
576 # 'anonymous_namespace{file}', where file will be replaced with the base name of
583 # If this flag is set to YES, the name of an unnamed parameter in a declaration
692 # name. If set to NO, the members will appear in declaration order.
699 # name. If set to NO, the members will appear in declaration order. Note that
725 # fully-qualified names, including namespaces. If set to NO, the class list will
726 # be sorted only by class name, not including the namespace part.
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
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
822 # will be used as the name of the layout file. See also section "Changing the
848 # higher, when running Doxygen from Doxywizard, because in this case any user-
857 #---------------------------------------------------------------------------
859 #---------------------------------------------------------------------------
920 # at the end of the Doxygen process Doxygen will return with a non-zero status.
926 # the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
957 # warning and error messages are written to standard error. When as file - is
963 #---------------------------------------------------------------------------
965 #---------------------------------------------------------------------------
986 # that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
991 # The default value is: UTF-8.
993 INPUT_ENCODING = UTF-8
998 # name with each pattern and apply the encoding instead of the default
1000 # form: pattern=encoding (like *.php=ISO-8859-1).
1007 # *.h) to filter out the source-files in the directories.
1062 # output. The symbol name can be a fully qualified name, a word, or if the
1079 # *.h) to filter out the source-files in the directories. If left blank all
1101 # <filter> <input-file>
1103 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1104 # name of an input file. Doxygen will then use the output that the filter
1124 # basis. Doxygen will compare the file name with each pattern and apply the
1128 # patterns match the file name, INPUT_FILTER is applied.
1151 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1167 #---------------------------------------------------------------------------
1169 #---------------------------------------------------------------------------
1172 # generated. Documented entities will be cross-referenced with these sources.
1181 # multi-line macros, enums or list initialized variables directly into the
1225 # point to the HTML generated by the htags(1) tool instead of Doxygen built-in
1231 # - Install the latest version of global
1232 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1233 # - Make sure the INPUT points to the root of the source tree
1234 # - Run doxygen as normal
1258 # which Doxygen's built-in parser lacks the necessary type information.
1260 # generated with the -Duse_libclang=ON option for CMake.
1286 # specifying the -p option to a clang tool, such as clang-check. These options
1290 # generated with the -Duse_libclang=ON option for CMake.
1294 #---------------------------------------------------------------------------
1296 #---------------------------------------------------------------------------
1308 # the alphabetical list under the first letter of the entity name that remains
1314 #---------------------------------------------------------------------------
1316 #---------------------------------------------------------------------------
1338 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1346 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1358 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1368 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1369 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1380 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1396 HTML_EXTRA_STYLESHEET = @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome.css \
1397 @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome-sidebar-only.css \
1398 … @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome-sidebar-only-darkmode-toggle.css \
1399 @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome-zephyr.css
1405 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1406 # files will be copied as-is; there are no commands or markers available.
1409 HTML_EXTRA_FILES = @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome-darkmode-toggle.js \
1410 @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome-zephyr.js
1427 # this color. Hue is specified as an angle on a color-wheel, see
1437 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1485 # https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file:
1529 # This tag determines the name of the docset feed. A documentation feed provides
1545 # set bundle. This should be a reverse domain-name style string, e.g.
1546 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1553 # the documentation publisher. This should be a reverse domain-name style
1574 # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1588 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1596 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1651 # the file name of the resulting .qch file. The path specified is relative to
1660 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1669 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1675 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1678 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1686 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1693 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1699 # including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to
1709 # to be copied into the plugins directory of eclipse. The name of the directory
1718 # the directory name containing the HTML and XML files should also have this
1719 # name. Each documentation set should have its own identifier.
1736 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1738 # value is set to YES, a side panel will be generated containing a tree-like
1743 # further fine tune the look of the index (see "Fine-tuning the output"). As an
1830 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1853 # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1856 # Possible values are: HTML-CSS (which is slower, but has the best
1857 # compatibility. This is the name for Mathjax version 2, for MathJax version 3
1860 # is the name for Mathjax version 3, for MathJax version 2 this will be
1861 # translated into HTML-CSS) and SVG.
1862 # The default value is: HTML-CSS.
1865 MATHJAX_FORMAT = HTML-CSS
1875 # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1876 # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1884 # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1896 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1966 # SEARCHDATA_FILE tag the name of this file can be specified.
1990 #---------------------------------------------------------------------------
1992 #---------------------------------------------------------------------------
2007 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
2019 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
2029 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
2058 # by its name or with the correct syntax as to be used with the LaTeX
2068 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
2072 # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
2076 # Note: Only use a user-defined header if you know what you are doing!
2085 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2091 # normally uses. Note: Only use a user-defined footer if you know what you are
2097 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2110 # directory. Note that the files will be copied as-is; there are no commands or
2173 #---------------------------------------------------------------------------
2175 #---------------------------------------------------------------------------
2224 # generated using doxygen -e rtf extensionFile.
2231 # Note that the files will be copied as-is; there are no commands or markers
2237 #---------------------------------------------------------------------------
2239 #---------------------------------------------------------------------------
2265 # The MAN_SUBDIR tag determines the name of the directory created within
2281 #---------------------------------------------------------------------------
2283 #---------------------------------------------------------------------------
2300 # listings (including syntax highlighting and cross-referencing information) to
2315 #---------------------------------------------------------------------------
2317 #---------------------------------------------------------------------------
2333 #---------------------------------------------------------------------------
2335 #---------------------------------------------------------------------------
2345 #---------------------------------------------------------------------------
2347 #---------------------------------------------------------------------------
2371 #---------------------------------------------------------------------------
2373 #---------------------------------------------------------------------------
2392 # formatted so it can be parsed by a human reader. This is useful if you want to
2409 #---------------------------------------------------------------------------
2411 #---------------------------------------------------------------------------
2414 # C-preprocessor directives found in the sources and include files.
2452 # patterns (like *.h and *.hpp) to filter out the header-files in the
2460 # defined before the preprocessor is started (similar to the -D option of e.g.
2461 # gcc). The argument of the tag is a list of macros of the form: name or
2462 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2541 # remove all references to function-like macros that are alone on a line, have
2542 # an all uppercase name, and do not end with a semicolon. Such function macros
2543 # are typically used for boiler-plate code, and will confuse the parser if not
2550 #---------------------------------------------------------------------------
2552 #---------------------------------------------------------------------------
2563 # Note: Each tag file must have a unique name (where the name does NOT include
2569 # When a file name is specified after GENERATE_TAGFILE, Doxygen will create a
2596 #---------------------------------------------------------------------------
2598 #---------------------------------------------------------------------------
2666 # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2921 # files in one run (i.e. multiple -o and -T options on the command line). This
2950 # use a built-in version of mscgen tool to produce the charts. Alternatively,
2951 # the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
2952 # specifying prog as the value, Doxygen will call the tool as prog -T
2953 # <outfile_format> -o <outputfile> <inputfile>. The external tool should support