Lines Matching refs:is
6 # All text after a hash (#) is considered a comment and will be ignored
7 # The format is:
18 # that follow. The default is UTF-8 which is also the encoding used for all
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
32 # if some version control system is used.
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
38 # If a relative path is entered, it will be relative to the location
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
55 # The default language is English, other supported languages are:
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
80 # that is used to form the text in various listings. Each string
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
86 # "The $name file" "is" "provides" "specifies" "contains"
92 is \
102 # Doxygen will generate a detailed section even if there is only a brief
107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121 # can be used to strip a user-defined part of the path. Stripping is
124 # If left blank the directory from which doxygen is run is used as the
133 # definition is used. Otherwise one should specify the include paths that
138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139 # (but less readable) file names. This can be useful is your file systems
144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
163 # The new default is to treat a multi-line C++ comment block as a detailed
168 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
174 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
196 # sources only. Doxygen will then generate output that is more tailored for C.
203 # sources only. Doxygen will then generate output that is more tailored for
210 # sources only. Doxygen will then generate output that is more tailored for
216 # sources. Doxygen will then generate output that is tailored for
224 # The format is ext=language, where ext is a file extension, and language is one of
227 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
249 # instead of private inheritance when no explicit protection keyword is present.
257 # setting a simple type. If this is not the case, or you want to show the
262 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
263 # tag is set to YES, then doxygen will reuse the documentation of the first
277 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
278 # is documented as struct, union, or enum with the name of the typedef. So
283 # types are typedef'ed and only the typedef is referenced, never the tag name.
289 # When the cache is full, less often used symbols will be written to disk.
290 # For small to medium size projects (<1000 input files) the default value is
297 # memory usage. The cache size is given by this formula:
298 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
307 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
314 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
319 # If the EXTRACT_STATIC tag is set to YES all static members of a file
324 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
330 # This flag is only useful for Objective-C code. When set to YES local
337 # If this flag is set to YES, the members of anonymous namespaces will be
345 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
348 # various overviews, but no documentation section is generated.
349 # This option has no effect if EXTRACT_ALL is enabled.
353 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
356 # overviews. This option has no effect if EXTRACT_ALL is enabled.
360 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
367 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
375 # that is typed after a \internal command is included. If the tag is set
381 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
383 # allowed. This is useful if you have classes or files whose names only differ
389 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
395 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
401 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
402 # is inserted in the documentation for inline members.
406 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
413 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
420 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
426 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
430 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
437 # disable (NO) the todo list. This list is created by putting \todo
443 # disable (NO) the test list. This list is created by putting \test
449 # disable (NO) the bug list. This list is created by putting \bug
455 # disable (NO) the deprecated list. This list is created by putting
477 # in the documentation. The default is NO.
483 # Folder Tree View (if specified). The default is YES.
489 # and from the Folder Tree View (if specified). The default is YES.
496 # popen()) the command <command> <input-file>, where <command> is the value of
497 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
499 # is used as the file version. See the manual for examples.
517 # by doxygen. Possible values are YES and NO. If left blank NO is used.
523 # NO is used.
527 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
528 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
533 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
558 # and error messages should be written. If left blank the output is written
575 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
626 # If left blank NO is used.
632 # subdirectory from a directory tree whose root is specified with the INPUT tag.
662 # wildcard * is used, a substring. Examples: ANamespace, AClass,
680 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
683 # Possible values are YES and NO. If left blank NO is used.
696 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
698 # to standard output. If FILTER_PATTERNS is specified, this tag will be
705 # filter if there is a match. The filters are a list of the form:
707 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
708 # is applied to all files.
712 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
714 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
722 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
725 # VERBATIM_HEADERS is set to NO.
740 # If the REFERENCED_BY_RELATION tag is set to YES
746 # If the REFERENCES_RELATION tag is set to YES
752 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
753 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
759 # If the USE_HTAGS tag is set to YES then the references to source code
761 # built-in source browser. The htags tool is part of GNU's global source
767 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
769 # which an include is specified. Set to NO to disable this.
777 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
783 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
801 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
806 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
807 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
813 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
819 # each generated HTML page. If it is left blank doxygen will generate a
825 # each generated HTML page. If it is left blank doxygen will generate a
831 # style sheet that is used by each HTML page. It can be used to
832 # fine-tune the look of the HTML output. If the tag is left blank doxygen
839 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
845 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
848 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
853 # If the GENERATE_DOCSET tag is set to YES, additional index files
865 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
872 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
879 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
886 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
893 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
900 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
901 # controls if a separate .chi index file is generated (YES) or that
906 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
907 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
912 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
913 # controls whether a binary table of contents is generated (YES) or a
923 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
930 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
932 # The path specified is relative to the HTML output folder.
948 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
965 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
983 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
985 # If the tag value is set to FRAME, a side panel will be generated
987 # is generated for HTML Help). For this to work a browser that supports
988 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
1000 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1002 # is shown.
1007 # as images in the HTML documentation. The default is 10. Note that
1018 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1023 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1024 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1040 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1046 # The PAPER_TYPE tag can be used to set the paper type that is used
1059 # the first chapter. If it is left blank doxygen will generate a
1064 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1065 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1071 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1077 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1080 # This option is also used when generating formulas in HTML.
1084 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1090 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1101 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1102 # The RTF output is optimized for Word 97 and may not look very pretty with
1107 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1108 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1113 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1119 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1128 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1135 # Syntax is similar to doxygen's config file.
1143 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1148 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1149 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1154 # The MAN_EXTENSION tag determines the extension that is added to
1155 # the generated man pages (default is the subroutine's section .3)
1159 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1163 # would be unable to find the correct page. The default is NO.
1171 # If the GENERATE_XML tag is set to YES Doxygen will
1177 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1178 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1195 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1206 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1209 # documentation. Note that this feature is still experimental
1218 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1221 # feature is still experimental and incomplete at the
1226 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1232 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1233 # nicely formatted so it can be parsed by a human reader. This is useful
1234 # if you want to understand what is going on. On the other hand, if this
1235 # tag is set to NO the size of the Perl module output will be much smaller
1242 # This is useful so different doxyrules.make files included by the same
1251 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1257 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1265 # then the macro expansion is limited to the macros specified with the
1270 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1271 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1289 # are defined before the preprocessor is started (similar to the -D option of
1290 # gcc). The argument of the tag is a list of macros of the form: name
1292 # omitted =1 is assumed. To prevent a macro definition from being
1303 # The macro definition that is found in the sources will be used.
1308 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1323 # this location is as follows:
1325 # Adding location for the tag files is done as follows:
1328 # URLs. If a location is present for each tag, the installdox tool
1332 # If a tag file is not located in the directory in which doxygen
1333 # is run, you must also specify the path to the tagfile here.
1337 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1338 # a tag file that is based on the input files it reads.
1342 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1348 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1363 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1366 # this option is superseded by the HAVE_DOT option below. This is only a
1367 # fallback. It is recommended to install and use dot, since it yields more
1376 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1382 # inheritance and usage relations if the target is undocumented
1383 # or is not a class.
1387 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1388 # available from the path. This tool is part of Graphviz, a graph visualization
1390 # have no effect if this option is set to NO (the default)
1398 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1406 # The default size is 10pt.
1436 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1496 # found. If left blank, it is assumed the dot tool can be found in the path.
1508 # becomes larger than this value, doxygen will truncate the graph, which is
1510 # number of direct children of the root node in a graph is already larger than
1527 # background. This is disabled by default, because dot on Windows does not
1537 # support this, this feature is disabled by default.
1541 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1547 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will