3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project.
6 # All text after a hash (#) is considered a comment and will be ignored.
8 # TAG = value [value, ...]
9 # For lists items can also be appended using:
10 # TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ").
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
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.
23 DOXYFILE_ENCODING = UTF-8
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.
29 PROJECT_NAME = ${EIGEN_DOXY_PROJECT_NAME}
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
33 # if some version control system is used.
35 # EIGEN_VERSION is set in the root CMakeLists.txt
37 PROJECT_NUMBER = "${EIGEN_VERSION}"
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.
50 PROJECT_LOGO = "${Eigen_SOURCE_DIR}/doc/Eigen_Silly_Professor_64x64.png"
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.
57 OUTPUT_DIRECTORY = "${Eigen_BINARY_DIR}/doc${EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX}"
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.
62 # Enabling this option can be useful when feeding doxygen a huge amount of
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
69 # documentation generated by doxygen is written. Doxygen will use this
70 # information to generate all constant output in the proper language.
71 # The default language is English, other supported languages are:
72 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
73 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
74 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
75 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
76 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
77 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
79 OUTPUT_LANGUAGE = English
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).
84 # Set to NO to disable this.
86 BRIEF_MEMBER_DESC = YES
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
91 # brief descriptions will be completely suppressed.
95 # This tag implements a quasi-intelligent brief description abbreviator
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" \
117 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
118 # Doxygen will generate a detailed section even if there is only a brief
121 ALWAYS_DETAILED_SEC = NO
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
125 # members were ordinary class members. Constructors, destructors and assignment
126 # operators of the base classes will not be shown.
128 INLINE_INHERITED_MEMB = YES
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.
152 STRIP_FROM_INC_PATH =
154 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
155 # (but less readable) file names. This can be useful if your file system
156 # doesn't support long names like on DOS, Mac, or CD-ROM.
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
163 # comments will behave just like regular Qt-style comments
164 # (thus requiring an explicit @brief command for a brief description.)
166 JAVADOC_AUTOBRIEF = NO
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
171 # will behave just like regular Qt-style comments (thus requiring
172 # an explicit \brief command for a brief description.)
176 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
177 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
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.
182 MULTILINE_CPP_IS_BRIEF = NO
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.
194 SEPARATE_MEMBER_PAGES = NO
196 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
197 # Doxygen uses this value to replace tabs by spaces in code fragments.
201 # This tag can be used to specify a number of aliases that acts
202 # as commands in the documentation. An alias has the form "name=value".
203 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
204 # put the command \sideeffect (or @sideeffect) in the documentation, which
205 # will result in a user-defined paragraph with heading "Side Effects:".
206 # You can put \n's in the value part of an alias to insert newlines.
208 ALIASES = "only_for_vectors=This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column." \
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> \endcode" \
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> \endcode" \
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" \
219 "matrixworld=<a href='#matrixonly' style='color:green;text-decoration: none;'>*</a>" \
220 "arrayworld=<a href='#arrayonly' style='color:blue;text-decoration: none;'>*</a>" \
221 "note_about_arbitrary_choice_of_solution=If there exists more than one solution, this method will arbitrarily choose one." \
222 "note_about_using_kernel_to_study_multiple_solutions=If you need a complete analysis of the space of solutions, take the one solution obtained by this method and add to it elements of the kernel, as determined by kernel()." \
223 "note_about_checking_solutions=This method just tries to find as good a solution as possible. If you want to check whether a solution exists or if it is accurate, just call this function to get a result and then compute the error of this result, or use MatrixBase::isApprox() directly, for instance like this: \code bool a_solution_exists = (A*result).isApprox(b, precision); \endcode This method avoids dividing by zero, so that the non-existence of a solution doesn't by itself mean that you'll get \c inf or \c nan values." \
224 "note_try_to_help_rvo=This function returns the result by value. In order to make that efficient, it is implemented as just a return statement using a special constructor, hopefully allowing the compiler to perform a RVO (return value optimization)." \
225 "nonstableyet=\warning This is not considered to be part of the stable public API yet. Changes may happen in future releases. See \ref Experimental \"Experimental parts of Eigen\""
227 ALIASES += "eigenAutoToc= "
228 ALIASES += "eigenManualPage=\defgroup"
230 # This tag can be used to specify a number of word-keyword mappings (TCL only).
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
233 # itcl::class meaning.
237 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
238 # sources only. Doxygen will then generate output that is more tailored for C.
239 # For instance, some of the names that are used will be different. The list
240 # of all members will be omitted, etc.
242 OPTIMIZE_OUTPUT_FOR_C = NO
244 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
245 # sources only. Doxygen will then generate output that is more tailored for
246 # Java. For instance, namespaces will be presented as packages, qualified
247 # scopes will look different, etc.
249 OPTIMIZE_OUTPUT_JAVA = NO
251 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
252 # sources only. Doxygen will then generate output that is more tailored for
255 OPTIMIZE_FOR_FORTRAN = NO
257 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
258 # sources. Doxygen will then generate output that is tailored for
261 OPTIMIZE_OUTPUT_VHDL = NO
263 # Doxygen selects the parser to use depending on the extension of the files it
264 # parses. With this tag you can assign which parser to use for a given extension.
265 # Doxygen has a built-in mapping, but you can override or extend it using this
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,
268 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
269 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
270 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
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
277 # documentation. See http://daringfireball.net/projects/markdown/ for details.
278 # The output of markdown processing is further processed by doxygen, so you
279 # can mix doxygen, HTML, and XML commands with Markdown formatting.
280 # Disable only in case of backward compatibilities issues.
282 MARKDOWN_SUPPORT = YES
284 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
285 # to include (a tag file for) the STL sources as input, then you should
286 # set this tag to YES in order to let doxygen match functions declarations and
287 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
288 # func(std::string) {}). This also makes the inheritance and collaboration
289 # diagrams that involve STL classes more complete and accurate.
291 BUILTIN_STL_SUPPORT = NO
293 # If you use Microsoft's C++/CLI language, you should set this option to YES to
294 # enable parsing support.
298 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
299 # Doxygen will parse them like normal C++ but will assume all classes use public
300 # instead of private inheritance when no explicit protection keyword is present.
304 # For Microsoft's IDL there are propget and propput attributes to indicate getter
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
309 # methods anyway, you should set this option to NO.
311 IDL_PROPERTY_SUPPORT = YES
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
316 # all members of a group must be documented explicitly.
318 DISTRIBUTE_GROUP_DOC = YES
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
323 # NO to prevent subgrouping. Alternatively, this can be done per class using
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
330 # @ingroup) instead of on a separate page (for HTML and Man pages) or
331 # section (for LaTeX and RTF).
333 INLINE_GROUPED_CLASSES = NO
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),
339 # structs, classes, and unions are shown on a separate page (for HTML and Man
340 # pages) or section (for LaTeX and RTF).
342 INLINE_SIMPLE_STRUCTS = NO
344 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
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.
352 TYPEDEF_HIDES_STRUCT = NO
354 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
355 # determine which symbols to keep in memory and which to flush to disk.
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
358 # probably good enough. For larger projects a too small cache size can cause
359 # doxygen to be busy swapping symbols to and from disk most of the time
360 # causing a significant performance penalty.
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,
366 # corresponding to a cache size of 2^16 = 65536 symbols.
368 # SYMBOL_CACHE_SIZE = 0
370 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
371 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
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,
377 # corresponding to a cache size of 2^16 = 65536 symbols.
379 LOOKUP_CACHE_SIZE = 0
381 #---------------------------------------------------------------------------
382 # Build related configuration options
383 #---------------------------------------------------------------------------
385 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
386 # documentation are documented, even if no documentation was available.
387 # Private class members and static file members will be hidden unless
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 included in the documentation.
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.
408 # If set to NO only classes defined in header files are included.
410 EXTRACT_LOCAL_CLASSES = NO
412 # This flag is only useful for Objective-C code. When set to YES local
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.
417 EXTRACT_LOCAL_METHODS = NO
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
423 # anonymous namespaces are hidden.
425 EXTRACT_ANON_NSPACES = NO
427 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
428 # undocumented members of documented classes, files or namespaces.
429 # If set to NO (the default) these members will be included in the
430 # various overviews, but no documentation section is generated.
431 # This option has no effect if EXTRACT_ALL is enabled.
433 HIDE_UNDOC_MEMBERS = YES
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
438 # overviews. This option has no effect if EXTRACT_ALL is enabled.
440 HIDE_UNDOC_CLASSES = YES
442 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
443 # friend (class|struct|union) declarations.
444 # If set to NO (the default) these declarations will be included in the
447 HIDE_FRIEND_COMPOUNDS = YES
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
452 # function's detailed documentation block.
454 HIDE_IN_BODY_DOCS = NO
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
464 # file names in lower-case letters. If set to YES upper-case letters are also
465 # allowed. This is useful if you have classes or files whose names only differ
466 # in case and if your file system supports case sensitive file names. Windows
467 # and Mac users are advised to set this option to NO.
469 CASE_SENSE_NAMES = YES
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.
475 HIDE_SCOPE_NAMES = YES
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
481 SHOW_INCLUDE_FILES = NO
483 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
484 # will list include files with double quotes in the documentation
485 # rather than with sharp brackets.
487 FORCE_LOCAL_INCLUDES = NO
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
499 SORT_MEMBER_DOCS = YES
501 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
502 # brief documentation of file, namespace and class members alphabetically
503 # by member name. If set to NO (the default) the members will appear in
506 SORT_BRIEF_DOCS = YES
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
512 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
513 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
514 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
516 SORT_MEMBERS_CTORS_1ST = NO
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.
522 SORT_GROUP_NAMES = NO
524 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
525 # sorted by fully-qualified names, including namespaces. If set to
526 # NO (the default), the class list will be sorted only by class name,
527 # not including the namespace part.
528 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
529 # Note: This option applies only to the class list, not to the
532 SORT_BY_SCOPE_NAME = NO
534 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
535 # do proper type resolution of all parameters of a function it will reject a
536 # match between the prototype and the implementation of a member function even
537 # if there is only one candidate or it is obvious which candidate to choose
538 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
539 # will still accept a match between prototype and implementation in such cases.
541 STRICT_PROTO_MATCHING = NO
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.
547 GENERATE_TODOLIST = NO
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.
553 GENERATE_TESTLIST = NO
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.
559 GENERATE_BUGLIST = NO
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.
565 GENERATE_DEPRECATEDLIST= YES
567 # The ENABLED_SECTIONS tag can be used to enable conditional
568 # documentation sections, marked by \if sectionname ... \endif.
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
575 # here it will be hidden. Use a value of 0 to hide initializers completely.
576 # The appearance of the initializer of individual variables and macros in the
577 # documentation can be controlled using \showinitializer or \hideinitializer
578 # command in the documentation regardless of this setting.
580 MAX_INITIALIZER_LINES = 0
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.
586 SHOW_USED_FILES = YES
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.
609 FILE_VERSION_FILTER =
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.
618 LAYOUT_FILE = "${Eigen_BINARY_DIR}/doc${EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX}/eigendoxy_layout.xml"
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
622 # .bib extension is automatically appended if omitted. Using this command
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.
630 #---------------------------------------------------------------------------
631 # configuration options related to warning and progress messages
632 #---------------------------------------------------------------------------
634 # The QUIET tag can be used to turn on/off the messages that are generated
635 # by doxygen. Possible values are YES and NO. If left blank NO is used.
639 # The WARNINGS tag can be used to turn on/off the warning messages that are
640 # generated by doxygen. Possible values are YES and NO. If left blank
645 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
646 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
647 # automatically be disabled.
649 WARN_IF_UNDOCUMENTED = NO
651 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
652 # potential errors in the documentation, such as not documenting some
653 # parameters in a documented function, or documenting parameters that
654 # don't exist or using markup commands wrongly.
656 WARN_IF_DOC_ERROR = YES
658 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
659 # functions that are documented, but have no documentation for their parameters
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
664 WARN_NO_PARAMDOC = NO
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
671 # be obtained via FILE_VERSION_FILTER)
673 WARN_FORMAT = "$file:$line: $text"
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
681 #---------------------------------------------------------------------------
682 # configuration options related to the input files
683 #---------------------------------------------------------------------------
685 # The INPUT tag can be used to specify the files and/or directories that contain
686 # documented source files. You may enter file names like "myfile.cpp" or
687 # directories like "/usr/src/myproject". Separate the files or directories
690 INPUT = ${EIGEN_DOXY_INPUT}
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.
698 INPUT_ENCODING = UTF-8
700 # If the value of the INPUT tag contains directories, you can use the
701 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
702 # and *.h) to filter out the source-files in the directories. If left
703 # blank the following patterns are tested:
704 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
705 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
706 # *.f90 *.f *.for *.vhd *.vhdl
710 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
711 # should be searched for input files as well. Possible values are YES and NO.
712 # If left blank NO is used.
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
722 EXCLUDE = "${Eigen_SOURCE_DIR}/Eigen/Eigen2Support" \
723 "${Eigen_SOURCE_DIR}/Eigen/src/Eigen2Support" \
724 "${Eigen_SOURCE_DIR}/doc/examples" \
725 "${Eigen_SOURCE_DIR}/doc/special_examples" \
726 "${Eigen_SOURCE_DIR}/doc/snippets" \
727 "${Eigen_SOURCE_DIR}/unsupported/doc/examples" \
728 "${Eigen_SOURCE_DIR}/unsupported/doc/snippets"
730 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
731 # directories that are symbolic links (a Unix file system feature) are excluded
734 EXCLUDE_SYMLINKS = NO
736 # If the value of the INPUT tag contains directories, you can use the
737 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
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/*
742 EXCLUDE_PATTERNS = CMake* \
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
761 # wildcard * is used, a substring. Examples: ANamespace, AClass,
762 # AClass::ANamespace, ANamespace::*Test
764 EXCLUDE_SYMBOLS = internal::* \
770 # The EXAMPLE_PATH tag can be used to specify one or more files or
771 # directories that contain example code fragments that are included (see
772 # the \include command).
774 EXAMPLE_PATH = "${Eigen_SOURCE_DIR}/doc/snippets" \
775 "${Eigen_BINARY_DIR}/doc/snippets" \
776 "${Eigen_SOURCE_DIR}/doc/examples" \
777 "${Eigen_BINARY_DIR}/doc/examples" \
778 "${Eigen_SOURCE_DIR}/doc/special_examples" \
779 "${Eigen_BINARY_DIR}/doc/special_examples" \
780 "${Eigen_SOURCE_DIR}/unsupported/doc/snippets" \
781 "${Eigen_BINARY_DIR}/unsupported/doc/snippets" \
782 "${Eigen_SOURCE_DIR}/unsupported/doc/examples" \
783 "${Eigen_BINARY_DIR}/unsupported/doc/examples"
785 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
786 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
787 # and *.h) to filter out the source-files in the directories. If left
788 # blank all files are included.
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.
795 # Possible values are YES and NO. If left blank NO is used.
797 EXAMPLE_RECURSIVE = NO
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
810 # to standard output.
811 # If FILTER_PATTERNS is specified, this tag will be
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
819 # filter if there is a match.
820 # The filters are a list of the form:
821 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
822 # info on how filters are used. If FILTER_PATTERNS is empty or if
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
829 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
831 FILTER_SOURCE_FILES = NO
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)
835 # and it is also possible to disable source filtering for a specific pattern
836 # using *.ext= (so without naming a filter). This option only has effect when
837 # FILTER_SOURCE_FILES is enabled.
839 FILTER_SOURCE_PATTERNS =
841 #---------------------------------------------------------------------------
842 # configuration options related to source browsing
843 #---------------------------------------------------------------------------
845 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
846 # be generated. Documented entities will be cross-referenced with these sources.
847 # Note: To get rid of all source code in the generated output, make sure also
848 # VERBATIM_HEADERS is set to NO.
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
858 # doxygen to hide any special comment blocks from generated source code
859 # fragments. Normal C, C++ and Fortran comments will always remain visible.
861 STRIP_CODE_COMMENTS = YES
863 # If the REFERENCED_BY_RELATION tag is set to YES
864 # then for each documented function all documented
865 # functions referencing it will be listed.
867 REFERENCED_BY_RELATION = YES
869 # If the REFERENCES_RELATION tag is set to YES
870 # then for each documented function all documented entities
871 # called/used by that function will be listed.
873 REFERENCES_RELATION = 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
877 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
878 # link to the source code.
879 # Otherwise they will link to the documentation.
881 REFERENCES_LINK_SOURCE = YES
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
886 # tagging system (see http://www.gnu.org/software/global/global.html). You
887 # will need version 4.8.6 or higher.
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
893 # which an include is specified. Set to NO to disable this.
895 VERBATIM_HEADERS = YES
897 #---------------------------------------------------------------------------
898 # configuration options related to the alphabetical class index
899 #---------------------------------------------------------------------------
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
903 # contains a lot of classes, structs, unions or interfaces.
905 ALPHABETICAL_INDEX = NO
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])
911 COLS_IN_ALPHA_INDEX = 5
913 # In case all classes in a project start with a common prefix, all
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.
920 #---------------------------------------------------------------------------
921 # configuration options related to the HTML output
922 #---------------------------------------------------------------------------
924 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
925 # generate HTML output.
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.
933 HTML_OUTPUT = "${Eigen_BINARY_DIR}/doc/html${EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX}"
935 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
936 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
937 # doxygen will generate files with .html extension.
939 HTML_FILE_EXTENSION = .html
941 # The HTML_HEADER tag can be used to specify a personal HTML header for
942 # each generated HTML page. If it is left blank doxygen will generate a
943 # standard header. Note that when using a custom header you are responsible
944 # for the proper inclusion of any scripts and style sheets that doxygen
945 # needs, which is dependent on the configuration options used.
946 # It is advised to generate a default header using "doxygen -w html
947 # header.html footer.html stylesheet.css YourConfigFile" and then modify
948 # that header. Note that the header is subject to change so you typically
949 # have to redo this when upgrading to a newer version of doxygen or when
950 # changing the value of configuration settings such as GENERATE_TREEVIEW!
952 HTML_HEADER = "${Eigen_BINARY_DIR}/doc/eigendoxy_header.html"
954 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
955 # each generated HTML page. If it is left blank doxygen will generate a
958 HTML_FOOTER = "${Eigen_BINARY_DIR}/doc/eigendoxy_footer.html"
960 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
961 # style sheet that is used by each HTML page. It can be used to
962 # fine-tune the look of the HTML output. If the tag is left blank doxygen
963 # will generate a default style sheet. Note that doxygen will try to copy
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.
976 HTML_EXTRA_FILES = "${Eigen_SOURCE_DIR}/doc/eigendoxy.css"
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
980 # according to this color. Hue is specified as an angle on a colorwheel,
981 # see http://en.wikipedia.org/wiki/Hue for more information.
982 # For instance the value 0 represents red, 60 is yellow, 120 is green,
983 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
984 # The allowed range is 0 to 359.
985 # The default is 220.
987 HTML_COLORSTYLE_HUE = ${EIGEN_DOXY_HTML_COLORSTYLE_HUE}
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.
993 HTML_COLORSTYLE_SAT = 100
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.
1002 HTML_COLORSTYLE_GAMMA = 80
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.
1008 HTML_TIMESTAMP = YES
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
1014 HTML_DYNAMIC_SECTIONS = YES
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
1018 # can expand and collapse entries dynamically later on. Doxygen will expand
1019 # the tree to such a level that at most the specified number of entries are
1020 # visible (unless a fully collapsed tree already exceeds this amount).
1021 # So setting the number of entries 1 will produce a full collapsed tree by
1022 # default. 0 is a special value representing an infinite number of entries
1023 # and will result in a full expanded tree by default.
1025 HTML_INDEX_NUM_ENTRIES = 100
1027 # If the GENERATE_DOCSET tag is set to YES, additional index files
1028 # will be generated that can be used as input for Apple's Xcode 3
1029 # integrated development environment, introduced with OSX 10.5 (Leopard).
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
1033 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1035 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1036 # for more information.
1038 GENERATE_DOCSET = NO
1040 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1041 # feed. A documentation feed provides an umbrella under which multiple
1042 # documentation sets from a single provider (such as a company or product suite)
1045 DOCSET_FEEDNAME = "Doxygen generated docs"
1047 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1048 # should uniquely identify the documentation set bundle. This should be a
1049 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1050 # will append .docset to the name.
1052 DOCSET_BUNDLE_ID = org.doxygen.Project
1054 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1055 # the documentation publisher. This should be a reverse domain-name style
1056 # string, e.g. com.mycompany.MyDocSet.documentation.
1058 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1060 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1062 DOCSET_PUBLISHER_NAME = 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
1066 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1067 # of the generated HTML documentation.
1069 GENERATE_HTMLHELP = NO
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
1086 # controls if a separate .chi index file is generated (YES) or that
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
1092 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1095 CHM_INDEX_ENCODING =
1097 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1098 # controls whether a binary table of contents is generated (YES) or a
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
1109 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1110 # that can be used as input for Qt's qhelpgenerator to generate a
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
1122 # Qt Help Project output. For more information please see
1123 # http://doc.trolltech.com/qthelpproject.html#namespace
1125 QHP_NAMESPACE = org.doxygen.Project
1127 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1128 # Qt Help Project output. For more information please see
1129 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1131 QHP_VIRTUAL_FOLDER = doc
1133 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1134 # add. For more information please see
1135 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1137 QHP_CUST_FILTER_NAME =
1139 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1140 # custom filter to add. For more information please see
1141 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1142 # Qt Help Project / Custom Filters</a>.
1144 QHP_CUST_FILTER_ATTRS =
1146 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1148 # filter section matches.
1149 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1150 # Qt Help Project / Filter Attributes</a>.
1152 QHP_SECT_FILTER_ATTRS =
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
1170 GENERATE_ECLIPSEHELP = NO
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
1176 ECLIPSE_DOC_ID = org.doxygen.Project
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
1181 # navigation tree you can set this option to NO if you already set
1182 # GENERATE_TREEVIEW to YES.
1186 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1187 # structure should be generated to display hierarchical information.
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
1190 # is generated for HTML Help). For this to work a browser that supports
1191 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
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
1194 # could consider to set DISABLE_INDEX to NO when enabling this option.
1196 GENERATE_TREEVIEW = YES
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.
1203 ENUM_VALUES_PER_LINE = 1
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
1209 TREEVIEW_WIDTH = 250
1211 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1212 # links to external symbols imported via tag files in a separate window.
1214 EXT_LINKS_IN_WINDOW = NO
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
1220 # to force them to be regenerated.
1222 FORMULA_FONTSIZE = 12
1224 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1225 # generated for formulas are transparent PNGs. Transparent PNGs are
1226 # not supported properly for IE 6.0, but are supported on all modern browsers.
1227 # Note that when changing this option you need to delete any form_*.png files
1228 # in the HTML output before the changes have effect.
1230 FORMULA_TRANSPARENT = YES
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
1234 # rendering instead of using prerendered bitmaps. Use this if you do not
1235 # have LaTeX installed or if you want to formulas look prettier in the HTML
1236 # output. When enabled you may also need to install MathJax separately and
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
1247 # installing MathJax.
1248 # However, it is strongly recommended to install a local
1249 # copy of MathJax from http://www.mathjax.org before deployment.
1251 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1253 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1254 # names that should be enabled during MathJax rendering.
1256 MATHJAX_EXTENSIONS =
1258 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1259 # for the HTML output. The underlying search engine uses javascript
1260 # and DHTML and should work on any modern browser. Note that when using
1261 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1262 # (GENERATE_DOCSET) there is already a search function so this one should
1263 # typically be disabled. For large projects the javascript based search engine
1264 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
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
1272 # based approach is that it scales better to large projects and allows
1273 # full text search. The disadvantages are that it is more difficult to setup
1274 # and does not have live searching capabilities.
1276 SERVER_BASED_SEARCH = NO
1278 #---------------------------------------------------------------------------
1279 # configuration options related to the LaTeX output
1280 #---------------------------------------------------------------------------
1282 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1283 # generate Latex output.
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.
1291 LATEX_OUTPUT = latex
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.
1295 # Note that when enabling USE_PDFLATEX this option is only used for
1296 # generating bitmaps for formulas in the HTML output, but not in the
1297 # Makefile that is written to the output directory.
1299 LATEX_CMD_NAME = latex
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
1303 # default command name.
1305 MAKEINDEX_CMD_NAME = makeindex
1307 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1308 # LaTeX documents. This may be useful for small projects and may help to
1309 # save some trees in general.
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
1315 # executive. If left blank a4wide will be used.
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.
1322 EXTRA_PACKAGES = amssymb \
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
1328 # standard header. Notice: only use this tag if you know what you are doing!
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
1335 # standard footer. Notice: only use this tag if you know what you are doing!
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
1348 # higher quality PDF documentation.
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.
1355 # This option is also used when generating formulas in HTML.
1357 LATEX_BATCHMODE = NO
1359 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1360 # include the index chapters (such as File Index, Compound Index, etc.)
1363 LATEX_HIDE_INDICES = NO
1365 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1366 # source code with syntax highlighting in the LaTeX output.
1367 # Note that which sources are shown also depends on other settings
1368 # such as SOURCE_BROWSER.
1370 LATEX_SOURCE_CODE = NO
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
1374 # http://en.wikipedia.org/wiki/BibTeX for more info.
1376 LATEX_BIB_STYLE = plain
1378 #---------------------------------------------------------------------------
1379 # configuration options related to the RTF output
1380 #---------------------------------------------------------------------------
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
1384 # other RTF readers or editors.
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
1395 # RTF documents. This may be useful for small projects and may help to
1396 # save some trees in general.
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
1404 # programs which support those fields.
1405 # Note: wordpad (write) and others do not support links.
1409 # Load style sheet definitions from file. Syntax is similar to doxygen's
1410 # config file, i.e. a series of assignments. You only have to provide
1411 # replacements, missing definitions are set to their default value.
1413 RTF_STYLESHEET_FILE =
1415 # Set optional variables used in the generation of an rtf document.
1416 # Syntax is similar to doxygen's config file.
1418 RTF_EXTENSIONS_FILE =
1420 #---------------------------------------------------------------------------
1421 # configuration options related to the man page output
1422 #---------------------------------------------------------------------------
1424 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1425 # generate man pages
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,
1441 # then it will generate one additional man file for each entity
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.
1448 #---------------------------------------------------------------------------
1449 # configuration options related to the XML output
1450 #---------------------------------------------------------------------------
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.
1481 XML_PROGRAMLISTING = YES
1483 #---------------------------------------------------------------------------
1484 # configuration options for the AutoGen Definitions output
1485 #---------------------------------------------------------------------------
1487 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1488 # generate an AutoGen Definitions (see autogen.sf.net) file
1489 # that captures the structure of the code including all
1490 # documentation. Note that this feature is still experimental
1491 # and incomplete at the moment.
1493 GENERATE_AUTOGEN_DEF = NO
1495 #---------------------------------------------------------------------------
1496 # configuration options related to the Perl module output
1497 #---------------------------------------------------------------------------
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
1505 GENERATE_PERLMOD = NO
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
1514 # nicely formatted so it can be parsed by a human reader.
1516 # if you want to understand what is going on.
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.
1521 PERLMOD_PRETTY = YES
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
1526 # Makefile don't overwrite each other's variables.
1528 PERLMOD_MAKEVAR_PREFIX =
1530 #---------------------------------------------------------------------------
1531 # Configuration options related to the preprocessor
1532 #---------------------------------------------------------------------------
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
1538 ENABLE_PREPROCESSING = YES
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
1542 # compilation will be performed. Macro expansion can be done in a controlled
1543 # way by setting EXPAND_ONLY_PREDEF to YES.
1545 MACRO_EXPANSION = YES
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
1549 # PREDEFINED and EXPAND_AS_DEFINED tags.
1551 EXPAND_ONLY_PREDEF = YES
1553 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1554 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1556 SEARCH_INCLUDES = YES
1558 # The INCLUDE_PATH tag can be used to specify one or more directories that
1559 # contain include files that are not input files but should be processed by
1562 INCLUDE_PATH = "${Eigen_SOURCE_DIR}/Eigen/src/plugins"
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
1569 INCLUDE_FILE_PATTERNS =
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
1575 # omitted =1 is assumed. To prevent a macro definition from being
1576 # undefined via #undef or recursively expanded use the := operator
1577 # instead of the = operator.
1579 PREDEFINED = EIGEN_EMPTY_STRUCT \
1580 EIGEN_PARSED_BY_DOXYGEN \
1583 EIGEN_STRONG_INLINE=inline \
1584 "EIGEN2_SUPPORT_STAGE=99" \
1585 "EIGEN_MAKE_CWISE_BINARY_OP(METHOD,FUNCTOR)=template<typename OtherDerived> const CwiseBinaryOp<FUNCTOR<Scalar>, const Derived, const OtherDerived> METHOD(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived> &other) const;" \
1586 "EIGEN_CWISE_PRODUCT_RETURN_TYPE(LHS,RHS)=CwiseBinaryOp<internal::scalar_product_op<typename LHS::Scalar, typename RHS::Scalar >, const LHS, const RHS>"
1588 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1589 # this tag can be used to specify a list of macro names that should be expanded.
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.
1594 EXPAND_AS_DEFINED = EIGEN_MAKE_TYPEDEFS \
1595 EIGEN_MAKE_FIXED_TYPEDEFS \
1596 EIGEN_MAKE_TYPEDEFS_ALL_SIZES \
1597 EIGEN_CWISE_UNOP_RETURN_TYPE \
1598 EIGEN_CWISE_BINOP_RETURN_TYPE \
1599 EIGEN_CURRENT_STORAGE_BASE_CLASS \
1600 EIGEN_MATHFUNC_IMPL \
1601 _EIGEN_GENERIC_PUBLIC_INTERFACE \
1604 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1605 # doxygen's preprocessor will remove all references to function-like macros
1606 # that are alone on a line, have an all uppercase name, and do not end with a
1607 # semicolon, because these will confuse the parser if not removed.
1609 SKIP_FUNCTION_MACROS = YES
1611 #---------------------------------------------------------------------------
1612 # Configuration::additions related to external references
1613 #---------------------------------------------------------------------------
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
1617 # format of a tag file without this location is as follows:
1619 # TAGFILES = file1 file2 ...
1620 # Adding location for the tag files is done as follows:
1622 # TAGFILES = file1=loc1 "file2 = loc2" ...
1623 # where "loc1" and "loc2" can be relative or absolute paths
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.
1628 TAGFILES = ${EIGEN_DOXY_TAGFILES}
1629 # "${Eigen_BINARY_DIR}/doc/eigen-unsupported.doxytags =unsupported"
1631 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1632 # a tag file that is based on the input files it reads.
1634 GENERATE_TAGFILE = "${Eigen_BINARY_DIR}/doc/${EIGEN_DOXY_PROJECT_NAME}.doxytags"
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
1646 EXTERNAL_GROUPS = YES
1648 # The PERL_PATH should be the absolute path and name of the perl script
1649 # interpreter (i.e. the result of `which perl').
1651 PERL_PATH = /usr/bin/perl
1653 #---------------------------------------------------------------------------
1654 # Configuration options related to the dot tool
1655 #---------------------------------------------------------------------------
1657 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1658 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1659 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1660 # this option also works with HAVE_DOT disabled, but it is recommended to
1661 # install and use dot, since it yields more powerful graphs.
1663 CLASS_DIAGRAMS = YES
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
1670 # default search path.
1674 # If set to YES, the inheritance and collaboration graphs will hide
1675 # inheritance and usage relations if the target is undocumented
1676 # or is not a class.
1678 HIDE_UNDOC_RELATIONS = NO
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
1691 # between CPU load and processing speed.
1695 # By default doxygen will use the Helvetica font for all dot files that
1696 # doxygen generates. When you want a differently looking font you can specify
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.
1710 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
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
1718 # CLASS_DIAGRAMS tag to NO.
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
1724 # indirect implementation dependencies (inheritance, containment, and
1725 # class references variables) of the class with other documented classes.
1727 COLLABORATION_GRAPH = NO
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.
1747 UML_LIMIT_NUM_FIELDS = 10
1749 # If set to YES, the inheritance and collaboration graphs will show the
1750 # relations between templates and their instances.
1752 TEMPLATE_RELATIONS = NO
1754 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1755 # tags are set to YES then doxygen will generate a graph for each documented
1756 # file showing the direct and indirect include dependencies of the file with
1757 # other documented files.
1761 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1762 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1763 # documented header file showing the documented files that directly or
1764 # indirectly include this file.
1766 INCLUDED_BY_GRAPH = NO
1768 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1769 # doxygen will generate a call dependency graph for every global function
1770 # or class method. Note that enabling this option will significantly increase
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
1777 # doxygen will generate a caller dependency graph for every global function
1778 # or class method. Note that enabling this option will significantly increase
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
1785 # will generate a graphical hierarchy of all classes instead of a textual one.
1787 GRAPHICAL_HIERARCHY = NO
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.
1794 DIRECTORY_GRAPH = NO
1796 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1797 # generated by dot. Possible values are svg, png, jpg, or gif.
1798 # If left blank png will be used. If you choose svg you need to set
1799 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1800 # visible in IE 9+ (other browsers do not have this requirement).
1802 DOT_IMAGE_FORMAT = png
1804 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1805 # enable generation of interactive SVG images that allow zooming and panning.
1806 # Note that this requires a modern browser other than Internet Explorer.
1807 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1808 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1809 # visible. Older versions of IE do not have SVG support.
1811 INTERACTIVE_SVG = NO
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
1820 # \dotfile command).
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
1826 # \mscfile command).
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.
1838 DOT_GRAPH_MAX_NODES = 50
1840 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1841 # graphs generated by dot. A depth value of 3 means that only nodes reachable
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
1846 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1848 MAX_DOT_GRAPH_DEPTH = 0
1850 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1851 # background. This is disabled by default, because dot on Windows does not
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
1854 # a graph (i.e. they become hard to read).
1856 DOT_TRANSPARENT = NO
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
1860 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1861 # support this, this feature is disabled by default.
1863 DOT_MULTI_TARGETS = NO
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.
1869 GENERATE_LEGEND = YES
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.