doxyfile.in - OpenGrok cross reference for /external/jsoncpp/doc/doxyfile.in

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.
82 # The default value is: English.
86 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
87 # descriptions after the members that are listed in the file and class
89 # The default value is: YES.
93 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
94 # description of a member or function before the detailed description
96 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
98 # The default value is: YES.
103 # used to form the text in various listings. Each string in this list, if found
104 # as the leading text of the brief description, will be stripped from the text
105 # and the result, after processing the whole list, is used as the annotated
106 # text. Otherwise, the brief description is used as-is. If left blank, the
107 # following values are used ($name is automatically replaced with the name of
108 # the entity):The $name class, The $name widget, The $name file, is, provides,
109 # specifies, contains, represents, a, an and the.
111 ABBREVIATE_BRIEF       = "The $name class" \
112                          "The $name widget" \
113                          "The $name file" \
121                          the
123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
126 # The default value is: NO.
130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131 # inherited members of a class in the documentation of that class as if those
133 # operators of the base classes will not be shown.
134 # The default value is: NO.
138 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
139 # before files name in the file list and in the header files. If set to NO the
140 # shortest path that makes the file name unique will be used
141 # The default value is: YES.
145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146 # Stripping is only done if one of the specified strings matches the left-hand
147 # part of the path. The tag can be used to show relative paths in the file list.
148 # If left blank the directory from which doxygen is run is used as the path to
152 # will be relative from the directory where doxygen is started.
153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158 # path mentioned in the documentation of a class, which tells the reader which
159 # header file to include in order to use a class. If left blank only the name of
160 # the header file containing the class definition is used. Otherwise one should
161 # specify the list of include paths that are normally passed to the compiler
162 # using the -I flag.
166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
169 # The default value is: NO.
173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174 # first line (until the first dot) of a Javadoc-style comment as the brief
175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
178 # The default value is: NO.
182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183 # line (until the first dot) of a Qt-style comment as the brief description. If
184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
186 # The default value is: NO.
190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
192 # a brief description. This used to be the default behavior. The new default is
194 # tag to YES if you prefer the old behavior instead.
198 # The default value is: NO.
202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
204 # The default value is: YES.
208 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
209 # new page for each member. If set to NO, the documentation of a member will be
210 # part of the file/class/namespace that contains it.
211 # The default value is: NO.
215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
222 # the documentation. An alias has the form:
226 # will allow you to put the command \sideeffect (or @sideeffect) in the
228 # "Side Effects:". You can put \n's in the value part of an alias to insert
237 # A mapping has the form "name=value". For example adding "class=itcl::class"
238 # will allow you to use the command class in the itcl::class meaning.
242 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
244 # instance, some of the names that are used will be different. The list of all
246 # The default value is: NO.
250 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
254 # The default value is: NO.
258 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
260 # The default value is: NO.
264 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
266 # The default value is: NO.
270 # Doxygen selects the parser to use depending on the extension of the files it
273 # using this tag. The format is ext=language, where ext is a file extension, and
274 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
282 # the files are not read by doxygen.
286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287 # according to the Markdown format, which allows for more readable
289 # The output of markdown processing is further processed by doxygen, so you can
292 # The default value is: YES.
298 # be prevented in individual cases by by putting a % sign in front of the word
300 # The default value is: YES.
305 # to include (a tag file for) the STL sources as input, then you should set this
308 # versus func(std::string) {}). This also make the inheritance and collaboration
310 # The default value is: NO.
316 # The default value is: NO.
320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
324 # The default value is: NO.
330 # doxygen to replace the get and set methods by a property in the documentation.
331 # This will only work if the methods are indeed getting or setting a simple
332 # type. If this is not the case, or you want to show the methods anyway, you
334 # The default value is: YES.
338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339 # tag is set to YES, then doxygen will reuse the documentation of the first
340 # member in the group (if any) for the other members of the group. By default
342 # The default value is: NO.
346 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
348 # type (e.g. under the Public Functions section). Set it to NO to prevent
349 # subgrouping. Alternatively, this can be done per class using the
351 # The default value is: YES.
355 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
356 # are shown inside the group in which they are included (e.g. using \ingroup)
362 # The default value is: NO.
366 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
368 # the documentation of the scope in which they are defined (i.e. file,
372 # The default value is: NO.
377 # enum is documented as struct, union, or enum with the name of the typedef. So
378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
379 # with name TypeT. When disabled the typedef will appear as a member of a file,
380 # namespace, or class. And the struct will be named TypeS. This can typically be
381 # useful for C code in case the coding convention dictates that all compound
382 # types are typedef'ed and only the typedef is referenced, never the tag name.
383 # The default value is: NO.
387 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
389 # an expensive process and often the same symbol appears multiple times in the
390 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
391 # doxygen will become slower. If the cache is too large, memory is wasted. The
392 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
393 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
394 # symbols. At the end of a run doxygen will report the cache usage and suggest
395 # the optimal cache size from a speed point of view.
404 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
406 # class members and static file members will be hidden unless the
408 # Note: This will also disable the warnings about undocumented members that are
410 # The default value is: NO.
414 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
415 # be included in the documentation.
416 # The default value is: NO.
420 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
421 # scope will be included in the documentation.
422 # The default value is: NO.
426 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
427 # included in the documentation.
428 # The default value is: NO.
432 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
433 # locally in source files will be included in the documentation. If set to NO
436 # The default value is: YES.
441 # which are defined in the implementation section but not in the interface are
442 # included in the documentation. If set to NO only methods in the interface are
444 # The default value is: NO.
448 # If this flag is set to YES, the members of anonymous namespaces will be
449 # extracted and appear in the documentation as a namespace called
450 # 'anonymous_namespace{file}', where file will be replaced with the base name of
451 # the file that contains the anonymous namespace. By default anonymous namespace
453 # The default value is: NO.
457 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
459 # members will be included in the various overviews, but no documentation
461 # The default value is: NO.
465 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
466 # undocumented classes that are normally visible in the class hierarchy. If set
467 # to NO these classes will be included in the various overviews. This option has
469 # The default value is: NO.
473 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
475 # included in the documentation.
476 # The default value is: NO.
480 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
481 # documentation blocks found inside the body of a function. If set to NO these
482 # blocks will be appended to the function's detailed documentation block.
483 # The default value is: NO.
487 # The INTERNAL_DOCS tag determines if documentation that is typed after a
488 # \internal command is included. If the tag is set to NO then the documentation
489 # will be excluded. Set it to YES to include the internal documentation.
490 # The default value is: NO.
494 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
499 # The default value is: system dependent.
503 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
504 # their full class and namespace scopes in the documentation. If set to YES the
506 # The default value is: NO.
510 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
511 # the files that are included by a file in the documentation of that file.
512 # The default value is: YES.
516 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
517 # files with double quotes in the documentation rather than with sharp brackets.
518 # The default value is: NO.
522 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
524 # The default value is: YES.
528 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
530 # name. If set to NO the members will appear in declaration order.
531 # The default value is: YES.
535 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
537 # name. If set to NO the members will appear in declaration order.
538 # The default value is: NO.
542 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
544 # destructors are listed first. If set to NO the constructors will appear in the
550 # The default value is: NO.
554 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
555 # of group names into alphabetical order. If set to NO the group names will
557 # The default value is: NO.
561 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
562 # fully-qualified names, including namespaces. If set to NO, the class list will
563 # be sorted only by class name, not including the namespace part.
565 # Note: This option applies only to the class list, not to the alphabetical
567 # The default value is: NO.
571 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
573 # the prototype and the implementation of a member function even if there is
577 # The default value is: NO.
581 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
582 # todo list. This list is created by putting \todo commands in the
584 # The default value is: YES.
588 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
589 # test list. This list is created by putting \test commands in the
591 # The default value is: YES.
595 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
596 # list. This list is created by putting \bug commands in the documentation.
597 # The default value is: YES.
601 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
602 # the deprecated list. This list is created by putting \deprecated commands in
603 # the documentation.
604 # The default value is: YES.
608 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
614 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
615 # initial value of a variable or macro / define can have for it to appear in the
616 # documentation. If the initializer consists of more lines than specified here
617 # it will be hidden. Use a value of 0 to hide initializers completely. The
618 # appearance of the value of individual variables and macros / defines can be
619 # controlled using \showinitializer or \hideinitializer command in the
625 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
626 # the bottom of the documentation of classes and structs. If set to YES the list
627 # will mention the files that were used to generate the documentation.
628 # The default value is: YES.
632 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
633 # will remove the Files entry from the Quick Index and from the Folder Tree View
635 # The default value is: YES.
639 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
640 # page. This will remove the Namespaces entry from the Quick Index and from the
642 # The default value is: YES.
646 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
647 # doxygen should invoke to get the current version for each file (typically from
648 # the version control system). Doxygen will invoke the program by executing (via
649 # popen()) the command command input-file, where command is the value of the
650 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
651 # by doxygen. Whatever the program writes to standard output is used as the file
652 # version. For an example see the documentation.
656 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
657 # by doxygen. The layout file controls the global structure of the generated
658 # output files in an output format independent way. To create the layout file
659 # that represents doxygen's defaults, run doxygen with the -l option. You can
660 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
661 # will be used as the name of the layout file.
664 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
669 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
670 # the reference definitions. This must be a list of .bib files. The .bib
671 # extension is automatically appended if omitted. This requires the bibtex tool
673 # For LaTeX the style of the bibliography can be controlled using
674 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
684 # The QUIET tag can be used to turn on/off the messages that are generated to
685 # standard output by doxygen. If QUIET is set to YES this implies that the
687 # The default value is: NO.
691 # The WARNINGS tag can be used to turn on/off the warning messages that are
693 # this implies that the warnings are on.
695 # Tip: Turn warnings on while writing the documentation.
696 # The default value is: YES.
700 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
703 # The default value is: YES.
707 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
708 # potential errors in the documentation, such as not documenting some parameters
711 # The default value is: YES.
718 # documentation, but not about the absence of documentation.
719 # The default value is: NO.
723 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
724 # can produce. The string should contain the $file, $line, and $text tags, which
725 # will be replaced by the file and line number from which the warning originated
726 # and the warning text. Optionally the format may contain $version, which will
727 # be replaced by the version of the file (if it could be obtained via
729 # The default value is: $file:$line: $text.
733 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
734 # messages should be written. If left blank the output is written to standard
740 # Configuration options related to the input files
743 # The INPUT tag is used to specify the files and/or directories that contain
745 # directories like /usr/src/myproject. Separate the files or directories with
747 # 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
776 # The RECURSIVE tag can be used to specify whether or not subdirectories should
778 # The default value is: NO.
782 # The EXCLUDE tag can be used to specify files and/or directories that should be
783 # excluded from the INPUT source files. This way you can easily exclude a
784 # subdirectory from a directory tree whose root is specified with the INPUT tag.
786 # Note that relative paths are relative to the directory from which doxygen is
791 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
793 # from the input.
794 # The default value is: NO.
798 # If the value of the INPUT tag contains directories, you can use the
802 # Note that the wildcards are matched against the file with absolute path, so to
803 # exclude all test directories for example use the pattern */test/*
807 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
808 # (namespaces, classes, functions, etc.) that should be excluded from the
809 # output. The symbol name can be a fully qualified name, a word, or if the
813 # Note that the wildcards are matched against the file with absolute path, so to
814 # exclude all test directories use the pattern */test/*
818 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
819 # that contain example code fragments that are included (see the \include
824 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
826 # *.h) to filter out the source-files in the directories. If left blank all
831 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
832 # searched for input files to be used with the \include or \dontinclude commands
833 # irrespective of the value of the RECURSIVE tag.
834 # The default value is: NO.
838 # The IMAGE_PATH tag can be used to specify one or more files or directories
839 # that contain images that are to be included in the documentation (see the
844 # The INPUT_FILTER tag can be used to specify a program that doxygen should
845 # invoke to filter for each input file. Doxygen will invoke the filter program
846 # by executing (via popen()) the command:
850 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
851 # name of an input file. Doxygen will then use the output that the filter
855 # Note that the filter must not add or remove lines; it is applied before the
856 # code is scanned, but not when the output code is generated. If lines are added
857 # or removed, the anchors will not be placed correctly.
861 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
862 # basis. Doxygen will compare the file name with each pattern and apply the
863 # filter if there is a match. The filters are a list of the form: pattern=filter
865 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
866 # patterns match the file name, INPUT_FILTER is applied.
870 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
871 # INPUT_FILTER ) will also be used to filter the input files that are used for
872 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
873 # The default value is: NO.
877 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
878 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
881 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
885 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
886 # is part of the input, its contents will be placed on the main page
888 # and want to reuse the introduction page also for the doxygen output.
896 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
899 # Note: To get rid of all source code in the generated output, make sure that
901 # The default value is: NO.
905 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
906 # classes and enums directly into the documentation.
907 # The default value is: NO.
911 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
914 # The default value is: YES.
918 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
920 # The default value is: NO.
924 # If the REFERENCES_RELATION tag is set to YES then for each documented function
926 # The default value is: NO.
930 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
931 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
932 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
933 # link to the documentation.
934 # The default value is: YES.
938 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
940 # brief description and links to the definition and documentation. Since this
941 # will make the HTML file larger and loading of large files a bit slower, you
943 # The default value is: YES.
944 # This tag requires that the tag SOURCE_BROWSER is set to YES.
948 # If the USE_HTAGS tag is set to YES then the references to source code will
949 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
950 # source browser. The htags tool is part of GNU's global source tagging system
954 # To use it do the following:
955 # - Install the latest version of global
956 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
957 # - Make sure the INPUT points to the root of the source tree
961 # tools must be available from the command line (i.e. in the search path).
963 # The result: instead of the source browser generated by doxygen, the links to
964 # source code will now point to the output of htags.
965 # The default value is: NO.
966 # This tag requires that the tag SOURCE_BROWSER is set to YES.
970 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
971 # verbatim copy of the header file for each class for which an include is
974 # The default value is: YES.
979 # Configuration options related to the alphabetical class index
982 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
983 # compounds will be generated. Enable this if the project contains a lot of
985 # The default value is: YES.
989 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
990 # which the alphabetical index list will be split.
992 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
997 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
999 # while generating the index headers.
1000 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1005 # Configuration options related to the HTML output
1008 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1009 # The default value is: YES.
1013 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1014 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1016 # The default directory is: html.
1017 # This tag requires that the tag GENERATE_HTML is set to YES.
1021 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1023 # The default value is: .html.
1024 # This tag requires that the tag GENERATE_HTML is set to YES.
1028 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1029 # each generated HTML page. If the tag is left blank doxygen will generate a
1032 # To get valid HTML the header file that includes any scripts and style sheets
1033 # that doxygen needs, which is dependent on the configuration options used (e.g.
1034 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1038 # and then modify the file new_header.html. See also section "Doxygen usage"
1039 # for information on how to generate the default header that doxygen normally
1041 # Note: The header is subject to change so you typically have to regenerate the
1043 # of the possible markers and block names see the documentation.
1044 # This tag requires that the tag GENERATE_HTML is set to YES.
1048 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1049 # generated HTML page. If the tag is left blank doxygen will generate a standard
1051 # footer and what special commands can be used inside the footer. See also
1052 # section "Doxygen usage" for information on how to generate the default footer
1054 # This tag requires that the tag GENERATE_HTML is set to YES.
1058 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1059 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1060 # the HTML output. If left blank doxygen will generate a default style sheet.
1061 # See also section "Doxygen usage" for information on how to generate the style
1064 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1066 # This tag requires that the tag GENERATE_HTML is set to YES.
1070 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1071 # defined cascading style sheet that is included after the standard style sheets
1073 # This is preferred over using HTML_STYLESHEET since it does not replace the
1075 # Doxygen will copy the style sheet file to the output directory. For an example
1076 # see the documentation.
1077 # This tag requires that the tag GENERATE_HTML is set to YES.
1081 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1082 # other source files which should be copied to the HTML output directory. Note
1083 # that these files will be copied to the base HTML output directory. Use the
1084 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1085 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1087 # This tag requires that the tag GENERATE_HTML is set to YES.
1091 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1092 # will adjust the colors in the stylesheet and background images according to
1094 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1098 # This tag requires that the tag GENERATE_HTML is set to YES.
1102 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1103 # in the HTML output. For a value of 0 the output will use grayscales only. A
1104 # value of 255 will produce the most vivid colors.
1106 # This tag requires that the tag GENERATE_HTML is set to YES.
1110 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1111 # luminance component of the colors in the HTML output. Values below 100
1112 # gradually make the output lighter, whereas values above 100 make the output
1113 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1114 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1115 # change the gamma.
1117 # This tag requires that the tag GENERATE_HTML is set to YES.
1121 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1122 # page will contain the date and time when the page was generated. Setting this
1123 # to NO can help when comparing the output of multiple runs.
1124 # The default value is: YES.
1125 # This tag requires that the tag GENERATE_HTML is set to YES.
1129 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1130 # documentation will contain sections that can be hidden and shown after the
1132 # The default value is: NO.
1133 # This tag requires that the tag GENERATE_HTML is set to YES.
1137 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1138 # shown in the various tree structured indices initially; the user can expand
1139 # and collapse entries dynamically later on. Doxygen will expand the tree to
1140 # such a level that at most the specified number of entries are visible (unless
1141 # a fully collapsed tree already exceeds this amount). So setting the number of
1146 # This tag requires that the tag GENERATE_HTML is set to YES.
1150 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1154 # Makefile in the HTML output directory. Running make will produce the docset in
1155 # that directory and running make install will install the docset in
1159 # The default value is: NO.
1160 # This tag requires that the tag GENERATE_HTML is set to YES.
1164 # This tag determines the name of the docset feed. A documentation feed provides
1167 # The default value is: Doxygen generated docs.
1168 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1172 # This tag specifies a string that should uniquely identify the documentation
1174 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1175 # The default value is: org.doxygen.Project.
1176 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1180 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1181 # the documentation publisher. This should be a reverse domain-name style
1183 # The default value is: org.doxygen.Publisher.
1184 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1188 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1189 # The default value is: Publisher.
1190 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1194 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1195 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1200 # The HTML Help Workshop contains a compiler that can convert all HTML output
1202 # files are now used as the Windows 98 help format, and will replace the old
1203 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1205 # words in the documentation. The HTML workshop also contains a viewer for
1207 # The default value is: NO.
1208 # This tag requires that the tag GENERATE_HTML is set to YES.
1212 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1213 # file. You can add a path in front of the file if the result should not be
1214 # written to the html output directory.
1215 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1219 # The HHC_LOCATION tag can be used to specify the location (absolute path
1220 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1221 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1222 # The file has to be specified with full path.
1223 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1227 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1228 # YES) or that it should be included in the master .chm file ( NO).
1229 # The default value is: NO.
1230 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1234 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1236 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1240 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1241 # YES) or a normal table of contents ( NO) in the .chm file.
1242 # The default value is: NO.
1243 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1247 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1248 # the table of contents of the HTML help documentation and to the tree view.
1249 # The default value is: NO.
1250 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1254 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1257 # (.qch) of the generated HTML documentation.
1258 # The default value is: NO.
1259 # This tag requires that the tag GENERATE_HTML is set to YES.
1263 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1264 # the file name of the resulting .qch file. The path specified is relative to
1265 # the HTML output folder.
1266 # This tag requires that the tag GENERATE_QHP is set to YES.
1270 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1273 # The default value is: org.doxygen.Project.
1274 # This tag requires that the tag GENERATE_QHP is set to YES.
1278 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1282 # The default value is: doc.
1283 # This tag requires that the tag GENERATE_QHP is set to YES.
1287 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1291 # This tag requires that the tag GENERATE_QHP is set to YES.
1295 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1299 # This tag requires that the tag GENERATE_QHP is set to YES.
1303 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1306 # This tag requires that the tag GENERATE_QHP is set to YES.
1310 # The QHG_LOCATION tag can be used to specify the location of Qt's
1311 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1313 # This tag requires that the tag GENERATE_QHP is set to YES.
1317 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1318 # generated, together with the HTML files, they form an Eclipse help plugin. To
1319 # install this plugin and make it available under the help contents menu in
1320 # Eclipse, the contents of the directory containing the HTML and XML files needs
1321 # to be copied into the plugins directory of eclipse. The name of the directory
1322 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1323 # After copying Eclipse needs to be restarted before the help appears.
1324 # The default value is: NO.
1325 # This tag requires that the tag GENERATE_HTML is set to YES.
1329 # A unique identifier for the Eclipse help plugin. When installing the plugin
1330 # the directory name containing the HTML and XML files should also have this
1332 # The default value is: org.doxygen.Project.
1333 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1337 # If you want full control over the layout of the generated HTML pages it might
1338 # be necessary to disable the index and replace it with your own. The
1339 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1340 # of each HTML page. A value of NO enables the index and the value YES disables
1341 # it. Since the tabs in the index contain the same information as the navigation
1343 # The default value is: NO.
1344 # This tag requires that the tag GENERATE_HTML is set to YES.
1348 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1349 # structure should be generated to display hierarchical information. If the tag
1351 # index structure (just like the one that is generated for HTML Help). For this
1353 # (i.e. any modern browser). Windows users are probably better off using the
1355 # further fine-tune the look of the index. As an example, the default style
1357 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1358 # the same information as the tab index, you could consider setting
1360 # The default value is: NO.
1361 # This tag requires that the tag GENERATE_HTML is set to YES.
1365 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1366 # doxygen will group on one line in the generated HTML documentation.
1368 # Note that a value of 0 will completely suppress the enum values from appearing
1369 # in the overview section.
1371 # This tag requires that the tag GENERATE_HTML is set to YES.
1375 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1376 # to set the initial width (in pixels) of the frame in which the tree is shown.
1378 # This tag requires that the tag GENERATE_HTML is set to YES.
1382 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1384 # The default value is: NO.
1385 # This tag requires that the tag GENERATE_HTML is set to YES.
1389 # Use this tag to change the font size of LaTeX formulas included as images in
1390 # the HTML documentation. When you change the font size after a successful
1391 # doxygen run you need to manually remove any form_*.png images from the HTML
1394 # This tag requires that the tag GENERATE_HTML is set to YES.
1398 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1403 # the HTML output directory before the changes have effect.
1404 # The default value is: YES.
1405 # This tag requires that the tag GENERATE_HTML is set to YES.
1409 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1410 # http://www.mathjax.org) which uses client side Javascript for the rendering
1412 # installed or if you want to formulas look prettier in the HTML output. When
1413 # enabled you may also need to install MathJax separately and configure the path
1414 # to it using the MATHJAX_RELPATH option.
1415 # The default value is: NO.
1416 # This tag requires that the tag GENERATE_HTML is set to YES.
1420 # When MathJax is enabled you can set the default output format to be used for
1421 # the MathJax output. See the MathJax site (see:
1423 # Possible values are: HTML-CSS (which is slower, but has the best
1425 # The default value is: HTML-CSS.
1426 # This tag requires that the tag USE_MATHJAX is set to YES.
1430 # When MathJax is enabled you need to specify the location relative to the HTML
1431 # output directory using the MATHJAX_RELPATH option. The destination directory
1432 # should contain the MathJax.js script. For instance, if the mathjax directory
1433 # is located at the same level as the HTML output directory, then
1434 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1435 # Content Delivery Network so you can quickly see the result without installing
1438 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1439 # This tag requires that the tag USE_MATHJAX is set to YES.
1443 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1446 # This tag requires that the tag USE_MATHJAX is set to YES.
1450 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1451 # of code that will be used on startup of the MathJax code. See the MathJax site
1453 # example see the documentation.
1454 # This tag requires that the tag USE_MATHJAX is set to YES.
1458 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1459 # the HTML output. The underlying search engine uses javascript and DHTML and
1463 # For large projects the javascript based search engine can be slow, then
1465 # search using the keyboard; to jump to the search box use <access key> + S
1466 # (what the <access key> is depends on the OS and browser, but it is typically
1467 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1468 # key> to jump into the search results window, the results can be navigated
1469 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1470 # the search. The filter options can be selected when the cursor is inside the
1471 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1472 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1474 # The default value is: YES.
1475 # This tag requires that the tag GENERATE_HTML is set to YES.
1479 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1481 # are two flavours of web server based searching depending on the
1483 # searching and an index file used by the script. When EXTERNAL_SEARCH is
1484 # enabled the indexing and searching needs to be provided by external tools. See
1485 # the section "External Indexing and Searching" for details.
1486 # The default value is: NO.
1487 # This tag requires that the tag SEARCHENGINE is set to YES.
1491 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1492 # script for searching. Instead the search results are written to an XML file
1494 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1498 # (doxysearch.cgi) which are based on the open source search engine library
1501 # See the section "External Indexing and Searching" for details.
1502 # The default value is: NO.
1503 # This tag requires that the tag SEARCHENGINE is set to YES.
1507 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1508 # which will return the search results when EXTERNAL_SEARCH is enabled.
1511 # (doxysearch.cgi) which are based on the open source search engine library
1512 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1514 # This tag requires that the tag SEARCHENGINE is set to YES.
1518 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1519 # search data is written to a file for indexing by an external tool. With the
1520 # SEARCHDATA_FILE tag the name of this file can be specified.
1521 # The default file is: searchdata.xml.
1522 # This tag requires that the tag SEARCHENGINE is set to YES.
1526 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1527 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1529 # projects and redirect the results back to the right project.
1530 # This tag requires that the tag SEARCHENGINE is set to YES.
1534 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1535 # projects other than the one defined by this configuration file, but that are
1536 # all added to the same external search index. Each project needs to have a
1537 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1538 # to a relative location where the documentation can be found. The format is:
1540 # This tag requires that the tag SEARCHENGINE is set to YES.
1545 # Configuration options related to the LaTeX output
1548 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1549 # The default value is: YES.
1553 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1554 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1556 # The default directory is: latex.
1557 # This tag requires that the tag GENERATE_LATEX is set to YES.
1561 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1565 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1566 # written to the output directory.
1567 # The default file is: latex.
1568 # This tag requires that the tag GENERATE_LATEX is set to YES.
1572 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1574 # The default file is: makeindex.
1575 # This tag requires that the tag GENERATE_LATEX is set to YES.
1579 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1582 # The default value is: NO.
1583 # This tag requires that the tag GENERATE_LATEX is set to YES.
1587 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1591 # The default value is: a4.
1592 # This tag requires that the tag GENERATE_LATEX is set to YES.
1596 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1597 # that should be included in the LaTeX output. To get the times font for
1601 # This tag requires that the tag GENERATE_LATEX is set to YES.
1605 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1606 # generated LaTeX document. The header should contain everything until the first
1608 # section "Doxygen usage" for information on how to let doxygen write the
1611 # Note: Only use a user-defined header if you know what you are doing! The
1612 # following commands have a special meaning inside the header: $title,
1614 # replace them by respectively the title of the page, the current date and time,
1615 # only the current date, the version number of doxygen, the project name (see
1616 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1617 # This tag requires that the tag GENERATE_LATEX is set to YES.
1621 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1622 # generated LaTeX document. The footer should contain everything after the last
1626 # This tag requires that the tag GENERATE_LATEX is set to YES.
1630 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1631 # other source files which should be copied to the LATEX_OUTPUT output
1632 # directory. Note that the files will be copied as-is; there are no commands or
1634 # This tag requires that the tag GENERATE_LATEX is set to YES.
1638 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1639 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1640 # contain links (just like the HTML output) instead of page references. This
1641 # makes the output suitable for online browsing using a PDF viewer.
1642 # The default value is: YES.
1643 # This tag requires that the tag GENERATE_LATEX is set to YES.
1647 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1648 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1650 # The default value is: YES.
1651 # This tag requires that the tag GENERATE_LATEX is set to YES.
1655 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1656 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1657 # if errors occur, instead of asking the user for help. This option is also used
1659 # The default value is: NO.
1660 # This tag requires that the tag GENERATE_LATEX is set to YES.
1664 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1665 # index chapters (such as File Index, Compound Index, etc.) in the output.
1666 # The default value is: NO.
1667 # This tag requires that the tag GENERATE_LATEX is set to YES.
1671 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1672 # code with syntax highlighting in the LaTeX output.
1676 # The default value is: NO.
1677 # This tag requires that the tag GENERATE_LATEX is set to YES.
1681 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1684 # The default value is: plain.
1685 # This tag requires that the tag GENERATE_LATEX is set to YES.
1690 # Configuration options related to the RTF output
1693 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1696 # The default value is: NO.
1700 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1701 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1703 # The default directory is: rtf.
1704 # This tag requires that the tag GENERATE_RTF is set to YES.
1708 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1711 # The default value is: NO.
1712 # This tag requires that the tag GENERATE_RTF is set to YES.
1716 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1717 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1718 # output) instead of page references. This makes the output suitable for online
1723 # The default value is: NO.
1724 # This tag requires that the tag GENERATE_RTF is set to YES.
1732 # See also section "Doxygen usage" for information on how to generate the
1734 # This tag requires that the tag GENERATE_RTF is set to YES.
1738 # Set optional variables used in the generation of an RTF document. Syntax is
1741 # This tag requires that the tag GENERATE_RTF is set to YES.
1746 # Configuration options related to the man page output
1749 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1751 # The default value is: NO.
1755 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1756 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1757 # it. A directory man3 will be created inside the directory specified by
1759 # The default directory is: man.
1760 # This tag requires that the tag GENERATE_MAN is set to YES.
1764 # The MAN_EXTENSION tag determines the extension that is added to the generated
1765 # man pages. In case the manual section does not start with a number, the number
1766 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1768 # The default value is: .3.
1769 # This tag requires that the tag GENERATE_MAN is set to YES.
1773 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1774 # will generate one additional man file for each entity documented in the real
1775 # man page(s). These additional files only source the real man page, but without
1776 # them the man command would be unable to find the correct page.
1777 # The default value is: NO.
1778 # This tag requires that the tag GENERATE_MAN is set to YES.
1783 # Configuration options related to the XML output
1786 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1787 # captures the structure of the code including all documentation.
1788 # The default value is: NO.
1792 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1793 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1795 # The default directory is: xml.
1796 # This tag requires that the tag GENERATE_XML is set to YES.
1800 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1801 # validating XML parser to check the syntax of the XML files.
1802 # This tag requires that the tag GENERATE_XML is set to YES.
1806 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1807 # validating XML parser to check the syntax of the XML files.
1808 # This tag requires that the tag GENERATE_XML is set to YES.
1812 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1814 # the XML output. Note that enabling this will significantly increase the size
1815 # of the XML output.
1816 # The default value is: YES.
1817 # This tag requires that the tag GENERATE_XML is set to YES.
1822 # Configuration options related to the DOCBOOK output
1825 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1827 # The default value is: NO.
1831 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1832 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1834 # The default directory is: docbook.
1835 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1840 # Configuration options for the AutoGen Definitions output
1843 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1844 # Definitions (see http://autogen.sf.net) file that captures the structure of
1845 # the code including all documentation. Note that this feature is still
1846 # experimental and incomplete at the moment.
1847 # The default value is: NO.
1852 # Configuration options related to the Perl module output
1855 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1856 # file that captures the structure of the code including all documentation.
1858 # Note that this feature is still experimental and incomplete at the moment.
1859 # The default value is: NO.
1863 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1865 # output from the Perl module output.
1866 # The default value is: NO.
1867 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1871 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1873 # understand what is going on. On the other hand, if this tag is set to NO the
1874 # size of the Perl module output will be much smaller and Perl will parse it
1875 # just the same.
1876 # The default value is: YES.
1877 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1881 # The names of the make variables in the generated doxyrules.make file are
1882 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1883 # so different doxyrules.make files included by the same Makefile don't
1885 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1890 # Configuration options related to the preprocessor
1893 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1894 # C-preprocessor directives found in the sources and include files.
1895 # The default value is: YES.
1899 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1900 # in the source code. If set to NO only conditional compilation will be
1903 # The default value is: NO.
1904 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1908 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1909 # the macro expansion is limited to the macros specified with the PREDEFINED and
1911 # The default value is: NO.
1912 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1916 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1918 # The default value is: YES.
1919 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1923 # The INCLUDE_PATH tag can be used to specify one or more directories that
1924 # contain include files that are not input files but should be processed by the
1926 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1930 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1931 # patterns (like *.h and *.hpp) to filter out the header-files in the
1932 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1934 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1938 # The PREDEFINED tag can be used to specify one or more macro names that are
1939 # defined before the preprocessor is started (similar to the -D option of e.g.
1940 # gcc). The argument of the tag is a list of macros of the form: name or
1941 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1943 # recursively expanded use the := operator instead of the = operator.
1944 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1952 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1953 # tag can be used to specify a list of macro names that should be expanded. The
1954 # macro definition that is found in the sources will be used. Use the PREDEFINED
1955 # tag if you want to use a different macro definition that overrules the
1956 # definition found in the source code.
1957 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1961 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1964 # typically used for boiler-plate code, and will confuse the parser if not
1966 # The default value is: YES.
1967 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1975 # The TAGFILES tag can be used to specify one or more tag files. For each tag
1976 # file the location of the external documentation should be added. The format of
1979 # Adding location for the tag files is done as follows:
1981 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
1982 # section "Linking to external documentation" for more information about the use
1984 # Note: Each tag file must have an unique name (where the name does NOT include
1985 # the path). If a tag file is not located in the directory in which doxygen is
1986 # run, you must also specify the path to the tagfile here.
1991 # tag file that is based on the input files it reads. See section "Linking to
1992 # external documentation" for more information about the usage of tag files.
1996 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1997 # class index. If set to NO only the inherited external classes will be listed.
1998 # The default value is: NO.
2002 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2003 # the modules index. If set to NO, only the current project's groups will be
2005 # The default value is: YES.
2009 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2010 # the related pages index. If set to NO, only the current project's pages will
2012 # The default value is: YES.
2016 # The PERL_PATH should be the absolute path and name of the perl script
2017 # interpreter (i.e. the result of 'which perl').
2018 # The default file (with absolute path) is: /usr/bin/perl.
2023 # Configuration options related to the dot tool
2026 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2027 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2028 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2031 # The default value is: YES.
2035 # You can define message sequence charts within doxygen comments using the \msc
2036 # command. Doxygen will then run the mscgen tool (see:
2037 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2038 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2039 # the mscgen tool resides. If left empty the tool is assumed to be found in the
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 DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2245 # that will be shown in the graph. If the number of nodes in a graph becomes
2246 # larger than this value, doxygen will truncate the graph, which is visualized
2247 # by representing a node as a red box. Note that doxygen if the number of direct
2248 # children of the root node in a graph is already larger than
2249 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2250 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2252 # This tag requires that the tag HAVE_DOT is set to YES.
2256 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2257 # generated by dot. A depth value of 3 means that only nodes reachable from the
2259 # further from the root node will be omitted. Note that setting this option to 1
2260 # or 2 may greatly reduce the computation time needed for large code bases. Also
2261 # note that the size of a graph can be further restricted by
2264 # This tag requires that the tag HAVE_DOT is set to YES.
2268 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2270 # to support this out of the box.
2272 # Warning: Depending on the platform used, enabling this option may lead to
2273 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2275 # The default value is: NO.
2276 # This tag requires that the tag HAVE_DOT is set to YES.
2280 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2281 # files in one run (i.e. multiple -o and -T options on the command line). This
2284 # The default value is: NO.
2285 # This tag requires that the tag HAVE_DOT is set to YES.
2289 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2290 # explaining the meaning of the various boxes and arrows in the dot generated
2292 # The default value is: YES.
2293 # This tag requires that the tag HAVE_DOT is set to YES.
2297 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2298 # files that are used to generate the various graphs.
2299 # The default value is: YES.
2300 # This tag requires that the tag HAVE_DOT is set to YES.