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 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
37 # information to generate all constant output in the proper language.
45 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
48 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
52 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
57 # If the EXTRACT_STATIC tag is set to YES all static members of a file
62 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
64 # If set to NO only classes defined in header files are included.
68 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
70 # If set to NO (the default) these members will be included in the
76 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
78 # If set to NO (the default) these class will be included in the various
83 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
85 # the file and class documentation (similar to JavaDoc).
86 # Set to NO to disable this.
90 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
92 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
97 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
103 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
110 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
112 # to NO the shortest path that makes the file name unique will be used.
116 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
117 # can be used to strip a user defined part of the path. Stripping is
119 # the path. It is allowed to use relative paths in the argument list.
125 # to NO (the default) then the documentation will be excluded.
126 # Set it to YES to include the internal documentation.
130 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
131 # doxygen to hide any special comment blocks from generated source code
136 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
137 # file names in lower case letters. If set to YES upper case letters are also
140 # users are adviced to set this option to NO.
144 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
150 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
152 # documentation. If set to YES the scope will be hidden.
156 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
158 # which an include is specified. Set to NO to disable this.
162 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
168 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
170 # comment as the brief description. If set to NO, the JavaDoc
176 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
182 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
187 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
189 # alphabetically by member name. If set to NO the members will appear in
195 # tag is set to YES, then doxygen will reuse the documentation of the first
201 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
202 # Doxygen uses this value to replace tabs by spaces in code fragments.
206 # The GENERATE_TODOLIST tag can be used to enable (YES) or
212 # The GENERATE_TESTLIST tag can be used to enable (YES) or
218 # The GENERATE_BUGLIST tag can be used to enable (YES) or
224 # This tag can be used to specify a number of aliases that acts
226 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
229 # You can put \n's in the value part of an alias to insert newlines.
235 # The ENABLED_SECTIONS tag can be used to enable conditional
241 # the initial value of a variable or define consist of for it to appear in
243 # here it will be hidden. Use a value of 0 to hide initializers completely.
250 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
257 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
264 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
265 # at the bottom of the documentation of classes and structs. If set to YES the
266 # list will mention the files that were used to generate the documentation.
271 # configuration options related to warning and progress messages
274 # The QUIET tag can be used to turn on/off the messages that are generated
279 # The WARNINGS tag can be used to turn on/off the warning messages that are
285 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
286 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
298 # The WARN_LOGFILE tag can be used to specify a file to which warning
300 # to stderr.
305 # configuration options related to the input files
308 # The INPUT tag can be used to specify the files and/or directories that contain
316 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
317 # and *.h) to filter out the source-files in the directories. If left
325 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
331 # The EXCLUDE tag can be used to specify files and/or directories that should
343 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
348 # The EXAMPLE_PATH tag can be used to specify one or more files or
355 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
356 # and *.h) to filter out the source-files in the directories. If left
361 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
362 # searched for input files to be used with the \include or \dontinclude
368 # The IMAGE_PATH tag can be used to specify one or more files or
374 # The INPUT_FILTER tag can be used to specify a program that doxygen should
375 # invoke to filter for each input file. Doxygen will invoke the filter program
379 # to standard output.
383 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
384 # INPUT_FILTER) will be used to filter the input files when producing source
385 # files to browse.
390 # configuration options related to source browsing
393 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
398 # Setting the INLINE_SOURCES tag to YES will include the body
403 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
409 # If the REFERENCES_RELATION tag is set to YES (the default)
416 # configuration options related to the alphabetical class index
419 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
426 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
433 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
439 # configuration options related to the HTML output
442 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
447 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
453 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
459 # The HTML_HEADER tag can be used to specify a personal HTML header for
465 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
471 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
472 # style sheet that is used by each HTML page. It can be used to
478 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
479 # files or namespaces will be aligned in HTML using tables. If set to
484 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
486 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
491 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
497 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
503 # The TOC_EXPAND flag can be set to YES to add extra items for group members
504 # to the contents of the Html help documentation and to the tree view.
508 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
514 # This tag can be used to set the number of enum values (range [1..20])
519 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
521 # is generated for HTML Help). For this to work a browser that supports
524 # can take a very long time. In such cases it is better to disable this feature.
530 # used to set the initial width (in pixels) of the frame in which the tree
536 # configuration options related to the LaTeX output
539 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
544 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
550 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank…
554 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
560 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
561 # LaTeX documents. This may be useful for small projects and may help to
566 # The PAPER_TYPE tag can be used to set the paper type that is used
572 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
577 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
584 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
585 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
591 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
592 # plain latex in the generated Makefile. Set this option to YES to get a
597 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
598 # command to the generated LaTeX files. This will instruct LaTeX to keep
605 # configuration options related to the RTF output
608 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
614 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
620 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
621 # RTF documents. This may be useful for small projects and may help to
626 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
635 # Load stylesheet definitions from file. Syntax is similar to doxygen's
636 # config file, i.e. a series of assigments. You only have to provide
637 # replacements, missing definitions are set to their default value.
642 # Syntax is similar to doxygen's config file.
647 # configuration options related to the man page output
650 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
655 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
661 # The MAN_EXTENSION tag determines the extension that is added to
666 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
670 # would be unable to find the correct page. The default is NO.
675 # configuration options related to the XML output
678 # If the GENERATE_XML tag is set to YES Doxygen will
690 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
699 # Configuration options related to the preprocessor
702 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
708 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
709 # names in the source code. If set to NO (the default) only conditional
711 # way by setting EXPAND_ONLY_PREDEF to YES.
715 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
716 # then the macro expansion is limited to the macros specified with the
721 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
726 # The INCLUDE_PATH tag can be used to specify one or more directories that
732 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
733 # patterns (like *.h and *.hpp) to filter out the header-files in the
739 # The PREDEFINED tag can be used to specify one or more macro names that
740 # are defined before the preprocessor is started (similar to the -D option of
751 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
752 # this tag can be used to specify a list of macro names that should be expanded.
754 # Use the PREDEFINED tag if you want to use a different macro definition.
758 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
766 # Configuration::addtions related to external references
769 # The TAGFILES tag can be used to specify one or more tagfiles.
778 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
779 # in the class index. If set to NO only the inherited external classes
784 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
785 # in the modules index. If set to NO, only the current project's groups will
796 # Configuration options related to the dot tool
799 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
801 # super classes. Setting the tag to NO turns the diagrams off. Note that this
803 # recommended to install and use dot, since it yield more powerful graphs.
807 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
810 # have no effect if this option is set to NO (the default)
814 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
816 # indirect inheritance relations. Setting this tag to YES will force the
817 # the CLASS_DIAGRAMS tag to NO.
821 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
828 # If set to YES, the inheritance and collaboration graphs will show the
833 # If set to YES, the inheritance and collaboration graphs will hide
840 # tags are set to YES then doxygen will generate a graph for each documented
847 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
853 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
858 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
864 # The tag DOT_PATH can be used to specify the path where the dot tool can be
869 # The DOTFILE_DIRS tag can be used to specify one or more directories that
875 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
877 # this value, doxygen will try to truncate the graph, so that it fits within
883 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
885 # this value, doxygen will try to truncate the graph, so that it fits within
891 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
897 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
898 # remove the intermedate dot files that are used to generate
904 # Configuration::addtions related to the search engine
908 # used. If set to NO the values of all tags below this one will be ignored.