Lines Matching refs: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]
68 # entered, it will be relative to the location where doxygen was started. If
71 OUTPUT_DIRECTORY       = doc/build/doxygen
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
146 # doxygen will generate a detailed section even if there is only a brief
152 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
160 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
170 # If left blank the directory from which doxygen is run is used as the path to
174 # will be relative from the directory where doxygen is started.
188 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
195 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
204 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
209 # interpreted by doxygen.
214 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
222 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
234 # By default Python docstrings are displayed as preformatted text and doxygen's
236 # doxygen's special commands can be used and the contents of the docstring
237 # documentation blocks is shown as doxygen documentation.
248 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
319 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
324 # default for Fortran type files). For instance to make doxygen treat .inc files
331 # the files are not read by doxygen. When specifying no_extension you should add
338 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
341 # The output of markdown processing is further processed by doxygen, so you can
342 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
357 # When enabled doxygen tries to link words that correspond to documented
367 # tag to YES in order to let doxygen match functions declarations and
391 # doxygen to replace the get and set methods by a property in the documentation.
400 # tag is set to YES then doxygen will reuse the documentation of the first
458 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
459 # doxygen will become slower. If the cache is too large, memory is wasted. The
462 # symbols. At the end of a run doxygen will report the cache usage and suggest
468 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
469 # during processing. When set to 0 doxygen will based this on the number of
485 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
551 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
559 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
568 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
575 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
589 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
606 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
613 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
626 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
639 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
651 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
658 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
666 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
678 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
695 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
699 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
769 # doxygen should invoke to get the current version for each file (typically from
773 # by doxygen. Whatever the program writes to standard output is used as the file
779 # by doxygen. The layout file controls the global structure of the generated
781 # that represents doxygen's defaults, run doxygen with the -l option. You can
786 # Note that if you run doxygen from a directory containing a file called
787 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
790 LAYOUT_FILE            = doxygen-theme/DoxygenLayout.xml
807 # standard output by doxygen. If QUIET is set to YES this implies that the
814 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
822 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
829 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
837 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
838 # function parameter documentation. If set to NO, doxygen will accept that some
846 # value. If set to NO, doxygen will only warn about wrong parameter
854 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
855 # undocumented enumeration values. If set to NO, doxygen will accept
862 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
864 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
865 # at the end of the doxygen process doxygen will return with a non-zero status.
871 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
884 # (outside of doxygen) the user can define a custom "cut" / "paste" string.
915 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
925 # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
940 # read by doxygen.
948 # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
964 # Note that relative paths are relative to the directory from which doxygen is
1022 # The INPUT_FILTER tag can be used to specify a program that doxygen should
1037 # Note that doxygen will use the data processed and written to standard output
1044 # properly processed by doxygen.
1057 # properly processed by doxygen.
1079 # and want to reuse the introduction page also for the doxygen output.
1111 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1149 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1158 # - Run doxygen as normal
1163 # The result: instead of the source browser generated by doxygen, the links to
1170 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1202 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1223 # each generated HTML page. If the tag is left blank doxygen will generate a
1227 # that doxygen needs, which is dependent on the configuration options used (e.g.
1230 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1233 # for information on how to generate the default header that doxygen normally
1236 # default header when upgrading to a newer version of doxygen. For a description
1243 # generated HTML page. If the tag is left blank doxygen will generate a standard
1247 # that doxygen normally uses.
1254 # the HTML output. If left blank doxygen will generate a default style sheet.
1256 # sheet that doxygen normally uses.
1266 # created by doxygen. Using this option one can overrule certain style aspects.
1274 # Webkit/Chromium, the styling will be left out of the default doxygen.css if
1280 HTML_EXTRA_STYLESHEET  = doxygen-theme/customdoxygen.css
1337 # to YES can help to show when doxygen was last run and thus if the
1380 # create a documentation set, doxygen will generate a Makefile in the HTML
1409 # The default value is: org.doxygen.Project.
1412 DOCSET_BUNDLE_ID       = org.doxygen.Project
1417 # The default value is: org.doxygen.Publisher.
1420 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1428 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1439 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1459 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1513 # The default value is: org.doxygen.Project.
1516 QHP_NAMESPACE          = org.doxygen.Project
1551 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1572 # The default value is: org.doxygen.Project.
1575 ECLIPSE_DOC_ID         = org.doxygen.Project
1596 # example, the default style sheet generated by doxygen has an example that
1618 # doxygen will group on one line in the generated HTML documentation.
1634 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1641 # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1648 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1661 # doxygen run you need to manually remove any form_*.png images from the HTML
1748 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1772 # setting. When disabled, doxygen will generate a PHP script for searching and
1781 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1826 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1840 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1885 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1916 # first chapter. If it is left blank doxygen will generate a standard header. It
1918 # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
1920 # information on how to generate the default header that doxygen normally uses.
1924 # default header when upgrading to a newer version of doxygen. The following
1933 # last chapter. If it is left blank doxygen will generate a standard footer. See
1936 # usage" for information on how to generate the default footer that doxygen
1945 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1971 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1981 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1989 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2024 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2039 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2059 # Load stylesheet definitions from file. Syntax is similar to doxygen's
2064 # default style sheet that doxygen normally uses.
2070 # similar to doxygen's configuration file. A template extensions file can be
2071 # generated using doxygen -e rtf extensionFile.
2080 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2111 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2124 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2138 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2147 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2158 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2176 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2188 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2196 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2226 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2232 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2293 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2317 # the path). If a tag file is not located in the directory in which doxygen is
2322 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2353 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2366 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2375 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2376 # to run in parallel. When set to 0 doxygen will base this on the number of
2387 # doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2421 # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
2432 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2441 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2449 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2470 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2472 # tag is set to YES, doxygen will add type and arguments for attributes and
2473 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2501 # YES then doxygen will generate a graph for each documented file showing the
2510 # set to YES then doxygen will generate a graph for each documented file showing
2518 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2530 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2542 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2549 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2637 # larger than this value, doxygen will truncate the graph, which is visualized
2638 # by representing a node as a red box. Note that doxygen if the number of direct
2668 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2671 # Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
2678 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate