Lines Matching refs:to

10 # This file describes the settings to be used by the documentation system
44 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
59 # the logo to the output directory.
63 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
65 # entered, it will be relative to the location where doxygen was started. If
70 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
80 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
81 # characters to appear in the names of generated files. If set to NO, non-ASCII
88 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
90 # information to generate all constant output in the proper language.
103 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
105 # documentation (similar to Javadoc). Set to NO to disable this.
110 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
113 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
120 # used to form the text in various listings. Each string in this list, if found
140 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
147 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
155 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
156 # before files name in the file list and in the header files. If set to NO the
162 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
164 # part of the path. The tag can be used to show relative paths in the file list.
165 # If left blank the directory from which doxygen is run is used as the path to
170 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
174 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
176 # header file to include in order to use a class. If left blank only the name of
178 # specify the list of include paths that are normally passed to the compiler
183 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
190 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
192 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
199 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
201 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
207 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
209 # a brief description. This used to be the default behavior. The new default is
210 # to treat a multi-line C++ comment block as a detailed description. Set this
211 # tag to YES if you prefer the old behavior instead.
213 # Note that setting this tag to YES also means that rational rose comments are
219 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
225 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
226 # page for each member. If set to NO, the documentation of a member will be part
232 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
233 # uses this value to replace tabs by spaces in code fragments.
238 # This tag can be used to specify a number of aliases that act as commands in
243 # will allow you to put the command \sideeffect (or @sideeffect) in the
245 # "Side Effects:". You can put \n's in the value part of an alias to insert
250 # This tag can be used to specify a number of word-keyword mappings (TCL only).
252 # will allow you to use the command class in the itcl::class meaning.
256 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
264 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
272 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
278 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
284 # Doxygen selects the parser to use depending on the extension of the files it
285 # parses. With this tag you can assign which parser to use for a given
291 # Fortran. In the later case the parser tries to guess whether the code is fixed
293 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
298 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
304 # according to the Markdown format, which allows for more readable
313 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
314 # to that level are automatically included in the table of contents, even if
316 # Note: This feature currently applies only to Markdown headings.
318 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
322 # When enabled doxygen tries to link words that correspond to documented
323 # classes, or namespaces to their corresponding documentation. Such a link can
325 # globally by setting AUTOLINK_SUPPORT to NO.
331 # to include (a tag file for) the STL sources as input, then you should set this
332 # tag to YES in order to let doxygen match functions declarations and
340 # If you use Microsoft's C++/CLI language, you should set this option to YES to
346 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
354 # For Microsoft's IDL there are propget and propput attributes to indicate
355 # getter and setter methods for a property. Setting this option to YES will make
356 # doxygen to replace the get and set methods by a property in the documentation.
358 # type. If this is not the case, or you want to show the methods anyway, you
359 # should set this option to NO.
365 # tag is set to YES then doxygen will reuse the documentation of the first
372 # If one adds a struct or class to a group and this option is enabled, then also
373 # any nested class or struct is added to the same group. By default this option
374 # is disabled and one has to add nested compounds explicitly via \ingroup.
379 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
380 # (for instance a group of public functions) to be put as a subgroup of that
381 # type (e.g. under the Public Functions section). Set it to NO to prevent
388 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
399 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
403 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
421 # cache is used to resolve symbols given their name and scope. Since this can be
426 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
437 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
440 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
442 # normally produced when WARNINGS is set to YES.
447 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
453 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
459 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
465 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
466 # locally in source files will be included in the documentation. If set to NO,
473 # This flag is only useful for Objective-C code. If set to YES, local methods,
475 # included in the documentation. If set to NO, only methods in the interface are
481 # If this flag is set to YES, the members of anonymous namespaces will be
490 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
491 # undocumented members inside documented classes or files. If set to NO these
498 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
500 # to NO, these classes will be included in the various overviews. This option
506 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
507 # (class|struct|union) declarations. If set to NO, these declarations will be
513 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
514 # documentation blocks found inside the body of a function. If set to NO, these
515 # blocks will be appended to the function's detailed documentation block.
521 # \internal command is included. If the tag is set to NO then the documentation
522 # will be excluded. Set it to YES to include the internal documentation.
527 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
528 # names in lower-case letters. If set to YES, upper-case letters are also
531 # and Mac users are advised to set this option to NO.
536 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
537 # their full class and namespace scopes in the documentation. If set to YES, the
543 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
544 # append additional text to a page's title, such as Class Reference. If set to
550 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
556 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
557 # grouped member an include statement to the documentation, telling the reader
558 # which file to include in order to use the member.
563 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
569 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
575 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
577 # name. If set to NO, the members will appear in declaration order.
582 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
584 # name. If set to NO, the members will appear in declaration order. Note that
590 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
592 # destructors are listed first. If set to NO the constructors will appear in the
594 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
596 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
602 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
603 # of group names into alphabetical order. If set to NO the group names will
609 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
610 # fully-qualified names, including namespaces. If set to NO, the class list will
612 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
613 # Note: This option applies only to the class list, not to the alphabetical
619 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
622 # only one candidate or it is obvious which candidate to choose by doing a
629 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
635 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
641 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
647 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
654 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
661 # initial value of a variable or macro / define can have for it to appear in the
663 # it will be hidden. Use a value of 0 to hide initializers completely. The
671 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
672 # the bottom of the documentation of classes and structs. If set to YES, the
673 # list will mention the files that were used to generate the documentation.
678 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
685 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
692 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
693 # doxygen should invoke to get the current version for each file (typically from
697 # by doxygen. Whatever the program writes to standard output is used as the file
702 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
715 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
718 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
721 # search path. See also \cite for info how to create references.
726 # Configuration options related to warning and progress messages
729 # The QUIET tag can be used to turn on/off the messages that are generated to
730 # standard output by doxygen. If QUIET is set to YES this implies that the
736 # The WARNINGS tag can be used to turn on/off the warning messages that are
737 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
745 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
746 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
752 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
760 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
762 # value. If set to NO, doxygen will only warn about wrong or incomplete
768 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
784 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
785 # messages should be written. If left blank the output is written to standard
791 # Configuration options related to the input files
794 # The INPUT tag is used to specify the files and/or directories that contain
806 # This tag can be used to specify the character encoding of the source files
816 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
817 # *.h) to filter out the source-files in the directories.
820 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
834 # The RECURSIVE tag can be used to specify whether or not subdirectories should
840 # The EXCLUDE tag can be used to specify files and/or directories that should be
844 # Note that relative paths are relative to the directory from which doxygen is
850 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
858 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
861 # Note that the wildcards are matched against the file with absolute path, so to
866 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
872 # Note that the wildcards are matched against the file with absolute path, so to
877 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
885 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
886 # *.h) to filter out the source-files in the directories. If left blank all
891 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
892 # searched for input files to be used with the \include or \dontinclude commands
898 # The IMAGE_PATH tag can be used to specify one or more files or directories
899 # that contain images that are to be included in the documentation (see the
904 # The INPUT_FILTER tag can be used to specify a program that doxygen should
905 # invoke to filter for each input file. Doxygen will invoke the filter program
912 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
920 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
925 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
933 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
938 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
939 # INPUT_FILTER) will also be used to filter the input files that are used for
940 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
945 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
947 # it is also possible to disable source filtering for a specific pattern using
949 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
953 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
956 # and want to reuse the introduction page also for the doxygen output.
961 # Configuration options related to source browsing
964 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
968 # also VERBATIM_HEADERS is set to NO.
973 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
979 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
986 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
992 # If the REFERENCES_RELATION tag is set to YES then for each documented function
998 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
999 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1000 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1001 # link to the documentation.
1008 # brief description and links to the definition and documentation. Since this
1010 # can opt to disable this feature.
1012 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1016 # If the USE_HTAGS tag is set to YES then the references to source code will
1017 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1025 # - Make sure the INPUT points to the root of the source tree
1031 # The result: instead of the source browser generated by doxygen, the links to
1032 # source code will now point to the output of htags.
1034 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1040 # specified. Set to NO to disable this.
1046 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1061 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1066 # Configuration options related to the alphabetical class index
1069 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1076 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1079 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1085 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1087 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1092 # Configuration options related to the HTML output
1095 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1100 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1104 # This tag requires that the tag GENERATE_HTML is set to YES.
1108 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1111 # This tag requires that the tag GENERATE_HTML is set to YES.
1115 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1121 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1126 # for information on how to generate the default header that doxygen normally
1128 # Note: The header is subject to change so you typically have to regenerate the
1129 # default header when upgrading to a newer version of doxygen. For a description
1131 # This tag requires that the tag GENERATE_HTML is set to YES.
1135 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1137 # footer. See HTML_HEADER for more information on how to generate a default
1139 # section "Doxygen usage" for information on how to generate the default footer
1141 # This tag requires that the tag GENERATE_HTML is set to YES.
1145 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1146 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1148 # See also section "Doxygen usage" for information on how to generate the style
1150 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1153 # This tag requires that the tag GENERATE_HTML is set to YES.
1157 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1162 # Doxygen will copy the style sheet files to the output directory.
1166 # This tag requires that the tag GENERATE_HTML is set to YES.
1170 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1171 # other source files which should be copied to the HTML output directory. Note
1172 # that these files will be copied to the base HTML output directory. Use the
1173 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1176 # This tag requires that the tag GENERATE_HTML is set to YES.
1181 # will adjust the colors in the style sheet and background images according to
1187 # This tag requires that the tag GENERATE_HTML is set to YES.
1195 # This tag requires that the tag GENERATE_HTML is set to YES.
1199 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1206 # This tag requires that the tag GENERATE_HTML is set to YES.
1210 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1212 # to YES can help to show when doxygen was last run and thus if the
1213 # documentation is up to date.
1215 # This tag requires that the tag GENERATE_HTML is set to YES.
1219 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1223 # This tag requires that the tag GENERATE_HTML is set to YES.
1229 # and collapse entries dynamically later on. Doxygen will expand the tree to
1236 # This tag requires that the tag GENERATE_HTML is set to YES.
1240 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1250 # This tag requires that the tag GENERATE_HTML is set to YES.
1258 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1264 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1266 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1274 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1280 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1284 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1298 # This tag requires that the tag GENERATE_HTML is set to YES.
1302 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1304 # written to the html output directory.
1305 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1309 # The HHC_LOCATION tag can be used to specify the location (absolute path
1311 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1312 # The file has to be specified with full path.
1313 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1320 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1324 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1326 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1334 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1338 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1339 # the table of contents of the HTML help documentation and to the tree view.
1341 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1345 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1347 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1350 # This tag requires that the tag GENERATE_HTML is set to YES.
1354 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1355 # the file name of the resulting .qch file. The path specified is relative to
1357 # This tag requires that the tag GENERATE_QHP is set to YES.
1361 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1365 # This tag requires that the tag GENERATE_QHP is set to YES.
1369 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1374 # This tag requires that the tag GENERATE_QHP is set to YES.
1379 # filter to add. For more information please see Qt Help Project / Custom
1382 # This tag requires that the tag GENERATE_QHP is set to YES.
1387 # custom filter to add. For more information please see Qt Help Project / Custom
1390 # This tag requires that the tag GENERATE_QHP is set to YES.
1397 # This tag requires that the tag GENERATE_QHP is set to YES.
1401 # The QHG_LOCATION tag can be used to specify the location of Qt's
1402 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1404 # This tag requires that the tag GENERATE_QHP is set to YES.
1408 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1412 # to be copied into the plugins directory of eclipse. The name of the directory
1414 # After copying Eclipse needs to be restarted before the help appears.
1416 # This tag requires that the tag GENERATE_HTML is set to YES.
1424 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1429 # be necessary to disable the index and replace it with your own. The
1430 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1433 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1435 # This tag requires that the tag GENERATE_HTML is set to YES.
1439 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1440 # structure should be generated to display hierarchical information. If the tag
1441 # value is set to YES, a side panel will be generated containing a tree-like
1443 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1447 # sheet generated by doxygen has an example that shows how to put an image at
1450 # DISABLE_INDEX to YES when enabling this option.
1452 # This tag requires that the tag GENERATE_HTML is set to YES.
1456 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1462 # This tag requires that the tag GENERATE_HTML is set to YES.
1467 # to set the initial width (in pixels) of the frame in which the tree is shown.
1469 # This tag requires that the tag GENERATE_HTML is set to YES.
1473 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1476 # This tag requires that the tag GENERATE_HTML is set to YES.
1480 # Use this tag to change the font size of LaTeX formulas included as images in
1482 # doxygen run you need to manually remove any form_*.png images from the HTML
1483 # output directory to force them to be regenerated.
1485 # This tag requires that the tag GENERATE_HTML is set to YES.
1489 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1493 # Note that when changing this option you need to delete any form_*.png files in
1496 # This tag requires that the tag GENERATE_HTML is set to YES.
1500 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1503 # installed or if you want to formulas look prettier in the HTML output. When
1504 # enabled you may also need to install MathJax separately and configure the path
1505 # to it using the MATHJAX_RELPATH option.
1507 # This tag requires that the tag GENERATE_HTML is set to YES.
1511 # When MathJax is enabled you can set the default output format to be used for
1517 # This tag requires that the tag USE_MATHJAX is set to YES.
1521 # When MathJax is enabled you need to specify the location relative to the HTML
1525 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1527 # MathJax. However, it is strongly recommended to install a local copy of
1530 # This tag requires that the tag USE_MATHJAX is set to YES.
1534 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1537 # This tag requires that the tag USE_MATHJAX is set to YES.
1541 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1545 # This tag requires that the tag USE_MATHJAX is set to YES.
1555 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1556 # search using the keyboard; to jump to the search box use <access key> + S
1559 # key> to jump into the search results window, the results can be navigated
1560 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1563 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1566 # This tag requires that the tag GENERATE_HTML is set to YES.
1575 # and searching needs to be provided by external tools. See the section
1578 # This tag requires that the tag SEARCHENGINE is set to YES.
1583 # script for searching. Instead the search results are written to an XML file
1584 # which needs to be processed by an external indexer. Doxygen will invoke an
1585 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1594 # This tag requires that the tag SEARCHENGINE is set to YES.
1598 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1605 # This tag requires that the tag SEARCHENGINE is set to YES.
1610 # search data is written to a file for indexing by an external tool. With the
1613 # This tag requires that the tag SEARCHENGINE is set to YES.
1619 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1620 # projects and redirect the results back to the right project.
1621 # This tag requires that the tag SEARCHENGINE is set to YES.
1625 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1627 # all added to the same external search index. Each project needs to have a
1629 # to a relative location where the documentation can be found. The format is:
1631 # This tag requires that the tag SEARCHENGINE is set to YES.
1636 # Configuration options related to the LaTeX output
1639 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1644 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1648 # This tag requires that the tag GENERATE_LATEX is set to YES.
1652 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1657 # written to the output directory.
1659 # This tag requires that the tag GENERATE_LATEX is set to YES.
1663 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1666 # This tag requires that the tag GENERATE_LATEX is set to YES.
1670 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1671 # documents. This may be useful for small projects and may help to save some
1674 # This tag requires that the tag GENERATE_LATEX is set to YES.
1678 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1683 # This tag requires that the tag GENERATE_LATEX is set to YES.
1687 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1689 # by its name or with the correct syntax as to be used with the LaTeX
1695 # This tag requires that the tag GENERATE_LATEX is set to YES.
1699 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1702 # section "Doxygen usage" for information on how to let doxygen write the
1703 # default header to a separate file.
1710 # to HTML_HEADER.
1711 # This tag requires that the tag GENERATE_LATEX is set to YES.
1715 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1718 # LATEX_HEADER for more information on how to generate a default footer and what
1722 # This tag requires that the tag GENERATE_LATEX is set to YES.
1726 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1729 # will copy the style sheet files to the output directory.
1733 # This tag requires that the tag GENERATE_LATEX is set to YES.
1737 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1738 # other source files which should be copied to the LATEX_OUTPUT output
1741 # This tag requires that the tag GENERATE_LATEX is set to YES.
1745 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1746 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1750 # This tag requires that the tag GENERATE_LATEX is set to YES.
1754 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1755 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1758 # This tag requires that the tag GENERATE_LATEX is set to YES.
1762 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1763 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1767 # This tag requires that the tag GENERATE_LATEX is set to YES.
1771 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1774 # This tag requires that the tag GENERATE_LATEX is set to YES.
1778 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1784 # This tag requires that the tag GENERATE_LATEX is set to YES.
1788 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1792 # This tag requires that the tag GENERATE_LATEX is set to YES.
1796 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1798 # to NO can help when comparing the output of multiple runs.
1800 # This tag requires that the tag GENERATE_LATEX is set to YES.
1805 # Configuration options related to the RTF output
1808 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1815 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1819 # This tag requires that the tag GENERATE_RTF is set to YES.
1823 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1824 # documents. This may be useful for small projects and may help to save some
1827 # This tag requires that the tag GENERATE_RTF is set to YES.
1831 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1839 # This tag requires that the tag GENERATE_RTF is set to YES.
1843 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1844 # file, i.e. a series of assignments. You only have to provide replacements,
1845 # missing definitions are set to their default value.
1847 # See also section "Doxygen usage" for information on how to generate the
1849 # This tag requires that the tag GENERATE_RTF is set to YES.
1854 # similar to doxygen's config file. A template extensions file can be generated
1856 # This tag requires that the tag GENERATE_RTF is set to YES.
1860 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1866 # This tag requires that the tag GENERATE_RTF is set to YES.
1871 # Configuration options related to the man page output
1874 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1880 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1885 # This tag requires that the tag GENERATE_MAN is set to YES.
1889 # The MAN_EXTENSION tag determines the extension that is added to the generated
1894 # This tag requires that the tag GENERATE_MAN is set to YES.
1899 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1901 # This tag requires that the tag GENERATE_MAN is set to YES.
1905 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1908 # them the man command would be unable to find the correct page.
1910 # This tag requires that the tag GENERATE_MAN is set to YES.
1915 # Configuration options related to the XML output
1918 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1924 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1928 # This tag requires that the tag GENERATE_XML is set to YES.
1932 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1933 # listings (including syntax highlighting and cross-referencing information) to
1937 # This tag requires that the tag GENERATE_XML is set to YES.
1942 # Configuration options related to the DOCBOOK output
1945 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1946 # that can be used to generate PDF.
1951 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1955 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1959 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1961 # information) to the DOCBOOK output. Note that enabling this will significantly
1964 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1972 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1981 # Configuration options related to the Perl module output
1984 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1992 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1993 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1996 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2000 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2001 # formatted so it can be parsed by a human reader. This is useful if you want to
2002 # understand what is going on. On the other hand, if this tag is set to NO, the
2006 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2014 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2019 # Configuration options related to the preprocessor
2022 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2028 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2029 # in the source code. If set to NO, only conditional compilation will be
2031 # EXPAND_ONLY_PREDEF to YES.
2033 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2037 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2038 # the macro expansion is limited to the macros specified with the PREDEFINED and
2041 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2045 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2048 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2052 # The INCLUDE_PATH tag can be used to specify one or more directories that
2055 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2059 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2060 # patterns (like *.h and *.hpp) to filter out the header-files in the
2063 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2068 # The PREDEFINED tag can be used to specify one or more macro names that are
2069 # defined before the preprocessor is started (similar to the -D option of e.g.
2074 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2079 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2080 # tag can be used to specify a list of macro names that should be expanded. The
2082 # tag if you want to use a different macro definition that overrules the
2084 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2088 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2089 # remove all references to function-like macros that are alone on a line, have
2094 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2099 # Configuration options related to external references
2102 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2109 # section "Linking to external documentation" for more information about the use
2113 # run, you must also specify the path to the tagfile here.
2118 # tag file that is based on the input files it reads. See section "Linking to
2123 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2124 # the class index. If set to NO, only the inherited external classes will be
2130 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2131 # in the modules index. If set to NO, only the current project's groups will be
2137 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2138 # the related pages index. If set to NO, only the current project's pages will
2151 # Configuration options related to the dot tool
2154 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2155 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2157 # disabled, but it is recommended to install and use dot, since it yields more
2165 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2166 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2167 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2173 # then run dia to produce the diagram and insert it in the documentation. The
2174 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2175 # If left empty dia is assumed to be found in the default search path.
2179 # If set to YES the inheritance and collaboration graphs will hide inheritance
2185 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2189 # set to NO
2195 # to run in parallel. When set to 0 doxygen will base this on the number of
2196 # processors available in the system. You can set it explicitly to a value
2197 # larger than 0 to get control over the balance between CPU load and processing
2200 # This tag requires that the tag HAVE_DOT is set to YES.
2205 # generates you can specify the font name using DOT_FONTNAME. You need to make
2206 # sure dot is able to find the font, which can be done by putting it in a
2208 # setting DOT_FONTPATH to the directory containing the font.
2210 # This tag requires that the tag HAVE_DOT is set to YES.
2214 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2217 # This tag requires that the tag HAVE_DOT is set to YES.
2221 # By default doxygen will tell dot to use the default font as specified with
2224 # This tag requires that the tag HAVE_DOT is set to YES.
2228 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2230 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2232 # This tag requires that the tag HAVE_DOT is set to YES.
2236 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2241 # This tag requires that the tag HAVE_DOT is set to YES.
2245 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2248 # This tag requires that the tag HAVE_DOT is set to YES.
2252 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2253 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2256 # This tag requires that the tag HAVE_DOT is set to YES.
2262 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2263 # number of items for each type to make the size more manageable. Set this to 0
2265 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2266 # but if the number exceeds 15, the total amount of fields shown is limited to
2269 # This tag requires that the tag HAVE_DOT is set to YES.
2273 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2277 # This tag requires that the tag HAVE_DOT is set to YES.
2281 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2286 # This tag requires that the tag HAVE_DOT is set to YES.
2291 # set to YES then doxygen will generate a graph for each documented file showing
2295 # This tag requires that the tag HAVE_DOT is set to YES.
2299 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2303 # So in most cases it will be better to enable call graphs for selected
2307 # This tag requires that the tag HAVE_DOT is set to YES.
2311 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2315 # So in most cases it will be better to enable caller graphs for selected
2319 # This tag requires that the tag HAVE_DOT is set to YES.
2323 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2326 # This tag requires that the tag HAVE_DOT is set to YES.
2330 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2335 # This tag requires that the tag HAVE_DOT is set to YES.
2339 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2343 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2344 # to make the SVG files visible in IE 9+ (other browsers do not have this
2350 # This tag requires that the tag HAVE_DOT is set to YES.
2354 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2359 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2362 # This tag requires that the tag HAVE_DOT is set to YES.
2366 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2368 # This tag requires that the tag HAVE_DOT is set to YES.
2372 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2375 # This tag requires that the tag HAVE_DOT is set to YES.
2379 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2385 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2391 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2404 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2412 # This tag requires that the tag HAVE_DOT is set to YES.
2416 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2419 # further from the root node will be omitted. Note that setting this option to 1
2424 # This tag requires that the tag HAVE_DOT is set to YES.
2428 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2430 # to support this out of the box.
2432 # Warning: Depending on the platform used, enabling this option may lead to
2433 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2436 # This tag requires that the tag HAVE_DOT is set to YES.
2440 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2445 # This tag requires that the tag HAVE_DOT is set to YES.
2449 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2453 # This tag requires that the tag HAVE_DOT is set to YES.
2457 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2458 # files that are used to generate the various graphs.
2460 # This tag requires that the tag HAVE_DOT is set to YES.