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
23DOXYFILE_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.
29PROJECT_NAME =
Eigen-unsupported
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
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.
50PROJECT_LOGO =
"/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.
57OUTPUT_DIRECTORY =
"/doc/unsupported"
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.
79OUTPUT_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.
86BRIEF_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"
105ABBREVIATE_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
121ALWAYS_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.
128INLINE_INHERITED_MEMB = NO
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
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.)
166JAVADOC_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
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.
182MULTILINE_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.
194SEPARATE_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.
208ALIASES =
"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 "not_reentrant=\warning This function is not re-entrant." \
210 "array_module=This is defined in the %Array module. \code #include <Eigen/Array> \endcode" \
211 "cholesky_module=This is defined in the %Cholesky module. \code #include <Eigen/Cholesky> \endcode" \
212 "eigenvalues_module=This is defined in the %Eigenvalues module. \code #include <Eigen/Eigenvalues> \endcode" \
213 "geometry_module=This is defined in the %Geometry module. \code #include <Eigen/Geometry> \endcode" \
214 "householder_module=This is defined in the %Householder module. \code #include <Eigen/Householder> \endcode" \
215 "jacobi_module=This is defined in the %Jacobi module. \code #include <Eigen/Jacobi> \endcode" \
216 "lu_module=This is defined in the %LU module. \code #include <Eigen/LU> \endcode" \
217 "qr_module=This is defined in the %QR module. \code #include <Eigen/QR> \endcode" \
218 "svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \
219 "specialfunctions_module=This is defined in the \b unsupported SpecialFunctions module. \code #include <Eigen/SpecialFunctions> \endcode" \
221 "matrixworld=<a href='#matrixonly' style='color:green;text-decoration: none;'>*</a>" \
222 "arrayworld=<a href='#arrayonly' style='color:blue;text-decoration: none;'>*</a>" \
223 "note_about_arbitrary_choice_of_solution=If there exists more than one solution, this method will arbitrarily choose one." \
224 "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()." \
225 "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." \
226 "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)." \
227 "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\"" \
228 "implsparsesolverconcept=This class follows the \link TutorialSparseSolverConcept sparse solver concept \endlink." \
230 "cpp11=<span class='cpp11'>[c++11]</span>" \
231 "cpp14=<span class='cpp14'>[c++14]</span>" \
232 "cpp17=<span class='cpp17'>[c++17]</span>" \
233 "newin{1}=<span class='newin3x'>New in %Eigen \1.</span>"
236ALIASES +=
"eigenAutoToc= "
237ALIASES +=
"eigenManualPage=\defgroup"
239# This tag can be used to specify a number of word-keyword mappings (TCL only).
240# A mapping has the form "name=value". For example adding
241# "class=itcl::class" will allow you to use the command class in the
242# itcl::class meaning.
246# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
247# sources only. Doxygen will then generate output that is more tailored for C.
248# For instance, some of the names that are used will be different. The list
249# of all members will be omitted, etc.
251OPTIMIZE_OUTPUT_FOR_C = NO
253# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
254# sources only. Doxygen will then generate output that is more tailored for
255# Java. For instance, namespaces will be presented as packages, qualified
256# scopes will look different, etc.
258OPTIMIZE_OUTPUT_JAVA = NO
260# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
261# sources only. Doxygen will then generate output that is more tailored for
264OPTIMIZE_FOR_FORTRAN = NO
266# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
267# sources. Doxygen will then generate output that is tailored for
270OPTIMIZE_OUTPUT_VHDL = NO
272# Doxygen selects the parser to use depending on the extension of the files it
273# parses. With this tag you can assign which parser to use for a given extension.
274# Doxygen has a built-in mapping, but you can override or extend it using this
275# tag. The format is ext=language, where ext is a file extension, and language
276# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
277# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
278# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
279# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
280# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
282EXTENSION_MAPPING = .h=C++ no_extension=C++
284# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
285# comments according to the Markdown format, which allows for more readable
286# documentation. See http:
287# The output of markdown processing is further processed by doxygen, so you
288# can mix doxygen, HTML, and XML commands with Markdown formatting.
289# Disable only in case of backward compatibilities issues.
291MARKDOWN_SUPPORT = YES
293# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
294# to include (a tag file for) the STL sources as input, then you should
295# set this tag to YES in order to let doxygen match functions declarations and
296# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
297# func(std::string) {}). This also makes the inheritance and collaboration
298# diagrams that involve STL classes more complete and accurate.
300BUILTIN_STL_SUPPORT = NO
302# If you use Microsoft's C++/CLI language, you should set this option to YES to
303# enable parsing support.
307# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
308# Doxygen will parse them like normal C++ but will assume all classes use public
309# instead of private inheritance when no explicit protection keyword is present.
313# For Microsoft's IDL there are propget and propput attributes to indicate getter
314# and setter methods for a property. Setting this option to YES (the default)
315# will make doxygen replace the get and set methods by a property in the
316# documentation. This will only work if the methods are indeed getting or
317# setting a simple type. If this is not the case, or you want to show the
318# methods anyway, you should set this option to NO.
320IDL_PROPERTY_SUPPORT = YES
322# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
323# tag is set to YES, then doxygen will reuse the documentation of the first
324# member in the group (if any) for the other members of the group. By default
325# all members of a group must be documented explicitly.
327DISTRIBUTE_GROUP_DOC = YES
329# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
330# the same type (for instance a group of public functions) to be put as a
331# subgroup of that type (e.g. under the Public Functions section). Set it to
332# NO to prevent subgrouping. Alternatively, this can be done per class using
333# the \nosubgrouping command.
337# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
338# unions are shown inside the group in which they are included (e.g. using
339# @ingroup) instead of on a separate page (for HTML and Man pages) or
340# section (for LaTeX and RTF).
342INLINE_GROUPED_CLASSES = NO
344# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
345# unions with only public data fields will be shown inline in the documentation
346# of the scope in which they are defined (i.e. file, namespace, or group
347# documentation), provided this scope is documented. If set to NO (the default),
348# structs, classes, and unions are shown on a separate page (for HTML and Man
349# pages) or section (for LaTeX and RTF).
351INLINE_SIMPLE_STRUCTS = NO
353# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
354# is documented as struct, union, or enum with the name of the typedef. So
355# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
356# with name TypeT. When disabled the typedef will appear as a member of a file,
357# namespace, or class. And the struct will be named TypeS. This can typically
358# be useful for C code in case the coding convention dictates that all compound
359# types are typedef'ed and only the typedef is referenced, never the tag name.
361TYPEDEF_HIDES_STRUCT = NO
363# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
364# determine which symbols to keep in memory and which to flush to disk.
365# When the cache is full, less often used symbols will be written to disk.
366# For small to medium size projects (<1000 input files) the default value is
367# probably good enough. For larger projects a too small cache size can cause
368# doxygen to be busy swapping symbols to and from disk most of the time
369# causing a significant performance penalty.
370# If the system has enough physical memory increasing the cache will improve the
371# performance by keeping more symbols in memory. Note that the value works on
372# a logarithmic scale so increasing the size by one will roughly double the
373# memory usage. The cache size is given by this formula:
374# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
375# corresponding to a cache size of 2^16 = 65536 symbols.
377# SYMBOL_CACHE_SIZE = 0
379# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
380# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
381# their name and scope. Since this can be an expensive process and often the
382# same symbol appear multiple times in the code, doxygen keeps a cache of
383# pre-resolved symbols. If the cache is too small doxygen will become slower.
384# If the cache is too large, memory is wasted. The cache size is given by this
385# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
386# corresponding to a cache size of 2^16 = 65536 symbols.
390#---------------------------------------------------------------------------
391# Build related configuration options
392#---------------------------------------------------------------------------
394# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
395# documentation are documented, even if no documentation was available.
396# Private class members and static file members will be hidden unless
397# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
401# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
402# will be included in the documentation.
406# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
410# If the EXTRACT_STATIC tag is set to YES all static members of a file
411# will be included in the documentation.
415# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
416# defined locally in source files will be included in the documentation.
417# If set to NO only classes defined in header files are included.
419EXTRACT_LOCAL_CLASSES = NO
421# This flag is only useful for Objective-C code. When set to YES local
422# methods, which are defined in the implementation section but not in
423# the interface are included in the documentation.
424# If set to NO (the default) only methods in the interface are included.
426EXTRACT_LOCAL_METHODS = NO
428# If this flag is set to YES, the members of anonymous namespaces will be
429# extracted and appear in the documentation as a namespace called
430# 'anonymous_namespace{file}', where file will be replaced with the base
431# name of the file that contains the anonymous namespace. By default
432# anonymous namespaces are hidden.
434EXTRACT_ANON_NSPACES = NO
436# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
437# undocumented members of documented classes, files or namespaces.
438# If set to NO (the default) these members will be included in the
439# various overviews, but no documentation section is generated.
440# This option has no effect if EXTRACT_ALL is enabled.
442HIDE_UNDOC_MEMBERS = YES
444# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
445# undocumented classes that are normally visible in the class hierarchy.
446# If set to NO (the default) these classes will be included in the various
447# overviews. This option has no effect if EXTRACT_ALL is enabled.
449HIDE_UNDOC_CLASSES = YES
451# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
452# friend (class|struct|union) declarations.
453# If set to NO (the default) these declarations will be included in the
456HIDE_FRIEND_COMPOUNDS = YES
458# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
459# documentation blocks found inside the body of a function.
460# If set to NO (the default) these blocks will be appended to the
461# function's detailed documentation block.
463HIDE_IN_BODY_DOCS = NO
465# The INTERNAL_DOCS tag determines if documentation
466# that is typed after a \internal command is included. If the tag is set
467# to NO (the default) then the documentation will be excluded.
468# Set it to YES to include the internal documentation.
472# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
473# file names in lower-case letters. If set to YES upper-case letters are also
474# allowed. This is useful if you have classes or files whose names only differ
475# in case and if your file system supports case sensitive file names. Windows
476# and Mac users are advised to set this option to NO.
478CASE_SENSE_NAMES = YES
480# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
481# will show members with their full class and namespace scopes in the
482# documentation. If set to YES the scope will be hidden.
486# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
487# will put a list of the files that are included by a file in the documentation
490SHOW_INCLUDE_FILES = NO
492# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
493# will list include files with double quotes in the documentation
494# rather than with sharp brackets.
496FORCE_LOCAL_INCLUDES = NO
498# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
499# is inserted in the documentation for inline members.
503# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
504# will sort the (detailed) documentation of file and class members
505# alphabetically by member name. If set to NO the members will appear in
508SORT_MEMBER_DOCS = YES
510# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
511# brief documentation of file, namespace and class members alphabetically
512# by member name. If set to NO (the default) the members will appear in
517# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
518# will sort the (brief and detailed) documentation of class members so that
519# constructors and destructors are listed first. If set to NO (the default)
520# the constructors will appear in the respective orders defined by
521# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
522# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
523# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
525SORT_MEMBERS_CTORS_1ST = NO
527# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
528# hierarchy of group names into alphabetical order. If set to NO (the default)
529# the group names will appear in their defined order.
533# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
534# sorted by fully-qualified names, including namespaces. If set to
535# NO (the default), the class list will be sorted only by class name,
536# not including the namespace part.
537# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
538# Note: This option applies only to the class list, not to the
541SORT_BY_SCOPE_NAME = NO
543# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
544# do proper type resolution of all parameters of a function it will reject a
545# match between the prototype and the implementation of a member function even
546# if there is only one candidate or it is obvious which candidate to choose
547# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
548# will still accept a match between prototype and implementation in such cases.
550STRICT_PROTO_MATCHING = NO
552# The GENERATE_TODOLIST tag can be used to enable (YES) or
553# disable (NO) the todo list. This list is created by putting \todo
554# commands in the documentation.
556GENERATE_TODOLIST = NO
558# The GENERATE_TESTLIST tag can be used to enable (YES) or
559# disable (NO) the test list. This list is created by putting \test
560# commands in the documentation.
562GENERATE_TESTLIST = NO
564# The GENERATE_BUGLIST tag can be used to enable (YES) or
565# disable (NO) the bug list. This list is created by putting \bug
566# commands in the documentation.
570# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
571# disable (NO) the deprecated list. This list is created by putting
572# \deprecated commands in the documentation.
574GENERATE_DEPRECATEDLIST= YES
576# The ENABLED_SECTIONS tag can be used to enable conditional
577# documentation sections, marked by \if sectionname ... \endif.
581# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
582# the initial value of a variable or macro consists of for it to appear in
583# the documentation. If the initializer consists of more lines than specified
584# here it will be hidden. Use a value of 0 to hide initializers completely.
585# The appearance of the initializer of individual variables and macros in the
586# documentation can be controlled using \showinitializer or \hideinitializer
587# command in the documentation regardless of this setting.
589MAX_INITIALIZER_LINES = 0
591# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
592# at the bottom of the documentation of classes and structs. If set to YES the
593# list will mention the files that were used to generate the documentation.
597# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
598# This will remove the Files entry from the Quick Index and from the
599# Folder Tree View (if specified). The default is YES.
603# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
605# This will remove the Namespaces entry from the Quick Index
606# and from the Folder Tree View (if specified). The default is YES.
610# The FILE_VERSION_FILTER tag can be used to specify a program or script that
611# doxygen should invoke to get the current version for each file (typically from
612# the version control system). Doxygen will invoke the program by executing (via
613# popen()) the command <command> <input-file>, where <command> is the value of
614# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
615# provided by doxygen. Whatever the program writes to standard output
616# is used as the file version. See the manual for examples.
620# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
621# by doxygen. The layout file controls the global structure of the generated
622# output files in an output format independent way. To create the layout file
623# that represents doxygen's defaults, run doxygen with the -l option.
624# You can optionally specify a file name after the option, if omitted
625# DoxygenLayout.xml will be used as the name of the layout file.
627LAYOUT_FILE =
"/doc/unsupported/eigendoxy_layout.xml"
629# The CITE_BIB_FILES tag can be used to specify one or more bib files
630# containing the references data. This must be a list of .bib files. The
631# .bib extension is automatically appended if omitted. Using this command
632# requires the bibtex tool to be installed. See also
634# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
635# feature you need bibtex and perl available in the search path.
639#---------------------------------------------------------------------------
640# configuration options related to warning and progress messages
641#---------------------------------------------------------------------------
643# The QUIET tag can be used to turn on/off the messages that are generated
644# by doxygen. Possible values are YES and NO. If left blank NO is used.
648# The WARNINGS tag can be used to turn on/off the warning messages that are
649# generated by doxygen. Possible values are YES and NO. If left blank
654# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
655# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
656# automatically be disabled.
658WARN_IF_UNDOCUMENTED = NO
660# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
661# potential errors in the documentation, such as not documenting some
662# parameters in a documented function, or documenting parameters that
663# don't exist or using markup commands wrongly.
665WARN_IF_DOC_ERROR = YES
667# The WARN_NO_PARAMDOC option can be enabled to get warnings for
668# functions that are documented, but have no documentation for their parameters
669# or return value. If set to NO (the default) doxygen will only warn about
670# wrong or incomplete parameter documentation, but not about the absence of
675# The WARN_FORMAT tag determines the format of the warning messages that
676# doxygen can produce. The string should contain the $file, $line, and $text
677# tags, which will be replaced by the file and line number from which the
678# warning originated and the warning text. Optionally the format may contain
679# $version, which will be replaced by the version of the file (if it could
680# be obtained via FILE_VERSION_FILTER)
682WARN_FORMAT =
"$file:$line: $text"
684# The WARN_LOGFILE tag can be used to specify a file to which warning
685# and error messages should be written. If left blank the output is written
690#---------------------------------------------------------------------------
691# configuration options related to the input files
692#---------------------------------------------------------------------------
694# The INPUT tag can be used to specify the files and/or directories that contain
695# documented source files. You may enter file names like "myfile.cpp" or
696# directories like "/usr/src/myproject". Separate the files or directories
699INPUT =
"/unsupported/Eigen" "/unsupported/doc"
701# This tag can be used to specify the character encoding of the source files
702# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
703# also the default input encoding. Doxygen uses libiconv (or the iconv built
704# into libc) for the transcoding. See http:
705# the list of possible encodings.
707INPUT_ENCODING = UTF-8
709# If the value of the INPUT tag contains directories, you can use the
710# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
711# and *.h) to filter out the source-files in the directories. If left
712# blank the following patterns are tested:
713# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
714# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
715# *.f90 *.f *.for *.vhd *.vhdl
719# The RECURSIVE tag can be used to turn specify whether or not subdirectories
720# should be searched for input files as well. Possible values are YES and NO.
721# If left blank NO is used.
725# The EXCLUDE tag can be used to specify files and/or directories that should be
726# excluded from the INPUT source files. This way you can easily exclude a
727# subdirectory from a directory tree whose root is specified with the INPUT tag.
728# Note that relative paths are relative to the directory from which doxygen is
731EXCLUDE =
"/Eigen/src/Core/products" \
732 "/Eigen/Eigen2Support" \
733 "/Eigen/src/Eigen2Support" \
735 "/doc/special_examples" \
737 "/unsupported/doc/examples" \
738 "/unsupported/doc/snippets"
740# Forward declarations of class templates cause the title of the main page for
741# the class template to not contain the template signature. This only happens
742# when the \class command is used to document the class. Possibly caused
744# doxygen release 1.8.19.
746EXCLUDE +=
"/Eigen/src/Core/util/ForwardDeclarations.h"
748# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
749# directories that are symbolic links (a Unix file system feature) are excluded
754# If the value of the INPUT tag contains directories, you can use the
755# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
756# certain files from those directories. Note that the wildcards are matched
757# against the file with absolute path, so to exclude all test directories
758# for example use the pattern */test
Namespace containing all symbols from the Eigen library.
Definition Core:137