Lines Matching refs:to
4 # Licensed to the Apache Software Foundation (ASF) under one
8 # to you under the Apache License, Version 2.0 (the
14 # Unless required by applicable law or agreed to in writing,
23 # This file describes the settings to be used by the documentation system
42 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
48 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
50 # If a relative path is entered, it will be relative to the location
55 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
64 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
66 # information to generate all constant output in the proper language.
76 # This tag can be used to specify the encoding used in the generated output.
79 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
81 # whereas setting the tag to NO uses a Unix-style encoding (the default for
86 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
88 # the file and class documentation (similar to JavaDoc).
89 # Set to NO to disable this.
93 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
95 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
101 # that is used to form the text in various listings. Each string
112 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
118 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
125 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
127 # to NO the shortest path that makes the file name unique will be used.
131 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
132 # can be used to strip a user-defined part of the path. Stripping is
134 # the path. The tag can be used to show relative paths in the file list.
136 # path to strip.
140 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
142 # the reader which header file to include in order to use a class.
145 # are normally passed to the compiler using the -I flag.
149 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
155 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
157 # comment as the brief description. If set to NO, the JavaDoc
163 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
165 # comments) as a brief description. This used to be the default behaviour.
166 # The new default is to treat a multi-line C++ comment block as a detailed
167 # description. Set this tag to YES if you prefer the old behaviour instead.
171 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
173 # If set to NO, the detailed description appears after the member
178 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
184 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
185 # a new page for each member. If set to NO, the documentation of a member will
190 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
191 # Doxygen uses this value to replace tabs by spaces in code fragments.
195 # This tag can be used to specify a number of aliases that acts
197 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
200 # You can put \n's in the value part of an alias to insert newlines.
204 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
211 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
218 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
220 # set this tag to YES in order to let doxygen match functions declarations and
228 # tag is set to YES, then doxygen will reuse the documentation of the first
234 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
235 # the same type (for instance a group of public functions) to be put as a
236 # subgroup of that type (e.g. under the Public Functions section). Set it to
237 # NO to prevent subgrouping. Alternatively, this can be done per class using
246 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
249 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
253 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
258 # If the EXTRACT_STATIC tag is set to YES all static members of a file
263 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
265 # If set to NO only classes defined in header files are included.
269 # This flag is only useful for Objective-C code. When set to YES local
272 # If set to NO (the default) only methods in the interface are included.
276 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
278 # If set to NO (the default) these members will be included in the
284 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
286 # If set to NO (the default) these classes will be included in the various
291 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
293 # If set to NO (the default) these declarations will be included in the
298 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
300 # If set to NO (the default) these blocks will be appended to the
307 # to NO (the default) then the documentation will be excluded.
308 # Set it to YES to include the internal documentation.
312 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
313 # file names in lower-case letters. If set to YES upper-case letters are also
316 # and Mac users are advised to set this option to NO.
320 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
322 # documentation. If set to YES the scope will be hidden.
326 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
332 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
337 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
339 # alphabetically by member name. If set to NO the members will appear in
344 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
346 # by member name. If set to NO (the default) the members will appear in
351 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
352 # sorted by fully-qualified names, including namespaces. If set to
355 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
356 # Note: This option applies only to the class list, not to the
361 # The GENERATE_TODOLIST tag can be used to enable (YES) or
367 # The GENERATE_TESTLIST tag can be used to enable (YES) or
373 # The GENERATE_BUGLIST tag can be used to enable (YES) or
379 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
385 # The ENABLED_SECTIONS tag can be used to enable conditional
391 # the initial value of a variable or define consists of for it to appear in
393 # here it will be hidden. Use a value of 0 to hide initializers completely.
400 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
401 # at the bottom of the documentation of classes and structs. If set to YES the
402 # list will mention the files that were used to generate the documentation.
407 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
412 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
413 # doxygen should invoke to get the current version for each file (typically from the
417 # provided by doxygen. Whatever the program writes to standard output
423 # configuration options related to warning and progress messages
426 # The QUIET tag can be used to turn on/off the messages that are generated
431 # The WARNINGS tag can be used to turn on/off the warning messages that are
437 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
438 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
443 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
450 # This WARN_NO_PARAMDOC option can be abled to get warnings for
452 # or return value. If set to NO (the default) doxygen will only warn about
467 # The WARN_LOGFILE tag can be used to specify a file to which warning
469 # to stderr.
474 # configuration options related to the input files
477 # The INPUT tag can be used to specify the files and/or directories that contain
485 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
486 # and *.h) to filter out the source-files in the directories. If left
493 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
499 # The EXCLUDE tag can be used to specify files and/or directories that should
512 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
514 # against the file with absolute path, so to exclude all test directories
519 # The EXAMPLE_PATH tag can be used to specify one or more files or
526 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
527 # and *.h) to filter out the source-files in the directories. If left
532 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
533 # searched for input files to be used with the \include or \dontinclude
539 # The IMAGE_PATH tag can be used to specify one or more files or
545 # The INPUT_FILTER tag can be used to specify a program that doxygen should
546 # invoke to filter for each input file. Doxygen will invoke the filter program
550 # to standard output. If FILTER_PATTERNS is specified, this tag will be
555 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
560 # is applied to all files.
564 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
565 # INPUT_FILTER) will be used to filter the input files when producing source
566 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
571 # configuration options related to source browsing
574 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
577 # VERBATIM_HEADERS is set to NO.
581 # Setting the INLINE_SOURCES tag to YES will include the body
586 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
587 # doxygen to hide any special comment blocks from generated source code
592 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
598 # If the REFERENCES_RELATION tag is set to YES (the default)
604 # If the USE_HTAGS tag is set to YES then the references to source code
605 # will point to the HTML generated by the htags(1) tool instead of doxygen
612 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
614 # which an include is specified. Set to NO to disable this.
619 # configuration options related to the alphabetical class index
622 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
629 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
636 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
642 # configuration options related to the HTML output
645 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
650 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
656 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
662 # The HTML_HEADER tag can be used to specify a personal HTML header for
668 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
674 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
675 # style sheet that is used by each HTML page. It can be used to
677 # will generate a default style sheet. Note that doxygen will try to copy
678 # the style sheet file to the HTML output directory, so don't put your own
683 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
684 # files or namespaces will be aligned in HTML using tables. If set to
689 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
691 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
696 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
697 # be used to specify the file name of the resulting .chm file. You
699 # written to the html output directory.
703 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
704 # be used to specify the location (absolute path including file name) of
705 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
710 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
716 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
722 # The TOC_EXPAND flag can be set to YES to add extra items for group members
723 # to the contents of the HTML help documentation and to the tree view.
727 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
733 # This tag can be used to set the number of enum values (range [1..20])
738 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
740 # is generated for HTML Help). For this to work a browser that supports
748 # used to set the initial width (in pixels) of the frame in which the tree
754 # configuration options related to the LaTeX output
757 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
762 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
768 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
773 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
779 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
780 # LaTeX documents. This may be useful for small projects and may help to
785 # The PAPER_TYPE tag can be used to set the paper type that is used
791 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
796 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
803 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
804 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
810 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
811 # plain latex in the generated Makefile. Set this option to YES to get a
816 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
817 # command to the generated LaTeX files. This will instruct LaTeX to keep
823 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
830 # configuration options related to the RTF output
833 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
839 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
845 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
846 # RTF documents. This may be useful for small projects and may help to
851 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
860 # Load stylesheet definitions from file. Syntax is similar to doxygen's
861 # config file, i.e. a series of assignments. You only have to provide
862 # replacements, missing definitions are set to their default value.
867 # Syntax is similar to doxygen's config file.
872 # configuration options related to the man page output
875 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
880 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
886 # The MAN_EXTENSION tag determines the extension that is added to
891 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
895 # would be unable to find the correct page. The default is NO.
900 # configuration options related to the XML output
903 # If the GENERATE_XML tag is set to YES Doxygen will
909 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
915 # The XML_SCHEMA tag can be used to specify an XML schema,
916 # which can be used by a validating XML parser to check the
921 # The XML_DTD tag can be used to specify an XML DTD,
922 # which can be used by a validating XML parser to check the
927 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
929 # and cross-referencing information) to the XML output. Note that
938 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
947 # configuration options related to the Perl module output
950 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
958 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
959 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
960 # to generate PDF and DVI output from the Perl module output.
964 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
966 # if you want to understand what is going on. On the other hand, if this
967 # tag is set to NO the size of the Perl module output will be much smaller
980 # Configuration options related to the preprocessor
983 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
989 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
990 # names in the source code. If set to NO (the default) only conditional
992 # way by setting EXPAND_ONLY_PREDEF to YES.
996 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
997 # then the macro expansion is limited to the macros specified with the
1002 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1007 # The INCLUDE_PATH tag can be used to specify one or more directories that
1013 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1014 # patterns (like *.h and *.hpp) to filter out the header-files in the
1020 # The PREDEFINED tag can be used to specify one or more macro names that
1021 # are defined before the preprocessor is started (similar to the -D option of
1030 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1031 # this tag can be used to specify a list of macro names that should be expanded.
1033 # Use the PREDEFINED tag if you want to use a different macro definition.
1037 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1046 # Configuration::additions related to external references
1049 # The TAGFILES option can be used to specify one or more tagfiles.
1058 # does not have to be run to correct the links.
1062 # is run, you must also specify the path to the tagfile here.
1071 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1072 # in the class index. If set to NO only the inherited external classes
1077 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1078 # in the modules index. If set to NO, only the current project's groups will
1089 # Configuration options related to the dot tool
1092 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1094 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1096 # fallback. It is recommended to install and use dot, since it yields more
1101 # If set to YES, the inheritance and collaboration graphs will hide
1107 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1110 # have no effect if this option is set to NO (the default)
1114 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1116 # indirect inheritance relations. Setting this tag to YES will force the
1117 # the CLASS_DIAGRAMS tag to NO.
1121 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1128 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1133 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1134 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1139 # If set to YES, the inheritance and collaboration graphs will show the
1145 # tags are set to YES then doxygen will generate a graph for each documented
1152 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1158 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1161 # So in most cases it will be better to enable call graphs for selected
1166 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1171 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1178 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1184 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1189 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1195 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1197 # this value, doxygen will try to truncate the graph, so that it fits within
1203 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1205 # this value, doxygen will try to truncate the graph, so that it fits within
1211 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1215 # option to 1 or 2 may greatly reduce the computation time needed for large
1217 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1223 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1225 # Warning: Depending on the platform used, enabling this option may lead to
1226 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1231 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1238 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1244 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1245 # remove the intermediate dot files that are used to generate
1251 # Configuration::additions related to the search engine
1255 # used. If set to NO the values of all tags below this one will be ignored.