Lines Matching full:doxygen

4 # doxygen (www.doxygen.org) for a project.
22 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
58 # entered, it will be relative to the location where doxygen was started. If
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
66 # option can be useful when feeding doxygen a huge amount of source files, where
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
82 # documentation generated by doxygen is written. Doxygen will use this
97 # documentation generated by doxygen is written. Doxygen will use this
104 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
111 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
132 # doxygen will generate a detailed section even if there is only a brief
138 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
146 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
156 # If left blank the directory from which doxygen is run is used as the path to
160 # will be relative from the directory where doxygen is started.
174 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
181 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
190 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
195 # interpreted by doxygen.
200 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
208 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
220 # By default Python docstrings are displayed as preformatted text and doxygen's
222 # doxygen's special commands can be used and the contents of the docstring
223 # documentation blocks is shown as doxygen documentation.
234 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
241 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
265 # only. Doxygen will then generate output that is more tailored for C. For
273 # Python sources only. Doxygen will then generate output that is more tailored
281 # sources. Doxygen will then generate output that is tailored for Fortran.
287 # sources. Doxygen will then generate output that is tailored for VHDL.
293 # sources only. Doxygen will then generate output that is more tailored for that
300 # Doxygen selects the parser to use depending on the extension of the files it
302 # extension. Doxygen has a built-in mapping, but you can override or extend it
304 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
309 # default for Fortran type files). For instance to make doxygen treat .inc files
316 # the files are not read by doxygen. When specifying no_extension you should add
323 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
326 # The output of markdown processing is further processed by doxygen, so you can
327 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
342 # When enabled doxygen tries to link words that correspond to documented
352 # tag to YES in order to let doxygen match functions declarations and
367 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
376 # doxygen to replace the get and set methods by a property in the documentation.
385 # tag is set to YES then doxygen will reuse the documentation of the first
443 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
444 # doxygen will become slower. If the cache is too large, memory is wasted. The
447 # symbols. At the end of a run doxygen will report the cache usage and suggest
453 # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
454 # during processing. When set to 0 doxygen will based this on the number of
470 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
536 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
544 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
552 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
559 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
573 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
589 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
596 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
603 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
609 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
616 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
628 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
635 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
643 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
655 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
672 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
676 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
746 # doxygen should invoke to get the current version for each file (typically from
747 # the version control system). Doxygen will invoke the program by executing (via
750 # by doxygen. Whatever the program writes to standard output is used as the file
756 # by doxygen. The layout file controls the global structure of the generated
758 # that represents doxygen's defaults, run doxygen with the -l option. You can
762 # Note that if you run doxygen from a directory containing a file called
763 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
783 # standard output by doxygen. If QUIET is set to YES this implies that the
790 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
798 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
805 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
815 # value. If set to NO, doxygen will only warn about wrong or incomplete
822 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
824 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
825 # at the end of the doxygen process doxygen will return with a non-zero status.
831 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
866 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
880 # read by doxygen.
888 # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
904 # Note that relative paths are relative to the directory from which doxygen is
966 # The INPUT_FILTER tag can be used to specify a program that doxygen should
967 # invoke to filter for each input file. Doxygen will invoke the filter program
973 # name of an input file. Doxygen will then use the output that the filter
983 # properly processed by doxygen.
988 # basis. Doxygen will compare the file name with each pattern and apply the
996 # properly processed by doxygen.
1018 # and want to reuse the introduction page also for the doxygen output.
1041 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1079 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1088 # - Run doxygen as normal
1090 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1093 # The result: instead of the source browser generated by doxygen, the links to
1100 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1108 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1112 # which doxygen's built-in parser lacks the necessary type information.
1113 # Note: The availability of this option depends on whether or not doxygen was
1120 # YES then doxygen will add the directory of each input to the include path.
1127 # the include paths will already be set by doxygen for the files and directories
1141 # Note: The availability of this option depends on whether or not doxygen was
1169 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1190 # each generated HTML page. If the tag is left blank doxygen will generate a
1194 # that doxygen needs, which is dependent on the configuration options used (e.g.
1197 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1199 # and then modify the file new_header.html. See also section "Doxygen usage"
1200 # for information on how to generate the default header that doxygen normally
1203 # default header when upgrading to a newer version of doxygen. For a description
1210 # generated HTML page. If the tag is left blank doxygen will generate a standard
1213 # section "Doxygen usage" for information on how to generate the default footer
1214 # that doxygen normally uses.
1221 # the HTML output. If left blank doxygen will generate a default style sheet.
1222 # See also section "Doxygen usage" for information on how to generate the style
1223 # sheet that doxygen normally uses.
1233 # created by doxygen. Using this option one can overrule certain style aspects.
1236 # Doxygen will copy the style sheet files to the output directory.
1254 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1286 # to YES can help to show when doxygen was last run and thus if the
1314 # and collapse entries dynamically later on. Doxygen will expand the tree to
1329 # create a documentation set, doxygen will generate a Makefile in the HTML
1343 # The default value is: Doxygen generated docs.
1346 DOCSET_FEEDNAME        = "Doxygen generated docs"
1350 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1351 # The default value is: org.doxygen.Project.
1354 DOCSET_BUNDLE_ID       = org.doxygen.Project
1359 # The default value is: org.doxygen.Publisher.
1362 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1370 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1377 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1397 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1451 # The default value is: org.doxygen.Project.
1454 QHP_NAMESPACE          = org.doxygen.Project
1489 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1510 # The default value is: org.doxygen.Project.
1513 ECLIPSE_DOC_ID         = org.doxygen.Project
1534 # sheet generated by doxygen has an example that shows how to put an image at
1544 # doxygen will group on one line in the generated HTML documentation.
1560 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1567 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1580 # doxygen run you need to manually remove any form_*.png images from the HTML
1654 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1678 # setting. When disabled, doxygen will generate a PHP script for searching and
1687 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1689 # which needs to be processed by an external indexer. Doxygen will invoke an
1693 # Doxygen ships with an example indexer (doxyindexer) and search engine
1707 # Doxygen ships with an example indexer (doxyindexer) and search engine
1732 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1746 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1791 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1822 # chapter. If it is left blank doxygen will generate a standard header. See
1823 # section "Doxygen usage" for information on how to let doxygen write the
1829 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1838 # chapter. If it is left blank doxygen will generate a standard footer. See
1849 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1875 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1885 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1894 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1901 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1939 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1954 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1974 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1978 # See also section "Doxygen usage" for information on how to generate the
1979 # default style sheet that doxygen normally uses.
1985 # similar to doxygen's configuration file. A template extensions file can be
1986 # generated using doxygen -e rtf extensionFile.
1991 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
2005 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2036 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2049 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2063 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2072 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2083 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2097 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2110 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2122 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2130 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2160 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2166 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2224 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2248 # the path). If a tag file is not located in the directory in which doxygen is
2253 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2284 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2293 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2306 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2315 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2316 # to run in parallel. When set to 0 doxygen will base this on the number of
2325 # When you want a differently looking font in the dot files that doxygen
2342 # By default doxygen will tell dot to use the default font as specified with
2349 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2357 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2366 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2373 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2394 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2396 # tag is set to YES, doxygen will add type and arguments for attributes and
2397 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2425 # YES then doxygen will generate a graph for each documented file showing the
2434 # set to YES then doxygen will generate a graph for each documented file showing
2442 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2454 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2466 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2473 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2538 # PlantUML is not used or called during a preprocessing step. Doxygen will
2556 # larger than this value, doxygen will truncate the graph, which is visualized
2557 # by representing a node as a red box. Note that doxygen if the number of direct
2599 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2607 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate