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
231 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
238 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
244 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
245 # page for each member. If set to NO, the documentation of a member will be part
251 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
252 # uses this value to replace tabs by spaces in code fragments.
257 # This tag can be used to specify a number of aliases that act as commands in
262 # will allow you to put the command \sideeffect (or @sideeffect) in the
264 # "Side Effects:". You can put \n's in the value part of an alias to insert
266 # alias to insert a newline as if a physical newline was in the original file.
267 # When you need a literal { or } or , in the value part of an alias you have to
268 # escape them by means of a backslash (\), this can lead to conflicts with the
269 # commands \{ and \} for these it is advised to use the version @{ and @} or use
274 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
282 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
290 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
296 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
302 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
310 # Doxygen selects the parser to use depending on the extension of the files it
311 # parses. With this tag you can assign which parser to use for a given
318 # tries to guess whether the code is fixed or free formatted code, this is the
319 # default for Fortran type files). For instance to make doxygen treat .inc files
325 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
327 # * to the FILE_PATTERNS.
334 # according to the Markdown format, which allows for more readable
343 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
344 # to that level are automatically included in the table of contents, even if
346 # Note: This feature currently applies only to Markdown headings.
348 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
352 # When enabled doxygen tries to link words that correspond to documented
353 # classes, or namespaces to their corresponding documentation. Such a link can
355 # globally by setting AUTOLINK_SUPPORT to NO.
361 # to include (a tag file for) the STL sources as input, then you should set this
362 # tag to YES in order to let doxygen match functions declarations and
370 # If you use Microsoft's C++/CLI language, you should set this option to YES to
376 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
384 # For Microsoft's IDL there are propget and propput attributes to indicate
385 # getter and setter methods for a property. Setting this option to YES will make
386 # doxygen to replace the get and set methods by a property in the documentation.
388 # type. If this is not the case, or you want to show the methods anyway, you
389 # should set this option to NO.
395 # tag is set to YES then doxygen will reuse the documentation of the first
402 # If one adds a struct or class to a group and this option is enabled, then also
403 # any nested class or struct is added to the same group. By default this option
404 # is disabled and one has to add nested compounds explicitly via \ingroup.
409 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
410 # (for instance a group of public functions) to be put as a subgroup of that
411 # type (e.g. under the Public Functions section). Set it to NO to prevent
418 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
429 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
433 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
451 # cache is used to resolve symbols given their name and scope. Since this can be
456 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
463 # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
464 # during processing. When set to 0 doxygen will based this on the number of
465 # cores available in the system. You can set it explicitly to a value larger
466 # than 0 to get more control over the balance between CPU load and processing
468 # threads. Since this is still an experimental feature the default is set to 1,
480 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
483 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
485 # normally produced when WARNINGS is set to YES.
490 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
496 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
502 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
508 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
514 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
515 # locally in source files will be included in the documentation. If set to NO,
522 # This flag is only useful for Objective-C code. If set to YES, local methods,
524 # included in the documentation. If set to NO, only methods in the interface are
530 # If this flag is set to YES, the members of anonymous namespaces will be
539 # If this flag is set to YES, the name of an unnamed parameter in a declaration
546 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
547 # undocumented members inside documented classes or files. If set to NO these
554 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
556 # to NO, these classes will be included in the various overviews. This option
562 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
563 # declarations. If set to NO, these declarations will be included in the
569 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
570 # documentation blocks found inside the body of a function. If set to NO, these
571 # blocks will be appended to the function's detailed documentation block.
577 # \internal command is included. If the tag is set to NO then the documentation
578 # will be excluded. Set it to YES to include the internal documentation.
584 # able to match the capabilities of the underlying filesystem. In case the
586 # whose names only differ in casing), the option must be set to YES to properly
588 # are not case sensitive the option should be be set to NO to properly deal with
590 # classes, one named CLASS and the other named Class, and to also support
591 # references to files without having to specify the exact matching casing. On
593 # to NO, whereas on Linux or other Unix flavors it should typically be set to
599 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
600 # their full class and namespace scopes in the documentation. If set to YES, the
606 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
607 # append additional text to a page's title, such as Class Reference. If set to
613 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
619 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
620 # grouped member an include statement to the documentation, telling the reader
621 # which file to include in order to use the member.
626 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
632 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
638 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
640 # name. If set to NO, the members will appear in declaration order.
645 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
647 # name. If set to NO, the members will appear in declaration order. Note that
653 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
655 # destructors are listed first. If set to NO the constructors will appear in the
657 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
659 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
665 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
666 # of group names into alphabetical order. If set to NO the group names will
672 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
673 # fully-qualified names, including namespaces. If set to NO, the class list will
675 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
676 # Note: This option applies only to the class list, not to the alphabetical
682 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
685 # only one candidate or it is obvious which candidate to choose by doing a
692 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
698 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
704 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
710 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
717 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
724 # initial value of a variable or macro / define can have for it to appear in the
726 # it will be hidden. Use a value of 0 to hide initializers completely. The
734 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
735 # the bottom of the documentation of classes and structs. If set to YES, the
736 # list will mention the files that were used to generate the documentation.
741 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
748 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
755 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
756 # doxygen should invoke to get the current version for each file (typically from
760 # by doxygen. Whatever the program writes to standard output is used as the file
765 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
767 # output files in an output format independent way. To create the layout file
778 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
781 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
783 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
784 # search path. See also \cite for info how to create references.
789 # Configuration options related to warning and progress messages
792 # The QUIET tag can be used to turn on/off the messages that are generated to
793 # standard output by doxygen. If QUIET is set to YES this implies that the
799 # The WARNINGS tag can be used to turn on/off the warning messages that are
800 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
808 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
809 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
815 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
823 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
825 # value. If set to NO, doxygen will only warn about wrong or incomplete
827 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
832 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
833 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
834 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
851 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
852 # messages should be written. If left blank the output is written to standard
858 # Configuration options related to the input files
861 # The INPUT tag is used to specify the files and/or directories that contain
869 # This tag can be used to specify the character encoding of the source files
879 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
880 # *.h) to filter out the source-files in the directories.
883 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
892 # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
899 # The RECURSIVE tag can be used to specify whether or not subdirectories should
905 # The EXCLUDE tag can be used to specify files and/or directories that should be
909 # Note that relative paths are relative to the directory from which doxygen is
914 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
922 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
925 # Note that the wildcards are matched against the file with absolute path, so to
930 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
936 # Note that the wildcards are matched against the file with absolute path, so to
941 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
948 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
949 # *.h) to filter out the source-files in the directories. If left blank all
954 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
955 # searched for input files to be used with the \include or \dontinclude commands
961 # The IMAGE_PATH tag can be used to specify one or more files or directories
962 # that contain images that are to be included in the documentation (see the
967 # The INPUT_FILTER tag can be used to specify a program that doxygen should
968 # invoke to filter for each input file. Doxygen will invoke the filter program
975 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
983 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
988 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
996 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1001 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1002 # INPUT_FILTER) will also be used to filter the input files that are used for
1003 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1008 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1010 # it is also possible to disable source filtering for a specific pattern using
1012 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1016 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1019 # and want to reuse the introduction page also for the doxygen output.
1024 # Configuration options related to source browsing
1027 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1030 # Note: To get rid of all source code in the generated output, make sure that
1031 # also VERBATIM_HEADERS is set to NO.
1036 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1042 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1049 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1055 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1061 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1062 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1063 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1064 # link to the documentation.
1071 # brief description and links to the definition and documentation. Since this
1073 # can opt to disable this feature.
1075 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1079 # If the USE_HTAGS tag is set to YES then the references to source code will
1080 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1085 # To use it do the following:
1088 # - Make sure the INPUT points to the root of the source tree
1094 # The result: instead of the source browser generated by doxygen, the links to
1095 # source code will now point to the output of htags.
1097 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1103 # specified. Set to NO to disable this.
1109 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1120 # If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to
1121 # YES then doxygen will add the directory of each input to the include path.
1130 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1135 # path to the directory containing a file called compile_commands.json. This
1138 # options used when the source files were built. This is equivalent to
1139 # specifying the -p option to a clang tool, such as clang-check. These options
1140 # will then be passed to the parser. Any options specified with CLANG_OPTIONS
1148 # Configuration options related to the alphabetical class index
1151 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1160 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1162 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1167 # Configuration options related to the HTML output
1170 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1175 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1179 # This tag requires that the tag GENERATE_HTML is set to YES.
1183 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1186 # This tag requires that the tag GENERATE_HTML is set to YES.
1190 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1194 # To get valid HTML the header file that includes any scripts and style sheets
1196 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1201 # for information on how to generate the default header that doxygen normally
1203 # Note: The header is subject to change so you typically have to regenerate the
1204 # default header when upgrading to a newer version of doxygen. For a description
1206 # This tag requires that the tag GENERATE_HTML is set to YES.
1210 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1212 # footer. See HTML_HEADER for more information on how to generate a default
1214 # section "Doxygen usage" for information on how to generate the default footer
1216 # This tag requires that the tag GENERATE_HTML is set to YES.
1220 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1221 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1223 # See also section "Doxygen usage" for information on how to generate the style
1225 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1228 # This tag requires that the tag GENERATE_HTML is set to YES.
1232 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1237 # Doxygen will copy the style sheet files to the output directory.
1241 # This tag requires that the tag GENERATE_HTML is set to YES.
1245 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1246 # other source files which should be copied to the HTML output directory. Note
1247 # that these files will be copied to the base HTML output directory. Use the
1248 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1251 # This tag requires that the tag GENERATE_HTML is set to YES.
1256 # will adjust the colors in the style sheet and background images according to
1262 # This tag requires that the tag GENERATE_HTML is set to YES.
1270 # This tag requires that the tag GENERATE_HTML is set to YES.
1274 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1281 # This tag requires that the tag GENERATE_HTML is set to YES.
1285 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1287 # to YES can help to show when doxygen was last run and thus if the
1288 # documentation is up to date.
1290 # This tag requires that the tag GENERATE_HTML is set to YES.
1294 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1298 # page. Disable this option to support browsers that do not have JavaScript,
1301 # This tag requires that the tag GENERATE_HTML is set to YES.
1305 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1309 # This tag requires that the tag GENERATE_HTML is set to YES.
1315 # and collapse entries dynamically later on. Doxygen will expand the tree to
1322 # This tag requires that the tag GENERATE_HTML is set to YES.
1326 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1329 # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1337 # This tag requires that the tag GENERATE_HTML is set to YES.
1345 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1351 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1353 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1361 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1367 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1371 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1385 # This tag requires that the tag GENERATE_HTML is set to YES.
1389 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1391 # written to the html output directory.
1392 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1396 # The HHC_LOCATION tag can be used to specify the location (absolute path
1398 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1399 # The file has to be specified with full path.
1400 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1407 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1411 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1413 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1421 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1425 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1426 # the table of contents of the HTML help documentation and to the tree view.
1428 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1432 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1434 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1437 # This tag requires that the tag GENERATE_HTML is set to YES.
1441 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1442 # the file name of the resulting .qch file. The path specified is relative to
1444 # This tag requires that the tag GENERATE_QHP is set to YES.
1448 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1453 # This tag requires that the tag GENERATE_QHP is set to YES.
1457 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1462 # This tag requires that the tag GENERATE_QHP is set to YES.
1467 # filter to add. For more information please see Qt Help Project / Custom
1470 # This tag requires that the tag GENERATE_QHP is set to YES.
1475 # custom filter to add. For more information please see Qt Help Project / Custom
1478 # This tag requires that the tag GENERATE_QHP is set to YES.
1485 # This tag requires that the tag GENERATE_QHP is set to YES.
1489 # The QHG_LOCATION tag can be used to specify the location (absolute path
1490 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1492 # This tag requires that the tag GENERATE_QHP is set to YES.
1496 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1497 # generated, together with the HTML files, they form an Eclipse help plugin. To
1500 # to be copied into the plugins directory of eclipse. The name of the directory
1502 # After copying Eclipse needs to be restarted before the help appears.
1504 # This tag requires that the tag GENERATE_HTML is set to YES.
1512 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1517 # be necessary to disable the index and replace it with your own. The
1518 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1521 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1523 # This tag requires that the tag GENERATE_HTML is set to YES.
1527 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1528 # structure should be generated to display hierarchical information. If the tag
1529 # value is set to YES, a side panel will be generated containing a tree-like
1531 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1535 # sheet generated by doxygen has an example that shows how to put an image at
1538 # DISABLE_INDEX to YES when enabling this option.
1540 # This tag requires that the tag GENERATE_HTML is set to YES.
1544 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1550 # This tag requires that the tag GENERATE_HTML is set to YES.
1555 # to set the initial width (in pixels) of the frame in which the tree is shown.
1557 # This tag requires that the tag GENERATE_HTML is set to YES.
1561 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1564 # This tag requires that the tag GENERATE_HTML is set to YES.
1568 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1570 # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1575 # This tag requires that the tag GENERATE_HTML is set to YES.
1579 # Use this tag to change the font size of LaTeX formulas included as images in
1581 # doxygen run you need to manually remove any form_*.png images from the HTML
1582 # output directory to force them to be regenerated.
1584 # This tag requires that the tag GENERATE_HTML is set to YES.
1588 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1592 # Note that when changing this option you need to delete any form_*.png files in
1595 # This tag requires that the tag GENERATE_HTML is set to YES.
1600 # to create new LaTeX commands to be used in formulas as building blocks. See
1605 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1608 # installed or if you want to formulas look prettier in the HTML output. When
1609 # enabled you may also need to install MathJax separately and configure the path
1610 # to it using the MATHJAX_RELPATH option.
1612 # This tag requires that the tag GENERATE_HTML is set to YES.
1616 # When MathJax is enabled you can set the default output format to be used for
1622 # This tag requires that the tag USE_MATHJAX is set to YES.
1626 # When MathJax is enabled you need to specify the location relative to the HTML
1630 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1632 # MathJax. However, it is strongly recommended to install a local copy of
1635 # This tag requires that the tag USE_MATHJAX is set to YES.
1639 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1642 # This tag requires that the tag USE_MATHJAX is set to YES.
1646 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1651 # This tag requires that the tag USE_MATHJAX is set to YES.
1661 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1662 # search using the keyboard; to jump to the search box use <access key> + S
1665 # key> to jump into the search results window, the results can be navigated
1666 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1669 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1672 # This tag requires that the tag GENERATE_HTML is set to YES.
1681 # and searching needs to be provided by external tools. See the section
1684 # This tag requires that the tag SEARCHENGINE is set to YES.
1689 # script for searching. Instead the search results are written to an XML file
1690 # which needs to be processed by an external indexer. Doxygen will invoke an
1691 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1701 # This tag requires that the tag SEARCHENGINE is set to YES.
1705 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1713 # This tag requires that the tag SEARCHENGINE is set to YES.
1718 # search data is written to a file for indexing by an external tool. With the
1721 # This tag requires that the tag SEARCHENGINE is set to YES.
1727 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1728 # projects and redirect the results back to the right project.
1729 # This tag requires that the tag SEARCHENGINE is set to YES.
1733 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1735 # all added to the same external search index. Each project needs to have a
1737 # to a relative location where the documentation can be found. The format is:
1739 # This tag requires that the tag SEARCHENGINE is set to YES.
1744 # Configuration options related to the LaTeX output
1747 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1752 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1756 # This tag requires that the tag GENERATE_LATEX is set to YES.
1760 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1768 # This tag requires that the tag GENERATE_LATEX is set to YES.
1772 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1778 # This tag requires that the tag GENERATE_LATEX is set to YES.
1782 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1788 # This tag requires that the tag GENERATE_LATEX is set to YES.
1792 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1793 # documents. This may be useful for small projects and may help to save some
1796 # This tag requires that the tag GENERATE_LATEX is set to YES.
1800 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1805 # This tag requires that the tag GENERATE_LATEX is set to YES.
1809 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1811 # by its name or with the correct syntax as to be used with the LaTeX
1812 # \usepackage command. To get the times font for instance you can specify :
1814 # To use the option intlimits with the amsmath package you can specify:
1817 # This tag requires that the tag GENERATE_LATEX is set to YES.
1821 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1824 # section "Doxygen usage" for information on how to let doxygen write the
1825 # default header to a separate file.
1832 # to HTML_HEADER.
1833 # This tag requires that the tag GENERATE_LATEX is set to YES.
1837 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1840 # LATEX_HEADER for more information on how to generate a default footer and what
1844 # This tag requires that the tag GENERATE_LATEX is set to YES.
1848 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1851 # will copy the style sheet files to the output directory.
1855 # This tag requires that the tag GENERATE_LATEX is set to YES.
1859 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1860 # other source files which should be copied to the LATEX_OUTPUT output
1863 # This tag requires that the tag GENERATE_LATEX is set to YES.
1867 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1868 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1872 # This tag requires that the tag GENERATE_LATEX is set to YES.
1876 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1877 # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
1878 # files. Set this option to YES, to get a higher quality PDF documentation.
1882 # This tag requires that the tag GENERATE_LATEX is set to YES.
1886 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1887 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1891 # This tag requires that the tag GENERATE_LATEX is set to YES.
1895 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1898 # This tag requires that the tag GENERATE_LATEX is set to YES.
1902 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1908 # This tag requires that the tag GENERATE_LATEX is set to YES.
1912 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1916 # This tag requires that the tag GENERATE_LATEX is set to YES.
1920 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1922 # to NO can help when comparing the output of multiple runs.
1924 # This tag requires that the tag GENERATE_LATEX is set to YES.
1928 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1930 # it will be relative to the LATEX_OUTPUT directory. If left blank the
1932 # This tag requires that the tag GENERATE_LATEX is set to YES.
1937 # Configuration options related to the RTF output
1940 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1947 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1951 # This tag requires that the tag GENERATE_RTF is set to YES.
1955 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1956 # documents. This may be useful for small projects and may help to save some
1959 # This tag requires that the tag GENERATE_RTF is set to YES.
1963 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1971 # This tag requires that the tag GENERATE_RTF is set to YES.
1975 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1976 # configuration file, i.e. a series of assignments. You only have to provide
1977 # replacements, missing definitions are set to their default value.
1979 # See also section "Doxygen usage" for information on how to generate the
1981 # This tag requires that the tag GENERATE_RTF is set to YES.
1986 # similar to doxygen's configuration file. A template extensions file can be
1988 # This tag requires that the tag GENERATE_RTF is set to YES.
1992 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1998 # This tag requires that the tag GENERATE_RTF is set to YES.
2003 # Configuration options related to the man page output
2006 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2012 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2017 # This tag requires that the tag GENERATE_MAN is set to YES.
2021 # The MAN_EXTENSION tag determines the extension that is added to the generated
2026 # This tag requires that the tag GENERATE_MAN is set to YES.
2031 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2033 # This tag requires that the tag GENERATE_MAN is set to YES.
2037 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2040 # them the man command would be unable to find the correct page.
2042 # This tag requires that the tag GENERATE_MAN is set to YES.
2047 # Configuration options related to the XML output
2050 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2056 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2060 # This tag requires that the tag GENERATE_XML is set to YES.
2064 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2065 # listings (including syntax highlighting and cross-referencing information) to
2069 # This tag requires that the tag GENERATE_XML is set to YES.
2073 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2076 # This tag requires that the tag GENERATE_XML is set to YES.
2081 # Configuration options related to the DOCBOOK output
2084 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2085 # that can be used to generate PDF.
2090 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2094 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2098 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2100 # information) to the DOCBOOK output. Note that enabling this will significantly
2103 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2111 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2120 # Configuration options related to the Perl module output
2123 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2131 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2132 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2135 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2139 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2140 # formatted so it can be parsed by a human reader. This is useful if you want to
2141 # understand what is going on. On the other hand, if this tag is set to NO, the
2145 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2153 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2158 # Configuration options related to the preprocessor
2161 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2167 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2168 # in the source code. If set to NO, only conditional compilation will be
2170 # EXPAND_ONLY_PREDEF to YES.
2172 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2176 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2177 # the macro expansion is limited to the macros specified with the PREDEFINED and
2180 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2184 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2187 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2191 # The INCLUDE_PATH tag can be used to specify one or more directories that
2194 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2198 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2199 # patterns (like *.h and *.hpp) to filter out the header-files in the
2202 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2206 # The PREDEFINED tag can be used to specify one or more macro names that are
2207 # defined before the preprocessor is started (similar to the -D option of e.g.
2210 # is assumed. To prevent a macro definition from being undefined via #undef or
2212 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2216 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2217 # tag can be used to specify a list of macro names that should be expanded. The
2219 # tag if you want to use a different macro definition that overrules the
2221 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2225 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2226 # remove all references to function-like macros that are alone on a line, have
2231 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2236 # Configuration options related to external references
2239 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2246 # section "Linking to external documentation" for more information about the use
2250 # run, you must also specify the path to the tagfile here.
2255 # tag file that is based on the input files it reads. See section "Linking to
2260 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2261 # the class index. If set to NO, only the inherited external classes will be
2267 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2268 # in the modules index. If set to NO, only the current project's groups will be
2274 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2275 # the related pages index. If set to NO, only the current project's pages will
2282 # Configuration options related to the dot tool
2285 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2286 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2288 # disabled, but it is recommended to install and use dot, since it yields more
2295 # then run dia to produce the diagram and insert it in the documentation. The
2296 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2297 # If left empty dia is assumed to be found in the default search path.
2301 # If set to YES the inheritance and collaboration graphs will hide inheritance
2307 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2311 # set to NO
2317 # to run in parallel. When set to 0 doxygen will base this on the number of
2318 # processors available in the system. You can set it explicitly to a value
2319 # larger than 0 to get control over the balance between CPU load and processing
2322 # This tag requires that the tag HAVE_DOT is set to YES.
2327 # generates you can specify the font name using DOT_FONTNAME. You need to make
2328 # sure dot is able to find the font, which can be done by putting it in a
2330 # setting DOT_FONTPATH to the directory containing the font.
2332 # This tag requires that the tag HAVE_DOT is set to YES.
2336 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2339 # This tag requires that the tag HAVE_DOT is set to YES.
2343 # By default doxygen will tell dot to use the default font as specified with
2346 # This tag requires that the tag HAVE_DOT is set to YES.
2350 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2352 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2354 # This tag requires that the tag HAVE_DOT is set to YES.
2358 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2363 # This tag requires that the tag HAVE_DOT is set to YES.
2367 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2370 # This tag requires that the tag HAVE_DOT is set to YES.
2374 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2375 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2378 # This tag requires that the tag HAVE_DOT is set to YES.
2384 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2385 # number of items for each type to make the size more manageable. Set this to 0
2387 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2388 # but if the number exceeds 15, the total amount of fields shown is limited to
2391 # This tag requires that the tag UML_LOOK is set to YES.
2395 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2397 # tag is set to YES, doxygen will add type and arguments for attributes and
2398 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2400 # class diagrams will look similar to the default class diagrams but using UML
2404 # This tag requires that the tag UML_LOOK is set to YES.
2408 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2409 # to display on a single line. If the actual line length exceeds this threshold
2411 # to avoid ugly line breaks.
2413 # This tag requires that the tag HAVE_DOT is set to YES.
2417 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2421 # This tag requires that the tag HAVE_DOT is set to YES.
2425 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2430 # This tag requires that the tag HAVE_DOT is set to YES.
2435 # set to YES then doxygen will generate a graph for each documented file showing
2439 # This tag requires that the tag HAVE_DOT is set to YES.
2443 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2447 # So in most cases it will be better to enable call graphs for selected
2451 # This tag requires that the tag HAVE_DOT is set to YES.
2455 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2459 # So in most cases it will be better to enable caller graphs for selected
2463 # This tag requires that the tag HAVE_DOT is set to YES.
2467 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2470 # This tag requires that the tag HAVE_DOT is set to YES.
2474 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2479 # This tag requires that the tag HAVE_DOT is set to YES.
2483 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2487 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2488 # to make the SVG files visible in IE 9+ (other browsers do not have this
2496 # This tag requires that the tag HAVE_DOT is set to YES.
2500 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2505 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2508 # This tag requires that the tag HAVE_DOT is set to YES.
2512 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2514 # This tag requires that the tag HAVE_DOT is set to YES.
2518 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2521 # This tag requires that the tag HAVE_DOT is set to YES.
2525 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2531 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2537 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2545 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2555 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2563 # This tag requires that the tag HAVE_DOT is set to YES.
2567 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2570 # further from the root node will be omitted. Note that setting this option to 1
2575 # This tag requires that the tag HAVE_DOT is set to YES.
2579 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2581 # to support this out of the box.
2583 # Warning: Depending on the platform used, enabling this option may lead to
2584 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2587 # This tag requires that the tag HAVE_DOT is set to YES.
2591 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2596 # This tag requires that the tag HAVE_DOT is set to YES.
2600 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2604 # This tag requires that the tag HAVE_DOT is set to YES.
2608 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2609 # files that are used to generate the various graphs.