Lines Matching +full:cancel +full:- +full:in +full:- +full:progress

1 # SPDX-FileCopyrightText: Copyright 2022-2024 Arm Limited and/or its affiliates <open-source-office…
3 # SPDX-License-Identifier: Apache-2.0
6 # not use this file except in compliance with the License.
9 # www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
22 # All text after a double hash (##) is considered a comment and is placed in
35 # doxygen -x [configFile]
39 # doxygen -x_noenv [configFile]
41 #---------------------------------------------------------------------------
43 #---------------------------------------------------------------------------
45 # This tag specifies the encoding used for all characters in the configuration
46 # file that follow. The default is UTF-8 which is also the encoding used for all
50 # The default value is: UTF-8.
52 DOXYFILE_ENCODING      = UTF-8
55 # double-quotes, unless you are using Doxywizard) that should identify the
56 # project for which the documentation is generated. This name is used in the
57 # title of most generated pages and in a few other places.
60 PROJECT_NAME           = "CMSIS-NN"
75 # in the documentation. The maximum height of the logo should not exceed 55
89 # sub-directories (in 2 levels) under the output directory of each output format
92 # putting all generated files in the same directory would otherwise causes
94 # control the number of sub-directories.
99 # Controls the number of sub-directories that will be created when
101 # level increment doubles the number of directories, resulting in 4096
103 # sub-directories are organized in 2 levels, the first level always has a fixed
110 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
111 # characters to appear in the names of generated files. If set to NO, non-ASCII
118 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
120 # information to generate all constant output in the proper language.
122 # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
124 # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
125 # English messages), Korean, Korean-en (Korean with English messages), Latvian,
127 # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
134 # descriptions after the members that are listed in the file and class
149 # This tag implements a quasi-intelligent brief description abbreviator that is
150 # used to form the text in various listings. Each string in this list, if found
153 # text. Otherwise, the brief description is used as-is. If left blank, the
178 # inherited members of a class in the documentation of that class as if those
186 # before files name in the file list and in the header files. If set to NO the
192 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
193 # Stripping is only done if one of the specified strings matches the left-hand
194 # part of the path. The tag can be used to show relative paths in the file list.
204 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
205 # path mentioned in the documentation of a class, which tells the reader which
206 # header file to include in order to use a class. If left blank only the name of
209 # using the -I flag.
215 # support long names like on DOS, Mac, or CD-ROM.
221 # first line (until the first dot) of a Javadoc-style comment as the brief
222 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
232 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
233 # Javadoc-style will behave just like regular comments and it will not be
240 # line (until the first dot) of a Qt-style comment as the brief description. If
241 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
248 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
250 # to treat a multi-line C++ comment block as a detailed description. Set this
268 # documentation from any documented member that it re-implements.
280 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
281 # uses this value to replace tabs by spaces in code fragments.
286 # This tag can be used to specify a number of aliases that act as commands in
291 # will allow you to put the command \sideeffect (or @sideeffect) in the
292 # documentation, which will result in a user-defined paragraph with heading
293 # "Side Effects:". Note that you cannot put \n's in the value part of an alias
294 # to insert newlines (in the resulting output). You can put ^^ in the value part
295 # of an alias to insert a newline as if a physical newline was in the original
296 # file. When you need a literal { or } or , in the value part of an alias you
343 # extension. Doxygen has a built-in mapping, but you can override or extend it
346 # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
348 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
364 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
368 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
374 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
375 # to that level are automatically included in the table of contents, even if
385 # be prevented in individual cases by putting a % sign in front of the word or
393 # tag to YES in order to let doxygen match functions declarations and
417 # doxygen to replace the get and set methods by a property in the documentation.
425 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
427 # member in the group (if any) for the other members of the group. By default
450 # are shown inside the group in which they are included (e.g. using \ingroup)
454 # Note that this feature does not work in combination with
461 # with only public data fields or simple typedef fields will be shown inline in
462 # the documentation of the scope in which they are defined (i.e. file,
472 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
475 # useful for C code in case the coding convention dictates that all compound
483 # an expensive process and often the same symbol appears multiple times in the
484 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
496 # cores available in the system. You can set it explicitly to a value larger
501 # encounter. Generating dot graphs in parallel is controlled by the
507 #---------------------------------------------------------------------------
509 #---------------------------------------------------------------------------
511 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
522 # be included in the documentation.
528 # methods of a class will be included in the documentation.
534 # scope will be included in the documentation.
540 # included in the documentation.
546 # locally in source files will be included in the documentation. If set to NO,
547 # only classes defined in header files are included. Does not have any effect
553 # This flag is only useful for Objective-C code. If set to YES, local methods,
554 # which are defined in the implementation section but not in the interface are
555 # included in the documentation. If set to NO, only methods in the interface are
562 # extracted and appear in the documentation as a namespace called
570 # If this flag is set to YES, the name of an unnamed parameter in a declaration
572 # parameters remain unnamed in the output.
579 # members will be included in the various overviews, but no documentation
586 # undocumented classes that are normally visible in the class hierarchy. If set
587 # to NO, these classes will be included in the various overviews. This option
595 # declarations. If set to NO, these declarations will be included in the
616 # able to match the capabilities of the underlying filesystem. In case the
617 # filesystem is case sensitive (i.e. it supports files in the same directory
618 # whose names only differ in casing), the option must be set to YES to properly
619 # deal with such files in case they appear in the input. For filesystems that
621 # output files written for symbols that only differ in casing, such as for two
633 # their full class and namespace scopes in the documentation. If set to YES, the
653 # the files that are included by a file in the documentation of that file.
660 # which file to include in order to use the member.
666 # files with double quotes in the documentation rather than with sharp brackets.
671 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
679 # name. If set to NO, the members will appear in declaration order.
686 # name. If set to NO, the members will appear in declaration order. Note that
687 # this will also influence the order of the classes in the class list.
694 # destructors are listed first. If set to NO the constructors will appear in the
706 # appear in their defined order.
712 # fully-qualified names, including namespaces. If set to NO, the class list will
726 # accept a match between prototype and implementation in such cases.
732 # list. This list is created by putting \todo commands in the documentation.
738 # list. This list is created by putting \test commands in the documentation.
744 # list. This list is created by putting \bug commands in the documentation.
750 # the deprecated list. This list is created by putting \deprecated commands in
763 # initial value of a variable or macro / define can have for it to appear in the
767 # controlled using \showinitializer or \hideinitializer command in the
797 # popen()) the command command input-file, where command is the value of the
798 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
806 # output files in an output format independent way. To create the layout file
807 # that represents doxygen's defaults, run doxygen with the -l option. You can
823 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
828 #---------------------------------------------------------------------------
829 # Configuration options related to warning and progress messages
830 #---------------------------------------------------------------------------
856 # potential errors in the documentation, such as documenting some parameters in
891 # at the end of the doxygen process doxygen will return with a non-zero status.
908 # In the $text part of the WARN_FORMAT command it is possible that a reference
920 # error (stderr). In case the file specified cannot be opened for writing the
921 # warning and error messages are written to standard error. When as file - is
927 #---------------------------------------------------------------------------
929 #---------------------------------------------------------------------------
944 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
949 # The default value is: UTF-8.
951 INPUT_ENCODING         = UTF-8
958 # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
965 # *.h) to filter out the source-files in the directories.
1089 # *.h) to filter out the source-files in the directories. If left blank all
1102 # that contain images that are to be included in the documentation (see the
1111 # <filter> <input-file>
1113 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1124 # commands (so in case of a Windows batch file always use @echo OFF), should be
1177 #---------------------------------------------------------------------------
1179 #---------------------------------------------------------------------------
1182 # generated. Documented entities will be cross-referenced with these sources.
1184 # Note: To get rid of all source code in the generated output, make sure that
1216 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1223 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1234 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1240 # - Install the latest version of global
1241 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1242 # - Make sure the INPUT points to the root of the source tree
1243 # - Run doxygen as normal
1245 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1246 # tools must be available from the command line (i.e. in the search path).
1267 # which doxygen's built-in parser lacks the necessary type information.
1269 # generated with the -Duse_libclang=ON option for CMake.
1295 # specifying the -p option to a clang tool, such as clang-check. These options
1299 # generated with the -Duse_libclang=ON option for CMake.
1303 #---------------------------------------------------------------------------
1305 #---------------------------------------------------------------------------
1316 # tag works for classes, function and member names. The entity will be placed in
1323 #---------------------------------------------------------------------------
1325 #---------------------------------------------------------------------------
1333 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1347 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1355 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1367 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1377 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1378 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1383 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1389 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1396 # style sheet in the list overrules the setting of the previous ones in the
1398 # Note: Since the styling of scrollbars can currently not be overruled in
1414 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1415 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1416 # files will be copied as-is; there are no commands or markers available.
1439 # will adjust the colors in the style sheet and background images according to
1440 # this color. Hue is specified as an angle on a color-wheel, see
1450 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1458 # luminance component of the colors in the HTML output. Values below 100
1480 # consists of multiple levels of tabs that are statically embedded in every HTML
1497 # shown in the various tree structured indices initially; the user can expand
1502 # representing an infinite number of entries and will result in a full expanded
1513 # create a documentation set, doxygen will generate a Makefile in the HTML
1514 # output directory. Running make will produce the docset in that directory and
1515 # running make install will install the docset in
1540 # set bundle. This should be a reverse domain-name style string, e.g.
1548 # the documentation publisher. This should be a reverse domain-name style
1564 # on Windows. In the beginning of 2021 Microsoft took the original page, with
1566 # in maintenance mode). You can download the HTML help workshop from the web
1569 # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1574 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1576 # words in the documentation. The HTML workshop also contains a viewer for
1584 # file. You can add a path in front of the file if the result should not be
1591 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1599 # (YES) or that it should be included in the main .chm file (NO).
1612 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1645 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1654 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1663 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1671 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1678 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1684 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1692 # install this plugin and make it available under the help contents menu in
1714 # it. Since the tabs in the index contain the same information as the navigation
1721 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1723 # value is set to YES, a side panel will be generated containing a tree-like
1728 # further fine tune the look of the index (see "Fine-tuning the output"). As an
1751 # doxygen will group on one line in the generated HTML documentation.
1754 # in the overview section.
1761 # to set the initial width (in pixels) of the frame in which the tree is shown.
1768 # external symbols imported via tag files in a separate window.
1792 # Use this tag to change the font size of LaTeX formulas included as images in
1802 # to create new LaTeX commands to be used in formulas as building blocks. See
1809 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1810 # installed or if you want to formulas look prettier in the HTML output. When
1832 # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1835 # Possible values are: HTML-CSS (which is slower, but has the best
1840 # translated into HTML-CSS) and SVG.
1841 # The default value is: HTML-CSS.
1844 MATHJAX_FORMAT         = HTML-CSS
1854 # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1855 # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1863 # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1875 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1892 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1895 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1953 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1969 #---------------------------------------------------------------------------
1971 #---------------------------------------------------------------------------
1979 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1990 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
2000 # Note: This tag is used in the Makefile / make.bat.
2001 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
2009 # generate index for LaTeX. In case there is no backslash (\) as first character
2010 # it will be automatically added in the LaTeX code.
2011 # Note: This tag is used in the generated output file (.tex).
2012 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
2020 # trees in general.
2036 # that should be included in the LaTeX output. The package can be specified just
2047 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
2051 # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
2055 # Note: Only use a user-defined header if you know what you are doing!
2064 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2070 # normally uses. Note: Only use a user-defined footer if you know what you are
2076 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2081 # style sheet in the list overrules the setting of the previous ones in the
2089 # directory. Note that the files will be copied as-is; there are no commands or
2123 # index chapters (such as File Index, Compound Index, etc.) in the output.
2153 #---------------------------------------------------------------------------
2155 #---------------------------------------------------------------------------
2165 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2174 # trees in general.
2202 # Set optional variables used in the generation of an RTF document. Syntax is
2204 # generated using doxygen -e rtf extensionFile.
2209 #---------------------------------------------------------------------------
2211 #---------------------------------------------------------------------------
2220 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2229 # man pages. In case the manual section does not start with a number, the number
2238 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2245 # will generate one additional man file for each entity documented in the real
2253 #---------------------------------------------------------------------------
2255 #---------------------------------------------------------------------------
2264 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2272 # listings (including syntax highlighting and cross-referencing information) to
2281 # namespace members in file scope as well, matching the HTML output.
2287 #---------------------------------------------------------------------------
2289 #---------------------------------------------------------------------------
2298 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2305 #---------------------------------------------------------------------------
2307 #---------------------------------------------------------------------------
2317 #---------------------------------------------------------------------------
2319 #---------------------------------------------------------------------------
2347 # The names of the make variables in the generated doxyrules.make file are
2348 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2355 #---------------------------------------------------------------------------
2357 #---------------------------------------------------------------------------
2360 # C-preprocessor directives found in the sources and include files.
2366 # in the source code. If set to NO, only conditional compilation will be
2367 # performed. Macro expansion can be done in a controlled way by setting
2382 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2398 # patterns (like *.h and *.hpp) to filter out the header-files in the
2406 # defined before the preprocessor is started (similar to the -D option of e.g.
2417 # macro definition that is found in the sources will be used. Use the PREDEFINED
2419 # definition found in the source code.
2425 # remove all references to function-like macros that are alone on a line, have
2427 # are typically used for boiler-plate code, and will confuse the parser if not
2434 #---------------------------------------------------------------------------
2436 #---------------------------------------------------------------------------
2448 # the path). If a tag file is not located in the directory in which doxygen is
2459 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2467 # in the modules index. If set to NO, only the current project's groups will be
2473 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2480 #---------------------------------------------------------------------------
2482 #---------------------------------------------------------------------------
2484 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2485 # then run dia to produce the diagram and insert it in the documentation. The
2487 # If left empty dia is assumed to be found in the default search path.
2500 # Bell Labs. The other options in this section have no effect if this option is
2507 # to run in parallel. When set to 0 doxygen will base this on the number of
2508 # processors available in the system. You can set it explicitly to a value
2517 # subgraphs. When you want a differently looking font in the dot files that
2521 # to find the font, which can be done by putting it in a standard location or by
2546 # You can set the path where dot can find font specified with fontname in
2554 # relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
2555 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
2574 # in the manual.
2581 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2602 # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2604 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2605 # will not generate fields with class member information in the UML graphs. The
2653 # So in most cases it will be better to enable call graphs for selected
2665 # So in most cases it will be better to enable caller graphs for selected
2681 # dependencies a directory has on other directories in a graphical way. The
2683 # files in the directories.
2690 # of child directories generated in directory dependency graphs by dot.
2698 # output formats in the documentation of the dot tool (Graphviz (see:
2700 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2701 # to make the SVG files visible in IE 9+ (other browsers do not have this
2716 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2724 # found. If left blank, it is assumed the dot tool can be found in the path.
2730 # contain dot files that are included in the documentation (see the \dotfile
2737 # contain msc files that are included in the documentation (see the \mscfile
2743 # contain dia files that are included in the documentation (see the \diafile
2752 # \startuml command in this case and will not generate output for the diagram.
2762 # the !include statement in a plantuml block.
2767 # that will be shown in the graph. If the number of nodes in a graph becomes
2770 # children of the root node in a graph is already larger than
2791 # files in one run (i.e. multiple -o and -T options on the command line). This
2800 # explaining the meaning of the various boxes and arrows in the dot generated