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 (" ")
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
75 # brief descriptions will be completely suppressed.
81 # in this list, if found as the leading text of the brief description, will be
100 # operators of the base classes will not be shown.
106 # to NO the shortest path that makes the file name unique will be used.
111 # can be used to strip a user-defined part of the path. Stripping is
113 # the path. The tag can be used to show relative paths in the file list.
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
129 # (but less readable) file names. This can be useful is your file systems
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
152 # comments) as a brief description. This used to be the default behaviour.
166 # be part of the file/class/namespace that contains it.
170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
175 # This tag can be used to specify a number of aliases that acts
186 # For instance, some of the names that are used will be different. The list
187 # of all members will be omitted, etc.
193 # Java. For instance, namespaces will be presented as packages, qualified
254 # all members of a group must be documented explicitly.
259 # the same type (for instance a group of public functions) to be put as a
261 # NO to prevent subgrouping. Alternatively, this can be done per class using
270 # namespace, or class. And the struct will be named TypeS. This can typically
271 # be useful for C code in case the coding convention dictates that all compound
278 # When the cache is full, less often used symbols will be written to disk.
281 # doxygen to be busy swapping symbols to and from disk most of the time
298 # Private class members and static file members will be hidden unless
304 # will be included in the documentation.
309 # will be included in the documentation.
314 # defined locally in source files will be included in the documentation.
326 # If this flag is set to YES, the members of anonymous namespaces will be
328 # 'anonymous_namespace{file}', where file will be replaced with the base
336 # If set to NO (the default) these members will be included in the
344 # If set to NO (the default) these classes will be included in the various
351 # If set to NO (the default) these declarations will be included in the
358 # If set to NO (the default) these blocks will be appended to the
365 # to NO (the default) then the documentation will be excluded.
380 # documentation. If set to YES the scope will be hidden.
420 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
431 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
433 # NO (the default), the class list will be sorted only by class name,
441 # The GENERATE_TODOLIST tag can be used to enable (YES) or
447 # The GENERATE_TESTLIST tag can be used to enable (YES) or
453 # The GENERATE_BUGLIST tag can be used to enable (YES) or
459 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
465 # The ENABLED_SECTIONS tag can be used to enable conditional
473 # here it will be hidden. Use a value of 0 to hide initializers completely.
475 # documentation can be controlled using \showinitializer or \hideinitializer
505 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
515 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
520 # DoxygenLayout.xml will be used as the name of the layout file.
528 # The QUIET tag can be used to turn on/off the messages that are generated
533 # The WARNINGS tag can be used to turn on/off the warning messages that are
541 # automatically be disabled.
552 # This WARN_NO_PARAMDOC option can be abled to get warnings for
562 # tags, which will be replaced by the file and line number from which the
564 # $version, which will be replaced by the version of the file (if it could
565 # be obtained via FILE_VERSION_FILTER)
569 # The WARN_LOGFILE tag can be used to specify a file to which warning
570 # and error messages should be written. If left blank the output is written
579 # The INPUT tag can be used to specify the files and/or directories that contain
586 # This tag can be used to specify the character encoding of the source files
603 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
604 # should be searched for input files as well. Possible values are YES and NO.
609 # The EXCLUDE tag can be used to specify files and/or directories that should
615 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
629 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
630 # (namespaces, classes, functions, etc.) that should be excluded from the
631 # output. The symbol name can be a fully qualified name, a word, or if the
637 # The EXAMPLE_PATH tag can be used to specify one or more files or
650 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
651 # searched for input files to be used with the \include or \dontinclude
657 # The IMAGE_PATH tag can be used to specify one or more files or
663 # The INPUT_FILTER tag can be used to specify a program that doxygen should
669 # If FILTER_PATTERNS is specified, this tag will be
674 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
686 # INPUT_FILTER) will be used to filter the input files when producing source
696 # be generated. Documented entities will be cross-referenced with these sources.
715 # functions referencing it will be listed.
721 # called/used by that function will be listed.
752 # of all compounds will be generated. Enable this if the project
758 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
759 # in which this list will be split (can be a number in the range [1..20])
764 # classes will be put under the same header in the alphabetical index.
765 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
766 # should be ignored while generating the index headers.
779 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
780 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
781 # put in front of it. If left blank `html' will be used as the default path.
785 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
791 # The HTML_HEADER tag can be used to specify a personal HTML header for
797 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
803 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
804 # style sheet that is used by each HTML page. It can be used to
808 # stylesheet in the HTML output directory as well, or it will be erased!
844 # files or namespaces will be aligned in HTML using tables. If set to
845 # NO a bullet list will be used.
850 # documentation will contain sections that can be hidden and shown after the
858 # will be generated that can be used as input for Apple's Xcode 3
873 # can be grouped.
878 # should uniquely identify the documentation set bundle. This should be a
885 # the documentation publisher. This should be a reverse domain-name style
895 # will be generated that can be used as input for tools like the
902 # be used to specify the file name of the resulting .chm file. You
903 # can add a path in front of the file if the result should not be
909 # be used to specify the location (absolute path including file name) of
917 # it should be included in the master .chm file (NO).
933 # The TOC_EXPAND flag can be set to YES to add extra items for group members
939 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
940 # that can be used as input for Qt's qhelpgenerator to generate a
946 # be used to specify the file name of the resulting .qch file.
985 # be used to specify the location of Qt's qhelpgenerator.
992 #  will be generated, which together with the HTML files, form an Eclipse help
995 # files needs to be copied into the plugins directory of eclipse. The name of
996 # the directory within the plugins directory should be the same as
997 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1008 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1014 # This tag can be used to set the number of enum values (range [1..20])
1020 # structure should be generated to display hierarchical information.
1021 # If the tag value is set to YES, a side panel will be generated
1034 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1049 # to force them to be regenerated.
1066 # typically be disabled. For large projects the javascript based search engine
1067 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1071 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1090 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1091 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1092 # put in front of it. If left blank `latex' will be used as the default path.
1096 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1097 # invoked. If left blank `latex' will be used as the default command name.
1104 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1105 # generate index for LaTeX. If left blank `makeindex' will be used as the
1111 # LaTeX documents. This may be useful for small projects and may help to
1116 # The PAPER_TYPE tag can be used to set the paper type that is used
1118 # executive. If left blank a4wide will be used.
1122 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1123 # packages that should be included in the LaTeX output.
1127 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1141 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1177 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1178 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1179 # put in front of it. If left blank `rtf' will be used as the default path.
1184 # RTF documents. This may be useful for small projects and may help to
1218 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1219 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1220 # put in front of it. If left blank `man' will be used as the default path.
1233 # would be unable to find the correct page. The default is NO.
1247 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1248 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1249 # put in front of it. If left blank `xml' will be used as the default path.
1253 # The XML_SCHEMA tag can be used to specify an XML schema,
1254 # which can be used by a validating XML parser to check the
1259 # The XML_DTD tag can be used to specify an XML DTD,
1260 # which can be used by a validating XML parser to check the
1297 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1302 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1303 # nicely formatted so it can be parsed by a human reader.
1307 # tag is set to NO the size of the Perl module output will be much smaller
1331 # compilation will be performed. Macro expansion can be done in a controlled
1343 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1347 # The INCLUDE_PATH tag can be used to specify one or more directories that
1348 # contain include files that are not input files but should be processed by
1356 # be used.
1360 # The PREDEFINED tag can be used to specify one or more macro names that
1371 # this tag can be used to specify a list of macro names that should be expanded.
1372 # The macro definition that is found in the sources will be used.
1389 # The TAGFILES option can be used to specify one or more tagfiles.
1391 # can be added for each tagfile. The format of a tag file without
1398 # where "loc1" and "loc2" can be relative or absolute paths or
1400 # does not have to be run to correct the links.
1413 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1415 # will be listed.
1419 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1421 # be listed.
1425 # The PERL_PATH should be the absolute path and name of the perl script
1447 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1478 # which can be done by putting it in a standard location or by setting the
1484 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1543 # the time of a run. So in most cases it will be better to enable call graphs
1551 # the time of a run. So in most cases it will be better to enable caller
1568 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1570 # If left blank png will be used.
1574 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1575 # found. If left blank, it is assumed the dot tool can be found in the path.
1579 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1585 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1586 # nodes that will be shown in the graph. If the number of nodes in a graph
1590 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1591 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1595 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1597 # from the root by following a path via at most 3 edges will be shown. Nodes
1598 # that lay further from the root node will be omitted. Note that setting this
1600 # code bases. Also note that the size of a graph can be further restricted by