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
92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
107 # to NO the shortest path that makes the file name unique will be used.
111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
112 # can be used to strip a user-defined part of the path. Stripping is
114 # the path. The tag can be used to show relative paths in the file list.
116 # path to strip.
120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
122 # the reader which header file to include in order to use a class.
125 # are normally passed to the compiler using the -I flag.
129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
137 # comment as the brief description. If set to NO, the JavaDoc
143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
145 # comments) as a brief description. This used to be the default behaviour.
146 # The new default is to treat a multi-line C++ comment block as a detailed
147 # description. Set this tag to YES if you prefer the old behaviour instead.
151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
153 # If set to NO, the detailed description appears after the member
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
165 # tag is set to YES, then doxygen will reuse the documentation of the first
171 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
172 # a new page for each member. If set to NO, the documentation of a member will
177 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
178 # Doxygen uses this value to replace tabs by spaces in code fragments.
182 # This tag can be used to specify a number of aliases that acts
184 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
187 # You can put \n's in the value part of an alias to insert newlines.
193 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
200 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
207 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
208 # the same type (for instance a group of public functions) to be put as a
209 # subgroup of that type (e.g. under the Public Functions section). Set it to
210 # NO to prevent subgrouping. Alternatively, this can be done per class using
219 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
222 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
226 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
231 # If the EXTRACT_STATIC tag is set to YES all static members of a file
236 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
238 # If set to NO only classes defined in header files are included.
242 # This flag is only useful for Objective-C code. When set to YES local
245 # If set to NO (the default) only methods in the interface are included.
249 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
251 # If set to NO (the default) these members will be included in the
257 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
259 # If set to NO (the default) these classes will be included in the various
264 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
266 # If set to NO (the default) these declarations will be included in the
271 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
273 # If set to NO (the default) these blocks will be appended to the
280 # to NO (the default) then the documentation will be excluded.
281 # Set it to YES to include the internal documentation.
285 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
286 # file names in lower-case letters. If set to YES upper-case letters are also
289 # and Mac users are advised to set this option to NO.
293 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
295 # documentation. If set to YES the scope will be hidden.
299 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
305 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
310 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
312 # alphabetically by member name. If set to NO the members will appear in
317 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
319 # by member name. If set to NO (the default) the members will appear in
324 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
325 # sorted by fully-qualified names, including namespaces. If set to
328 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
329 # Note: This option applies only to the class list, not to the
334 # The GENERATE_TODOLIST tag can be used to enable (YES) or
340 # The GENERATE_TESTLIST tag can be used to enable (YES) or
346 # The GENERATE_BUGLIST tag can be used to enable (YES) or
352 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
358 # The ENABLED_SECTIONS tag can be used to enable conditional
364 # the initial value of a variable or define consists of for it to appear in
366 # here it will be hidden. Use a value of 0 to hide initializers completely.
373 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
374 # at the bottom of the documentation of classes and structs. If set to YES the
375 # list will mention the files that were used to generate the documentation.
380 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
385 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
386 # doxygen should invoke to get the current version for each file (typically from the
390 # provided by doxygen. Whatever the progam writes to standard output
396 # configuration options related to warning and progress messages
399 # The QUIET tag can be used to turn on/off the messages that are generated
404 # The WARNINGS tag can be used to turn on/off the warning messages that are
410 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
411 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
416 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
423 # This WARN_NO_PARAMDOC option can be abled to get warnings for
425 # or return value. If set to NO (the default) doxygen will only warn about
440 # The WARN_LOGFILE tag can be used to specify a file to which warning
442 # to stderr.
447 # configuration options related to the input files
450 # The INPUT tag can be used to specify the files and/or directories that contain
458 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
459 # and *.h) to filter out the source-files in the directories. If left
466 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
472 # The EXCLUDE tag can be used to specify files and/or directories that should
485 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
490 # The EXAMPLE_PATH tag can be used to specify one or more files or
497 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
498 # and *.h) to filter out the source-files in the directories. If left
503 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
504 # searched for input files to be used with the \include or \dontinclude
510 # The IMAGE_PATH tag can be used to specify one or more files or
516 # The INPUT_FILTER tag can be used to specify a program that doxygen should
517 # invoke to filter for each input file. Doxygen will invoke the filter program
521 # to standard output. If FILTER_PATTERNS is specified, this tag will be
526 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
531 # is applied to all files.
535 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
536 # INPUT_FILTER) will be used to filter the input files when producing source
537 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
542 # configuration options related to source browsing
545 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
548 # VERBATIM_HEADERS is set to NO.
552 # Setting the INLINE_SOURCES tag to YES will include the body
557 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
558 # doxygen to hide any special comment blocks from generated source code
563 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
569 # If the REFERENCES_RELATION tag is set to YES (the default)
575 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
577 # which an include is specified. Set to NO to disable this.
582 # configuration options related to the alphabetical class index
585 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
592 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
599 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
605 # configuration options related to the HTML output
608 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
613 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
619 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
625 # The HTML_HEADER tag can be used to specify a personal HTML header for
631 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
637 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
638 # style sheet that is used by each HTML page. It can be used to
640 # will generate a default style sheet. Note that doxygen will try to copy
641 # the style sheet file to the HTML output directory, so don't put your own
646 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
647 # files or namespaces will be aligned in HTML using tables. If set to
652 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
654 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
659 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
660 # be used to specify the file name of the resulting .chm file. You
662 # written to the html output directory.
666 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
667 # be used to specify the location (absolute path including file name) of
668 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
673 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
679 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
685 # The TOC_EXPAND flag can be set to YES to add extra items for group members
686 # to the contents of the HTML help documentation and to the tree view.
690 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
696 # This tag can be used to set the number of enum values (range [1..20])
701 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
703 # is generated for HTML Help). For this to work a browser that supports
711 # used to set the initial width (in pixels) of the frame in which the tree
717 # configuration options related to the LaTeX output
720 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
725 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
731 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
736 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
742 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
743 # LaTeX documents. This may be useful for small projects and may help to
748 # The PAPER_TYPE tag can be used to set the paper type that is used
754 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
759 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
766 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
767 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
773 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
774 # plain latex in the generated Makefile. Set this option to YES to get a
779 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
780 # command to the generated LaTeX files. This will instruct LaTeX to keep
786 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
793 # configuration options related to the RTF output
796 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
802 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
808 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
809 # RTF documents. This may be useful for small projects and may help to
814 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
823 # Load stylesheet definitions from file. Syntax is similar to doxygen's
824 # config file, i.e. a series of assignments. You only have to provide
825 # replacements, missing definitions are set to their default value.
830 # Syntax is similar to doxygen's config file.
835 # configuration options related to the man page output
838 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
843 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
849 # The MAN_EXTENSION tag determines the extension that is added to
854 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
858 # would be unable to find the correct page. The default is NO.
863 # configuration options related to the XML output
866 # If the GENERATE_XML tag is set to YES Doxygen will
872 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
878 # The XML_SCHEMA tag can be used to specify an XML schema,
879 # which can be used by a validating XML parser to check the
884 # The XML_DTD tag can be used to specify an XML DTD,
885 # which can be used by a validating XML parser to check the
890 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
892 # and cross-referencing information) to the XML output. Note that
901 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
910 # configuration options related to the Perl module output
913 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
921 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
922 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
923 # to generate PDF and DVI output from the Perl module output.
927 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
929 # if you want to understand what is going on. On the other hand, if this
930 # tag is set to NO the size of the Perl module output will be much smaller
943 # Configuration options related to the preprocessor
946 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
952 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
953 # names in the source code. If set to NO (the default) only conditional
955 # way by setting EXPAND_ONLY_PREDEF to YES.
959 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
960 # then the macro expansion is limited to the macros specified with the
965 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
970 # The INCLUDE_PATH tag can be used to specify one or more directories that
976 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
977 # patterns (like *.h and *.hpp) to filter out the header-files in the
983 # The PREDEFINED tag can be used to specify one or more macro names that
984 # are defined before the preprocessor is started (similar to the -D option of
993 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
994 # this tag can be used to specify a list of macro names that should be expanded.
996 # Use the PREDEFINED tag if you want to use a different macro definition.
1000 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1009 # Configuration::additions related to external references
1012 # The TAGFILES option can be used to specify one or more tagfiles.
1021 # does not have to be run to correct the links.
1025 # is run, you must also specify the path to the tagfile here.
1034 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1035 # in the class index. If set to NO only the inherited external classes
1040 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1041 # in the modules index. If set to NO, only the current project's groups will
1052 # Configuration options related to the dot tool
1055 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1057 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1059 # fallback. It is recommended to install and use dot, since it yields more
1064 # If set to YES, the inheritance and collaboration graphs will hide
1070 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1073 # have no effect if this option is set to NO (the default)
1077 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1079 # indirect inheritance relations. Setting this tag to YES will force the
1080 # the CLASS_DIAGRAMS tag to NO.
1084 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1091 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1096 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1097 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1102 # If set to YES, the inheritance and collaboration graphs will show the
1108 # tags are set to YES then doxygen will generate a graph for each documented
1115 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1121 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1124 # So in most cases it will be better to enable call graphs for selected
1129 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1134 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1141 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1147 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1152 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1158 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1160 # this value, doxygen will try to truncate the graph, so that it fits within
1166 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1168 # this value, doxygen will try to truncate the graph, so that it fits within
1174 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1178 # option to 1 or 2 may greatly reduce the computation time needed for large
1180 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1186 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1188 # Warning: Depending on the platform used, enabling this option may lead to
1189 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1194 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1201 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1207 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1208 # remove the intermediate dot files that are used to generate
1214 # Configuration::additions related to the search engine
1218 # used. If set to NO the values of all tags below this one will be ignored.