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.
39 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
42 # title of most generated pages and in a few other places.
47 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
56 # for a project that appears at the top of each page and should give viewer a
63 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
71 # into which the generated documentation will be written. If a relative path is
80 # option can be useful when feeding doxygen a huge amount of source files, where
94 # sub-directories are organized in 2 levels, the first level always has a fixed
132 # description of a member or function before the detailed description
140 # This tag implements a quasi-intelligent brief description abbreviator that is
147 # specifies, contains, represents, a, an and the.
152 # doxygen will generate a detailed section even if there is only a brief
159 # inherited members of a class in the documentation of that class as if those
173 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
185 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
186 # path mentioned in the documentation of a class, which tells the reader which
187 # header file to include in order to use a class. If left blank only the name of
202 # first line (until the first dot) of a Javadoc-style comment as the brief
204 # style comments (thus requiring an explicit @brief command for a brief
210 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
213 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
221 # line (until the first dot) of a Qt-style comment as the brief description. If
223 # requiring an explicit \brief command for a brief description.)
228 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
229 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
230 # a brief description. This used to be the default behavior. The new default is
231 # to treat a multi-line C++ comment block as a detailed description. Set this
254 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
255 # page for each member. If set to NO, the documentation of a member will be part
261 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
267 # This tag can be used to specify a number of aliases that act as commands in
273 # documentation, which will result in a user-defined paragraph with heading
276 # of an alias to insert a newline as if a physical newline was in the original
277 # file. When you need a literal { or } or , in the value part of an alias you
278 # have to escape them by means of a backslash (\), this can lead to conflicts
280 # @} or use a double escape (\\{ and \\})
324 # parses. With this tag you can assign which parser to use for a given
325 # extension. Doxygen has a built-in mapping, but you can override or extend it
326 # using this tag. The format is ext=language, where ext is a file extension, and
336 # Note: For files without extension you can use no_extension as a placeholder.
356 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
366 # classes, or namespaces to their corresponding documentation. Such a link can
367 # be prevented in individual cases by putting a % sign in front of the word or
374 # to include (a tag file for) the STL sources as input, then you should set this
398 # getter and setter methods for a property. Setting this option to YES will make
399 # doxygen to replace the get and set methods by a property in the documentation.
400 # This will only work if the methods are indeed getting or setting a simple
410 # all members of a group must be documented explicitly.
415 # If one adds a struct or class to a group and this option is enabled, then also
423 # (for instance a group of public functions) to be put as a subgroup of that
433 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
446 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
452 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
454 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
455 # with name TypeT. When disabled the typedef will appear as a member of a file,
466 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
469 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
470 # symbols. At the end of a run doxygen will report the cache usage and suggest
471 # the optimal cache size from a speed point of view.
478 # cores available in the system. You can set it explicitly to a value larger
503 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
510 # methods of a class will be included in the documentation.
521 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
544 # extracted and appear in the documentation as a namespace called
552 # If this flag is set to YES, the name of an unnamed parameter in a declaration
584 # documentation blocks found inside the body of a function. If set to NO, these
590 # The INTERNAL_DOCS tag determines if documentation that is typed after a
622 # append additional text to a page's title, such as Class Reference. If set to
628 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
634 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
635 # the files that are included by a file in the documentation of that file.
653 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
704 # type resolution of all parameters of a function it will reject a match between
705 # the prototype and the implementation of a member function even if there is
706 # only one candidate or it is obvious which candidate to choose by doing a
708 # accept a match between prototype and implementation in such cases.
745 # initial value of a variable or macro / define can have for it to appear in the
747 # it will be hidden. Use a value of 0 to hide initializers completely. The
776 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
786 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
790 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
794 # Note that if you run doxygen from a directory containing a file called
801 # the reference definitions. This must be a list of .bib files. The .bib
839 # a documented function twice, or documenting parameters that don't exist or
871 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
873 # at the end of the doxygen process doxygen will return with a non-zero status.
890 # In the $text part of the WARN_FORMAT command it is possible that a reference
891 # to a more specific place is given. To make it easier to jump to this place
892 # (outside of doxygen) the user can define a custom "cut" / "paste" string.
900 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
944 # character encoding on a per file pattern basis. Doxygen will compare the file
946 # INPUT_ENCODING) if there is a match. The character encodings are a list of the
980 # excluded from the INPUT source files. This way you can easily exclude a
981 # subdirectory from a directory tree whose root is specified with the INPUT tag.
989 # directories that are symbolic links (a Unix file system feature) are excluded
1006 # output. The symbol name can be a fully qualified name, a word, or if the
1007 # wildcard * is used, a substring. Examples: ANamespace, AClass,
1041 # The INPUT_FILTER tag can be used to specify a program that doxygen should
1058 # commands (so in case of a Windows batch file always use @echo OFF), should be
1067 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1069 # filter if there is a match. The filters are a list of the form: pattern=filter
1089 # it is also possible to disable source filtering for a specific pattern using
1090 # *.ext= (so without naming a filter).
1095 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1097 # (index.html). This can be useful if you have a project on for instance GitHub
1115 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1157 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1158 # source code will show a tooltip with additional information such as prototype,
1160 # will make the HTML file larger and loading of large files a bit slower, you
1189 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1202 # compounds will be generated. Enable this if the project contains a lot of
1208 # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1226 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1241 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1242 # each generated HTML page. If the tag is left blank doxygen will generate a
1247 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1255 # default header when upgrading to a newer version of doxygen. For a description
1261 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1262 # generated HTML page. If the tag is left blank doxygen will generate a standard
1263 # footer. See HTML_HEADER for more information on how to generate a default
1271 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1273 # the HTML output. If left blank doxygen will generate a default style sheet.
1312 # should be rendered with a dark or light theme.
1318 # light and dark mode via a button.
1326 # this color. Hue is specified as an angle on a color-wheel, see
1336 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1347 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1364 # documentation will contain a main index with vertical navigation menus that
1385 # such a level that at most the specified number of entries are visible (unless
1386 # a fully collapsed tree already exceeds this amount). So setting the number of
1387 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1388 # representing an infinite number of entries and will result in a full expanded
1399 # create a documentation set, doxygen will generate a Makefile in the HTML
1411 # an umbrella under which multiple documentation sets from a single provider
1412 # (such as a company or product suite) can be grouped.
1419 # an umbrella under which multiple documentation sets from a single provider
1420 # (such as a company or product suite) can be grouped.
1425 # This tag specifies a string that should uniquely identify the documentation
1426 # set bundle. This should be a reverse domain-name style string, e.g.
1433 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1434 # the documentation publisher. This should be a reverse domain-name style
1449 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1451 # a.o. the download links, offline the HTML help workshop was already many years
1457 # The HTML Help Workshop contains a compiler that can convert all HTML output
1458 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1461 # HTML files also contain an index, a table of contents, and you can search for
1462 # words in the documentation. The HTML workshop also contains a viewer for
1470 # file. You can add a path in front of the file if the result should not be
1484 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1497 # The BINARY_TOC flag controls whether a binary table of contents is generated
1498 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1514 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1546 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1609 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1611 # value is set to YES, a side panel will be generated containing a tree-like
1613 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1629 # YES). Setting this to YES gives a layout similar to
1641 # Note that a value of 0 will completely suppress the enum values from appearing
1656 # external symbols imported via tag files in a separate window.
1681 # the HTML documentation. When you change the font size after a successful
1740 # MathJax. However, it is strongly recommended to install a local copy of
1760 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1769 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1773 # there is already a search function so this one should typically be disabled.
1775 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1783 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1791 # implemented using a web server instead of a web client using JavaScript. There
1793 # setting. When disabled, doxygen will generate a PHP script for searching and
1819 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1832 # search data is written to a file for indexing by an external tool. With the
1849 # all added to the same external search index. Each project needs to have a
1851 # to a relative location where the documentation can be found. The format is:
1866 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1935 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
1937 # first chapter. If it is left blank doxygen will generate a standard header. It
1938 # is highly recommended to start with a default header using
1943 # Note: Only use a user-defined header if you know what you are doing!
1945 # default header when upgrading to a newer version of doxygen. The following
1946 # commands have a special meaning inside the header (and footer): For a
1952 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
1954 # last chapter. If it is left blank doxygen will generate a standard footer. See
1955 # LATEX_HEADER for more information on how to generate a default footer and what
1958 # normally uses. Note: Only use a user-defined footer if you know what you are
1986 # makes the output suitable for online browsing using a PDF viewer.
1994 # files. Set this option to YES, to get a higher quality PDF documentation.
2034 # path from which the emoji images will be read. If a relative path is entered,
2052 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2081 # configuration file, i.e. a series of assignments. You only have to provide
2107 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2117 # man pages. In case the manual section does not start with a number, the number
2151 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2186 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2209 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2226 # formatted so it can be parsed by a human reader. This is useful if you want to
2255 # performed. Macro expansion can be done in a controlled way by setting
2271 # INCLUDE_PATH will be searched if a #include is found.
2295 # gcc). The argument of the tag is a list of macros of the form: name or
2297 # is assumed. To prevent a macro definition from being undefined via #undef or
2307 # tag can be used to specify a list of macro names that should be expanded. The
2309 # tag if you want to use a different macro definition that overrules the
2316 # remove all references to function-like macros that are alone on a line, have
2317 # an all uppercase name, and do not end with a semicolon. Such function macros
2331 # a tag file without this location is as follows:
2338 # Note: Each tag file must have a unique name (where the name does NOT include
2339 # the path). If a tag file is not located in the directory in which doxygen is
2344 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2385 # and usage relations if the target is undocumented or is not a class.
2392 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2401 # processors available in the system. You can set it explicitly to a value
2410 # subgraphs. When you want a differently looking font in the dot files that
2412 # For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
2413 # Edge and Graph Attributes specification</a> You need to make sure dot is able
2414 # to find the font, which can be done by putting it in a standard location or by
2423 # add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
2425 # arrows shapes.</a>
2432 # around nodes set 'shape=plain' or 'shape=plaintext' <a
2433 # href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
2445 # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
2456 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2465 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2474 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2508 # to display on a single line. If the actual line length exceeds this threshold
2525 # YES then doxygen will generate a graph for each documented file showing the
2534 # set to YES then doxygen will generate a graph for each documented file showing
2542 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2545 # Note that enabling this option will significantly increase the time of a run.
2547 # functions only using the \callgraph command. Disabling a call graph can be
2554 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2557 # Note that enabling this option will significantly increase the time of a run.
2559 # functions only using the \callergraph command. Disabling a caller graph can be
2567 # hierarchy of all classes instead of a textual one.
2574 # dependencies a directory has on other directories in a graphical way. The
2607 # Note that this requires a modern browser other than Internet Explorer. Tested
2644 # a preprocessing step. Doxygen will generate a warning when it encounters a
2649 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2655 # the !include statement in a plantuml block.
2660 # that will be shown in the graph. If the number of nodes in a graph becomes
2662 # by representing a node as a red box. Note that doxygen if the number of direct
2663 # children of the root node in a graph is already larger than
2665 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2673 # root by following a path via at most 3 edges will be shown. Nodes that lay
2676 # note that the size of a graph can be further restricted by
2677 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2692 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page