Doxyfile - OpenGrok cross reference for /lvgl-latest/docs/Doxyfile

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 # the logo to the output directory.
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
58 # entered, it will be relative to the location where doxygen was started. If
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74 # characters to appear in the names of generated files. If set to NO, non-ASCII
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
83 # information to generate all constant output in the proper language.
96 # 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 new
219 # page for each member. If set to NO, the documentation of a member will be part
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 the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
307 # to that level are automatically included in the table of contents, even if
309 # Note: This feature currently applies only to Markdown headings.
311 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
315 # When enabled doxygen tries to link words that correspond to documented
316 # classes, or namespaces to their corresponding documentation. Such a link can
318 # globally by setting AUTOLINK_SUPPORT to NO.
324 # to include (a tag file for) the STL sources as input, then you should set this
325 # tag to YES in order to let doxygen match functions declarations and
333 # If you use Microsoft's C++/CLI language, you should set this option to YES to
339 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
347 # For Microsoft's IDL there are propget and propput attributes to indicate
348 # getter and setter methods for a property. Setting this option to YES will make
349 # doxygen to replace the get and set methods by a property in the documentation.
351 # type. If this is not the case, or you want to show the methods anyway, you
352 # should set this option to NO.
358 # tag is set to YES then doxygen will reuse the documentation of the first
365 # If one adds a struct or class to a group and this option is enabled, then also
366 # any nested class or struct is added to the same group. By default this option
367 # is disabled and one has to add nested compounds explicitly via \ingroup.
372 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
373 # (for instance a group of public functions) to be put as a subgroup of that
374 # type (e.g. under the Public Functions section). Set it to NO to prevent
381 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
392 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
396 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
414 # cache is used to resolve symbols given their name and scope. Since this can be
419 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
430 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
433 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
435 # normally produced when WARNINGS is set to YES.
440 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
446 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
452 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
458 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
459 # locally in source files will be included in the documentation. If set to NO,
466 # This flag is only useful for Objective-C code. If set to YES, local methods,
468 # included in the documentation. If set to NO, only methods in the interface are
474 # If this flag is set to YES, the members of anonymous namespaces will be
483 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
484 # undocumented members inside documented classes or files. If set to NO these
491 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
493 # to NO, these classes will be included in the various overviews. This option
499 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
500 # (class|struct|union) declarations. If set to NO, these declarations will be
506 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
507 # documentation blocks found inside the body of a function. If set to NO, these
508 # blocks will be appended to the function's detailed documentation block.
514 # \internal command is included. If the tag is set to NO then the documentation
515 # will be excluded. Set it to YES to include the internal documentation.
520 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
521 # names in lower-case letters. If set to YES, upper-case letters are also
524 # and Mac users are advised to set this option to NO.
529 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
530 # their full class and namespace scopes in the documentation. If set to YES, the
536 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
537 # append additional text to a page's title, such as Class Reference. If set to
543 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
549 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
550 # grouped member an include statement to the documentation, telling the reader
551 # which file to include in order to use the member.
556 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
562 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
568 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
570 # name. If set to NO, the members will appear in declaration order.
575 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
577 # name. If set to NO, the members will appear in declaration order. Note that
583 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
585 # destructors are listed first. If set to NO the constructors will appear in the
587 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
589 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
595 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
596 # of group names into alphabetical order. If set to NO the group names will
602 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
603 # fully-qualified names, including namespaces. If set to NO, the class list will
605 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
606 # Note: This option applies only to the class list, not to the alphabetical
612 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
615 # only one candidate or it is obvious which candidate to choose by doing a
622 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
628 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
634 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
640 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
647 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
654 # initial value of a variable or macro / define can have for it to appear in the
656 # it will be hidden. Use a value of 0 to hide initializers completely. The
664 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
665 # the bottom of the documentation of classes and structs. If set to YES, the
666 # list will mention the files that were used to generate the documentation.
671 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
678 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
685 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
686 # doxygen should invoke to get the current version for each file (typically from
690 # by doxygen. Whatever the program writes to standard output is used as the file
695 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
708 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
711 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
714 # search path. See also \cite for info how to create references.
719 # Configuration options related to warning and progress messages
722 # The QUIET tag can be used to turn on/off the messages that are generated to
723 # standard output by doxygen. If QUIET is set to YES this implies that the
729 # The WARNINGS tag can be used to turn on/off the warning messages that are
730 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
738 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
739 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
745 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
753 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
755 # value. If set to NO, doxygen will only warn about wrong or incomplete
761 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
777 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
778 # messages should be written. If left blank the output is written to standard
784 # Configuration options related to the input files
787 # The INPUT tag is used to specify the files and/or directories that contain
795 # This tag can be used to specify the character encoding of the source files
805 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
806 # *.h) to filter out the source-files in the directories.
809 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
824 # The RECURSIVE tag can be used to specify whether or not subdirectories should
830 # The EXCLUDE tag can be used to specify files and/or directories that should be
834 # Note that relative paths are relative to the directory from which doxygen is
839 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
847 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
850 # Note that the wildcards are matched against the file with absolute path, so to
856 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
862 # Note that the wildcards are matched against the file with absolute path, so to
867 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
874 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
875 # *.h) to filter out the source-files in the directories. If left blank all
880 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
881 # searched for input files to be used with the \include or \dontinclude commands
887 # The IMAGE_PATH tag can be used to specify one or more files or directories
888 # that contain images that are to be included in the documentation (see the
893 # The INPUT_FILTER tag can be used to specify a program that doxygen should
894 # invoke to filter for each input file. Doxygen will invoke the filter program
901 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
909 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
914 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
922 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
927 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
928 # INPUT_FILTER) will also be used to filter the input files that are used for
929 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
934 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
936 # it is also possible to disable source filtering for a specific pattern using
938 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
942 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
945 # and want to reuse the introduction page also for the doxygen output.
950 # Configuration options related to source browsing
953 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
957 # also VERBATIM_HEADERS is set to NO.
962 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
968 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
975 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
981 # If the REFERENCES_RELATION tag is set to YES then for each documented function
987 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
988 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
989 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
990 # link to the documentation.
997 # brief description and links to the definition and documentation. Since this
999 # can opt to disable this feature.
1001 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1005 # If the USE_HTAGS tag is set to YES then the references to source code will
1006 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1014 # - Make sure the INPUT points to the root of the source tree
1020 # The result: instead of the source browser generated by doxygen, the links to
1021 # source code will now point to the output of htags.
1023 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1029 # specified. Set to NO to disable this.
1035 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1050 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1055 # Configuration options related to the alphabetical class index
1058 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1065 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1068 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1074 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1076 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1081 # Configuration options related to the HTML output
1084 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1089 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1093 # This tag requires that the tag GENERATE_HTML is set to YES.
1097 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1100 # This tag requires that the tag GENERATE_HTML is set to YES.
1104 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1110 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1115 # for information on how to generate the default header that doxygen normally
1117 # Note: The header is subject to change so you typically have to regenerate the
1118 # default header when upgrading to a newer version of doxygen. For a description
1120 # This tag requires that the tag GENERATE_HTML is set to YES.
1124 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1126 # footer. See HTML_HEADER for more information on how to generate a default
1128 # section "Doxygen usage" for information on how to generate the default footer
1130 # This tag requires that the tag GENERATE_HTML is set to YES.
1134 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1135 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1137 # See also section "Doxygen usage" for information on how to generate the style
1139 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1142 # This tag requires that the tag GENERATE_HTML is set to YES.
1146 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1151 # Doxygen will copy the style sheet files to the output directory.
1155 # This tag requires that the tag GENERATE_HTML is set to YES.
1159 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1160 # other source files which should be copied to the HTML output directory. Note
1161 # that these files will be copied to the base HTML output directory. Use the
1162 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1165 # This tag requires that the tag GENERATE_HTML is set to YES.
1170 # will adjust the colors in the style sheet and background images according to
1176 # This tag requires that the tag GENERATE_HTML is set to YES.
1184 # This tag requires that the tag GENERATE_HTML is set to YES.
1188 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1195 # This tag requires that the tag GENERATE_HTML is set to YES.
1199 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1201 # to YES can help to show when doxygen was last run and thus if the
1202 # documentation is up to date.
1204 # This tag requires that the tag GENERATE_HTML is set to YES.
1208 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1212 # This tag requires that the tag GENERATE_HTML is set to YES.
1218 # and collapse entries dynamically later on. Doxygen will expand the tree to
1225 # This tag requires that the tag GENERATE_HTML is set to YES.
1229 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1239 # This tag requires that the tag GENERATE_HTML is set to YES.
1247 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1253 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1255 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1263 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1269 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1273 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1287 # This tag requires that the tag GENERATE_HTML is set to YES.
1291 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1293 # written to the html output directory.
1294 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1298 # The HHC_LOCATION tag can be used to specify the location (absolute path
1300 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1301 # The file has to be specified with full path.
1302 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1309 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1313 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1315 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1323 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1327 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1328 # the table of contents of the HTML help documentation and to the tree view.
1330 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1334 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1336 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1339 # This tag requires that the tag GENERATE_HTML is set to YES.
1343 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1344 # the file name of the resulting .qch file. The path specified is relative to
1346 # This tag requires that the tag GENERATE_QHP is set to YES.
1350 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1354 # This tag requires that the tag GENERATE_QHP is set to YES.
1358 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1363 # This tag requires that the tag GENERATE_QHP is set to YES.
1368 # filter to add. For more information please see Qt Help Project / Custom
1371 # This tag requires that the tag GENERATE_QHP is set to YES.
1376 # custom filter to add. For more information please see Qt Help Project / Custom
1379 # This tag requires that the tag GENERATE_QHP is set to YES.
1386 # This tag requires that the tag GENERATE_QHP is set to YES.
1390 # The QHG_LOCATION tag can be used to specify the location of Qt's
1391 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1393 # This tag requires that the tag GENERATE_QHP is set to YES.
1397 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1401 # to be copied into the plugins directory of eclipse. The name of the directory
1403 # After copying Eclipse needs to be restarted before the help appears.
1405 # This tag requires that the tag GENERATE_HTML is set to YES.
1413 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1418 # be necessary to disable the index and replace it with your own. The
1419 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1422 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1424 # This tag requires that the tag GENERATE_HTML is set to YES.
1428 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1429 # structure should be generated to display hierarchical information. If the tag
1430 # value is set to YES, a side panel will be generated containing a tree-like
1432 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1436 # sheet generated by doxygen has an example that shows how to put an image at
1439 # DISABLE_INDEX to YES when enabling this option.
1441 # This tag requires that the tag GENERATE_HTML is set to YES.
1445 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1451 # This tag requires that the tag GENERATE_HTML is set to YES.
1456 # to set the initial width (in pixels) of the frame in which the tree is shown.
1458 # This tag requires that the tag GENERATE_HTML is set to YES.
1462 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1465 # This tag requires that the tag GENERATE_HTML is set to YES.
1469 # Use this tag to change the font size of LaTeX formulas included as images in
1471 # doxygen run you need to manually remove any form_*.png images from the HTML
1472 # output directory to force them to be regenerated.
1474 # This tag requires that the tag GENERATE_HTML is set to YES.
1478 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1482 # Note that when changing this option you need to delete any form_*.png files in
1485 # This tag requires that the tag GENERATE_HTML is set to YES.
1489 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1492 # installed or if you want to formulas look prettier in the HTML output. When
1493 # enabled you may also need to install MathJax separately and configure the path
1494 # to it using the MATHJAX_RELPATH option.
1496 # This tag requires that the tag GENERATE_HTML is set to YES.
1500 # When MathJax is enabled you can set the default output format to be used for
1506 # This tag requires that the tag USE_MATHJAX is set to YES.
1510 # When MathJax is enabled you need to specify the location relative to the HTML
1514 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1516 # MathJax. However, it is strongly recommended to install a local copy of
1519 # This tag requires that the tag USE_MATHJAX is set to YES.
1523 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1526 # This tag requires that the tag USE_MATHJAX is set to YES.
1530 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1534 # This tag requires that the tag USE_MATHJAX is set to YES.
1544 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1545 # search using the keyboard; to jump to the search box use <access key> + S
1548 # key> to jump into the search results window, the results can be navigated
1549 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1552 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1555 # This tag requires that the tag GENERATE_HTML is set to YES.
1564 # and searching needs to be provided by external tools. See the section
1567 # This tag requires that the tag SEARCHENGINE is set to YES.
1572 # script for searching. Instead the search results are written to an XML file
1573 # which needs to be processed by an external indexer. Doxygen will invoke an
1574 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1583 # This tag requires that the tag SEARCHENGINE is set to YES.
1587 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1594 # This tag requires that the tag SEARCHENGINE is set to YES.
1599 # search data is written to a file for indexing by an external tool. With the
1602 # This tag requires that the tag SEARCHENGINE is set to YES.
1608 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1609 # projects and redirect the results back to the right project.
1610 # This tag requires that the tag SEARCHENGINE is set to YES.
1614 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1616 # all added to the same external search index. Each project needs to have a
1618 # to a relative location where the documentation can be found. The format is:
1620 # This tag requires that the tag SEARCHENGINE is set to YES.
1625 # Configuration options related to the LaTeX output
1628 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1633 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1637 # This tag requires that the tag GENERATE_LATEX is set to YES.
1641 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1646 # written to the output directory.
1648 # This tag requires that the tag GENERATE_LATEX is set to YES.
1652 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1655 # This tag requires that the tag GENERATE_LATEX is set to YES.
1659 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1660 # documents. This may be useful for small projects and may help to save some
1663 # This tag requires that the tag GENERATE_LATEX is set to YES.
1667 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1672 # This tag requires that the tag GENERATE_LATEX is set to YES.
1676 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1678 # by its name or with the correct syntax as to be used with the LaTeX
1684 # This tag requires that the tag GENERATE_LATEX is set to YES.
1688 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1691 # section "Doxygen usage" for information on how to let doxygen write the
1692 # default header to a separate file.
1699 # to HTML_HEADER.
1700 # This tag requires that the tag GENERATE_LATEX is set to YES.
1704 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1707 # LATEX_HEADER for more information on how to generate a default footer and what
1711 # This tag requires that the tag GENERATE_LATEX is set to YES.
1715 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1718 # will copy the style sheet files to the output directory.
1722 # This tag requires that the tag GENERATE_LATEX is set to YES.
1726 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1727 # other source files which should be copied to the LATEX_OUTPUT output
1730 # This tag requires that the tag GENERATE_LATEX is set to YES.
1734 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1735 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1739 # This tag requires that the tag GENERATE_LATEX is set to YES.
1743 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1744 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1747 # This tag requires that the tag GENERATE_LATEX is set to YES.
1751 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1752 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1756 # This tag requires that the tag GENERATE_LATEX is set to YES.
1760 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1763 # This tag requires that the tag GENERATE_LATEX is set to YES.
1767 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1773 # This tag requires that the tag GENERATE_LATEX is set to YES.
1777 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1781 # This tag requires that the tag GENERATE_LATEX is set to YES.
1785 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1787 # to NO can help when comparing the output of multiple runs.
1789 # This tag requires that the tag GENERATE_LATEX is set to YES.
1794 # Configuration options related to the RTF output
1797 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1804 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1808 # This tag requires that the tag GENERATE_RTF is set to YES.
1812 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1813 # documents. This may be useful for small projects and may help to save some
1816 # This tag requires that the tag GENERATE_RTF is set to YES.
1820 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1828 # This tag requires that the tag GENERATE_RTF is set to YES.
1832 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1833 # file, i.e. a series of assignments. You only have to provide replacements,
1834 # missing definitions are set to their default value.
1836 # See also section "Doxygen usage" for information on how to generate the
1838 # This tag requires that the tag GENERATE_RTF is set to YES.
1843 # similar to doxygen's config file. A template extensions file can be generated
1845 # This tag requires that the tag GENERATE_RTF is set to YES.
1849 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1855 # This tag requires that the tag GENERATE_RTF is set to YES.
1860 # Configuration options related to the man page output
1863 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1869 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1874 # This tag requires that the tag GENERATE_MAN is set to YES.
1878 # The MAN_EXTENSION tag determines the extension that is added to the generated
1883 # This tag requires that the tag GENERATE_MAN is set to YES.
1888 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1890 # This tag requires that the tag GENERATE_MAN is set to YES.
1894 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1897 # them the man command would be unable to find the correct page.
1899 # This tag requires that the tag GENERATE_MAN is set to YES.
1904 # Configuration options related to the XML output
1907 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1913 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1917 # This tag requires that the tag GENERATE_XML is set to YES.
1921 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1922 # listings (including syntax highlighting and cross-referencing information) to
1926 # This tag requires that the tag GENERATE_XML is set to YES.
1931 # Configuration options related to the DOCBOOK output
1934 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1935 # that can be used to generate PDF.
1940 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1944 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1948 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1950 # information) to the DOCBOOK output. Note that enabling this will significantly
1953 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1961 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1970 # Configuration options related to the Perl module output
1973 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1981 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1982 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1985 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1989 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1990 # formatted so it can be parsed by a human reader. This is useful if you want to
1991 # understand what is going on. On the other hand, if this tag is set to NO, the
1995 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2003 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2008 # Configuration options related to the preprocessor
2011 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2017 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2018 # in the source code. If set to NO, only conditional compilation will be
2020 # EXPAND_ONLY_PREDEF to YES.
2022 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2026 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2027 # the macro expansion is limited to the macros specified with the PREDEFINED and
2030 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2034 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2037 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2041 # The INCLUDE_PATH tag can be used to specify one or more directories that
2044 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2048 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2049 # patterns (like *.h and *.hpp) to filter out the header-files in the
2052 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2056 # The PREDEFINED tag can be used to specify one or more macro names that are
2057 # defined before the preprocessor is started (similar to the -D option of e.g.
2062 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2066 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2067 # tag can be used to specify a list of macro names that should be expanded. The
2069 # tag if you want to use a different macro definition that overrules the
2071 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2075 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2076 # remove all references to function-like macros that are alone on a line, have
2081 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2086 # Configuration options related to external references
2089 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2096 # section "Linking to external documentation" for more information about the use
2100 # run, you must also specify the path to the tagfile here.
2105 # tag file that is based on the input files it reads. See section "Linking to
2110 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2111 # the class index. If set to NO, only the inherited external classes will be
2117 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2118 # in the modules index. If set to NO, only the current project's groups will be
2124 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2125 # the related pages index. If set to NO, only the current project's pages will
2138 # Configuration options related to the dot tool
2141 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2142 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2144 # disabled, but it is recommended to install and use dot, since it yields more
2152 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2153 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2154 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2160 # then run dia to produce the diagram and insert it in the documentation. The
2161 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2162 # If left empty dia is assumed to be found in the default search path.
2166 # If set to YES the inheritance and collaboration graphs will hide inheritance
2172 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2176 # set to NO
2182 # to run in parallel. When set to 0 doxygen will base this on the number of
2183 # processors available in the system. You can set it explicitly to a value
2184 # larger than 0 to get control over the balance between CPU load and processing
2187 # This tag requires that the tag HAVE_DOT is set to YES.
2192 # generates you can specify the font name using DOT_FONTNAME. You need to make
2193 # sure dot is able to find the font, which can be done by putting it in a
2195 # setting DOT_FONTPATH to the directory containing the font.
2197 # This tag requires that the tag HAVE_DOT is set to YES.
2201 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2204 # This tag requires that the tag HAVE_DOT is set to YES.
2208 # By default doxygen will tell dot to use the default font as specified with
2211 # This tag requires that the tag HAVE_DOT is set to YES.
2215 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2217 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2219 # This tag requires that the tag HAVE_DOT is set to YES.
2223 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2228 # This tag requires that the tag HAVE_DOT is set to YES.
2232 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2235 # This tag requires that the tag HAVE_DOT is set to YES.
2239 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2240 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2243 # This tag requires that the tag HAVE_DOT is set to YES.
2249 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2250 # number of items for each type to make the size more manageable. Set this to 0
2252 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2253 # but if the number exceeds 15, the total amount of fields shown is limited to
2256 # This tag requires that the tag HAVE_DOT is set to YES.
2260 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2264 # This tag requires that the tag HAVE_DOT is set to YES.
2268 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2273 # This tag requires that the tag HAVE_DOT is set to YES.
2278 # set to YES then doxygen will generate a graph for each documented file showing
2282 # This tag requires that the tag HAVE_DOT is set to YES.
2286 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2290 # So in most cases it will be better to enable call graphs for selected
2294 # This tag requires that the tag HAVE_DOT is set to YES.
2298 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2302 # So in most cases it will be better to enable caller graphs for selected
2306 # This tag requires that the tag HAVE_DOT is set to YES.
2310 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2313 # This tag requires that the tag HAVE_DOT is set to YES.
2317 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2322 # This tag requires that the tag HAVE_DOT is set to YES.
2326 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2330 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2331 # to make the SVG files visible in IE 9+ (other browsers do not have this
2339 # This tag requires that the tag HAVE_DOT is set to YES.
2343 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2348 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2351 # This tag requires that the tag HAVE_DOT is set to YES.
2355 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2357 # This tag requires that the tag HAVE_DOT is set to YES.
2361 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2364 # This tag requires that the tag HAVE_DOT is set to YES.
2368 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2374 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2380 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2388 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2398 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2406 # This tag requires that the tag HAVE_DOT is set to YES.
2410 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2413 # further from the root node will be omitted. Note that setting this option to 1
2418 # This tag requires that the tag HAVE_DOT is set to YES.
2422 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2424 # to support this out of the box.
2426 # Warning: Depending on the platform used, enabling this option may lead to
2427 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2430 # This tag requires that the tag HAVE_DOT is set to YES.
2434 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2439 # This tag requires that the tag HAVE_DOT is set to YES.
2443 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2447 # This tag requires that the tag HAVE_DOT is set to YES.
2451 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2452 # files that are used to generate the various graphs.
2454 # This tag requires that the tag HAVE_DOT is set to YES.