Lines Matching full:the
3 # This file describes the settings to be used by the documentation system
7 # front of the TAG it is preceding.
10 # The format is:
18 # Use Doxygen to compare the used configuration file with the template
21 # Use Doxygen to compare the used configuration file with the template
22 # configuration file without replacing the environment variables or CMake type
30 # This tag specifies the encoding used for all characters in the configuration
31 # file that follow. The default is UTF-8 which is also the encoding used for all
32 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
33 # iconv built into libc) for the transcoding. See
34 # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
35 # The default value is: UTF-8.
39 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
40 # double-quotes, unless you are using Doxywizard) that should identify the
41 # project for which the documentation is generated. This name is used in the
43 # The default value is: My Project.
47 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
48 # could be handy for archiving the generated documentation or if some version
53 # Using the PROJECT_BRIEF tag one can provide an optional one line description
54 # for a project that appears at the top of each page and should give viewer a
55 # quick idea about the purpose of the project. Keep the description short.
59 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
60 # in the documentation. The maximum height of the logo should not exceed 55
61 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
62 # the logo to the output directory.
66 # With the PROJECT_ICON tag one can specify an icon that is included in the tabs
67 # when the HTML document is shown. Doxygen will copy the logo to the output
72 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
73 # into which the generated documentation will be written. If a relative path is
74 # entered, it will be relative to the location where Doxygen was started. If
75 # left blank the current directory will be used.
79 # If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096
80 # sub-directories (in 2 levels) under the output directory of each output format
81 # and will distribute the generated files over these directories. Enabling this
83 # putting all generated files in the same directory would otherwise causes
84 # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
85 # control the number of sub-directories.
86 # The default value is: NO.
90 # Controls the number of sub-directories that will be created when
92 # level increment doubles the number of directories, resulting in 4096
93 # directories at level 8 which is the default and also the maximum value. The
94 # sub-directories are organized in 2 levels, the first level always has a fixed
97 # This tag requires that the tag CREATE_SUBDIRS is set to YES.
101 # If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII
102 # characters to appear in the names of generated files. If set to NO, non-ASCII
105 # The default value is: NO.
109 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
111 # information to generate all constant output in the proper language.
120 # The default value is: English.
124 # If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member
125 # descriptions after the members that are listed in the file and class
127 # The default value is: YES.
131 # If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief
132 # description of a member or function before the detailed description
134 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
136 # The default value is: YES.
141 # used to form the text in various listings. Each string in this list, if found
142 # as the leading text of the brief description, will be stripped from the text
143 # and the result, after processing the whole list, is used as the annotated
144 # text. Otherwise, the brief description is used as-is. If left blank, the
145 # following values are used ($name is automatically replaced with the name of
146 # the entity):The $name class, The $name widget, The $name file, is, provides,
147 # specifies, contains, represents, a, an and the.
151 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
154 # The default value is: NO.
158 # If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all
159 # inherited members of a class in the documentation of that class as if those
161 # operators of the base classes will not be shown.
162 # The default value is: NO.
166 # If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path
167 # before files name in the file list and in the header files. If set to NO the
168 # shortest path that makes the file name unique will be used
169 # The default value is: YES.
173 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
174 # Stripping is only done if one of the specified strings matches the left-hand
175 # part of the path. The tag can be used to show relative paths in the file list.
176 # If left blank the directory from which Doxygen is run is used as the path to
180 # will be relative from the directory where Doxygen is started.
181 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
185 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
186 # path mentioned in the documentation of a class, which tells the reader which
187 # header file to include in order to use a class. If left blank only the name of
188 # the header file containing the class definition is used. Otherwise one should
189 # specify the list of include paths that are normally passed to the compiler
190 # using the -I flag.
194 # If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but
197 # The default value is: NO.
201 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the
202 # first line (until the first dot) of a Javadoc-style comment as the brief
203 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
206 # The default value is: NO.
210 # If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line
213 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
216 # The default value is: NO.
220 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first
221 # line (until the first dot) of a Qt-style comment as the brief description. If
222 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
224 # The default value is: NO.
228 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a
230 # a brief description. This used to be the default behavior. The new default is
232 # tag to YES if you prefer the old behavior instead.
236 # The default value is: NO.
241 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
242 # Doxygen's special commands can be used and the contents of the docstring
244 # The default value is: YES.
248 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
250 # The default value is: YES.
254 # If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new
255 # page for each member. If set to NO, the documentation of a member will be part
256 # of the file/class/namespace that contains it.
257 # The default value is: NO.
261 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
268 # the documentation. An alias has the form:
272 # will allow you to put the command \sideeffect (or @sideeffect) in the
274 # "Side Effects:". Note that you cannot put \n's in the value part of an alias
275 # to insert newlines (in the resulting output). You can put ^^ in the value part
276 # of an alias to insert a newline as if a physical newline was in the original
277 # file. When you need a literal { or } or , in the value part of an alias you
279 # with the commands \{ and \} for these it is advised to use the version @{ and
286 …"kconfig_dep{1}=\attention Available only when the following Kconfig option is enabled: \kconfig{\…
287 …"kconfig_dep{2}=\attention Available only when the following Kconfig options are enabled: \kconfig…
288 …"kconfig_dep{3}=\attention Available only when the following Kconfig options are enabled: \kconfig…
299 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
301 # instance, some of the names that are used will be different. The list of all
303 # The default value is: NO.
307 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
311 # The default value is: NO.
315 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
317 # The default value is: NO.
321 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
323 # The default value is: NO.
327 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
331 # The default value is: NO.
335 # Doxygen selects the parser to use depending on the extension of the files it
338 # using this tag. The format is ext=language, where ext is a file extension, and
339 # language is one of the parsers supported by Doxygen: IDL, Java, JavaScript,
342 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
343 # tries to guess whether the code is fixed or free formatted code, this is the
351 # the files are not read by Doxygen. When specifying no_extension you should add
352 # * to the FILE_PATTERNS.
354 # Note see also the list of default file extension mappings.
358 # If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments
359 # according to the Markdown format, which allows for more readable
361 # The output of markdown processing is further processed by Doxygen, so you can
364 # The default value is: YES.
368 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
369 # to that level are automatically included in the table of contents, even if
373 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
377 # The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
378 # generate identifiers for the Markdown headings. Note: Every identifier is
381 # sequence number starting at 0 and GITHUB use the lower case version of title
383 # The default value is: DOXYGEN.
384 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
390 # be prevented in individual cases by putting a % sign in front of the word or
392 # The default value is: YES.
397 # to include (a tag file for) the STL sources as input, then you should set this
400 # versus func(std::string) {}). This also makes the inheritance and
402 # The default value is: NO.
408 # The default value is: NO.
412 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
416 # The default value is: NO.
422 # Doxygen to replace the get and set methods by a property in the documentation.
423 # This will only work if the methods are indeed getting or setting a simple
424 # type. If this is not the case, or you want to show the methods anyway, you
426 # The default value is: YES.
430 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
431 # tag is set to YES then Doxygen will reuse the documentation of the first
432 # member in the group (if any) for the other members of the group. By default
434 # The default value is: NO.
439 # any nested class or struct is added to the same group. By default this option
441 # The default value is: NO.
445 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
447 # type (e.g. under the Public Functions section). Set it to NO to prevent
448 # subgrouping. Alternatively, this can be done per class using the
450 # The default value is: YES.
454 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
455 # are shown inside the group in which they are included (e.g. using \ingroup)
461 # The default value is: NO.
465 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
467 # the documentation of the scope in which they are defined (i.e. file,
471 # The default value is: NO.
476 # enum is documented as struct, union, or enum with the name of the typedef. So
477 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
478 # with name TypeT. When disabled the typedef will appear as a member of a file,
479 # namespace, or class. And the struct will be named TypeS. This can typically be
480 # useful for C code in case the coding convention dictates that all compound
481 # types are typedef'ed and only the typedef is referenced, never the tag name.
482 # The default value is: NO.
486 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
488 # an expensive process and often the same symbol appears multiple times in the
489 # code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small
490 # Doxygen will become slower. If the cache is too large, memory is wasted. The
491 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
492 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
493 # symbols. At the end of a run Doxygen will report the cache usage and suggest
494 # the optimal cache size from a speed point of view.
499 # The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use
500 # during processing. When set to 0 Doxygen will based this on the number of
501 # cores available in the system. You can set it explicitly to a value larger
502 # than 0 to get more control over the balance between CPU load and processing
503 # speed. At this moment only the input processing can be done using multiple
504 # threads. Since this is still an experimental feature the default is set to 1,
506 # encounter. Generating dot graphs in parallel is controlled by the
512 # If the TIMESTAMP tag is set different from NO then each generated page will
513 # contain the date or date and time when the page was generated. Setting this to
514 # NO can help when comparing the output of multiple runs.
516 # The default value is: NO.
524 # If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in
526 # class members and static file members will be hidden unless the
528 # Note: This will also disable the warnings about undocumented members that are
530 # The default value is: NO.
534 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
535 # be included in the documentation.
536 # The default value is: NO.
540 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
541 # methods of a class will be included in the documentation.
542 # The default value is: NO.
546 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
547 # scope will be included in the documentation.
548 # The default value is: NO.
552 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
553 # included in the documentation.
554 # The default value is: NO.
558 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
559 # locally in source files will be included in the documentation. If set to NO,
562 # The default value is: YES.
567 # which are defined in the implementation section but not in the interface are
568 # included in the documentation. If set to NO, only methods in the interface are
570 # The default value is: NO.
574 # If this flag is set to YES, the members of anonymous namespaces will be
575 # extracted and appear in the documentation as a namespace called
576 # 'anonymous_namespace{file}', where file will be replaced with the base name of
577 # the file that contains the anonymous namespace. By default anonymous namespace
579 # The default value is: NO.
583 # If this flag is set to YES, the name of an unnamed parameter in a declaration
584 # will be determined by the corresponding definition. By default unnamed
585 # parameters remain unnamed in the output.
586 # The default value is: YES.
590 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
592 # members will be included in the various overviews, but no documentation
594 # The default value is: NO.
598 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
599 # undocumented classes that are normally visible in the class hierarchy. If set
600 # to NO, these classes will be included in the various overviews. This option
603 # The default value is: NO.
607 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend
608 # declarations. If set to NO, these declarations will be included in the
610 # The default value is: NO.
614 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
615 # documentation blocks found inside the body of a function. If set to NO, these
616 # blocks will be appended to the function's detailed documentation block.
617 # The default value is: NO.
621 # The INTERNAL_DOCS tag determines if documentation that is typed after a
622 # \internal command is included. If the tag is set to NO then the documentation
623 # will be excluded. Set it to YES to include the internal documentation.
624 # The default value is: NO.
628 # With the correct setting of option CASE_SENSE_NAMES Doxygen will better be
629 # able to match the capabilities of the underlying filesystem. In case the
630 # filesystem is case sensitive (i.e. it supports files in the same directory
631 # whose names only differ in casing), the option must be set to YES to properly
632 # deal with such files in case they appear in the input. For filesystems that
633 # are not case sensitive the option should be set to NO to properly deal with
635 # classes, one named CLASS and the other named Class, and to also support
636 # references to files without having to specify the exact matching casing. On
641 # The default value is: SYSTEM.
645 # If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with
646 # their full class and namespace scopes in the documentation. If set to YES, the
648 # The default value is: NO.
652 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will
654 # YES the compound reference will be hidden.
655 # The default value is: NO.
659 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
660 # will show which file needs to be included to use the class.
661 # The default value is: YES.
665 # If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of
666 # the files that are included by a file in the documentation of that file.
667 # The default value is: YES.
671 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
672 # grouped member an include statement to the documentation, telling the reader
673 # which file to include in order to use the member.
674 # The default value is: NO.
678 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include
679 # files with double quotes in the documentation rather than with sharp brackets.
680 # The default value is: NO.
684 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
686 # The default value is: YES.
690 # If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the
692 # name. If set to NO, the members will appear in declaration order.
693 # The default value is: YES.
697 # If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief
699 # name. If set to NO, the members will appear in declaration order. Note that
700 # this will also influence the order of the classes in the class list.
701 # The default value is: NO.
705 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the
707 # destructors are listed first. If set to NO the constructors will appear in the
713 # The default value is: NO.
717 # If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy
718 # of group names into alphabetical order. If set to NO the group names will
720 # The default value is: NO.
724 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
725 # fully-qualified names, including namespaces. If set to NO, the class list will
726 # be sorted only by class name, not including the namespace part.
728 # Note: This option applies only to the class list, not to the alphabetical
730 # The default value is: NO.
734 # If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper
736 # the prototype and the implementation of a member function even if there is
740 # The default value is: NO.
744 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
745 # list. This list is created by putting \todo commands in the documentation.
746 # The default value is: YES.
750 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
751 # list. This list is created by putting \test commands in the documentation.
752 # The default value is: YES.
756 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
757 # list. This list is created by putting \bug commands in the documentation.
758 # The default value is: YES.
762 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
763 # the deprecated list. This list is created by putting \deprecated commands in
764 # the documentation.
765 # The default value is: YES.
769 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
775 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
776 # initial value of a variable or macro / define can have for it to appear in the
777 # documentation. If the initializer consists of more lines than specified here
778 # it will be hidden. Use a value of 0 to hide initializers completely. The
779 # appearance of the value of individual variables and macros / defines can be
780 # controlled using \showinitializer or \hideinitializer command in the
786 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
787 # the bottom of the documentation of classes and structs. If set to YES, the
788 # list will mention the files that were used to generate the documentation.
789 # The default value is: YES.
793 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
794 # will remove the Files entry from the Quick Index and from the Folder Tree View
796 # The default value is: YES.
800 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
801 # page. This will remove the Namespaces entry from the Quick Index and from the
803 # The default value is: YES.
807 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
808 # Doxygen should invoke to get the current version for each file (typically from
809 # the version control system). Doxygen will invoke the program by executing (via
810 # popen()) the command command input-file, where command is the value of the
811 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
812 # by Doxygen. Whatever the program writes to standard output is used as the file
813 # version. For an example see the documentation.
817 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
818 # by Doxygen. The layout file controls the global structure of the generated
819 # output files in an output format independent way. To create the layout file
820 # that represents Doxygen's defaults, run Doxygen with the -l option. You can
821 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
822 # will be used as the name of the layout file. See also section "Changing the
826 # DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE
831 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
832 # the reference definitions. This must be a list of .bib files. The .bib
833 # extension is automatically appended if omitted. This requires the bibtex tool
835 # For LaTeX the style of the bibliography can be controlled using
836 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
841 # The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH
844 # Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the
845 # path already specified by the PATH variable, and are added in the order
849 # defined changes to the PATH are ignored. A typical example on macOS is to set
851 # together with the standard path, the full search path used by doxygen when
861 # The QUIET tag can be used to turn on/off the messages that are generated to
862 # standard output by Doxygen. If QUIET is set to YES this implies that the
864 # The default value is: NO.
868 # The WARNINGS tag can be used to turn on/off the warning messages that are
870 # this implies that the warnings are on.
872 # Tip: Turn warnings on while writing the documentation.
873 # The default value is: YES.
877 # If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate
880 # The default value is: YES.
884 # If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for
885 # potential errors in the documentation, such as documenting some parameters in
888 # The default value is: YES.
895 # The default value is: YES.
902 # documentation, but not about the absence of documentation. If EXTRACT_ALL is
905 # The default value is: NO.
913 # The default value is: NO.
917 # If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when
918 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
920 # at the end of the Doxygen process Doxygen will return with a non-zero status.
921 # If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves
923 # write the warning messages in between other messages but write them at the end
924 # of a run, in case a WARN_LOGFILE is defined the warning messages will be
925 # besides being in the defined file also be shown at the end of a run, unless
926 # the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
927 # the behavior will remain as with the setting FAIL_ON_WARNINGS.
929 # The default value is: NO.
933 # The WARN_FORMAT tag determines the format of the warning messages that Doxygen
934 # can produce. The string should contain the $file, $line, and $text tags, which
935 # will be replaced by the file and line number from which the warning originated
936 # and the warning text. Optionally the format may contain $version, which will
937 # be replaced by the version of the file (if it could be obtained via
940 # The default value is: $file:$line: $text.
944 # In the $text part of the WARN_FORMAT command it is possible that a reference
946 # (outside of Doxygen) the user can define a custom "cut" / "paste" string.
950 # The default value is: at line $line of file $file.
954 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
955 # messages should be written. If left blank the output is written to standard
956 # error (stderr). In case the file specified cannot be opened for writing the
958 # specified the warning and error messages are written to standard output
964 # Configuration options related to the input files
967 # The INPUT tag is used to specify the files and/or directories that contain
969 # directories like /usr/src/myproject. Separate the files or directories with
971 # Note: If this tag is empty the current directory is searched.
984 # This tag can be used to specify the character encoding of the source files
985 # that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
986 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
988 # https://www.gnu.org/software/libiconv/) for the list of possible encodings.
990 # The default value is: UTF-8.
994 # This tag can be used to specify the character encoding of the source files
995 # that Doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
996 # character encoding on a per file pattern basis. Doxygen will compare the file
997 # name with each pattern and apply the encoding instead of the default
998 # INPUT_ENCODING) if there is a match. The character encodings are a list of the
1004 # If the value of the INPUT tag contains directories, you can use the
1006 # *.h) to filter out the source-files in the directories.
1009 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1012 # Note the list of default checked file patterns might differ from the list of
1015 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
1027 # The RECURSIVE tag can be used to specify whether or not subdirectories should
1029 # The default value is: NO.
1033 # The EXCLUDE tag can be used to specify files and/or directories that should be
1034 # excluded from the INPUT source files. This way you can easily exclude a
1035 # subdirectory from a directory tree whose root is specified with the INPUT tag.
1037 # Note that relative paths are relative to the directory from which Doxygen is
1043 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1045 # from the input.
1046 # The default value is: NO.
1050 # If the value of the INPUT tag contains directories, you can use the
1054 # Note that the wildcards are matched against the file with absolute path, so to
1055 # exclude all test directories for example use the pattern */test/*
1059 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1060 # (namespaces, classes, functions, etc.) that should be excluded from the
1061 # output. The symbol name can be a fully qualified name, a word, or if the
1070 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
1071 # that contain example code fragments that are included (see the \include
1076 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
1078 # *.h) to filter out the source-files in the directories. If left blank all
1083 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1084 # searched for input files to be used with the \include or \dontinclude commands
1085 # irrespective of the value of the RECURSIVE tag.
1086 # The default value is: NO.
1090 # The IMAGE_PATH tag can be used to specify one or more files or directories
1091 # that contain images that are to be included in the documentation (see the
1096 # The INPUT_FILTER tag can be used to specify a program that Doxygen should
1097 # invoke to filter for each input file. Doxygen will invoke the filter program
1098 # by executing (via popen()) the command:
1102 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1103 # name of an input file. Doxygen will then use the output that the filter
1107 # Note that the filter must not add or remove lines; it is applied before the
1108 # code is scanned, but not when the output code is generated. If lines are added
1109 # or removed, the anchors will not be placed correctly.
1111 # Note that Doxygen will use the data processed and written to standard output
1117 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1122 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1123 # basis. Doxygen will compare the file name with each pattern and apply the
1124 # filter if there is a match. The filters are a list of the form: pattern=filter
1126 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1127 # patterns match the file name, INPUT_FILTER is applied.
1130 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1135 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1136 # INPUT_FILTER) will also be used to filter the input files that are used for
1137 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1138 # The default value is: NO.
1142 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1143 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1146 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1150 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1151 # is part of the input, its contents will be placed on the main page
1153 # and want to reuse the introduction page also for the Doxygen output.
1157 # The Fortran standard specifies that for fixed formatted Fortran code all
1159 # extension is to allow longer lines before the automatic comment starts. The
1161 # be processed before the automatic comment starts.
1170 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1173 # Note: To get rid of all source code in the generated output, make sure that
1175 # The default value is: NO.
1179 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1180 # multi-line macros, enums or list initialized variables directly into the
1182 # The default value is: NO.
1186 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any
1189 # The default value is: YES.
1193 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1195 # The default value is: NO.
1199 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1201 # The default value is: NO.
1205 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1206 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1207 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1208 # link to the documentation.
1209 # The default value is: YES.
1213 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1215 # brief description and links to the definition and documentation. Since this
1216 # will make the HTML file larger and loading of large files a bit slower, you
1218 # The default value is: YES.
1219 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1223 # If the USE_HTAGS tag is set to YES then the references to source code will
1224 # point to the HTML generated by the htags(1) tool instead of Doxygen built-in
1225 # source browser. The htags tool is part of GNU's global source tagging system
1229 # To use it do the following:
1230 # - Install the latest version of global
1231 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1232 # - Make sure the INPUT points to the root of the source tree
1236 # tools must be available from the command line (i.e. in the search path).
1238 # The result: instead of the source browser generated by Doxygen, the links to
1239 # source code will now point to the output of htags.
1240 # The default value is: NO.
1241 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1245 # If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a
1246 # verbatim copy of the header file for each class for which an include is
1249 # The default value is: YES.
1253 # If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the
1255 # http://clang.llvm.org/) for more accurate parsing at the cost of reduced
1257 # which Doxygen's built-in parser lacks the necessary type information.
1258 # Note: The availability of this option depends on whether or not Doxygen was
1259 # generated with the -Duse_libclang=ON option for CMake.
1260 # The default value is: NO.
1264 # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
1265 # tag is set to YES then Doxygen will add the directory of each input to the
1267 # The default value is: YES.
1268 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1272 # If clang assisted parsing is enabled you can provide the compiler with command
1273 # line options that you would normally use when invoking the compiler. Note that
1274 # the include paths will already be set by Doxygen for the files and directories
1276 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1280 # If clang assisted parsing is enabled you can provide the clang parser with the
1281 # path to the directory containing a file called compile_commands.json. This
1282 # file is the compilation database (see:
1283 # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
1284 # options used when the source files were built. This is equivalent to
1285 # specifying the -p option to a clang tool, such as clang-check. These options
1286 # will then be passed to the parser. Any options specified with CLANG_OPTIONS
1288 # Note: The availability of this option depends on whether or not Doxygen was
1289 # generated with the -Duse_libclang=ON option for CMake.
1294 # Configuration options related to the alphabetical class index
1297 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1298 # compounds will be generated. Enable this if the project contains a lot of
1300 # The default value is: YES.
1304 # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1305 # that should be ignored while generating the index headers. The IGNORE_PREFIX
1306 # tag works for classes, function and member names. The entity will be placed in
1307 # the alphabetical list under the first letter of the entity name that remains
1308 # after removing the prefix.
1309 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1314 # Configuration options related to the HTML output
1317 # If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output
1318 # The default value is: YES.
1322 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1323 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1325 # The default directory is: html.
1326 # This tag requires that the tag GENERATE_HTML is set to YES.
1330 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1332 # The default value is: .html.
1333 # This tag requires that the tag GENERATE_HTML is set to YES.
1337 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1338 # each generated HTML page. If the tag is left blank Doxygen will generate a
1341 # To get valid HTML the header file that includes any scripts and style sheets
1342 # that Doxygen needs, which is dependent on the configuration options used (e.g.
1343 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1347 # and then modify the file new_header.html. See also section "Doxygen usage"
1348 # for information on how to generate the default header that Doxygen normally
1350 # Note: The header is subject to change so you typically have to regenerate the
1352 # of the possible markers and block names see the documentation.
1353 # This tag requires that the tag GENERATE_HTML is set to YES.
1357 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1358 # generated HTML page. If the tag is left blank Doxygen will generate a standard
1360 # footer and what special commands can be used inside the footer. See also
1361 # section "Doxygen usage" for information on how to generate the default footer
1363 # This tag requires that the tag GENERATE_HTML is set to YES.
1367 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1368 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1369 # the HTML output. If left blank Doxygen will generate a default style sheet.
1370 # See also section "Doxygen usage" for information on how to generate the style
1373 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1375 # This tag requires that the tag GENERATE_HTML is set to YES.
1379 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1380 # cascading style sheets that are included after the standard style sheets
1382 # This is preferred over using HTML_STYLESHEET since it does not replace the
1384 # Doxygen will copy the style sheet files to the output directory.
1385 # Note: The order of the extra style sheet files is of importance (e.g. the last
1386 # style sheet in the list overrules the setting of the previous ones in the
1388 # Note: Since the styling of scrollbars can currently not be overruled in
1389 # Webkit/Chromium, the styling will be left out of the default doxygen.css if
1391 # customization is desired it has to be added explicitly. For an example see the
1393 # This tag requires that the tag GENERATE_HTML is set to YES.
1400 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1401 # other source files which should be copied to the HTML output directory. Note
1402 # that these files will be copied to the base HTML output directory. Use the
1403 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1404 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1406 # This tag requires that the tag GENERATE_HTML is set to YES.
1411 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1414 # generates dark mode output, AUTO_LIGHT automatically sets the mode according
1415 # to the user preference, uses light mode if no preference is set (the default),
1416 # AUTO_DARK automatically sets the mode according to the user preference, uses
1419 # The default value is: AUTO_LIGHT.
1420 # This tag requires that the tag GENERATE_HTML is set to YES.
1424 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1425 # will adjust the colors in the style sheet and background images according to
1427 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1431 # This tag requires that the tag GENERATE_HTML is set to YES.
1435 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1436 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1437 # value of 255 will produce the most vivid colors.
1439 # This tag requires that the tag GENERATE_HTML is set to YES.
1443 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1444 # luminance component of the colors in the HTML output. Values below 100
1445 # gradually make the output lighter, whereas values above 100 make the output
1446 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1447 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1448 # change the gamma.
1450 # This tag requires that the tag GENERATE_HTML is set to YES.
1454 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1456 # are dynamically created via JavaScript. If disabled, the navigation index will
1459 # like the Qt help browser.
1460 # The default value is: YES.
1461 # This tag requires that the tag GENERATE_HTML is set to YES.
1465 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1466 # documentation will contain sections that can be hidden and shown after the
1468 # The default value is: NO.
1469 # This tag requires that the tag GENERATE_HTML is set to YES.
1473 # If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
1474 # dynamically folded and expanded in the generated HTML source code.
1475 # The default value is: YES.
1476 # This tag requires that the tag GENERATE_HTML is set to YES.
1480 # If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in
1481 # the top right corner of code and text fragments that allows the user to copy
1482 # its content to the clipboard. Note this only works if supported by the browser
1483 # and the web page is served via a secure context (see:
1484 # https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file:
1486 # The default value is: YES.
1487 # This tag requires that the tag GENERATE_HTML is set to YES.
1491 # Doxygen stores a couple of settings persistently in the browser (via e.g.
1493 # Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store
1494 # the settings under a project specific key, such that the user preferences will
1496 # This tag requires that the tag GENERATE_HTML is set to YES.
1500 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1501 # shown in the various tree structured indices initially; the user can expand
1502 # and collapse entries dynamically later on. Doxygen will expand the tree to
1503 # such a level that at most the specified number of entries are visible (unless
1504 # a fully collapsed tree already exceeds this amount). So setting the number of
1509 # This tag requires that the tag GENERATE_HTML is set to YES.
1513 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1517 # create a documentation set, Doxygen will generate a Makefile in the HTML
1518 # output directory. Running make will produce the docset in that directory and
1519 # running make install will install the docset in
1523 # The default value is: NO.
1524 # This tag requires that the tag GENERATE_HTML is set to YES.
1528 # This tag determines the name of the docset feed. A documentation feed provides
1531 # The default value is: Doxygen generated docs.
1532 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1536 # This tag determines the URL of the docset feed. A documentation feed provides
1539 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1543 # This tag specifies a string that should uniquely identify the documentation
1545 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1546 # The default value is: org.doxygen.Project.
1547 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1551 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1552 # the documentation publisher. This should be a reverse domain-name style
1554 # The default value is: org.doxygen.Publisher.
1555 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1559 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1560 # The default value is: Publisher.
1561 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1565 # If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three
1566 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1568 # on Windows. In the beginning of 2021 Microsoft took the original page, with
1569 # a.o. the download links, offline the HTML help workshop was already many years
1570 # in maintenance mode). You can download the HTML help workshop from the web
1575 # The HTML Help Workshop contains a compiler that can convert all HTML output
1577 # files are now used as the Windows 98 help format, and will replace the old
1578 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1580 # words in the documentation. The HTML workshop also contains a viewer for
1582 # The default value is: NO.
1583 # This tag requires that the tag GENERATE_HTML is set to YES.
1587 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1588 # file. You can add a path in front of the file if the result should not be
1589 # written to the html output directory.
1590 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1594 # The HHC_LOCATION tag can be used to specify the location (absolute path
1595 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1596 # Doxygen will try to run the HTML help compiler on the generated index.hhp.
1597 # The file has to be specified with full path.
1598 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1602 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1603 # (YES) or that it should be included in the main .chm file (NO).
1604 # The default value is: NO.
1605 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1609 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1611 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1615 # The BINARY_TOC flag controls whether a binary table of contents is generated
1616 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1617 # enables the Previous and Next buttons.
1618 # The default value is: NO.
1619 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1623 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1624 # the table of contents of the HTML help documentation and to the tree view.
1625 # The default value is: NO.
1626 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1630 # The SITEMAP_URL tag is used to specify the full URL of the place where the
1631 # generated documentation will be placed on the server by the user during the
1632 # deployment of the documentation. The generated sitemap is called sitemap.xml
1633 # and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
1634 # is specified no sitemap is generated. For information about the sitemap
1636 # This tag requires that the tag GENERATE_HTML is set to YES.
1640 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1643 # (.qch) of the generated HTML documentation.
1644 # The default value is: NO.
1645 # This tag requires that the tag GENERATE_HTML is set to YES.
1649 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1650 # the file name of the resulting .qch file. The path specified is relative to
1651 # the HTML output folder.
1652 # This tag requires that the tag GENERATE_QHP is set to YES.
1656 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1660 # The default value is: org.doxygen.Project.
1661 # This tag requires that the tag GENERATE_QHP is set to YES.
1665 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1669 # The default value is: doc.
1670 # This tag requires that the tag GENERATE_QHP is set to YES.
1674 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1678 # This tag requires that the tag GENERATE_QHP is set to YES.
1682 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1686 # This tag requires that the tag GENERATE_QHP is set to YES.
1690 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1693 # This tag requires that the tag GENERATE_QHP is set to YES.
1697 # The QHG_LOCATION tag can be used to specify the location (absolute path
1699 # run qhelpgenerator on the generated .qhp file.
1700 # This tag requires that the tag GENERATE_QHP is set to YES.
1704 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1705 # generated, together with the HTML files, they form an Eclipse help plugin. To
1706 # install this plugin and make it available under the help contents menu in
1707 # Eclipse, the contents of the directory containing the HTML and XML files needs
1708 # to be copied into the plugins directory of eclipse. The name of the directory
1709 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1710 # After copying Eclipse needs to be restarted before the help appears.
1711 # The default value is: NO.
1712 # This tag requires that the tag GENERATE_HTML is set to YES.
1716 # A unique identifier for the Eclipse help plugin. When installing the plugin
1717 # the directory name containing the HTML and XML files should also have this
1719 # The default value is: org.doxygen.Project.
1720 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1724 # If you want full control over the layout of the generated HTML pages it might
1725 # be necessary to disable the index and replace it with your own. The
1726 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1727 # of each HTML page. A value of NO enables the index and the value YES disables
1728 # it. Since the tabs in the index contain the same information as the navigation
1730 # The default value is: NO.
1731 # This tag requires that the tag GENERATE_HTML is set to YES.
1735 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1736 # structure should be generated to display hierarchical information. If the tag
1738 # index structure (just like the one that is generated for HTML Help). For this
1740 # (i.e. any modern browser). Windows users are probably better off using the
1742 # further fine tune the look of the index (see "Fine-tuning the output"). As an
1743 # example, the default style sheet generated by Doxygen has an example that
1744 # shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1745 # Since the tree basically has the same information as the tab index, you could
1747 # The default value is: NO.
1748 # This tag requires that the tag GENERATE_HTML is set to YES.
1752 # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
1753 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1754 # area (value NO) or if it should extend to the full height of the window (value
1756 # https://docs.readthedocs.io with more room for contents, but less room for the
1759 # The default value is: NO.
1760 # This tag requires that the tag GENERATE_HTML is set to YES.
1764 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1765 # Doxygen will group on one line in the generated HTML documentation.
1767 # Note that a value of 0 will completely suppress the enum values from appearing
1768 # in the overview section.
1770 # This tag requires that the tag GENERATE_HTML is set to YES.
1774 # When the SHOW_ENUM_VALUES tag is set doxygen will show the specified
1775 # enumeration values besides the enumeration mnemonics.
1776 # The default value is: NO.
1780 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1781 # to set the initial width (in pixels) of the frame in which the tree is shown.
1783 # This tag requires that the tag GENERATE_HTML is set to YES.
1787 # If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to
1789 # The default value is: NO.
1790 # This tag requires that the tag GENERATE_HTML is set to YES.
1794 # If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email
1796 # The default value is: YES.
1797 # This tag requires that the tag GENERATE_HTML is set to YES.
1801 # If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg
1804 # the HTML output. These images will generally look nicer at scaled resolutions.
1805 # Possible values are: png (the default) and svg (looks nicer but requires the
1807 # The default value is: png.
1808 # This tag requires that the tag GENERATE_HTML is set to YES.
1812 # Use this tag to change the font size of LaTeX formulas included as images in
1813 # the HTML documentation. When you change the font size after a successful
1814 # Doxygen run you need to manually remove any form_*.png images from the HTML
1817 # This tag requires that the tag GENERATE_HTML is set to YES.
1821 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1823 # the section "Including formulas" for details.
1827 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1828 # https://www.mathjax.org) which uses client side JavaScript for the rendering
1830 # installed or if you want to formulas look prettier in the HTML output. When
1831 # enabled you may also need to install MathJax separately and configure the path
1832 # to it using the MATHJAX_RELPATH option.
1833 # The default value is: NO.
1834 # This tag requires that the tag GENERATE_HTML is set to YES.
1838 # With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1839 # Note that the different versions of MathJax have different requirements with
1840 # regards to the different settings, so it is possible that also other MathJax
1841 # settings have to be changed when switching between the different MathJax
1844 # The default value is: MathJax_2.
1845 # This tag requires that the tag USE_MATHJAX is set to YES.
1849 # When MathJax is enabled you can set the default output format to be used for
1850 # the MathJax output. For more details about the output format see MathJax
1855 # Possible values are: HTML-CSS (which is slower, but has the best
1856 # compatibility. This is the name for Mathjax version 2, for MathJax version 3
1859 # is the name for Mathjax version 3, for MathJax version 2 this will be
1861 # The default value is: HTML-CSS.
1862 # This tag requires that the tag USE_MATHJAX is set to YES.
1866 # When MathJax is enabled you need to specify the location relative to the HTML
1867 # output directory using the MATHJAX_RELPATH option. The destination directory
1868 # should contain the MathJax.js script. For instance, if the mathjax directory
1869 # is located at the same level as the HTML output directory, then
1870 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1871 # Content Delivery Network so you can quickly see the result without installing
1873 # MathJax from https://www.mathjax.org before deployment. The default value is:
1876 # This tag requires that the tag USE_MATHJAX is set to YES.
1880 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1888 # This tag requires that the tag USE_MATHJAX is set to YES.
1892 # The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces
1893 # of code that will be used on startup of the MathJax code. See the MathJax site
1896 # example see the documentation.
1897 # This tag requires that the tag USE_MATHJAX is set to YES.
1901 # When the SEARCHENGINE tag is enabled Doxygen will generate a search box for
1902 # the HTML output. The underlying search engine uses JavaScript and DHTML and
1906 # For large projects the JavaScript based search engine can be slow, then
1908 # search using the keyboard; to jump to the search box use <access key> + S
1909 # (what the <access key> is depends on the OS and browser, but it is typically
1910 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1911 # key> to jump into the search results window, the results can be navigated
1912 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1913 # the search. The filter options can be selected when the cursor is inside the
1914 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1915 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1917 # The default value is: YES.
1918 # This tag requires that the tag GENERATE_HTML is set to YES.
1922 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1924 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1926 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1927 # and searching needs to be provided by external tools. See the section
1929 # The default value is: NO.
1930 # This tag requires that the tag SEARCHENGINE is set to YES.
1934 # When EXTERNAL_SEARCH tag is enabled Doxygen will no longer generate the PHP
1935 # script for searching. Instead the search results are written to an XML file
1937 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1941 # (doxysearch.cgi) which are based on the open source search engine library
1945 # See the section "External Indexing and Searching" for details.
1946 # The default value is: NO.
1947 # This tag requires that the tag SEARCHENGINE is set to YES.
1951 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1952 # which will return the search results when EXTERNAL_SEARCH is enabled.
1955 # (doxysearch.cgi) which are based on the open source search engine library
1957 # https://xapian.org/). See the section "External Indexing and Searching" for
1959 # This tag requires that the tag SEARCHENGINE is set to YES.
1963 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1964 # search data is written to a file for indexing by an external tool. With the
1965 # SEARCHDATA_FILE tag the name of this file can be specified.
1966 # The default file is: searchdata.xml.
1967 # This tag requires that the tag SEARCHENGINE is set to YES.
1971 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1972 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1974 # projects and redirect the results back to the right project.
1975 # This tag requires that the tag SEARCHENGINE is set to YES.
1979 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through Doxygen
1980 # projects other than the one defined by this configuration file, but that are
1981 # all added to the same external search index. Each project needs to have a
1982 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1983 # to a relative location where the documentation can be found. The format is:
1985 # This tag requires that the tag SEARCHENGINE is set to YES.
1990 # Configuration options related to the LaTeX output
1993 # If the GENERATE_LATEX tag is set to YES, Doxygen will generate LaTeX output.
1994 # The default value is: YES.
1998 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1999 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2001 # The default directory is: latex.
2002 # This tag requires that the tag GENERATE_LATEX is set to YES.
2006 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
2009 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
2010 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
2011 # chosen this is overwritten by pdflatex. For specific output languages the
2012 # default can have been set differently, this depends on the implementation of
2013 # the output language.
2014 # This tag requires that the tag GENERATE_LATEX is set to YES.
2018 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
2020 # Note: This tag is used in the Makefile / make.bat.
2021 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
2023 # The default file is: makeindex.
2024 # This tag requires that the tag GENERATE_LATEX is set to YES.
2028 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
2030 # it will be automatically added in the LaTeX code.
2031 # Note: This tag is used in the generated output file (.tex).
2032 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
2033 # The default value is: makeindex.
2034 # This tag requires that the tag GENERATE_LATEX is set to YES.
2038 # If the COMPACT_LATEX tag is set to YES, Doxygen generates more compact LaTeX
2041 # The default value is: NO.
2042 # This tag requires that the tag GENERATE_LATEX is set to YES.
2046 # The PAPER_TYPE tag can be used to set the paper type that is used by the
2050 # The default value is: a4.
2051 # This tag requires that the tag GENERATE_LATEX is set to YES.
2055 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
2056 # that should be included in the LaTeX output. The package can be specified just
2057 # by its name or with the correct syntax as to be used with the LaTeX
2058 # \usepackage command. To get the times font for instance you can specify :
2060 # To use the option intlimits with the amsmath package you can specify:
2063 # This tag requires that the tag GENERATE_LATEX is set to YES.
2067 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
2068 # the generated LaTeX document. The header should contain everything until the
2072 # and then modify the file new_header.tex. See also section "Doxygen usage" for
2073 # information on how to generate the default header that Doxygen normally uses.
2076 # Note: The header is subject to change so you typically have to regenerate the
2077 # default header when upgrading to a newer version of Doxygen. The following
2078 # commands have a special meaning inside the header (and footer): For a
2079 # description of the possible markers and block names see the documentation.
2080 # This tag requires that the tag GENERATE_LATEX is set to YES.
2084 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2085 # the generated LaTeX document. The footer should contain everything after the
2088 # special commands can be used inside the footer. See also section "Doxygen
2089 # usage" for information on how to generate the default footer that Doxygen
2092 # This tag requires that the tag GENERATE_LATEX is set to YES.
2096 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2097 # LaTeX style sheets that are included after the standard style sheets created
2099 # will copy the style sheet files to the output directory.
2100 # Note: The order of the extra style sheet files is of importance (e.g. the last
2101 # style sheet in the list overrules the setting of the previous ones in the
2103 # This tag requires that the tag GENERATE_LATEX is set to YES.
2107 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2108 # other source files which should be copied to the LATEX_OUTPUT output
2109 # directory. Note that the files will be copied as-is; there are no commands or
2111 # This tag requires that the tag GENERATE_LATEX is set to YES.
2115 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2116 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2117 # contain links (just like the HTML output) instead of page references. This
2118 # makes the output suitable for online browsing using a PDF viewer.
2119 # The default value is: YES.
2120 # This tag requires that the tag GENERATE_LATEX is set to YES.
2124 # If the USE_PDFLATEX tag is set to YES, Doxygen will use the engine as
2125 # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
2128 # See also section LATEX_CMD_NAME for selecting the engine.
2129 # The default value is: YES.
2130 # This tag requires that the tag GENERATE_LATEX is set to YES.
2134 # The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error.
2136 # mode nothing is printed on the terminal, errors are scrolled as if <return> is
2138 # keyboard input (\read on a not open input stream) cause the job to abort,
2139 # NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
2144 # The default value is: NO.
2145 # This tag requires that the tag GENERATE_LATEX is set to YES.
2149 # If the LATEX_HIDE_INDICES tag is set to YES then Doxygen will not include the
2150 # index chapters (such as File Index, Compound Index, etc.) in the output.
2151 # The default value is: NO.
2152 # This tag requires that the tag GENERATE_LATEX is set to YES.
2156 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2159 # The default value is: plain.
2160 # This tag requires that the tag GENERATE_LATEX is set to YES.
2164 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2165 # path from which the emoji images will be read. If a relative path is entered,
2166 # it will be relative to the LATEX_OUTPUT directory. If left blank the
2168 # This tag requires that the tag GENERATE_LATEX is set to YES.
2173 # Configuration options related to the RTF output
2176 # If the GENERATE_RTF tag is set to YES, Doxygen will generate RTF output. The
2179 # The default value is: NO.
2183 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2184 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2186 # The default directory is: rtf.
2187 # This tag requires that the tag GENERATE_RTF is set to YES.
2191 # If the COMPACT_RTF tag is set to YES, Doxygen generates more compact RTF
2194 # The default value is: NO.
2195 # This tag requires that the tag GENERATE_RTF is set to YES.
2199 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2200 # contain hyperlink fields. The RTF file will contain links (just like the HTML
2201 # output) instead of page references. This makes the output suitable for online
2206 # The default value is: NO.
2207 # This tag requires that the tag GENERATE_RTF is set to YES.
2215 # See also section "Doxygen usage" for information on how to generate the
2217 # This tag requires that the tag GENERATE_RTF is set to YES.
2221 # Set optional variables used in the generation of an RTF document. Syntax is
2224 # This tag requires that the tag GENERATE_RTF is set to YES.
2228 # The RTF_EXTRA_FILES tag can be used to specify one or more extra images or
2229 # other source files which should be copied to the RTF_OUTPUT output directory.
2230 # Note that the files will be copied as-is; there are no commands or markers
2232 # This tag requires that the tag GENERATE_RTF is set to YES.
2237 # Configuration options related to the man page output
2240 # If the GENERATE_MAN tag is set to YES, Doxygen will generate man pages for
2242 # The default value is: NO.
2246 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2247 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2248 # it. A directory man3 will be created inside the directory specified by
2250 # The default directory is: man.
2251 # This tag requires that the tag GENERATE_MAN is set to YES.
2255 # The MAN_EXTENSION tag determines the extension that is added to the generated
2256 # man pages. In case the manual section does not start with a number, the number
2257 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2259 # The default value is: .3.
2260 # This tag requires that the tag GENERATE_MAN is set to YES.
2264 # The MAN_SUBDIR tag determines the name of the directory created within
2265 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2266 # MAN_EXTENSION with the initial . removed.
2267 # This tag requires that the tag GENERATE_MAN is set to YES.
2271 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, then it
2272 # will generate one additional man file for each entity documented in the real
2273 # man page(s). These additional files only source the real man page, but without
2274 # them the man command would be unable to find the correct page.
2275 # The default value is: NO.
2276 # This tag requires that the tag GENERATE_MAN is set to YES.
2281 # Configuration options related to the XML output
2284 # If the GENERATE_XML tag is set to YES, Doxygen will generate an XML file that
2285 # captures the structure of the code including all documentation.
2286 # The default value is: NO.
2290 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2291 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2293 # The default directory is: xml.
2294 # This tag requires that the tag GENERATE_XML is set to YES.
2298 # If the XML_PROGRAMLISTING tag is set to YES, Doxygen will dump the program
2300 # the XML output. Note that enabling this will significantly increase the size
2301 # of the XML output.
2302 # The default value is: YES.
2303 # This tag requires that the tag GENERATE_XML is set to YES.
2307 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, Doxygen will include
2308 # namespace members in file scope as well, matching the HTML output.
2309 # The default value is: NO.
2310 # This tag requires that the tag GENERATE_XML is set to YES.
2315 # Configuration options related to the DOCBOOK output
2318 # If the GENERATE_DOCBOOK tag is set to YES, Doxygen will generate Docbook files
2320 # The default value is: NO.
2324 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2325 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2327 # The default directory is: docbook.
2328 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2333 # Configuration options for the AutoGen Definitions output
2336 # If the GENERATE_AUTOGEN_DEF tag is set to YES, Doxygen will generate an
2338 # the structure of the code including all documentation. Note that this feature
2339 # is still experimental and incomplete at the moment.
2340 # The default value is: NO.
2348 # If the GENERATE_SQLITE3 tag is set to YES Doxygen will generate a Sqlite3
2350 # The default value is: NO.
2354 # The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
2355 # put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2357 # The default directory is: sqlite3.
2358 # This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2362 # The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db
2365 # The default value is: YES.
2366 # This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2371 # Configuration options related to the Perl module output
2374 # If the GENERATE_PERLMOD tag is set to YES, Doxygen will generate a Perl module
2375 # file that captures the structure of the code including all documentation.
2377 # Note that this feature is still experimental and incomplete at the moment.
2378 # The default value is: NO.
2382 # If the PERLMOD_LATEX tag is set to YES, Doxygen will generate the necessary
2384 # output from the Perl module output.
2385 # The default value is: NO.
2386 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2390 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2392 # understand what is going on. On the other hand, if this tag is set to NO, the
2393 # size of the Perl module output will be much smaller and Perl will parse it
2394 # just the same.
2395 # The default value is: YES.
2396 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2400 # The names of the make variables in the generated doxyrules.make file are
2401 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2402 # so different doxyrules.make files included by the same Makefile don't
2404 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2409 # Configuration options related to the preprocessor
2412 # If the ENABLE_PREPROCESSING tag is set to YES, Doxygen will evaluate all
2413 # C-preprocessor directives found in the sources and include files.
2414 # The default value is: YES.
2418 # If the MACRO_EXPANSION tag is set to YES, Doxygen will expand all macro names
2419 # in the source code. If set to NO, only conditional compilation will be
2422 # The default value is: NO.
2423 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2427 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2428 # the macro expansion is limited to the macros specified with the PREDEFINED and
2430 # The default value is: NO.
2431 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2435 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2437 # The default value is: YES.
2438 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2442 # The INCLUDE_PATH tag can be used to specify one or more directories that
2443 # contain include files that are not input files but should be processed by the
2444 # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2446 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2450 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2451 # patterns (like *.h and *.hpp) to filter out the header-files in the
2452 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2454 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2458 # The PREDEFINED tag can be used to specify one or more macro names that are
2459 # defined before the preprocessor is started (similar to the -D option of e.g.
2460 # gcc). The argument of the tag is a list of macros of the form: name or
2461 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2463 # recursively expanded use the := operator instead of the = operator.
2464 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2530 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2531 # tag can be used to specify a list of macro names that should be expanded. The
2532 # macro definition that is found in the sources will be used. Use the PREDEFINED
2533 # tag if you want to use a different macro definition that overrules the
2534 # definition found in the source code.
2535 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2539 # If the SKIP_FUNCTION_MACROS tag is set to YES then Doxygen's preprocessor will
2542 # are typically used for boiler-plate code, and will confuse the parser if not
2544 # The default value is: YES.
2545 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2553 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2554 # file the location of the external documentation should be added. The format of
2557 # Adding location for the tag files is done as follows:
2559 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2560 # section "Linking to external documentation" for more information about the use
2562 # Note: Each tag file must have a unique name (where the name does NOT include
2563 # the path). If a tag file is not located in the directory in which Doxygen is
2564 # run, you must also specify the path to the tagfile here.
2569 # tag file that is based on the input files it reads. See section "Linking to
2570 # external documentation" for more information about the usage of tag files.
2574 # If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
2575 # will be listed in the class and namespace index. If set to NO, only the
2577 # The default value is: NO.
2581 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2582 # in the topic index. If set to NO, only the current project's groups will be
2584 # The default value is: YES.
2588 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2589 # the related pages index. If set to NO, only the current project's pages will
2591 # The default value is: YES.
2599 # If set to YES the inheritance and collaboration graphs will hide inheritance
2600 # and usage relations if the target is undocumented or is not a class.
2601 # The default value is: YES.
2605 # If you set the HAVE_DOT tag to YES then Doxygen will assume the dot tool is
2606 # available from the path. This tool is part of Graphviz (see:
2608 # Bell Labs. The other options in this section have no effect if this option is
2610 # The default value is: NO.
2614 # The DOT_NUM_THREADS specifies the number of dot invocations Doxygen is allowed
2615 # to run in parallel. When set to 0 Doxygen will base this on the number of
2616 # processors available in the system. You can set it explicitly to a value
2617 # larger than 0 to get control over the balance between CPU load and processing
2620 # This tag requires that the tag HAVE_DOT is set to YES.
2625 # subgraphs. When you want a differently looking font in the dot files that
2629 # to find the font, which can be done by putting it in a standard location or by
2630 # setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2631 # directory containing the font. Default graphviz fontsize is 14.
2632 # The default value is: fontname=Helvetica,fontsize=10.
2633 # This tag requires that the tag HAVE_DOT is set to YES.
2641 # The default value is: labelfontname=Helvetica,labelfontsize=10.
2642 # This tag requires that the tag HAVE_DOT is set to YES.
2649 # The default value is: shape=box,height=0.2,width=0.4.
2650 # This tag requires that the tag HAVE_DOT is set to YES.
2654 # You can set the path where dot can find font specified with fontname in
2656 # This tag requires that the tag HAVE_DOT is set to YES.
2660 # If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then Doxygen will
2661 # generate a graph for each documented class showing the direct and indirect
2662 # inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
2663 # HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2664 # the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
2665 # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2666 # If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
2669 # specific class, can be accomplished by means of the command \inheritancegraph.
2670 # Disabling an inheritance graph can be accomplished by means of the command
2673 # The default value is: YES.
2677 # If the COLLABORATION_GRAPH tag is set to YES then Doxygen will generate a
2678 # graph for each documented class showing the direct and indirect implementation
2679 # dependencies (inheritance, containment, and class references variables) of the
2681 # when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
2683 # accomplished by means of the command \hidecollaborationgraph.
2684 # The default value is: YES.
2685 # This tag requires that the tag HAVE_DOT is set to YES.
2689 # If the GROUP_GRAPHS tag is set to YES then Doxygen will generate a graph for
2690 # groups, showing the direct groups dependencies. Explicit enabling a group
2692 # of the command \groupgraph. Disabling a directory graph can be accomplished by
2693 # means of the command \hidegroupgraph. See also the chapter Grouping in the
2695 # The default value is: YES.
2696 # This tag requires that the tag HAVE_DOT is set to YES.
2700 # If the UML_LOOK tag is set to YES, Doxygen will generate inheritance and
2701 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2703 # The default value is: NO.
2704 # This tag requires that the tag HAVE_DOT is set to YES.
2708 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2709 # class node. If there are many fields or methods and many nodes the graph may
2710 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2711 # number of items for each type to make the size more manageable. Set this to 0
2712 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2713 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2714 # but if the number exceeds 15, the total amount of fields shown is limited to
2717 # This tag requires that the tag UML_LOOK is set to YES.
2721 # If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and
2722 # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2724 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, Doxygen
2725 # will not generate fields with class member information in the UML graphs. The
2726 # class diagrams will look similar to the default class diagrams but using UML
2727 # notation for the relationships.
2729 # The default value is: NO.
2730 # This tag requires that the tag UML_LOOK is set to YES.
2734 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2735 # to display on a single line. If the actual line length exceeds this threshold
2739 # This tag requires that the tag HAVE_DOT is set to YES.
2743 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2744 # collaboration graphs will show the relations between templates and their
2746 # The default value is: NO.
2747 # This tag requires that the tag HAVE_DOT is set to YES.
2751 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2752 # YES then Doxygen will generate a graph for each documented file showing the
2753 # direct and indirect include dependencies of the file with other documented
2755 # can be accomplished by means of the command \includegraph. Disabling an
2756 # include graph can be accomplished by means of the command \hideincludegraph.
2757 # The default value is: YES.
2758 # This tag requires that the tag HAVE_DOT is set to YES.
2762 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2764 # the direct and indirect include dependencies of the file with other documented
2766 # to NO, can be accomplished by means of the command \includedbygraph. Disabling
2767 # an included by graph can be accomplished by means of the command
2769 # The default value is: YES.
2770 # This tag requires that the tag HAVE_DOT is set to YES.
2774 # If the CALL_GRAPH tag is set to YES then Doxygen will generate a call
2777 # Note that enabling this option will significantly increase the time of a run.
2779 # functions only using the \callgraph command. Disabling a call graph can be
2780 # accomplished by means of the command \hidecallgraph.
2781 # The default value is: NO.
2782 # This tag requires that the tag HAVE_DOT is set to YES.
2786 # If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller
2789 # Note that enabling this option will significantly increase the time of a run.
2791 # functions only using the \callergraph command. Disabling a caller graph can be
2792 # accomplished by means of the command \hidecallergraph.
2793 # The default value is: NO.
2794 # This tag requires that the tag HAVE_DOT is set to YES.
2798 # If the GRAPHICAL_HIERARCHY tag is set to YES then Doxygen will graphical
2800 # The default value is: YES.
2801 # This tag requires that the tag HAVE_DOT is set to YES.
2805 # If the DIRECTORY_GRAPH tag is set to YES then Doxygen will show the
2806 # dependencies a directory has on other directories in a graphical way. The
2807 # dependency relations are determined by the #include relations between the
2808 # files in the directories. Explicit enabling a directory graph, when
2809 # DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
2811 # the command \hidedirectorygraph.
2812 # The default value is: YES.
2813 # This tag requires that the tag HAVE_DOT is set to YES.
2817 # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
2820 # This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2824 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2825 # generated by dot. For an explanation of the image formats see the section
2826 # output formats in the documentation of the dot tool (Graphviz (see:
2829 # to make the SVG files visible in IE 9+ (other browsers do not have this
2834 # The default value is: png.
2835 # This tag requires that the tag HAVE_DOT is set to YES.
2845 # the SVG files visible. Older versions of IE do not have SVG support.
2846 # The default value is: NO.
2847 # This tag requires that the tag HAVE_DOT is set to YES.
2851 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2852 # found. If left blank, it is assumed the dot tool can be found in the path.
2853 # This tag requires that the tag HAVE_DOT is set to YES.
2857 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2858 # contain dot files that are included in the documentation (see the \dotfile
2860 # This tag requires that the tag HAVE_DOT is set to YES.
2865 # then run dia to produce the diagram and insert it in the documentation. The
2866 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2867 # If left empty dia is assumed to be found in the default search path.
2871 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2872 # contain dia files that are included in the documentation (see the \diafile
2877 # When using PlantUML, the PLANTUML_JAR_PATH tag should be used to specify the
2878 # path where java can find the plantuml.jar file or to the filename of jar file
2881 # \startuml command in this case and will not generate output for the diagram.
2885 # When using PlantUML, the PLANTUML_CFG_FILE tag can be used to specify a
2890 # When using PlantUML, the specified paths are searched for files specified by
2891 # the !include statement in a PlantUML block.
2895 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2896 # that will be shown in the graph. If the number of nodes in a graph becomes
2897 # larger than this value, Doxygen will truncate the graph, which is visualized
2898 # by representing a node as a red box. Note that if the number of direct
2899 # children of the root node in a graph is already larger than
2900 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2901 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2903 # This tag requires that the tag HAVE_DOT is set to YES.
2907 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2908 # generated by dot. A depth value of 3 means that only nodes reachable from the
2910 # further from the root node will be omitted. Note that setting this option to 1
2911 # or 2 may greatly reduce the computation time needed for large code bases. Also
2912 # note that the size of a graph can be further restricted by
2915 # This tag requires that the tag HAVE_DOT is set to YES.
2919 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2920 # files in one run (i.e. multiple -o and -T options on the command line). This
2923 # The default value is: NO.
2924 # This tag requires that the tag HAVE_DOT is set to YES.
2928 # If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page
2929 # explaining the meaning of the various boxes and arrows in the dot generated
2931 # Note: This tag requires that UML_LOOK isn't set, i.e. the Doxygen internal
2933 # The default value is: YES.
2934 # This tag requires that the tag HAVE_DOT is set to YES.
2938 # If the DOT_CLEANUP tag is set to YES, Doxygen will remove the intermediate
2939 # files that are used to generate the various graphs.
2943 # The default value is: YES.
2947 # You can define message sequence charts within Doxygen comments using the \msc
2948 # command. If the MSCGEN_TOOL tag is left empty (the default), then Doxygen will
2949 # use a built-in version of mscgen tool to produce the charts. Alternatively,
2950 # the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
2951 # specifying prog as the value, Doxygen will call the tool as prog -T
2952 # <outfile_format> -o <outputfile> <inputfile>. The external tool should support
2957 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2958 # contain msc files that are included in the documentation (see the \mscfile