xref: /seL4-master/manual/Doxyfile

10 # doxygen (www.doxygen.org) for a project.
12 # All text after a double hash (##) is considered a comment and is placed in
15 # All text after a single hash (#) is considered a comment and will be ignored.
35 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
38 # title of most generated pages and in a few other places.
43 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
50 # for a project that appears at the top of each page and should give viewer a
55 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
63 # into which the generated documentation will be written. If a relative path is
72 # option can be useful when feeding doxygen a huge amount of source files, where
110 # description of a member or function before the detailed description
118 # This tag implements a quasi-intelligent brief description abbreviator that is
125 # specifies, contains, represents, a, an and the.
130 # doxygen will generate a detailed section even if there is only a brief
137 # inherited members of a class in the documentation of that class as if those
151 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
163 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
164 # path mentioned in the documentation of a class, which tells the reader which
165 # header file to include in order to use a class. If left blank only the name of
180 # first line (until the first dot) of a Javadoc-style comment as the brief
182 # style comments (thus requiring an explicit @brief command for a brief
189 # line (until the first dot) of a Qt-style comment as the brief description. If
191 # requiring an explicit \brief command for a brief description.)
196 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
197 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
198 # a brief description. This used to be the default behavior. The new default is
199 # to treat a multi-line C++ comment block as a detailed description. Set this
214 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
215 # page for each member. If set to NO, the documentation of a member will be part
221 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
227 # This tag can be used to specify a number of aliases that act as commands in
233 # documentation, which will result in a user-defined paragraph with heading
239 # This tag can be used to specify a number of word-keyword mappings (TCL only).
274 # parses. With this tag you can assign which parser to use for a given
275 # extension. Doxygen has a built-in mapping, but you can override or extend it
276 # using this tag. The format is ext=language, where ext is a file extension, and
285 # Note: For files without extension you can use no_extension as a placeholder.
303 # classes, or namespaces to their corresponding documentation. Such a link can
304 # be prevented in individual cases by putting a % sign in front of the word or
311 # to include (a tag file for) the STL sources as input, then you should set this
335 # getter and setter methods for a property. Setting this option to YES will make
336 # doxygen to replace the get and set methods by a property in the documentation.
337 # This will only work if the methods are indeed getting or setting a simple
347 # all members of a group must be documented explicitly.
352 # If one adds a struct or class to a group and this option is enabled, then also
360 # (for instance a group of public functions) to be put as a subgroup of that
370 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
383 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
389 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
391 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
392 # with name TypeT. When disabled the typedef will appear as a member of a file,
403 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
406 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
407 # symbols. At the end of a run doxygen will report the cache usage and suggest
408 # the optimal cache size from a speed point of view.
427 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
439 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
462 # extracted and appear in the documentation as a namespace called
494 # documentation blocks found inside the body of a function. If set to NO, these
500 # The INTERNAL_DOCS tag determines if documentation that is typed after a
524 # append additional text to a page's title, such as Class Reference. If set to
530 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
531 # the files that are included by a file in the documentation of that file.
549 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
600 # type resolution of all parameters of a function it will reject a match between
601 # the prototype and the implementation of a member function even if there is
602 # only one candidate or it is obvious which candidate to choose by doing a
604 # accept a match between prototype and implementation in such cases.
641 # initial value of a variable or macro / define can have for it to appear in the
643 # it will be hidden. Use a value of 0 to hide initializers completely. The
672 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
682 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
686 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
689 # Note that if you run doxygen from a directory containing a file called
696 # the reference definitions. This must be a list of .bib files. The .bib
734 # in a documented function, or documenting parameters that don't exist or using
749 # a warning is encountered.
764 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
814 # excluded from the INPUT source files. This way you can easily exclude a
815 # subdirectory from a directory tree whose root is specified with the INPUT tag.
823 # directories that are symbolic links (a Unix file system feature) are excluded
840 # output. The symbol name can be a fully qualified name, a word, or if the
841 # wildcard * is used, a substring. Examples: ANamespace, AClass,
875 # The INPUT_FILTER tag can be used to specify a program that doxygen should
896 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
898 # filter if there is a match. The filters are a list of the form: pattern=filter
918 # it is also possible to disable source filtering for a specific pattern using
919 # *.ext= (so without naming a filter).
924 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
926 # (index.html). This can be useful if you have a project on for instance GitHub
935 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
977 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
978 # source code will show a tooltip with additional information such as prototype,
980 # will make the HTML file larger and loading of large files a bit slower, you
1009 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1022 # compounds will be generated. Enable this if the project contains a lot of
1035 # In case all classes in a project start with a common prefix, all classes will
1037 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1052 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1067 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1068 # each generated HTML page. If the tag is left blank doxygen will generate a
1073 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1081 # default header when upgrading to a newer version of doxygen. For a description
1087 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1088 # generated HTML page. If the tag is left blank doxygen will generate a standard
1089 # footer. See HTML_HEADER for more information on how to generate a default
1097 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1099 # the HTML output. If left blank doxygen will generate a default style sheet.
1134 # this color. Hue is specified as an angle on a colorwheel, see
1144 # in the HTML output. For a value of 0 the output will use grayscales only. A
1155 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1182 # such a level that at most the specified number of entries are visible (unless
1183 # a fully collapsed tree already exceeds this amount). So setting the number of
1184 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1185 # representing an infinite number of entries and will result in a full expanded
1195 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1207 # an umbrella under which multiple documentation sets from a single provider
1208 # (such as a company or product suite) can be grouped.
1214 # This tag specifies a string that should uniquely identify the documentation
1215 # set bundle. This should be a reverse domain-name style string, e.g.
1222 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1223 # the documentation publisher. This should be a reverse domain-name style
1238 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1242 # The HTML Help Workshop contains a compiler that can convert all HTML output
1243 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1246 # HTML files also contain an index, a table of contents, and you can search for
1247 # words in the documentation. The HTML workshop also contains a viewer for
1255 # file. You can add a path in front of the file if the result should not be
1269 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1282 # The BINARY_TOC flag controls whether a binary table of contents is generated
1283 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1299 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1330 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1391 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1393 # value is set to YES, a side panel will be generated containing a tree-like
1395 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1411 # Note that a value of 0 will completely suppress the enum values from appearing
1426 # external symbols imported via tag files in a separate window.
1433 # the HTML documentation. When you change the font size after a successful
1479 # MathJax. However, it is strongly recommended to install a local copy of
1493 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1501 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1505 # there is already a search function so this one should typically be disabled.
1507 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1515 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1523 # implemented using a web server instead of a web client using Javascript. There
1525 # setting. When disabled, doxygen will generate a PHP script for searching and
1550 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1562 # search data is written to a file for indexing by an external tool. With the
1579 # all added to the same external search index. Each project needs to have a
1581 # to a relative location where the documentation can be found. The format is:
1596 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1651 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1653 # chapter. If it is left blank doxygen will generate a standard header. See
1655 # default header to a separate file.
1657 # Note: Only use a user-defined header if you know what you are doing! The
1658 # following commands have a special meaning inside the header: $title,
1667 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1669 # chapter. If it is left blank doxygen will generate a standard footer. See
1670 # LATEX_HEADER for more information on how to generate a default footer and what
1673 # Note: Only use a user-defined footer if you know what you are doing!
1700 # makes the output suitable for online browsing using a PDF viewer.
1707 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1767 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1796 # file, i.e. a series of assignments. You only have to provide replacements,
1832 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1842 # man pages. In case the manual section does not start with a number, the number
1876 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1904 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1936 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1953 # formatted so it can be parsed by a human reader. This is useful if you want to
1982 # performed. Macro expansion can be done in a controlled way by setting
1998 # INCLUDE_PATH will be searched if a #include is found.
2021 # gcc). The argument of the tag is a list of macros of the form: name or
2023 # is assumed. To prevent a macro definition from being undefined via #undef or
2030 # tag can be used to specify a list of macro names that should be expanded. The
2032 # tag if you want to use a different macro definition that overrules the
2039 # remove all references to function-like macros that are alone on a line, have
2040 # an all uppercase name, and do not end with a semicolon. Such function macros
2054 # a tag file without this location is as follows:
2061 # Note: Each tag file must have a unique name (where the name does NOT include
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
2130 # and usage relations if the target is undocumented or is not a class.
2137 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2146 # processors available in the system. You can set it explicitly to a value
2154 # When you want a differently looking font in the dot files that doxygen
2156 # sure dot is able to find the font, which can be done by putting it in a
2172 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
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
2203 # collaboration diagrams in a style similar to the OMG's Unified Modeling
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
2252 # Note that enabling this option will significantly increase the time of a run.
2254 # functions only using the \callgraph command. Disabling a call graph can be
2261 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2264 # Note that enabling this option will significantly increase the time of a run.
2266 # functions only using the \callergraph command. Disabling a caller graph can be
2274 # hierarchy of all classes instead of a textual one.
2281 # dependencies a directory has on other directories in a graphical way. The
2307 # Note that this requires a modern browser other than Internet Explorer. Tested
2343 # PlantUML is not used or called during a preprocessing step. Doxygen will
2344 # generate a warning when it encounters a \startuml command in this case and
2350 # the !include statement in a plantuml block.
2355 # that will be shown in the graph. If the number of nodes in a graph becomes
2357 # by representing a node as a red box. Note that doxygen if the number of direct
2358 # children of the root node in a graph is already larger than
2360 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2368 # root by following a path via at most 3 edges will be shown. Nodes that lay
2371 # note that the size of a graph can be further restricted by
2372 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2378 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2383 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2399 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page

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