Lines Matching full: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.
143 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
153 # (but less readable) file names. This can be useful if your file system
174 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
176 # comments) as a brief description. This used to be the default behaviour.
190 # be part of the file/class/namespace that contains it.
194 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
199 # This tag can be used to specify a number of aliases that acts
208 # This tag can be used to specify a number of word-keyword mappings (TCL only).
217 # For instance, some of the names that are used will be different. The list
218 # of all members will be omitted, etc.
224 # Java. For instance, namespaces will be presented as packages, qualified
285 # all members of a group must be documented explicitly.
290 # the same type (for instance a group of public functions) to be put as a
292 # NO to prevent subgrouping. Alternatively, this can be done per class using
305 # unions with only public data fields will be shown inline in the documentation
317 # namespace, or class. And the struct will be named TypeS. This can typically
318 # be useful for C code in case the coding convention dictates that all compound
325 # When the cache is full, less often used symbols will be written to disk.
328 # doxygen to be busy swapping symbols to and from disk most of the time
339 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
341 # their name and scope. Since this can be an expensive process and often the
356 # Private class members and static file members will be hidden unless
362 # will be included in the documentation.
367 # will be included in the documentation.
372 # defined locally in source files will be included in the documentation.
384 # If this flag is set to YES, the members of anonymous namespaces will be
386 # 'anonymous_namespace{file}', where file will be replaced with the base
394 # If set to NO (the default) these members will be included in the
402 # If set to NO (the default) these classes will be included in the various
409 # If set to NO (the default) these declarations will be included in the
416 # If set to NO (the default) these blocks will be appended to the
423 # to NO (the default) then the documentation will be excluded.
438 # documentation. If set to YES the scope will be hidden.
478 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
489 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
491 # NO (the default), the class list will be sorted only by class name,
508 # The GENERATE_TODOLIST tag can be used to enable (YES) or
514 # The GENERATE_TESTLIST tag can be used to enable (YES) or
520 # The GENERATE_BUGLIST tag can be used to enable (YES) or
526 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
532 # The ENABLED_SECTIONS tag can be used to enable conditional
540 # here it will be hidden. Use a value of 0 to hide initializers completely.
542 # documentation can be controlled using \showinitializer or \hideinitializer
571 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
581 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
586 # DoxygenLayout.xml will be used as the name of the layout file.
590 # The CITE_BIB_FILES tag can be used to specify one or more bib files
591 # containing the references data. This must be a list of .bib files. The
593 # requires the bibtex tool to be installed. See also
595 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
604 # The QUIET tag can be used to turn on/off the messages that are generated
609 # The WARNINGS tag can be used to turn on/off the warning messages that are
617 # automatically be disabled.
628 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
638 # tags, which will be replaced by the file and line number from which the
640 # $version, which will be replaced by the version of the file (if it could
641 # be obtained via FILE_VERSION_FILTER)
645 # The WARN_LOGFILE tag can be used to specify a file to which warning
646 # and error messages should be written. If left blank the output is written
655 # The INPUT tag can be used to specify the files and/or directories that contain
667 # This tag can be used to specify the character encoding of the source files
689 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
690 # should be searched for input files as well. Possible values are YES and NO.
695 # The EXCLUDE tag can be used to specify files and/or directories that should be
703 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
717 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
718 # (namespaces, classes, functions, etc.) that should be excluded from the
719 # output. The symbol name can be a fully qualified name, a word, or if the
725 # The EXAMPLE_PATH tag can be used to specify one or more files or
738 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
739 # searched for input files to be used with the \include or \dontinclude
745 # The IMAGE_PATH tag can be used to specify one or more files or
751 # The INPUT_FILTER tag can be used to specify a program that doxygen should
756 # to standard output. If FILTER_PATTERNS is specified, this tag will be
761 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
771 # INPUT_FILTER) will be used to filter the input files when producing source
776 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
789 # be generated. Documented entities will be cross-referenced with these sources.
808 # functions referencing it will be listed.
814 # called/used by that function will be listed.
844 # of all compounds will be generated. Enable this if the project
850 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
851 # in which this list will be split (can be a number in the range [1..20])
856 # classes will be put under the same header in the alphabetical index.
857 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
858 # should be ignored while generating the index headers.
871 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
872 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
873 # put in front of it. If left blank `html' will be used as the default path.
877 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
883 # The HTML_HEADER tag can be used to specify a personal HTML header for
896 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
902 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
903 # style sheet that is used by each HTML page. It can be used to
907 # style sheet in the HTML output directory as well, or it will be erased!
911 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
912 # other source files which should be copied to the HTML output directory. Note
913 # that these files will be copied to the base HTML output directory. Use the
916 # the files will be copied as-is; there are no commands or markers available.
952 # files or namespaces will be aligned in HTML using tables. If set to
953 # NO a bullet list will be used.
958 # documentation will contain sections that can be hidden and shown after the
966 # will be generated that can be used as input for Apple's Xcode 3
981 # can be grouped.
986 # should uniquely identify the documentation set bundle. This should be a
993 # the documentation publisher. This should be a reverse domain-name style
1003 # will be generated that can be used as input for tools like the
1010 # be used to specify the file name of the resulting .chm file. You
1011 # can add a path in front of the file if the result should not be
1017 # be used to specify the location (absolute path including file name) of
1025 # it should be included in the master .chm file (NO).
1041 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1047 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1048 # that can be used as input for Qt's qhelpgenerator to generate a
1054 # be used to specify the file name of the resulting .qch file.
1093 # be used to specify the location of Qt's qhelpgenerator.
1100 # will be generated, which together with the HTML files, form an Eclipse help
1103 # files needs to be copied into the plugins directory of eclipse. The name of
1104 # the directory within the plugins directory should be the same as
1105 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1116 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1125 # structure should be generated to display hierarchical information.
1126 # If the tag value is set to YES, a side panel will be generated
1136 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1148 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1163 # to force them to be regenerated.
1188 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
1195 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1196 # names that should be enabled during MathJax rendering.
1205 # typically be disabled. For large projects the javascript based search engine
1206 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1210 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1229 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1230 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1231 # put in front of it. If left blank `latex' will be used as the default path.
1235 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1236 # invoked. If left blank `latex' will be used as the default command name.
1243 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1244 # generate index for LaTeX. If left blank `makeindex' will be used as the
1250 # LaTeX documents. This may be useful for small projects and may help to
1255 # The PAPER_TYPE tag can be used to set the paper type that is used
1257 # executive. If left blank a4wide will be used.
1261 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1262 # packages that should be included in the LaTeX output.
1266 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1273 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1287 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1313 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1329 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1330 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1331 # put in front of it. If left blank `rtf' will be used as the default path.
1336 # RTF documents. This may be useful for small projects and may help to
1370 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1371 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1372 # put in front of it. If left blank `man' will be used as the default path.
1385 # would be unable to find the correct page. The default is NO.
1399 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1400 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1401 # put in front of it. If left blank `xml' will be used as the default path.
1405 # The XML_SCHEMA tag can be used to specify an XML schema,
1406 # which can be used by a validating XML parser to check the
1411 # The XML_DTD tag can be used to specify an XML DTD,
1412 # which can be used by a validating XML parser to check the
1449 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1454 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1455 # nicely formatted so it can be parsed by a human reader. This is useful
1457 # tag is set to NO the size of the Perl module output will be much smaller
1481 # compilation will be performed. Macro expansion can be done in a controlled
1493 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1497 # The INCLUDE_PATH tag can be used to specify one or more directories that
1498 # contain include files that are not input files but should be processed by
1506 # be used.
1510 # The PREDEFINED tag can be used to specify one or more macro names that
1536 # this tag can be used to specify a list of macro names that should be expanded.
1537 # The macro definition that is found in the sources will be used.
1554 # The TAGFILES option can be used to specify one or more tagfiles.
1556 # can be added for each tagfile. The format of a tag file without
1561 # where "loc1" and "loc2" can be relative or absolute paths or
1563 # does not have to be run to correct the links.
1576 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1578 # will be listed.
1582 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1584 # be listed.
1588 # The PERL_PATH should be the absolute path and name of the perl script
1609 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1638 # the font, which can be done by putting it in a standard location or by setting
1644 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1702 # the time of a run. So in most cases it will be better to enable call graphs
1710 # the time of a run. So in most cases it will be better to enable caller
1727 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1729 # If left blank png will be used. If you choose svg you need to set
1735 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1744 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1745 # found. If left blank, it is assumed the dot tool can be found in the path.
1749 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1755 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1761 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1762 # nodes that will be shown in the graph. If the number of nodes in a graph
1766 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1767 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1771 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1773 # from the root by following a path via at most 3 edges will be shown. Nodes
1774 # that lay further from the root node will be omitted. Note that setting this
1776 # code bases. Also note that the size of a graph can be further restricted by