Lines Matching full:the

3 # This file describes the settings to be used by the documentation system
7 # The format is:
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
25 # The PROJECT_NAME tag is a single word (or sequence of words) that should
26 # identify the project. Note that if you do not use Doxywizard you need
27 # to put quotes around the project name if it contains spaces.
31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
32 # This could be handy for archiving the generated documentation or
35 # EIGEN_VERSION is set in the root CMakeLists.txt
39 # Using the PROJECT_BRIEF tag one can provide an optional one line description
40 # for a project that appears at the top of each page and should give viewer
41 # a quick idea about the purpose of the project. Keep the description short.
45 # With the PROJECT_LOGO tag one can specify an logo or icon that is
46 # included in the documentation. The maximum height of the logo should not
47 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
48 # Doxygen will copy the logo to the output directory.
52 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
53 # base path where the generated documentation will be put.
54 # If a relative path is entered, it will be relative to the location
55 # where doxygen was started. If left blank the current directory will be used.
59 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
60 # 4096 sub-directories (in 2 levels) under the output directory of each output
61 # format and will distribute the generated files over these directories.
63 # source files, where putting all generated files in the same directory would
64 # otherwise cause performance problems for the file system.
68 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
70 # information to generate all constant output in the proper language.
71 # The default language is English, other supported languages are:
81 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
82 # include brief member descriptions after the members that are listed in
83 # the file and class documentation (similar to JavaDoc).
88 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
89 # the brief description of a member or function before the detailed description.
90 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
96 # that is used to form the text in various listings. Each string
97 # in this list, if found as the leading text of the brief description, will be
98 # stripped from the text and the result after processing the whole list, is
99 # used as the annotated text. Otherwise, the brief description is used as-is.
100 # If left blank, the following values are used ("$name" is automatically
101 # replaced with the name of the entity): "The $name class" "The $name widget"
102 # "The $name file" "is" "provides" "specifies" "contains"
103 # "represents" "a" "an" "the"
105 ABBREVIATE_BRIEF       = "The $name class" \
106                          "The $name widget" \
107                          "The $name file" \
115                          the
117 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
123 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
124 # inherited members of a class in the documentation of that class as if those
126 # operators of the base classes will not be shown.
130 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
131 # path before files name in the file list and in the header files. If set
132 # to NO the shortest path that makes the file name unique will be used.
136 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
137 # can be used to strip a user-defined part of the path. Stripping is
138 # only done if one of the specified strings matches the left-hand part of
139 # 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
145 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
146 # the path mentioned in the documentation of a class, which tells
147 # the reader which header file to include in order to use a class.
148 # If left blank only the name of the header file containing the class
149 # definition is used. Otherwise one should specify the include paths that
150 # are normally passed to the compiler using the -I flag.
154 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
160 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
161 # will interpret the first line (until the first dot) of a JavaDoc-style
162 # comment as the brief description. If set to NO, the JavaDoc
168 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
169 # interpret the first line (until the first dot) of a Qt-style
170 # comment as the brief description. If set to NO, the comments
176 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
178 # comments) as a brief description. This used to be the default behaviour.
179 # The new default is to treat a multi-line C++ comment block as a detailed
180 # description. Set this tag to YES if you prefer the old behaviour instead.
184 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
185 # member inherits the documentation from any documented member that it
190 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
191 # a new page for each member. If set to NO, the documentation of a member will
192 # be part of the file/class/namespace that contains it.
196 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
202 # as commands in the documentation. An alias has the form "name=value".
204 # put the command \sideeffect (or @sideeffect) in the documentation, which
206 # You can put \n's in the value part of an alias to insert newlines.
209 …       "array_module=This is defined in the %Array module. \code #include <Eigen/Array> \endcode" \
210 …"cholesky_module=This is defined in the %Cholesky module. \code #include <Eigen/Cholesky> \endcode…
211 …"eigenvalues_module=This is defined in the %Eigenvalues module. \code #include <Eigen/Eigenvalues>…
212 …"geometry_module=This is defined in the %Geometry module. \code #include <Eigen/Geometry> \endcode…
213 …"householder_module=This is defined in the %Householder module. \code #include <Eigen/Householder>…
214 …    "jacobi_module=This is defined in the %Jacobi module. \code #include <Eigen/Jacobi> \endcode" \
215 …                "lu_module=This is defined in the %LU module. \code #include <Eigen/LU> \endcode" \
216 …                "qr_module=This is defined in the %QR module. \code #include <Eigen/QR> \endcode" \
217 …             "svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \
222 …eed a complete analysis of the space of solutions, take the one solution obtained by this method a…
223 …the error of this result, or use MatrixBase::isApprox() directly, for instance like this: \code bo…
224 … the result by value. In order to make that efficient, it is implemented as just a return statemen…
225 …"nonstableyet=\warning This is not considered to be part of the stable public API yet. Changes may…
231 # A mapping has the form "name=value". For example adding
232 # "class=itcl::class" will allow you to use the command class in the
237 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
239 # For instance, some of the names that are used will be different. The list
244 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
251 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
257 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
263 # Doxygen selects the parser to use depending on the extension of the files it
266 # tag. The format is ext=language, where ext is a file extension, and language
267 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
271 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
275 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
276 # comments according to the Markdown format, which allows for more readable
278 # The output of markdown processing is further processed by doxygen, so you
285 # to include (a tag file for) the STL sources as input, then you should
288 # func(std::string) {}). This also makes the inheritance and collaboration
298 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
305 # and setter methods for a property. Setting this option to YES (the default)
306 # will make doxygen replace the get and set methods by a property in the
307 # documentation. This will only work if the methods are indeed getting or
308 # setting a simple type. If this is not the case, or you want to show the
313 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
314 # tag is set to YES, then doxygen will reuse the documentation of the first
315 # member in the group (if any) for the other members of the group. By default
320 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
321 # the same type (for instance a group of public functions) to be put as a
322 # subgroup of that type (e.g. under the Public Functions section). Set it to
324 # the \nosubgrouping command.
328 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
329 # unions are shown inside the group in which they are included (e.g. using
335 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
336 # unions with only public data fields will be shown inline in the documentation
337 # of the scope in which they are defined (i.e. file, namespace, or group
338 # documentation), provided this scope is documented. If set to NO (the default),
345 # is documented as struct, union, or enum with the name of the typedef. So
346 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
347 # with name TypeT. When disabled the typedef will appear as a member of a file,
348 # namespace, or class. And the struct will be named TypeS. This can typically
349 # be useful for C code in case the coding convention dictates that all compound
350 # types are typedef'ed and only the typedef is referenced, never the tag name.
354 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
356 # When the cache is full, less often used symbols will be written to disk.
357 # For small to medium size projects (<1000 input files) the default value is
359 # doxygen to be busy swapping symbols to and from disk most of the time
361 # If the system has enough physical memory increasing the cache will improve the
362 # performance by keeping more symbols in memory. Note that the value works on
363 # a logarithmic scale so increasing the size by one will roughly double the
364 # memory usage. The cache size is given by this formula:
365 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
370 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
372 # their name and scope. Since this can be an expensive process and often the
373 # same symbol appear multiple times in the code, doxygen keeps a cache of
374 # pre-resolved symbols. If the cache is too small doxygen will become slower.
375 # If the cache is too large, memory is wasted. The cache size is given by this
376 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
385 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
388 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
392 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
393 # will be included in the documentation.
397 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be inclu…
401 # If the EXTRACT_STATIC tag is set to YES all static members of a file
402 # will be included in the documentation.
406 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
407 # defined locally in source files will be included in the documentation.
413 # methods, which are defined in the implementation section but not in
414 # the interface are included in the documentation.
415 # If set to NO (the default) only methods in the interface are included.
419 # If this flag is set to YES, the members of anonymous namespaces will be
420 # extracted and appear in the documentation as a namespace called
421 # 'anonymous_namespace{file}', where file will be replaced with the base
422 # name of the file that contains the anonymous namespace. By default
427 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
429 # If set to NO (the default) these members will be included in the
435 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
436 # undocumented classes that are normally visible in the class hierarchy.
437 # If set to NO (the default) these classes will be included in the various
442 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
444 # If set to NO (the default) these declarations will be included in the
449 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
450 # documentation blocks found inside the body of a function.
451 # If set to NO (the default) these blocks will be appended to the
456 # The INTERNAL_DOCS tag determines if documentation
457 # that is typed after a \internal command is included. If the tag is set
458 # to NO (the default) then the documentation will be excluded.
459 # Set it to YES to include the internal documentation.
463 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
471 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
472 # will show members with their full class and namespace scopes in the
473 # documentation. If set to YES the scope will be hidden.
477 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
478 # will put a list of the files that are included by a file in the documentation
483 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
484 # will list include files with double quotes in the documentation
489 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
490 # is inserted in the documentation for inline members.
494 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
495 # will sort the (detailed) documentation of file and class members
496 # alphabetically by member name. If set to NO the members will appear in
501 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
503 # by member name. If set to NO (the default) the members will appear in
508 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
509 # will sort the (brief and detailed) documentation of class members so that
510 # constructors and destructors are listed first. If set to NO (the default)
511 # the constructors will appear in the respective orders defined by
518 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
519 # hierarchy of group names into alphabetical order. If set to NO (the default)
520 # the group names will appear in their defined order.
524 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
526 # NO (the default), the class list will be sorted only by class name,
527 # not including the namespace part.
529 # Note: This option applies only to the class list, not to the
534 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
536 # match between the prototype and the implementation of a member function even
543 # The GENERATE_TODOLIST tag can be used to enable (YES) or
544 # disable (NO) the todo list. This list is created by putting \todo
545 # commands in the documentation.
549 # The GENERATE_TESTLIST tag can be used to enable (YES) or
550 # disable (NO) the test list. This list is created by putting \test
551 # commands in the documentation.
555 # The GENERATE_BUGLIST tag can be used to enable (YES) or
556 # disable (NO) the bug list. This list is created by putting \bug
557 # commands in the documentation.
561 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
562 # disable (NO) the deprecated list. This list is created by putting
563 # \deprecated commands in the documentation.
567 # The ENABLED_SECTIONS tag can be used to enable conditional
572 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
573 # the initial value of a variable or macro consists of for it to appear in
574 # the documentation. If the initializer consists of more lines than specified
576 # The appearance of the initializer of individual variables and macros in the
578 # command in the documentation regardless of this setting.
582 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
583 # at the bottom of the documentation of classes and structs. If set to YES the
584 # list will mention the files that were used to generate the documentation.
588 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
589 # This will remove the Files entry from the Quick Index and from the
590 # Folder Tree View (if specified). The default is YES.
594 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
596 # This will remove the Namespaces entry from the Quick Index
597 # and from the Folder Tree View (if specified). The default is YES.
601 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
602 # doxygen should invoke to get the current version for each file (typically from
603 # the version control system). Doxygen will invoke the program by executing (via
604 # popen()) the command <command> <input-file>, where <command> is the value of
605 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
606 # provided by doxygen. Whatever the program writes to standard output
607 # is used as the file version. See the manual for examples.
611 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
612 # by doxygen. The layout file controls the global structure of the generated
613 # output files in an output format independent way. To create the layout file
614 # that represents doxygen's defaults, run doxygen with the -l option.
615 # You can optionally specify a file name after the option, if omitted
616 # DoxygenLayout.xml will be used as the name of the layout file.
620 # The CITE_BIB_FILES tag can be used to specify one or more bib files
621 # containing the references data. This must be a list of .bib files. The
623 # requires the bibtex tool to be installed. See also
624 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
625 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
626 # feature you need bibtex and perl available in the search path.
634 # The QUIET tag can be used to turn on/off the messages that are generated
639 # The WARNINGS tag can be used to turn on/off the warning messages that are
652 # potential errors in the documentation, such as not documenting some
658 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
660 # or return value. If set to NO (the default) doxygen will only warn about
661 # wrong or incomplete parameter documentation, but not about the absence of
666 # The WARN_FORMAT tag determines the format of the warning messages that
667 # doxygen can produce. The string should contain the $file, $line, and $text
668 # tags, which will be replaced by the file and line number from which the
669 # warning originated and the warning text. Optionally the format may contain
670 # $version, which will be replaced by the version of the file (if it could
675 # The WARN_LOGFILE tag can be used to specify a file to which warning
676 # and error messages should be written. If left blank the output is written
682 # configuration options related to the input files
685 # The INPUT tag can be used to specify the files and/or directories that contain
687 # directories like "/usr/src/myproject". Separate the files or directories
692 # This tag can be used to specify the character encoding of the source files
693 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
694 # also the default input encoding. Doxygen uses libiconv (or the iconv built
695 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
696 # the list of possible encodings.
700 # If the value of the INPUT tag contains directories, you can use the
702 # and *.h) to filter out the source-files in the directories. If left
703 # blank the following patterns are tested:
710 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
716 # The EXCLUDE tag can be used to specify files and/or directories that should be
717 # excluded from the INPUT source files. This way you can easily exclude a
718 # subdirectory from a directory tree whose root is specified with the INPUT tag.
719 # Note that relative paths are relative to the directory from which doxygen is
730 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
732 # from the input.
736 # If the value of the INPUT tag contains directories, you can use the
738 # certain files from those directories. Note that the wildcards are matched
739 # against the file with absolute path, so to exclude all test directories
740 # for example use the pattern */test/*
758 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
759 # (namespaces, classes, functions, etc.) that should be excluded from the
760 # output. The symbol name can be a fully qualified name, a word, or if the
770 # The EXAMPLE_PATH tag can be used to specify one or more files or
772 # the \include command).
785 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
787 # and *.h) to filter out the source-files in the directories. If left
792 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
793 # searched for input files to be used with the \include or \dontinclude
794 # commands irrespective of the value of the RECURSIVE tag.
799 # The IMAGE_PATH tag can be used to specify one or more files or
800 # directories that contain image that are included in the documentation (see
801 # the \image command).
805 # The INPUT_FILTER tag can be used to specify a program that doxygen should
806 # invoke to filter for each input file. Doxygen will invoke the filter program
807 # by executing (via popen()) the command <filter> <input-file>, where <filter>
808 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
809 # input file. Doxygen will then use the output that the filter program writes
816 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
818 # Doxygen will compare the file name with each pattern and apply the
820 # The filters are a list of the form:
823 # non of the patterns match the file name, INPUT_FILTER is applied.
827 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
828 # INPUT_FILTER) will be used to filter the input files when producing source
833 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
834 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
845 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
847 # Note: To get rid of all source code in the generated output, make sure also
852 # Setting the INLINE_SOURCES tag to YES will include the body
853 # of functions and classes directly in the documentation.
857 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
863 # If the REFERENCED_BY_RELATION tag is set to YES
869 # If the REFERENCES_RELATION tag is set to YES
875 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
876 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
878 # link to the source code.
879 # Otherwise they will link to the documentation.
883 # If the USE_HTAGS tag is set to YES then the references to source code
884 # will point to the HTML generated by the htags(1) tool instead of doxygen
885 # built-in source browser. The htags tool is part of GNU's global source
891 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
892 # will generate a verbatim copy of the header file for each class for
898 # configuration options related to the alphabetical class index
901 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
902 # of all compounds will be generated. Enable this if the project
907 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
908 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
909 # in which this list will be split (can be a number in the range [1..20])
914 # classes will be put under the same header in the alphabetical index.
915 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
916 # should be ignored while generating the index headers.
921 # configuration options related to the HTML output
924 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
929 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
930 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
931 # put in front of it. If left blank `html' will be used as the default path.
935 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
941 # The HTML_HEADER tag can be used to specify a personal HTML header for
944 #  for the proper inclusion of any scripts and style sheets that doxygen
945 # needs, which is dependent on the configuration options used.
948 # that header. Note that the header is subject to change so you typically
950 # changing the value of configuration settings such as GENERATE_TREEVIEW!
954 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
960 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
962 # fine-tune the look of the HTML output. If the tag is left blank doxygen
964 # the style sheet file to the HTML output directory, so don't put your own
965 # style sheet in the HTML output directory as well, or it will be erased!
969 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
970 # other source files which should be copied to the HTML output directory. Note
971 # that these files will be copied to the base HTML output directory. Use the
972 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
973 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
974 # the files will be copied as-is; there are no commands or markers available.
978 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
979 # Doxygen will adjust the colors in the style sheet and background images
982 # For instance the value 0 represents red, 60 is yellow, 120 is green,
984 # The allowed range is 0 to 359.
985 # The default is 220.
989 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
990 # the colors in the HTML output. For a value of 0 the output will use
991 # grayscales only. A value of 255 will produce the most vivid colors.
995 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
996 # the luminance component of the colors in the HTML output. Values below
997 # 100 gradually make the output lighter, whereas values above 100 make
998 # the output darker. The value divided by 100 is the actual gamma applied,
999 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
1000 # and 100 does not change the gamma.
1004 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1005 # page will contain the date and time when the page was generated. Setting
1006 # this to NO can help when comparing the output of multiple runs.
1010 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1011 # documentation will contain sections that can be hidden and shown after the
1016 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
1017 # entries shown in the various tree structured indices initially; the user
1019 # the tree to such a level that at most the specified number of entries are
1021 # So setting the number of entries 1 will produce a full collapsed tree by
1027 # If the GENERATE_DOCSET tag is set to YES, additional index files
1030 # To create a documentation set, doxygen will generate a Makefile in the
1031 # HTML output directory. Running make will produce the docset in that
1032 # directory and running "make install" will install the docset in
1040 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1048 # should uniquely identify the documentation set bundle. This should be a
1050 # will append .docset to the name.
1055 # the documentation publisher. This should be a reverse domain-name style
1060 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1064 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1065 # will be generated that can be used as input for tools like the
1067 # of the generated HTML documentation.
1071 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1072 # be used to specify the file name of the resulting .chm file. You
1073 # can add a path in front of the file if the result should not be
1074 # written to the html output directory.
1078 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1079 # be used to specify the location (absolute path including file name) of
1080 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1081 # the HTML help compiler on the generated index.hhp.
1085 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1087 # it should be included in the master .chm file (NO).
1091 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1097 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1099 # normal table of contents (NO) in the .chm file.
1103 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1104 # to the contents of the HTML help documentation and to the tree view.
1108 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1111 # Qt Compressed Help (.qch) of the generated HTML documentation.
1115 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1116 # be used to specify the file name of the resulting .qch file.
1117 # The path specified is relative to the HTML output folder.
1121 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1127 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1133 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1139 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1146 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1154 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1155 # be used to specify the location of Qt's qhelpgenerator.
1156 # If non-empty doxygen will try to run qhelpgenerator on the generated
1161 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1162 #  will be generated, which together with the HTML files, form an Eclipse help
1163 # plugin. To install this plugin and make it available under the help contents
1164 # menu in Eclipse, the contents of the directory containing the HTML and XML
1165 # files needs to be copied into the plugins directory of eclipse. The name of
1166 # the directory within the plugins directory should be the same as
1167 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1168 # the help appears.
1172 # A unique identifier for the eclipse help plugin. When installing the plugin
1173 # the directory name containing the HTML and XML files should also have
1178 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1179 # at top of each HTML page. The value NO (the default) enables the index and
1180 # the value YES disables it. Since the tabs have the same information as the
1186 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1188 # If the tag value is set to YES, a side panel will be generated
1189 # containing a tree-like index structure (just like the one that
1192 # Windows users are probably better off using the HTML help feature.
1193 # Since the tree basically has the same information as the tab index you
1198 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1199 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1200 # documentation. Note that a value of 0 will completely suppress the enum
1201 # values from appearing in the overview section.
1205 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1206 # used to set the initial width (in pixels) of the frame in which the tree
1211 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1216 # Use this tag to change the font size of Latex formulas included
1217 # as images in the HTML documentation. The default is 10. Note that
1218 # when you change the font size after a successful doxygen run you need
1219 # to manually remove any form_*.png images from the HTML output directory
1224 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1228 # in the HTML output before the changes have effect.
1232 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1233 # (see http://www.mathjax.org) which uses client side Javascript for the
1235 # have LaTeX installed or if you want to formulas look prettier in the HTML
1237 # configure the path to it using the MATHJAX_RELPATH option.
1241 # When MathJax is enabled you need to specify the location relative to the
1242 # HTML output directory using the MATHJAX_RELPATH option. The destination
1243 # directory should contain the MathJax.js script. For instance, if the mathjax
1244 # directory is located at the same level as the HTML output directory, then
1245 # MATHJAX_RELPATH should be ../mathjax. The default value points to
1246 # the MathJax Content Delivery Network so you can quickly see the result without
1253 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1258 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1259 # for the HTML output. The underlying search engine uses javascript
1263 # typically be disabled. For large projects the javascript based search engine
1268 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1269 # implemented using a PHP enabled web server instead of at the web client
1270 # using Javascript. Doxygen will generate the search PHP script and index
1271 # file to put on the web server. The advantage of the server
1273 # full text search. The disadvantages are that it is more difficult to setup
1279 # configuration options related to the LaTeX output
1282 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1287 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1288 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1289 # put in front of it. If left blank `latex' will be used as the default path.
1293 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1294 # invoked. If left blank `latex' will be used as the default command name.
1296 # generating bitmaps for formulas in the HTML output, but not in the
1297 # Makefile that is written to the output directory.
1301 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1302 # generate index for LaTeX. If left blank `makeindex' will be used as the
1307 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1313 # The PAPER_TYPE tag can be used to set the paper type that is used
1314 # by the printer. Possible values are: a4, letter, legal and
1319 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1320 # packages that should be included in the LaTeX output.
1325 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1326 # the generated latex document. The header should contain everything until
1327 # the first chapter. If it is left blank doxygen will generate a
1332 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1333 # the generated latex document. The footer should contain everything after
1334 # the last chapter. If it is left blank doxygen will generate a
1339 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1340 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1341 # contain links (just like the HTML output) instead of page references
1342 # This makes the output suitable for online browsing using a pdf viewer.
1346 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1347 # plain latex in the generated Makefile. Set this option to YES to get a
1352 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1353 # command to the generated LaTeX files. This will instruct LaTeX to keep
1354 # running if errors occur, instead of asking the user for help.
1360 # include the index chapters (such as File Index, Compound Index, etc.)
1361 # in the output.
1366 # source code with syntax highlighting in the LaTeX output.
1372 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1373 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1379 # configuration options related to the RTF output
1382 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1383 # The RTF output is optimized for Word 97 and may not look very pretty with
1388 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1389 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1390 # put in front of it. If left blank `rtf' will be used as the default path.
1394 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1400 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1401 # will contain hyperlink fields. The RTF file will
1402 # contain links (just like the HTML output) instead of page references.
1403 # This makes the output suitable for online browsing using WORD or other
1415 # Set optional variables used in the generation of an rtf document.
1421 # configuration options related to the man page output
1424 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1429 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1430 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1431 # put in front of it. If left blank `man' will be used as the default path.
1435 # The MAN_EXTENSION tag determines the extension that is added to
1436 # the generated man pages (default is the subroutine's section .3)
1440 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1442 # documented in the real man page(s). These additional files
1443 # only source the real man page, but without them the man command
1444 # would be unable to find the correct page. The default is NO.
1449 # configuration options related to the XML output
1452 # If the GENERATE_XML tag is set to YES Doxygen will
1453 # generate an XML file that captures the structure of
1454 # the code including all documentation.
1458 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1459 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1460 # put in front of it. If left blank `xml' will be used as the default path.
1464 # The XML_SCHEMA tag can be used to specify an XML schema,
1465 # which can be used by a validating XML parser to check the
1466 # syntax of the XML files.
1470 # The XML_DTD tag can be used to specify an XML DTD,
1471 # which can be used by a validating XML parser to check the
1472 # syntax of the XML files.
1476 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1477 # dump the program listings (including syntax highlighting
1478 # and cross-referencing information) to the XML output. Note that
1479 # enabling this will significantly increase the size of the XML output.
1484 # configuration options for the AutoGen Definitions output
1487 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1489 # that captures the structure of the code including all
1491 # and incomplete at the moment.
1496 # configuration options related to the Perl module output
1499 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1500 # generate a Perl module file that captures the structure of
1501 # the code including all documentation. Note that this
1502 # feature is still experimental and incomplete at the
1507 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1508 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1509 # to generate PDF and DVI output from the Perl module output.
1513 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1517 # On the other hand, if this
1518 # tag is set to NO the size of the Perl module output will be much smaller
1519 # and Perl will parse it just the same.
1523 # The names of the make variables in the generated doxyrules.make file
1524 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1525 # This is useful so different doxyrules.make files included by the same
1531 # Configuration options related to the preprocessor
1534 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1535 # evaluate all C-preprocessor directives found in the sources and include
1540 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1541 # names in the source code. If set to NO (the default) only conditional
1547 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1548 # then the macro expansion is limited to the macros specified with the
1553 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1558 # The INCLUDE_PATH tag can be used to specify one or more directories that
1560 # the preprocessor.
1564 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1565 # patterns (like *.h and *.hpp) to filter out the header-files in the
1566 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1571 # The PREDEFINED tag can be used to specify one or more macro names that
1572 # are defined before the preprocessor is started (similar to the -D option of
1573 # gcc). The argument of the tag is a list of macros of the form: name
1574 # or name=definition (no spaces). If the definition and the = are
1576 # undefined via #undef or recursively expanded use the := operator
1577 # instead of the = operator.
1588 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1590 # The macro definition that is found in the sources will be used.
1591 # Use the PREDEFINED tag if you want to use a different macro definition that
1592 # overrules the definition found in the source code.
1604 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1607 # semicolon, because these will confuse the parser if not removed.
1615 # The TAGFILES option can be used to specify one or more tagfiles. For each
1616 # tag file the location of the external documentation should be added. The
1620 # Adding location for the tag files is done as follows:
1624 # or URLs. Note that each tag file must have a unique name (where the name does
1625 # NOT include the path). If a tag file is not located in the directory in which
1626 # doxygen is run, you must also specify the path to the tagfile here.
1632 # a tag file that is based on the input files it reads.
1636 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1637 # in the class index. If set to NO only the inherited external classes
1642 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1643 # in the modules index. If set to NO, only the current project's groups will
1648 # The PERL_PATH should be the absolute path and name of the perl script
1649 # interpreter (i.e. the result of `which perl').
1654 # Configuration options related to the dot tool
1657 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1659 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1665 # You can define message sequence charts within doxygen comments using the \msc
1666 # command. Doxygen will then run the mscgen tool (see
1667 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1668 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1669 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1674 # If set to YES, the inheritance and collaboration graphs will hide
1675 # inheritance and usage relations if the target is undocumented
1680 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1681 # available from the path. This tool is part of Graphviz, a graph visualization
1682 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1683 # have no effect if this option is set to NO (the default)
1687 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1688 # allowed to run in parallel. When set to 0 (the default) doxygen will
1689 # base this on the number of processors available in the system. You can set it
1690 # explicitly to a value larger than 0 to get control over the balance
1695 # By default doxygen will use the Helvetica font for all dot files that
1697 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1698 # the font, which can be done by putting it in a standard location or by setting
1699 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1700 # directory containing the font.
1704 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1705 # The default size is 10pt.
1709 # By default doxygen will tell dot to use the Helvetica font.
1711 # set the path where dot can find it.
1715 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1716 # will generate a graph for each documented class showing the direct and
1717 # indirect inheritance relations. Setting this tag to YES will force the
1722 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1723 # will generate a graph for each documented class showing the direct and
1725 # class references variables) of the class with other documented classes.
1729 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1730 # will generate a graph for groups, showing the direct groups dependencies
1734 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1735 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1740 # If the UML_LOOK tag is enabled, the fields and methods are shown inside
1741 # the class node. If there are many fields or methods and many nodes the
1742 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1743 # threshold limits the number of items for each type to make the size more
1744 # managable. Set this to 0 for no limit. Note that the threshold may be
1745 # exceeded by 50% before the limit is enforced.
1749 # If set to YES, the inheritance and collaboration graphs will show the
1754 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1756 # file showing the direct and indirect include dependencies of the file with
1761 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1763 # documented header file showing the documented files that directly or
1768 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1771 # the time of a run. So in most cases it will be better to enable call graphs
1772 # for selected functions only using the \callgraph command.
1776 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1779 # the time of a run. So in most cases it will be better to enable caller
1780 # graphs for selected functions only using the \callergraph command.
1784 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1789 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
1790 # then doxygen will show the dependencies a directory has on other directories
1791 # in a graphical way. The dependency relations are determined by the #include
1792 # relations between the files in the directories.
1796 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1799 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1808 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1813 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1814 # found. If left blank, it is assumed the dot tool can be found in the path.
1818 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1819 # contain dot files that are included in the documentation (see the
1824 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1825 # contain msc files that are included in the documentation (see the
1830 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1831 # nodes that will be shown in the graph. If the number of nodes in a graph
1832 # becomes larger than this value, doxygen will truncate the graph, which is
1833 # visualized by representing a node as a red box. Note that doxygen if the
1834 # number of direct children of the root node in a graph is already larger than
1835 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1836 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1840 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1842 # from the root by following a path via at most 3 edges will be shown. Nodes
1843 # that lay further from the root node will be omitted. Note that setting this
1844 # option to 1 or 2 may greatly reduce the computation time needed for large
1845 # code bases. Also note that the size of a graph can be further restricted by
1850 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1852 # seem to support this out of the box. Warning: Depending on the platform used,
1853 # enabling this option may lead to badly anti-aliased labels on the edges of
1858 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1859 # files in one run (i.e. multiple -o and -T options on the command line). This
1865 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1866 # generate a legend page explaining the meaning of the various boxes and
1867 # arrows in the dot generated graphs.
1871 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1872 # remove the intermediate dot files that are used to generate
1873 # the various graphs.