Lines Matching refs:be

3 # This file describes the settings to be used by the documentation system
6 # All text after a hash (#) is considered a comment and will be ignored
9 # For lists items can also be appended using:
11 # Values that contain spaces should be placed between quotes (" ")
31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
32 # This could be handy for archiving the generated documentation or
51 # base path where the generated documentation will be put.
52 # If a relative path is entered, it will be relative to the location
53 # where doxygen was started. If left blank the current directory will be used.
60 # Enabling this option can be useful when feeding doxygen a huge amount of
89 # brief descriptions will be completely suppressed.
95 # in this list, if found as the leading text of the brief description, will be
124 # operators of the base classes will not be shown.
130 # to NO the shortest path that makes the file name unique will be used.
135 # can be used to strip a user-defined part of the path. Stripping is
137 # the path. The tag can be used to show relative paths in the file list.
140 # relative paths, which will be relative from the directory where doxygen is
145 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
155 # (but less readable) file names. This can be useful if your file system
176 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
178 # comments) as a brief description. This used to be the default behaviour.
192 # be part of the file/class/namespace that contains it.
196 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
201 # This tag can be used to specify a number of aliases that acts
210 # This tag can be used to specify a number of word-keyword mappings (TCL only).
219 # For instance, some of the names that are used will be different. The list
220 # of all members will be omitted, etc.
226 # Java. For instance, namespaces will be presented as packages, qualified
266 # or namespaces to their corresponding documentation. Such a link can be
304 # all members of a group must be documented explicitly.
309 # the same type (for instance a group of public functions) to be put as a
311 # NO to prevent subgrouping. Alternatively, this can be done per class using
324 # unions with only public data fields will be shown inline in the documentation
336 # namespace, or class. And the struct will be named TypeS. This can typically
337 # be useful for C code in case the coding convention dictates that all compound
344 # When the cache is full, less often used symbols will be written to disk.
347 # doxygen to be busy swapping symbols to and from disk most of the time
358 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
360 # their name and scope. Since this can be an expensive process and often the
375 # Private class members and static file members will be hidden unless
381 # will be included in the documentation.
386 # scope will be included in the documentation.
391 # will be included in the documentation.
396 # defined locally in source files will be included in the documentation.
408 # If this flag is set to YES, the members of anonymous namespaces will be
410 # 'anonymous_namespace{file}', where file will be replaced with the base
418 # If set to NO (the default) these members will be included in the
426 # If set to NO (the default) these classes will be included in the various
433 # If set to NO (the default) these declarations will be included in the
440 # If set to NO (the default) these blocks will be appended to the
447 # to NO (the default) then the documentation will be excluded.
462 # documentation. If set to YES the scope will be hidden.
502 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
513 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
515 # NO (the default), the class list will be sorted only by class name,
532 # The GENERATE_TODOLIST tag can be used to enable (YES) or
538 # The GENERATE_TESTLIST tag can be used to enable (YES) or
544 # The GENERATE_BUGLIST tag can be used to enable (YES) or
550 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
556 # The ENABLED_SECTIONS tag can be used to enable conditional
565 # here it will be hidden. Use a value of 0 to hide initializers completely.
567 # documentation can be controlled using \showinitializer or \hideinitializer
590 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
600 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
605 # DoxygenLayout.xml will be used as the name of the layout file.
609 # The CITE_BIB_FILES tag can be used to specify one or more bib files
610 # containing the references data. This must be a list of .bib files. The
612 # requires the bibtex tool to be installed. See also
614 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
624 # The QUIET tag can be used to turn on/off the messages that are generated
629 # The WARNINGS tag can be used to turn on/off the warning messages that are
637 # automatically be disabled.
648 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
658 # tags, which will be replaced by the file and line number from which the
660 # $version, which will be replaced by the version of the file (if it could
661 # be obtained via FILE_VERSION_FILTER)
665 # The WARN_LOGFILE tag can be used to specify a file to which warning
666 # and error messages should be written. If left blank the output is written
675 # The INPUT tag can be used to specify the files and/or directories that contain
682 # This tag can be used to specify the character encoding of the source files
733 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
734 # should be searched for input files as well. Possible values are YES and NO.
739 # The EXCLUDE tag can be used to specify files and/or directories that should be
747 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
761 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
762 # (namespaces, classes, functions, etc.) that should be excluded from the
763 # output. The symbol name can be a fully qualified name, a word, or if the
769 # The EXAMPLE_PATH tag can be used to specify one or more files or
782 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
783 # searched for input files to be used with the \include or \dontinclude
789 # The IMAGE_PATH tag can be used to specify one or more files or
795 # The INPUT_FILTER tag can be used to specify a program that doxygen should
800 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
805 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
815 # INPUT_FILTER) will be used to filter the input files when producing source
820 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
829 # is part of the input, its contents will be placed on the main page (index.html).
830 # This can be useful if you have a project on for instance GitHub and want reuse
840 # be generated. Documented entities will be cross-referenced with these sources.
859 # functions referencing it will be listed.
865 # called/used by that function will be listed.
895 # of all compounds will be generated. Enable this if the project
901 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
902 # in which this list will be split (can be a number in the range [1..20])
907 # classes will be put under the same header in the alphabetical index.
908 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
909 # should be ignored while generating the index headers.
922 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
923 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
924 # put in front of it. If left blank `html' will be used as the default path.
928 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
934 # The HTML_HEADER tag can be used to specify a personal HTML header for
947 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
953 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
954 # style sheet that is used by each HTML page. It can be used to
962 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
972 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
973 # other source files which should be copied to the HTML output directory. Note
974 # that these files will be copied to the base HTML output directory. Use the
977 # the files will be copied as-is; there are no commands or markers available.
1013 # documentation will contain sections that can be hidden and shown after the
1030 # will be generated that can be used as input for Apple's Xcode 3
1045 # can be grouped.
1050 # should uniquely identify the documentation set bundle. This should be a
1057 # identify the documentation publisher. This should be a reverse domain-name
1067 # will be generated that can be used as input for tools like the
1074 # be used to specify the file name of the resulting .chm file. You
1075 # can add a path in front of the file if the result should not be
1081 # be used to specify the location (absolute path including file name) of
1089 # it should be included in the master .chm file (NO).
1105 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1111 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1112 # that can be used as input for Qt's qhelpgenerator to generate a
1118 # be used to specify the file name of the resulting .qch file.
1157 # be used to specify the location of Qt's qhelpgenerator.
1164 # will be generated, which together with the HTML files, form an Eclipse help
1167 # files needs to be copied into the plugins directory of eclipse. The name of
1168 # the directory within the plugins directory should be the same as
1169 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1180 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1189 # structure should be generated to display hierarchical information.
1190 # If the tag value is set to YES, a side panel will be generated
1200 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1207 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1222 # to force them to be regenerated.
1243 # When MathJax is enabled you can set the default output format to be used for
1254 # MATHJAX_RELPATH should be ../mathjax. The default value points to
1261 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1262 # names that should be enabled during MathJax rendering.
1271 # typically be disabled. For large projects the javascript based search engine
1272 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1276 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1281 # enabled the indexing and searching needs to be provided by external tools.
1288 # which needs to be processed by an external indexer. Doxygen will invoke an
1306 # SEARCHDATA_FILE tag the name of this file can be specified.
1311 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1317 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1321 # of to a relative location where the documentation can be found.
1335 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1336 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1337 # put in front of it. If left blank `latex' will be used as the default path.
1341 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1342 # invoked. If left blank `latex' will be used as the default command name.
1349 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1350 # generate index for LaTeX. If left blank `makeindex' will be used as the
1356 # LaTeX documents. This may be useful for small projects and may help to
1361 # The PAPER_TYPE tag can be used to set the paper type that is used
1363 # executive. If left blank a4wide will be used.
1367 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1368 # packages that should be included in the LaTeX output.
1372 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1379 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1393 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1419 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1435 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1436 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1437 # put in front of it. If left blank `rtf' will be used as the default path.
1442 # RTF documents. This may be useful for small projects and may help to
1476 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1477 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1478 # put in front of it. If left blank `man' will be used as the default path.
1491 # would be unable to find the correct page. The default is NO.
1505 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1506 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1507 # put in front of it. If left blank `xml' will be used as the default path.
1511 # The XML_SCHEMA tag can be used to specify an XML schema,
1512 # which can be used by a validating XML parser to check the
1517 # The XML_DTD tag can be used to specify an XML DTD,
1518 # which can be used by a validating XML parser to check the
1555 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1560 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1561 # nicely formatted so it can be parsed by a human reader.  This is useful
1563 # tag is set to NO the size of the Perl module output will be much smaller
1587 # compilation will be performed. Macro expansion can be done in a controlled
1599 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1603 # The INCLUDE_PATH tag can be used to specify one or more directories that
1604 # contain include files that are not input files but should be processed by
1612 # be used.
1616 # The PREDEFINED tag can be used to specify one or more macro names that
1643 # this tag can be used to specify a list of macro names that should be expanded.
1644 # The macro definition that is found in the sources will be used.
1661 # The TAGFILES option can be used to specify one or more tagfiles. For each
1662 # tag file the location of the external documentation should be added. The
1667 # where "loc1" and "loc2" can be relative or absolute paths
1679 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1681 # will be listed.
1685 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1687 # be listed.
1691 # The PERL_PATH should be the absolute path and name of the perl script
1712 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1741 # the font, which can be done by putting it in a standard location or by setting
1747 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1785 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1787 # managable. Set this to 0 for no limit. Note that the threshold may be
1814 # the time of a run. So in most cases it will be better to enable call graphs
1822 # the time of a run. So in most cases it will be better to enable caller
1839 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1841 # If left blank png will be used. If you choose svg you need to set
1847 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1856 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1857 # found. If left blank, it is assumed the dot tool can be found in the path.
1861 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1867 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1873 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1874 # nodes that will be shown in the graph. If the number of nodes in a graph
1878 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1879 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1883 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1885 # from the root by following a path via at most 3 edges will be shown. Nodes
1886 # that lay further from the root node will be omitted. Note that setting this
1888 # code bases. Also note that the size of a graph can be further restricted by