Lines Matching refs:the
3 # This file describes the settings to be used by the documentation system
18 # by quotes) that should identify the project.
23 # This could be handy for archiving the generated documentation or
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29 # base path where the generated documentation will be put.
30 # If a relative path is entered, it will be relative to the location
31 # where doxygen was started. If left blank the current directory will be used.
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36 # 4096 sub-directories (in 2 levels) under the output directory of each output
37 # format and will distribute the generated files over these directories.
39 # files, where putting all generated files in the same directory would otherwise
40 # cause performance problems for the file system.
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.
57 # The encoding is not always determined by the language that is chosen,
58 # but also whether or not the output is meant for Windows or non-Windows users.
59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
60 # forces the Windows encoding (this is the default for the Windows binary),
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
67 # include brief member descriptions after the members that are listed in
68 # the file and class documentation (similar to JavaDoc).
73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74 # the brief description of a member or function before the detailed description.
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
82 # in this list, if found as the leading text of the brief description, will be
83 # stripped from the text and the result after processing the whole list, is used
84 # as the annotated text. Otherwise, the brief description is used as-is. If left
85 # blank, the following values are used ("$name" is automatically replaced with the
86 # name of the entity): "The $name class" "The $name widget" "The $name file"
87 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
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
98 # members of a class in the documentation of that class as if those members were
100 # the base classes will not be shown.
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105 # path before files name in the file list and in the header files. If set
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
112 # only done if one of the specified strings matches the left-hand part of
113 # the path. The tag can be used to show relative paths in the file list.
114 # If left blank the directory from which doxygen is run is used as the
120 # the path mentioned in the documentation of a class, which tells
121 # the reader which header file to include in order to use a class.
122 # If left blank only the name of the header file containing the class
123 # definition is used. Otherwise one should specify the include paths that
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
135 # will interpret the first line (until the first dot) of a JavaDoc-style
136 # comment as the brief description. If set to NO, the JavaDoc
137 # comments will behave just like the Qt-style comments (thus requiring an
144 # comments) as a brief description. This used to be the default behaviour.
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
151 # will output the detailed description near the top, like JavaDoc.
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
158 # member inherits the documentation from any documented member that it
163 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
164 # tag is set to YES, then doxygen will reuse the documentation of the first
165 # member in the group (if any) for the other members of the group. By default
170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
176 # as commands in the documentation. An alias has the form "name=value".
178 # put the command \sideeffect (or @sideeffect) in the documentation, which
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
186 # For instance, some of the names that are used will be different. The list
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
202 # the \nosubgrouping command.
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
218 # will be included in the documentation.
222 # If the EXTRACT_STATIC tag is set to YES all static members of a file
223 # will be included in the documentation.
227 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
228 # defined locally in source files will be included in the documentation.
234 # methods, which are defined in the implementation section but not in
235 # the interface are included in the documentation.
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
249 # undocumented classes that are normally visible in the class hierarchy.
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
263 # documentation blocks found inside the body of a function.
264 # If set to NO (the default) these blocks will be appended to the
270 # that is typed after a \internal command is included. If the tag is set
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
284 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
285 # will show members with their full class and namespace scopes in the
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
291 # will put a list of the files that are included by a file in the documentation
296 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
297 # is inserted in the documentation for inline members.
301 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
302 # will sort the (detailed) documentation of file and class members
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
317 # NO (the default), the class list will be sorted only by class name,
318 # not including the namespace part.
320 # Note: This option applies only to the class list, not to the
326 # disable (NO) the todo list. This list is created by putting \todo
327 # commands in the documentation.
332 # disable (NO) the test list. This list is created by putting \test
333 # commands in the documentation.
338 # disable (NO) the bug list. This list is created by putting \bug
339 # commands in the documentation.
344 # disable (NO) the deprecated list. This list is created by putting
345 # \deprecated commands in the documentation.
354 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
355 # the initial value of a variable or define consists of for it to appear in
356 # the documentation. If the initializer consists of more lines than specified
358 # The appearance of the initializer of individual variables and defines in the
360 # command in the documentation regardless of this setting.
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.
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
392 # potential errors in the documentation, such as not documenting some
398 # The WARN_FORMAT tag determines the format of the warning messages that
399 # doxygen can produce. The string should contain the $file, $line, and $text
400 # tags, which will be replaced by the file and line number from which the
401 # warning originated and the warning text.
406 # and error messages should be written. If left blank the output is written
412 # configuration options related to the input files
415 # The INPUT tag can be used to specify the files and/or directories that contain
417 # directories like "/usr/src/myproject". Separate the files or directories
422 # If the value of the INPUT tag contains directories, you can use the
424 # and *.h) to filter out the source-files in the directories. If left
425 # blank the following patterns are tested:
438 # excluded from the INPUT source files. This way you can easily exclude a
439 # subdirectory from a directory tree whose root is specified with the INPUT tag.
444 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
448 # If the value of the INPUT tag contains directories, you can use the
456 # the \include command).
460 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
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
469 # commands irrespective of the value of the RECURSIVE tag.
475 # directories that contain image that are included in the documentation (see
476 # the \image command).
481 # invoke to filter for each input file. Doxygen will invoke the filter program
482 # by executing (via popen()) the command <filter> <input-file>, where <filter>
483 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
484 # input file. Doxygen will then use the output that the filter program writes
491 # basis. Doxygen will compare the file name with each pattern and apply the
492 # filter if there is a match. The filters are a list of the form:
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
509 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
511 # Note: To get rid of all source code in the generated output, make sure also
516 # Setting the INLINE_SOURCES tag to YES will include the body
517 # of functions and classes directly in the documentation.
521 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
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
540 # will generate a verbatim copy of the header file for each class for
546 # configuration options related to the alphabetical class index
549 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
550 # of all compounds will be generated. Enable this if the project
555 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
556 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
557 # in which this list will be split (can be a number in the range [1..20])
562 # classes will be put under the same header in the alphabetical index.
564 # should be ignored while generating the index headers.
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.
578 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
579 # put in front of it. If left blank `html' will be used as the default path.
583 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
603 # fine-tune the look of the HTML output. If the tag is left blank doxygen
605 # the style sheet file to the HTML output directory, so don't put your own
606 # stylesheet in the HTML output directory as well, or it will be erased!
610 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
616 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
617 # will be generated that can be used as input for tools like the
619 # of the generated HTML documentation.
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
625 # can add a path in front of the file if the result should not be
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
633 # the HTML help compiler on the generated index.hhp.
637 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
639 # it should be included in the master .chm file (NO).
643 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
645 # normal table of contents (NO) in the .chm file.
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
655 # top of each HTML page. The value NO (the default) enables the index and
656 # the value YES disables it.
660 # This tag can be used to set the number of enum values (range [1..20])
661 # that doxygen will group on one line in the generated HTML documentation.
665 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
666 # generated containing a tree-like index structure (just like the one that
670 # probably better off using the HTML help feature.
674 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
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.
690 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
691 # put in front of it. If left blank `latex' will be used as the default path.
695 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
696 # invoked. If left blank `latex' will be used as the default command name.
700 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
701 # generate index for LaTeX. If left blank `makeindex' will be used as the
706 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
712 # The PAPER_TYPE tag can be used to set the paper type that is used
713 # by the printer. Possible values are: a4, a4wide, letter, legal and
719 # packages that should be included in the LaTeX output.
724 # the generated latex document. The header should contain everything until
725 # the first chapter. If it is left blank doxygen will generate a
730 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
732 # contain links (just like the HTML output) instead of page references
733 # This makes the output suitable for online browsing using a pdf viewer.
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
745 # running if errors occur, instead of asking the user for help.
751 # include the index chapters (such as File Index, Compound Index, etc.)
752 # in the output.
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.
767 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
768 # put in front of it. If left blank `rtf' will be used as the default path.
772 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
778 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
780 # contain links (just like the HTML output) instead of page references.
781 # This makes the output suitable for online browsing using WORD or other
793 # Set optional variables used in the generation of an rtf document.
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.
808 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
809 # put in front of it. If left blank `man' will be used as the default path.
813 # The MAN_EXTENSION tag determines the extension that is added to
814 # the generated man pages (default is the subroutine's section .3)
818 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
820 # documented in the real man page(s). These additional files
821 # only source the real man page, but without them the man command
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
831 # generate an XML file that captures the structure of
832 # the code including all documentation.
836 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
837 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
838 # put in front of it. If left blank `xml' will be used as the default path.
843 # which can be used by a validating XML parser to check the
844 # syntax of the XML files.
849 # which can be used by a validating XML parser to check the
850 # syntax of the XML files.
854 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
855 # dump the program listings (including syntax highlighting
856 # and cross-referencing information) to the XML output. Note that
857 # enabling this will significantly increase the size of the XML output.
862 # configuration options for the AutoGen Definitions output
865 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
867 # that captures the structure of the code including all
869 # and incomplete at the moment.
874 # configuration options related to the Perl module output
877 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
878 # generate a Perl module file that captures the structure of
879 # the code including all documentation. Note that this
880 # feature is still experimental and incomplete at the
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
895 # and Perl will parse it just the same.
899 # The names of the make variables in the generated doxyrules.make file
900 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
901 # This is useful so different doxyrules.make files included by the same
907 # Configuration options related to the preprocessor
910 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
911 # evaluate all C-preprocessor directives found in the sources and include
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
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
930 # in the INCLUDE_PATH (see below) will be search if a #include is found.
936 # the preprocessor.
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
942 # directories. If left blank, the patterns specified with FILE_PATTERNS will
948 # are defined before the preprocessor is started (similar to the -D option of
949 # gcc). The argument of the tag is a list of macros of the form: name
950 # or name=definition (no spaces). If the definition and the = are
955 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
957 # The macro definition that is found in the sources will be used.
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
965 # function macros are typically used for boiler-plate code, and will confuse the
975 # Optionally an initial location of the external documentation
979 # Adding location for the tag files is done as follows:
982 # URLs. If a location is present for each tag, the installdox tool
983 # does not have to be run to correct the links.
985 # (where the name does NOT include the path)
986 # If a tag file is not located in the directory in which doxygen
987 # is run, you must also specify the path to the tagfile here.
992 # a tag file that is based on the input files it reads.
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
1008 # The PERL_PATH should be the absolute path and name of the perl script
1009 # interpreter (i.e. the result of `which perl').
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
1020 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1025 # If set to YES, the inheritance and collaboration graphs will hide
1026 # inheritance and usage relations if the target is undocumented
1031 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1032 # available from the path. This tool is part of Graphviz, a graph visualization
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
1039 # will generate a graph for each documented class showing the direct and
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
1046 # will generate a graph for each documented class showing the direct and
1048 # class references variables) of the class with other documented classes.
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
1063 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1065 # file showing the direct and indirect include dependencies of the file with
1070 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1072 # documented header file showing the documented files that directly or
1077 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1079 # Note that enabling this option will significantly increase the time of a run.
1081 # functions only using the \callgraph command.
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
1097 # found. If left blank, it is assumed the dot tool can be found on the path.
1102 # contain dot files that are included in the documentation (see the
1107 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1108 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1109 # this value, doxygen will try to truncate the graph, so that it fits within
1110 # the specified constraint. Beware that most browsers cannot cope with very
1115 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1116 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1117 # this value, doxygen will try to truncate the graph, so that it fits within
1118 # the specified constraint. Beware that most browsers cannot cope with very
1123 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1125 # from the root by following a path via at most 3 edges will be shown. Nodes that
1126 # lay further from the root node will be omitted. Note that setting this option to
1127 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1128 # note that a graph may be further truncated if the graph's image dimensions are
1129 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1130 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1134 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1135 # generate a legend page explaining the meaning of the various boxes and
1136 # arrows in the dot generated graphs.
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
1142 # the various graphs.
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.