Lines Matching full:doxygen

4 # Doxygen (www.doxygen.org) for a project.
18 # Use Doxygen to compare the used configuration file with the template
20 # doxygen -x [configFile]
21 # Use Doxygen to compare the used configuration file with the template
24 # doxygen -x_noenv [configFile]
32 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
61 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
67 # when the HTML document is shown. Doxygen will copy the logo to the output
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
82 # option can be useful when feeding Doxygen a huge amount of source files, where
101 # If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII
110 # documentation generated by Doxygen is written. Doxygen will use this
124 # If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member
131 # If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief
152 # Doxygen will generate a detailed section even if there is only a brief
158 # If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all
166 # If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path
176 # If left blank the directory from which Doxygen is run is used as the path to
180 # will be relative from the directory where Doxygen is started.
194 # If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but
201 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the
210 # If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line
215 # interpreted by Doxygen.
220 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first
228 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a
240 # By default Python docstrings are displayed as preformatted text and Doxygen's
242 # Doxygen's special commands can be used and the contents of the docstring
243 # documentation blocks is shown as Doxygen documentation.
254 # If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new
261 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
300 # only. Doxygen will then generate output that is more tailored for C. For
308 # Python sources only. Doxygen will then generate output that is more tailored
316 # sources. Doxygen will then generate output that is tailored for Fortran.
322 # sources. Doxygen will then generate output that is tailored for VHDL.
328 # sources only. Doxygen will then generate output that is more tailored for that
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
339 # language is one of the parsers supported by Doxygen: IDL, Java, JavaScript,
344 # default for Fortran type files). For instance to make Doxygen treat .inc files
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
361 # The output of markdown processing is further processed by Doxygen, so you can
362 # mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in
380 # Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a
383 # The default value is: DOXYGEN.
386 MARKDOWN_ID_STYLE      = DOXYGEN
388 # When enabled Doxygen tries to link words that correspond to documented
398 # tag to YES in order to let Doxygen match functions declarations and
413 # https://www.riverbankcomputing.com/software) sources only. Doxygen will parse
422 # Doxygen to replace the get and set methods by a property in the documentation.
431 # tag is set to YES then Doxygen will reuse the documentation of the first
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
493 # symbols. At the end of a run Doxygen will report the cache usage and suggest
499 # The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use
500 # during processing. When set to 0 Doxygen will based this on the number of
524 # If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in
590 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
598 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
607 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend
614 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
628 # With the correct setting of option CASE_SENSE_NAMES Doxygen will better be
645 # If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with
652 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will
665 # If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of
671 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
678 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include
690 # If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the
697 # If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief
705 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the
717 # If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy
734 # If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper
738 # simple string match. By disabling STRICT_PROTO_MATCHING Doxygen will still
808 # Doxygen should invoke to get the current version for each file (typically from
809 # the version control system). Doxygen will invoke the program by executing (via
812 # by Doxygen. Whatever the program writes to standard output is used as the file
818 # by Doxygen. The layout file controls the global structure of the generated
820 # that represents Doxygen's defaults, run Doxygen with the -l option. You can
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
848 # higher, when running Doxygen from Doxywizard, because in this case any user-
851 # together with the standard path, the full search path used by doxygen when
862 # standard output by Doxygen. If QUIET is set to YES this implies that the
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
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
901 # value. If set to NO, Doxygen will only warn about wrong parameter
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
917 # If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when
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
933 # The WARN_FORMAT tag determines the format of the warning messages that Doxygen
946 # (outside of Doxygen) the user can define a custom "cut" / "paste" string.
985 # that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
995 # that Doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
996 # character encoding on a per file pattern basis. Doxygen will compare the file
1010 # read by Doxygen.
1019 # be provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
1037 # Note that relative paths are relative to the directory from which Doxygen is
1096 # The INPUT_FILTER tag can be used to specify a program that Doxygen should
1097 # invoke to filter for each input file. Doxygen will invoke the filter program
1103 # name of an input file. Doxygen will then use the output that the filter
1111 # Note that Doxygen will use the data processed and written to standard output
1118 # properly processed by Doxygen.
1123 # basis. Doxygen will compare the file name with each pattern and apply the
1131 # properly processed by Doxygen.
1153 # and want to reuse the introduction page also for the Doxygen output.
1186 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any
1224 # point to the HTML generated by the htags(1) tool instead of Doxygen built-in
1233 # - Run doxygen as normal
1235 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1238 # The result: instead of the source browser generated by Doxygen, the links to
1245 # If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a
1253 # If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the
1257 # which Doxygen's built-in parser lacks the necessary type information.
1258 # Note: The availability of this option depends on whether or not Doxygen was
1265 # tag is set to YES then Doxygen will add the directory of each input to the
1274 # the include paths will already be set by Doxygen for the files and directories
1288 # Note: The availability of this option depends on whether or not Doxygen was
1317 # If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output
1338 # each generated HTML page. If the tag is left blank Doxygen will generate a
1342 # that Doxygen needs, which is dependent on the configuration options used (e.g.
1345 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1347 # and then modify the file new_header.html. See also section "Doxygen usage"
1348 # for information on how to generate the default header that Doxygen normally
1351 # default header when upgrading to a newer version of Doxygen. For a description
1358 # generated HTML page. If the tag is left blank Doxygen will generate a standard
1361 # section "Doxygen usage" for information on how to generate the default footer
1362 # that Doxygen normally uses.
1369 # the HTML output. If left blank Doxygen will generate a default style sheet.
1370 # See also section "Doxygen usage" for information on how to generate the style
1371 # sheet that Doxygen normally uses.
1381 # created by Doxygen. Using this option one can overrule certain style aspects.
1384 # Doxygen will copy the style sheet files to the output directory.
1389 # Webkit/Chromium, the styling will be left out of the default doxygen.css if
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
1408 HTML_EXTRA_FILES       = @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome-darkmode-toggle.js \
1409                          @ZEPHYR_BASE@/doc/_doxygen/doxygen-awesome-zephyr.js
1424 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1480 # If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in
1491 # Doxygen stores a couple of settings persistently in the browser (via e.g.
1493 # Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store
1502 # and collapse entries dynamically later on. Doxygen will expand the tree to
1517 # create a documentation set, Doxygen will generate a Makefile in the HTML
1531 # The default value is: Doxygen generated docs.
1534 DOCSET_FEEDNAME        = "Doxygen generated docs"
1545 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1546 # The default value is: org.doxygen.Project.
1549 DOCSET_BUNDLE_ID       = org.doxygen.Project
1554 # The default value is: org.doxygen.Publisher.
1557 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1565 # If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three
1576 # generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML
1596 # Doxygen will try to run the HTML help compiler on the generated index.hhp.
1660 # The default value is: org.doxygen.Project.
1663 QHP_NAMESPACE          = org.doxygen.Project
1698 # including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to
1719 # The default value is: org.doxygen.Project.
1722 ECLIPSE_DOC_ID         = org.doxygen.Project
1743 # example, the default style sheet generated by Doxygen has an example that
1765 # Doxygen will group on one line in the generated HTML documentation.
1774 # When the SHOW_ENUM_VALUES tag is set doxygen will show the specified
1787 # If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to
1794 # If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email
1801 # If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg
1814 # Doxygen run you need to manually remove any form_*.png images from the HTML
1901 # When the SEARCHENGINE tag is enabled Doxygen will generate a search box for
1925 # setting. When disabled, Doxygen will generate a PHP script for searching and
1934 # When EXTERNAL_SEARCH tag is enabled Doxygen will no longer generate the PHP
1936 # which needs to be processed by an external indexer. Doxygen will invoke an
1940 # Doxygen ships with an example indexer (doxyindexer) and search engine
1954 # Doxygen ships with an example indexer (doxyindexer) and search engine
1979 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through Doxygen
1993 # If the GENERATE_LATEX tag is set to YES, Doxygen will generate LaTeX output.
2038 # If the COMPACT_LATEX tag is set to YES, Doxygen generates more compact LaTeX
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
2072 # and then modify the file new_header.tex. See also section "Doxygen usage" for
2073 # information on how to generate the default header that Doxygen normally uses.
2077 # default header when upgrading to a newer version of Doxygen. The following
2086 # last chapter. If it is left blank Doxygen will generate a standard footer. See
2088 # special commands can be used inside the footer. See also section "Doxygen
2089 # usage" for information on how to generate the default footer that Doxygen
2098 # by Doxygen. Using this option one can overrule certain style aspects. Doxygen
2124 # If the USE_PDFLATEX tag is set to YES, Doxygen will use the engine as
2149 # If the LATEX_HIDE_INDICES tag is set to YES then Doxygen will not include the
2176 # If the GENERATE_RTF tag is set to YES, Doxygen will generate RTF output. The
2191 # If the COMPACT_RTF tag is set to YES, Doxygen generates more compact RTF
2211 # Load stylesheet definitions from file. Syntax is similar to Doxygen's
2215 # See also section "Doxygen usage" for information on how to generate the
2216 # default style sheet that Doxygen normally uses.
2222 # similar to Doxygen's configuration file. A template extensions file can be
2223 # generated using doxygen -e rtf extensionFile.
2240 # If the GENERATE_MAN tag is set to YES, Doxygen will generate man pages for
2271 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, then it
2284 # If the GENERATE_XML tag is set to YES, Doxygen will generate an XML file that
2298 # If the XML_PROGRAMLISTING tag is set to YES, Doxygen will dump the program
2307 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, Doxygen will include
2318 # If the GENERATE_DOCBOOK tag is set to YES, Doxygen will generate Docbook files
2336 # If the GENERATE_AUTOGEN_DEF tag is set to YES, Doxygen will generate an
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.
2363 # database file will be recreated with each Doxygen run. If set to NO, Doxygen
2374 # If the GENERATE_PERLMOD tag is set to YES, Doxygen will generate a Perl module
2382 # If the PERLMOD_LATEX tag is set to YES, Doxygen will generate the necessary
2412 # If the ENABLE_PREPROCESSING tag is set to YES, Doxygen will evaluate all
2418 # If the MACRO_EXPANSION tag is set to YES, Doxygen will expand all macro names
2539 # If the SKIP_FUNCTION_MACROS tag is set to YES then Doxygen's preprocessor will
2563 # the path). If a tag file is not located in the directory in which Doxygen is
2568 # When a file name is specified after GENERATE_TAGFILE, Doxygen will create a
2605 # If you set the HAVE_DOT tag to YES then Doxygen will assume the dot tool is
2614 # The DOT_NUM_THREADS specifies the number of dot invocations Doxygen is allowed
2615 # to run in parallel. When set to 0 Doxygen will base this on the number of
2626 # Doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2660 # If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then Doxygen will
2677 # If the COLLABORATION_GRAPH tag is set to YES then Doxygen will generate a
2689 # If the GROUP_GRAPHS tag is set to YES then Doxygen will generate a graph for
2700 # If the UML_LOOK tag is set to YES, Doxygen will generate inheritance and
2721 # If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and
2723 # tag is set to YES, Doxygen will add type and arguments for attributes and
2724 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, Doxygen
2752 # YES then Doxygen will generate a graph for each documented file showing the
2763 # set to YES then Doxygen will generate a graph for each documented file showing
2774 # If the CALL_GRAPH tag is set to YES then Doxygen will generate a call
2786 # If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller
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
2864 # You can include diagrams made with dia in Doxygen documentation. Doxygen will
2880 # a preprocessing step. Doxygen will generate a warning when it encounters a
2897 # larger than this value, Doxygen will truncate the graph, which is visualized
2928 # If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page
2931 # Note: This tag requires that UML_LOOK isn't set, i.e. the Doxygen internal
2938 # If the DOT_CLEANUP tag is set to YES, Doxygen will remove the intermediate
2947 # You can define message sequence charts within Doxygen comments using the \msc
2948 # command. If the MSCGEN_TOOL tag is left empty (the default), then Doxygen will
2951 # specifying prog as the value, Doxygen will call the tool as prog -T