Lines Matching refs:to
3 # This file describes the settings to be used by the documentation system
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
30 # If a relative path is entered, it will be relative to the location
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
46 # information to generate all constant output in the proper language.
56 # This tag can be used to specify the encoding used in the generated output.
59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
68 # the file and class documentation (similar to JavaDoc).
69 # Set to NO to disable this.
73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
81 # that is used to form the text in various listings. Each string
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
106 # to NO the shortest path that makes the file name unique will be used.
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
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.
115 # path to strip.
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
121 # the reader which header file to include in order to use a class.
124 # are normally passed to the compiler using the -I flag.
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
136 # comment as the brief description. If set to NO, the JavaDoc
142 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
144 # comments) as a brief description. This used to be the default behaviour.
145 # The new default is to treat a multi-line C++ comment block as a detailed
146 # description. Set this tag to YES if you prefer the old behaviour instead.
150 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
152 # If set to NO, the detailed description appears after the member
157 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
164 # tag is set to YES, then doxygen will reuse the documentation of the first
170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
171 # Doxygen uses this value to replace tabs by spaces in code fragments.
175 # This tag can be used to specify a number of aliases that acts
177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
180 # You can put \n's in the value part of an alias to insert newlines.
184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
198 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
199 # the same type (for instance a group of public functions) to be put as a
200 # subgroup of that type (e.g. under the Public Functions section). Set it to
201 # NO to prevent subgrouping. Alternatively, this can be done per class using
210 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
213 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
217 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
222 # If the EXTRACT_STATIC tag is set to YES all static members of a file
227 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
229 # If set to NO only classes defined in header files are included.
233 # This flag is only useful for Objective-C code. When set to YES local
236 # If set to NO (the default) only methods in the interface are included.
240 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
242 # If set to NO (the default) these members will be included in the
248 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
250 # If set to NO (the default) these classes will be included in the various
255 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
257 # If set to NO (the default) these declarations will be included in the
262 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
264 # If set to NO (the default) these blocks will be appended to the
271 # to NO (the default) then the documentation will be excluded.
272 # Set it to YES to include the internal documentation.
276 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
277 # file names in lower-case letters. If set to YES upper-case letters are also
280 # and Mac users are advised to set this option to NO.
284 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
286 # documentation. If set to YES the scope will be hidden.
290 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
296 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
301 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
303 # alphabetically by member name. If set to NO the members will appear in
308 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
310 # by member name. If set to NO (the default) the members will appear in
315 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
316 # sorted by fully-qualified names, including namespaces. If set to
319 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
320 # Note: This option applies only to the class list, not to the
325 # The GENERATE_TODOLIST tag can be used to enable (YES) or
331 # The GENERATE_TESTLIST tag can be used to enable (YES) or
337 # The GENERATE_BUGLIST tag can be used to enable (YES) or
343 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
349 # The ENABLED_SECTIONS tag can be used to enable conditional
355 # the initial value of a variable or define consists of for it to appear in
357 # here it will be hidden. Use a value of 0 to hide initializers completely.
364 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
365 # at the bottom of the documentation of classes and structs. If set to YES the
366 # list will mention the files that were used to generate the documentation.
371 # configuration options related to warning and progress messages
374 # The QUIET tag can be used to turn on/off the messages that are generated
379 # The WARNINGS tag can be used to turn on/off the warning messages that are
385 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
386 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
391 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
405 # The WARN_LOGFILE tag can be used to specify a file to which warning
407 # to stderr.
412 # configuration options related to the input files
415 # The INPUT tag can be used to specify the files and/or directories that contain
423 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
424 # and *.h) to filter out the source-files in the directories. If left
431 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
437 # The EXCLUDE tag can be used to specify files and/or directories that should
449 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
454 # The EXAMPLE_PATH tag can be used to specify one or more files or
461 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
462 # and *.h) to filter out the source-files in the directories. If left
467 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
468 # searched for input files to be used with the \include or \dontinclude
474 # The IMAGE_PATH tag can be used to specify one or more files or
480 # The INPUT_FILTER tag can be used to specify a program that doxygen should
481 # invoke to filter for each input file. Doxygen will invoke the filter program
485 # to standard output. If FILTER_PATTERNS is specified, this tag will be
490 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
495 # is applied to all files.
499 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
500 # INPUT_FILTER) will be used to filter the input files when producing source
501 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
506 # configuration options related to source browsing
509 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
512 # VERBATIM_HEADERS is set to NO.
516 # Setting the INLINE_SOURCES tag to YES will include the body
521 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
522 # doxygen to hide any special comment blocks from generated source code
527 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
533 # If the REFERENCES_RELATION tag is set to YES (the default)
539 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
541 # which an include is specified. Set to NO to disable this.
546 # configuration options related to the alphabetical class index
549 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
556 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
563 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
569 # configuration options related to the HTML output
572 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
577 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
583 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
589 # The HTML_HEADER tag can be used to specify a personal HTML header for
595 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
601 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
602 # style sheet that is used by each HTML page. It can be used to
604 # will generate a default style sheet. Note that doxygen will try to copy
605 # the style sheet file to the HTML output directory, so don't put your own
610 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
611 # files or namespaces will be aligned in HTML using tables. If set to
616 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
618 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
623 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
624 # be used to specify the file name of the resulting .chm file. You
626 # written to the html output directory.
630 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
631 # be used to specify the location (absolute path including file name) of
632 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
637 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
643 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
649 # The TOC_EXPAND flag can be set to YES to add extra items for group members
650 # to the contents of the HTML help documentation and to the tree view.
654 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
660 # This tag can be used to set the number of enum values (range [1..20])
665 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
667 # is generated for HTML Help). For this to work a browser that supports
675 # used to set the initial width (in pixels) of the frame in which the tree
681 # configuration options related to the LaTeX output
684 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
689 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
695 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
700 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
706 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
707 # LaTeX documents. This may be useful for small projects and may help to
712 # The PAPER_TYPE tag can be used to set the paper type that is used
718 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
723 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
730 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
731 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
737 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
738 # plain latex in the generated Makefile. Set this option to YES to get a
743 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
744 # command to the generated LaTeX files. This will instruct LaTeX to keep
750 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
757 # configuration options related to the RTF output
760 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
766 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
772 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
773 # RTF documents. This may be useful for small projects and may help to
778 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
787 # Load stylesheet definitions from file. Syntax is similar to doxygen's
788 # config file, i.e. a series of assignments. You only have to provide
789 # replacements, missing definitions are set to their default value.
794 # Syntax is similar to doxygen's config file.
799 # configuration options related to the man page output
802 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
807 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
813 # The MAN_EXTENSION tag determines the extension that is added to
818 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
822 # would be unable to find the correct page. The default is NO.
827 # configuration options related to the XML output
830 # If the GENERATE_XML tag is set to YES Doxygen will
836 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
842 # The XML_SCHEMA tag can be used to specify an XML schema,
843 # which can be used by a validating XML parser to check the
848 # The XML_DTD tag can be used to specify an XML DTD,
849 # which can be used by a validating XML parser to check the
854 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
856 # and cross-referencing information) to the XML output. Note that
865 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
874 # configuration options related to the Perl module output
877 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
885 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
886 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
887 # to generate PDF and DVI output from the Perl module output.
891 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
893 # if you want to understand what is going on. On the other hand, if this
894 # tag is set to NO the size of the Perl module output will be much smaller
907 # Configuration options related to the preprocessor
910 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
916 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
917 # names in the source code. If set to NO (the default) only conditional
919 # way by setting EXPAND_ONLY_PREDEF to YES.
923 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
924 # then the macro expansion is limited to the macros specified with the
929 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
934 # The INCLUDE_PATH tag can be used to specify one or more directories that
940 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
941 # patterns (like *.h and *.hpp) to filter out the header-files in the
947 # The PREDEFINED tag can be used to specify one or more macro names that
948 # are defined before the preprocessor is started (similar to the -D option of
955 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
956 # this tag can be used to specify a list of macro names that should be expanded.
958 # Use the PREDEFINED tag if you want to use a different macro definition.
962 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
971 # Configuration::additions related to external references
974 # The TAGFILES option can be used to specify one or more tagfiles.
983 # does not have to be run to correct the links.
987 # is run, you must also specify the path to the tagfile here.
996 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
997 # in the class index. If set to NO only the inherited external classes
1002 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1003 # in the modules index. If set to NO, only the current project's groups will
1014 # Configuration options related to the dot tool
1017 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1019 # super classes. Setting the tag to NO turns the diagrams off. Note that this
1021 # recommended to install and use dot, since it yields more powerful graphs.
1025 # If set to YES, the inheritance and collaboration graphs will hide
1031 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1034 # have no effect if this option is set to NO (the default)
1038 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1040 # indirect inheritance relations. Setting this tag to YES will force the
1041 # the CLASS_DIAGRAMS tag to NO.
1045 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1052 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1053 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1058 # If set to YES, the inheritance and collaboration graphs will show the
1064 # tags are set to YES then doxygen will generate a graph for each documented
1071 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1077 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1080 # So in most cases it will be better to enable call graphs for selected
1085 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1090 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1096 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1101 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1107 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1109 # this value, doxygen will try to truncate the graph, so that it fits within
1115 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1117 # this value, doxygen will try to truncate the graph, so that it fits within
1123 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1126 # lay further from the root node will be omitted. Note that setting this option to
1129 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1134 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1140 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1141 # remove the intermediate dot files that are used to generate
1147 # Configuration::additions related to the search engine
1151 # used. If set to NO the values of all tags below this one will be ignored.