Lines Matching refs:is

15 #  software distributed under the License is distributed on an
26 # All text after a hash (#) is considered a comment and will be ignored
27 # The format is:
37 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
44 # if some version control system is used.
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
65 # documentation generated by doxygen is written. Doxygen will use this
67 # The default language is English, other supported languages are:
77 # The encoding is not always determined by the language that is chosen,
78 # but also whether or not the output is meant for Windows or non-Windows users.
79 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
80 # forces the Windows encoding (this is the default for the Windows binary),
86 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
93 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
101 # that is used to form the text in various listings. Each string
103 # stripped from the text and the result after processing the whole list, is
104 # used as the annotated text. Otherwise, the brief description is used as-is.
105 # If left blank, the following values are used ("$name" is automatically
107 # "The $name file" "is" "provides" "specifies" "contains"
113 # Doxygen will generate a detailed section even if there is only a brief
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
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
135 # If left blank the directory from which doxygen is run is used as the
144 # definition is used. Otherwise one should specify the include paths that
149 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
150 # (but less readable) file names. This can be useful is your file systems
155 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
166 # The new default is to treat a multi-line C++ comment block as a detailed
171 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
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
205 # sources only. Doxygen will then generate output that is more tailored for C.
212 # sources only. Doxygen will then generate output that is more tailored for Java.
227 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
228 # tag is set to YES, then doxygen will reuse the documentation of the first
246 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
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)
269 # This flag is only useful for Objective-C code. When set to YES local
276 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
279 # various overviews, but no documentation section is generated.
280 # This option has no effect if EXTRACT_ALL is enabled.
284 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
287 # overviews. This option has no effect if EXTRACT_ALL is enabled.
291 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
298 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
306 # that is typed after a \internal command is included. If the tag is set
312 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
314 # allowed. This is useful if you have classes or files whose names only differ
320 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
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]
333 # is inserted in the documentation for inline members.
337 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
344 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
351 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
355 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
362 # disable (NO) the todo list. This list is created by putting \todo
368 # disable (NO) the test list. This list is created by putting \test
374 # disable (NO) the bug list. This list is created by putting \bug
380 # disable (NO) the deprecated list. This list is created by putting
408 # in the documentation. The default is NO.
415 # popen()) the command <command> <input-file>, where <command> is the value of
416 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
418 # is used as the file version. See the manual for examples.
427 # by doxygen. Possible values are YES and NO. If left blank NO is used.
433 # NO is used.
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
468 # and error messages should be written. If left blank the output is written
495 # If left blank NO is used.
501 # subdirectory from a directory tree whose root is specified with the INPUT tag.
532 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
535 # Possible values are YES and NO. If left blank NO is used.
548 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
550 # to standard output. If FILTER_PATTERNS is specified, this tag will be
557 # filter if there is a match. The filters are a list of the form:
559 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
560 # is applied to all files.
564 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
566 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
574 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
577 # VERBATIM_HEADERS is set to NO.
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
606 # built-in source browser. The htags tool is part of GNU's global source
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.
622 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
628 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
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.
651 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
657 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
663 # each generated HTML page. If it is left blank doxygen will generate a
669 # each generated HTML page. If it is left blank doxygen will generate a
675 # style sheet that is used by each HTML page. It can be used to
676 # fine-tune the look of the HTML output. If the tag is left blank doxygen
683 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
689 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
696 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
703 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
710 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
711 # controls if a separate .chi index file is generated (YES) or that
716 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
717 # controls whether a binary table of contents is generated (YES) or a
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
741 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
747 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
749 # is shown.
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.
763 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
779 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
785 # The PAPER_TYPE tag can be used to set the paper type that is used
798 # the first chapter. If it is left blank doxygen will generate a
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
816 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
819 # This option is also used when generating formulas in HTML.
823 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
833 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
834 # The RTF output is optimized for Word 97 and may not look very pretty with
839 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
840 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
845 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
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
867 # Syntax is similar to doxygen's config file.
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.
881 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
886 # The MAN_EXTENSION tag determines the extension that is added to
887 # the generated man pages (default is the subroutine's section .3)
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.
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.
910 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
927 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
938 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
941 # documentation. Note that this feature is still experimental
950 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
953 # feature is still experimental and incomplete at the
958 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
964 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
965 # nicely formatted so it can be parsed by a human reader. This is useful
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
974 # This is useful so different doxyrules.make files included by the same
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
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
1003 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1021 # are defined before the preprocessor is started (similar to the -D option of
1022 # gcc). The argument of the tag is a list of macros of the form: name
1024 # omitted =1 is assumed. To prevent a macro definition from being
1032 # The macro definition that is found in the sources will be used.
1037 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1052 # this location is as follows:
1054 # Adding location for the tag files is done as follows:
1057 # URLs. If a location is present for each tag, the installdox tool
1061 # If a tag file is not located in the directory in which doxygen
1062 # is run, you must also specify the path to the tagfile here.
1066 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1067 # a tag file that is based on the input files it reads.
1071 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1077 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1092 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1095 # this option is superseded by the HAVE_DOT option below. This is only a
1096 # fallback. It is recommended to install and use dot, since it yields more
1102 # inheritance and usage relations if the target is undocumented
1103 # or is not a class.
1107 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1108 # available from the path. This tool is part of Graphviz, a graph visualization
1110 # have no effect if this option is set to NO (the default)
1133 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1185 # found. If left blank, it is assumed the dot tool can be found in the path.
1218 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1219 # the graph is not depth-constrained.
1224 # background. This is disabled by default, which results in a white background.
1234 # support this, this feature is disabled by default.
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