Lines Matching full: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
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.
124 # doxygen will generate a detailed section even if there is only a brief
131 # inherited members of a class in the documentation of that class as if those
145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158 # path mentioned in the documentation of a class, which tells the reader which
159 # header file to include in order to use a class. If left blank only the name of
174 # first line (until the first dot) of a Javadoc-style comment as the brief
176 # style comments (thus requiring an explicit @brief command for a brief
183 # line (until the first dot) of a Qt-style comment as the brief description. If
185 # requiring an explicit \brief command for a brief description.)
190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192 # a brief description. This used to be the default behavior. The new default is
193 # to treat a multi-line C++ comment block as a detailed description. Set this
208 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
209 # new page for each member. If set to NO, the documentation of a member will be
215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
221 # This tag can be used to specify a number of aliases that act as commands in
227 # documentation, which will result in a user-defined paragraph with heading
233 # This tag can be used to specify a number of word-keyword mappings (TCL only).
234 # A mapping has the form "name=value". For example adding "class=itcl::class"
268 # parses. With this tag you can assign which parser to use for a given
269 # extension. Doxygen has a built-in mapping, but you can override or extend it
270 # using this tag. The format is ext=language, where ext is a file extension, and
279 # Note For files without extension you can use no_extension as a placeholder.
297 # classes, or namespaces to their corresponding documentation. Such a link can
298 # be prevented in individual cases by by putting a % sign in front of the word
305 # to include (a tag file for) the STL sources as input, then you should set this
329 # getter and setter methods for a property. Setting this option to YES will make
330 # doxygen to replace the get and set methods by a property in the documentation.
331 # This will only work if the methods are indeed getting or setting a simple
341 # all members of a group must be documented explicitly.
347 # (for instance a group of public functions) to be put as a subgroup of that
357 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
370 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
376 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
379 # with name TypeT. When disabled the typedef will appear as a member of a file,
390 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
393 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
394 # symbols. At the end of a run doxygen will report the cache usage and suggest
395 # the optimal cache size from a speed point of view.
414 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
426 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
449 # extracted and appear in the documentation as a namespace called
481 # documentation blocks found inside the body of a function. If set to NO these
487 # The INTERNAL_DOCS tag determines if documentation that is typed after a
510 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
511 # the files that are included by a file in the documentation of that file.
529 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
580 # type resolution of all parameters of a function it will reject a match between
581 # the prototype and the implementation of a member function even if there is
582 # only one candidate or it is obvious which candidate to choose by doing a
584 # accept a match between prototype and implementation in such cases.
623 # initial value of a variable or macro / define can have for it to appear in the
625 # it will be hidden. Use a value of 0 to hide initializers completely. The
654 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
664 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
668 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
671 # Note that if you run doxygen from a directory containing a file called
678 # the reference definitions. This must be a list of .bib files. The .bib
716 # in a documented function, or documenting parameters that don't exist or using
740 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
787 # excluded from the INPUT source files. This way you can easily exclude a
788 # subdirectory from a directory tree whose root is specified with the INPUT tag.
796 # directories that are symbolic links (a Unix file system feature) are excluded
813 # output. The symbol name can be a fully qualified name, a word, or if the
814 # wildcard * is used, a substring. Examples: ANamespace, AClass,
850 # The INPUT_FILTER tag can be used to specify a program that doxygen should
867 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
869 # filter if there is a match. The filters are a list of the form: pattern=filter
884 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
885 # it is also possible to disable source filtering for a specific pattern using
886 # *.ext= (so without naming a filter).
891 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
893 # (index.html). This can be useful if you have a project on for instance GitHub
902 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
944 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
945 # source code will show a tooltip with additional information such as prototype,
947 # will make the HTML file larger and loading of large files a bit slower, you
976 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
989 # compounds will be generated. Enable this if the project contains a lot of
1002 # In case all classes in a project start with a common prefix, all classes will
1004 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1019 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1034 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1035 # each generated HTML page. If the tag is left blank doxygen will generate a
1040 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1048 # default header when upgrading to a newer version of doxygen. For a description
1054 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1055 # generated HTML page. If the tag is left blank doxygen will generate a standard
1056 # footer. See HTML_HEADER for more information on how to generate a default
1064 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1066 # the HTML output. If left blank doxygen will generate a default style sheet.
1101 # this color. Hue is specified as an angle on a colorwheel, see
1111 # in the HTML output. For a value of 0 the output will use grayscales only. A
1122 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1148 # such a level that at most the specified number of entries are visible (unless
1149 # a fully collapsed tree already exceeds this amount). So setting the number of
1150 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1151 # representing an infinite number of entries and will result in a full expanded
1161 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1172 # This tag determines the name of the docset feed. A documentation feed provides
1173 # an umbrella under which multiple documentation sets from a single provider
1174 # (such as a company or product suite) can be grouped.
1180 # This tag specifies a string that should uniquely identify the documentation
1181 # set bundle. This should be a reverse domain-name style string, e.g.
1188 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1189 # the documentation publisher. This should be a reverse domain-name style
1204 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1208 # The HTML Help Workshop contains a compiler that can convert all HTML output
1209 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1212 # HTML files also contain an index, a table of contents, and you can search for
1213 # words in the documentation. The HTML workshop also contains a viewer for
1221 # file. You can add a path in front of the file if the result should not be
1235 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1248 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1249 # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
1265 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1296 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1338 # A unique identifier for the Eclipse help plugin. When installing the plugin
1349 # of each HTML page. A value of NO enables the index and the value YES disables
1357 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1359 # value is set to YES, a side panel will be generated containing a tree-like
1361 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1377 # Note that a value of 0 will completely suppress the enum values from appearing
1392 # external symbols imported via tag files in a separate window.
1399 # the HTML documentation. When you change the font size after a successful
1445 # MathJax. However, it is strongly recommended to install a local copy of
1459 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1467 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1471 # there is already a search function so this one should typically be disabled.
1473 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1481 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1489 # implemented using a web server instead of a web client using Javascript. There
1491 # setting. When disabled, doxygen will generate a PHP script for searching and
1516 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1528 # search data is written to a file for indexing by an external tool. With the
1545 # all added to the same external search index. Each project needs to have a
1547 # to a relative location where the documentation can be found. The format is:
1562 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1614 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1616 # chapter. If it is left blank doxygen will generate a standard header. See
1618 # default header to a separate file.
1620 # Note: Only use a user-defined header if you know what you are doing! The
1621 # following commands have a special meaning inside the header: $title,
1630 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1632 # chapter. If it is left blank doxygen will generate a standard footer. See
1633 # LATEX_HEADER for more information on how to generate a default footer and what
1636 # Note: Only use a user-defined footer if you know what you are doing!
1652 # makes the output suitable for online browsing using a PDF viewer.
1659 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1711 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1740 # file, i.e. a series of assignments. You only have to provide replacements,
1750 # similar to doxygen's config file. A template extensions file can be generated
1766 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1768 # it. A directory man3 will be created inside the directory specified by
1776 # man pages. In case the manual section does not start with a number, the number
1810 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1838 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1861 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1878 # formatted so it can be parsed by a human reader. This is useful if you want to
1907 # performed. Macro expansion can be done in a controlled way by setting
1923 # INCLUDE_PATH will be searched if a #include is found.
1946 # gcc). The argument of the tag is a list of macros of the form: name or
1948 # is assumed. To prevent a macro definition from being undefined via #undef or
1956 # tag can be used to specify a list of macro names that should be expanded. The
1958 # tag if you want to use a different macro definition that overrules the
1965 # remove all references to function-like macros that are alone on a line, have
1966 # an all uppercase name, and do not end with a semicolon. Such function macros
1980 # a tag file without this location is as follows:
1987 # Note: Each tag file must have a unique name (where the name does NOT include
1988 # the path). If a tag file is not located in the directory in which doxygen is
1993 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2029 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2055 # and usage relations if the target is undocumented or is not a class.
2062 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2071 # processors available in the system. You can set it explicitly to a value
2079 # When you want a differently looking font in the dot files that doxygen
2081 # sure dot is able to find the font, which can be done by putting it in a
2097 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2103 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2111 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2120 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2128 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2157 # YES then doxygen will generate a graph for each documented file showing the
2166 # set to YES then doxygen will generate a graph for each documented file showing
2174 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2177 # Note that enabling this option will significantly increase the time of a run.
2185 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2188 # Note that enabling this option will significantly increase the time of a run.
2197 # hierarchy of all classes instead of a textual one.
2204 # dependencies a directory has on other directories in a graphical way. The
2226 # Note that this requires a modern browser other than Internet Explorer. Tested
2261 # that will be shown in the graph. If the number of nodes in a graph becomes
2263 # by representing a node as a red box. Note that doxygen if the number of direct
2264 # children of the root node in a graph is already larger than
2266 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2273 # generated by dot. A depth value of 3 means that only nodes reachable from the
2274 # root by following a path via at most 3 edges will be shown. Nodes that lay
2277 # note that the size of a graph can be further restricted by
2278 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2284 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2289 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2305 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page