Lines Matching full:is

6 # All text after a double hash (##) is considered a comment and is placed in
7 # front of the TAG it is preceding.
9 # All text after a single hash (#) is considered a comment and will be ignored.
10 # The format is:
21 # that follow. The default is UTF-8 which is also the encoding used for all text
25 # The default value is: UTF-8.
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
31 # project for which the documentation is generated. This name is used in the
33 # The default value is: My Project.
39 # control system is used.
49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 # into which the generated documentation will be written. If a relative path is
63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
69 # The default value is: NO.
73 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
74 # documentation generated by doxygen is written. Doxygen will use this
84 # The default value is: English.
88 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
91 # The default value is: YES.
95 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
100 # The default value is: YES.
104 # This tag implements a quasi-intelligent brief description abbreviator that is
107 # and the result, after processing the whole list, is used as the annotated
108 # text. Otherwise, the brief description is used as-is. If left blank, the
109 # following values are used ($name is automatically replaced with the name of
110 # the entity):The $name class, The $name widget, The $name file, is, provides,
116 # doxygen will generate a detailed section even if there is only a brief
118 # The default value is: NO.
122 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
126 # The default value is: NO.
130 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
133 # The default value is: YES.
138 # Stripping is only done if one of the specified strings matches the left-hand
140 # If left blank the directory from which doxygen is run is used as the path to
144 # will be relative from the directory where doxygen is started.
145 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
152 # the header file containing the class definition is used. Otherwise one should
160 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
161 # less readable) file names. This can be useful is your file systems doesn't
163 # The default value is: NO.
167 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
172 # The default value is: NO.
176 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
180 # The default value is: NO.
186 # a brief description. This used to be the default behavior. The new default is
192 # The default value is: NO.
196 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
198 # The default value is: YES.
202 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
205 # The default value is: NO.
234 # only. Doxygen will then generate output that is more tailored for C. For
237 # The default value is: NO.
242 # Python sources only. Doxygen will then generate output that is more tailored
245 # The default value is: NO.
250 # sources. Doxygen will then generate output that is tailored for Fortran.
251 # The default value is: NO.
256 # sources. Doxygen will then generate output that is tailored for VHDL.
257 # The default value is: NO.
264 # using this tag. The format is ext=language, where ext is a file extension, and
265 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
267 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
268 # (default is Fortran), use: inc=Fortran f=C.
277 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
280 # The output of markdown processing is further processed by doxygen, so you can
283 # The default value is: YES.
291 # The default value is: YES.
301 # The default value is: NO.
307 # The default value is: NO.
314 # of private inheritance when no explicit protection keyword is present.
315 # The default value is: NO.
323 # type. If this is not the case, or you want to show the methods anyway, you
325 # The default value is: YES.
329 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
330 # tag is set to YES, then doxygen will reuse the documentation of the first
333 # The default value is: NO.
342 # The default value is: YES.
346 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
353 # The default value is: NO.
357 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
360 # namespace, or group documentation), provided this scope is documented. If set
363 # The default value is: NO.
367 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
368 # enum is documented as struct, union, or enum with the name of the typedef. So
373 # types are typedef'ed and only the typedef is referenced, never the tag name.
374 # The default value is: NO.
379 # cache is used to resolve symbols given their name and scope. Since this can be
381 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
382 # doxygen will become slower. If the cache is too large, memory is wasted. The
383 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
384 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
395 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
400 # normally produced when WARNINGS is set to YES.
401 # The default value is: NO.
405 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
407 # The default value is: NO.
411 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
413 # The default value is: NO.
417 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
419 # The default value is: NO.
423 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
427 # The default value is: YES.
431 # This flag is only useful for Objective-C code. When set to YES local methods,
435 # The default value is: NO.
439 # If this flag is set to YES, the members of anonymous namespaces will be
444 # The default value is: NO.
448 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
451 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
452 # The default value is: NO.
456 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
459 # no effect if EXTRACT_ALL is enabled.
460 # The default value is: NO.
464 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
467 # The default value is: NO.
471 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
474 # The default value is: NO.
478 # The INTERNAL_DOCS tag determines if documentation that is typed after a
479 # \internal command is included. If the tag is set to NO then the documentation
481 # The default value is: NO.
485 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
487 # allowed. This is useful if you have classes or files whose names only differ
490 # The default value is: system dependent.
494 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
497 # The default value is: NO.
501 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
503 # The default value is: YES.
507 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
510 # The default value is: NO.
514 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
516 # The default value is: NO.
520 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
522 # The default value is: YES.
526 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
529 # The default value is: YES.
533 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
537 # The default value is: NO.
541 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
545 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
547 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
549 # The default value is: NO.
553 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
556 # The default value is: NO.
560 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
563 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
566 # The default value is: NO.
570 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
572 # the prototype and the implementation of a member function even if there is
573 # only one candidate or it is obvious which candidate to choose by doing a
576 # The default value is: NO.
581 # todo list. This list is created by putting \todo commands in the
583 # The default value is: YES.
588 # test list. This list is created by putting \test commands in the
590 # The default value is: YES.
595 # list. This list is created by putting \bug commands in the documentation.
596 # The default value is: YES.
601 # the deprecated list. This list is created by putting \deprecated commands in
603 # The default value is: YES.
627 # The default value is: YES.
634 # The default value is: YES.
641 # The default value is: YES.
648 # popen()) the command command input-file, where command is the value of the
649 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
650 # by doxygen. Whatever the program writes to standard output is used as the file
664 # tag is left empty.
670 # extension is automatically appended if omitted. This requires the bibtex tool
684 # standard output by doxygen. If QUIET is set to YES this implies that the
686 # The default value is: NO.
691 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
695 # The default value is: YES.
699 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
700 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
702 # The default value is: YES.
706 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
710 # The default value is: YES.
718 # The default value is: NO.
728 # The default value is: $file:$line: $text.
733 # messages should be written. If left blank the output is written to standard
742 # The INPUT tag is used to specify the files and/or directories that contain
746 # Note: If this tag is empty the current directory is searched.
760 # The default value is: UTF-8.
777 # The default value is: NO.
783 # subdirectory from a directory tree whose root is specified with the INPUT tag.
785 # Note that relative paths are relative to the directory from which doxygen is
793 # The default value is: NO.
809 # wildcard * is used, a substring. Examples: ANamespace, AClass,
830 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
833 # The default value is: NO.
849 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
851 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
854 # Note that the filter must not add or remove lines; it is applied before the
855 # code is scanned, but not when the output code is generated. If lines are added
862 # filter if there is a match. The filters are a list of the form: pattern=filter
864 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
865 # patterns match the file name, INPUT_FILTER is applied.
869 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
871 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
872 # The default value is: NO.
878 # it is also possible to disable source filtering for a specific pattern using
880 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
885 # is part of the input, its contents will be placed on the main page
895 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
899 # also VERBATIM_HEADERS is set to NO.
900 # The default value is: NO.
906 # The default value is: NO.
913 # The default value is: YES.
917 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
919 # The default value is: NO.
923 # If the REFERENCES_RELATION tag is set to YES then for each documented function
925 # The default value is: NO.
929 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
933 # The default value is: YES.
937 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
942 # The default value is: YES.
943 # This tag requires that the tag SOURCE_BROWSER is set to YES.
947 # If the USE_HTAGS tag is set to YES then the references to source code will
949 # source browser. The htags tool is part of GNU's global source tagging system
964 # The default value is: NO.
965 # This tag requires that the tag SOURCE_BROWSER is set to YES.
969 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
970 # verbatim copy of the header file for each class for which an include is
973 # The default value is: YES.
981 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
984 # The default value is: YES.
991 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
999 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1007 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1008 # The default value is: YES.
1012 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1013 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1015 # The default directory is: html.
1016 # This tag requires that the tag GENERATE_HTML is set to YES.
1022 # The default value is: .html.
1023 # This tag requires that the tag GENERATE_HTML is set to YES.
1028 # each generated HTML page. If the tag is left blank doxygen will generate a
1032 # that doxygen needs, which is dependent on the configuration options used (e.g.
1033 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1040 # Note: The header is subject to change so you typically have to regenerate the
1043 # This tag requires that the tag GENERATE_HTML is set to YES.
1048 # generated HTML page. If the tag is left blank doxygen will generate a standard
1053 # This tag requires that the tag GENERATE_HTML is set to YES.
1058 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1062 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1063 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1065 # This tag requires that the tag GENERATE_HTML is set to YES.
1070 # defined cascading style sheet that is included after the standard style sheets
1072 # This is preferred over using HTML_STYLESHEET since it does not replace the
1073 # standard style sheet and is therefor more robust against future updates.
1076 # This tag requires that the tag GENERATE_HTML is set to YES.
1085 # files will be copied as-is; there are no commands or markers available.
1086 # This tag requires that the tag GENERATE_HTML is set to YES.
1092 # this color. Hue is specified as an angle on a colorwheel, see
1094 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1095 # purple, and 360 is red again.
1097 # This tag requires that the tag GENERATE_HTML is set to YES.
1105 # This tag requires that the tag GENERATE_HTML is set to YES.
1112 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1116 # This tag requires that the tag GENERATE_HTML is set to YES.
1120 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1123 # The default value is: YES.
1124 # This tag requires that the tag GENERATE_HTML is set to YES.
1128 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1131 # The default value is: NO.
1132 # This tag requires that the tag GENERATE_HTML is set to YES.
1141 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1145 # This tag requires that the tag GENERATE_HTML is set to YES.
1149 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1158 # The default value is: NO.
1159 # This tag requires that the tag GENERATE_HTML is set to YES.
1166 # The default value is: Doxygen generated docs.
1167 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1174 # The default value is: org.doxygen.Project.
1175 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1182 # The default value is: org.doxygen.Publisher.
1183 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1188 # The default value is: Publisher.
1189 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1193 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1195 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1206 # The default value is: NO.
1207 # This tag requires that the tag GENERATE_HTML is set to YES.
1214 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1222 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1226 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1228 # The default value is: NO.
1229 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1233 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1235 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1239 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1241 # The default value is: NO.
1242 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1248 # The default value is: NO.
1249 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1253 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1257 # The default value is: NO.
1258 # This tag requires that the tag GENERATE_HTML is set to YES.
1262 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1263 # the file name of the resulting .qch file. The path specified is relative to
1265 # This tag requires that the tag GENERATE_QHP is set to YES.
1272 # The default value is: org.doxygen.Project.
1273 # This tag requires that the tag GENERATE_QHP is set to YES.
1281 # The default value is: doc.
1282 # This tag requires that the tag GENERATE_QHP is set to YES.
1286 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1290 # This tag requires that the tag GENERATE_QHP is set to YES.
1298 # This tag requires that the tag GENERATE_QHP is set to YES.
1305 # This tag requires that the tag GENERATE_QHP is set to YES.
1312 # This tag requires that the tag GENERATE_QHP is set to YES.
1316 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1323 # The default value is: NO.
1324 # This tag requires that the tag GENERATE_HTML is set to YES.
1331 # The default value is: org.doxygen.Project.
1332 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1342 # The default value is: NO.
1343 # This tag requires that the tag GENERATE_HTML is set to YES.
1347 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1349 # value is set to YES, a side panel will be generated containing a tree-like
1350 # index structure (just like the one that is generated for HTML Help). For this
1351 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1359 # The default value is: NO.
1360 # This tag requires that the tag GENERATE_HTML is set to YES.
1370 # This tag requires that the tag GENERATE_HTML is set to YES.
1374 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1375 # to set the initial width (in pixels) of the frame in which the tree is shown.
1377 # This tag requires that the tag GENERATE_HTML is set to YES.
1381 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1383 # The default value is: NO.
1384 # This tag requires that the tag GENERATE_HTML is set to YES.
1393 # This tag requires that the tag GENERATE_HTML is set to YES.
1403 # The default value is: YES.
1404 # This tag requires that the tag GENERATE_HTML is set to YES.
1414 # The default value is: NO.
1415 # This tag requires that the tag GENERATE_HTML is set to YES.
1419 # When MathJax is enabled you can set the default output format to be used for
1422 # Possible values are: HTML-CSS (which is slower, but has the best
1424 # The default value is: HTML-CSS.
1425 # This tag requires that the tag USE_MATHJAX is set to YES.
1429 # When MathJax is enabled you need to specify the location relative to the HTML
1432 # is located at the same level as the HTML output directory, then
1435 # MathJax. However, it is strongly recommended to install a local copy of
1437 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1438 # This tag requires that the tag USE_MATHJAX is set to YES.
1445 # This tag requires that the tag USE_MATHJAX is set to YES.
1453 # This tag requires that the tag USE_MATHJAX is set to YES.
1457 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1461 # there is already a search function so this one should typically be disabled.
1463 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1465 # (what the <access key> is depends on the OS and browser, but it is typically
1469 # the search. The filter options can be selected when the cursor is inside the
1473 # The default value is: YES.
1474 # This tag requires that the tag GENERATE_HTML is set to YES.
1478 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1482 # searching and an index file used by the script. When EXTERNAL_SEARCH is
1485 # The default value is: NO.
1486 # This tag requires that the tag SEARCHENGINE is set to YES.
1490 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1501 # The default value is: NO.
1502 # This tag requires that the tag SEARCHENGINE is set to YES.
1507 # which will return the search results when EXTERNAL_SEARCH is enabled.
1513 # This tag requires that the tag SEARCHENGINE is set to YES.
1518 # search data is written to a file for indexing by an external tool. With the
1520 # The default file is: searchdata.xml.
1521 # This tag requires that the tag SEARCHENGINE is set to YES.
1526 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1529 # This tag requires that the tag SEARCHENGINE is set to YES.
1537 # to a relative location where the documentation can be found. The format is:
1539 # This tag requires that the tag SEARCHENGINE is set to YES.
1547 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1548 # The default value is: YES.
1552 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1553 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1555 # The default directory is: latex.
1556 # This tag requires that the tag GENERATE_LATEX is set to YES.
1563 # Note that when enabling USE_PDFLATEX this option is only used for generating
1564 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1566 # The default file is: latex.
1567 # This tag requires that the tag GENERATE_LATEX is set to YES.
1573 # The default file is: makeindex.
1574 # This tag requires that the tag GENERATE_LATEX is set to YES.
1578 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1581 # The default value is: NO.
1582 # This tag requires that the tag GENERATE_LATEX is set to YES.
1586 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1590 # The default value is: a4.
1591 # This tag requires that the tag GENERATE_LATEX is set to YES.
1600 # This tag requires that the tag GENERATE_LATEX is set to YES.
1606 # chapter. If it is left blank doxygen will generate a standard header. See
1616 # This tag requires that the tag GENERATE_LATEX is set to YES.
1622 # chapter. If it is left blank doxygen will generate a standard footer.
1625 # This tag requires that the tag GENERATE_LATEX is set to YES.
1631 # directory. Note that the files will be copied as-is; there are no commands or
1633 # This tag requires that the tag GENERATE_LATEX is set to YES.
1637 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1641 # The default value is: YES.
1642 # This tag requires that the tag GENERATE_LATEX is set to YES.
1646 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1649 # The default value is: YES.
1650 # This tag requires that the tag GENERATE_LATEX is set to YES.
1654 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1656 # if errors occur, instead of asking the user for help. This option is also used
1658 # The default value is: NO.
1659 # This tag requires that the tag GENERATE_LATEX is set to YES.
1663 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1665 # The default value is: NO.
1666 # This tag requires that the tag GENERATE_LATEX is set to YES.
1670 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1675 # The default value is: NO.
1676 # This tag requires that the tag GENERATE_LATEX is set to YES.
1683 # The default value is: plain.
1684 # This tag requires that the tag GENERATE_LATEX is set to YES.
1692 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1693 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1695 # The default value is: NO.
1699 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1700 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1702 # The default directory is: rtf.
1703 # This tag requires that the tag GENERATE_RTF is set to YES.
1707 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1710 # The default value is: NO.
1711 # This tag requires that the tag GENERATE_RTF is set to YES.
1715 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1722 # The default value is: NO.
1723 # This tag requires that the tag GENERATE_RTF is set to YES.
1727 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1733 # This tag requires that the tag GENERATE_RTF is set to YES.
1737 # Set optional variables used in the generation of an RTF document. Syntax is
1740 # This tag requires that the tag GENERATE_RTF is set to YES.
1748 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1750 # The default value is: NO.
1754 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1755 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1758 # The default directory is: man.
1759 # This tag requires that the tag GENERATE_MAN is set to YES.
1763 # The MAN_EXTENSION tag determines the extension that is added to the generated
1765 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1767 # The default value is: .3.
1768 # This tag requires that the tag GENERATE_MAN is set to YES.
1772 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1776 # The default value is: NO.
1777 # This tag requires that the tag GENERATE_MAN is set to YES.
1785 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1787 # The default value is: NO.
1791 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1792 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1794 # The default directory is: xml.
1795 # This tag requires that the tag GENERATE_XML is set to YES.
1801 # This tag requires that the tag GENERATE_XML is set to YES.
1807 # This tag requires that the tag GENERATE_XML is set to YES.
1811 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1815 # The default value is: YES.
1816 # This tag requires that the tag GENERATE_XML is set to YES.
1824 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1826 # The default value is: NO.
1830 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1831 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1833 # The default directory is: docbook.
1834 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1842 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1844 # the code including all documentation. Note that this feature is still
1846 # The default value is: NO.
1854 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1857 # Note that this feature is still experimental and incomplete at the moment.
1858 # The default value is: NO.
1862 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1865 # The default value is: NO.
1866 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1870 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1871 # formatted so it can be parsed by a human reader. This is useful if you want to
1872 # understand what is going on. On the other hand, if this tag is set to NO the
1875 # The default value is: YES.
1876 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1881 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1884 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1892 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1894 # The default value is: YES.
1898 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1902 # The default value is: NO.
1903 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1908 # the macro expansion is limited to the macros specified with the PREDEFINED and
1910 # The default value is: NO.
1911 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1915 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1916 # INCLUDE_PATH will be searched if a #include is found.
1917 # The default value is: YES.
1918 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1925 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1933 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1938 # defined before the preprocessor is started (similar to the -D option of e.g.
1939 # gcc). The argument of the tag is a list of macros of the form: name or
1941 # is assumed. To prevent a macro definition from being undefined via #undef or
1943 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1949 # macro definition that is found in the sources will be used. Use the PREDEFINED
1952 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1956 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1961 # The default value is: YES.
1962 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1972 # a tag file without this location is as follows:
1974 # Adding location for the tag files is done as follows:
1980 # the path). If a tag file is not located in the directory in which doxygen is
1985 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
1986 # tag file that is based on the input files it reads. See section "Linking to
1991 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1993 # The default value is: NO.
1997 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2000 # The default value is: YES.
2004 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2007 # The default value is: YES.
2013 # The default file (with absolute path) is: /usr/bin/perl.
2021 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2024 # disabled, but it is recommended to install and use dot, since it yields more
2026 # The default value is: YES.
2034 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2042 # If left empty dia is assumed to be found in the default search path.
2047 # and usage relations if the target is undocumented or is not a class.
2048 # The default value is: YES.
2052 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2053 # available from the path. This tool is part of Graphviz (see:
2055 # Bell Labs. The other options in this section have no effect if this option is
2057 # The default value is: NO.
2061 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2067 # This tag requires that the tag HAVE_DOT is set to YES.
2073 # sure dot is able to find the font, which can be done by putting it in a
2076 # The default value is: Helvetica.
2077 # This tag requires that the tag HAVE_DOT is set to YES.
2084 # This tag requires that the tag HAVE_DOT is set to YES.
2091 # This tag requires that the tag HAVE_DOT is set to YES.
2095 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2098 # The default value is: YES.
2099 # This tag requires that the tag HAVE_DOT is set to YES.
2103 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2107 # The default value is: YES.
2108 # This tag requires that the tag HAVE_DOT is set to YES.
2112 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2114 # The default value is: YES.
2115 # This tag requires that the tag HAVE_DOT is set to YES.
2119 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2122 # The default value is: NO.
2123 # This tag requires that the tag HAVE_DOT is set to YES.
2127 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2132 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2133 # but if the number exceeds 15, the total amount of fields shown is limited to
2136 # This tag requires that the tag HAVE_DOT is set to YES.
2140 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2143 # The default value is: NO.
2144 # This tag requires that the tag HAVE_DOT is set to YES.
2152 # The default value is: YES.
2153 # This tag requires that the tag HAVE_DOT is set to YES.
2161 # The default value is: YES.
2162 # This tag requires that the tag HAVE_DOT is set to YES.
2166 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2172 # The default value is: NO.
2173 # This tag requires that the tag HAVE_DOT is set to YES.
2177 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2183 # The default value is: NO.
2184 # This tag requires that the tag HAVE_DOT is set to YES.
2188 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2190 # The default value is: YES.
2191 # This tag requires that the tag HAVE_DOT is set to YES.
2195 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2199 # The default value is: YES.
2200 # This tag requires that the tag HAVE_DOT is set to YES.
2210 # The default value is: png.
2211 # This tag requires that the tag HAVE_DOT is set to YES.
2215 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2222 # The default value is: NO.
2223 # This tag requires that the tag HAVE_DOT is set to YES.
2228 # found. If left blank, it is assumed the dot tool can be found in the path.
2229 # This tag requires that the tag HAVE_DOT is set to YES.
2236 # This tag requires that the tag HAVE_DOT is set to YES.
2254 # larger than this value, doxygen will truncate the graph, which is visualized
2256 # children of the root node in a graph is already larger than
2260 # This tag requires that the tag HAVE_DOT is set to YES.
2272 # This tag requires that the tag HAVE_DOT is set to YES.
2277 # background. This is disabled by default, because dot on Windows does not seem
2283 # The default value is: NO.
2284 # This tag requires that the tag HAVE_DOT is set to YES.
2291 # this, this feature is disabled by default.
2292 # The default value is: NO.
2293 # This tag requires that the tag HAVE_DOT is set to YES.
2297 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2300 # The default value is: YES.
2301 # This tag requires that the tag HAVE_DOT is set to YES.
2305 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2307 # The default value is: YES.
2308 # This tag requires that the tag HAVE_DOT is set to YES.