Lines Matching refs:a
4 # doxygen (www.doxygen.org) for a project.
6 # All text after a double hash (##) is considered a comment and is placed in
9 # All text after a single hash (#) is considered a comment and will be ignored.
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
32 # title of most generated pages and in a few other places.
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
44 # for a project that appears at the top of each page and should give viewer a
49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
57 # into which the generated documentation will be written. If a relative path is
66 # option can be useful when feeding doxygen a huge amount of source files, where
104 # description of a member or function before the detailed description
112 # This tag implements a quasi-intelligent brief description abbreviator that is
119 # specifies, contains, represents, a, an and the.
129 a \
134 # doxygen will generate a detailed section even if there is only a brief
141 # inherited members of a class in the documentation of that class as if those
155 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
167 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
168 # path mentioned in the documentation of a class, which tells the reader which
169 # header file to include in order to use a class. If left blank only the name of
184 # first line (until the first dot) of a Javadoc-style comment as the brief
186 # style comments (thus requiring an explicit @brief command for a brief
192 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
195 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
203 # line (until the first dot) of a Qt-style comment as the brief description. If
205 # requiring an explicit \brief command for a brief description.)
210 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
211 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
212 # a brief description. This used to be the default behavior. The new default is
213 # to treat a multi-line C++ comment block as a detailed description. Set this
236 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
237 # page for each member. If set to NO, the documentation of a member will be part
243 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
249 # This tag can be used to specify a number of aliases that act as commands in
255 # documentation, which will result in a user-defined paragraph with heading
258 # of an alias to insert a newline as if a physical newline was in the original
259 # file. When you need a literal { or } or , in the value part of an alias you
260 # have to escape them by means of a backslash (\), this can lead to conflicts
262 # @} or use a double escape (\\{ and \\})
303 # parses. With this tag you can assign which parser to use for a given
304 # extension. Doxygen has a built-in mapping, but you can override or extend it
305 # using this tag. The format is ext=language, where ext is a file extension, and
315 # Note: For files without extension you can use no_extension as a placeholder.
335 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
345 # classes, or namespaces to their corresponding documentation. Such a link can
346 # be prevented in individual cases by putting a % sign in front of the word or
353 # to include (a tag file for) the STL sources as input, then you should set this
377 # getter and setter methods for a property. Setting this option to YES will make
378 # doxygen to replace the get and set methods by a property in the documentation.
379 # This will only work if the methods are indeed getting or setting a simple
389 # all members of a group must be documented explicitly.
394 # If one adds a struct or class to a group and this option is enabled, then also
402 # (for instance a group of public functions) to be put as a subgroup of that
412 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
425 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
431 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
433 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
434 # with name TypeT. When disabled the typedef will appear as a member of a file,
445 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
448 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
449 # symbols. At the end of a run doxygen will report the cache usage and suggest
450 # the optimal cache size from a speed point of view.
457 # cores available in the system. You can set it explicitly to a value larger
482 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
489 # methods of a class will be included in the documentation.
500 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
523 # extracted and appear in the documentation as a namespace called
555 # documentation blocks found inside the body of a function. If set to NO, these
561 # The INTERNAL_DOCS tag determines if documentation that is typed after a
592 # append additional text to a page's title, such as Class Reference. If set to
598 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
604 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
605 # the files that are included by a file in the documentation of that file.
623 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
674 # type resolution of all parameters of a function it will reject a match between
675 # the prototype and the implementation of a member function even if there is
676 # only one candidate or it is obvious which candidate to choose by doing a
678 # accept a match between prototype and implementation in such cases.
715 # initial value of a variable or macro / define can have for it to appear in the
717 # it will be hidden. Use a value of 0 to hide initializers completely. The
746 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
756 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
760 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
764 # Note that if you run doxygen from a directory containing a file called
771 # the reference definitions. This must be a list of .bib files. The .bib
809 # a documented function twice, or documenting parameters that don't exist or
833 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
835 # at the end of the doxygen process doxygen will return with a non-zero status.
851 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
921 # excluded from the INPUT source files. This way you can easily exclude a
922 # subdirectory from a directory tree whose root is specified with the INPUT tag.
930 # directories that are symbolic links (a Unix file system feature) are excluded
947 # output. The symbol name can be a fully qualified name, a word, or if the
948 # wildcard * is used, a substring. Examples: ANamespace, AClass,
982 # The INPUT_FILTER tag can be used to specify a program that doxygen should
1003 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1005 # filter if there is a match. The filters are a list of the form: pattern=filter
1025 # it is also possible to disable source filtering for a specific pattern using
1026 # *.ext= (so without naming a filter).
1031 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1033 # (index.html). This can be useful if you have a project on for instance GitHub
1042 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1084 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1085 # source code will show a tooltip with additional information such as prototype,
1087 # will make the HTML file larger and loading of large files a bit slower, you
1116 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1152 # path to the directory containing a file called compile_commands.json. This
1156 # specifying the -p option to a clang tool, such as clang-check. These options
1169 # compounds will be generated. Enable this if the project contains a lot of
1175 # In case all classes in a project start with a common prefix, all classes will
1177 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1192 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1207 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1208 # each generated HTML page. If the tag is left blank doxygen will generate a
1213 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1221 # default header when upgrading to a newer version of doxygen. For a description
1227 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1228 # generated HTML page. If the tag is left blank doxygen will generate a standard
1229 # footer. See HTML_HEADER for more information on how to generate a default
1237 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1239 # the HTML output. If left blank doxygen will generate a default style sheet.
1274 # this color. Hue is specified as an angle on a color-wheel, see
1284 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1295 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1312 # documentation will contain a main index with vertical navigation menus that
1333 # such a level that at most the specified number of entries are visible (unless
1334 # a fully collapsed tree already exceeds this amount). So setting the number of
1335 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1336 # representing an infinite number of entries and will result in a full expanded
1347 # create a documentation set, doxygen will generate a Makefile in the HTML
1359 # an umbrella under which multiple documentation sets from a single provider
1360 # (such as a company or product suite) can be grouped.
1366 # This tag specifies a string that should uniquely identify the documentation
1367 # set bundle. This should be a reverse domain-name style string, e.g.
1374 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1375 # the documentation publisher. This should be a reverse domain-name style
1390 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1392 # a.o. the download links, offline the HTML help workshop was already many years
1398 # The HTML Help Workshop contains a compiler that can convert all HTML output
1399 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1402 # HTML files also contain an index, a table of contents, and you can search for
1403 # words in the documentation. The HTML workshop also contains a viewer for
1411 # file. You can add a path in front of the file if the result should not be
1425 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1438 # The BINARY_TOC flag controls whether a binary table of contents is generated
1439 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1455 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1487 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1548 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1550 # value is set to YES, a side panel will be generated containing a tree-like
1552 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1568 # YES). Setting this to YES gives a layout similar to
1580 # Note that a value of 0 will completely suppress the enum values from appearing
1595 # external symbols imported via tag files in a separate window.
1613 # the HTML documentation. When you change the font size after a successful
1683 # MathJax. However, it is strongly recommended to install a local copy of
1703 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1712 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1716 # there is already a search function so this one should typically be disabled.
1718 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1726 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1734 # implemented using a web server instead of a web client using JavaScript. There
1736 # setting. When disabled, doxygen will generate a PHP script for searching and
1762 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1775 # search data is written to a file for indexing by an external tool. With the
1792 # all added to the same external search index. Each project needs to have a
1794 # to a relative location where the documentation can be found. The format is:
1809 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1878 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
1880 # first chapter. If it is left blank doxygen will generate a standard header. It
1881 # is highly recommended to start with a default header using
1886 # Note: Only use a user-defined header if you know what you are doing!
1888 # default header when upgrading to a newer version of doxygen. The following
1889 # commands have a special meaning inside the header (and footer): For a
1895 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
1897 # last chapter. If it is left blank doxygen will generate a standard footer. See
1898 # LATEX_HEADER for more information on how to generate a default footer and what
1901 # normally uses. Note: Only use a user-defined footer if you know what you are
1929 # makes the output suitable for online browsing using a PDF viewer.
1937 # files. Set this option to YES, to get a higher quality PDF documentation.
1977 # path from which the emoji images will be read. If a relative path is entered,
1995 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2024 # configuration file, i.e. a series of assignments. You only have to provide
2050 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2060 # man pages. In case the manual section does not start with a number, the number
2094 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2129 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2152 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2169 # formatted so it can be parsed by a human reader. This is useful if you want to
2198 # performed. Macro expansion can be done in a controlled way by setting
2214 # INCLUDE_PATH will be searched if a #include is found.
2237 # gcc). The argument of the tag is a list of macros of the form: name or
2239 # is assumed. To prevent a macro definition from being undefined via #undef or
2254 # tag can be used to specify a list of macro names that should be expanded. The
2256 # tag if you want to use a different macro definition that overrules the
2263 # remove all references to function-like macros that are alone on a line, have
2264 # an all uppercase name, and do not end with a semicolon. Such function macros
2278 # a tag file without this location is as follows:
2285 # Note: Each tag file must have a unique name (where the name does NOT include
2286 # the path). If a tag file is not located in the directory in which doxygen is
2291 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2322 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2339 # and usage relations if the target is undocumented or is not a class.
2346 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2355 # processors available in the system. You can set it explicitly to a value
2363 # When you want a differently looking font in the dot files that doxygen
2365 # sure dot is able to find the font, which can be done by putting it in a
2381 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2387 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2395 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2404 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2412 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2441 # YES then doxygen will generate a graph for each documented file showing the
2450 # set to YES then doxygen will generate a graph for each documented file showing
2458 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2461 # Note that enabling this option will significantly increase the time of a run.
2463 # functions only using the \callgraph command. Disabling a call graph can be
2470 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2473 # Note that enabling this option will significantly increase the time of a run.
2475 # functions only using the \callergraph command. Disabling a caller graph can be
2483 # hierarchy of all classes instead of a textual one.
2490 # dependencies a directory has on other directories in a graphical way. The
2516 # Note that this requires a modern browser other than Internet Explorer. Tested
2552 # PlantUML is not used or called during a preprocessing step. Doxygen will
2553 # generate a warning when it encounters a \startuml command in this case and
2558 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2564 # the !include statement in a plantuml block.
2569 # that will be shown in the graph. If the number of nodes in a graph becomes
2571 # by representing a node as a red box. Note that doxygen if the number of direct
2572 # children of the root node in a graph is already larger than
2574 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2582 # root by following a path via at most 3 edges will be shown. Nodes that lay
2585 # note that the size of a graph can be further restricted by
2586 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2592 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2597 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2613 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page