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
68 # entered, it will be relative to the location where doxygen was started. If
73 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
76 # option can be useful when feeding doxygen a huge amount of source files, where
95 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
104 # documentation generated by doxygen is written. Doxygen will use this
118 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
125 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
156 # doxygen will generate a detailed section even if there is only a brief
162 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
170 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
180 # If left blank the directory from which doxygen is run is used as the path to
184 # will be relative from the directory where doxygen is started.
198 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
205 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
214 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
219 # interpreted by doxygen.
224 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
232 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
244 # By default Python docstrings are displayed as preformatted text and doxygen's
246 # doxygen's special commands can be used and the contents of the docstring
247 # documentation blocks is shown as doxygen documentation.
258 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
265 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
289 # only. Doxygen will then generate output that is more tailored for C. For
297 # Python sources only. Doxygen will then generate output that is more tailored
305 # sources. Doxygen will then generate output that is tailored for Fortran.
311 # sources. Doxygen will then generate output that is tailored for VHDL.
317 # sources only. Doxygen will then generate output that is more tailored for that
324 # Doxygen selects the parser to use depending on the extension of the files it
326 # extension. Doxygen has a built-in mapping, but you can override or extend it
328 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
333 # default for Fortran type files). For instance to make doxygen treat .inc files
340 # the files are not read by doxygen. When specifying no_extension you should add
347 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
350 # The output of markdown processing is further processed by doxygen, so you can
351 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
366 # When enabled doxygen tries to link words that correspond to documented
376 # tag to YES in order to let doxygen match functions declarations and
391 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
400 # doxygen to replace the get and set methods by a property in the documentation.
409 # tag is set to YES then doxygen will reuse the documentation of the first
467 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
468 # doxygen will become slower. If the cache is too large, memory is wasted. The
471 # symbols. At the end of a run doxygen will report the cache usage and suggest
477 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
478 # during processing. When set to 0 doxygen will based this on the number of
494 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
560 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
568 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
577 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
584 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
598 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
615 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
622 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
635 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
641 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
648 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
660 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
667 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
675 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
687 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
704 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
708 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
778 # doxygen should invoke to get the current version for each file (typically from
779 # the version control system). Doxygen will invoke the program by executing (via
782 # by doxygen. Whatever the program writes to standard output is used as the file
788 # by doxygen. The layout file controls the global structure of the generated
790 # that represents doxygen's defaults, run doxygen with the -l option. You can
795 # Note that if you run doxygen from a directory containing a file called
796 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
816 # standard output by doxygen. If QUIET is set to YES this implies that the
823 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
831 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
838 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
846 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
847 # function parameter documentation. If set to NO, doxygen will accept that some
855 # value. If set to NO, doxygen will only warn about wrong parameter
863 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
864 # undocumented enumeration values. If set to NO, doxygen will accept
871 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
873 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
874 # at the end of the doxygen process doxygen will return with a non-zero status.
880 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
893 # (outside of doxygen) the user can define a custom "cut" / "paste" string.
923 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
933 # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
934 # character encoding on a per file pattern basis. Doxygen will compare the file
948 # read by doxygen.
956 # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
975 # Note that relative paths are relative to the directory from which doxygen is
1034 # The INPUT_FILTER tag can be used to specify a program that doxygen should
1035 # invoke to filter for each input file. Doxygen will invoke the filter program
1041 # name of an input file. Doxygen will then use the output that the filter
1049 # Note that doxygen will use the data processed and written to standard output
1056 # properly processed by doxygen.
1061 # basis. Doxygen will compare the file name with each pattern and apply the
1069 # properly processed by doxygen.
1091 # and want to reuse the introduction page also for the doxygen output.
1123 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1161 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1170 # - Run doxygen as normal
1172 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1175 # The result: instead of the source browser generated by doxygen, the links to
1182 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1214 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1235 # each generated HTML page. If the tag is left blank doxygen will generate a
1239 # that doxygen needs, which is dependent on the configuration options used (e.g.
1242 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1244 # and then modify the file new_header.html. See also section "Doxygen usage"
1245 # for information on how to generate the default header that doxygen normally
1248 # default header when upgrading to a newer version of doxygen. For a description
1255 # generated HTML page. If the tag is left blank doxygen will generate a standard
1258 # section "Doxygen usage" for information on how to generate the default footer
1259 # that doxygen normally uses.
1266 # the HTML output. If left blank doxygen will generate a default style sheet.
1267 # See also section "Doxygen usage" for information on how to generate the style
1268 # sheet that doxygen normally uses.
1278 # created by doxygen. Using this option one can overrule certain style aspects.
1281 # Doxygen will copy the style sheet files to the output directory.
1286 # Webkit/Chromium, the styling will be left out of the default doxygen.css if
1317 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1349 # to YES can help to show when doxygen was last run and thus if the
1377 # and collapse entries dynamically later on. Doxygen will expand the tree to
1392 # create a documentation set, doxygen will generate a Makefile in the HTML
1406 # The default value is: Doxygen generated docs.
1409 DOCSET_FEEDNAME        = "Doxygen generated docs"
1420 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1421 # The default value is: org.doxygen.Project.
1424 DOCSET_BUNDLE_ID       = org.doxygen.Project
1429 # The default value is: org.doxygen.Publisher.
1432 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1440 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1451 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1471 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1525 # The default value is: org.doxygen.Project.
1528 QHP_NAMESPACE          = org.doxygen.Project
1563 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1584 # The default value is: org.doxygen.Project.
1587 ECLIPSE_DOC_ID         = org.doxygen.Project
1608 # example, the default style sheet generated by doxygen has an example that
1630 # doxygen will group on one line in the generated HTML documentation.
1646 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1653 # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1660 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1673 # doxygen run you need to manually remove any form_*.png images from the HTML
1760 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1784 # setting. When disabled, doxygen will generate a PHP script for searching and
1793 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1795 # which needs to be processed by an external indexer. Doxygen will invoke an
1799 # Doxygen ships with an example indexer (doxyindexer) and search engine
1813 # Doxygen ships with an example indexer (doxyindexer) and search engine
1838 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1852 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1897 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1928 # first chapter. If it is left blank doxygen will generate a standard header. It
1930 # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
1931 # and then modify the file new_header.tex. See also section "Doxygen usage" for
1932 # information on how to generate the default header that doxygen normally uses.
1936 # default header when upgrading to a newer version of doxygen. The following
1945 # last chapter. If it is left blank doxygen will generate a standard footer. See
1947 # special commands can be used inside the footer. See also section "Doxygen
1948 # usage" for information on how to generate the default footer that doxygen
1957 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1983 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1993 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
2001 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2036 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2051 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2071 # Load stylesheet definitions from file. Syntax is similar to doxygen's
2075 # See also section "Doxygen usage" for information on how to generate the
2076 # default style sheet that doxygen normally uses.
2082 # similar to doxygen's configuration file. A template extensions file can be
2083 # generated using doxygen -e rtf extensionFile.
2092 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2123 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2136 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2150 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2159 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2170 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2188 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2200 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2208 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2238 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2244 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2303 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2327 # the path). If a tag file is not located in the directory in which doxygen is
2332 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2363 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2376 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2385 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2386 # to run in parallel. When set to 0 doxygen will base this on the number of
2397 # doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2431 # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
2442 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2451 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2459 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2480 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2482 # tag is set to YES, doxygen will add type and arguments for attributes and
2483 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2511 # YES then doxygen will generate a graph for each documented file showing the
2520 # set to YES then doxygen will generate a graph for each documented file showing
2528 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2540 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2552 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2559 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2630 # a preprocessing step. Doxygen will generate a warning when it encounters a
2647 # larger than this value, doxygen will truncate the graph, which is visualized
2648 # by representing a node as a red box. Note that doxygen if the number of direct
2678 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2681 # Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
2688 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate