Lines Matching refs: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 a logo or an icon that is included
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 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
77 # The default value is: NO.
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82 # documentation generated by doxygen is written. Doxygen will use this
92 # The default value is: English.
96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
99 # The default value is: YES.
103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
108 # The default value is: YES.
112 # This tag implements a quasi-intelligent brief description abbreviator that is
115 # and the result, after processing the whole list, is used as the annotated
116 # text. Otherwise, the brief description is used as-is. If left blank, the
117 # following values are used ($name is automatically replaced with the name of
118 # the entity):The $name class, The $name widget, The $name file, is, provides,
124 # doxygen will generate a detailed section even if there is only a brief
126 # The default value is: NO.
130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
134 # The default value is: NO.
138 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
141 # The default value is: YES.
146 # Stripping is only done if one of the specified strings matches the left-hand
148 # If left blank the directory from which doxygen is run is used as the path to
152 # will be relative from the directory where doxygen is started.
153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
160 # the header file containing the class definition is used. Otherwise one should
166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167 # less readable) file names. This can be useful is your file systems doesn't
169 # The default value is: NO.
173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
178 # The default value is: NO.
182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
186 # The default value is: NO.
192 # a brief description. This used to be the default behavior. The new default is
198 # The default value is: NO.
202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
204 # The default value is: YES.
208 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
211 # The default value is: NO.
240 # only. Doxygen will then generate output that is more tailored for C. For
243 # The default value is: NO.
248 # Python sources only. Doxygen will then generate output that is more tailored
251 # The default value is: NO.
256 # sources. Doxygen will then generate output that is tailored for Fortran.
257 # The default value is: NO.
262 # sources. Doxygen will then generate output that is tailored for VHDL.
263 # The default value is: NO.
270 # using this tag. The format is ext=language, where ext is a file extension, and
271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
274 # Fortran. In the later case the parser tries to guess whether the code is fixed
275 # or free formatted code, this is the default for Fortran type files), VHDL. For
276 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
277 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
289 # The output of markdown processing is further processed by doxygen, so you can
292 # The default value is: YES.
300 # The default value is: YES.
310 # The default value is: NO.
316 # The default value is: NO.
323 # of private inheritance when no explicit protection keyword is present.
324 # The default value is: NO.
332 # type. If this is not the case, or you want to show the methods anyway, you
334 # The default value is: YES.
338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339 # tag is set to YES then doxygen will reuse the documentation of the first
342 # The default value is: NO.
346 # If one adds a struct or class to a group and this option is enabled, then also
347 # any nested class or struct is added to the same group. By default this option
348 # is disabled and one has to add nested compounds explicitly via \ingroup.
349 # The default value is: NO.
358 # The default value is: YES.
362 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
369 # The default value is: NO.
373 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
376 # namespace, or group documentation), provided this scope is documented. If set
379 # The default value is: NO.
383 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
384 # enum is documented as struct, union, or enum with the name of the typedef. So
389 # types are typedef'ed and only the typedef is referenced, never the tag name.
390 # The default value is: NO.
395 # cache is used to resolve symbols given their name and scope. Since this can be
397 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
398 # doxygen will become slower. If the cache is too large, memory is wasted. The
399 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
400 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
411 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
416 # normally produced when WARNINGS is set to YES.
417 # The default value is: NO.
421 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
423 # The default value is: NO.
427 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
429 # The default value is: NO.
433 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
435 # The default value is: NO.
439 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
443 # The default value is: YES.
447 # This flag is only useful for Objective-C code. If set to YES, local methods,
451 # The default value is: NO.
455 # If this flag is set to YES, the members of anonymous namespaces will be
460 # The default value is: NO.
464 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
467 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
468 # The default value is: NO.
472 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
475 # has no effect if EXTRACT_ALL is enabled.
476 # The default value is: NO.
480 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
483 # The default value is: NO.
487 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
490 # The default value is: NO.
494 # The INTERNAL_DOCS tag determines if documentation that is typed after a
495 # \internal command is included. If the tag is set to NO then the documentation
497 # The default value is: NO.
501 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
503 # allowed. This is useful if you have classes or files whose names only differ
506 # The default value is: system dependent.
510 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
513 # The default value is: NO.
517 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
520 # The default value is: NO.
524 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
526 # The default value is: YES.
530 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
533 # The default value is: NO.
537 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
539 # The default value is: NO.
543 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
545 # The default value is: YES.
549 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
552 # The default value is: YES.
556 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
560 # The default value is: NO.
564 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
568 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
570 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
572 # The default value is: NO.
576 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
579 # The default value is: NO.
583 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
586 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
589 # The default value is: NO.
593 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
595 # the prototype and the implementation of a member function even if there is
596 # only one candidate or it is obvious which candidate to choose by doing a
599 # The default value is: NO.
604 # list. This list is created by putting \todo commands in the documentation.
605 # The default value is: YES.
610 # list. This list is created by putting \test commands in the documentation.
611 # The default value is: YES.
616 # list. This list is created by putting \bug commands in the documentation.
617 # The default value is: YES.
622 # the deprecated list. This list is created by putting \deprecated commands in
624 # The default value is: YES.
648 # The default value is: YES.
655 # The default value is: YES.
662 # The default value is: YES.
669 # popen()) the command command input-file, where command is the value of the
670 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
671 # by doxygen. Whatever the program writes to standard output is used as the file
685 # tag is left empty.
691 # extension is automatically appended if omitted. This requires the bibtex tool
704 # standard output by doxygen. If QUIET is set to YES this implies that the
706 # The default value is: NO.
711 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
715 # The default value is: YES.
719 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
720 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
722 # The default value is: YES.
726 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
730 # The default value is: YES.
738 # The default value is: NO.
742 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
743 # a warning is encountered.
744 # The default value is: NO.
754 # The default value is: $file:$line: $text.
759 # messages should be written. If left blank the output is written to standard
768 # The INPUT tag is used to specify the files and/or directories that contain
772 # Note: If this tag is empty the current directory is searched.
781 # The default value is: UTF-8.
803 # The default value is: NO.
809 # subdirectory from a directory tree whose root is specified with the INPUT tag.
811 # Note that relative paths are relative to the directory from which doxygen is
819 # The default value is: NO.
835 # wildcard * is used, a substring. Examples: ANamespace, AClass,
856 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
859 # The default value is: NO.
875 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
877 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
880 # Note that the filter must not add or remove lines; it is applied before the
881 # code is scanned, but not when the output code is generated. If lines are added
892 # filter if there is a match. The filters are a list of the form: pattern=filter
894 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
895 # patterns match the file name, INPUT_FILTER is applied.
903 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
905 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
906 # The default value is: NO.
912 # it is also possible to disable source filtering for a specific pattern using
914 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
919 # is part of the input, its contents will be placed on the main page
929 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
933 # also VERBATIM_HEADERS is set to NO.
934 # The default value is: NO.
940 # The default value is: NO.
947 # The default value is: YES.
951 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
953 # The default value is: NO.
957 # If the REFERENCES_RELATION tag is set to YES then for each documented function
959 # The default value is: NO.
963 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
967 # The default value is: YES.
971 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
976 # The default value is: YES.
977 # This tag requires that the tag SOURCE_BROWSER is set to YES.
981 # If the USE_HTAGS tag is set to YES then the references to source code will
983 # source browser. The htags tool is part of GNU's global source tagging system
998 # The default value is: NO.
999 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1003 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1004 # verbatim copy of the header file for each class for which an include is
1007 # The default value is: YES.
1011 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1018 # The default value is: NO.
1022 # If clang assisted parsing is enabled you can provide the compiler with command
1026 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1034 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1037 # The default value is: YES.
1044 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1052 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1060 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1061 # The default value is: YES.
1065 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1066 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1068 # The default directory is: html.
1069 # This tag requires that the tag GENERATE_HTML is set to YES.
1075 # The default value is: .html.
1076 # This tag requires that the tag GENERATE_HTML is set to YES.
1081 # each generated HTML page. If the tag is left blank doxygen will generate a
1085 # that doxygen needs, which is dependent on the configuration options used (e.g.
1086 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1093 # Note: The header is subject to change so you typically have to regenerate the
1096 # This tag requires that the tag GENERATE_HTML is set to YES.
1101 # generated HTML page. If the tag is left blank doxygen will generate a standard
1106 # This tag requires that the tag GENERATE_HTML is set to YES.
1111 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1115 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1116 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1118 # This tag requires that the tag GENERATE_HTML is set to YES.
1125 # This is preferred over using HTML_STYLESHEET since it does not replace the
1126 # standard style sheet and is therefore more robust against future updates.
1128 # Note: The order of the extra style sheet files is of importance (e.g. the last
1131 # This tag requires that the tag GENERATE_HTML is set to YES.
1140 # files will be copied as-is; there are no commands or markers available.
1141 # This tag requires that the tag GENERATE_HTML is set to YES.
1147 # this color. Hue is specified as an angle on a colorwheel, see
1149 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1150 # purple, and 360 is red again.
1152 # This tag requires that the tag GENERATE_HTML is set to YES.
1160 # This tag requires that the tag GENERATE_HTML is set to YES.
1167 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1171 # This tag requires that the tag GENERATE_HTML is set to YES.
1175 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1178 # documentation is up to date.
1179 # The default value is: NO.
1180 # This tag requires that the tag GENERATE_HTML is set to YES.
1184 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1187 # The default value is: NO.
1188 # This tag requires that the tag GENERATE_HTML is set to YES.
1197 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1201 # This tag requires that the tag GENERATE_HTML is set to YES.
1205 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1214 # The default value is: NO.
1215 # This tag requires that the tag GENERATE_HTML is set to YES.
1222 # The default value is: Doxygen generated docs.
1223 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1230 # The default value is: org.doxygen.Project.
1231 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1238 # The default value is: org.doxygen.Publisher.
1239 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1244 # The default value is: Publisher.
1245 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1249 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1251 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1262 # The default value is: NO.
1263 # This tag requires that the tag GENERATE_HTML is set to YES.
1270 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1278 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1282 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1284 # The default value is: NO.
1285 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1289 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1291 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1295 # The BINARY_TOC flag controls whether a binary table of contents is generated
1298 # The default value is: NO.
1299 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1305 # The default value is: NO.
1306 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1310 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1314 # The default value is: NO.
1315 # This tag requires that the tag GENERATE_HTML is set to YES.
1319 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1320 # the file name of the resulting .qch file. The path specified is relative to
1322 # This tag requires that the tag GENERATE_QHP is set to YES.
1329 # The default value is: org.doxygen.Project.
1330 # This tag requires that the tag GENERATE_QHP is set to YES.
1338 # The default value is: doc.
1339 # This tag requires that the tag GENERATE_QHP is set to YES.
1343 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1347 # This tag requires that the tag GENERATE_QHP is set to YES.
1355 # This tag requires that the tag GENERATE_QHP is set to YES.
1362 # This tag requires that the tag GENERATE_QHP is set to YES.
1369 # This tag requires that the tag GENERATE_QHP is set to YES.
1373 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1380 # The default value is: NO.
1381 # This tag requires that the tag GENERATE_HTML is set to YES.
1388 # The default value is: org.doxygen.Project.
1389 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1399 # The default value is: NO.
1400 # This tag requires that the tag GENERATE_HTML is set to YES.
1404 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1406 # value is set to YES, a side panel will be generated containing a tree-like
1407 # index structure (just like the one that is generated for HTML Help). For this
1408 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1416 # The default value is: NO.
1417 # This tag requires that the tag GENERATE_HTML is set to YES.
1427 # This tag requires that the tag GENERATE_HTML is set to YES.
1431 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1432 # to set the initial width (in pixels) of the frame in which the tree is shown.
1434 # This tag requires that the tag GENERATE_HTML is set to YES.
1438 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1440 # The default value is: NO.
1441 # This tag requires that the tag GENERATE_HTML is set to YES.
1450 # This tag requires that the tag GENERATE_HTML is set to YES.
1460 # The default value is: YES.
1461 # This tag requires that the tag GENERATE_HTML is set to YES.
1471 # The default value is: NO.
1472 # This tag requires that the tag GENERATE_HTML is set to YES.
1476 # When MathJax is enabled you can set the default output format to be used for
1479 # Possible values are: HTML-CSS (which is slower, but has the best
1481 # The default value is: HTML-CSS.
1482 # This tag requires that the tag USE_MATHJAX is set to YES.
1486 # When MathJax is enabled you need to specify the location relative to the HTML
1489 # is located at the same level as the HTML output directory, then
1492 # MathJax. However, it is strongly recommended to install a local copy of
1494 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1495 # This tag requires that the tag USE_MATHJAX is set to YES.
1502 # This tag requires that the tag USE_MATHJAX is set to YES.
1510 # This tag requires that the tag USE_MATHJAX is set to YES.
1514 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1518 # there is already a search function so this one should typically be disabled.
1520 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1522 # (what the <access key> is depends on the OS and browser, but it is typically
1526 # the search. The filter options can be selected when the cursor is inside the
1530 # The default value is: YES.
1531 # This tag requires that the tag GENERATE_HTML is set to YES.
1535 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1539 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1542 # The default value is: NO.
1543 # This tag requires that the tag SEARCHENGINE is set to YES.
1547 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1558 # The default value is: NO.
1559 # This tag requires that the tag SEARCHENGINE is set to YES.
1564 # which will return the search results when EXTERNAL_SEARCH is enabled.
1570 # This tag requires that the tag SEARCHENGINE is set to YES.
1575 # search data is written to a file for indexing by an external tool. With the
1577 # The default file is: searchdata.xml.
1578 # This tag requires that the tag SEARCHENGINE is set to YES.
1583 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1586 # This tag requires that the tag SEARCHENGINE is set to YES.
1594 # to a relative location where the documentation can be found. The format is:
1596 # This tag requires that the tag SEARCHENGINE is set to YES.
1604 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1605 # The default value is: YES.
1609 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1610 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1612 # The default directory is: latex.
1613 # This tag requires that the tag GENERATE_LATEX is set to YES.
1620 # Note that when enabling USE_PDFLATEX this option is only used for generating
1621 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1623 # The default file is: latex.
1624 # This tag requires that the tag GENERATE_LATEX is set to YES.
1630 # The default file is: makeindex.
1631 # This tag requires that the tag GENERATE_LATEX is set to YES.
1635 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1638 # The default value is: NO.
1639 # This tag requires that the tag GENERATE_LATEX is set to YES.
1643 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1647 # The default value is: a4.
1648 # This tag requires that the tag GENERATE_LATEX is set to YES.
1660 # This tag requires that the tag GENERATE_LATEX is set to YES.
1666 # chapter. If it is left blank doxygen will generate a standard header. See
1674 # string, for the replacement values of the other commands the user is referred
1676 # This tag requires that the tag GENERATE_LATEX is set to YES.
1682 # chapter. If it is left blank doxygen will generate a standard footer. See
1687 # This tag requires that the tag GENERATE_LATEX is set to YES.
1695 # Note: The order of the extra style sheet files is of importance (e.g. the last
1698 # This tag requires that the tag GENERATE_LATEX is set to YES.
1704 # directory. Note that the files will be copied as-is; there are no commands or
1706 # This tag requires that the tag GENERATE_LATEX is set to YES.
1710 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1714 # The default value is: YES.
1715 # This tag requires that the tag GENERATE_LATEX is set to YES.
1719 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1722 # The default value is: YES.
1723 # This tag requires that the tag GENERATE_LATEX is set to YES.
1727 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1729 # if errors occur, instead of asking the user for help. This option is also used
1731 # The default value is: NO.
1732 # This tag requires that the tag GENERATE_LATEX is set to YES.
1736 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1738 # The default value is: NO.
1739 # This tag requires that the tag GENERATE_LATEX is set to YES.
1743 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1748 # The default value is: NO.
1749 # This tag requires that the tag GENERATE_LATEX is set to YES.
1756 # The default value is: plain.
1757 # This tag requires that the tag GENERATE_LATEX is set to YES.
1761 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1764 # The default value is: NO.
1765 # This tag requires that the tag GENERATE_LATEX is set to YES.
1773 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1774 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1776 # The default value is: NO.
1780 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1781 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1783 # The default directory is: rtf.
1784 # This tag requires that the tag GENERATE_RTF is set to YES.
1788 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1791 # The default value is: NO.
1792 # This tag requires that the tag GENERATE_RTF is set to YES.
1796 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1803 # The default value is: NO.
1804 # This tag requires that the tag GENERATE_RTF is set to YES.
1808 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1814 # This tag requires that the tag GENERATE_RTF is set to YES.
1818 # Set optional variables used in the generation of an RTF document. Syntax is
1821 # This tag requires that the tag GENERATE_RTF is set to YES.
1825 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1830 # The default value is: NO.
1831 # This tag requires that the tag GENERATE_RTF is set to YES.
1839 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1841 # The default value is: NO.
1845 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1846 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1849 # The default directory is: man.
1850 # This tag requires that the tag GENERATE_MAN is set to YES.
1854 # The MAN_EXTENSION tag determines the extension that is added to the generated
1856 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1858 # The default value is: .3.
1859 # This tag requires that the tag GENERATE_MAN is set to YES.
1866 # This tag requires that the tag GENERATE_MAN is set to YES.
1870 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1874 # The default value is: NO.
1875 # This tag requires that the tag GENERATE_MAN is set to YES.
1883 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1885 # The default value is: NO.
1889 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1890 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1892 # The default directory is: xml.
1893 # This tag requires that the tag GENERATE_XML is set to YES.
1897 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1901 # The default value is: YES.
1902 # This tag requires that the tag GENERATE_XML is set to YES.
1910 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1912 # The default value is: NO.
1916 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1917 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1919 # The default directory is: docbook.
1920 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1924 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1928 # The default value is: NO.
1929 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1937 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1939 # structure of the code including all documentation. Note that this feature is
1941 # The default value is: NO.
1949 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1952 # Note that this feature is still experimental and incomplete at the moment.
1953 # The default value is: NO.
1957 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1960 # The default value is: NO.
1961 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1965 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1966 # formatted so it can be parsed by a human reader. This is useful if you want to
1967 # understand what is going on. On the other hand, if this tag is set to NO, the
1970 # The default value is: YES.
1971 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1976 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1979 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1987 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1989 # The default value is: YES.
1993 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1997 # The default value is: NO.
1998 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2003 # the macro expansion is limited to the macros specified with the PREDEFINED and
2005 # The default value is: NO.
2006 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2010 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2011 # INCLUDE_PATH will be searched if a #include is found.
2012 # The default value is: YES.
2013 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2020 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2028 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2033 # defined before the preprocessor is started (similar to the -D option of e.g.
2034 # gcc). The argument of the tag is a list of macros of the form: name or
2036 # is assumed. To prevent a macro definition from being undefined via #undef or
2038 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2044 # macro definition that is found in the sources will be used. Use the PREDEFINED
2047 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2051 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2056 # The default value is: YES.
2057 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2067 # a tag file without this location is as follows:
2069 # Adding location for the tag files is done as follows:
2075 # the path). If a tag file is not located in the directory in which doxygen is
2080 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2081 # tag file that is based on the input files it reads. See section "Linking to
2086 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2089 # The default value is: NO.
2093 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2096 # The default value is: YES.
2100 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2103 # The default value is: YES.
2109 # The default file (with absolute path) is: /usr/bin/perl.
2117 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2120 # disabled, but it is recommended to install and use dot, since it yields more
2122 # The default value is: YES.
2130 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2138 # If left empty dia is assumed to be found in the default search path.
2143 # and usage relations if the target is undocumented or is not a class.
2144 # The default value is: YES.
2148 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2149 # available from the path. This tool is part of Graphviz (see:
2151 # Bell Labs. The other options in this section have no effect if this option is
2153 # The default value is: YES.
2157 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2163 # This tag requires that the tag HAVE_DOT is set to YES.
2169 # sure dot is able to find the font, which can be done by putting it in a
2172 # The default value is: Helvetica.
2173 # This tag requires that the tag HAVE_DOT is set to YES.
2180 # This tag requires that the tag HAVE_DOT is set to YES.
2187 # This tag requires that the tag HAVE_DOT is set to YES.
2191 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2194 # The default value is: YES.
2195 # This tag requires that the tag HAVE_DOT is set to YES.
2199 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2203 # The default value is: YES.
2204 # This tag requires that the tag HAVE_DOT is set to YES.
2208 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2210 # The default value is: YES.
2211 # This tag requires that the tag HAVE_DOT is set to YES.
2215 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2218 # The default value is: NO.
2219 # This tag requires that the tag HAVE_DOT is set to YES.
2223 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2228 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2229 # but if the number exceeds 15, the total amount of fields shown is limited to
2232 # This tag requires that the tag HAVE_DOT is set to YES.
2236 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2239 # The default value is: NO.
2240 # This tag requires that the tag HAVE_DOT is set to YES.
2248 # The default value is: YES.
2249 # This tag requires that the tag HAVE_DOT is set to YES.
2257 # The default value is: YES.
2258 # This tag requires that the tag HAVE_DOT is set to YES.
2262 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2269 # The default value is: NO.
2270 # This tag requires that the tag HAVE_DOT is set to YES.
2274 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2281 # The default value is: NO.
2282 # This tag requires that the tag HAVE_DOT is set to YES.
2286 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2288 # The default value is: YES.
2289 # This tag requires that the tag HAVE_DOT is set to YES.
2293 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2297 # The default value is: YES.
2298 # This tag requires that the tag HAVE_DOT is set to YES.
2314 # The default value is: png.
2315 # This tag requires that the tag HAVE_DOT is set to YES.
2319 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2326 # The default value is: NO.
2327 # This tag requires that the tag HAVE_DOT is set to YES.
2332 # found. If left blank, it is assumed the dot tool can be found in the path.
2333 # This tag requires that the tag HAVE_DOT is set to YES.
2340 # This tag requires that the tag HAVE_DOT is set to YES.
2357 # path where java can find the plantuml.jar file. If left blank, it is assumed
2358 # PlantUML is not used or called during a preprocessing step. Doxygen will
2371 # larger than this value, doxygen will truncate the graph, which is visualized
2373 # children of the root node in a graph is already larger than
2377 # This tag requires that the tag HAVE_DOT is set to YES.
2389 # This tag requires that the tag HAVE_DOT is set to YES.
2394 # background. This is disabled by default, because dot on Windows does not seem
2400 # The default value is: NO.
2401 # This tag requires that the tag HAVE_DOT is set to YES.
2408 # this, this feature is disabled by default.
2409 # The default value is: NO.
2410 # This tag requires that the tag HAVE_DOT is set to YES.
2414 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2417 # The default value is: YES.
2418 # This tag requires that the tag HAVE_DOT is set to YES.
2422 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2424 # The default value is: YES.
2425 # This tag requires that the tag HAVE_DOT is set to YES.