xref: /seL4-master/manual/Doxyfile

10 # doxygen (www.doxygen.org) for a project.
64 # entered, it will be relative to the location where doxygen was started. If
67 OUTPUT_DIRECTORY       = doxygen-output
69 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
72 # option can be useful when feeding doxygen a huge amount of source files, where
79 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
88 # documentation generated by doxygen is written. Doxygen will use this
102 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
109 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
130 # doxygen will generate a detailed section even if there is only a brief
136 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
144 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
154 # If left blank the directory from which doxygen is run is used as the path to
158 # will be relative from the directory where doxygen is started.
172 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
179 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
188 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
196 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
214 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
277 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
282 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
288 # the files are not read by doxygen.
292 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
295 # The output of markdown processing is further processed by doxygen, so you can
296 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
302 # When enabled doxygen tries to link words that correspond to documented
312 # tag to YES in order to let doxygen match functions declarations and
336 # doxygen to replace the get and set methods by a property in the documentation.
345 # tag is set to YES then doxygen will reuse the documentation of the first
403 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
404 # doxygen will become slower. If the cache is too large, memory is wasted. The
407 # symbols. At the end of a run doxygen will report the cache usage and suggest
417 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
470 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
478 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
486 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
493 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
507 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
516 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
523 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
530 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
543 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
555 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
562 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
570 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
582 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
599 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
603 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
673 # doxygen should invoke to get the current version for each file (typically from
677 # by doxygen. Whatever the program writes to standard output is used as the file
683 # by doxygen. The layout file controls the global structure of the generated
685 # that represents doxygen's defaults, run doxygen with the -l option. You can
689 # Note that if you run doxygen from a directory containing a file called
690 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
710 # standard output by doxygen. If QUIET is set to YES this implies that the
717 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
725 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
732 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
742 # value. If set to NO, doxygen will only warn about wrong or incomplete
748 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
754 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
783 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
797 # read by doxygen.
817 # Note that relative paths are relative to the directory from which doxygen is
875 # The INPUT_FILTER tag can be used to specify a program that doxygen should
892 # properly processed by doxygen.
905 # properly processed by doxygen.
927 # and want to reuse the introduction page also for the doxygen output.
950 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
988 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
997 # - Run doxygen as normal
1002 # The result: instead of the source browser generated by doxygen, the links to
1009 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1047 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1068 # each generated HTML page. If the tag is left blank doxygen will generate a
1072 # that doxygen needs, which is dependent on the configuration options used (e.g.
1075 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1078 # for information on how to generate the default header that doxygen normally
1081 # default header when upgrading to a newer version of doxygen. For a description
1088 # generated HTML page. If the tag is left blank doxygen will generate a standard
1092 # that doxygen normally uses.
1099 # the HTML output. If left blank doxygen will generate a default style sheet.
1101 # sheet that doxygen normally uses.
1111 # created by doxygen. Using this option one can overrule certain style aspects.
1164 # to YES can help to show when doxygen was last run and thus if the
1195 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1217 # The default value is: org.doxygen.Project.
1220 DOCSET_BUNDLE_ID       = org.doxygen.Project
1225 # The default value is: org.doxygen.Publisher.
1228 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1236 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1243 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1263 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1316 # The default value is: org.doxygen.Project.
1319 QHP_NAMESPACE          = org.doxygen.Project
1354 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1375 # The default value is: org.doxygen.Project.
1378 ECLIPSE_DOC_ID         = org.doxygen.Project
1399 # sheet generated by doxygen has an example that shows how to put an image at
1409 # doxygen will group on one line in the generated HTML documentation.
1425 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1434 # doxygen run you need to manually remove any form_*.png images from the HTML
1501 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1525 # setting. When disabled, doxygen will generate a PHP script for searching and
1534 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1577 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1591 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1622 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1653 # chapter. If it is left blank doxygen will generate a standard header. See
1654 # section "Doxygen usage" for information on how to let doxygen write the
1669 # chapter. If it is left blank doxygen will generate a standard footer. See
1680 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1706 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1714 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1723 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1730 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1760 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1775 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1795 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1800 # default style sheet that doxygen normally uses.
1806 # similar to doxygen's config file. A template extensions file can be generated
1807 # using doxygen -e rtf extensionFile.
1812 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1826 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1857 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1870 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1884 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1897 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1911 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1924 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1936 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1944 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1974 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1980 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2038 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2062 # the path). If a tag file is not located in the directory in which doxygen is
2067 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2104 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2113 # You can define message sequence charts within doxygen comments using the \msc
2122 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2135 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2144 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2145 # to run in parallel. When set to 0 doxygen will base this on the number of
2154 # When you want a differently looking font in the dot files that doxygen
2171 # By default doxygen will tell dot to use the default font as specified with
2178 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2186 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2195 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2202 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2232 # YES then doxygen will generate a graph for each documented file showing the
2241 # set to YES then doxygen will generate a graph for each documented file showing
2249 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2261 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2273 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2280 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2356 # larger than this value, doxygen will truncate the graph, which is visualized
2357 # by representing a node as a red box. Note that doxygen if the number of direct
2399 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2407 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot

Last Index update Sun Aug 20 00:18:20 CST 2023