Lines Matching full:be

3 # This file describes the settings to be used by the documentation system
9 # All text after a single hash (#) is considered a comment and will be ignored.
12 # For lists, items can also be appended using:
14 # Values that contain spaces should be placed between quotes (\" \").
47 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
48 # could be handy for archiving the generated documentation or if some version
67 # into which the generated documentation will be written. If a relative path is
68 # entered, it will be relative to the location where doxygen was started. If
69 # left blank the current directory will be used.
76 # option can be useful when feeding doxygen a huge amount of source files, where
84 # Controls the number of sub-directories that will be created when
97 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
129 # brief descriptions will be completely suppressed.
136 # as the leading text of the brief description, will be stripped from the text
165 # operators of the base classes will not be shown.
172 # shortest path that makes the file name unique will be used
177 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
179 # part of the path. The tag can be used to show relative paths in the file list.
184 # will be relative from the directory where doxygen is started.
189 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
199 # less readable) file names. This can be useful is your file systems doesn't
218 # Javadoc-style will behave just like regular comments and it will not be
232 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
234 # a brief description. This used to be the default behavior. The new default is
245 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
246 # doxygen's special commands can be used and the contents of the docstring
259 # page for each member. If set to NO, the documentation of a member will be part
265 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
271 # This tag can be used to specify a number of aliases that act as commands in
290 # instance, some of the names that are used will be different. The list of all
291 # members will be omitted, etc.
298 # for that language. For instance, namespaces will be presented as packages,
318 # language. For instance, namespaces will be presented as modules, types will be
366 # The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
379 # be prevented in individual cases by putting a % sign in front of the word or
422 # all members of a group must be documented explicitly.
435 # (for instance a group of public functions) to be put as a subgroup of that
437 # subgrouping. Alternatively, this can be done per class using the
455 # with only public data fields or simple typedef fields will be shown inline in
468 # namespace, or class. And the struct will be named TypeS. This can typically be
475 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
476 # cache is used to resolve symbols given their name and scope. Since this can be
492 # speed. At this moment only the input processing can be done using multiple
515 # class members and static file members will be hidden unless the
524 # be included in the documentation.
530 # methods of a class will be included in the documentation.
536 # scope will be included in the documentation.
541 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
548 # locally in source files will be included in the documentation. If set to NO,
563 # If this flag is set to YES, the members of anonymous namespaces will be
565 # 'anonymous_namespace{file}', where file will be replaced with the base name of
573 # will be determined by the corresponding definition. By default unnamed
581 # members will be included in the various overviews, but no documentation
589 # to NO, these classes will be included in the various overviews. This option
597 # declarations. If set to NO, these declarations will be included in the
605 # blocks will be appended to the function's detailed documentation block.
612 # will be excluded. Set it to YES to include the internal documentation.
617 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
620 # whose names only differ in casing), the option must be set to YES to properly
622 # are not case sensitive the option should be set to NO to properly deal with
627 # to NO, whereas on Linux or other Unix flavors it should typically be set to
636 # scope will be hidden.
643 # YES the compound reference will be hidden.
649 # will show which file needs to be included to use the class.
713 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
715 # be sorted only by class name, not including the namespace part.
733 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
739 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
745 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
751 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
758 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
767 # it will be hidden. Use a value of 0 to hide initializers completely. The
768 # appearance of the value of individual variables and macros / defines can be
796 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
806 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
811 # will be used as the name of the layout file. See also section "Changing the
820 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
821 # the reference definitions. This must be a list of .bib files. The .bib
823 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
824 # For LaTeX the style of the bibliography can be controlled using
834 # The QUIET tag can be used to turn on/off the messages that are generated to
841 # The WARNINGS tag can be used to turn on/off the warning messages that are
852 # will automatically be disabled.
872 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
876 # set to YES then this flag will automatically be disabled. See also
885 # will automatically be disabled.
897 # of a run, in case a WARN_LOGFILE is defined the warning messages will be
898 # besides being in the defined file also be shown at the end of a run, unless
908 # will be replaced by the file and line number from which the warning originated
910 # be replaced by the version of the file (if it could be obtained via
927 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
928 # messages should be written. If left blank the output is written to standard
929 # error (stderr). In case the file specified cannot be opened for writing the
948 # This tag can be used to specify the character encoding of the source files
958 # This tag can be used to specify the character encoding of the source files
959 # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
982 # *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be
1037 # The RECURSIVE tag can be used to specify whether or not subdirectories should
1038 # be searched for input files as well.
1043 # The EXCLUDE tag can be used to specify files and/or directories that should be
1052 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1068 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1069 # (namespaces, classes, functions, etc.) that should be excluded from the
1070 # output. The symbol name can be a fully qualified name, a word, or if the
1076 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
1089 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1090 # searched for input files to be used with the \include or \dontinclude commands
1096 # The IMAGE_PATH tag can be used to specify one or more files or directories
1097 # that contain images that are to be included in the documentation (see the
1102 # The INPUT_FILTER tag can be used to specify a program that doxygen should
1111 # will be ignored.
1115 # or removed, the anchors will not be placed correctly.
1119 # commands (so in case of a Windows batch file always use @echo OFF), should be
1128 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1142 # INPUT_FILTER) will also be used to filter the input files that are used for
1148 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1157 # is part of the input, its contents will be placed on the main page
1158 # (index.html). This can be useful if you have a project on for instance GitHub
1164 # characters from position 72 are to be considered as comment. A common
1167 # be processed before the automatic comment starts.
1176 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1177 # generated. Documented entities will be cross-referenced with these sources.
1199 # entity all documented functions referencing it will be listed.
1205 # all documented entities called/used by that function will be listed.
1241 # tools must be available from the command line (i.e. in the search path).
1263 # compounds will be generated. Enable this if the project contains a lot of
1269 # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1270 # that should be ignored while generating the index headers. The IGNORE_PREFIX
1271 # tag works for classes, function and member names. The entity will be placed in
1287 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1288 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1295 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1302 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1322 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1325 # footer and what special commands can be used inside the footer. See also
1332 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1333 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1344 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1353 # Note: Since the styling of scrollbars can currently not be overruled in
1354 # Webkit/Chromium, the styling will be left out of the default doxygen.css if
1356 # customization is desired it has to be added explicitly. For an example see the
1362 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1363 # other source files which should be copied to the HTML output directory. Note
1364 # that these files will be copied to the base HTML output directory. Use the
1367 # files will be copied as-is; there are no commands or markers available.
1372 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1373 # should be rendered with a dark or light theme.
1427 # documentation will contain sections that can be hidden and shown after the
1434 # If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
1454 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1455 # generated that can be used as input for Apple's Xcode 3 integrated development
1471 # (such as a company or product suite) can be grouped.
1479 # (such as a company or product suite) can be grouped.
1485 # set bundle. This should be a reverse domain-name style string, e.g.
1493 # the documentation publisher. This should be a reverse domain-name style
1508 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1528 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1529 # file. You can add a path in front of the file if the result should not be
1535 # The HHC_LOCATION tag can be used to specify the location (absolute path
1538 # The file has to be specified with full path.
1544 # (YES) or that it should be included in the main .chm file (NO).
1564 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1572 # generated documentation will be placed on the server by the user during the
1582 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1583 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1590 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1638 # The QHG_LOCATION tag can be used to specify the location (absolute path
1645 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1649 # to be copied into the plugins directory of eclipse. The name of the directory
1650 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1651 # After copying Eclipse needs to be restarted before the help appears.
1666 # be necessary to disable the index and replace it with your own. The
1667 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1677 # structure should be generated to display hierarchical information. If the tag
1678 # value is set to YES, a side panel will be generated containing a tree-like
1705 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1715 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1750 # output directory to force them to be regenerated.
1757 # to create new LaTeX commands to be used in formulas as building blocks. See
1773 # With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1776 # settings have to be changed when switching between the different MathJax
1784 # When MathJax is enabled you can set the default output format to be used for
1792 # this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1793 # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1794 # is the name for Mathjax version 3, for MathJax version 2 this will be
1805 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1815 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1816 # extension names that should be enabled during MathJax rendering. For example
1827 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1828 # of code that will be used on startup of the MathJax code. See the MathJax site
1840 # there is already a search function so this one should typically be disabled.
1841 # For large projects the javascript based search engine can be slow, then
1846 # key> to jump into the search results window, the results can be navigated
1848 # the search. The filter options can be selected when the cursor is inside the
1857 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1862 # and searching needs to be provided by external tools. See the section
1871 # which needs to be processed by an external indexer. Doxygen will invoke an
1900 # SEARCHDATA_FILE tag the name of this file can be specified.
1907 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1914 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
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
1934 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1941 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1953 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1963 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1965 # it will be automatically added in the LaTeX code.
1974 # documents. This may be useful for small projects and may help to save some
1981 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1990 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1991 # that should be included in the LaTeX output. The package can be specified just
1992 # by its name or with the correct syntax as to be used with the LaTeX
1997 # If left blank no extra packages will be included.
2002 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
2019 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2023 # special commands can be used inside the footer. See also section "Doxygen
2031 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2042 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2043 # other source files which should be copied to the LATEX_OUTPUT output
2044 # directory. Note that the files will be copied as-is; there are no commands or
2091 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2100 # path from which the emoji images will be read. If a relative path is entered,
2101 # it will be relative to the LATEX_OUTPUT directory. If left blank the
2102 # LATEX_OUTPUT directory will be used.
2118 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2119 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2127 # documents. This may be useful for small projects and may help to save some
2157 # similar to doxygen's configuration file. A template extensions file can be
2173 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2174 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2175 # it. A directory man3 will be created inside the directory specified by
2201 # them the man command would be unable to find the correct page.
2217 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2218 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2246 # that can be used to generate PDF.
2251 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2252 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2281 # The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
2282 # put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2290 # database file will be recreated with each doxygen run. If set to NO, doxygen
2310 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2317 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2318 # formatted so it can be parsed by a human reader. This is useful if you want to
2320 # size of the Perl module output will be much smaller and Perl will parse it
2346 # in the source code. If set to NO, only conditional compilation will be
2347 # performed. Macro expansion can be done in a controlled way by setting
2363 # INCLUDE_PATH will be searched if a #include is found.
2369 # The INCLUDE_PATH tag can be used to specify one or more directories that
2370 # contain include files that are not input files but should be processed by the
2379 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2385 # The PREDEFINED tag can be used to specify one or more macro names that are
2396 # tag can be used to specify a list of macro names that should be expanded. The
2397 # macro definition that is found in the sources will be used. Use the PREDEFINED
2418 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2419 # file the location of the external documentation should be added. The format of
2424 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2440 # will be listed in the class and namespace index. If set to NO, only the
2441 # inherited external classes will be listed.
2446 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2447 # in the topic index. If set to NO, only the current project's groups will be
2453 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2455 # be listed.
2494 # to find the font, which can be done by putting it in a standard location or by
2528 # HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2530 # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2532 # relations will be shown as texts / links.
2542 # when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
2543 # command \collaborationgraph. Disabling a collaboration graph can be
2552 # dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
2553 # of the command \groupgraph. Disabling a directory graph can be accomplished by
2571 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2573 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2595 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2616 # can be accomplished by means of the command \includegraph. Disabling an
2617 # include graph can be accomplished by means of the command \hideincludegraph.
2627 # to NO, can be accomplished by means of the command \includedbygraph. Disabling
2628 # an included by graph can be accomplished by means of the command
2639 # So in most cases it will be better to enable call graphs for selected
2640 # functions only using the \callgraph command. Disabling a call graph can be
2651 # So in most cases it will be better to enable caller graphs for selected
2652 # functions only using the \callergraph command. Disabling a caller graph can be
2670 # DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
2671 # \directorygraph. Disabling a directory graph can be accomplished by means of
2678 # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
2685 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2700 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2712 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2713 # found. If left blank, it is assumed the dot tool can be found in the path.
2718 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2728 # If left empty dia is assumed to be found in the default search path.
2732 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2738 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2740 # to be used. If left blank, it is assumed PlantUML is not used or called during
2746 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2756 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2757 # that will be shown in the graph. If the number of nodes in a graph becomes
2761 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2762 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2768 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2770 # root by following a path via at most 3 edges will be shown. Nodes that lay
2771 # further from the root node will be omitted. Note that setting this option to 1
2773 # note that the size of a graph can be further restricted by
2818 # The MSCFILE_DIRS tag can be used to specify one or more directories that