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:
20 # This tag specifies the encoding used for all characters in the config file
21 # that follow. The default is UTF-8 which is also the encoding used for all text
22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24 # for the list of possible encodings.
25 # The default value is: UTF-8.
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30 # double-quotes, unless you are using Doxywizard) that should identify the
31 # project for which the documentation is generated. This name is used in the
33 # The default value is: My Project.
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
44 # for a project that appears at the top of each page and should give viewer a
45 # quick idea about the purpose of the project. Keep the description short.
49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50 # the documentation. The maximum height of the logo should not exceed 55 pixels
51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52 # to the output directory.
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
64 # directories (in 2 levels) under the output directory of each output format and
65 # will distribute the generated files over these directories. Enabling this
67 # putting all generated files in the same directory would otherwise causes
68 # performance problems for the file system.
69 # The default value is: NO.
73 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
75 # information to generate all constant output in the proper language.
84 # The default value is: English.
88 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
89 # descriptions after the members that are listed in the file and class
91 # The default value is: YES.
95 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
96 # description of a member or function before the detailed description
98 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
100 # The default value is: YES.
105 # used to form the text in various listings. Each string in this list, if found
106 # as the leading text of the brief description, will be stripped from the text
107 # and the result, after processing the whole list, is used as the annotated
108 # text. Otherwise, the brief description is used as-is. If left blank, the
109 # following values are used ($name is automatically replaced with the name of
110 # the entity):The $name class, The $name widget, The $name file, is, provides,
111 # specifies, contains, represents, a, an and the.
115 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
118 # The default value is: NO.
122 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
123 # inherited members of a class in the documentation of that class as if those
125 # operators of the base classes will not be shown.
126 # The default value is: NO.
130 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
131 # before files name in the file list and in the header files. If set to NO the
132 # shortest path that makes the file name unique will be used
133 # The default value is: YES.
137 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
138 # Stripping is only done if one of the specified strings matches the left-hand
139 # part of the path. The tag can be used to show relative paths in the file list.
140 # If left blank the directory from which doxygen is run is used as the path to
144 # will be relative from the directory where doxygen is started.
145 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
149 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
150 # path mentioned in the documentation of a class, which tells the reader which
151 # header file to include in order to use a class. If left blank only the name of
152 # the header file containing the class definition is used. Otherwise one should
153 # specify the list of include paths that are normally passed to the compiler
154 # using the -I flag.
160 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
163 # The default value is: NO.
167 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
168 # first line (until the first dot) of a Javadoc-style comment as the brief
169 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
172 # The default value is: NO.
176 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
177 # line (until the first dot) of a Qt-style comment as the brief description. If
178 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
180 # The default value is: NO.
184 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
186 # a brief description. This used to be the default behavior. The new default is
188 # tag to YES if you prefer the old behavior instead.
192 # The default value is: NO.
196 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
198 # The default value is: YES.
202 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
203 # new page for each member. If set to NO, the documentation of a member will be
204 # part of the file/class/namespace that contains it.
205 # The default value is: NO.
209 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216 # the documentation. An alias has the form:
220 # will allow you to put the command \sideeffect (or @sideeffect) in the
222 # "Side Effects:". You can put \n's in the value part of an alias to insert
228 # A mapping has the form "name=value". For example adding "class=itcl::class"
229 # will allow you to use the command class in the itcl::class meaning.
233 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
235 # instance, some of the names that are used will be different. The list of all
237 # The default value is: NO.
241 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
245 # The default value is: NO.
249 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
251 # The default value is: NO.
255 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
257 # The default value is: NO.
261 # Doxygen selects the parser to use depending on the extension of the files it
264 # using this tag. The format is ext=language, where ext is a file extension, and
265 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
273 # the files are not read by doxygen.
277 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
278 # according to the Markdown format, which allows for more readable
280 # The output of markdown processing is further processed by doxygen, so you can
283 # The default value is: YES.
289 # be prevented in individual cases by by putting a % sign in front of the word
291 # The default value is: YES.
296 # to include (a tag file for) the STL sources as input, then you should set this
299 # versus func(std::string) {}). This also make the inheritance and collaboration
301 # The default value is: NO.
307 # The default value is: NO.
311 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
315 # The default value is: NO.
321 # doxygen to replace the get and set methods by a property in the documentation.
322 # This will only work if the methods are indeed getting or setting a simple
323 # type. If this is not the case, or you want to show the methods anyway, you
325 # The default value is: YES.
329 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
330 # tag is set to YES, then doxygen will reuse the documentation of the first
331 # member in the group (if any) for the other members of the group. By default
333 # The default value is: NO.
337 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
339 # type (e.g. under the Public Functions section). Set it to NO to prevent
340 # subgrouping. Alternatively, this can be done per class using the
342 # The default value is: YES.
346 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
347 # are shown inside the group in which they are included (e.g. using \ingroup)
353 # The default value is: NO.
357 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
359 # the documentation of the scope in which they are defined (i.e. file,
363 # The default value is: NO.
368 # enum is documented as struct, union, or enum with the name of the typedef. So
369 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
370 # with name TypeT. When disabled the typedef will appear as a member of a file,
371 # namespace, or class. And the struct will be named TypeS. This can typically be
372 # useful for C code in case the coding convention dictates that all compound
373 # types are typedef'ed and only the typedef is referenced, never the tag name.
374 # The default value is: NO.
378 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
380 # an expensive process and often the same symbol appears multiple times in the
381 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
382 # doxygen will become slower. If the cache is too large, memory is wasted. The
383 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
384 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
385 # symbols. At the end of a run doxygen will report the cache usage and suggest
386 # the optimal cache size from a speed point of view.
395 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
397 # class members and static file members will be hidden unless the
399 # Note: This will also disable the warnings about undocumented members that are
401 # The default value is: NO.
405 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
406 # be included in the documentation.
407 # The default value is: NO.
411 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
412 # scope will be included in the documentation.
413 # The default value is: NO.
417 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
418 # included in the documentation.
419 # The default value is: NO.
423 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
424 # locally in source files will be included in the documentation. If set to NO
427 # The default value is: YES.
432 # which are defined in the implementation section but not in the interface are
433 # included in the documentation. If set to NO only methods in the interface are
435 # The default value is: NO.
439 # If this flag is set to YES, the members of anonymous namespaces will be
440 # extracted and appear in the documentation as a namespace called
441 # 'anonymous_namespace{file}', where file will be replaced with the base name of
442 # the file that contains the anonymous namespace. By default anonymous namespace
444 # The default value is: NO.
448 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
450 # members will be included in the various overviews, but no documentation
452 # The default value is: NO.
456 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
457 # undocumented classes that are normally visible in the class hierarchy. If set
458 # to NO these classes will be included in the various overviews. This option has
460 # The default value is: NO.
464 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
466 # included in the documentation.
467 # The default value is: NO.
471 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
472 # documentation blocks found inside the body of a function. If set to NO these
473 # blocks will be appended to the function's detailed documentation block.
474 # The default value is: NO.
478 # The INTERNAL_DOCS tag determines if documentation that is typed after a
479 # \internal command is included. If the tag is set to NO then the documentation
480 # will be excluded. Set it to YES to include the internal documentation.
481 # The default value is: NO.
485 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
490 # The default value is: system dependent.
494 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
495 # their full class and namespace scopes in the documentation. If set to YES the
497 # The default value is: NO.
501 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
502 # the files that are included by a file in the documentation of that file.
503 # The default value is: YES.
507 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
508 # grouped member an include statement to the documentation, telling the reader
509 # which file to include in order to use the member.
510 # The default value is: NO.
514 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
515 # files with double quotes in the documentation rather than with sharp brackets.
516 # The default value is: NO.
520 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
522 # The default value is: YES.
526 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
528 # name. If set to NO the members will appear in declaration order.
529 # The default value is: YES.
533 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
535 # name. If set to NO the members will appear in declaration order. Note that
536 # this will also influence the order of the classes in the class list.
537 # The default value is: NO.
541 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
543 # destructors are listed first. If set to NO the constructors will appear in the
549 # The default value is: NO.
553 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
554 # of group names into alphabetical order. If set to NO the group names will
556 # The default value is: NO.
560 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
561 # fully-qualified names, including namespaces. If set to NO, the class list will
562 # be sorted only by class name, not including the namespace part.
564 # Note: This option applies only to the class list, not to the alphabetical
566 # The default value is: NO.
570 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
572 # the prototype and the implementation of a member function even if there is
576 # The default value is: NO.
580 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
581 # todo list. This list is created by putting \todo commands in the
583 # The default value is: YES.
587 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
588 # test list. This list is created by putting \test commands in the
590 # The default value is: YES.
594 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
595 # list. This list is created by putting \bug commands in the documentation.
596 # The default value is: YES.
600 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
601 # the deprecated list. This list is created by putting \deprecated commands in
602 # the documentation.
603 # The default value is: YES.
607 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
613 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
614 # initial value of a variable or macro / define can have for it to appear in the
615 # documentation. If the initializer consists of more lines than specified here
616 # it will be hidden. Use a value of 0 to hide initializers completely. The
617 # appearance of the value of individual variables and macros / defines can be
618 # controlled using \showinitializer or \hideinitializer command in the
624 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
625 # the bottom of the documentation of classes and structs. If set to YES the list
626 # will mention the files that were used to generate the documentation.
627 # The default value is: YES.
631 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
632 # will remove the Files entry from the Quick Index and from the Folder Tree View
634 # The default value is: YES.
638 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
639 # page. This will remove the Namespaces entry from the Quick Index and from the
641 # The default value is: YES.
645 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
646 # doxygen should invoke to get the current version for each file (typically from
647 # the version control system). Doxygen will invoke the program by executing (via
648 # popen()) the command command input-file, where command is the value of the
649 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
650 # by doxygen. Whatever the program writes to standard output is used as the file
651 # version. For an example see the documentation.
655 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
656 # by doxygen. The layout file controls the global structure of the generated
657 # output files in an output format independent way. To create the layout file
658 # that represents doxygen's defaults, run doxygen with the -l option. You can
659 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
660 # will be used as the name of the layout file.
663 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
668 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
669 # the reference definitions. This must be a list of .bib files. The .bib
670 # extension is automatically appended if omitted. This requires the bibtex tool
672 # For LaTeX the style of the bibliography can be controlled using
673 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
683 # The QUIET tag can be used to turn on/off the messages that are generated to
684 # standard output by doxygen. If QUIET is set to YES this implies that the
686 # The default value is: NO.
690 # The WARNINGS tag can be used to turn on/off the warning messages that are
692 # this implies that the warnings are on.
694 # Tip: Turn warnings on while writing the documentation.
695 # The default value is: YES.
699 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
702 # The default value is: YES.
706 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
707 # potential errors in the documentation, such as not documenting some parameters
710 # The default value is: YES.
717 # documentation, but not about the absence of documentation.
718 # The default value is: NO.
722 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
723 # can produce. The string should contain the $file, $line, and $text tags, which
724 # will be replaced by the file and line number from which the warning originated
725 # and the warning text. Optionally the format may contain $version, which will
726 # be replaced by the version of the file (if it could be obtained via
728 # The default value is: $file:$line: $text.
732 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
733 # messages should be written. If left blank the output is written to standard
739 # Configuration options related to the input files
742 # The INPUT tag is used to specify the files and/or directories that contain
744 # directories like /usr/src/myproject. Separate the files or directories with
746 # Note: If this tag is empty the current directory is searched.
753 # This tag can be used to specify the character encoding of the source files
754 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
755 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
756 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
758 # The default value is: UTF-8.
762 # If the value of the INPUT tag contains directories, you can use the
764 # *.h) to filter out the source-files in the directories. If left blank the
773 # The RECURSIVE tag can be used to specify whether or not subdirectories should
775 # The default value is: NO.
779 # The EXCLUDE tag can be used to specify files and/or directories that should be
780 # excluded from the INPUT source files. This way you can easily exclude a
781 # subdirectory from a directory tree whose root is specified with the INPUT tag.
783 # Note that relative paths are relative to the directory from which doxygen is
788 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
790 # from the input.
791 # The default value is: NO.
795 # If the value of the INPUT tag contains directories, you can use the
799 # Note that the wildcards are matched against the file with absolute path, so to
800 # exclude all test directories for example use the pattern */test/*
804 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
805 # (namespaces, classes, functions, etc.) that should be excluded from the
806 # output. The symbol name can be a fully qualified name, a word, or if the
810 # Note that the wildcards are matched against the file with absolute path, so to
811 # exclude all test directories use the pattern */test/*
815 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
816 # that contain example code fragments that are included (see the \include
821 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
823 # *.h) to filter out the source-files in the directories. If left blank all
828 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
829 # searched for input files to be used with the \include or \dontinclude commands
830 # irrespective of the value of the RECURSIVE tag.
831 # The default value is: NO.
835 # The IMAGE_PATH tag can be used to specify one or more files or directories
836 # that contain images that are to be included in the documentation (see the
841 # The INPUT_FILTER tag can be used to specify a program that doxygen should
842 # invoke to filter for each input file. Doxygen will invoke the filter program
843 # by executing (via popen()) the command:
847 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
848 # name of an input file. Doxygen will then use the output that the filter
852 # Note that the filter must not add or remove lines; it is applied before the
853 # code is scanned, but not when the output code is generated. If lines are added
854 # or removed, the anchors will not be placed correctly.
858 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
859 # basis. Doxygen will compare the file name with each pattern and apply the
860 # filter if there is a match. The filters are a list of the form: pattern=filter
862 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
863 # patterns match the file name, INPUT_FILTER is applied.
867 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
868 # INPUT_FILTER ) will also be used to filter the input files that are used for
869 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
870 # The default value is: NO.
874 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
875 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
878 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
882 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
883 # is part of the input, its contents will be placed on the main page
885 # and want to reuse the introduction page also for the doxygen output.
893 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
896 # Note: To get rid of all source code in the generated output, make sure that
898 # The default value is: NO.
902 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
903 # classes and enums directly into the documentation.
904 # The default value is: NO.
908 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
911 # The default value is: YES.
915 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
917 # The default value is: NO.
921 # If the REFERENCES_RELATION tag is set to YES then for each documented function
923 # The default value is: NO.
927 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
928 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
929 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
930 # link to the documentation.
931 # The default value is: YES.
935 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
937 # brief description and links to the definition and documentation. Since this
938 # will make the HTML file larger and loading of large files a bit slower, you
940 # The default value is: YES.
941 # This tag requires that the tag SOURCE_BROWSER is set to YES.
945 # If the USE_HTAGS tag is set to YES then the references to source code will
946 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
947 # source browser. The htags tool is part of GNU's global source tagging system
951 # To use it do the following:
952 # - Install the latest version of global
953 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
954 # - Make sure the INPUT points to the root of the source tree
958 # tools must be available from the command line (i.e. in the search path).
960 # The result: instead of the source browser generated by doxygen, the links to
961 # source code will now point to the output of htags.
962 # The default value is: NO.
963 # This tag requires that the tag SOURCE_BROWSER is set to YES.
967 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
968 # verbatim copy of the header file for each class for which an include is
971 # The default value is: YES.
976 # Configuration options related to the alphabetical class index
979 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
980 # compounds will be generated. Enable this if the project contains a lot of
982 # The default value is: YES.
986 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
987 # which the alphabetical index list will be split.
989 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
994 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
996 # while generating the index headers.
997 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1002 # Configuration options related to the HTML output
1005 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1006 # The default value is: YES.
1010 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1011 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1013 # The default directory is: html.
1014 # This tag requires that the tag GENERATE_HTML is set to YES.
1018 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1020 # The default value is: .html.
1021 # This tag requires that the tag GENERATE_HTML is set to YES.
1025 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1026 # each generated HTML page. If the tag is left blank doxygen will generate a
1029 # To get valid HTML the header file that includes any scripts and style sheets
1030 # that doxygen needs, which is dependent on the configuration options used (e.g.
1031 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1035 # and then modify the file new_header.html. See also section "Doxygen usage"
1036 # for information on how to generate the default header that doxygen normally
1038 # Note: The header is subject to change so you typically have to regenerate the
1040 # of the possible markers and block names see the documentation.
1041 # This tag requires that the tag GENERATE_HTML is set to YES.
1045 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1046 # generated HTML page. If the tag is left blank doxygen will generate a standard
1048 # footer and what special commands can be used inside the footer. See also
1049 # section "Doxygen usage" for information on how to generate the default footer
1051 # This tag requires that the tag GENERATE_HTML is set to YES.
1055 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1056 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1057 # the HTML output. If left blank doxygen will generate a default style sheet.
1058 # See also section "Doxygen usage" for information on how to generate the style
1061 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1063 # This tag requires that the tag GENERATE_HTML is set to YES.
1067 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1068 # defined cascading style sheet that is included after the standard style sheets
1070 # This is preferred over using HTML_STYLESHEET since it does not replace the
1072 # Doxygen will copy the style sheet file to the output directory. For an example
1073 # see the documentation.
1074 # This tag requires that the tag GENERATE_HTML is set to YES.
1078 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1079 # other source files which should be copied to the HTML output directory. Note
1080 # that these files will be copied to the base HTML output directory. Use the
1081 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1082 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1084 # This tag requires that the tag GENERATE_HTML is set to YES.
1088 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1089 # will adjust the colors in the stylesheet and background images according to
1091 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1095 # This tag requires that the tag GENERATE_HTML is set to YES.
1099 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1100 # in the HTML output. For a value of 0 the output will use grayscales only. A
1101 # value of 255 will produce the most vivid colors.
1103 # This tag requires that the tag GENERATE_HTML is set to YES.
1107 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1108 # luminance component of the colors in the HTML output. Values below 100
1109 # gradually make the output lighter, whereas values above 100 make the output
1110 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1111 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1112 # change the gamma.
1114 # This tag requires that the tag GENERATE_HTML is set to YES.
1118 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1119 # page will contain the date and time when the page was generated. Setting this
1120 # to NO can help when comparing the output of multiple runs.
1121 # The default value is: YES.
1122 # This tag requires that the tag GENERATE_HTML is set to YES.
1126 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1127 # documentation will contain sections that can be hidden and shown after the
1129 # The default value is: NO.
1130 # This tag requires that the tag GENERATE_HTML is set to YES.
1134 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1135 # shown in the various tree structured indices initially; the user can expand
1136 # and collapse entries dynamically later on. Doxygen will expand the tree to
1137 # such a level that at most the specified number of entries are visible (unless
1138 # a fully collapsed tree already exceeds this amount). So setting the number of
1143 # This tag requires that the tag GENERATE_HTML is set to YES.
1147 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1151 # Makefile in the HTML output directory. Running make will produce the docset in
1152 # that directory and running make install will install the docset in
1156 # The default value is: NO.
1157 # This tag requires that the tag GENERATE_HTML is set to YES.
1161 # This tag determines the name of the docset feed. A documentation feed provides
1164 # The default value is: Doxygen generated docs.
1165 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1169 # This tag specifies a string that should uniquely identify the documentation
1171 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1172 # The default value is: org.doxygen.Project.
1173 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1177 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1178 # the documentation publisher. This should be a reverse domain-name style
1180 # The default value is: org.doxygen.Publisher.
1181 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1185 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1186 # The default value is: Publisher.
1187 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1191 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1192 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1197 # The HTML Help Workshop contains a compiler that can convert all HTML output
1199 # files are now used as the Windows 98 help format, and will replace the old
1200 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1202 # words in the documentation. The HTML workshop also contains a viewer for
1204 # The default value is: NO.
1205 # This tag requires that the tag GENERATE_HTML is set to YES.
1209 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1210 # file. You can add a path in front of the file if the result should not be
1211 # written to the html output directory.
1212 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1216 # The HHC_LOCATION tag can be used to specify the location (absolute path
1217 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1218 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1219 # The file has to be specified with full path.
1220 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1224 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1225 # YES) or that it should be included in the main .chm file ( NO).
1226 # The default value is: NO.
1227 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1231 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1233 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1237 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1238 # YES) or a normal table of contents ( NO) in the .chm file.
1239 # The default value is: NO.
1240 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1244 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1245 # the table of contents of the HTML help documentation and to the tree view.
1246 # The default value is: NO.
1247 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1251 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1254 # (.qch) of the generated HTML documentation.
1255 # The default value is: NO.
1256 # This tag requires that the tag GENERATE_HTML is set to YES.
1260 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1261 # the file name of the resulting .qch file. The path specified is relative to
1262 # the HTML output folder.
1263 # This tag requires that the tag GENERATE_QHP is set to YES.
1267 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1270 # The default value is: org.doxygen.Project.
1271 # This tag requires that the tag GENERATE_QHP is set to YES.
1275 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1279 # The default value is: doc.
1280 # This tag requires that the tag GENERATE_QHP is set to YES.
1284 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1288 # This tag requires that the tag GENERATE_QHP is set to YES.
1292 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1296 # This tag requires that the tag GENERATE_QHP is set to YES.
1300 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1303 # This tag requires that the tag GENERATE_QHP is set to YES.
1307 # The QHG_LOCATION tag can be used to specify the location of Qt's
1308 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1310 # This tag requires that the tag GENERATE_QHP is set to YES.
1314 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1315 # generated, together with the HTML files, they form an Eclipse help plugin. To
1316 # install this plugin and make it available under the help contents menu in
1317 # Eclipse, the contents of the directory containing the HTML and XML files needs
1318 # to be copied into the plugins directory of eclipse. The name of the directory
1319 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1320 # After copying Eclipse needs to be restarted before the help appears.
1321 # The default value is: NO.
1322 # This tag requires that the tag GENERATE_HTML is set to YES.
1326 # A unique identifier for the Eclipse help plugin. When installing the plugin
1327 # the directory name containing the HTML and XML files should also have this
1329 # The default value is: org.doxygen.Project.
1330 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1334 # If you want full control over the layout of the generated HTML pages it might
1335 # be necessary to disable the index and replace it with your own. The
1336 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1337 # of each HTML page. A value of NO enables the index and the value YES disables
1338 # it. Since the tabs in the index contain the same information as the navigation
1340 # The default value is: NO.
1341 # This tag requires that the tag GENERATE_HTML is set to YES.
1345 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1346 # structure should be generated to display hierarchical information. If the tag
1348 # index structure (just like the one that is generated for HTML Help). For this
1350 # (i.e. any modern browser). Windows users are probably better off using the
1352 # further fine-tune the look of the index. As an example, the default style
1354 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1355 # the same information as the tab index, you could consider setting
1357 # The default value is: NO.
1358 # This tag requires that the tag GENERATE_HTML is set to YES.
1362 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1363 # doxygen will group on one line in the generated HTML documentation.
1365 # Note that a value of 0 will completely suppress the enum values from appearing
1366 # in the overview section.
1368 # This tag requires that the tag GENERATE_HTML is set to YES.
1372 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1373 # to set the initial width (in pixels) of the frame in which the tree is shown.
1375 # This tag requires that the tag GENERATE_HTML is set to YES.
1379 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1381 # The default value is: NO.
1382 # This tag requires that the tag GENERATE_HTML is set to YES.
1386 # Use this tag to change the font size of LaTeX formulas included as images in
1387 # the HTML documentation. When you change the font size after a successful
1388 # doxygen run you need to manually remove any form_*.png images from the HTML
1391 # This tag requires that the tag GENERATE_HTML is set to YES.
1395 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1400 # the HTML output directory before the changes have effect.
1401 # The default value is: YES.
1402 # This tag requires that the tag GENERATE_HTML is set to YES.
1406 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1407 # http://www.mathjax.org) which uses client side Javascript for the rendering
1409 # installed or if you want to formulas look prettier in the HTML output. When
1410 # enabled you may also need to install MathJax separately and configure the path
1411 # to it using the MATHJAX_RELPATH option.
1412 # The default value is: NO.
1413 # This tag requires that the tag GENERATE_HTML is set to YES.
1417 # When MathJax is enabled you can set the default output format to be used for
1418 # the MathJax output. See the MathJax site (see:
1420 # Possible values are: HTML-CSS (which is slower, but has the best
1422 # The default value is: HTML-CSS.
1423 # This tag requires that the tag USE_MATHJAX is set to YES.
1427 # When MathJax is enabled you need to specify the location relative to the HTML
1428 # output directory using the MATHJAX_RELPATH option. The destination directory
1429 # should contain the MathJax.js script. For instance, if the mathjax directory
1430 # is located at the same level as the HTML output directory, then
1431 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1432 # Content Delivery Network so you can quickly see the result without installing
1435 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1436 # This tag requires that the tag USE_MATHJAX is set to YES.
1440 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1443 # This tag requires that the tag USE_MATHJAX is set to YES.
1447 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1448 # of code that will be used on startup of the MathJax code. See the MathJax site
1450 # example see the documentation.
1451 # This tag requires that the tag USE_MATHJAX is set to YES.
1455 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1456 # the HTML output. The underlying search engine uses javascript and DHTML and
1460 # For large projects the javascript based search engine can be slow, then
1462 # search using the keyboard; to jump to the search box use <access key> + S
1463 # (what the <access key> is depends on the OS and browser, but it is typically
1464 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1465 # key> to jump into the search results window, the results can be navigated
1466 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1467 # the search. The filter options can be selected when the cursor is inside the
1468 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1469 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1471 # The default value is: YES.
1472 # This tag requires that the tag GENERATE_HTML is set to YES.
1476 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1478 # are two flavours of web server based searching depending on the
1480 # searching and an index file used by the script. When EXTERNAL_SEARCH is
1481 # enabled the indexing and searching needs to be provided by external tools. See
1482 # the section "External Indexing and Searching" for details.
1483 # The default value is: NO.
1484 # This tag requires that the tag SEARCHENGINE is set to YES.
1488 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1489 # script for searching. Instead the search results are written to an XML file
1491 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1495 # (doxysearch.cgi) which are based on the open source search engine library
1498 # See the section "External Indexing and Searching" for details.
1499 # The default value is: NO.
1500 # This tag requires that the tag SEARCHENGINE is set to YES.
1504 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1505 # which will return the search results when EXTERNAL_SEARCH is enabled.
1508 # (doxysearch.cgi) which are based on the open source search engine library
1509 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1511 # This tag requires that the tag SEARCHENGINE is set to YES.
1515 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1516 # search data is written to a file for indexing by an external tool. With the
1517 # SEARCHDATA_FILE tag the name of this file can be specified.
1518 # The default file is: searchdata.xml.
1519 # This tag requires that the tag SEARCHENGINE is set to YES.
1523 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1524 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1526 # projects and redirect the results back to the right project.
1527 # This tag requires that the tag SEARCHENGINE is set to YES.
1531 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1532 # projects other than the one defined by this configuration file, but that are
1533 # all added to the same external search index. Each project needs to have a
1534 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1535 # to a relative location where the documentation can be found. The format is:
1537 # This tag requires that the tag SEARCHENGINE is set to YES.
1542 # Configuration options related to the LaTeX output
1545 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1546 # The default value is: YES.
1550 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1551 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1553 # The default directory is: latex.
1554 # This tag requires that the tag GENERATE_LATEX is set to YES.
1558 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1562 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1563 # written to the output directory.
1564 # The default file is: latex.
1565 # This tag requires that the tag GENERATE_LATEX is set to YES.
1569 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1571 # The default file is: makeindex.
1572 # This tag requires that the tag GENERATE_LATEX is set to YES.
1576 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1579 # The default value is: NO.
1580 # This tag requires that the tag GENERATE_LATEX is set to YES.
1584 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1588 # The default value is: a4.
1589 # This tag requires that the tag GENERATE_LATEX is set to YES.
1593 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1594 # that should be included in the LaTeX output. To get the times font for
1598 # This tag requires that the tag GENERATE_LATEX is set to YES.
1602 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1603 # generated LaTeX document. The header should contain everything until the first
1605 # section "Doxygen usage" for information on how to let doxygen write the
1608 # Note: Only use a user-defined header if you know what you are doing! The
1609 # following commands have a special meaning inside the header: $title,
1611 # replace them by respectively the title of the page, the current date and time,
1612 # only the current date, the version number of doxygen, the project name (see
1613 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1614 # This tag requires that the tag GENERATE_LATEX is set to YES.
1618 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1619 # generated LaTeX document. The footer should contain everything after the last
1623 # This tag requires that the tag GENERATE_LATEX is set to YES.
1627 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1628 # other source files which should be copied to the LATEX_OUTPUT output
1629 # directory. Note that the files will be copied as-is; there are no commands or
1631 # This tag requires that the tag GENERATE_LATEX is set to YES.
1635 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1636 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1637 # contain links (just like the HTML output) instead of page references. This
1638 # makes the output suitable for online browsing using a PDF viewer.
1639 # The default value is: YES.
1640 # This tag requires that the tag GENERATE_LATEX is set to YES.
1644 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1645 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1647 # The default value is: YES.
1648 # This tag requires that the tag GENERATE_LATEX is set to YES.
1652 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1653 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1654 # if errors occur, instead of asking the user for help. This option is also used
1656 # The default value is: NO.
1657 # This tag requires that the tag GENERATE_LATEX is set to YES.
1661 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1662 # index chapters (such as File Index, Compound Index, etc.) in the output.
1663 # The default value is: NO.
1664 # This tag requires that the tag GENERATE_LATEX is set to YES.
1668 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1669 # code with syntax highlighting in the LaTeX output.
1673 # The default value is: NO.
1674 # This tag requires that the tag GENERATE_LATEX is set to YES.
1678 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1681 # The default value is: plain.
1682 # This tag requires that the tag GENERATE_LATEX is set to YES.
1687 # Configuration options related to the RTF output
1690 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1693 # The default value is: NO.
1697 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1698 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1700 # The default directory is: rtf.
1701 # This tag requires that the tag GENERATE_RTF is set to YES.
1705 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1708 # The default value is: NO.
1709 # This tag requires that the tag GENERATE_RTF is set to YES.
1713 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1714 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1715 # output) instead of page references. This makes the output suitable for online
1720 # The default value is: NO.
1721 # This tag requires that the tag GENERATE_RTF is set to YES.
1729 # See also section "Doxygen usage" for information on how to generate the
1731 # This tag requires that the tag GENERATE_RTF is set to YES.
1735 # Set optional variables used in the generation of an RTF document. Syntax is
1738 # This tag requires that the tag GENERATE_RTF is set to YES.
1743 # Configuration options related to the man page output
1746 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1748 # The default value is: NO.
1752 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1753 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1754 # it. A directory man3 will be created inside the directory specified by
1756 # The default directory is: man.
1757 # This tag requires that the tag GENERATE_MAN is set to YES.
1761 # The MAN_EXTENSION tag determines the extension that is added to the generated
1762 # man pages. In case the manual section does not start with a number, the number
1763 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1765 # The default value is: .3.
1766 # This tag requires that the tag GENERATE_MAN is set to YES.
1770 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1771 # will generate one additional man file for each entity documented in the real
1772 # man page(s). These additional files only source the real man page, but without
1773 # them the man command would be unable to find the correct page.
1774 # The default value is: NO.
1775 # This tag requires that the tag GENERATE_MAN is set to YES.
1780 # Configuration options related to the XML output
1783 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1784 # captures the structure of the code including all documentation.
1785 # The default value is: NO.
1789 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1790 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1792 # The default directory is: xml.
1793 # This tag requires that the tag GENERATE_XML is set to YES.
1797 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1798 # validating XML parser to check the syntax of the XML files.
1799 # This tag requires that the tag GENERATE_XML is set to YES.
1803 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1804 # validating XML parser to check the syntax of the XML files.
1805 # This tag requires that the tag GENERATE_XML is set to YES.
1809 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1811 # the XML output. Note that enabling this will significantly increase the size
1812 # of the XML output.
1813 # The default value is: YES.
1814 # This tag requires that the tag GENERATE_XML is set to YES.
1819 # Configuration options related to the DOCBOOK output
1822 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1824 # The default value is: NO.
1828 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1829 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1831 # The default directory is: docbook.
1832 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1837 # Configuration options for the AutoGen Definitions output
1840 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1841 # Definitions (see http://autogen.sf.net) file that captures the structure of
1842 # the code including all documentation. Note that this feature is still
1843 # experimental and incomplete at the moment.
1844 # The default value is: NO.
1849 # Configuration options related to the Perl module output
1852 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1853 # file that captures the structure of the code including all documentation.
1855 # Note that this feature is still experimental and incomplete at the moment.
1856 # The default value is: NO.
1860 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1862 # output from the Perl module output.
1863 # The default value is: NO.
1864 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1868 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1870 # understand what is going on. On the other hand, if this tag is set to NO the
1871 # size of the Perl module output will be much smaller and Perl will parse it
1872 # just the same.
1873 # The default value is: YES.
1874 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1878 # The names of the make variables in the generated doxyrules.make file are
1879 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1880 # so different doxyrules.make files included by the same Makefile don't
1882 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1887 # Configuration options related to the preprocessor
1890 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1891 # C-preprocessor directives found in the sources and include files.
1892 # The default value is: YES.
1896 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1897 # in the source code. If set to NO only conditional compilation will be
1900 # The default value is: NO.
1901 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1905 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1906 # the macro expansion is limited to the macros specified with the PREDEFINED and
1908 # The default value is: NO.
1909 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1913 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1915 # The default value is: YES.
1916 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1920 # The INCLUDE_PATH tag can be used to specify one or more directories that
1921 # contain include files that are not input files but should be processed by the
1923 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1927 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1928 # patterns (like *.h and *.hpp) to filter out the header-files in the
1929 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1931 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1935 # The PREDEFINED tag can be used to specify one or more macro names that are
1936 # defined before the preprocessor is started (similar to the -D option of e.g.
1937 # gcc). The argument of the tag is a list of macros of the form: name or
1938 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1940 # recursively expanded use the := operator instead of the = operator.
1941 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1945 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1946 # tag can be used to specify a list of macro names that should be expanded. The
1947 # macro definition that is found in the sources will be used. Use the PREDEFINED
1948 # tag if you want to use a different macro definition that overrules the
1949 # definition found in the source code.
1950 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1954 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1957 # typically used for boiler-plate code, and will confuse the parser if not
1959 # The default value is: YES.
1960 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1968 # The TAGFILES tag can be used to specify one or more tag files. For each tag
1969 # file the location of the external documentation should be added. The format of
1972 # Adding location for the tag files is done as follows:
1974 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
1975 # section "Linking to external documentation" for more information about the use
1977 # Note: Each tag file must have an unique name (where the name does NOT include
1978 # the path). If a tag file is not located in the directory in which doxygen is
1979 # run, you must also specify the path to the tagfile here.
1984 # tag file that is based on the input files it reads. See section "Linking to
1985 # external documentation" for more information about the usage of tag files.
1989 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1990 # class index. If set to NO only the inherited external classes will be listed.
1991 # The default value is: NO.
1995 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
1996 # the modules index. If set to NO, only the current project's groups will be
1998 # The default value is: YES.
2002 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2003 # the related pages index. If set to NO, only the current project's pages will
2005 # The default value is: YES.
2009 # The PERL_PATH should be the absolute path and name of the perl script
2010 # interpreter (i.e. the result of 'which perl').
2011 # The default file (with absolute path) is: /usr/bin/perl.
2016 # Configuration options related to the dot tool
2019 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2020 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2021 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2024 # The default value is: YES.
2028 # You can define message sequence charts within doxygen comments using the \msc
2029 # command. Doxygen will then run the mscgen tool (see:
2030 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2031 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2032 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2038 # then run dia to produce the diagram and insert it in the documentation. The
2039 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2040 # If left empty dia is assumed to be found in the default search path.
2044 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2045 # and usage relations if the target is undocumented or is not a class.
2046 # The default value is: YES.
2050 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2051 # available from the path. This tool is part of Graphviz (see:
2053 # Bell Labs. The other options in this section have no effect if this option is
2055 # The default value is: NO.
2059 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2060 # to run in parallel. When set to 0 doxygen will base this on the number of
2061 # processors available in the system. You can set it explicitly to a value
2062 # larger than 0 to get control over the balance between CPU load and processing
2065 # This tag requires that the tag HAVE_DOT is set to YES.
2069 # When you want a differently looking font n the dot files that doxygen
2070 # generates you can specify the font name using DOT_FONTNAME. You need to make
2071 # sure dot is able to find the font, which can be done by putting it in a
2072 # standard location or by setting the DOTFONTPATH environment variable or by
2073 # setting DOT_FONTPATH to the directory containing the font.
2074 # The default value is: Helvetica.
2075 # This tag requires that the tag HAVE_DOT is set to YES.
2079 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2082 # This tag requires that the tag HAVE_DOT is set to YES.
2086 # By default doxygen will tell dot to use the default font as specified with
2088 # the path where dot can find it using this tag.
2089 # This tag requires that the tag HAVE_DOT is set to YES.
2093 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2094 # each documented class showing the direct and indirect inheritance relations.
2095 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2096 # The default value is: YES.
2097 # This tag requires that the tag HAVE_DOT is set to YES.
2101 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2102 # graph for each documented class showing the direct and indirect implementation
2103 # dependencies (inheritance, containment, and class references variables) of the
2105 # The default value is: YES.
2106 # This tag requires that the tag HAVE_DOT is set to YES.
2110 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2111 # groups, showing the direct groups dependencies.
2112 # The default value is: YES.
2113 # This tag requires that the tag HAVE_DOT is set to YES.
2117 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2118 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2120 # The default value is: NO.
2121 # This tag requires that the tag HAVE_DOT is set to YES.
2125 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2126 # class node. If there are many fields or methods and many nodes the graph may
2127 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2128 # number of items for each type to make the size more manageable. Set this to 0
2129 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2130 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2131 # but if the number exceeds 15, the total amount of fields shown is limited to
2134 # This tag requires that the tag HAVE_DOT is set to YES.
2138 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2139 # collaboration graphs will show the relations between templates and their
2141 # The default value is: NO.
2142 # This tag requires that the tag HAVE_DOT is set to YES.
2146 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2147 # YES then doxygen will generate a graph for each documented file showing the
2148 # direct and indirect include dependencies of the file with other documented
2150 # The default value is: YES.
2151 # This tag requires that the tag HAVE_DOT is set to YES.
2155 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2157 # the direct and indirect include dependencies of the file with other documented
2159 # The default value is: YES.
2160 # This tag requires that the tag HAVE_DOT is set to YES.
2164 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2167 # Note that enabling this option will significantly increase the time of a run.
2169 # functions only using the \callgraph command.
2170 # The default value is: NO.
2171 # This tag requires that the tag HAVE_DOT is set to YES.
2175 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2178 # Note that enabling this option will significantly increase the time of a run.
2180 # functions only using the \callergraph command.
2181 # The default value is: NO.
2182 # This tag requires that the tag HAVE_DOT is set to YES.
2186 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2188 # The default value is: YES.
2189 # This tag requires that the tag HAVE_DOT is set to YES.
2193 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2194 # dependencies a directory has on other directories in a graphical way. The
2195 # dependency relations are determined by the #include relations between the
2196 # files in the directories.
2197 # The default value is: YES.
2198 # This tag requires that the tag HAVE_DOT is set to YES.
2202 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2205 # to make the SVG files visible in IE 9+ (other browsers do not have this
2208 # The default value is: png.
2209 # This tag requires that the tag HAVE_DOT is set to YES.
2219 # the SVG files visible. Older versions of IE do not have SVG support.
2220 # The default value is: NO.
2221 # This tag requires that the tag HAVE_DOT is set to YES.
2225 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2226 # found. If left blank, it is assumed the dot tool can be found in the path.
2227 # This tag requires that the tag HAVE_DOT is set to YES.
2231 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2232 # contain dot files that are included in the documentation (see the \dotfile
2234 # This tag requires that the tag HAVE_DOT is set to YES.
2238 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2239 # contain msc files that are included in the documentation (see the \mscfile
2244 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2245 # contain dia files that are included in the documentation (see the \diafile
2250 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2251 # that will be shown in the graph. If the number of nodes in a graph becomes
2252 # larger than this value, doxygen will truncate the graph, which is visualized
2253 # by representing a node as a red box. Note that doxygen if the number of direct
2254 # children of the root node in a graph is already larger than
2255 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2256 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2258 # This tag requires that the tag HAVE_DOT is set to YES.
2262 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2263 # generated by dot. A depth value of 3 means that only nodes reachable from the
2265 # further from the root node will be omitted. Note that setting this option to 1
2266 # or 2 may greatly reduce the computation time needed for large code bases. Also
2267 # note that the size of a graph can be further restricted by
2270 # This tag requires that the tag HAVE_DOT is set to YES.
2274 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2276 # to support this out of the box.
2278 # Warning: Depending on the platform used, enabling this option may lead to
2279 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2281 # The default value is: NO.
2282 # This tag requires that the tag HAVE_DOT is set to YES.
2286 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2287 # files in one run (i.e. multiple -o and -T options on the command line). This
2290 # The default value is: NO.
2291 # This tag requires that the tag HAVE_DOT is set to YES.
2295 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2296 # explaining the meaning of the various boxes and arrows in the dot generated
2298 # The default value is: YES.
2299 # This tag requires that the tag HAVE_DOT is set to YES.
2303 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2304 # files that are used to generate the various graphs.
2305 # The default value is: YES.
2306 # This tag requires that the tag HAVE_DOT is set to YES.