Lines Matching refs:to
9 # Unless required by applicable law or agreed to in writing, software
18 # This file describes the settings to be used by the documentation system
52 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
67 # to the output directory.
71 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
73 # entered, it will be relative to the location where doxygen was started. If
78 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
88 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
90 # information to generate all constant output in the proper language.
103 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
105 # documentation (similar to Javadoc). Set to NO to disable this.
110 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
113 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
120 # used to form the text in various listings. Each string in this list, if found
130 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
137 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
145 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
146 # before files name in the file list and in the header files. If set to NO the
152 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
154 # part of the path. The tag can be used to show relative paths in the file list.
155 # If left blank the directory from which doxygen is run is used as the path to
160 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
164 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
166 # header file to include in order to use a class. If left blank only the name of
168 # specify the list of include paths that are normally passed to the compiler
173 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
180 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
182 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
189 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
191 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
197 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
199 # a brief description. This used to be the default behavior. The new default is
200 # to treat a multi-line C++ comment block as a detailed description. Set this
201 # tag to YES if you prefer the old behavior instead.
203 # Note that setting this tag to YES also means that rational rose comments are
209 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
215 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
216 # new page for each member. If set to NO, the documentation of a member will be
222 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
223 # uses this value to replace tabs by spaces in code fragments.
228 # This tag can be used to specify a number of aliases that act as commands in
233 # will allow you to put the command \sideeffect (or @sideeffect) in the
235 # "Side Effects:". You can put \n's in the value part of an alias to insert
240 # This tag can be used to specify a number of word-keyword mappings (TCL only).
242 # will allow you to use the command class in the itcl::class meaning.
246 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
254 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
262 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
268 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
274 # Doxygen selects the parser to use depending on the extension of the files it
275 # parses. With this tag you can assign which parser to use for a given
279 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
285 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
291 # according to the Markdown format, which allows for more readable
300 # When enabled doxygen tries to link words that correspond to documented
301 # classes, or namespaces to their corresponding documentation. Such a link can
303 # or globally by setting AUTOLINK_SUPPORT to NO.
309 # to include (a tag file for) the STL sources as input, then you should set this
310 # tag to YES in order to let doxygen match functions declarations and
318 # If you use Microsoft's C++/CLI language, you should set this option to YES to
324 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
332 # For Microsoft's IDL there are propget and propput attributes to indicate
333 # getter and setter methods for a property. Setting this option to YES will make
334 # doxygen to replace the get and set methods by a property in the documentation.
336 # type. If this is not the case, or you want to show the methods anyway, you
337 # should set this option to NO.
343 # tag is set to YES, then doxygen will reuse the documentation of the first
350 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
351 # (for instance a group of public functions) to be put as a subgroup of that
352 # type (e.g. under the Public Functions section). Set it to NO to prevent
359 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
370 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
374 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
392 # cache is used to resolve symbols given their name and scope. Since this can be
397 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
408 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
411 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
413 # normally produced when WARNINGS is set to YES.
418 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
424 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
430 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
436 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
437 # locally in source files will be included in the documentation. If set to NO
444 # This flag is only useful for Objective-C code. When set to YES local methods,
446 # included in the documentation. If set to NO only methods in the interface are
452 # If this flag is set to YES, the members of anonymous namespaces will be
461 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
462 # undocumented members inside documented classes or files. If set to NO these
469 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
471 # to NO these classes will be included in the various overviews. This option has
477 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
478 # (class|struct|union) declarations. If set to NO these declarations will be
484 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
485 # documentation blocks found inside the body of a function. If set to NO these
486 # blocks will be appended to the function's detailed documentation block.
492 # \internal command is included. If the tag is set to NO then the documentation
493 # will be excluded. Set it to YES to include the internal documentation.
498 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
499 # names in lower-case letters. If set to YES upper-case letters are also
502 # and Mac users are advised to set this option to NO.
507 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
508 # their full class and namespace scopes in the documentation. If set to YES the
514 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
520 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
521 # grouped member an include statement to the documentation, telling the reader
522 # which file to include in order to use the member.
527 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
533 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
539 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
541 # name. If set to NO the members will appear in declaration order.
546 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
548 # name. If set to NO the members will appear in declaration order. Note that
554 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
556 # destructors are listed first. If set to NO the constructors will appear in the
558 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
560 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
566 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
567 # of group names into alphabetical order. If set to NO the group names will
573 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
574 # fully-qualified names, including namespaces. If set to NO, the class list will
576 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
577 # Note: This option applies only to the class list, not to the alphabetical
583 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
586 # only one candidate or it is obvious which candidate to choose by doing a
593 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
600 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
607 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
613 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
620 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
627 # initial value of a variable or macro / define can have for it to appear in the
629 # it will be hidden. Use a value of 0 to hide initializers completely. The
637 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
638 # the bottom of the documentation of classes and structs. If set to YES the list
639 # will mention the files that were used to generate the documentation.
644 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
651 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
658 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
659 # doxygen should invoke to get the current version for each file (typically from
663 # by doxygen. Whatever the program writes to standard output is used as the file
668 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
681 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
684 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
688 # also \cite for info how to create references.
693 # Configuration options related to warning and progress messages
696 # The QUIET tag can be used to turn on/off the messages that are generated to
697 # standard output by doxygen. If QUIET is set to YES this implies that the
703 # The WARNINGS tag can be used to turn on/off the warning messages that are
704 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
712 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
713 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
719 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
727 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
729 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
745 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
746 # messages should be written. If left blank the output is written to standard
752 # Configuration options related to the input files
755 # The INPUT tag is used to specify the files and/or directories that contain
763 # This tag can be used to specify the character encoding of the source files
773 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
774 # *.h) to filter out the source-files in the directories. If left blank the
783 # The RECURSIVE tag can be used to specify whether or not subdirectories should
789 # The EXCLUDE tag can be used to specify files and/or directories that should be
793 # Note that relative paths are relative to the directory from which doxygen is
798 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
806 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
809 # Note that the wildcards are matched against the file with absolute path, so to
814 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
820 # Note that the wildcards are matched against the file with absolute path, so to
825 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
832 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
833 # *.h) to filter out the source-files in the directories. If left blank all
838 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
839 # searched for input files to be used with the \include or \dontinclude commands
845 # The IMAGE_PATH tag can be used to specify one or more files or directories
846 # that contain images that are to be included in the documentation (see the
851 # The INPUT_FILTER tag can be used to specify a program that doxygen should
852 # invoke to filter for each input file. Doxygen will invoke the filter program
859 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
868 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
877 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
878 # INPUT_FILTER ) will also be used to filter the input files that are used for
879 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
884 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
886 # it is also possible to disable source filtering for a specific pattern using
888 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
892 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
895 # and want to reuse the introduction page also for the doxygen output.
900 # Configuration options related to source browsing
903 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
907 # also VERBATIM_HEADERS is set to NO.
912 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
918 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
925 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
931 # If the REFERENCES_RELATION tag is set to YES then for each documented function
937 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
938 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
939 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
940 # link to the documentation.
947 # brief description and links to the definition and documentation. Since this
949 # can opt to disable this feature.
951 # This tag requires that the tag SOURCE_BROWSER is set to YES.
955 # If the USE_HTAGS tag is set to YES then the references to source code will
956 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
964 # - Make sure the INPUT points to the root of the source tree
970 # The result: instead of the source browser generated by doxygen, the links to
971 # source code will now point to the output of htags.
973 # This tag requires that the tag SOURCE_BROWSER is set to YES.
979 # specified. Set to NO to disable this.
986 # Configuration options related to the alphabetical class index
989 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
996 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
999 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1005 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1007 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1012 # Configuration options related to the HTML output
1015 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1020 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1024 # This tag requires that the tag GENERATE_HTML is set to YES.
1028 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1031 # This tag requires that the tag GENERATE_HTML is set to YES.
1035 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1041 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1046 # for information on how to generate the default header that doxygen normally
1048 # Note: The header is subject to change so you typically have to regenerate the
1049 # default header when upgrading to a newer version of doxygen. For a description
1051 # This tag requires that the tag GENERATE_HTML is set to YES.
1055 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1057 # footer. See HTML_HEADER for more information on how to generate a default
1059 # section "Doxygen usage" for information on how to generate the default footer
1061 # This tag requires that the tag GENERATE_HTML is set to YES.
1065 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1066 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1068 # See also section "Doxygen usage" for information on how to generate the style
1070 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1073 # This tag requires that the tag GENERATE_HTML is set to YES.
1077 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1082 # Doxygen will copy the style sheet file to the output directory. For an example
1084 # This tag requires that the tag GENERATE_HTML is set to YES.
1088 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1089 # other source files which should be copied to the HTML output directory. Note
1090 # that these files will be copied to the base HTML output directory. Use the
1091 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1094 # This tag requires that the tag GENERATE_HTML is set to YES.
1099 # will adjust the colors in the stylesheet and background images according to
1105 # This tag requires that the tag GENERATE_HTML is set to YES.
1113 # This tag requires that the tag GENERATE_HTML is set to YES.
1117 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1124 # This tag requires that the tag GENERATE_HTML is set to YES.
1128 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1130 # to NO can help when comparing the output of multiple runs.
1132 # This tag requires that the tag GENERATE_HTML is set to YES.
1136 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1140 # This tag requires that the tag GENERATE_HTML is set to YES.
1146 # and collapse entries dynamically later on. Doxygen will expand the tree to
1153 # This tag requires that the tag GENERATE_HTML is set to YES.
1157 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1167 # This tag requires that the tag GENERATE_HTML is set to YES.
1175 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1181 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1183 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1191 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1197 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1201 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1215 # This tag requires that the tag GENERATE_HTML is set to YES.
1219 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1221 # written to the html output directory.
1222 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1226 # The HHC_LOCATION tag can be used to specify the location (absolute path
1228 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1229 # The file has to be specified with full path.
1230 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1237 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1241 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1243 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1250 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1254 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1255 # the table of contents of the HTML help documentation and to the tree view.
1257 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1261 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1263 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1266 # This tag requires that the tag GENERATE_HTML is set to YES.
1270 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1271 # the file name of the resulting .qch file. The path specified is relative to
1273 # This tag requires that the tag GENERATE_QHP is set to YES.
1277 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1281 # This tag requires that the tag GENERATE_QHP is set to YES.
1285 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1290 # This tag requires that the tag GENERATE_QHP is set to YES.
1295 # filter to add. For more information please see Qt Help Project / Custom
1298 # This tag requires that the tag GENERATE_QHP is set to YES.
1303 # custom filter to add. For more information please see Qt Help Project / Custom
1306 # This tag requires that the tag GENERATE_QHP is set to YES.
1313 # This tag requires that the tag GENERATE_QHP is set to YES.
1317 # The QHG_LOCATION tag can be used to specify the location of Qt's
1318 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1320 # This tag requires that the tag GENERATE_QHP is set to YES.
1324 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1328 # to be copied into the plugins directory of eclipse. The name of the directory
1330 # After copying Eclipse needs to be restarted before the help appears.
1332 # This tag requires that the tag GENERATE_HTML is set to YES.
1340 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1345 # be necessary to disable the index and replace it with your own. The
1346 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1349 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1351 # This tag requires that the tag GENERATE_HTML is set to YES.
1355 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1356 # structure should be generated to display hierarchical information. If the tag
1357 # value is set to YES, a side panel will be generated containing a tree-like
1359 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1363 # sheet generated by doxygen has an example that shows how to put an image at
1366 # DISABLE_INDEX to YES when enabling this option.
1368 # This tag requires that the tag GENERATE_HTML is set to YES.
1372 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1378 # This tag requires that the tag GENERATE_HTML is set to YES.
1383 # to set the initial width (in pixels) of the frame in which the tree is shown.
1385 # This tag requires that the tag GENERATE_HTML is set to YES.
1389 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1392 # This tag requires that the tag GENERATE_HTML is set to YES.
1396 # Use this tag to change the font size of LaTeX formulas included as images in
1398 # doxygen run you need to manually remove any form_*.png images from the HTML
1399 # output directory to force them to be regenerated.
1401 # This tag requires that the tag GENERATE_HTML is set to YES.
1405 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1409 # Note that when changing this option you need to delete any form_*.png files in
1412 # This tag requires that the tag GENERATE_HTML is set to YES.
1416 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1419 # installed or if you want to formulas look prettier in the HTML output. When
1420 # enabled you may also need to install MathJax separately and configure the path
1421 # to it using the MATHJAX_RELPATH option.
1423 # This tag requires that the tag GENERATE_HTML is set to YES.
1427 # When MathJax is enabled you can set the default output format to be used for
1433 # This tag requires that the tag USE_MATHJAX is set to YES.
1437 # When MathJax is enabled you need to specify the location relative to the HTML
1441 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1443 # MathJax. However, it is strongly recommended to install a local copy of
1446 # This tag requires that the tag USE_MATHJAX is set to YES.
1450 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1453 # This tag requires that the tag USE_MATHJAX is set to YES.
1457 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1461 # This tag requires that the tag USE_MATHJAX is set to YES.
1471 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1472 # search using the keyboard; to jump to the search box use <access key> + S
1475 # key> to jump into the search results window, the results can be navigated
1476 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1479 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1482 # This tag requires that the tag GENERATE_HTML is set to YES.
1491 # enabled the indexing and searching needs to be provided by external tools. See
1494 # This tag requires that the tag SEARCHENGINE is set to YES.
1499 # script for searching. Instead the search results are written to an XML file
1500 # which needs to be processed by an external indexer. Doxygen will invoke an
1501 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1510 # This tag requires that the tag SEARCHENGINE is set to YES.
1514 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1521 # This tag requires that the tag SEARCHENGINE is set to YES.
1526 # search data is written to a file for indexing by an external tool. With the
1529 # This tag requires that the tag SEARCHENGINE is set to YES.
1535 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1536 # projects and redirect the results back to the right project.
1537 # This tag requires that the tag SEARCHENGINE is set to YES.
1541 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1543 # all added to the same external search index. Each project needs to have a
1545 # to a relative location where the documentation can be found. The format is:
1547 # This tag requires that the tag SEARCHENGINE is set to YES.
1552 # Configuration options related to the LaTeX output
1555 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1560 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1564 # This tag requires that the tag GENERATE_LATEX is set to YES.
1568 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1573 # written to the output directory.
1575 # This tag requires that the tag GENERATE_LATEX is set to YES.
1579 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1582 # This tag requires that the tag GENERATE_LATEX is set to YES.
1586 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1587 # documents. This may be useful for small projects and may help to save some
1590 # This tag requires that the tag GENERATE_LATEX is set to YES.
1594 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1599 # This tag requires that the tag GENERATE_LATEX is set to YES.
1603 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1608 # This tag requires that the tag GENERATE_LATEX is set to YES.
1612 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1615 # section "Doxygen usage" for information on how to let doxygen write the
1616 # default header to a separate file.
1624 # This tag requires that the tag GENERATE_LATEX is set to YES.
1628 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1633 # This tag requires that the tag GENERATE_LATEX is set to YES.
1637 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1638 # other source files which should be copied to the LATEX_OUTPUT output
1641 # This tag requires that the tag GENERATE_LATEX is set to YES.
1645 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1646 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1650 # This tag requires that the tag GENERATE_LATEX is set to YES.
1654 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1655 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1658 # This tag requires that the tag GENERATE_LATEX is set to YES.
1662 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1663 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1667 # This tag requires that the tag GENERATE_LATEX is set to YES.
1671 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1674 # This tag requires that the tag GENERATE_LATEX is set to YES.
1678 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1684 # This tag requires that the tag GENERATE_LATEX is set to YES.
1688 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1692 # This tag requires that the tag GENERATE_LATEX is set to YES.
1697 # Configuration options related to the RTF output
1700 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1707 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1711 # This tag requires that the tag GENERATE_RTF is set to YES.
1715 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1716 # documents. This may be useful for small projects and may help to save some
1719 # This tag requires that the tag GENERATE_RTF is set to YES.
1723 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1731 # This tag requires that the tag GENERATE_RTF is set to YES.
1735 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1736 # file, i.e. a series of assignments. You only have to provide replacements,
1737 # missing definitions are set to their default value.
1739 # See also section "Doxygen usage" for information on how to generate the
1741 # This tag requires that the tag GENERATE_RTF is set to YES.
1746 # similar to doxygen's config file. A template extensions file can be generated
1748 # This tag requires that the tag GENERATE_RTF is set to YES.
1753 # Configuration options related to the man page output
1756 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1762 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1767 # This tag requires that the tag GENERATE_MAN is set to YES.
1771 # The MAN_EXTENSION tag determines the extension that is added to the generated
1776 # This tag requires that the tag GENERATE_MAN is set to YES.
1780 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1783 # them the man command would be unable to find the correct page.
1785 # This tag requires that the tag GENERATE_MAN is set to YES.
1790 # Configuration options related to the XML output
1793 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1799 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1803 # This tag requires that the tag GENERATE_XML is set to YES.
1807 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1808 # validating XML parser to check the syntax of the XML files.
1809 # This tag requires that the tag GENERATE_XML is set to YES.
1813 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1814 # validating XML parser to check the syntax of the XML files.
1815 # This tag requires that the tag GENERATE_XML is set to YES.
1819 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1820 # listings (including syntax highlighting and cross-referencing information) to
1824 # This tag requires that the tag GENERATE_XML is set to YES.
1829 # Configuration options related to the DOCBOOK output
1832 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1833 # that can be used to generate PDF.
1838 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1842 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1850 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1859 # Configuration options related to the Perl module output
1862 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1870 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1871 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1874 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1878 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1879 # formatted so it can be parsed by a human reader. This is useful if you want to
1880 # understand what is going on. On the other hand, if this tag is set to NO the
1884 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1892 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1897 # Configuration options related to the preprocessor
1900 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1906 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1907 # in the source code. If set to NO only conditional compilation will be
1909 # EXPAND_ONLY_PREDEF to YES.
1911 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1915 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1916 # the macro expansion is limited to the macros specified with the PREDEFINED and
1919 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1923 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1926 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1930 # The INCLUDE_PATH tag can be used to specify one or more directories that
1933 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1937 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1938 # patterns (like *.h and *.hpp) to filter out the header-files in the
1941 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1945 # The PREDEFINED tag can be used to specify one or more macro names that are
1946 # defined before the preprocessor is started (similar to the -D option of e.g.
1951 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1961 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1962 # tag can be used to specify a list of macro names that should be expanded. The
1964 # tag if you want to use a different macro definition that overrules the
1966 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1970 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1971 # remove all references to function-like macros that are alone on a line, have an
1976 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1981 # Configuration options related to external references
1984 # The TAGFILES tag can be used to specify one or more tag files. For each tag
1991 # section "Linking to external documentation" for more information about the use
1995 # run, you must also specify the path to the tagfile here.
2000 # tag file that is based on the input files it reads. See section "Linking to
2005 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2006 # class index. If set to NO only the inherited external classes will be listed.
2011 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2012 # the modules index. If set to NO, only the current project's groups will be
2018 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2019 # the related pages index. If set to NO, only the current project's pages will
2032 # Configuration options related to the dot tool
2035 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2036 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2038 # disabled, but it is recommended to install and use dot, since it yields more
2046 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2047 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2048 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2054 # then run dia to produce the diagram and insert it in the documentation. The
2055 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2056 # If left empty dia is assumed to be found in the default search path.
2060 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2066 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2070 # set to NO
2076 # to run in parallel. When set to 0 doxygen will base this on the number of
2077 # processors available in the system. You can set it explicitly to a value
2078 # larger than 0 to get control over the balance between CPU load and processing
2081 # This tag requires that the tag HAVE_DOT is set to YES.
2086 # generates you can specify the font name using DOT_FONTNAME. You need to make
2087 # sure dot is able to find the font, which can be done by putting it in a
2089 # setting DOT_FONTPATH to the directory containing the font.
2091 # This tag requires that the tag HAVE_DOT is set to YES.
2095 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2098 # This tag requires that the tag HAVE_DOT is set to YES.
2102 # By default doxygen will tell dot to use the default font as specified with
2105 # This tag requires that the tag HAVE_DOT is set to YES.
2109 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2111 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2113 # This tag requires that the tag HAVE_DOT is set to YES.
2117 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2122 # This tag requires that the tag HAVE_DOT is set to YES.
2126 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2129 # This tag requires that the tag HAVE_DOT is set to YES.
2133 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2134 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2137 # This tag requires that the tag HAVE_DOT is set to YES.
2143 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2144 # number of items for each type to make the size more manageable. Set this to 0
2146 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2147 # but if the number exceeds 15, the total amount of fields shown is limited to
2150 # This tag requires that the tag HAVE_DOT is set to YES.
2154 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2158 # This tag requires that the tag HAVE_DOT is set to YES.
2162 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2167 # This tag requires that the tag HAVE_DOT is set to YES.
2172 # set to YES then doxygen will generate a graph for each documented file showing
2176 # This tag requires that the tag HAVE_DOT is set to YES.
2180 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2184 # So in most cases it will be better to enable call graphs for selected
2187 # This tag requires that the tag HAVE_DOT is set to YES.
2191 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2195 # So in most cases it will be better to enable caller graphs for selected
2198 # This tag requires that the tag HAVE_DOT is set to YES.
2202 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2205 # This tag requires that the tag HAVE_DOT is set to YES.
2209 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2214 # This tag requires that the tag HAVE_DOT is set to YES.
2218 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2220 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2221 # to make the SVG files visible in IE 9+ (other browsers do not have this
2225 # This tag requires that the tag HAVE_DOT is set to YES.
2229 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2234 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2237 # This tag requires that the tag HAVE_DOT is set to YES.
2241 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2243 # This tag requires that the tag HAVE_DOT is set to YES.
2247 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2250 # This tag requires that the tag HAVE_DOT is set to YES.
2254 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2260 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2266 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2274 # This tag requires that the tag HAVE_DOT is set to YES.
2278 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2281 # further from the root node will be omitted. Note that setting this option to 1
2286 # This tag requires that the tag HAVE_DOT is set to YES.
2290 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2292 # to support this out of the box.
2294 # Warning: Depending on the platform used, enabling this option may lead to
2295 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2298 # This tag requires that the tag HAVE_DOT is set to YES.
2302 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2307 # This tag requires that the tag HAVE_DOT is set to YES.
2311 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2315 # This tag requires that the tag HAVE_DOT is set to YES.
2319 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2320 # files that are used to generate the various graphs.
2322 # This tag requires that the tag HAVE_DOT is set to YES.