Lines Matching +full:created +full:- +full:for
4 # doxygen (www.doxygen.org) for a project.
12 # For lists, items can also be appended using:
19 # doxygen -x [configFile]
23 # doxygen -x_noenv [configFile]
25 #---------------------------------------------------------------------------
27 #---------------------------------------------------------------------------
29 # This tag specifies the encoding used for all characters in the configuration
30 # file that follow. The default is UTF-8 which is also the encoding used for all
32 # iconv built into libc) for the transcoding. See
33 # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
34 # The default value is: UTF-8.
36 DOXYFILE_ENCODING = UTF-8
39 # double-quotes, unless you are using Doxywizard) that should identify the
40 # project for which the documentation is generated. This name is used in the
47 # could be handy for archiving the generated documentation or if some version
53 # for a project that appears at the top of each page and should give viewer a
73 # sub-directories (in 2 levels) under the output directory of each output format
77 # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
78 # control the number of sub-directories.
83 # Controls the number of sub-directories that will be created when
87 # sub-directories are organized in 2 levels, the first level always has a fixed
94 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
95 # characters to appear in the names of generated files. If set to NO, non-ASCII
96 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
106 # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
108 # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
109 # English messages), Korean, Korean-en (Korean with English messages), Latvian,
111 # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
133 # This tag implements a quasi-intelligent brief description abbreviator that is
137 # text. Otherwise, the brief description is used as-is. If left blank, the
176 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
177 # Stripping is only done if one of the specified strings matches the left-hand
188 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
193 # using the -I flag.
199 # support long names like on DOS, Mac, or CD-ROM.
205 # first line (until the first dot) of a Javadoc-style comment as the brief
206 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
207 # style comments (thus requiring an explicit @brief command for a brief
216 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
217 # Javadoc-style will behave just like regular comments and it will not be
224 # line (until the first dot) of a Qt-style comment as the brief description. If
225 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
226 # requiring an explicit \brief command for a brief description.)
232 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
234 # to treat a multi-line C++ comment block as a detailed description. Set this
252 # documentation from any documented member that it re-implements.
258 # page for each member. If set to NO, the documentation of a member will be part
273 # For example adding
276 # documentation, which will result in a user-defined paragraph with heading
282 # with the commands \{ and \} for these it is advised to use the version @{ and
288 # only. Doxygen will then generate output that is more tailored for C. For
297 # for that language. For instance, namespaces will be presented as packages,
304 # sources. Doxygen will then generate output that is tailored for Fortran.
310 # sources. Doxygen will then generate output that is tailored for VHDL.
316 # sources only. Doxygen will then generate output that is more tailored for that
317 # language. For instance, namespaces will be presented as modules, types will be
324 # parses. With this tag you can assign which parser to use for a given
325 # extension. Doxygen has a built-in mapping, but you can override or extend it
328 # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
332 # default for Fortran type files). For instance to make doxygen treat .inc files
336 # Note: For files without extension you can use no_extension as a placeholder.
338 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
346 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
347 # according to the Markdown format, which allows for more readable
348 # documentation. See https://daringfireball.net/projects/markdown/ for details.
356 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
374 # to include (a tag file for) the STL sources as input, then you should set this
397 # For Microsoft's IDL there are propget and propput attributes to indicate
398 # getter and setter methods for a property. Setting this option to YES will make
409 # member in the group (if any) for the other members of the group. By default
423 # (for instance a group of public functions) to be put as a subgroup of that
433 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
446 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
447 # Man pages) or section (for LaTeX and RTF).
457 # useful for C code in case the coding convention dictates that all compound
466 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
489 #---------------------------------------------------------------------------
491 #---------------------------------------------------------------------------
530 # for Java sources.
535 # This flag is only useful for Objective-C code. If set to YES, local methods,
601 # deal with such files in case they appear in the input. For filesystems that
603 # output files written for symbols that only differ in casing, such as for two
628 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
640 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
654 # documentation for inline members.
678 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
680 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
694 # fully-qualified names, including namespaces. If set to NO, the class list will
714 # list. This list is created by putting \todo commands in the documentation.
720 # list. This list is created by putting \test commands in the documentation.
726 # list. This list is created by putting \bug commands in the documentation.
732 # the deprecated list. This list is created by putting \deprecated commands in
745 # initial value of a variable or macro / define can have for it to appear in the
777 # doxygen should invoke to get the current version for each file (typically from
779 # popen()) the command command input-file, where command is the value of the
780 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
782 # version. For an example see the documentation.
789 # that represents doxygen's defaults, run doxygen with the -l option. You can
792 # layout of pages" for information.
803 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
804 # For LaTeX the style of the bibliography can be controlled using
806 # search path. See also \cite for info how to create references.
810 #---------------------------------------------------------------------------
812 #---------------------------------------------------------------------------
831 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
837 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
852 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
853 # are documented, but have no documentation for their parameters or return
873 # at the end of the doxygen process doxygen will return with a non-zero status.
902 # error (stderr). In case the file specified cannot be opened for writing the
903 # warning and error messages are written to standard error. When as file - is
909 #---------------------------------------------------------------------------
911 #---------------------------------------------------------------------------
924 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
925 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
927 # https://www.gnu.org/software/libiconv/) for the list of possible encodings.
929 # The default value is: UTF-8.
931 INPUT_ENCODING = UTF-8
938 # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
939 # "INPUT_ENCODING" for further information on supported encodings.
945 # *.h) to filter out the source-files in the directories.
947 # Note that for custom extensions or not directly supported extensions you also
948 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
958 # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
1001 *.for \
1009 # be searched for input files as well.
1036 # exclude all test directories for example use the pattern */test/*
1059 # *.h) to filter out the source-files in the directories. If left blank all
1065 # searched for input files to be used with the \include or \dontinclude commands
1078 # invoke to filter for each input file. Doxygen will invoke the filter program
1081 # <filter> <input-file>
1083 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1093 # for further processing, therefore nothing else, like debug statements or used
1097 # Note that for custom extensions or not directly supported extensions you also
1098 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1106 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1110 # Note that for custom extensions or not directly supported extensions you also
1111 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1117 # INPUT_FILTER) will also be used to filter the input files that are used for
1124 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1125 # it is also possible to disable source filtering for a specific pattern using
1133 # (index.html). This can be useful if you have a project on for instance GitHub
1134 # and want to reuse the introduction page also for the doxygen output.
1138 # The Fortran standard specifies that for fixed formatted Fortran code all
1147 #---------------------------------------------------------------------------
1149 #---------------------------------------------------------------------------
1152 # generated. Documented entities will be cross-referenced with these sources.
1173 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1179 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1204 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1210 # - Install the latest version of global
1211 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1212 # - Make sure the INPUT points to the root of the source tree
1213 # - Run doxygen as normal
1226 # verbatim copy of the header file for each class for which an include is
1235 # http://clang.llvm.org/) for more accurate parsing at the cost of reduced
1236 # performance. This can be particularly helpful with template rich C++ code for
1237 # which doxygen's built-in parser lacks the necessary type information.
1239 # generated with the -Duse_libclang=ON option for CMake.
1254 # the include paths will already be set by doxygen for the files and directories
1265 # specifying the -p option to a clang tool, such as clang-check. These options
1269 # generated with the -Duse_libclang=ON option for CMake.
1273 #---------------------------------------------------------------------------
1275 #---------------------------------------------------------------------------
1286 # tag works for classes, function and member names. The entity will be placed in
1293 #---------------------------------------------------------------------------
1295 #---------------------------------------------------------------------------
1310 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1311 # generated HTML page (for example: .htm, .php, .asp).
1317 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1325 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1328 # for information on how to generate the default header that doxygen normally
1331 # default header when upgrading to a newer version of doxygen. For a description
1337 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1339 # footer. See HTML_HEADER for more information on how to generate a default
1341 # section "Doxygen usage" for information on how to generate the default footer
1347 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1348 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1350 # See also section "Doxygen usage" for information on how to generate the style
1359 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1361 # created by doxygen. Using this option one can overrule certain style aspects.
1371 # customization is desired it has to be added explicitly. For an example see the
1386 # files will be copied as-is; there are no commands or markers available.
1410 # this color. Hue is specified as an angle on a color-wheel, see
1411 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1420 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1449 # are dynamically created via JavaScript. If disabled, the navigation index will
1480 # generated that can be used as input for Apple's Xcode 3 integrated development
1488 # genXcode/_index.html for more information.
1510 # set bundle. This should be a reverse domain-name style string, e.g.
1518 # the documentation publisher. This should be a reverse domain-name style
1539 # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1545 # HTML files also contain an index, a table of contents, and you can search for
1546 # words in the documentation. The HTML workshop also contains a viewer for
1561 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1589 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1598 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1613 # Project output. For more information please see Qt Help Project / Namespace
1615 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1622 # Help Project output. For more information please see Qt Help Project / Virtual
1624 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1631 # filter to add. For more information please see Qt Help Project / Custom
1633 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1639 # custom filter to add. For more information please see Qt Help Project / Custom
1641 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1648 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1654 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1672 # A unique identifier for the Eclipse help plugin. When installing the plugin
1691 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1693 # value is set to YES, a side panel will be generated containing a tree-like
1694 # index structure (just like the one that is generated for HTML Help). For this
1698 # further fine tune the look of the index (see "Fine-tuning the output"). As an
1712 # https://docs.readthedocs.io with more room for contents, but less room for the
1753 # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1773 # the section "Including formulas" for details.
1778 # https://www.mathjax.org) which uses client side JavaScript for the rendering
1779 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1799 # When MathJax is enabled you can set the default output format to be used for
1800 # the MathJax output. For more details about the output format see MathJax
1802 # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1805 # Possible values are: HTML-CSS (which is slower, but has the best
1806 # compatibility. This is the name for Mathjax version 2, for MathJax version 3
1808 # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1809 # is the name for Mathjax version 3, for MathJax version 2 this will be
1810 # translated into HTML-CSS) and SVG.
1811 # The default value is: HTML-CSS.
1814 MATHJAX_FORMAT = HTML-CSS
1818 # should contain the MathJax.js script. For instance, if the mathjax directory
1824 # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1825 # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1831 # extension names that should be enabled during MathJax rendering. For example
1832 # for MathJax version 2 (see
1833 # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1835 # For example for MathJax version 3 (see
1845 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1851 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1856 # For large projects the javascript based search engine can be slow, then
1875 # setting. When disabled, doxygen will generate a PHP script for searching and
1878 # "External Indexing and Searching" for details.
1885 # script for searching. Instead the search results are written to an XML file
1895 # See the section "External Indexing and Searching" for details.
1907 # https://xapian.org/). See the section "External Indexing and Searching" for
1914 # search data is written to a file for indexing by an external tool. With the
1922 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1939 #---------------------------------------------------------------------------
1941 #---------------------------------------------------------------------------
1961 # chosen this is overwritten by pdflatex. For specific output languages the
1969 # index for LaTeX.
1971 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1979 # generate index for LaTeX. In case there is no backslash (\) as first character
1982 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1989 # documents. This may be useful for small projects and may help to save some
2008 # \usepackage command. To get the times font for instance you can specify :
2017 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
2021 # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
2022 # and then modify the file new_header.tex. See also section "Doxygen usage" for
2025 # Note: Only use a user-defined header if you know what you are doing!
2028 # commands have a special meaning inside the header (and footer): For a
2034 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2037 # LATEX_HEADER for more information on how to generate a default footer and what
2039 # usage" for information on how to generate the default footer that doxygen
2040 # normally uses. Note: Only use a user-defined footer if you know what you are
2046 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2047 # LaTeX style sheets that are included after the standard style sheets created
2059 # directory. Note that the files will be copied as-is; there are no commands or
2066 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2068 # makes the output suitable for online browsing using a PDF viewer.
2078 # See also section LATEX_CMD_NAME for selecting the engine.
2086 # if errors occur, instead of asking the user for help.
2099 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2101 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2123 #---------------------------------------------------------------------------
2125 #---------------------------------------------------------------------------
2128 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
2143 # documents. This may be useful for small projects and may help to save some
2152 # output) instead of page references. This makes the output suitable for online
2166 # See also section "Doxygen usage" for information on how to generate the
2174 # generated using doxygen -e rtf extensionFile.
2179 #---------------------------------------------------------------------------
2181 #---------------------------------------------------------------------------
2183 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2191 # it. A directory man3 will be created inside the directory specified by
2207 # The MAN_SUBDIR tag determines the name of the directory created within
2215 # will generate one additional man file for each entity documented in the real
2223 #---------------------------------------------------------------------------
2225 #---------------------------------------------------------------------------
2242 # listings (including syntax highlighting and cross-referencing information) to
2257 #---------------------------------------------------------------------------
2259 #---------------------------------------------------------------------------
2275 #---------------------------------------------------------------------------
2276 # Configuration options for the AutoGen Definitions output
2277 #---------------------------------------------------------------------------
2287 #---------------------------------------------------------------------------
2289 #---------------------------------------------------------------------------
2325 #---------------------------------------------------------------------------
2327 #---------------------------------------------------------------------------
2330 # C-preprocessor directives found in the sources and include files.
2368 # patterns (like *.h and *.hpp) to filter out the header-files in the
2376 # defined before the preprocessor is started (similar to the -D option of e.g.
2395 # remove all references to function-like macros that are alone on a line, have
2397 # are typically used for boiler-plate code, and will confuse the parser if not
2404 #---------------------------------------------------------------------------
2406 #---------------------------------------------------------------------------
2408 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2412 # Adding location for the tag files is done as follows:
2415 # section "Linking to external documentation" for more information about the use
2425 # external documentation" for more information about the usage of tag files.
2450 #---------------------------------------------------------------------------
2452 #---------------------------------------------------------------------------
2486 # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2489 # For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
2499 # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2508 # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2523 # graph for each documented class showing the direct and indirect inheritance
2525 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
2534 # graph for each documented class showing the direct and indirect implementation
2542 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2562 # number of items for each type to make the size more manageable. Set this to 0
2563 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2574 # tag is set to YES, doxygen will add type and arguments for attributes and
2578 # notation for the relationships.
2603 # YES then doxygen will generate a graph for each documented file showing the
2612 # set to YES then doxygen will generate a graph for each documented file showing
2621 # dependency graph for every global function or class method.
2624 # So in most cases it will be better to enable call graphs for selected
2633 # dependency graph for every global function or class method.
2636 # So in most cases it will be better to enable caller graphs for selected
2668 # generated by dot. For an explanation of the image formats see the section
2687 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2723 # \startuml command in this case and will not generate output for the diagram.
2728 # configuration file for plantuml.
2732 # When using plantuml, the specified paths are searched for files specified by
2753 # or 2 may greatly reduce the computation time needed for large code bases. Also
2762 # files in one run (i.e. multiple -o and -T options on the command line). This
2774 # graphical representation for inheritance and collaboration diagrams is used.
2783 # Note: This setting is not only used for dot files but also for msc temporary