Lines Matching refs: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 (\" \").
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
66 # option can be useful when feeding doxygen a huge amount of source files, where
75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
107 # brief descriptions will be completely suppressed.
114 # as the leading text of the brief description, will be stripped from the text
143 # operators of the base classes will not be shown.
150 # shortest path that makes the file name unique will be used
155 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
157 # part of the path. The tag can be used to show relative paths in the file list.
162 # will be relative from the directory where doxygen is started.
167 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
177 # less readable) file names. This can be useful is your file systems doesn't
200 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
202 # a brief description. This used to be the default behavior. The new default is
219 # page for each member. If set to NO, the documentation of a member will be part
225 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
231 # This tag can be used to specify a number of aliases that act as commands in
243 # This tag can be used to specify a number of word-keyword mappings (TCL only).
251 # instance, some of the names that are used will be different. The list of all
252 # members will be omitted, etc.
259 # for that language. For instance, namespaces will be presented as packages,
317 # be prevented in individual cases by putting a % sign in front of the word or
360 # all members of a group must be documented explicitly.
373 # (for instance a group of public functions) to be put as a subgroup of that
375 # subgrouping. Alternatively, this can be done per class using the
393 # with only public data fields or simple typedef fields will be shown inline in
406 # namespace, or class. And the struct will be named TypeS. This can typically be
413 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
414 # cache is used to resolve symbols given their name and scope. Since this can be
432 # class members and static file members will be hidden unless the
441 # be included in the documentation.
447 # scope will be included in the documentation.
452 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
459 # locally in source files will be included in the documentation. If set to NO,
474 # If this flag is set to YES, the members of anonymous namespaces will be
476 # 'anonymous_namespace{file}', where file will be replaced with the base name of
485 # members will be included in the various overviews, but no documentation
493 # to NO, these classes will be included in the various overviews. This option
500 # (class|struct|union) declarations. If set to NO, these declarations will be
508 # blocks will be appended to the function's detailed documentation block.
515 # will be excluded. Set it to YES to include the internal documentation.
531 # scope will be hidden.
538 # YES the compound reference will be hidden.
602 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
604 # be sorted only by class name, not including the namespace part.
622 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
628 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
634 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
640 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
647 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
656 # it will be hidden. Use a value of 0 to hide initializers completely. The
657 # appearance of the value of individual variables and macros / defines can be
685 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
695 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
700 # will be used as the name of the layout file.
708 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
709 # the reference definitions. This must be a list of .bib files. The .bib
711 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
712 # For LaTeX the style of the bibliography can be controlled using
722 # The QUIET tag can be used to turn on/off the messages that are generated to
729 # The WARNINGS tag can be used to turn on/off the warning messages that are
740 # will automatically be disabled.
753 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
769 # will be replaced by the file and line number from which the warning originated
771 # be replaced by the version of the file (if it could be obtained via
777 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
778 # messages should be written. If left blank the output is written to standard
796 # This tag can be used to specify the character encoding of the source files
864 # The RECURSIVE tag can be used to specify whether or not subdirectories should
865 # be searched for input files as well.
870 # The EXCLUDE tag can be used to specify files and/or directories that should be
879 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
895 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
896 # (namespaces, classes, functions, etc.) that should be excluded from the
897 # output. The symbol name can be a fully qualified name, a word, or if the
906 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
919 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
920 # searched for input files to be used with the \include or \dontinclude commands
926 # The IMAGE_PATH tag can be used to specify one or more files or directories
927 # that contain images that are to be included in the documentation (see the
932 # The INPUT_FILTER tag can be used to specify a program that doxygen should
941 # will be ignored.
945 # or removed, the anchors will not be placed correctly.
953 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
967 # INPUT_FILTER) will also be used to filter the input files that are used for
973 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
982 # is part of the input, its contents will be placed on the main page
983 # (index.html). This can be useful if you have a project on for instance GitHub
992 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
993 # generated. Documented entities will be cross-referenced with these sources.
1015 # function all documented functions referencing it will be listed.
1021 # all documented entities called/used by that function will be listed.
1057 # tools must be available from the command line (i.e. in the search path).
1076 # cost of reduced performance. This can be particularly helpful with template
1087 # the include paths will already be set by doxygen for the files and directories
1098 # compounds will be generated. Enable this if the project contains a lot of
1104 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1105 # which the alphabetical index list will be split.
1112 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1113 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1128 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1129 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1136 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1143 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1163 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1166 # footer and what special commands can be used inside the footer. See also
1173 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1174 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1185 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1198 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1199 # other source files which should be copied to the HTML output directory. Note
1200 # that these files will be copied to the base HTML output directory. Use the
1203 # files will be copied as-is; there are no commands or markers available.
1248 # documentation will contain sections that can be hidden and shown after the
1268 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1269 # generated that can be used as input for Apple's Xcode 3 integrated development
1284 # (such as a company or product suite) can be grouped.
1291 # set bundle. This should be a reverse domain-name style string, e.g.
1299 # the documentation publisher. This should be a reverse domain-name style
1314 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1330 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1331 # file. You can add a path in front of the file if the result should not be
1337 # The HHC_LOCATION tag can be used to specify the location (absolute path
1340 # The file has to be specified with full path.
1346 # (YES) or that it should be included in the master .chm file (NO).
1366 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1374 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1375 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1382 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1429 # The QHG_LOCATION tag can be used to specify the location of Qt's
1436 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1440 # to be copied into the plugins directory of eclipse. The name of the directory
1441 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1442 # After copying Eclipse needs to be restarted before the help appears.
1457 # be necessary to disable the index and replace it with your own. The
1458 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1468 # structure should be generated to display hierarchical information. If the tag
1469 # value is set to YES, a side panel will be generated containing a tree-like
1484 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1494 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1511 # output directory to force them to be regenerated.
1539 # When MathJax is enabled you can set the default output format to be used for
1553 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1562 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1563 # extension names that should be enabled during MathJax rendering. For example
1569 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1570 # of code that will be used on startup of the MathJax code. See the MathJax site
1581 # there is already a search function so this one should typically be disabled.
1582 # For large projects the javascript based search engine can be slow, then
1587 # key> to jump into the search results window, the results can be navigated
1589 # the search. The filter options can be selected when the cursor is inside the
1598 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1603 # and searching needs to be provided by external tools. See the section
1612 # which needs to be processed by an external indexer. Doxygen will invoke an
1639 # SEARCHDATA_FILE tag the name of this file can be specified.
1646 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1653 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1657 # to a relative location where the documentation can be found. The format is:
1672 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1673 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1680 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1691 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1699 # documents. This may be useful for small projects and may help to save some
1706 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1715 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1716 # that should be included in the LaTeX output. The package can be specified just
1717 # by its name or with the correct syntax as to be used with the LaTeX
1722 # If left blank no extra packages will be included.
1727 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1743 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1747 # special commands can be used inside the footer.
1754 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1765 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1766 # other source files which should be copied to the LATEX_OUTPUT output
1767 # directory. Note that the files will be copied as-is; there are no commands or
1816 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1843 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1844 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1852 # documents. This may be useful for small projects and may help to save some
1882 # similar to doxygen's config file. A template extensions file can be generated
1908 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1909 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1910 # it. A directory man3 will be created inside the directory specified by
1936 # them the man command would be unable to find the correct page.
1952 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1953 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1974 # that can be used to generate PDF.
1979 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1980 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2021 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2028 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2029 # formatted so it can be parsed by a human reader. This is useful if you want to
2031 # size of the Perl module output will be much smaller and Perl will parse it
2057 # in the source code. If set to NO, only conditional compilation will be
2058 # performed. Macro expansion can be done in a controlled way by setting
2074 # INCLUDE_PATH will be searched if a #include is found.
2080 # The INCLUDE_PATH tag can be used to specify one or more directories that
2081 # contain include files that are not input files but should be processed by the
2089 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2095 # The PREDEFINED tag can be used to specify one or more macro names that are
2106 # tag can be used to specify a list of macro names that should be expanded. The
2107 # macro definition that is found in the sources will be used. Use the PREDEFINED
2128 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2129 # file the location of the external documentation should be added. The format of
2134 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2149 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2150 # the class index. If set to NO, only the inherited external classes will be
2156 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2157 # in the modules index. If set to NO, only the current project's groups will be
2163 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2165 # be listed.
2170 # The PERL_PATH should be the absolute path and name of the perl script
2193 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2201 # If left empty dia is assumed to be found in the default search path.
2232 # sure dot is able to find the font, which can be done by putting it in a
2240 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2288 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2290 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2329 # So in most cases it will be better to enable call graphs for selected
2330 # functions only using the \callgraph command. Disabling a call graph can be
2341 # So in most cases it will be better to enable caller graphs for selected
2342 # functions only using the \callergraph command. Disabling a caller graph can be
2365 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2382 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2394 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2395 # found. If left blank, it is assumed the dot tool can be found in the path.
2400 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2407 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2413 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2419 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2427 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2437 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2438 # that will be shown in the graph. If the number of nodes in a graph becomes
2442 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2443 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2449 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2451 # root by following a path via at most 3 edges will be shown. Nodes that lay
2452 # further from the root node will be omitted. Note that setting this option to 1
2454 # note that the size of a graph can be further restricted by