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 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
75 # information to generate all constant output in the proper language.
88 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
90 # documentation (similar to Javadoc). Set to NO to disable this.
95 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
98 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
105 # used to form the text in various listings. Each string in this list, if found
125 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
132 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
140 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
141 # before files name in the file list and in the header files. If set to NO the
147 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
149 # part of the path. The tag can be used to show relative paths in the file list.
150 # If left blank the directory from which doxygen is run is used as the path to
155 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
159 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
161 # header file to include in order to use a class. If left blank only the name of
163 # specify the list of include paths that are normally passed to the compiler
168 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
175 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
177 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
184 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
186 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
192 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
194 # a brief description. This used to be the default behavior. The new default is
195 # to treat a multi-line C++ comment block as a detailed description. Set this
196 # tag to YES if you prefer the old behavior instead.
198 # Note that setting this tag to YES also means that rational rose comments are
204 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
210 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
211 # new page for each member. If set to NO, the documentation of a member will be
217 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
218 # uses this value to replace tabs by spaces in code fragments.
223 # This tag can be used to specify a number of aliases that act as commands in
228 # will allow you to put the command \sideeffect (or @sideeffect) in the
230 # "Side Effects:". You can put \n's in the value part of an alias to insert
235 # This tag can be used to specify a number of word-keyword mappings (TCL only).
237 # will allow you to use the command class in the itcl::class meaning.
241 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
249 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
257 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
263 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
269 # Doxygen selects the parser to use depending on the extension of the files it
270 # parses. With this tag you can assign which parser to use for a given
274 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
280 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
286 # according to the Markdown format, which allows for more readable
295 # When enabled doxygen tries to link words that correspond to documented
296 # classes, or namespaces to their corresponding documentation. Such a link can
298 # or globally by setting AUTOLINK_SUPPORT to NO.
304 # to include (a tag file for) the STL sources as input, then you should set this
305 # tag to YES in order to let doxygen match functions declarations and
313 # If you use Microsoft's C++/CLI language, you should set this option to YES to
319 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
327 # For Microsoft's IDL there are propget and propput attributes to indicate
328 # getter and setter methods for a property. Setting this option to YES will make
329 # doxygen to replace the get and set methods by a property in the documentation.
331 # type. If this is not the case, or you want to show the methods anyway, you
332 # should set this option to NO.
338 # tag is set to YES, then doxygen will reuse the documentation of the first
345 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
346 # (for instance a group of public functions) to be put as a subgroup of that
347 # type (e.g. under the Public Functions section). Set it to NO to prevent
354 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
365 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
369 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
387 # cache is used to resolve symbols given their name and scope. Since this can be
392 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
403 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
406 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
408 # normally produced when WARNINGS is set to YES.
413 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
419 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
425 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
431 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
432 # locally in source files will be included in the documentation. If set to NO
439 # This flag is only useful for Objective-C code. When set to YES local methods,
441 # included in the documentation. If set to NO only methods in the interface are
447 # If this flag is set to YES, the members of anonymous namespaces will be
456 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
457 # undocumented members inside documented classes or files. If set to NO these
464 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
466 # to NO these classes will be included in the various overviews. This option has
472 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
473 # (class|struct|union) declarations. If set to NO these declarations will be
479 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
480 # documentation blocks found inside the body of a function. If set to NO these
481 # blocks will be appended to the function's detailed documentation block.
487 # \internal command is included. If the tag is set to NO then the documentation
488 # will be excluded. Set it to YES to include the internal documentation.
493 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
494 # names in lower-case letters. If set to YES upper-case letters are also
497 # and Mac users are advised to set this option to NO.
502 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
503 # their full class and namespace scopes in the documentation. If set to YES the
509 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
515 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
516 # grouped member an include statement to the documentation, telling the reader
517 # which file to include in order to use the member.
522 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
528 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
534 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
536 # name. If set to NO the members will appear in declaration order.
541 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
543 # name. If set to NO the members will appear in declaration order. Note that
549 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
551 # destructors are listed first. If set to NO the constructors will appear in the
553 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
555 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
561 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
562 # of group names into alphabetical order. If set to NO the group names will
568 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
569 # fully-qualified names, including namespaces. If set to NO, the class list will
571 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
572 # Note: This option applies only to the class list, not to the alphabetical
578 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
581 # only one candidate or it is obvious which candidate to choose by doing a
588 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
595 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
602 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
608 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
615 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
622 # initial value of a variable or macro / define can have for it to appear in the
624 # it will be hidden. Use a value of 0 to hide initializers completely. The
632 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
633 # the bottom of the documentation of classes and structs. If set to YES the list
634 # will mention the files that were used to generate the documentation.
639 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
646 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
653 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
654 # doxygen should invoke to get the current version for each file (typically from
658 # by doxygen. Whatever the program writes to standard output is used as the file
663 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
676 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
679 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
683 # also \cite for info how to create references.
688 # Configuration options related to warning and progress messages
691 # The QUIET tag can be used to turn on/off the messages that are generated to
692 # standard output by doxygen. If QUIET is set to YES this implies that the
698 # The WARNINGS tag can be used to turn on/off the warning messages that are
699 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
707 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
708 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
714 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
722 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
724 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
740 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
741 # messages should be written. If left blank the output is written to standard
747 # Configuration options related to the input files
750 # 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
786 # The RECURSIVE tag can be used to specify whether or not subdirectories should
792 # The EXCLUDE tag can be used to specify files and/or directories that should be
796 # Note that relative paths are relative to the directory from which doxygen is
801 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
809 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
812 # Note that the wildcards are matched against the file with absolute path, so to
817 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
823 # Note that the wildcards are matched against the file with absolute path, so to
828 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
837 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
838 # *.h) to filter out the source-files in the directories. If left blank all
843 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
844 # searched for input files to be used with the \include or \dontinclude commands
850 # The IMAGE_PATH tag can be used to specify one or more files or directories
851 # that contain images that are to be included in the documentation (see the
856 # The INPUT_FILTER tag can be used to specify a program that doxygen should
857 # invoke to filter for each input file. Doxygen will invoke the filter program
864 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
873 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
882 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
883 # INPUT_FILTER ) will also be used to filter the input files that are used for
884 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
889 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
891 # it is also possible to disable source filtering for a specific pattern using
893 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
897 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
900 # and want to reuse the introduction page also for the doxygen output.
905 # Configuration options related to source browsing
908 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
912 # also VERBATIM_HEADERS is set to NO.
917 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
923 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
930 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
936 # If the REFERENCES_RELATION tag is set to YES then for each documented function
942 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
943 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
944 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
945 # link to the documentation.
952 # brief description and links to the definition and documentation. Since this
954 # can opt to disable this feature.
956 # This tag requires that the tag SOURCE_BROWSER is set to YES.
960 # If the USE_HTAGS tag is set to YES then the references to source code will
961 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
969 # - Make sure the INPUT points to the root of the source tree
975 # The result: instead of the source browser generated by doxygen, the links to
976 # source code will now point to the output of htags.
978 # This tag requires that the tag SOURCE_BROWSER is set to YES.
984 # specified. Set to NO to disable this.
991 # Configuration options related to the alphabetical class index
994 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1001 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1004 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1010 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1012 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1017 # Configuration options related to the HTML output
1020 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1025 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1029 # This tag requires that the tag GENERATE_HTML is set to YES.
1033 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1036 # This tag requires that the tag GENERATE_HTML is set to YES.
1040 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1046 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1051 # for information on how to generate the default header that doxygen normally
1053 # Note: The header is subject to change so you typically have to regenerate the
1054 # default header when upgrading to a newer version of doxygen. For a description
1056 # This tag requires that the tag GENERATE_HTML is set to YES.
1060 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1062 # footer. See HTML_HEADER for more information on how to generate a default
1064 # section "Doxygen usage" for information on how to generate the default footer
1066 # This tag requires that the tag GENERATE_HTML is set to YES.
1070 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1071 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1073 # See also section "Doxygen usage" for information on how to generate the style
1075 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1078 # This tag requires that the tag GENERATE_HTML is set to YES.
1082 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1087 # Doxygen will copy the style sheet file to the output directory. For an example
1089 # This tag requires that the tag GENERATE_HTML is set to YES.
1093 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1094 # other source files which should be copied to the HTML output directory. Note
1095 # that these files will be copied to the base HTML output directory. Use the
1096 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1099 # This tag requires that the tag GENERATE_HTML is set to YES.
1104 # will adjust the colors in the stylesheet and background images according to
1110 # This tag requires that the tag GENERATE_HTML is set to YES.
1118 # This tag requires that the tag GENERATE_HTML is set to YES.
1122 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1129 # This tag requires that the tag GENERATE_HTML is set to YES.
1133 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1135 # to NO can help when comparing the output of multiple runs.
1137 # This tag requires that the tag GENERATE_HTML is set to YES.
1141 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1145 # This tag requires that the tag GENERATE_HTML is set to YES.
1151 # and collapse entries dynamically later on. Doxygen will expand the tree to
1158 # This tag requires that the tag GENERATE_HTML is set to YES.
1162 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1172 # This tag requires that the tag GENERATE_HTML is set to YES.
1180 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1186 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1188 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1196 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1202 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1206 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1220 # This tag requires that the tag GENERATE_HTML is set to YES.
1224 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1226 # written to the html output directory.
1227 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1231 # The HHC_LOCATION tag can be used to specify the location (absolute path
1233 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1234 # The file has to be specified with full path.
1235 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1242 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1246 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1248 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1255 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1259 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1260 # the table of contents of the HTML help documentation and to the tree view.
1262 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1266 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1268 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1271 # This tag requires that the tag GENERATE_HTML is set to YES.
1275 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1276 # the file name of the resulting .qch file. The path specified is relative to
1278 # This tag requires that the tag GENERATE_QHP is set to YES.
1282 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1286 # This tag requires that the tag GENERATE_QHP is set to YES.
1290 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1295 # This tag requires that the tag GENERATE_QHP is set to YES.
1300 # filter to add. For more information please see Qt Help Project / Custom
1303 # This tag requires that the tag GENERATE_QHP is set to YES.
1308 # custom filter to add. For more information please see Qt Help Project / Custom
1311 # This tag requires that the tag GENERATE_QHP is set to YES.
1318 # This tag requires that the tag GENERATE_QHP is set to YES.
1322 # The QHG_LOCATION tag can be used to specify the location of Qt's
1323 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1325 # This tag requires that the tag GENERATE_QHP is set to YES.
1329 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1333 # to be copied into the plugins directory of eclipse. The name of the directory
1335 # After copying Eclipse needs to be restarted before the help appears.
1337 # This tag requires that the tag GENERATE_HTML is set to YES.
1345 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1350 # be necessary to disable the index and replace it with your own. The
1351 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1354 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1356 # This tag requires that the tag GENERATE_HTML is set to YES.
1360 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1361 # structure should be generated to display hierarchical information. If the tag
1362 # value is set to YES, a side panel will be generated containing a tree-like
1364 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1368 # sheet generated by doxygen has an example that shows how to put an image at
1371 # DISABLE_INDEX to YES when enabling this option.
1373 # This tag requires that the tag GENERATE_HTML is set to YES.
1377 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1383 # This tag requires that the tag GENERATE_HTML is set to YES.
1388 # to set the initial width (in pixels) of the frame in which the tree is shown.
1390 # This tag requires that the tag GENERATE_HTML is set to YES.
1394 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1397 # This tag requires that the tag GENERATE_HTML is set to YES.
1401 # Use this tag to change the font size of LaTeX formulas included as images in
1403 # doxygen run you need to manually remove any form_*.png images from the HTML
1404 # output directory to force them to be regenerated.
1406 # This tag requires that the tag GENERATE_HTML is set to YES.
1410 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1414 # Note that when changing this option you need to delete any form_*.png files in
1417 # This tag requires that the tag GENERATE_HTML is set to YES.
1421 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1424 # installed or if you want to formulas look prettier in the HTML output. When
1425 # enabled you may also need to install MathJax separately and configure the path
1426 # to it using the MATHJAX_RELPATH option.
1428 # This tag requires that the tag GENERATE_HTML is set to YES.
1432 # When MathJax is enabled you can set the default output format to be used for
1438 # This tag requires that the tag USE_MATHJAX is set to YES.
1442 # When MathJax is enabled you need to specify the location relative to the HTML
1446 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1448 # MathJax. However, it is strongly recommended to install a local copy of
1451 # This tag requires that the tag USE_MATHJAX is set to YES.
1455 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1458 # This tag requires that the tag USE_MATHJAX is set to YES.
1462 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1466 # This tag requires that the tag USE_MATHJAX is set to YES.
1476 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1477 # search using the keyboard; to jump to the search box use <access key> + S
1480 # key> to jump into the search results window, the results can be navigated
1481 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1484 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1487 # This tag requires that the tag GENERATE_HTML is set to YES.
1496 # enabled the indexing and searching needs to be provided by external tools. See
1499 # This tag requires that the tag SEARCHENGINE is set to YES.
1504 # script for searching. Instead the search results are written to an XML file
1505 # which needs to be processed by an external indexer. Doxygen will invoke an
1506 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1515 # This tag requires that the tag SEARCHENGINE is set to YES.
1519 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1526 # This tag requires that the tag SEARCHENGINE is set to YES.
1531 # search data is written to a file for indexing by an external tool. With the
1534 # This tag requires that the tag SEARCHENGINE is set to YES.
1540 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1541 # projects and redirect the results back to the right project.
1542 # This tag requires that the tag SEARCHENGINE is set to YES.
1546 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1548 # all added to the same external search index. Each project needs to have a
1550 # to a relative location where the documentation can be found. The format is:
1552 # This tag requires that the tag SEARCHENGINE is set to YES.
1557 # Configuration options related to the LaTeX output
1560 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1565 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1569 # This tag requires that the tag GENERATE_LATEX is set to YES.
1573 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1578 # written to the output directory.
1580 # This tag requires that the tag GENERATE_LATEX is set to YES.
1584 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1587 # This tag requires that the tag GENERATE_LATEX is set to YES.
1591 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1592 # documents. This may be useful for small projects and may help to save some
1595 # This tag requires that the tag GENERATE_LATEX is set to YES.
1599 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1604 # This tag requires that the tag GENERATE_LATEX is set to YES.
1608 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1613 # This tag requires that the tag GENERATE_LATEX is set to YES.
1617 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1620 # section "Doxygen usage" for information on how to let doxygen write the
1621 # default header to a separate file.
1629 # This tag requires that the tag GENERATE_LATEX is set to YES.
1633 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1638 # This tag requires that the tag GENERATE_LATEX is set to YES.
1642 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1643 # other source files which should be copied to the LATEX_OUTPUT output
1646 # This tag requires that the tag GENERATE_LATEX is set to YES.
1650 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1651 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1655 # This tag requires that the tag GENERATE_LATEX is set to YES.
1659 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1660 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1663 # This tag requires that the tag GENERATE_LATEX is set to YES.
1667 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1668 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1672 # This tag requires that the tag GENERATE_LATEX is set to YES.
1676 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1679 # This tag requires that the tag GENERATE_LATEX is set to YES.
1683 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1689 # This tag requires that the tag GENERATE_LATEX is set to YES.
1693 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1697 # This tag requires that the tag GENERATE_LATEX is set to YES.
1702 # Configuration options related to the RTF output
1705 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1712 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1716 # This tag requires that the tag GENERATE_RTF is set to YES.
1720 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1721 # documents. This may be useful for small projects and may help to save some
1724 # This tag requires that the tag GENERATE_RTF is set to YES.
1728 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1736 # This tag requires that the tag GENERATE_RTF is set to YES.
1740 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1741 # file, i.e. a series of assignments. You only have to provide replacements,
1742 # missing definitions are set to their default value.
1744 # See also section "Doxygen usage" for information on how to generate the
1746 # This tag requires that the tag GENERATE_RTF is set to YES.
1751 # similar to doxygen's config file. A template extensions file can be generated
1753 # This tag requires that the tag GENERATE_RTF is set to YES.
1758 # Configuration options related to the man page output
1761 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1767 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1772 # This tag requires that the tag GENERATE_MAN is set to YES.
1776 # The MAN_EXTENSION tag determines the extension that is added to the generated
1781 # This tag requires that the tag GENERATE_MAN is set to YES.
1785 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1788 # them the man command would be unable to find the correct page.
1790 # This tag requires that the tag GENERATE_MAN is set to YES.
1795 # Configuration options related to the XML output
1798 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1804 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1808 # This tag requires that the tag GENERATE_XML is set to YES.
1812 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1813 # validating XML parser to check the syntax of the XML files.
1814 # This tag requires that the tag GENERATE_XML is set to YES.
1818 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1819 # validating XML parser to check the syntax of the XML files.
1820 # This tag requires that the tag GENERATE_XML is set to YES.
1824 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1825 # listings (including syntax highlighting and cross-referencing information) to
1829 # This tag requires that the tag GENERATE_XML is set to YES.
1834 # Configuration options related to the DOCBOOK output
1837 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1838 # that can be used to generate PDF.
1843 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1847 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1855 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1864 # Configuration options related to the Perl module output
1867 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1875 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1876 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1879 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1883 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1884 # formatted so it can be parsed by a human reader. This is useful if you want to
1885 # understand what is going on. On the other hand, if this tag is set to NO the
1889 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1897 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1902 # Configuration options related to the preprocessor
1905 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1911 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1912 # in the source code. If set to NO only conditional compilation will be
1914 # EXPAND_ONLY_PREDEF to YES.
1916 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1920 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1921 # the macro expansion is limited to the macros specified with the PREDEFINED and
1924 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1928 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1931 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1935 # The INCLUDE_PATH tag can be used to specify one or more directories that
1938 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1942 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1943 # patterns (like *.h and *.hpp) to filter out the header-files in the
1946 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1950 # The PREDEFINED tag can be used to specify one or more macro names that are
1951 # defined before the preprocessor is started (similar to the -D option of e.g.
1956 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1960 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1961 # tag can be used to specify a list of macro names that should be expanded. The
1963 # tag if you want to use a different macro definition that overrules the
1965 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1969 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1970 # remove all refrences to function-like macros that are alone on a line, have an
1975 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1980 # Configuration options related to external references
1983 # The TAGFILES tag can be used to specify one or more tag files. For each tag
1990 # section "Linking to external documentation" for more information about the use
1994 # run, you must also specify the path to the tagfile here.
1999 # tag file that is based on the input files it reads. See section "Linking to
2004 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2005 # class index. If set to NO only the inherited external classes will be listed.
2010 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2011 # the modules index. If set to NO, only the current project's groups will be
2017 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2018 # the related pages index. If set to NO, only the current project's pages will
2031 # Configuration options related to the dot tool
2034 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2035 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2037 # disabled, but it is recommended to install and use dot, since it yields more
2045 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2046 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2047 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2053 # then run dia to produce the diagram and insert it in the documentation. The
2054 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2055 # If left empty dia is assumed to be found in the default search path.
2059 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2065 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2069 # set to NO
2075 # to run in parallel. When set to 0 doxygen will base this on the number of
2076 # processors available in the system. You can set it explicitly to a value
2077 # larger than 0 to get control over the balance between CPU load and processing
2080 # This tag requires that the tag HAVE_DOT is set to YES.
2085 # generates you can specify the font name using DOT_FONTNAME. You need to make
2086 # sure dot is able to find the font, which can be done by putting it in a
2088 # setting DOT_FONTPATH to the directory containing the font.
2090 # This tag requires that the tag HAVE_DOT is set to YES.
2094 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2097 # This tag requires that the tag HAVE_DOT is set to YES.
2101 # By default doxygen will tell dot to use the default font as specified with
2104 # This tag requires that the tag HAVE_DOT is set to YES.
2108 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2110 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2112 # This tag requires that the tag HAVE_DOT is set to YES.
2116 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2121 # This tag requires that the tag HAVE_DOT is set to YES.
2125 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2128 # This tag requires that the tag HAVE_DOT is set to YES.
2132 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2133 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2136 # This tag requires that the tag HAVE_DOT is set to YES.
2142 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2143 # number of items for each type to make the size more manageable. Set this to 0
2145 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2146 # but if the number exceeds 15, the total amount of fields shown is limited to
2149 # This tag requires that the tag HAVE_DOT is set to YES.
2153 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2157 # This tag requires that the tag HAVE_DOT is set to YES.
2161 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2166 # This tag requires that the tag HAVE_DOT is set to YES.
2171 # set to YES then doxygen will generate a graph for each documented file showing
2175 # This tag requires that the tag HAVE_DOT is set to YES.
2179 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2183 # So in most cases it will be better to enable call graphs for selected
2186 # This tag requires that the tag HAVE_DOT is set to YES.
2190 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2194 # So in most cases it will be better to enable caller graphs for selected
2197 # This tag requires that the tag HAVE_DOT is set to YES.
2201 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2204 # This tag requires that the tag HAVE_DOT is set to YES.
2208 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2213 # This tag requires that the tag HAVE_DOT is set to YES.
2217 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2219 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2220 # to make the SVG files visible in IE 9+ (other browsers do not have this
2224 # This tag requires that the tag HAVE_DOT is set to YES.
2228 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2233 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2236 # This tag requires that the tag HAVE_DOT is set to YES.
2240 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2242 # This tag requires that the tag HAVE_DOT is set to YES.
2246 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2249 # This tag requires that the tag HAVE_DOT is set to YES.
2253 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2259 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2265 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2273 # This tag requires that the tag HAVE_DOT is set to YES.
2277 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2280 # further from the root node will be omitted. Note that setting this option to 1
2285 # This tag requires that the tag HAVE_DOT is set to YES.
2289 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2291 # to support this out of the box.
2293 # Warning: Depending on the platform used, enabling this option may lead to
2294 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2297 # This tag requires that the tag HAVE_DOT is set to YES.
2301 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2306 # This tag requires that the tag HAVE_DOT is set to YES.
2310 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2314 # This tag requires that the tag HAVE_DOT is set to YES.
2318 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2319 # files that are used to generate the various graphs.
2321 # This tag requires that the tag HAVE_DOT is set to YES.