Lines Matching full: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 sequence of words) that should
33 # if some version control system is used.
43 # With the PROJECT_LOGO tag one can specify an logo or icon that is
50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
52 # If a relative path is entered, it will be relative to the location
57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
66 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
67 # documentation generated by doxygen is written. Doxygen will use this
69 # The default language is English, other supported languages are:
79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
94 # that is used to form the text in various listings. Each string
96 # stripped from the text and the result after processing the whole list, is
97 # used as the annotated text. Otherwise, the brief description is used as-is.
98 # If left blank, the following values are used ("$name" is automatically
100 # "The $name file" "is" "provides" "specifies" "contains"
106 is \
116 # Doxygen will generate a detailed section even if there is only a brief
121 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
128 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
134 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
135 # can be used to strip a user-defined part of the path. Stripping is
138 # If left blank the directory from which doxygen is run is used as the
147 # definition is used. Otherwise one should specify the include paths that
152 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
158 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
166 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
177 # The new default is to treat a multi-line C++ comment block as a detailed
182 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
188 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
216 # sources only. Doxygen will then generate output that is more tailored for C.
223 # sources only. Doxygen will then generate output that is more tailored for
230 # sources only. Doxygen will then generate output that is more tailored for
236 # sources. Doxygen will then generate output that is tailored for
244 # tag. The format is ext=language, where ext is a file extension, and language
245 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
247 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
248 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
269 # instead of private inheritance when no explicit protection keyword is present.
277 # setting a simple type. If this is not the case, or you want to show the
282 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
283 # tag is set to YES, then doxygen will reuse the documentation of the first
297 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
304 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
307 # documentation), provided this scope is documented. If set to NO (the default),
313 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
314 # is documented as struct, union, or enum with the name of the typedef. So
319 # types are typedef'ed and only the typedef is referenced, never the tag name.
325 # When the cache is full, less often used symbols will be written to disk.
326 # For small to medium size projects (<1000 input files) the default value is
333 # memory usage. The cache size is given by this formula:
334 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
340 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
343 # pre-resolved symbols. If the cache is too small doxygen will become slower.
344 # If the cache is too large, memory is wasted. The cache size is given by this
345 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
354 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
361 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
366 # If the EXTRACT_STATIC tag is set to YES all static members of a file
371 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
377 # This flag is only useful for Objective-C code. When set to YES local
384 # If this flag is set to YES, the members of anonymous namespaces will be
392 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
395 # various overviews, but no documentation section is generated.
396 # This option has no effect if EXTRACT_ALL is enabled.
400 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
403 # overviews. This option has no effect if EXTRACT_ALL is enabled.
407 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
414 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
422 # that is typed after a \internal command is included. If the tag is set
428 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
430 # allowed. This is useful if you have classes or files whose names only differ
436 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
442 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
448 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
454 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
455 # is inserted in the documentation for inline members.
459 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
466 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
473 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
478 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
479 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
483 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
489 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
493 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
499 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
502 # if there is only one candidate or it is obvious which candidate to choose
509 # disable (NO) the todo list. This list is created by putting \todo
515 # disable (NO) the test list. This list is created by putting \test
521 # disable (NO) the bug list. This list is created by putting \bug
527 # disable (NO) the deprecated list. This list is created by putting
555 # in the documentation. The default is NO.
561 # Folder Tree View (if specified). The default is YES.
567 # and from the Folder Tree View (if specified). The default is YES.
574 # popen()) the command <command> <input-file>, where <command> is the value of
575 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
577 # is used as the file version. See the manual for examples.
592 # .bib extension is automatically appended if omitted. Using this command
605 # by doxygen. Possible values are YES and NO. If left blank NO is used.
611 # NO is used.
615 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
616 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
621 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
646 # and error messages should be written. If left blank the output is written
668 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
691 # If left blank NO is used.
697 # subdirectory from a directory tree whose root is specified with the INPUT tag.
698 # Note that relative paths are relative to the directory from which doxygen is
720 # wildcard * is used, a substring. Examples: ANamespace, AClass,
738 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
741 # Possible values are YES and NO. If left blank NO is used.
754 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
756 # to standard output. If FILTER_PATTERNS is specified, this tag will be
763 # filter if there is a match. The filters are a list of the form:
765 # info on how filters are used. If FILTER_PATTERNS is empty or if
766 # non of the patterns match the file name, INPUT_FILTER is applied.
770 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
772 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
778 # and it is also possible to disable source filtering for a specific pattern
780 # FILTER_SOURCE_FILES is enabled.
788 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
791 # VERBATIM_HEADERS is set to NO.
806 # If the REFERENCED_BY_RELATION tag is set to YES
812 # If the REFERENCES_RELATION tag is set to YES
818 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
819 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
825 # If the USE_HTAGS tag is set to YES then the references to source code
827 # built-in source browser. The htags tool is part of GNU's global source
833 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
835 # which an include is specified. Set to NO to disable this.
843 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
849 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
866 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
871 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
872 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
878 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
884 # each generated HTML page. If it is left blank doxygen will generate a
887 # needs, which is dependent on the configuration options used.
888 # It is advised to generate a default header using "doxygen -w html
890 # that header. Note that the header is subject to change so you typically
897 # each generated HTML page. If it is left blank doxygen will generate a
903 # style sheet that is used by each HTML page. It can be used to
904 # fine-tune the look of the HTML output. If the tag is left blank doxygen
916 # the files will be copied as-is; there are no commands or markers available.
922 # according to this color. Hue is specified as an angle on a colorwheel,
924 # For instance the value 0 represents red, 60 is yellow, 120 is green,
925 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
926 # The allowed range is 0 to 359.
939 # the output darker. The value divided by 100 is the actual gamma applied,
945 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
951 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
957 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
960 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
965 # If the GENERATE_DOCSET tag is set to YES, additional index files
978 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
985 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1002 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1009 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1016 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1023 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1024 # controls if a separate .chi index file is generated (YES) or that
1029 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1030 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1035 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1036 # controls whether a binary table of contents is generated (YES) or a
1046 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1053 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1055 # The path specified is relative to the HTML output folder.
1071 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1092 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1099 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1124 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1126 # If the tag value is set to YES, a side panel will be generated
1128 # is generated for HTML Help). For this to work a browser that supports
1129 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1148 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1150 # is shown.
1154 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1160 # as images in the HTML documentation. The default is 10. Note that
1184 # When MathJax is enabled you need to specify the location relative to the
1187 # directory is located at the same level as the HTML output directory, then
1190 # MathJax, but it is strongly recommended to install a local copy of MathJax
1200 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1204 # (GENERATE_DOCSET) there is already a search function so this one should
1210 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1214 # based approach is that it scales better to large projects and allows
1215 # full text search. The disadvantages are that it is more difficult to setup
1224 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1229 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1230 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1237 # Note that when enabling USE_PDFLATEX this option is only used for
1239 # Makefile that is written to the output directory.
1249 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1255 # The PAPER_TYPE tag can be used to set the paper type that is used
1268 # the first chapter. If it is left blank doxygen will generate a
1275 # the last chapter. If it is left blank doxygen will generate a
1280 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1281 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1287 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1293 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1296 # This option is also used when generating formulas in HTML.
1300 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1306 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1314 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1323 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1324 # The RTF output is optimized for Word 97 and may not look very pretty with
1329 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1330 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1335 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1341 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1350 # Load style sheet definitions from file. Syntax is similar to doxygen's
1357 # Syntax is similar to doxygen's config file.
1365 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1370 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1371 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1376 # The MAN_EXTENSION tag determines the extension that is added to
1377 # the generated man pages (default is the subroutine's section .3)
1381 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1385 # would be unable to find the correct page. The default is NO.
1393 # If the GENERATE_XML tag is set to YES Doxygen will
1399 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1400 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1417 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1428 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1431 # documentation. Note that this feature is still experimental
1440 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1443 # feature is still experimental and incomplete at the
1448 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1454 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1455 # nicely formatted so it can be parsed by a human reader. This is useful
1456 # if you want to understand what is going on. On the other hand, if this
1457 # tag is set to NO the size of the Perl module output will be much smaller
1464 # This is useful so different doxyrules.make files included by the same
1473 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1479 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1487 # then the macro expansion is limited to the macros specified with the
1492 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1493 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1511 # are defined before the preprocessor is started (similar to the -D option of
1512 # gcc). The argument of the tag is a list of macros of the form: name
1514 # omitted =1 is assumed. To prevent a macro definition from being
1537 # The macro definition that is found in the sources will be used.
1543 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1557 # this location is as follows:
1559 # Adding location for the tag files is done as follows:
1562 # URLs. If a location is present for each tag, the installdox tool
1566 # If a tag file is not located in the directory in which doxygen
1567 # is run, you must also specify the path to the tagfile here.
1571 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1572 # a tag file that is based on the input files it reads.
1576 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1582 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1597 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1600 # this option also works with HAVE_DOT disabled, but it is recommended to
1609 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1615 # inheritance and usage relations if the target is undocumented
1616 # or is not a class.
1620 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1621 # available from the path. This tool is part of Graphviz, a graph visualization
1623 # have no effect if this option is set to NO (the default)
1627 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1637 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1645 # The default size is 10pt.
1674 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1735 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1745 # found. If left blank, it is assumed the dot tool can be found in the path.
1763 # becomes larger than this value, doxygen will truncate the graph, which is
1765 # number of direct children of the root node in a graph is already larger than
1782 # background. This is disabled by default, because dot on Windows does not
1792 # support this, this feature is disabled by default.
1796 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1802 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will