Lines Matching refs: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 # 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 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
98 # documentation (similar to Javadoc). Set to NO to disable this.
103 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
113 # used to form the text in various listings. Each string in this list, if found
133 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
140 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
148 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
149 # before files name in the file list and in the header files. If set to NO the
155 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
157 # part of the path. The tag can be used to show relative paths in the file list.
158 # If left blank the directory from which doxygen is run is used as the path to
163 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
167 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
169 # header file to include in order to use a class. If left blank only the name of
171 # specify the list of include paths that are normally passed to the compiler
176 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
183 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
185 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
192 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
194 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
200 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
202 # a brief description. This used to be the default behavior. The new default is
203 # to treat a multi-line C++ comment block as a detailed description. Set this
204 # tag to YES if you prefer the old behavior instead.
206 # Note that setting this tag to YES also means that rational rose comments are
212 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
218 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
219 # new page for each member. If set to NO, the documentation of a member will be
225 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
226 # uses this value to replace tabs by spaces in code fragments.
231 # This tag can be used to specify a number of aliases that act as commands in
236 # will allow you to put the command \sideeffect (or @sideeffect) in the
238 # "Side Effects:". You can put \n's in the value part of an alias to insert
243 # This tag can be used to specify a number of word-keyword mappings (TCL only).
245 # will allow you to use the command class in the itcl::class meaning.
249 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
257 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
265 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
271 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
277 # Doxygen selects the parser to use depending on the extension of the files it
278 # parses. With this tag you can assign which parser to use for a given
284 # Fortran. In the later case the parser tries to guess whether the code is fixed
286 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
291 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
297 # according to the Markdown format, which allows for more readable
306 # When enabled doxygen tries to link words that correspond to documented
307 # classes, or namespaces to their corresponding documentation. Such a link can
309 # or globally by setting AUTOLINK_SUPPORT to NO.
315 # to include (a tag file for) the STL sources as input, then you should set this
316 # tag to YES in order to let doxygen match functions declarations and
324 # If you use Microsoft's C++/CLI language, you should set this option to YES to
330 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
338 # For Microsoft's IDL there are propget and propput attributes to indicate
339 # getter and setter methods for a property. Setting this option to YES will make
340 # doxygen to replace the get and set methods by a property in the documentation.
342 # type. If this is not the case, or you want to show the methods anyway, you
343 # should set this option to NO.
349 # tag is set to YES, then doxygen will reuse the documentation of the first
356 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
357 # (for instance a group of public functions) to be put as a subgroup of that
358 # type (e.g. under the Public Functions section). Set it to NO to prevent
365 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
376 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
380 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
398 # cache is used to resolve symbols given their name and scope. Since this can be
403 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
414 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
417 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
419 # normally produced when WARNINGS is set to YES.
424 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
430 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
436 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
442 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
443 # locally in source files will be included in the documentation. If set to NO
450 # This flag is only useful for Objective-C code. When set to YES local methods,
452 # included in the documentation. If set to NO only methods in the interface are
458 # If this flag is set to YES, the members of anonymous namespaces will be
467 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
468 # undocumented members inside documented classes or files. If set to NO these
475 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
477 # to NO these classes will be included in the various overviews. This option has
483 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
484 # (class|struct|union) declarations. If set to NO these declarations will be
490 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
491 # documentation blocks found inside the body of a function. If set to NO these
492 # blocks will be appended to the function's detailed documentation block.
498 # \internal command is included. If the tag is set to NO then the documentation
499 # will be excluded. Set it to YES to include the internal documentation.
504 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
505 # names in lower-case letters. If set to YES upper-case letters are also
508 # and Mac users are advised to set this option to NO.
513 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
514 # their full class and namespace scopes in the documentation. If set to YES the
520 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
526 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
527 # grouped member an include statement to the documentation, telling the reader
528 # which file to include in order to use the member.
533 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
539 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
545 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
547 # name. If set to NO the members will appear in declaration order.
552 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
554 # name. If set to NO the members will appear in declaration order. Note that
560 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
562 # destructors are listed first. If set to NO the constructors will appear in the
564 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
566 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
572 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
573 # of group names into alphabetical order. If set to NO the group names will
579 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
580 # fully-qualified names, including namespaces. If set to NO, the class list will
582 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
583 # Note: This option applies only to the class list, not to the alphabetical
589 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
592 # only one candidate or it is obvious which candidate to choose by doing a
599 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
606 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
613 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
619 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
626 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
633 # initial value of a variable or macro / define can have for it to appear in the
635 # it will be hidden. Use a value of 0 to hide initializers completely. The
643 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
644 # the bottom of the documentation of classes and structs. If set to YES the list
645 # will mention the files that were used to generate the documentation.
650 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
657 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
664 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
665 # doxygen should invoke to get the current version for each file (typically from
669 # by doxygen. Whatever the program writes to standard output is used as the file
674 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
687 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
690 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
694 # also \cite for info how to create references.
699 # Configuration options related to warning and progress messages
702 # The QUIET tag can be used to turn on/off the messages that are generated to
703 # standard output by doxygen. If QUIET is set to YES this implies that the
709 # The WARNINGS tag can be used to turn on/off the warning messages that are
710 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
718 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
719 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
725 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
733 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
735 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
751 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
752 # messages should be written. If left blank the output is written to standard
758 # Configuration options related to the input files
761 # The INPUT tag is used to specify the files and/or directories that contain
781 # This tag can be used to specify the character encoding of the source files
791 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
792 # *.h) to filter out the source-files in the directories. If left blank the
810 # The RECURSIVE tag can be used to specify whether or not subdirectories should
816 # The EXCLUDE tag can be used to specify files and/or directories that should be
820 # Note that relative paths are relative to the directory from which doxygen is
825 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
833 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
836 # Note that the wildcards are matched against the file with absolute path, so to
841 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
847 # Note that the wildcards are matched against the file with absolute path, so to
852 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
859 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
860 # *.h) to filter out the source-files in the directories. If left blank all
865 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
866 # searched for input files to be used with the \include or \dontinclude commands
872 # The IMAGE_PATH tag can be used to specify one or more files or directories
873 # that contain images that are to be included in the documentation (see the
878 # The INPUT_FILTER tag can be used to specify a program that doxygen should
879 # invoke to filter for each input file. Doxygen will invoke the filter program
886 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
895 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
904 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
905 # INPUT_FILTER ) will also be used to filter the input files that are used for
906 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
911 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
913 # it is also possible to disable source filtering for a specific pattern using
915 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
919 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
922 # and want to reuse the introduction page also for the doxygen output.
927 # Configuration options related to source browsing
930 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
934 # also VERBATIM_HEADERS is set to NO.
939 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
945 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
952 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
958 # If the REFERENCES_RELATION tag is set to YES then for each documented function
964 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
965 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
966 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
967 # link to the documentation.
974 # brief description and links to the definition and documentation. Since this
976 # can opt to disable this feature.
978 # This tag requires that the tag SOURCE_BROWSER is set to YES.
982 # If the USE_HTAGS tag is set to YES then the references to source code will
983 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
991 # - Make sure the INPUT points to the root of the source tree
997 # The result: instead of the source browser generated by doxygen, the links to
998 # source code will now point to the output of htags.
1000 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1006 # specified. Set to NO to disable this.
1012 # If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
1027 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1032 # Configuration options related to the alphabetical class index
1035 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1042 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1045 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1051 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1053 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1058 # Configuration options related to the HTML output
1061 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1066 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1070 # This tag requires that the tag GENERATE_HTML is set to YES.
1074 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1077 # This tag requires that the tag GENERATE_HTML is set to YES.
1081 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1087 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1092 # for information on how to generate the default header that doxygen normally
1094 # Note: The header is subject to change so you typically have to regenerate the
1095 # default header when upgrading to a newer version of doxygen. For a description
1097 # This tag requires that the tag GENERATE_HTML is set to YES.
1101 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1103 # footer. See HTML_HEADER for more information on how to generate a default
1105 # section "Doxygen usage" for information on how to generate the default footer
1107 # This tag requires that the tag GENERATE_HTML is set to YES.
1111 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1112 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1114 # See also section "Doxygen usage" for information on how to generate the style
1116 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1119 # This tag requires that the tag GENERATE_HTML is set to YES.
1123 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1128 # Doxygen will copy the style sheet file to the output directory. For an example
1130 # This tag requires that the tag GENERATE_HTML is set to YES.
1134 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1135 # other source files which should be copied to the HTML output directory. Note
1136 # that these files will be copied to the base HTML output directory. Use the
1137 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1140 # This tag requires that the tag GENERATE_HTML is set to YES.
1145 # will adjust the colors in the stylesheet and background images according to
1151 # This tag requires that the tag GENERATE_HTML is set to YES.
1159 # This tag requires that the tag GENERATE_HTML is set to YES.
1163 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1170 # This tag requires that the tag GENERATE_HTML is set to YES.
1174 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1176 # to NO can help when comparing the output of multiple runs.
1178 # This tag requires that the tag GENERATE_HTML is set to YES.
1182 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1186 # This tag requires that the tag GENERATE_HTML is set to YES.
1192 # and collapse entries dynamically later on. Doxygen will expand the tree to
1199 # This tag requires that the tag GENERATE_HTML is set to YES.
1203 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1213 # This tag requires that the tag GENERATE_HTML is set to YES.
1221 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1227 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1229 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1237 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1243 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1247 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1261 # This tag requires that the tag GENERATE_HTML is set to YES.
1265 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1267 # written to the html output directory.
1268 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1272 # The HHC_LOCATION tag can be used to specify the location (absolute path
1274 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1275 # The file has to be specified with full path.
1276 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1283 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1287 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1289 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1297 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1301 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1302 # the table of contents of the HTML help documentation and to the tree view.
1304 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1308 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1310 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1313 # This tag requires that the tag GENERATE_HTML is set to YES.
1317 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1318 # the file name of the resulting .qch file. The path specified is relative to
1320 # This tag requires that the tag GENERATE_QHP is set to YES.
1324 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1328 # This tag requires that the tag GENERATE_QHP is set to YES.
1332 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1337 # This tag requires that the tag GENERATE_QHP is set to YES.
1342 # filter to add. For more information please see Qt Help Project / Custom
1345 # This tag requires that the tag GENERATE_QHP is set to YES.
1350 # custom filter to add. For more information please see Qt Help Project / Custom
1353 # This tag requires that the tag GENERATE_QHP is set to YES.
1360 # This tag requires that the tag GENERATE_QHP is set to YES.
1364 # The QHG_LOCATION tag can be used to specify the location of Qt's
1365 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1367 # This tag requires that the tag GENERATE_QHP is set to YES.
1371 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1375 # to be copied into the plugins directory of eclipse. The name of the directory
1377 # After copying Eclipse needs to be restarted before the help appears.
1379 # This tag requires that the tag GENERATE_HTML is set to YES.
1387 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1392 # be necessary to disable the index and replace it with your own. The
1393 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1396 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1398 # This tag requires that the tag GENERATE_HTML is set to YES.
1402 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1403 # structure should be generated to display hierarchical information. If the tag
1404 # value is set to YES, a side panel will be generated containing a tree-like
1406 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1410 # sheet generated by doxygen has an example that shows how to put an image at
1413 # DISABLE_INDEX to YES when enabling this option.
1415 # This tag requires that the tag GENERATE_HTML is set to YES.
1419 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1425 # This tag requires that the tag GENERATE_HTML is set to YES.
1430 # to set the initial width (in pixels) of the frame in which the tree is shown.
1432 # This tag requires that the tag GENERATE_HTML is set to YES.
1436 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1439 # This tag requires that the tag GENERATE_HTML is set to YES.
1443 # Use this tag to change the font size of LaTeX formulas included as images in
1445 # doxygen run you need to manually remove any form_*.png images from the HTML
1446 # output directory to force them to be regenerated.
1448 # This tag requires that the tag GENERATE_HTML is set to YES.
1452 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1456 # Note that when changing this option you need to delete any form_*.png files in
1459 # This tag requires that the tag GENERATE_HTML is set to YES.
1463 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1466 # installed or if you want to formulas look prettier in the HTML output. When
1467 # enabled you may also need to install MathJax separately and configure the path
1468 # to it using the MATHJAX_RELPATH option.
1470 # This tag requires that the tag GENERATE_HTML is set to YES.
1474 # When MathJax is enabled you can set the default output format to be used for
1480 # This tag requires that the tag USE_MATHJAX is set to YES.
1484 # When MathJax is enabled you need to specify the location relative to the HTML
1488 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1490 # MathJax. However, it is strongly recommended to install a local copy of
1493 # This tag requires that the tag USE_MATHJAX is set to YES.
1497 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1500 # This tag requires that the tag USE_MATHJAX is set to YES.
1504 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1508 # This tag requires that the tag USE_MATHJAX is set to YES.
1518 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1519 # search using the keyboard; to jump to the search box use <access key> + S
1522 # key> to jump into the search results window, the results can be navigated
1523 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1526 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1529 # This tag requires that the tag GENERATE_HTML is set to YES.
1538 # and searching needs to be provided by external tools. See the section
1541 # This tag requires that the tag SEARCHENGINE is set to YES.
1546 # script for searching. Instead the search results are written to an XML file
1547 # which needs to be processed by an external indexer. Doxygen will invoke an
1548 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1557 # This tag requires that the tag SEARCHENGINE is set to YES.
1561 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1568 # This tag requires that the tag SEARCHENGINE is set to YES.
1573 # search data is written to a file for indexing by an external tool. With the
1576 # This tag requires that the tag SEARCHENGINE is set to YES.
1582 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1583 # projects and redirect the results back to the right project.
1584 # This tag requires that the tag SEARCHENGINE is set to YES.
1588 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1590 # all added to the same external search index. Each project needs to have a
1592 # to a relative location where the documentation can be found. The format is:
1594 # This tag requires that the tag SEARCHENGINE is set to YES.
1599 # Configuration options related to the LaTeX output
1602 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1607 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1611 # This tag requires that the tag GENERATE_LATEX is set to YES.
1615 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1620 # written to the output directory.
1622 # This tag requires that the tag GENERATE_LATEX is set to YES.
1626 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1629 # This tag requires that the tag GENERATE_LATEX is set to YES.
1633 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1634 # documents. This may be useful for small projects and may help to save some
1637 # This tag requires that the tag GENERATE_LATEX is set to YES.
1641 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1646 # This tag requires that the tag GENERATE_LATEX is set to YES.
1650 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1655 # This tag requires that the tag GENERATE_LATEX is set to YES.
1659 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1662 # section "Doxygen usage" for information on how to let doxygen write the
1663 # default header to a separate file.
1671 # This tag requires that the tag GENERATE_LATEX is set to YES.
1675 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1680 # This tag requires that the tag GENERATE_LATEX is set to YES.
1684 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1685 # other source files which should be copied to the LATEX_OUTPUT output
1688 # This tag requires that the tag GENERATE_LATEX is set to YES.
1692 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1693 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1697 # This tag requires that the tag GENERATE_LATEX is set to YES.
1701 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1702 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1705 # This tag requires that the tag GENERATE_LATEX is set to YES.
1709 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1710 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1714 # This tag requires that the tag GENERATE_LATEX is set to YES.
1718 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1721 # This tag requires that the tag GENERATE_LATEX is set to YES.
1725 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1731 # This tag requires that the tag GENERATE_LATEX is set to YES.
1735 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1739 # This tag requires that the tag GENERATE_LATEX is set to YES.
1744 # Configuration options related to the RTF output
1747 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1754 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1758 # This tag requires that the tag GENERATE_RTF is set to YES.
1762 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1763 # documents. This may be useful for small projects and may help to save some
1766 # This tag requires that the tag GENERATE_RTF is set to YES.
1770 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1778 # This tag requires that the tag GENERATE_RTF is set to YES.
1782 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1783 # file, i.e. a series of assignments. You only have to provide replacements,
1784 # missing definitions are set to their default value.
1786 # See also section "Doxygen usage" for information on how to generate the
1788 # This tag requires that the tag GENERATE_RTF is set to YES.
1793 # similar to doxygen's config file. A template extensions file can be generated
1795 # This tag requires that the tag GENERATE_RTF is set to YES.
1800 # Configuration options related to the man page output
1803 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1809 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1814 # This tag requires that the tag GENERATE_MAN is set to YES.
1818 # The MAN_EXTENSION tag determines the extension that is added to the generated
1823 # This tag requires that the tag GENERATE_MAN is set to YES.
1828 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1830 # This tag requires that the tag GENERATE_MAN is set to YES.
1834 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1837 # them the man command would be unable to find the correct page.
1839 # This tag requires that the tag GENERATE_MAN is set to YES.
1844 # Configuration options related to the XML output
1847 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1853 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1857 # This tag requires that the tag GENERATE_XML is set to YES.
1861 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1862 # listings (including syntax highlighting and cross-referencing information) to
1866 # This tag requires that the tag GENERATE_XML is set to YES.
1871 # Configuration options related to the DOCBOOK output
1874 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1875 # that can be used to generate PDF.
1880 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1884 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1892 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1901 # Configuration options related to the Perl module output
1904 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1912 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1913 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1916 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1920 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1921 # formatted so it can be parsed by a human reader. This is useful if you want to
1922 # understand what is going on. On the other hand, if this tag is set to NO the
1926 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1934 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1939 # Configuration options related to the preprocessor
1942 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1948 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1949 # in the source code. If set to NO only conditional compilation will be
1951 # EXPAND_ONLY_PREDEF to YES.
1953 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1957 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1958 # the macro expansion is limited to the macros specified with the PREDEFINED and
1961 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1965 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1968 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1972 # The INCLUDE_PATH tag can be used to specify one or more directories that
1975 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1979 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1980 # patterns (like *.h and *.hpp) to filter out the header-files in the
1983 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1987 # The PREDEFINED tag can be used to specify one or more macro names that are
1988 # defined before the preprocessor is started (similar to the -D option of e.g.
1993 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2003 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2004 # tag can be used to specify a list of macro names that should be expanded. The
2006 # tag if you want to use a different macro definition that overrules the
2008 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2013 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2014 # remove all references to function-like macros that are alone on a line, have
2019 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2024 # Configuration options related to external references
2027 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2034 # section "Linking to external documentation" for more information about the use
2038 # run, you must also specify the path to the tagfile here.
2043 # tag file that is based on the input files it reads. See section "Linking to
2048 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2049 # class index. If set to NO only the inherited external classes will be listed.
2054 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2055 # the modules index. If set to NO, only the current project's groups will be
2061 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2062 # the related pages index. If set to NO, only the current project's pages will
2075 # Configuration options related to the dot tool
2078 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2079 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2081 # disabled, but it is recommended to install and use dot, since it yields more
2089 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2090 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2091 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2097 # then run dia to produce the diagram and insert it in the documentation. The
2098 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2099 # If left empty dia is assumed to be found in the default search path.
2103 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2109 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2113 # set to NO
2119 # to run in parallel. When set to 0 doxygen will base this on the number of
2120 # processors available in the system. You can set it explicitly to a value
2121 # larger than 0 to get control over the balance between CPU load and processing
2124 # This tag requires that the tag HAVE_DOT is set to YES.
2129 # generates you can specify the font name using DOT_FONTNAME. You need to make
2130 # sure dot is able to find the font, which can be done by putting it in a
2132 # setting DOT_FONTPATH to the directory containing the font.
2134 # This tag requires that the tag HAVE_DOT is set to YES.
2138 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2141 # This tag requires that the tag HAVE_DOT is set to YES.
2145 # By default doxygen will tell dot to use the default font as specified with
2148 # This tag requires that the tag HAVE_DOT is set to YES.
2152 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2154 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2156 # This tag requires that the tag HAVE_DOT is set to YES.
2160 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2165 # This tag requires that the tag HAVE_DOT is set to YES.
2169 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2172 # This tag requires that the tag HAVE_DOT is set to YES.
2176 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2177 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2180 # This tag requires that the tag HAVE_DOT is set to YES.
2186 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2187 # number of items for each type to make the size more manageable. Set this to 0
2189 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2190 # but if the number exceeds 15, the total amount of fields shown is limited to
2193 # This tag requires that the tag HAVE_DOT is set to YES.
2197 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2201 # This tag requires that the tag HAVE_DOT is set to YES.
2205 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2210 # This tag requires that the tag HAVE_DOT is set to YES.
2215 # set to YES then doxygen will generate a graph for each documented file showing
2219 # This tag requires that the tag HAVE_DOT is set to YES.
2223 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2227 # So in most cases it will be better to enable call graphs for selected
2230 # This tag requires that the tag HAVE_DOT is set to YES.
2234 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2238 # So in most cases it will be better to enable caller graphs for selected
2241 # This tag requires that the tag HAVE_DOT is set to YES.
2245 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2248 # This tag requires that the tag HAVE_DOT is set to YES.
2252 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2257 # This tag requires that the tag HAVE_DOT is set to YES.
2261 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2263 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2264 # to make the SVG files visible in IE 9+ (other browsers do not have this
2268 # This tag requires that the tag HAVE_DOT is set to YES.
2272 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2277 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2280 # This tag requires that the tag HAVE_DOT is set to YES.
2284 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2286 # This tag requires that the tag HAVE_DOT is set to YES.
2290 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2293 # This tag requires that the tag HAVE_DOT is set to YES.
2297 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2303 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2309 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2317 # This tag requires that the tag HAVE_DOT is set to YES.
2321 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2324 # further from the root node will be omitted. Note that setting this option to 1
2329 # This tag requires that the tag HAVE_DOT is set to YES.
2333 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2335 # to support this out of the box.
2337 # Warning: Depending on the platform used, enabling this option may lead to
2338 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2341 # This tag requires that the tag HAVE_DOT is set to YES.
2345 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2350 # This tag requires that the tag HAVE_DOT is set to YES.
2354 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2358 # This tag requires that the tag HAVE_DOT is set to YES.
2362 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2363 # files that are used to generate the various graphs.
2365 # This tag requires that the tag HAVE_DOT is set to YES.