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
54 # for a project that appears at the top of each page and should give viewer a
59 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
73 # into which the generated documentation will be written. If a relative path is
82 # 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.
157 a \
162 # Doxygen will generate a detailed section even if there is only a brief
169 # inherited members of a class in the documentation of that class as if those
183 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
195 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
196 # path mentioned in the documentation of a class, which tells the reader which
197 # header file to include in order to use a class. If left blank only the name of
212 # first line (until the first dot) of a Javadoc-style comment as the brief
214 # style comments (thus requiring an explicit @brief command for a brief
220 # If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line
223 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
231 # line (until the first dot) of a Qt-style comment as the brief description. If
233 # requiring an explicit \brief command for a brief description.)
238 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a
239 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
240 # a brief description. This used to be the default behavior. The new default is
241 # to treat a multi-line C++ comment block as a detailed description. Set this
264 # If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new
265 # page for each member. If set to NO, the documentation of a member will be part
271 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
277 # This tag can be used to specify a number of aliases that act as commands in
283 # documentation, which will result in a user-defined paragraph with heading
286 # of an alias to insert a newline as if a physical newline was in the original
287 # file. When you need a literal { or } or , in the value part of an alias you
288 # have to escape them by means of a backslash (\), this can lead to conflicts
290 # @} or use a double escape (\\{ and \\})
331 # parses. With this tag you can assign which parser to use for a given
332 # extension. Doxygen has a built-in mapping, but you can override or extend it
333 # using this tag. The format is ext=language, where ext is a file extension, and
343 # Note: For files without extension you can use no_extension as a placeholder.
363 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
375 # Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a
384 # classes, or namespaces to their corresponding documentation. Such a link can
385 # be prevented in individual cases by putting a % sign in front of the word or
392 # to include (a tag file for) the STL sources as input, then you should set this
416 # getter and setter methods for a property. Setting this option to YES will make
417 # Doxygen to replace the get and set methods by a property in the documentation.
418 # This will only work if the methods are indeed getting or setting a simple
428 # all members of a group must be documented explicitly.
433 # If one adds a struct or class to a group and this option is enabled, then also
441 # (for instance a group of public functions) to be put as a subgroup of that
451 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
464 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
470 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
472 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
473 # with name TypeT. When disabled the typedef will appear as a member of a file,
484 # code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small
487 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
488 # symbols. At the end of a run Doxygen will report the cache usage and suggest
489 # the optimal cache size from a speed point of view.
496 # cores available in the system. You can set it explicitly to a value larger
529 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
536 # methods of a class will be included in the documentation.
547 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
570 # extracted and appear in the documentation as a namespace called
578 # If this flag is set to YES, the name of an unnamed parameter in a declaration
610 # documentation blocks found inside the body of a function. If set to NO, these
616 # The INTERNAL_DOCS tag determines if documentation that is typed after a
648 # append additional text to a page's title, such as Class Reference. If set to
654 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
660 # If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of
661 # the files that are included by a file in the documentation of that file.
679 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
730 # type resolution of all parameters of a function it will reject a match between
731 # the prototype and the implementation of a member function even if there is
732 # only one candidate or it is obvious which candidate to choose by doing a
734 # accept a match between prototype and implementation in such cases.
771 # initial value of a variable or macro / define can have for it to appear in the
773 # it will be hidden. Use a value of 0 to hide initializers completely. The
802 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
812 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
816 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
820 # Note that if you run Doxygen from a directory containing a file called
827 # the reference definitions. This must be a list of .bib files. The .bib
881 # a documented function twice, or documenting parameters that don't exist or
913 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
915 # at the end of the Doxygen process Doxygen will return with a non-zero status.
919 # of a run, in case a WARN_LOGFILE is defined the warning messages will be
920 # besides being in the defined file also be shown at the end of a run, unless
939 # In the $text part of the WARN_FORMAT command it is possible that a reference
940 # to a more specific place is given. To make it easier to jump to this place
941 # (outside of Doxygen) the user can define a custom "cut" / "paste" string.
949 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
982 # character encoding on a per file pattern basis. Doxygen will compare the file
984 # INPUT_ENCODING) if there is a match. The character encodings are a list of the
1017 # excluded from the INPUT source files. This way you can easily exclude a
1018 # subdirectory from a directory tree whose root is specified with the INPUT tag.
1026 # directories that are symbolic links (a Unix file system feature) are excluded
1043 # output. The symbol name can be a fully qualified name, a word, or if the
1044 # wildcard * is used, a substring. Examples: ANamespace, AClass,
1075 # The INPUT_FILTER tag can be used to specify a program that Doxygen should
1092 # commands (so in case of a Windows batch file always use @echo OFF), should be
1101 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1103 # filter if there is a match. The filters are a list of the form: pattern=filter
1123 # it is also possible to disable source filtering for a specific pattern using
1124 # *.ext= (so without naming a filter).
1129 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1131 # (index.html). This can be useful if you have a project on for instance GitHub
1149 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1192 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1193 # source code will show a tooltip with additional information such as prototype,
1195 # will make the HTML file larger and loading of large files a bit slower, you
1224 # If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a
1237 # compounds will be generated. Enable this if the project contains a lot of
1243 # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1261 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1276 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1277 # each generated HTML page. If the tag is left blank Doxygen will generate a
1282 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1290 # default header when upgrading to a newer version of Doxygen. For a description
1296 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1297 # generated HTML page. If the tag is left blank Doxygen will generate a standard
1298 # footer. See HTML_HEADER for more information on how to generate a default
1306 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1308 # the HTML output. If left blank Doxygen will generate a default style sheet.
1347 # should be rendered with a dark or light theme.
1352 # dark mode if no preference is set and TOGGLE allows a user to switch between
1353 # light and dark mode via a button.
1361 # this color. Hue is specified as an angle on a color-wheel, see
1371 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1382 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1390 # documentation will contain a main index with vertical navigation menus that
1418 # and the web page is served via a secure context (see:
1426 # Doxygen stores a couple of settings persistently in the browser (via e.g.
1429 # the settings under a project specific key, such that the user preferences will
1438 # such a level that at most the specified number of entries are visible (unless
1439 # a fully collapsed tree already exceeds this amount). So setting the number of
1440 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1441 # representing an infinite number of entries and will result in a full expanded
1452 # create a documentation set, Doxygen will generate a Makefile in the HTML
1464 # an umbrella under which multiple documentation sets from a single provider
1465 # (such as a company or product suite) can be grouped.
1472 # an umbrella under which multiple documentation sets from a single provider
1473 # (such as a company or product suite) can be grouped.
1478 # This tag specifies a string that should uniquely identify the documentation
1479 # set bundle. This should be a reverse domain-name style string, e.g.
1486 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1487 # the documentation publisher. This should be a reverse domain-name style
1502 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1504 # a.o. the download links, offline the HTML help workshop was already many years
1510 # The HTML Help Workshop contains a compiler that can convert all HTML output
1511 # generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML
1514 # HTML files also contain an index, a table of contents, and you can search for
1515 # words in the documentation. The HTML workshop also contains a viewer for
1523 # file. You can add a path in front of the file if the result should not be
1537 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1550 # The BINARY_TOC flag controls whether a binary table of contents is generated
1551 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1577 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1609 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1670 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1672 # value is set to YES, a side panel will be generated containing a tree-like
1674 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1690 # YES). Setting this to YES gives a layout similar to
1702 # Note that a value of 0 will completely suppress the enum values from appearing
1723 # external symbols imported via tag files in a separate window.
1748 # the HTML documentation. When you change the font size after a successful
1807 # MathJax. However, it is strongly recommended to install a local copy of
1827 # The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces
1836 # When the SEARCHENGINE tag is enabled Doxygen will generate a search box for
1840 # there is already a search function so this one should typically be disabled.
1842 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1850 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1858 # implemented using a web server instead of a web client using JavaScript. There
1860 # setting. When disabled, Doxygen will generate a PHP script for searching and
1886 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1899 # search data is written to a file for indexing by an external tool. With the
1916 # all added to the same external search index. Each project needs to have a
1918 # to a relative location where the documentation can be found. The format is:
1933 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
2002 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
2004 # first chapter. If it is left blank Doxygen will generate a standard header. It
2005 # is highly recommended to start with a default header using
2010 # Note: Only use a user-defined header if you know what you are doing!
2012 # default header when upgrading to a newer version of Doxygen. The following
2013 # commands have a special meaning inside the header (and footer): For a
2019 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2021 # last chapter. If it is left blank Doxygen will generate a standard footer. See
2022 # LATEX_HEADER for more information on how to generate a default footer and what
2025 # normally uses. Note: Only use a user-defined footer if you know what you are
2053 # makes the output suitable for online browsing using a PDF viewer.
2061 # files. Set this option to YES, to get a higher quality PDF documentation.
2073 # keyboard input (\read on a not open input stream) cause the job to abort,
2100 # path from which the emoji images will be read. If a relative path is entered,
2118 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2147 # configuration file, i.e. a series of assignments. You only have to provide
2181 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2191 # man pages. In case the manual section does not start with a number, the number
2225 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2260 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2283 # If the GENERATE_SQLITE3 tag is set to YES Doxygen will generate a Sqlite3
2290 # put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2299 # will warn if a database file is already found and not modify it.
2309 # If the GENERATE_PERLMOD tag is set to YES, Doxygen will generate a Perl module
2326 # formatted so it can be parsed by a human reader. This is useful if you want to
2355 # performed. Macro expansion can be done in a controlled way by setting
2371 # INCLUDE_PATH will be searched if a #include is found.
2395 # gcc). The argument of the tag is a list of macros of the form: name or
2397 # is assumed. To prevent a macro definition from being undefined via #undef or
2404 # tag can be used to specify a list of macro names that should be expanded. The
2406 # tag if you want to use a different macro definition that overrules the
2413 # remove all references to function-like macros that are alone on a line, have
2414 # an all uppercase name, and do not end with a semicolon. Such function macros
2428 # a tag file without this location is as follows:
2435 # Note: Each tag file must have a unique name (where the name does NOT include
2436 # the path). If a tag file is not located in the directory in which Doxygen is
2441 # When a file name is specified after GENERATE_TAGFILE, Doxygen will create a
2473 # and usage relations if the target is undocumented or is not a class.
2480 # https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2489 # processors available in the system. You can set it explicitly to a value
2498 # subgraphs. When you want a differently looking font in the dot files that
2500 # For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
2501 # Edge and Graph Attributes specification</a> You need to make sure dot is able
2502 # to find the font, which can be done by putting it in a standard location or by
2511 # add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
2513 # arrows shapes.</a>
2520 # around nodes set 'shape=plain' or 'shape=plaintext' <a
2521 # href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
2534 # generate a graph for each documented class showing the direct and indirect
2541 # graph or choosing a different representation for an inheritance graph of a
2550 # If the COLLABORATION_GRAPH tag is set to YES then Doxygen will generate a
2553 # class with other documented classes. Explicit enabling a collaboration graph,
2555 # command \collaborationgraph. Disabling a collaboration graph can be
2562 # If the GROUP_GRAPHS tag is set to YES then Doxygen will generate a graph for
2563 # groups, showing the direct groups dependencies. Explicit enabling a group
2565 # of the command \groupgraph. Disabling a directory graph can be accomplished by
2574 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2608 # to display on a single line. If the actual line length exceeds this threshold
2625 # YES then Doxygen will generate a graph for each documented file showing the
2636 # set to YES then Doxygen will generate a graph for each documented file showing
2647 # If the CALL_GRAPH tag is set to YES then Doxygen will generate a call
2650 # Note that enabling this option will significantly increase the time of a run.
2652 # functions only using the \callgraph command. Disabling a call graph can be
2659 # If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller
2662 # Note that enabling this option will significantly increase the time of a run.
2664 # functions only using the \callergraph command. Disabling a caller graph can be
2672 # hierarchy of all classes instead of a textual one.
2679 # dependencies a directory has on other directories in a graphical way. The
2681 # files in the directories. Explicit enabling a directory graph, when
2683 # \directorygraph. Disabling a directory graph can be accomplished by means of
2715 # Note that this requires a modern browser other than Internet Explorer. Tested
2753 # a preprocessing step. Doxygen will generate a warning when it encounters a
2758 # When using PlantUML, the PLANTUML_CFG_FILE tag can be used to specify a
2764 # the !include statement in a PlantUML block.
2769 # that will be shown in the graph. If the number of nodes in a graph becomes
2771 # by representing a node as a red box. Note that if the number of direct
2772 # children of the root node in a graph is already larger than
2774 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2782 # root by following a path via at most 3 edges will be shown. Nodes that lay
2785 # note that the size of a graph can be further restricted by
2786 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2801 # If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page
2822 # use a built-in version of mscgen tool to produce the charts. Alternatively,