Lines Matching full:to

3 # This file describes the settings to be used by the documentation system
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
52 # the logo to the output directory.
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
58 # entered, it will be relative to the location where doxygen was started. If
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74 # characters to appear in the names of generated files. If set to NO, non-ASCII
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
83 # information to generate all constant output in the proper language.
96 # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
98 # information to generate all generated output in the proper direction.
104 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
106 # documentation (similar to Javadoc). Set to NO to disable this.
111 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
114 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
121 # used to form the text in various listings. Each string in this list, if found
141 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
148 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
156 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
157 # before files name in the file list and in the header files. If set to NO the
163 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
165 # part of the path. The tag can be used to show relative paths in the file list.
166 # If left blank the directory from which doxygen is run is used as the path to
171 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
175 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
177 # header file to include in order to use a class. If left blank only the name of
179 # specify the list of include paths that are normally passed to the compiler
184 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
191 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
193 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
200 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
203 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
210 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
212 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
218 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
220 # a brief description. This used to be the default behavior. The new default is
221 # to treat a multi-line C++ comment block as a detailed description. Set this
222 # tag to YES if you prefer the old behavior instead.
224 # Note that setting this tag to YES also means that rational rose comments are
230 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
236 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
237 # page for each member. If set to NO, the documentation of a member will be part
243 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
244 # uses this value to replace tabs by spaces in code fragments.
249 # This tag can be used to specify a number of aliases that act as commands in
254 # will allow you to put the command \sideeffect (or @sideeffect) in the
256 # "Side Effects:". You can put \n's in the value part of an alias to insert
258 # alias to insert a newline as if a physical newline was in the original file.
259 # When you need a literal { or } or , in the value part of an alias you have to
260 # escape them by means of a backslash (\), this can lead to conflicts with the
261 # commands \{ and \} for these it is advised to use the version @{ and @} or use
266 # This tag can be used to specify a number of word-keyword mappings (TCL only).
268 # will allow you to use the command class in the itcl::class meaning.
272 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
280 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
288 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
294 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
300 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
308 # Doxygen selects the parser to use depending on the extension of the files it
309 # parses. With this tag you can assign which parser to use for a given
316 # tries to guess whether the code is fixed or free formatted code, this is the
317 # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
323 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
329 # according to the Markdown format, which allows for more readable
338 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
339 # to that level are automatically included in the table of contents, even if
341 # Note: This feature currently applies only to Markdown headings.
343 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
347 # When enabled doxygen tries to link words that correspond to documented
348 # classes, or namespaces to their corresponding documentation. Such a link can
350 # globally by setting AUTOLINK_SUPPORT to NO.
356 # to include (a tag file for) the STL sources as input, then you should set this
357 # tag to YES in order to let doxygen match functions declarations and
365 # If you use Microsoft's C++/CLI language, you should set this option to YES to
371 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
379 # For Microsoft's IDL there are propget and propput attributes to indicate
380 # getter and setter methods for a property. Setting this option to YES will make
381 # doxygen to replace the get and set methods by a property in the documentation.
383 # type. If this is not the case, or you want to show the methods anyway, you
384 # should set this option to NO.
390 # tag is set to YES then doxygen will reuse the documentation of the first
397 # If one adds a struct or class to a group and this option is enabled, then also
398 # any nested class or struct is added to the same group. By default this option
399 # is disabled and one has to add nested compounds explicitly via \ingroup.
404 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
405 # (for instance a group of public functions) to be put as a subgroup of that
406 # type (e.g. under the Public Functions section). Set it to NO to prevent
413 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
424 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
428 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
446 # cache is used to resolve symbols given their name and scope. Since this can be
451 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
462 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
465 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
467 # normally produced when WARNINGS is set to YES.
472 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
478 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
484 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
490 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
496 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
497 # locally in source files will be included in the documentation. If set to NO,
504 # This flag is only useful for Objective-C code. If set to YES, local methods,
506 # included in the documentation. If set to NO, only methods in the interface are
512 # If this flag is set to YES, the members of anonymous namespaces will be
521 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
522 # undocumented members inside documented classes or files. If set to NO these
529 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
531 # to NO, these classes will be included in the various overviews. This option
537 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
538 # declarations. If set to NO, these declarations will be included in the
544 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
545 # documentation blocks found inside the body of a function. If set to NO, these
546 # blocks will be appended to the function's detailed documentation block.
552 # \internal command is included. If the tag is set to NO then the documentation
553 # will be excluded. Set it to YES to include the internal documentation.
558 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
559 # names in lower-case letters. If set to YES, upper-case letters are also
562 # (including Cygwin) ands Mac users are advised to set this option to NO.
567 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
568 # their full class and namespace scopes in the documentation. If set to YES, the
574 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
575 # append additional text to a page's title, such as Class Reference. If set to
581 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
587 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
588 # grouped member an include statement to the documentation, telling the reader
589 # which file to include in order to use the member.
594 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
600 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
606 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
608 # name. If set to NO, the members will appear in declaration order.
613 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
615 # name. If set to NO, the members will appear in declaration order. Note that
621 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
623 # destructors are listed first. If set to NO the constructors will appear in the
625 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
627 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
633 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
634 # of group names into alphabetical order. If set to NO the group names will
640 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
641 # fully-qualified names, including namespaces. If set to NO, the class list will
643 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
644 # Note: This option applies only to the class list, not to the alphabetical
650 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
653 # only one candidate or it is obvious which candidate to choose by doing a
660 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
666 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
672 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
678 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
685 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
692 # initial value of a variable or macro / define can have for it to appear in the
694 # it will be hidden. Use a value of 0 to hide initializers completely. The
702 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
703 # the bottom of the documentation of classes and structs. If set to YES, the
704 # list will mention the files that were used to generate the documentation.
709 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
716 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
723 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
724 # doxygen should invoke to get the current version for each file (typically from
728 # by doxygen. Whatever the program writes to standard output is used as the file
733 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
735 # output files in an output format independent way. To create the layout file
746 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
749 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
751 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
752 # search path. See also \cite for info how to create references.
757 # Configuration options related to warning and progress messages
760 # The QUIET tag can be used to turn on/off the messages that are generated to
761 # standard output by doxygen. If QUIET is set to YES this implies that the
767 # The WARNINGS tag can be used to turn on/off the warning messages that are
768 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
776 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
777 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
783 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
791 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
793 # value. If set to NO, doxygen will only warn about wrong or incomplete
795 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
800 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
816 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
817 # messages should be written. If left blank the output is written to standard
823 # Configuration options related to the input files
826 # The INPUT tag is used to specify the files and/or directories that contain
834 # This tag can be used to specify the character encoding of the source files
844 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
845 # *.h) to filter out the source-files in the directories.
848 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
854 # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
855 # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
907 # The RECURSIVE tag can be used to specify whether or not subdirectories should
913 # The EXCLUDE tag can be used to specify files and/or directories that should be
917 # Note that relative paths are relative to the directory from which doxygen is
922 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
930 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
933 # Note that the wildcards are matched against the file with absolute path, so to
938 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
944 # Note that the wildcards are matched against the file with absolute path, so to
949 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
956 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
957 # *.h) to filter out the source-files in the directories. If left blank all
962 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
963 # searched for input files to be used with the \include or \dontinclude commands
969 # The IMAGE_PATH tag can be used to specify one or more files or directories
970 # that contain images that are to be included in the documentation (see the
975 # The INPUT_FILTER tag can be used to specify a program that doxygen should
976 # invoke to filter for each input file. Doxygen will invoke the filter program
983 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
991 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
996 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1004 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1009 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1010 # INPUT_FILTER) will also be used to filter the input files that are used for
1011 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1016 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1018 # it is also possible to disable source filtering for a specific pattern using
1020 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1024 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1027 # and want to reuse the introduction page also for the doxygen output.
1032 # Configuration options related to source browsing
1035 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1038 # Note: To get rid of all source code in the generated output, make sure that
1039 # also VERBATIM_HEADERS is set to NO.
1044 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1050 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1057 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1063 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1069 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1070 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1071 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1072 # link to the documentation.
1079 # brief description and links to the definition and documentation. Since this
1081 # can opt to disable this feature.
1083 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1087 # If the USE_HTAGS tag is set to YES then the references to source code will
1088 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1093 # To use it do the following:
1096 # - Make sure the INPUT points to the root of the source tree
1102 # The result: instead of the source browser generated by doxygen, the links to
1103 # source code will now point to the output of htags.
1105 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1111 # specified. Set to NO to disable this.
1117 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1132 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1137 # path to the compilation database (see:
1139 # were built. This is equivalent to specifying the "-p" option to a clang tool,
1140 # such as clang-check. These options will then be passed to the parser.
1147 # Configuration options related to the alphabetical class index
1150 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1157 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1160 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1166 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1168 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1173 # Configuration options related to the HTML output
1176 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1181 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1185 # This tag requires that the tag GENERATE_HTML is set to YES.
1189 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1192 # This tag requires that the tag GENERATE_HTML is set to YES.
1196 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1200 # To get valid HTML the header file that includes any scripts and style sheets
1202 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1207 # for information on how to generate the default header that doxygen normally
1209 # Note: The header is subject to change so you typically have to regenerate the
1210 # default header when upgrading to a newer version of doxygen. For a description
1212 # This tag requires that the tag GENERATE_HTML is set to YES.
1216 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1218 # footer. See HTML_HEADER for more information on how to generate a default
1220 # section "Doxygen usage" for information on how to generate the default footer
1222 # This tag requires that the tag GENERATE_HTML is set to YES.
1226 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1227 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1229 # See also section "Doxygen usage" for information on how to generate the style
1231 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1234 # This tag requires that the tag GENERATE_HTML is set to YES.
1238 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1243 # Doxygen will copy the style sheet files to the output directory.
1247 # This tag requires that the tag GENERATE_HTML is set to YES.
1251 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1252 # other source files which should be copied to the HTML output directory. Note
1253 # that these files will be copied to the base HTML output directory. Use the
1254 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1257 # This tag requires that the tag GENERATE_HTML is set to YES.
1262 # will adjust the colors in the style sheet and background images according to
1268 # This tag requires that the tag GENERATE_HTML is set to YES.
1276 # This tag requires that the tag GENERATE_HTML is set to YES.
1280 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1287 # This tag requires that the tag GENERATE_HTML is set to YES.
1291 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1293 # to YES can help to show when doxygen was last run and thus if the
1294 # documentation is up to date.
1296 # This tag requires that the tag GENERATE_HTML is set to YES.
1300 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1304 # page. Disable this option to support browsers that do not have JavaScript,
1307 # This tag requires that the tag GENERATE_HTML is set to YES.
1311 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1315 # This tag requires that the tag GENERATE_HTML is set to YES.
1321 # and collapse entries dynamically later on. Doxygen will expand the tree to
1328 # This tag requires that the tag GENERATE_HTML is set to YES.
1332 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1335 # 10.5 (Leopard). To create a documentation set, doxygen will generate a
1342 # This tag requires that the tag GENERATE_HTML is set to YES.
1350 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1356 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1358 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1366 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1372 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1376 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1390 # This tag requires that the tag GENERATE_HTML is set to YES.
1394 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1396 # written to the html output directory.
1397 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1401 # The HHC_LOCATION tag can be used to specify the location (absolute path
1403 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1404 # The file has to be specified with full path.
1405 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1412 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1416 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1418 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1426 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1430 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1431 # the table of contents of the HTML help documentation and to the tree view.
1433 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1437 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1439 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1442 # This tag requires that the tag GENERATE_HTML is set to YES.
1446 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1447 # the file name of the resulting .qch file. The path specified is relative to
1449 # This tag requires that the tag GENERATE_QHP is set to YES.
1453 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1457 # This tag requires that the tag GENERATE_QHP is set to YES.
1461 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1466 # This tag requires that the tag GENERATE_QHP is set to YES.
1471 # filter to add. For more information please see Qt Help Project / Custom
1474 # This tag requires that the tag GENERATE_QHP is set to YES.
1479 # custom filter to add. For more information please see Qt Help Project / Custom
1482 # This tag requires that the tag GENERATE_QHP is set to YES.
1489 # This tag requires that the tag GENERATE_QHP is set to YES.
1493 # The QHG_LOCATION tag can be used to specify the location of Qt's
1494 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1496 # This tag requires that the tag GENERATE_QHP is set to YES.
1500 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1501 # generated, together with the HTML files, they form an Eclipse help plugin. To
1504 # to be copied into the plugins directory of eclipse. The name of the directory
1506 # After copying Eclipse needs to be restarted before the help appears.
1508 # This tag requires that the tag GENERATE_HTML is set to YES.
1516 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1521 # be necessary to disable the index and replace it with your own. The
1522 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1525 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1527 # This tag requires that the tag GENERATE_HTML is set to YES.
1531 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1532 # structure should be generated to display hierarchical information. If the tag
1533 # value is set to YES, a side panel will be generated containing a tree-like
1535 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1539 # sheet generated by doxygen has an example that shows how to put an image at
1542 # DISABLE_INDEX to YES when enabling this option.
1544 # This tag requires that the tag GENERATE_HTML is set to YES.
1548 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1554 # This tag requires that the tag GENERATE_HTML is set to YES.
1559 # to set the initial width (in pixels) of the frame in which the tree is shown.
1561 # This tag requires that the tag GENERATE_HTML is set to YES.
1565 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1568 # This tag requires that the tag GENERATE_HTML is set to YES.
1572 # Use this tag to change the font size of LaTeX formulas included as images in
1574 # doxygen run you need to manually remove any form_*.png images from the HTML
1575 # output directory to force them to be regenerated.
1577 # This tag requires that the tag GENERATE_HTML is set to YES.
1581 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1585 # Note that when changing this option you need to delete any form_*.png files in
1588 # This tag requires that the tag GENERATE_HTML is set to YES.
1593 # to create new LaTeX commands to be used in formulas as building blocks. See
1598 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1601 # installed or if you want to formulas look prettier in the HTML output. When
1602 # enabled you may also need to install MathJax separately and configure the path
1603 # to it using the MATHJAX_RELPATH option.
1605 # This tag requires that the tag GENERATE_HTML is set to YES.
1609 # When MathJax is enabled you can set the default output format to be used for
1615 # This tag requires that the tag USE_MATHJAX is set to YES.
1619 # When MathJax is enabled you need to specify the location relative to the HTML
1623 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1625 # MathJax. However, it is strongly recommended to install a local copy of
1628 # This tag requires that the tag USE_MATHJAX is set to YES.
1632 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1635 # This tag requires that the tag USE_MATHJAX is set to YES.
1639 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1643 # This tag requires that the tag USE_MATHJAX is set to YES.
1653 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1654 # search using the keyboard; to jump to the search box use <access key> + S
1657 # key> to jump into the search results window, the results can be navigated
1658 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1661 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1664 # This tag requires that the tag GENERATE_HTML is set to YES.
1673 # and searching needs to be provided by external tools. See the section
1676 # This tag requires that the tag SEARCHENGINE is set to YES.
1681 # script for searching. Instead the search results are written to an XML file
1682 # which needs to be processed by an external indexer. Doxygen will invoke an
1683 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1692 # This tag requires that the tag SEARCHENGINE is set to YES.
1696 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1703 # This tag requires that the tag SEARCHENGINE is set to YES.
1708 # search data is written to a file for indexing by an external tool. With the
1711 # This tag requires that the tag SEARCHENGINE is set to YES.
1717 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1718 # projects and redirect the results back to the right project.
1719 # This tag requires that the tag SEARCHENGINE is set to YES.
1723 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1725 # all added to the same external search index. Each project needs to have a
1727 # to a relative location where the documentation can be found. The format is:
1729 # This tag requires that the tag SEARCHENGINE is set to YES.
1734 # Configuration options related to the LaTeX output
1737 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1742 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1746 # This tag requires that the tag GENERATE_LATEX is set to YES.
1750 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1758 # This tag requires that the tag GENERATE_LATEX is set to YES.
1762 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1768 # This tag requires that the tag GENERATE_LATEX is set to YES.
1772 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1778 # This tag requires that the tag GENERATE_LATEX is set to YES.
1782 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1783 # documents. This may be useful for small projects and may help to save some
1786 # This tag requires that the tag GENERATE_LATEX is set to YES.
1790 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1795 # This tag requires that the tag GENERATE_LATEX is set to YES.
1799 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1801 # by its name or with the correct syntax as to be used with the LaTeX
1802 # \usepackage command. To get the times font for instance you can specify :
1804 # To use the option intlimits with the amsmath package you can specify:
1807 # This tag requires that the tag GENERATE_LATEX is set to YES.
1811 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1814 # section "Doxygen usage" for information on how to let doxygen write the
1815 # default header to a separate file.
1822 # to HTML_HEADER.
1823 # This tag requires that the tag GENERATE_LATEX is set to YES.
1827 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1830 # LATEX_HEADER for more information on how to generate a default footer and what
1834 # This tag requires that the tag GENERATE_LATEX is set to YES.
1838 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1841 # will copy the style sheet files to the output directory.
1845 # This tag requires that the tag GENERATE_LATEX is set to YES.
1849 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1850 # other source files which should be copied to the LATEX_OUTPUT output
1853 # This tag requires that the tag GENERATE_LATEX is set to YES.
1857 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1858 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1862 # This tag requires that the tag GENERATE_LATEX is set to YES.
1866 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1867 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1870 # This tag requires that the tag GENERATE_LATEX is set to YES.
1874 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1875 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1879 # This tag requires that the tag GENERATE_LATEX is set to YES.
1883 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1886 # This tag requires that the tag GENERATE_LATEX is set to YES.
1890 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1896 # This tag requires that the tag GENERATE_LATEX is set to YES.
1900 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1904 # This tag requires that the tag GENERATE_LATEX is set to YES.
1908 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1910 # to NO can help when comparing the output of multiple runs.
1912 # This tag requires that the tag GENERATE_LATEX is set to YES.
1916 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1918 # it will be relative to the LATEX_OUTPUT directory. If left blank the
1920 # This tag requires that the tag GENERATE_LATEX is set to YES.
1925 # Configuration options related to the RTF output
1928 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1935 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1939 # This tag requires that the tag GENERATE_RTF is set to YES.
1943 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1944 # documents. This may be useful for small projects and may help to save some
1947 # This tag requires that the tag GENERATE_RTF is set to YES.
1951 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1959 # This tag requires that the tag GENERATE_RTF is set to YES.
1963 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1964 # configuration file, i.e. a series of assignments. You only have to provide
1965 # replacements, missing definitions are set to their default value.
1967 # See also section "Doxygen usage" for information on how to generate the
1969 # This tag requires that the tag GENERATE_RTF is set to YES.
1974 # similar to doxygen's configuration file. A template extensions file can be
1976 # This tag requires that the tag GENERATE_RTF is set to YES.
1980 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1986 # This tag requires that the tag GENERATE_RTF is set to YES.
1991 # Configuration options related to the man page output
1994 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2000 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2005 # This tag requires that the tag GENERATE_MAN is set to YES.
2009 # The MAN_EXTENSION tag determines the extension that is added to the generated
2014 # This tag requires that the tag GENERATE_MAN is set to YES.
2019 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2021 # This tag requires that the tag GENERATE_MAN is set to YES.
2025 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2028 # them the man command would be unable to find the correct page.
2030 # This tag requires that the tag GENERATE_MAN is set to YES.
2035 # Configuration options related to the XML output
2038 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2044 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2048 # This tag requires that the tag GENERATE_XML is set to YES.
2052 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2053 # listings (including syntax highlighting and cross-referencing information) to
2057 # This tag requires that the tag GENERATE_XML is set to YES.
2061 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2064 # This tag requires that the tag GENERATE_XML is set to YES.
2069 # Configuration options related to the DOCBOOK output
2072 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2073 # that can be used to generate PDF.
2078 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2082 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2086 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2088 # information) to the DOCBOOK output. Note that enabling this will significantly
2091 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2099 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2108 # Configuration options related to the Perl module output
2111 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2119 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2120 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2123 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2127 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2128 # formatted so it can be parsed by a human reader. This is useful if you want to
2129 # understand what is going on. On the other hand, if this tag is set to NO, the
2133 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2141 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2146 # Configuration options related to the preprocessor
2149 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2155 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2156 # in the source code. If set to NO, only conditional compilation will be
2158 # EXPAND_ONLY_PREDEF to YES.
2160 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2164 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2165 # the macro expansion is limited to the macros specified with the PREDEFINED and
2168 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2172 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2175 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2179 # The INCLUDE_PATH tag can be used to specify one or more directories that
2182 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2186 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2187 # patterns (like *.h and *.hpp) to filter out the header-files in the
2190 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2194 # The PREDEFINED tag can be used to specify one or more macro names that are
2195 # defined before the preprocessor is started (similar to the -D option of e.g.
2198 # is assumed. To prevent a macro definition from being undefined via #undef or
2200 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2204 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2205 # tag can be used to specify a list of macro names that should be expanded. The
2207 # tag if you want to use a different macro definition that overrules the
2209 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2213 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2214 # remove all references to function-like macros that are alone on a line, have
2219 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2224 # Configuration options related to external references
2227 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2234 # section "Linking to external documentation" for more information about the use
2238 # run, you must also specify the path to the tagfile here.
2243 # tag file that is based on the input files it reads. See section "Linking to
2248 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2249 # the class index. If set to NO, only the inherited external classes will be
2255 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2256 # in the modules index. If set to NO, only the current project's groups will be
2262 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2263 # the related pages index. If set to NO, only the current project's pages will
2270 # Configuration options related to the dot tool
2273 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2274 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2276 # disabled, but it is recommended to install and use dot, since it yields more
2283 # then run dia to produce the diagram and insert it in the documentation. The
2284 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2285 # If left empty dia is assumed to be found in the default search path.
2289 # If set to YES the inheritance and collaboration graphs will hide inheritance
2295 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2299 # set to NO
2305 # to run in parallel. When set to 0 doxygen will base this on the number of
2306 # processors available in the system. You can set it explicitly to a value
2307 # larger than 0 to get control over the balance between CPU load and processing
2310 # This tag requires that the tag HAVE_DOT is set to YES.
2315 # generates you can specify the font name using DOT_FONTNAME. You need to make
2316 # sure dot is able to find the font, which can be done by putting it in a
2318 # setting DOT_FONTPATH to the directory containing the font.
2320 # This tag requires that the tag HAVE_DOT is set to YES.
2324 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2327 # This tag requires that the tag HAVE_DOT is set to YES.
2331 # By default doxygen will tell dot to use the default font as specified with
2334 # This tag requires that the tag HAVE_DOT is set to YES.
2338 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2340 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2342 # This tag requires that the tag HAVE_DOT is set to YES.
2346 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2351 # This tag requires that the tag HAVE_DOT is set to YES.
2355 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2358 # This tag requires that the tag HAVE_DOT is set to YES.
2362 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2363 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2366 # This tag requires that the tag HAVE_DOT is set to YES.
2372 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2373 # number of items for each type to make the size more manageable. Set this to 0
2375 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2376 # but if the number exceeds 15, the total amount of fields shown is limited to
2379 # This tag requires that the tag HAVE_DOT is set to YES.
2383 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2387 # This tag requires that the tag HAVE_DOT is set to YES.
2391 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2396 # This tag requires that the tag HAVE_DOT is set to YES.
2401 # set to YES then doxygen will generate a graph for each documented file showing
2405 # This tag requires that the tag HAVE_DOT is set to YES.
2409 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2413 # So in most cases it will be better to enable call graphs for selected
2417 # This tag requires that the tag HAVE_DOT is set to YES.
2421 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2425 # So in most cases it will be better to enable caller graphs for selected
2429 # This tag requires that the tag HAVE_DOT is set to YES.
2433 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2436 # This tag requires that the tag HAVE_DOT is set to YES.
2440 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2445 # This tag requires that the tag HAVE_DOT is set to YES.
2449 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2453 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2454 # to make the SVG files visible in IE 9+ (other browsers do not have this
2462 # This tag requires that the tag HAVE_DOT is set to YES.
2466 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2471 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2474 # This tag requires that the tag HAVE_DOT is set to YES.
2478 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2480 # This tag requires that the tag HAVE_DOT is set to YES.
2484 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2487 # This tag requires that the tag HAVE_DOT is set to YES.
2491 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2497 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2503 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2511 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2521 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2529 # This tag requires that the tag HAVE_DOT is set to YES.
2533 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2536 # further from the root node will be omitted. Note that setting this option to 1
2541 # This tag requires that the tag HAVE_DOT is set to YES.
2545 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2547 # to support this out of the box.
2549 # Warning: Depending on the platform used, enabling this option may lead to
2550 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2553 # This tag requires that the tag HAVE_DOT is set to YES.
2557 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2562 # This tag requires that the tag HAVE_DOT is set to YES.
2566 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2570 # This tag requires that the tag HAVE_DOT is set to YES.
2574 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2575 # files that are used to generate the various graphs.
2577 # This tag requires that the tag HAVE_DOT is set to YES.