doxygen.cfg.in - OpenGrok cross reference for /external/libusb/doc/doxygen.cfg.in

Lines Matching +full:set +full:- +full:value
11 # TAG = value [value, ...]
13 # TAG += value [value, ...]
16 #---------------------------------------------------------------------------
18 #---------------------------------------------------------------------------
21 # file that follow. The default is UTF-8 which is also the encoding used for all
25 # The default value is: UTF-8.
27 DOXYFILE_ENCODING      = UTF-8
30 # double-quotes, unless you are using Doxywizard) that should identify the
33 # The default value is: My Project.
47 PROJECT_BRIEF          = "A cross-platform user library to access USB devices"
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
69 # The default value is: NO.
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
77 # The default value is: NO.
85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
92 # The default value is: English.
100 # The default value is: None.
104 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
106 # documentation (similar to Javadoc). Set to NO to disable this.
107 # The default value is: YES.
111 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
114 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
116 # The default value is: YES.
120 # This tag implements a quasi-intelligent brief description abbreviator that is
124 # text. Otherwise, the brief description is used as-is. If left blank, the
131 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
134 # The default value is: NO.
138 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
142 # The default value is: NO.
146 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
147 # before files name in the file list and in the header files. If set to NO the
149 # The default value is: YES.
153 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
154 # Stripping is only done if one of the specified strings matches the left-hand
161 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
165 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
170 # using the -I flag.
174 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
176 # support long names like on DOS, Mac, or CD-ROM.
177 # The default value is: NO.
181 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
182 # first line (until the first dot) of a Javadoc-style comment as the brief
183 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
186 # The default value is: NO.
190 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
193 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
194 # Javadoc-style will behave just like regular comments and it will not be
196 # The default value is: NO.
200 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
201 # line (until the first dot) of a Qt-style comment as the brief description. If
202 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
204 # The default value is: NO.
208 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
209 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
211 # to treat a multi-line C++ comment block as a detailed description. Set this
216 # The default value is: NO.
224 # The default value is: YES.
228 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
229 # documentation from any documented member that it re-implements.
230 # The default value is: YES.
234 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
235 # page for each member. If set to NO, the documentation of a member will be part
237 # The default value is: NO.
241 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
242 # uses this value to replace tabs by spaces in code fragments.
243 # Minimum value: 1, maximum value: 16, default value: 4.
249 # name=value
253 # documentation, which will result in a user-defined paragraph with heading
254 # "Side Effects:". You can put \n's in the value part of an alias to insert
255 # newlines (in the resulting output). You can put ^^ in the value part of an
257 # When you need a literal { or } or , in the value part of an alias you have to
264 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
268 # The default value is: NO.
272 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
276 # The default value is: NO.
280 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
282 # The default value is: NO.
286 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
288 # The default value is: NO.
292 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
296 # The default value is: NO.
302 # extension. Doxygen has a built-in mapping, but you can override or extend it
305 # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
315 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
323 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
329 # The default value is: YES.
333 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
337 # Minimum value: 0, maximum value: 99, default value: 5.
338 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
346 # The default value is: YES.
351 # to include (a tag file for) the STL sources as input, then you should set this
356 # The default value is: NO.
360 # If you use Microsoft's C++/CLI language, you should set this option to YES to
362 # The default value is: NO.
366 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
370 # The default value is: NO.
376 # doxygen to replace the get and set methods by a property in the documentation.
379 # should set this option to NO.
380 # The default value is: YES.
385 # tag is set to YES then doxygen will reuse the documentation of the first
388 # The default value is: NO.
395 # The default value is: NO.
399 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
401 # type (e.g. under the Public Functions section). Set it to NO to prevent
404 # The default value is: YES.
408 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
415 # The default value is: NO.
419 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
422 # namespace, or group documentation), provided this scope is documented. If set
425 # The default value is: NO.
436 # The default value is: NO.
440 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
443 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
449 # Minimum value: 0, maximum value: 9, default value: 0.
454 # during processing. When set to 0 doxygen will based this on the number of
455 # cores available in the system. You can set it explicitly to a value larger
458 # threads. Since this is still an experimental feature the default is set to 1,
462 # Minimum value: 0, maximum value: 32, default value: 1.
466 #---------------------------------------------------------------------------
468 #---------------------------------------------------------------------------
470 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
473 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
475 # normally produced when WARNINGS is set to YES.
476 # The default value is: NO.
480 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
482 # The default value is: NO.
486 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
488 # The default value is: NO.
492 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
494 # The default value is: NO.
498 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
500 # The default value is: NO.
504 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
505 # locally in source files will be included in the documentation. If set to NO,
508 # The default value is: YES.
512 # This flag is only useful for Objective-C code. If set to YES, local methods,
514 # included in the documentation. If set to NO, only methods in the interface are
516 # The default value is: NO.
520 # If this flag is set to YES, the members of anonymous namespaces will be
525 # The default value is: NO.
529 # If this flag is set to YES, the name of an unnamed parameter in a declaration
532 # The default value is: YES.
536 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
537 # undocumented members inside documented classes or files. If set to NO these
540 # The default value is: NO.
544 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
545 # undocumented classes that are normally visible in the class hierarchy. If set
548 # The default value is: NO.
552 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
553 # declarations. If set to NO, these declarations will be included in the
555 # The default value is: NO.
559 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
560 # documentation blocks found inside the body of a function. If set to NO, these
562 # The default value is: NO.
567 # \internal command is included. If the tag is set to NO then the documentation
568 # will be excluded. Set it to YES to include the internal documentation.
569 # The default value is: NO.
576 # whose names only differ in casing), the option must be set to YES to properly
578 # are not case sensitive the option should be be set to NO to properly deal with
582 # Windows (including Cygwin) and MacOS, users should typically set this option
583 # to NO, whereas on Linux or other Unix flavors it should typically be set to
585 # The default value is: system dependent.
589 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
590 # their full class and namespace scopes in the documentation. If set to YES, the
592 # The default value is: NO.
596 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
597 # append additional text to a page's title, such as Class Reference. If set to
599 # The default value is: NO.
603 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
605 # The default value is: YES.
609 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
612 # The default value is: NO.
616 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
618 # The default value is: NO.
622 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
624 # The default value is: YES.
628 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
630 # name. If set to NO, the members will appear in declaration order.
631 # The default value is: YES.
635 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
637 # name. If set to NO, the members will appear in declaration order. Note that
639 # The default value is: NO.
643 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
645 # destructors are listed first. If set to NO the constructors will appear in the
647 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
649 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
651 # The default value is: NO.
655 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
656 # of group names into alphabetical order. If set to NO the group names will
658 # The default value is: NO.
662 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
663 # fully-qualified names, including namespaces. If set to NO, the class list will
665 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
668 # The default value is: NO.
678 # The default value is: NO.
684 # The default value is: YES.
690 # The default value is: YES.
696 # The default value is: YES.
703 # The default value is: YES.
714 # initial value of a variable or macro / define can have for it to appear in the
716 # it will be hidden. Use a value of 0 to hide initializers completely. The
717 # appearance of the value of individual variables and macros / defines can be
720 # Minimum value: 0, maximum value: 10000, default value: 30.
724 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
725 # the bottom of the documentation of classes and structs. If set to YES, the
727 # The default value is: YES.
731 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
734 # The default value is: YES.
738 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
741 # The default value is: YES.
748 # popen()) the command command input-file, where command is the value of the
749 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
758 # that represents doxygen's defaults, run doxygen with the -l option. You can
778 #---------------------------------------------------------------------------
780 #---------------------------------------------------------------------------
783 # standard output by doxygen. If QUIET is set to YES this implies that the
785 # The default value is: NO.
790 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
794 # The default value is: YES.
798 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
799 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
801 # The default value is: YES.
805 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
809 # The default value is: YES.
815 # value. If set to NO, doxygen will only warn about wrong or incomplete
817 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
818 # The default value is: NO.
822 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
823 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
824 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
825 # at the end of the doxygen process doxygen will return with a non-zero status.
827 # The default value is: NO.
837 # The default value is: $file:$line: $text.
847 #---------------------------------------------------------------------------
849 #---------------------------------------------------------------------------
860 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
864 # The default value is: UTF-8.
866 INPUT_ENCODING         = UTF-8
868 # If the value of the INPUT tag contains directories, you can use the
870 # *.h) to filter out the source-files in the directories.
873 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
891 # The default value is: NO.
910 # The default value is: NO.
914 # If the value of the INPUT tag contains directories, you can use the
940 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
942 # *.h) to filter out the source-files in the directories. If left blank all
947 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
949 # irrespective of the value of the RECURSIVE tag.
950 # The default value is: NO.
964 # <filter> <input-file>
966 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
976 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
989 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
994 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
996 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
997 # The default value is: NO.
1005 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1016 #---------------------------------------------------------------------------
1018 #---------------------------------------------------------------------------
1020 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1021 # generated. Documented entities will be cross-referenced with these sources.
1024 # also VERBATIM_HEADERS is set to NO.
1025 # The default value is: NO.
1031 # The default value is: NO.
1038 # The default value is: YES.
1042 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1044 # The default value is: NO.
1048 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1050 # The default value is: NO.
1054 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1058 # The default value is: YES.
1067 # The default value is: YES.
1068 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1072 # If the USE_HTAGS tag is set to YES then the references to source code will
1073 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1079 # - Install the latest version of global
1080 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1081 # - Make sure the INPUT points to the root of the source tree
1082 # - Run doxygen as normal
1089 # The default value is: NO.
1090 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1094 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1096 # specified. Set to NO to disable this.
1098 # The default value is: YES.
1102 #---------------------------------------------------------------------------
1104 #---------------------------------------------------------------------------
1106 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1109 # The default value is: YES.
1117 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1121 #---------------------------------------------------------------------------
1123 #---------------------------------------------------------------------------
1125 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1126 # The default value is: YES.
1131 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1134 # This tag requires that the tag GENERATE_HTML is set to YES.
1140 # The default value is: .html.
1141 # This tag requires that the tag GENERATE_HTML is set to YES.
1145 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1153 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1161 # This tag requires that the tag GENERATE_HTML is set to YES.
1165 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1171 # This tag requires that the tag GENERATE_HTML is set to YES.
1175 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1176 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1183 # This tag requires that the tag GENERATE_HTML is set to YES.
1187 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1196 # This tag requires that the tag GENERATE_HTML is set to YES.
1205 # files will be copied as-is; there are no commands or markers available.
1206 # This tag requires that the tag GENERATE_HTML is set to YES.
1213 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1216 # Minimum value: 0, maximum value: 359, default value: 220.
1217 # This tag requires that the tag GENERATE_HTML is set to YES.
1222 # in the HTML output. For a value of 0 the output will use grayscales only. A
1223 # value of 255 will produce the most vivid colors.
1224 # Minimum value: 0, maximum value: 255, default value: 100.
1225 # This tag requires that the tag GENERATE_HTML is set to YES.
1232 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1233 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1235 # Minimum value: 40, maximum value: 240, default value: 80.
1236 # This tag requires that the tag GENERATE_HTML is set to YES.
1240 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1244 # The default value is: NO.
1245 # This tag requires that the tag GENERATE_HTML is set to YES.
1249 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1255 # The default value is: YES.
1256 # This tag requires that the tag GENERATE_HTML is set to YES.
1260 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1263 # The default value is: NO.
1264 # This tag requires that the tag GENERATE_HTML is set to YES.
1273 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1276 # Minimum value: 0, maximum value: 9999, default value: 100.
1277 # This tag requires that the tag GENERATE_HTML is set to YES.
1281 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1285 # create a documentation set, doxygen will generate a Makefile in the HTML
1291 # The default value is: NO.
1292 # This tag requires that the tag GENERATE_HTML is set to YES.
1299 # The default value is: Doxygen generated docs.
1300 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1305 # set bundle. This should be a reverse domain-name style string, e.g.
1307 # The default value is: org.doxygen.Project.
1308 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1313 # the documentation publisher. This should be a reverse domain-name style
1315 # The default value is: org.doxygen.Publisher.
1316 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1321 # The default value is: Publisher.
1322 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1326 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1330 # https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
1339 # The default value is: NO.
1340 # This tag requires that the tag GENERATE_HTML is set to YES.
1347 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1352 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1355 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1361 # The default value is: NO.
1362 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1368 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1375 # The default value is: NO.
1376 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1380 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1382 # The default value is: NO.
1383 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1387 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1388 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1391 # The default value is: NO.
1392 # This tag requires that the tag GENERATE_HTML is set to YES.
1399 # This tag requires that the tag GENERATE_QHP is set to YES.
1406 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1407 # The default value is: org.doxygen.Project.
1408 # This tag requires that the tag GENERATE_QHP is set to YES.
1415 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1416 # The default value is: doc.
1417 # This tag requires that the tag GENERATE_QHP is set to YES.
1421 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1424 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1425 # This tag requires that the tag GENERATE_QHP is set to YES.
1432 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1433 # This tag requires that the tag GENERATE_QHP is set to YES.
1439 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1440 # This tag requires that the tag GENERATE_QHP is set to YES.
1445 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1447 # This tag requires that the tag GENERATE_QHP is set to YES.
1451 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1456 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1458 # The default value is: NO.
1459 # This tag requires that the tag GENERATE_HTML is set to YES.
1465 # name. Each documentation set should have its own identifier.
1466 # The default value is: org.doxygen.Project.
1467 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1474 # of each HTML page. A value of NO enables the index and the value YES disables
1476 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1477 # The default value is: NO.
1478 # This tag requires that the tag GENERATE_HTML is set to YES.
1482 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1484 # value is set to YES, a side panel will be generated containing a tree-like
1489 # further fine-tune the look of the index. As an example, the default style
1494 # The default value is: NO.
1495 # This tag requires that the tag GENERATE_HTML is set to YES.
1499 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1502 # Note that a value of 0 will completely suppress the enum values from appearing
1504 # Minimum value: 0, maximum value: 20, default value: 4.
1505 # This tag requires that the tag GENERATE_HTML is set to YES.
1510 # to set the initial width (in pixels) of the frame in which the tree is shown.
1511 # Minimum value: 0, maximum value: 1500, default value: 250.
1512 # This tag requires that the tag GENERATE_HTML is set to YES.
1516 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1518 # The default value is: NO.
1519 # This tag requires that the tag GENERATE_HTML is set to YES.
1523 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1529 # The default value is: png.
1530 # This tag requires that the tag GENERATE_HTML is set to YES.
1538 # Minimum value: 8, maximum value: 50, default value: 10.
1539 # This tag requires that the tag GENERATE_HTML is set to YES.
1549 # The default value is: YES.
1550 # This tag requires that the tag GENERATE_HTML is set to YES.
1562 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1566 # The default value is: NO.
1567 # This tag requires that the tag GENERATE_HTML is set to YES.
1571 # When MathJax is enabled you can set the default output format to be used for
1573 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
1574 # Possible values are: HTML-CSS (which is slower, but has the best
1576 # The default value is: HTML-CSS.
1577 # This tag requires that the tag USE_MATHJAX is set to YES.
1579 MATHJAX_FORMAT         = HTML-CSS
1585 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1589 # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
1590 # This tag requires that the tag USE_MATHJAX is set to YES.
1597 # This tag requires that the tag USE_MATHJAX is set to YES.
1604 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1606 # This tag requires that the tag USE_MATHJAX is set to YES.
1626 # The default value is: YES.
1627 # This tag requires that the tag GENERATE_HTML is set to YES.
1638 # The default value is: NO.
1639 # This tag requires that the tag SEARCHENGINE is set to YES.
1655 # The default value is: NO.
1656 # This tag requires that the tag SEARCHENGINE is set to YES.
1668 # This tag requires that the tag SEARCHENGINE is set to YES.
1676 # This tag requires that the tag SEARCHENGINE is set to YES.
1684 # This tag requires that the tag SEARCHENGINE is set to YES.
1691 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1694 # This tag requires that the tag SEARCHENGINE is set to YES.
1698 #---------------------------------------------------------------------------
1700 #---------------------------------------------------------------------------
1702 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1703 # The default value is: YES.
1708 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1711 # This tag requires that the tag GENERATE_LATEX is set to YES.
1721 # default can have been set differently, this depends on the implementation of
1723 # This tag requires that the tag GENERATE_LATEX is set to YES.
1733 # This tag requires that the tag GENERATE_LATEX is set to YES.
1742 # The default value is: makeindex.
1743 # This tag requires that the tag GENERATE_LATEX is set to YES.
1747 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1750 # The default value is: NO.
1751 # This tag requires that the tag GENERATE_LATEX is set to YES.
1755 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1759 # The default value is: a4.
1760 # This tag requires that the tag GENERATE_LATEX is set to YES.
1772 # This tag requires that the tag GENERATE_LATEX is set to YES.
1782 # Note: Only use a user-defined header if you know what you are doing! The
1788 # This tag requires that the tag GENERATE_LATEX is set to YES.
1798 # Note: Only use a user-defined footer if you know what you are doing!
1799 # This tag requires that the tag GENERATE_LATEX is set to YES.
1803 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1810 # This tag requires that the tag GENERATE_LATEX is set to YES.
1816 # directory. Note that the files will be copied as-is; there are no commands or
1818 # This tag requires that the tag GENERATE_LATEX is set to YES.
1822 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1826 # The default value is: YES.
1827 # This tag requires that the tag GENERATE_LATEX is set to YES.
1831 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1833 # files. Set this option to YES, to get a higher quality PDF documentation.
1836 # The default value is: YES.
1837 # This tag requires that the tag GENERATE_LATEX is set to YES.
1841 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1845 # The default value is: NO.
1846 # This tag requires that the tag GENERATE_LATEX is set to YES.
1850 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1852 # The default value is: NO.
1853 # This tag requires that the tag GENERATE_LATEX is set to YES.
1857 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1862 # The default value is: NO.
1863 # This tag requires that the tag GENERATE_LATEX is set to YES.
1870 # The default value is: plain.
1871 # This tag requires that the tag GENERATE_LATEX is set to YES.
1875 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1878 # The default value is: NO.
1879 # This tag requires that the tag GENERATE_LATEX is set to YES.
1887 # This tag requires that the tag GENERATE_LATEX is set to YES.
1891 #---------------------------------------------------------------------------
1893 #---------------------------------------------------------------------------
1895 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1898 # The default value is: NO.
1903 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1906 # This tag requires that the tag GENERATE_RTF is set to YES.
1910 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1913 # The default value is: NO.
1914 # This tag requires that the tag GENERATE_RTF is set to YES.
1918 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1925 # The default value is: NO.
1926 # This tag requires that the tag GENERATE_RTF is set to YES.
1932 # replacements, missing definitions are set to their default value.
1936 # This tag requires that the tag GENERATE_RTF is set to YES.
1940 # Set optional variables used in the generation of an RTF document. Syntax is
1942 # generated using doxygen -e rtf extensionFile.
1943 # This tag requires that the tag GENERATE_RTF is set to YES.
1947 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1952 # The default value is: NO.
1953 # This tag requires that the tag GENERATE_RTF is set to YES.
1957 #---------------------------------------------------------------------------
1959 #---------------------------------------------------------------------------
1961 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1963 # The default value is: NO.
1968 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1972 # This tag requires that the tag GENERATE_MAN is set to YES.
1980 # The default value is: .3.
1981 # This tag requires that the tag GENERATE_MAN is set to YES.
1988 # This tag requires that the tag GENERATE_MAN is set to YES.
1992 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1996 # The default value is: NO.
1997 # This tag requires that the tag GENERATE_MAN is set to YES.
2001 #---------------------------------------------------------------------------
2003 #---------------------------------------------------------------------------
2005 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2007 # The default value is: NO.
2012 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2015 # This tag requires that the tag GENERATE_XML is set to YES.
2019 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2020 # listings (including syntax highlighting and cross-referencing information) to
2023 # The default value is: YES.
2024 # This tag requires that the tag GENERATE_XML is set to YES.
2028 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2030 # The default value is: NO.
2031 # This tag requires that the tag GENERATE_XML is set to YES.
2035 #---------------------------------------------------------------------------
2037 #---------------------------------------------------------------------------
2039 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2041 # The default value is: NO.
2046 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2049 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2053 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2054 # program listings (including syntax highlighting and cross-referencing
2057 # The default value is: NO.
2058 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2062 #---------------------------------------------------------------------------
2064 #---------------------------------------------------------------------------
2066 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2070 # The default value is: NO.
2074 #---------------------------------------------------------------------------
2076 #---------------------------------------------------------------------------
2078 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2082 # The default value is: NO.
2086 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2089 # The default value is: NO.
2090 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2094 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2096 # understand what is going on. On the other hand, if this tag is set to NO, the
2099 # The default value is: YES.
2100 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2108 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2112 #---------------------------------------------------------------------------
2114 #---------------------------------------------------------------------------
2116 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2117 # C-preprocessor directives found in the sources and include files.
2118 # The default value is: YES.
2122 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2123 # in the source code. If set to NO, only conditional compilation will be
2126 # The default value is: NO.
2127 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2131 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2134 # The default value is: NO.
2135 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2139 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2141 # The default value is: YES.
2142 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2149 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2154 # patterns (like *.h and *.hpp) to filter out the header-files in the
2157 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2162 # defined before the preprocessor is started (similar to the -D option of e.g.
2167 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2174 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2179 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2183 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2184 # remove all references to function-like macros that are alone on a line, have
2186 # are typically used for boiler-plate code, and will confuse the parser if not
2188 # The default value is: YES.
2189 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2193 #---------------------------------------------------------------------------
2195 #---------------------------------------------------------------------------
2218 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2219 # the class index. If set to NO, only the inherited external classes will be
2221 # The default value is: NO.
2225 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2226 # in the modules index. If set to NO, only the current project's groups will be
2228 # The default value is: YES.
2232 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2233 # the related pages index. If set to NO, only the current project's pages will
2235 # The default value is: YES.
2239 #---------------------------------------------------------------------------
2241 #---------------------------------------------------------------------------
2243 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2248 # The default value is: YES.
2259 # If set to YES the inheritance and collaboration graphs will hide inheritance
2261 # The default value is: YES.
2265 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2269 # set to NO
2270 # The default value is: NO.
2275 # to run in parallel. When set to 0 doxygen will base this on the number of
2276 # processors available in the system. You can set it explicitly to a value
2279 # Minimum value: 0, maximum value: 32, default value: 0.
2280 # This tag requires that the tag HAVE_DOT is set to YES.
2289 # The default value is: Helvetica.
2290 # This tag requires that the tag HAVE_DOT is set to YES.
2294 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2296 # Minimum value: 4, maximum value: 24, default value: 10.
2297 # This tag requires that the tag HAVE_DOT is set to YES.
2302 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2304 # This tag requires that the tag HAVE_DOT is set to YES.
2308 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2311 # The default value is: YES.
2312 # This tag requires that the tag HAVE_DOT is set to YES.
2316 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2320 # The default value is: YES.
2321 # This tag requires that the tag HAVE_DOT is set to YES.
2325 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2327 # The default value is: YES.
2328 # This tag requires that the tag HAVE_DOT is set to YES.
2332 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2335 # The default value is: NO.
2336 # This tag requires that the tag HAVE_DOT is set to YES.
2343 # number of items for each type to make the size more manageable. Set this to 0
2345 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2348 # Minimum value: 0, maximum value: 100, default value: 10.
2349 # This tag requires that the tag UML_LOOK is set to YES.
2353 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2355 # tag is set to YES, doxygen will add type and arguments for attributes and
2356 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2361 # The default value is: NO.
2362 # This tag requires that the tag UML_LOOK is set to YES.
2366 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2370 # Minimum value: 0, maximum value: 1000, default value: 17.
2371 # This tag requires that the tag HAVE_DOT is set to YES.
2375 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2378 # The default value is: NO.
2379 # This tag requires that the tag HAVE_DOT is set to YES.
2383 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2387 # The default value is: YES.
2388 # This tag requires that the tag HAVE_DOT is set to YES.
2393 # set to YES then doxygen will generate a graph for each documented file showing
2396 # The default value is: YES.
2397 # This tag requires that the tag HAVE_DOT is set to YES.
2401 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2408 # The default value is: NO.
2409 # This tag requires that the tag HAVE_DOT is set to YES.
2413 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2420 # The default value is: NO.
2421 # This tag requires that the tag HAVE_DOT is set to YES.
2425 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2427 # The default value is: YES.
2428 # This tag requires that the tag HAVE_DOT is set to YES.
2432 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2436 # The default value is: YES.
2437 # This tag requires that the tag HAVE_DOT is set to YES.
2441 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2445 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2451 # The default value is: png.
2452 # This tag requires that the tag HAVE_DOT is set to YES.
2456 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2461 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2463 # The default value is: NO.
2464 # This tag requires that the tag HAVE_DOT is set to YES.
2470 # This tag requires that the tag HAVE_DOT is set to YES.
2477 # This tag requires that the tag HAVE_DOT is set to YES.
2511 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2513 # larger than this value, doxygen will truncate the graph, which is visualized
2518 # Minimum value: 0, maximum value: 10000, default value: 50.
2519 # This tag requires that the tag HAVE_DOT is set to YES.
2523 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2524 # generated by dot. A depth value of 3 means that only nodes reachable from the
2530 # Minimum value: 0, maximum value: 1000, default value: 0.
2531 # This tag requires that the tag HAVE_DOT is set to YES.
2535 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2540 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2542 # The default value is: NO.
2543 # This tag requires that the tag HAVE_DOT is set to YES.
2547 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2548 # files in one run (i.e. multiple -o and -T options on the command line). This
2551 # The default value is: NO.
2552 # This tag requires that the tag HAVE_DOT is set to YES.
2556 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2559 # The default value is: YES.
2560 # This tag requires that the tag HAVE_DOT is set to YES.
2564 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2569 # The default value is: YES.