1# Doxyfile 1.8.1.1 2 3# This file describes the settings to be used by the documentation system 4# doxygen (www.doxygen.org) for a project. 5# 6# All text after a hash (#) is considered a comment and will be ignored. 7# The format is: 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 (" "). 12 13#--------------------------------------------------------------------------- 14# Project related configuration options 15#--------------------------------------------------------------------------- 16 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. 22 23DOXYFILE_ENCODING = UTF-8 24 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. 28 29PROJECT_NAME = ${EIGEN_DOXY_PROJECT_NAME} 30 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. 34 35# EIGEN_VERSION is set in the root CMakeLists.txt 36 37PROJECT_NUMBER = "${EIGEN_VERSION}" 38 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. 42 43PROJECT_BRIEF = 44 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. 49 50PROJECT_LOGO = "${Eigen_SOURCE_DIR}/doc/Eigen_Silly_Professor_64x64.png" 51 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. 56 57OUTPUT_DIRECTORY = "${Eigen_BINARY_DIR}/doc${EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX}" 58 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. 65 66CREATE_SUBDIRS = NO 67 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. 78 79OUTPUT_LANGUAGE = English 80 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. 85 86BRIEF_MEMBER_DESC = YES 87 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. 92 93REPEAT_BRIEF = YES 94 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" 104 105ABBREVIATE_BRIEF = "The $name class" \ 106 "The $name widget" \ 107 "The $name file" \ 108 is \ 109 provides \ 110 specifies \ 111 contains \ 112 represents \ 113 a \ 114 an \ 115 the 116 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 119# description. 120 121ALWAYS_DETAILED_SEC = NO 122 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. 127 128INLINE_INHERITED_MEMB = NO 129 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. 133 134FULL_PATH_NAMES = NO 135 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 141# path to strip. 142 143STRIP_FROM_PATH = 144 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. 151 152STRIP_FROM_INC_PATH = 153 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. 157 158SHORT_NAMES = NO 159 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.) 165 166JAVADOC_AUTOBRIEF = NO 167 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.) 173 174QT_AUTOBRIEF = NO 175 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. 181 182MULTILINE_CPP_IS_BRIEF = NO 183 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 186# re-implements. 187 188INHERIT_DOCS = YES 189 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. 193 194SEPARATE_MEMBER_PAGES = NO 195 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. 198 199TAB_SIZE = 8 200 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. 207 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" \ 220 "label=\bug" \ 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." \ 229 "blank= " \ 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>" 234 235 236ALIASES += "eigenAutoToc= " 237ALIASES += "eigenManualPage=\defgroup" 238 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. 243 244TCL_SUBST = 245 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. 250 251OPTIMIZE_OUTPUT_FOR_C = NO 252 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. 257 258OPTIMIZE_OUTPUT_JAVA = NO 259 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 262# Fortran. 263 264OPTIMIZE_FOR_FORTRAN = NO 265 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 268# VHDL. 269 270OPTIMIZE_OUTPUT_VHDL = NO 271 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. 281 282EXTENSION_MAPPING = .h=C++ no_extension=C++ 283 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://daringfireball.net/projects/markdown/ for details. 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. 290 291MARKDOWN_SUPPORT = YES 292 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. 299 300BUILTIN_STL_SUPPORT = NO 301 302# If you use Microsoft's C++/CLI language, you should set this option to YES to 303# enable parsing support. 304 305CPP_CLI_SUPPORT = NO 306 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. 310 311SIP_SUPPORT = NO 312 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. 319 320IDL_PROPERTY_SUPPORT = YES 321 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. 326 327DISTRIBUTE_GROUP_DOC = YES 328 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. 334 335SUBGROUPING = YES 336 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). 341 342INLINE_GROUPED_CLASSES = NO 343 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). 350 351INLINE_SIMPLE_STRUCTS = NO 352 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. 360 361TYPEDEF_HIDES_STRUCT = NO 362 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. 376 377# SYMBOL_CACHE_SIZE = 0 378 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. 387 388LOOKUP_CACHE_SIZE = 0 389 390#--------------------------------------------------------------------------- 391# Build related configuration options 392#--------------------------------------------------------------------------- 393 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 398 399EXTRACT_ALL = NO 400 401# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 402# will be included in the documentation. 403 404EXTRACT_PRIVATE = NO 405 406# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. 407 408EXTRACT_PACKAGE = NO 409 410# If the EXTRACT_STATIC tag is set to YES all static members of a file 411# will be included in the documentation. 412 413EXTRACT_STATIC = YES 414 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. 418 419EXTRACT_LOCAL_CLASSES = NO 420 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. 425 426EXTRACT_LOCAL_METHODS = NO 427 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. 433 434EXTRACT_ANON_NSPACES = NO 435 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. 441 442HIDE_UNDOC_MEMBERS = YES 443 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. 448 449HIDE_UNDOC_CLASSES = YES 450 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 454# documentation. 455 456HIDE_FRIEND_COMPOUNDS = YES 457 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. 462 463HIDE_IN_BODY_DOCS = NO 464 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. 469 470INTERNAL_DOCS = ${EIGEN_DOXY_INTERNAL} 471 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. 477 478CASE_SENSE_NAMES = YES 479 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. 483 484HIDE_SCOPE_NAMES = NO 485 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 488# of that file. 489 490SHOW_INCLUDE_FILES = ${EIGEN_DOXY_INTERNAL} 491 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. 495 496FORCE_LOCAL_INCLUDES = NO 497 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. 500 501INLINE_INFO = YES 502 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 506# declaration order. 507 508SORT_MEMBER_DOCS = YES 509 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 513# declaration order. 514 515SORT_BRIEF_DOCS = YES 516 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. 524 525SORT_MEMBERS_CTORS_1ST = NO 526 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. 530 531SORT_GROUP_NAMES = NO 532 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 539# alphabetical list. 540 541SORT_BY_SCOPE_NAME = NO 542 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. 549 550STRICT_PROTO_MATCHING = NO 551 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. 555 556GENERATE_TODOLIST = ${EIGEN_DOXY_INTERNAL} 557 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. 561 562GENERATE_TESTLIST = NO 563 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. 567 568GENERATE_BUGLIST = ${EIGEN_DOXY_INTERNAL} 569 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. 573 574GENERATE_DEPRECATEDLIST= YES 575 576# The ENABLED_SECTIONS tag can be used to enable conditional 577# documentation sections, marked by \if sectionname ... \endif. 578 579ENABLED_SECTIONS = 580 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. 588 589MAX_INITIALIZER_LINES = 0 590 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. 594 595SHOW_USED_FILES = YES 596 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. 600 601SHOW_FILES = YES 602 603# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 604# Namespaces page. 605# This will remove the Namespaces entry from the Quick Index 606# and from the Folder Tree View (if specified). The default is YES. 607 608SHOW_NAMESPACES = NO 609 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. 617 618FILE_VERSION_FILTER = 619 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. 626 627LAYOUT_FILE = "${Eigen_BINARY_DIR}/doc${EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX}/eigendoxy_layout.xml" 628 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 633# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 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. 636 637CITE_BIB_FILES = 638 639#--------------------------------------------------------------------------- 640# configuration options related to warning and progress messages 641#--------------------------------------------------------------------------- 642 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. 645 646QUIET = NO 647 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 650# NO is used. 651 652WARNINGS = YES 653 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. 657 658WARN_IF_UNDOCUMENTED = NO 659 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. 664 665WARN_IF_DOC_ERROR = YES 666 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 671# documentation. 672 673WARN_NO_PARAMDOC = NO 674 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) 681 682WARN_FORMAT = "$file:$line: $text" 683 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 686# to stderr. 687 688WARN_LOGFILE = 689 690#--------------------------------------------------------------------------- 691# configuration options related to the input files 692#--------------------------------------------------------------------------- 693 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 697# with spaces. 698 699INPUT = ${EIGEN_DOXY_INPUT} 700 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://www.gnu.org/software/libiconv for 705# the list of possible encodings. 706 707INPUT_ENCODING = UTF-8 708 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 716 717FILE_PATTERNS = * 718 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. 722 723RECURSIVE = YES 724 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 729# run. 730 731EXCLUDE = "${Eigen_SOURCE_DIR}/Eigen/src/Core/products" \ 732 "${Eigen_SOURCE_DIR}/Eigen/Eigen2Support" \ 733 "${Eigen_SOURCE_DIR}/Eigen/src/Eigen2Support" \ 734 "${Eigen_SOURCE_DIR}/doc/examples" \ 735 "${Eigen_SOURCE_DIR}/doc/special_examples" \ 736 "${Eigen_SOURCE_DIR}/doc/snippets" \ 737 "${Eigen_SOURCE_DIR}/unsupported/doc/examples" \ 738 "${Eigen_SOURCE_DIR}/unsupported/doc/snippets" 739 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 743# by https://github.com/doxygen/doxygen/issues/7698. Confirmed fixed by 744# doxygen release 1.8.19. 745 746EXCLUDE += "${Eigen_SOURCE_DIR}/Eigen/src/Core/util/ForwardDeclarations.h" 747 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 750# from the input. 751 752EXCLUDE_SYMLINKS = NO 753 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/* 759 760EXCLUDE_PATTERNS = CMake* \ 761 *.txt \ 762 *.sh \ 763 *.orig \ 764 *.diff \ 765 diff \ 766 *~ \ 767 *. \ 768 *.sln \ 769 *.sdf \ 770 *.tmp \ 771 *.vcxproj \ 772 *.filters \ 773 *.user \ 774 *.suo 775 776# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 777# (namespaces, classes, functions, etc.) that should be excluded from the 778# output. The symbol name can be a fully qualified name, a word, or if the 779# wildcard * is used, a substring. Examples: ANamespace, AClass, 780# AClass::ANamespace, ANamespace::*Test 781 782EXCLUDE_SYMBOLS = internal::* \ 783 Flagged* \ 784 *InnerIterator* \ 785 DenseStorage<* \ 786 787 788# The EXAMPLE_PATH tag can be used to specify one or more files or 789# directories that contain example code fragments that are included (see 790# the \include command). 791 792EXAMPLE_PATH = "${Eigen_SOURCE_DIR}/doc/snippets" \ 793 "${Eigen_BINARY_DIR}/doc/snippets" \ 794 "${Eigen_SOURCE_DIR}/doc/examples" \ 795 "${Eigen_BINARY_DIR}/doc/examples" \ 796 "${Eigen_SOURCE_DIR}/doc/special_examples" \ 797 "${Eigen_BINARY_DIR}/doc/special_examples" \ 798 "${Eigen_SOURCE_DIR}/unsupported/doc/snippets" \ 799 "${Eigen_BINARY_DIR}/unsupported/doc/snippets" \ 800 "${Eigen_SOURCE_DIR}/unsupported/doc/examples" \ 801 "${Eigen_BINARY_DIR}/unsupported/doc/examples" 802 803# If the value of the EXAMPLE_PATH tag contains directories, you can use the 804# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 805# and *.h) to filter out the source-files in the directories. If left 806# blank all files are included. 807 808EXAMPLE_PATTERNS = * 809 810# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 811# searched for input files to be used with the \include or \dontinclude 812# commands irrespective of the value of the RECURSIVE tag. 813# Possible values are YES and NO. If left blank NO is used. 814 815EXAMPLE_RECURSIVE = NO 816 817# The IMAGE_PATH tag can be used to specify one or more files or 818# directories that contain image that are included in the documentation (see 819# the \image command). 820 821IMAGE_PATH = ${Eigen_BINARY_DIR}/doc/html 822 823# The INPUT_FILTER tag can be used to specify a program that doxygen should 824# invoke to filter for each input file. Doxygen will invoke the filter program 825# by executing (via popen()) the command <filter> <input-file>, where <filter> 826# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 827# input file. Doxygen will then use the output that the filter program writes 828# to standard output. 829# If FILTER_PATTERNS is specified, this tag will be 830# ignored. 831 832INPUT_FILTER = 833 834# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 835# basis. 836# Doxygen will compare the file name with each pattern and apply the 837# filter if there is a match. 838# The filters are a list of the form: 839# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 840# info on how filters are used. If FILTER_PATTERNS is empty or if 841# non of the patterns match the file name, INPUT_FILTER is applied. 842 843FILTER_PATTERNS = 844 845# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 846# INPUT_FILTER) will be used to filter the input files when producing source 847# files to browse (i.e. when SOURCE_BROWSER is set to YES). 848 849FILTER_SOURCE_FILES = NO 850 851# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 852# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 853# and it is also possible to disable source filtering for a specific pattern 854# using *.ext= (so without naming a filter). This option only has effect when 855# FILTER_SOURCE_FILES is enabled. 856 857FILTER_SOURCE_PATTERNS = 858 859#--------------------------------------------------------------------------- 860# configuration options related to source browsing 861#--------------------------------------------------------------------------- 862 863# If the SOURCE_BROWSER tag is set to YES then a list of source files will 864# be generated. Documented entities will be cross-referenced with these sources. 865# Note: To get rid of all source code in the generated output, make sure also 866# VERBATIM_HEADERS is set to NO. 867 868SOURCE_BROWSER = NO 869 870# Setting the INLINE_SOURCES tag to YES will include the body 871# of functions and classes directly in the documentation. 872 873INLINE_SOURCES = NO 874 875# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 876# doxygen to hide any special comment blocks from generated source code 877# fragments. Normal C, C++ and Fortran comments will always remain visible. 878 879STRIP_CODE_COMMENTS = YES 880 881# If the REFERENCED_BY_RELATION tag is set to YES 882# then for each documented function all documented 883# functions referencing it will be listed. 884 885REFERENCED_BY_RELATION = NO 886 887# If the REFERENCES_RELATION tag is set to YES 888# then for each documented function all documented entities 889# called/used by that function will be listed. 890 891REFERENCES_RELATION = NO 892 893# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 894# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 895# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 896# link to the source code. 897# Otherwise they will link to the documentation. 898 899REFERENCES_LINK_SOURCE = YES 900 901# If the USE_HTAGS tag is set to YES then the references to source code 902# will point to the HTML generated by the htags(1) tool instead of doxygen 903# built-in source browser. The htags tool is part of GNU's global source 904# tagging system (see http://www.gnu.org/software/global/global.html). You 905# will need version 4.8.6 or higher. 906 907USE_HTAGS = NO 908 909# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 910# will generate a verbatim copy of the header file for each class for 911# which an include is specified. Set to NO to disable this. 912 913VERBATIM_HEADERS = YES 914 915#--------------------------------------------------------------------------- 916# configuration options related to the alphabetical class index 917#--------------------------------------------------------------------------- 918 919# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 920# of all compounds will be generated. Enable this if the project 921# contains a lot of classes, structs, unions or interfaces. 922 923ALPHABETICAL_INDEX = NO 924 925# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 926# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 927# in which this list will be split (can be a number in the range [1..20]) 928 929COLS_IN_ALPHA_INDEX = 5 930 931# In case all classes in a project start with a common prefix, all 932# classes will be put under the same header in the alphabetical index. 933# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 934# should be ignored while generating the index headers. 935 936IGNORE_PREFIX = 937 938#--------------------------------------------------------------------------- 939# configuration options related to the HTML output 940#--------------------------------------------------------------------------- 941 942# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 943# generate HTML output. 944 945GENERATE_HTML = YES 946 947# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 948# If a relative path is entered the value of OUTPUT_DIRECTORY will be 949# put in front of it. If left blank `html' will be used as the default path. 950 951HTML_OUTPUT = "${Eigen_BINARY_DIR}/doc/html${EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX}" 952 953# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 954# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 955# doxygen will generate files with .html extension. 956 957HTML_FILE_EXTENSION = .html 958 959# The HTML_HEADER tag can be used to specify a personal HTML header for 960# each generated HTML page. If it is left blank doxygen will generate a 961# standard header. Note that when using a custom header you are responsible 962# for the proper inclusion of any scripts and style sheets that doxygen 963# needs, which is dependent on the configuration options used. 964# It is advised to generate a default header using "doxygen -w html 965# header.html footer.html stylesheet.css YourConfigFile" and then modify 966# that header. Note that the header is subject to change so you typically 967# have to redo this when upgrading to a newer version of doxygen or when 968# changing the value of configuration settings such as GENERATE_TREEVIEW! 969 970HTML_HEADER = "${Eigen_BINARY_DIR}/doc/eigendoxy_header.html" 971 972# The HTML_FOOTER tag can be used to specify a personal HTML footer for 973# each generated HTML page. If it is left blank doxygen will generate a 974# standard footer. 975 976HTML_FOOTER = "${Eigen_BINARY_DIR}/doc/eigendoxy_footer.html" 977 978# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 979# style sheet that is used by each HTML page. It can be used to 980# fine-tune the look of the HTML output. If the tag is left blank doxygen 981# will generate a default style sheet. Note that doxygen will try to copy 982# the style sheet file to the HTML output directory, so don't put your own 983# style sheet in the HTML output directory as well, or it will be erased! 984 985HTML_STYLESHEET = 986 987# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 988# other source files which should be copied to the HTML output directory. Note 989# that these files will be copied to the base HTML output directory. Use the 990# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 991# files. In the HTML_STYLESHEET file, use the file name only. Also note that 992# the files will be copied as-is; there are no commands or markers available. 993 994HTML_EXTRA_FILES = "${Eigen_SOURCE_DIR}/doc/eigendoxy.css" 995 996# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 997# Doxygen will adjust the colors in the style sheet and background images 998# according to this color. Hue is specified as an angle on a colorwheel, 999# see http://en.wikipedia.org/wiki/Hue for more information. 1000# For instance the value 0 represents red, 60 is yellow, 120 is green, 1001# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 1002# The allowed range is 0 to 359. 1003# The default is 220. 1004 1005HTML_COLORSTYLE_HUE = ${EIGEN_DOXY_HTML_COLORSTYLE_HUE} 1006 1007# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 1008# the colors in the HTML output. For a value of 0 the output will use 1009# grayscales only. A value of 255 will produce the most vivid colors. 1010 1011HTML_COLORSTYLE_SAT = 100 1012 1013# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 1014# the luminance component of the colors in the HTML output. Values below 1015# 100 gradually make the output lighter, whereas values above 100 make 1016# the output darker. The value divided by 100 is the actual gamma applied, 1017# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 1018# and 100 does not change the gamma. 1019 1020HTML_COLORSTYLE_GAMMA = 80 1021 1022# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1023# page will contain the date and time when the page was generated. Setting 1024# this to NO can help when comparing the output of multiple runs. 1025 1026HTML_TIMESTAMP = YES 1027 1028# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1029# documentation will contain sections that can be hidden and shown after the 1030# page has loaded. 1031 1032HTML_DYNAMIC_SECTIONS = YES 1033 1034# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 1035# entries shown in the various tree structured indices initially; the user 1036# can expand and collapse entries dynamically later on. Doxygen will expand 1037# the tree to such a level that at most the specified number of entries are 1038# visible (unless a fully collapsed tree already exceeds this amount). 1039# So setting the number of entries 1 will produce a full collapsed tree by 1040# default. 0 is a special value representing an infinite number of entries 1041# and will result in a full expanded tree by default. 1042 1043HTML_INDEX_NUM_ENTRIES = 100 1044 1045# If the GENERATE_DOCSET tag is set to YES, additional index files 1046# will be generated that can be used as input for Apple's Xcode 3 1047# integrated development environment, introduced with OSX 10.5 (Leopard). 1048# To create a documentation set, doxygen will generate a Makefile in the 1049# HTML output directory. Running make will produce the docset in that 1050# directory and running "make install" will install the docset in 1051# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 1052# it at startup. 1053# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1054# for more information. 1055 1056GENERATE_DOCSET = NO 1057 1058# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 1059# feed. A documentation feed provides an umbrella under which multiple 1060# documentation sets from a single provider (such as a company or product suite) 1061# can be grouped. 1062 1063DOCSET_FEEDNAME = "Doxygen generated docs" 1064 1065# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 1066# should uniquely identify the documentation set bundle. This should be a 1067# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 1068# will append .docset to the name. 1069 1070DOCSET_BUNDLE_ID = org.doxygen.Project 1071 1072# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 1073# the documentation publisher. This should be a reverse domain-name style 1074# string, e.g. com.mycompany.MyDocSet.documentation. 1075 1076DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1077 1078# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1079 1080DOCSET_PUBLISHER_NAME = Publisher 1081 1082# If the GENERATE_HTMLHELP tag is set to YES, additional index files 1083# will be generated that can be used as input for tools like the 1084# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 1085# of the generated HTML documentation. 1086 1087GENERATE_HTMLHELP = NO 1088 1089# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 1090# be used to specify the file name of the resulting .chm file. You 1091# can add a path in front of the file if the result should not be 1092# written to the html output directory. 1093 1094CHM_FILE = 1095 1096# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1097# be used to specify the location (absolute path including file name) of 1098# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1099# the HTML help compiler on the generated index.hhp. 1100 1101HHC_LOCATION = 1102 1103# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1104# controls if a separate .chi index file is generated (YES) or that 1105# it should be included in the master .chm file (NO). 1106 1107GENERATE_CHI = NO 1108 1109# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 1110# is used to encode HtmlHelp index (hhk), content (hhc) and project file 1111# content. 1112 1113CHM_INDEX_ENCODING = 1114 1115# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1116# controls whether a binary table of contents is generated (YES) or a 1117# normal table of contents (NO) in the .chm file. 1118 1119BINARY_TOC = NO 1120 1121# The TOC_EXPAND flag can be set to YES to add extra items for group members 1122# to the contents of the HTML help documentation and to the tree view. 1123 1124TOC_EXPAND = NO 1125 1126# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1127# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1128# that can be used as input for Qt's qhelpgenerator to generate a 1129# Qt Compressed Help (.qch) of the generated HTML documentation. 1130 1131GENERATE_QHP = NO 1132 1133# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 1134# be used to specify the file name of the resulting .qch file. 1135# The path specified is relative to the HTML output folder. 1136 1137QCH_FILE = 1138 1139# The QHP_NAMESPACE tag specifies the namespace to use when generating 1140# Qt Help Project output. For more information please see 1141# http://doc.trolltech.com/qthelpproject.html#namespace 1142 1143QHP_NAMESPACE = org.doxygen.Project 1144 1145# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1146# Qt Help Project output. For more information please see 1147# http://doc.trolltech.com/qthelpproject.html#virtual-folders 1148 1149QHP_VIRTUAL_FOLDER = doc 1150 1151# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1152# add. For more information please see 1153# http://doc.trolltech.com/qthelpproject.html#custom-filters 1154 1155QHP_CUST_FILTER_NAME = 1156 1157# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1158# custom filter to add. For more information please see 1159# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1160# Qt Help Project / Custom Filters</a>. 1161 1162QHP_CUST_FILTER_ATTRS = 1163 1164# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1165# project's 1166# filter section matches. 1167# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1168# Qt Help Project / Filter Attributes</a>. 1169 1170QHP_SECT_FILTER_ATTRS = 1171 1172# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1173# be used to specify the location of Qt's qhelpgenerator. 1174# If non-empty doxygen will try to run qhelpgenerator on the generated 1175# .qhp file. 1176 1177QHG_LOCATION = 1178 1179# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1180# will be generated, which together with the HTML files, form an Eclipse help 1181# plugin. To install this plugin and make it available under the help contents 1182# menu in Eclipse, the contents of the directory containing the HTML and XML 1183# files needs to be copied into the plugins directory of eclipse. The name of 1184# the directory within the plugins directory should be the same as 1185# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1186# the help appears. 1187 1188GENERATE_ECLIPSEHELP = NO 1189 1190# A unique identifier for the eclipse help plugin. When installing the plugin 1191# the directory name containing the HTML and XML files should also have 1192# this name. 1193 1194ECLIPSE_DOC_ID = org.doxygen.Project 1195 1196# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1197# at top of each HTML page. The value NO (the default) enables the index and 1198# the value YES disables it. Since the tabs have the same information as the 1199# navigation tree you can set this option to NO if you already set 1200# GENERATE_TREEVIEW to YES. 1201 1202DISABLE_INDEX = YES 1203 1204# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1205# structure should be generated to display hierarchical information. 1206# If the tag value is set to YES, a side panel will be generated 1207# containing a tree-like index structure (just like the one that 1208# is generated for HTML Help). For this to work a browser that supports 1209# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1210# Windows users are probably better off using the HTML help feature. 1211# Since the tree basically has the same information as the tab index you 1212# could consider to set DISABLE_INDEX to NO when enabling this option. 1213 1214GENERATE_TREEVIEW = YES 1215 1216# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1217# (range [0,1..20]) that doxygen will group on one line in the generated HTML 1218# documentation. Note that a value of 0 will completely suppress the enum 1219# values from appearing in the overview section. 1220 1221ENUM_VALUES_PER_LINE = 1 1222 1223# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1224# used to set the initial width (in pixels) of the frame in which the tree 1225# is shown. 1226 1227TREEVIEW_WIDTH = 250 1228 1229# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1230# links to external symbols imported via tag files in a separate window. 1231 1232EXT_LINKS_IN_WINDOW = NO 1233 1234# Use this tag to change the font size of Latex formulas included 1235# as images in the HTML documentation. The default is 10. Note that 1236# when you change the font size after a successful doxygen run you need 1237# to manually remove any form_*.png images from the HTML output directory 1238# to force them to be regenerated. 1239 1240FORMULA_FONTSIZE = 12 1241 1242# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1243# generated for formulas are transparent PNGs. Transparent PNGs are 1244# not supported properly for IE 6.0, but are supported on all modern browsers. 1245# Note that when changing this option you need to delete any form_*.png files 1246# in the HTML output before the changes have effect. 1247 1248FORMULA_TRANSPARENT = YES 1249 1250# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1251# (see http://www.mathjax.org) which uses client side Javascript for the 1252# rendering instead of using prerendered bitmaps. Use this if you do not 1253# have LaTeX installed or if you want to formulas look prettier in the HTML 1254# output. When enabled you may also need to install MathJax separately and 1255# configure the path to it using the MATHJAX_RELPATH option. 1256 1257USE_MATHJAX = @EIGEN_DOXY_USE_MATHJAX@ 1258 1259# When MathJax is enabled you need to specify the location relative to the 1260# HTML output directory using the MATHJAX_RELPATH option. The destination 1261# directory should contain the MathJax.js script. For instance, if the mathjax 1262# directory is located at the same level as the HTML output directory, then 1263# MATHJAX_RELPATH should be ../mathjax. The default value points to 1264# the MathJax Content Delivery Network so you can quickly see the result without 1265# installing MathJax. 1266# However, it is strongly recommended to install a local 1267# copy of MathJax from http://www.mathjax.org before deployment. 1268 1269MATHJAX_RELPATH = https://cdn.mathjax.org/mathjax/latest 1270 1271# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1272# names that should be enabled during MathJax rendering. 1273 1274MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1275 1276# When the SEARCHENGINE tag is enabled doxygen will generate a search box 1277# for the HTML output. The underlying search engine uses javascript 1278# and DHTML and should work on any modern browser. Note that when using 1279# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1280# (GENERATE_DOCSET) there is already a search function so this one should 1281# typically be disabled. For large projects the javascript based search engine 1282# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1283 1284SEARCHENGINE = YES 1285 1286# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1287# implemented using a PHP enabled web server instead of at the web client 1288# using Javascript. Doxygen will generate the search PHP script and index 1289# file to put on the web server. The advantage of the server 1290# based approach is that it scales better to large projects and allows 1291# full text search. The disadvantages are that it is more difficult to setup 1292# and does not have live searching capabilities. 1293 1294SERVER_BASED_SEARCH = NO 1295 1296#--------------------------------------------------------------------------- 1297# configuration options related to the LaTeX output 1298#--------------------------------------------------------------------------- 1299 1300# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1301# generate Latex output. 1302 1303GENERATE_LATEX = NO 1304 1305# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1306# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1307# put in front of it. If left blank `latex' will be used as the default path. 1308 1309LATEX_OUTPUT = latex 1310 1311# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1312# invoked. If left blank `latex' will be used as the default command name. 1313# Note that when enabling USE_PDFLATEX this option is only used for 1314# generating bitmaps for formulas in the HTML output, but not in the 1315# Makefile that is written to the output directory. 1316 1317LATEX_CMD_NAME = latex 1318 1319# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1320# generate index for LaTeX. If left blank `makeindex' will be used as the 1321# default command name. 1322 1323MAKEINDEX_CMD_NAME = makeindex 1324 1325# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1326# LaTeX documents. This may be useful for small projects and may help to 1327# save some trees in general. 1328 1329COMPACT_LATEX = NO 1330 1331# The PAPER_TYPE tag can be used to set the paper type that is used 1332# by the printer. Possible values are: a4, letter, legal and 1333# executive. If left blank a4wide will be used. 1334 1335PAPER_TYPE = a4wide 1336 1337# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1338# packages that should be included in the LaTeX output. 1339 1340EXTRA_PACKAGES = amssymb \ 1341 amsmath 1342 1343# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1344# the generated latex document. The header should contain everything until 1345# the first chapter. If it is left blank doxygen will generate a 1346# standard header. Notice: only use this tag if you know what you are doing! 1347 1348LATEX_HEADER = 1349 1350# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1351# the generated latex document. The footer should contain everything after 1352# the last chapter. If it is left blank doxygen will generate a 1353# standard footer. Notice: only use this tag if you know what you are doing! 1354 1355LATEX_FOOTER = 1356 1357# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1358# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1359# contain links (just like the HTML output) instead of page references 1360# This makes the output suitable for online browsing using a pdf viewer. 1361 1362PDF_HYPERLINKS = NO 1363 1364# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1365# plain latex in the generated Makefile. Set this option to YES to get a 1366# higher quality PDF documentation. 1367 1368USE_PDFLATEX = NO 1369 1370# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1371# command to the generated LaTeX files. This will instruct LaTeX to keep 1372# running if errors occur, instead of asking the user for help. 1373# This option is also used when generating formulas in HTML. 1374 1375LATEX_BATCHMODE = NO 1376 1377# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1378# include the index chapters (such as File Index, Compound Index, etc.) 1379# in the output. 1380 1381LATEX_HIDE_INDICES = NO 1382 1383# If LATEX_SOURCE_CODE is set to YES then doxygen will include 1384# source code with syntax highlighting in the LaTeX output. 1385# Note that which sources are shown also depends on other settings 1386# such as SOURCE_BROWSER. 1387 1388LATEX_SOURCE_CODE = NO 1389 1390# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1391# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1392# http://en.wikipedia.org/wiki/BibTeX for more info. 1393 1394LATEX_BIB_STYLE = plain 1395 1396#--------------------------------------------------------------------------- 1397# configuration options related to the RTF output 1398#--------------------------------------------------------------------------- 1399 1400# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1401# The RTF output is optimized for Word 97 and may not look very pretty with 1402# other RTF readers or editors. 1403 1404GENERATE_RTF = NO 1405 1406# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1407# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1408# put in front of it. If left blank `rtf' will be used as the default path. 1409 1410RTF_OUTPUT = rtf 1411 1412# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1413# RTF documents. This may be useful for small projects and may help to 1414# save some trees in general. 1415 1416COMPACT_RTF = NO 1417 1418# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1419# will contain hyperlink fields. The RTF file will 1420# contain links (just like the HTML output) instead of page references. 1421# This makes the output suitable for online browsing using WORD or other 1422# programs which support those fields. 1423# Note: wordpad (write) and others do not support links. 1424 1425RTF_HYPERLINKS = NO 1426 1427# Load style sheet definitions from file. Syntax is similar to doxygen's 1428# config file, i.e. a series of assignments. You only have to provide 1429# replacements, missing definitions are set to their default value. 1430 1431RTF_STYLESHEET_FILE = 1432 1433# Set optional variables used in the generation of an rtf document. 1434# Syntax is similar to doxygen's config file. 1435 1436RTF_EXTENSIONS_FILE = 1437 1438#--------------------------------------------------------------------------- 1439# configuration options related to the man page output 1440#--------------------------------------------------------------------------- 1441 1442# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1443# generate man pages 1444 1445GENERATE_MAN = NO 1446 1447# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1448# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1449# put in front of it. If left blank `man' will be used as the default path. 1450 1451MAN_OUTPUT = man 1452 1453# The MAN_EXTENSION tag determines the extension that is added to 1454# the generated man pages (default is the subroutine's section .3) 1455 1456MAN_EXTENSION = .3 1457 1458# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1459# then it will generate one additional man file for each entity 1460# documented in the real man page(s). These additional files 1461# only source the real man page, but without them the man command 1462# would be unable to find the correct page. The default is NO. 1463 1464MAN_LINKS = NO 1465 1466#--------------------------------------------------------------------------- 1467# configuration options related to the XML output 1468#--------------------------------------------------------------------------- 1469 1470# If the GENERATE_XML tag is set to YES Doxygen will 1471# generate an XML file that captures the structure of 1472# the code including all documentation. 1473 1474GENERATE_XML = NO 1475 1476# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1477# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1478# put in front of it. If left blank `xml' will be used as the default path. 1479 1480XML_OUTPUT = xml 1481 1482# The XML_SCHEMA tag can be used to specify an XML schema, 1483# which can be used by a validating XML parser to check the 1484# syntax of the XML files. 1485 1486# XML_SCHEMA = 1487 1488# The XML_DTD tag can be used to specify an XML DTD, 1489# which can be used by a validating XML parser to check the 1490# syntax of the XML files. 1491 1492# XML_DTD = 1493 1494# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1495# dump the program listings (including syntax highlighting 1496# and cross-referencing information) to the XML output. Note that 1497# enabling this will significantly increase the size of the XML output. 1498 1499XML_PROGRAMLISTING = YES 1500 1501#--------------------------------------------------------------------------- 1502# configuration options for the AutoGen Definitions output 1503#--------------------------------------------------------------------------- 1504 1505# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1506# generate an AutoGen Definitions (see autogen.sf.net) file 1507# that captures the structure of the code including all 1508# documentation. Note that this feature is still experimental 1509# and incomplete at the moment. 1510 1511GENERATE_AUTOGEN_DEF = NO 1512 1513#--------------------------------------------------------------------------- 1514# configuration options related to the Perl module output 1515#--------------------------------------------------------------------------- 1516 1517# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1518# generate a Perl module file that captures the structure of 1519# the code including all documentation. Note that this 1520# feature is still experimental and incomplete at the 1521# moment. 1522 1523GENERATE_PERLMOD = NO 1524 1525# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1526# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1527# to generate PDF and DVI output from the Perl module output. 1528 1529PERLMOD_LATEX = NO 1530 1531# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1532# nicely formatted so it can be parsed by a human reader. 1533# This is useful 1534# if you want to understand what is going on. 1535# On the other hand, if this 1536# tag is set to NO the size of the Perl module output will be much smaller 1537# and Perl will parse it just the same. 1538 1539PERLMOD_PRETTY = YES 1540 1541# The names of the make variables in the generated doxyrules.make file 1542# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1543# This is useful so different doxyrules.make files included by the same 1544# Makefile don't overwrite each other's variables. 1545 1546PERLMOD_MAKEVAR_PREFIX = 1547 1548#--------------------------------------------------------------------------- 1549# Configuration options related to the preprocessor 1550#--------------------------------------------------------------------------- 1551 1552# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1553# evaluate all C-preprocessor directives found in the sources and include 1554# files. 1555 1556ENABLE_PREPROCESSING = YES 1557 1558# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1559# names in the source code. If set to NO (the default) only conditional 1560# compilation will be performed. Macro expansion can be done in a controlled 1561# way by setting EXPAND_ONLY_PREDEF to YES. 1562 1563MACRO_EXPANSION = YES 1564 1565# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1566# then the macro expansion is limited to the macros specified with the 1567# PREDEFINED and EXPAND_AS_DEFINED tags. 1568 1569EXPAND_ONLY_PREDEF = YES 1570 1571# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1572# pointed to by INCLUDE_PATH will be searched when a #include is found. 1573 1574SEARCH_INCLUDES = YES 1575 1576# The INCLUDE_PATH tag can be used to specify one or more directories that 1577# contain include files that are not input files but should be processed by 1578# the preprocessor. 1579 1580INCLUDE_PATH = "${Eigen_SOURCE_DIR}/Eigen/src/plugins" 1581 1582# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1583# patterns (like *.h and *.hpp) to filter out the header-files in the 1584# directories. If left blank, the patterns specified with FILE_PATTERNS will 1585# be used. 1586 1587INCLUDE_FILE_PATTERNS = 1588 1589# The PREDEFINED tag can be used to specify one or more macro names that 1590# are defined before the preprocessor is started (similar to the -D option of 1591# gcc). The argument of the tag is a list of macros of the form: name 1592# or name=definition (no spaces). If the definition and the = are 1593# omitted =1 is assumed. To prevent a macro definition from being 1594# undefined via #undef or recursively expanded use the := operator 1595# instead of the = operator. 1596 1597PREDEFINED = EIGEN_EMPTY_STRUCT \ 1598 EIGEN_PARSED_BY_DOXYGEN \ 1599 EIGEN_VECTORIZE \ 1600 EIGEN_QT_SUPPORT \ 1601 EIGEN_STRONG_INLINE=inline \ 1602 EIGEN_DEVICE_FUNC= \ 1603 EIGEN_HAS_CXX11=1 \ 1604 EIGEN_HAS_CXX11_MATH=1 \ 1605 "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;" \ 1606 "EIGEN_CWISE_PRODUCT_RETURN_TYPE(LHS,RHS)=CwiseBinaryOp<internal::scalar_product_op<LHS::Scalar,RHS::Scalar>, const LHS, const RHS>"\ 1607 "EIGEN_CAT2(a,b)= a ## b"\ 1608 "EIGEN_CAT(a,b)=EIGEN_CAT2(a,b)"\ 1609 "EIGEN_CWISE_BINARY_RETURN_TYPE(LHS,RHS,OPNAME)=CwiseBinaryOp<EIGEN_CAT(EIGEN_CAT(internal::scalar_,OPNAME),_op)<LHS::Scalar, RHS::Scalar>, const LHS, const RHS>"\ 1610 "EIGEN_ALIGN_TO_BOUNDARY(x)="\ 1611 DOXCOMMA=, 1612 1613 1614# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1615# this tag can be used to specify a list of macro names that should be expanded. 1616# The macro definition that is found in the sources will be used. 1617# Use the PREDEFINED tag if you want to use a different macro definition that 1618# overrules the definition found in the source code. 1619 1620EXPAND_AS_DEFINED = EIGEN_MAKE_TYPEDEFS \ 1621 EIGEN_MAKE_FIXED_TYPEDEFS \ 1622 EIGEN_MAKE_TYPEDEFS_ALL_SIZES \ 1623 EIGEN_MAKE_ARRAY_TYPEDEFS \ 1624 EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS \ 1625 EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES \ 1626 EIGEN_CWISE_UNOP_RETURN_TYPE \ 1627 EIGEN_CWISE_BINOP_RETURN_TYPE \ 1628 EIGEN_CURRENT_STORAGE_BASE_CLASS \ 1629 EIGEN_MATHFUNC_IMPL \ 1630 _EIGEN_GENERIC_PUBLIC_INTERFACE \ 1631 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY \ 1632 EIGEN_EMPTY \ 1633 EIGEN_EULER_ANGLES_TYPEDEFS \ 1634 EIGEN_EULER_ANGLES_SINGLE_TYPEDEF \ 1635 EIGEN_EULER_SYSTEM_TYPEDEF \ 1636 EIGEN_AUTODIFF_DECLARE_GLOBAL_UNARY \ 1637 EIGEN_MATRIX_FUNCTION \ 1638 EIGEN_MATRIX_FUNCTION_1 \ 1639 EIGEN_DOC_UNARY_ADDONS \ 1640 EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL \ 1641 EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF 1642 1643 1644# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1645# doxygen's preprocessor will remove all references to function-like macros 1646# that are alone on a line, have an all uppercase name, and do not end with a 1647# semicolon, because these will confuse the parser if not removed. 1648 1649SKIP_FUNCTION_MACROS = YES 1650 1651#--------------------------------------------------------------------------- 1652# Configuration::additions related to external references 1653#--------------------------------------------------------------------------- 1654 1655# The TAGFILES option can be used to specify one or more tagfiles. For each 1656# tag file the location of the external documentation should be added. The 1657# format of a tag file without this location is as follows: 1658# 1659# TAGFILES = file1 file2 ... 1660# Adding location for the tag files is done as follows: 1661# 1662# TAGFILES = file1=loc1 "file2 = loc2" ... 1663# where "loc1" and "loc2" can be relative or absolute paths 1664# or URLs. Note that each tag file must have a unique name (where the name does 1665# NOT include the path). If a tag file is not located in the directory in which 1666# doxygen is run, you must also specify the path to the tagfile here. 1667 1668TAGFILES = ${EIGEN_DOXY_TAGFILES} 1669# "${Eigen_BINARY_DIR}/doc/eigen-unsupported.doxytags =unsupported" 1670 1671# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1672# a tag file that is based on the input files it reads. 1673 1674GENERATE_TAGFILE = "${Eigen_BINARY_DIR}/doc/${EIGEN_DOXY_PROJECT_NAME}.doxytags" 1675 1676# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1677# in the class index. If set to NO only the inherited external classes 1678# will be listed. 1679 1680ALLEXTERNALS = NO 1681 1682# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1683# in the modules index. If set to NO, only the current project's groups will 1684# be listed. 1685 1686EXTERNAL_GROUPS = NO 1687 1688# The PERL_PATH should be the absolute path and name of the perl script 1689# interpreter (i.e. the result of `which perl'). 1690 1691PERL_PATH = /usr/bin/perl 1692 1693#--------------------------------------------------------------------------- 1694# Configuration options related to the dot tool 1695#--------------------------------------------------------------------------- 1696 1697# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1698# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1699# or super classes. Setting the tag to NO turns the diagrams off. Note that 1700# this option also works with HAVE_DOT disabled, but it is recommended to 1701# install and use dot, since it yields more powerful graphs. 1702 1703CLASS_DIAGRAMS = YES 1704 1705# You can define message sequence charts within doxygen comments using the \msc 1706# command. Doxygen will then run the mscgen tool (see 1707# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1708# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1709# the mscgen tool resides. If left empty the tool is assumed to be found in the 1710# default search path. 1711 1712MSCGEN_PATH = 1713 1714# If set to YES, the inheritance and collaboration graphs will hide 1715# inheritance and usage relations if the target is undocumented 1716# or is not a class. 1717 1718HIDE_UNDOC_RELATIONS = NO 1719 1720# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1721# available from the path. This tool is part of Graphviz, a graph visualization 1722# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1723# have no effect if this option is set to NO (the default) 1724 1725HAVE_DOT = YES 1726 1727# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1728# allowed to run in parallel. When set to 0 (the default) doxygen will 1729# base this on the number of processors available in the system. You can set it 1730# explicitly to a value larger than 0 to get control over the balance 1731# between CPU load and processing speed. 1732 1733DOT_NUM_THREADS = 0 1734 1735# By default doxygen will use the Helvetica font for all dot files that 1736# doxygen generates. When you want a differently looking font you can specify 1737# the font name using DOT_FONTNAME. You need to make sure dot is able to find 1738# the font, which can be done by putting it in a standard location or by setting 1739# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1740# directory containing the font. 1741 1742DOT_FONTNAME = 1743 1744# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1745# The default size is 10pt. 1746 1747DOT_FONTSIZE = 10 1748 1749# By default doxygen will tell dot to use the Helvetica font. 1750# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1751# set the path where dot can find it. 1752 1753DOT_FONTPATH = 1754 1755# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1756# will generate a graph for each documented class showing the direct and 1757# indirect inheritance relations. Setting this tag to YES will force the 1758# CLASS_DIAGRAMS tag to NO. 1759 1760CLASS_GRAPH = YES 1761 1762# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1763# will generate a graph for each documented class showing the direct and 1764# indirect implementation dependencies (inheritance, containment, and 1765# class references variables) of the class with other documented classes. 1766 1767COLLABORATION_GRAPH = NO 1768 1769# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1770# will generate a graph for groups, showing the direct groups dependencies 1771 1772GROUP_GRAPHS = NO 1773 1774# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1775# collaboration diagrams in a style similar to the OMG's Unified Modeling 1776# Language. 1777 1778UML_LOOK = YES 1779 1780# If the UML_LOOK tag is enabled, the fields and methods are shown inside 1781# the class node. If there are many fields or methods and many nodes the 1782# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 1783# threshold limits the number of items for each type to make the size more 1784# manageable. Set this to 0 for no limit. Note that the threshold may be 1785# exceeded by 50% before the limit is enforced. 1786 1787UML_LIMIT_NUM_FIELDS = 10 1788 1789# If set to YES, the inheritance and collaboration graphs will show the 1790# relations between templates and their instances. 1791 1792TEMPLATE_RELATIONS = NO 1793 1794# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1795# tags are set to YES then doxygen will generate a graph for each documented 1796# file showing the direct and indirect include dependencies of the file with 1797# other documented files. 1798 1799INCLUDE_GRAPH = NO 1800 1801# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1802# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1803# documented header file showing the documented files that directly or 1804# indirectly include this file. 1805 1806INCLUDED_BY_GRAPH = NO 1807 1808# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1809# doxygen will generate a call dependency graph for every global function 1810# or class method. Note that enabling this option will significantly increase 1811# the time of a run. So in most cases it will be better to enable call graphs 1812# for selected functions only using the \callgraph command. 1813 1814CALL_GRAPH = NO 1815 1816# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1817# doxygen will generate a caller dependency graph for every global function 1818# or class method. Note that enabling this option will significantly increase 1819# the time of a run. So in most cases it will be better to enable caller 1820# graphs for selected functions only using the \callergraph command. 1821 1822CALLER_GRAPH = NO 1823 1824# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1825# will generate a graphical hierarchy of all classes instead of a textual one. 1826 1827GRAPHICAL_HIERARCHY = NO 1828 1829# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 1830# then doxygen will show the dependencies a directory has on other directories 1831# in a graphical way. The dependency relations are determined by the #include 1832# relations between the files in the directories. 1833 1834DIRECTORY_GRAPH = NO 1835 1836# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1837# generated by dot. Possible values are svg, png, jpg, or gif. 1838# If left blank png will be used. If you choose svg you need to set 1839# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1840# visible in IE 9+ (other browsers do not have this requirement). 1841 1842DOT_IMAGE_FORMAT = png 1843 1844# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1845# enable generation of interactive SVG images that allow zooming and panning. 1846# Note that this requires a modern browser other than Internet Explorer. 1847# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1848# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1849# visible. Older versions of IE do not have SVG support. 1850 1851INTERACTIVE_SVG = NO 1852 1853# The tag DOT_PATH can be used to specify the path where the dot tool can be 1854# found. If left blank, it is assumed the dot tool can be found in the path. 1855 1856DOT_PATH = 1857 1858# The DOTFILE_DIRS tag can be used to specify one or more directories that 1859# contain dot files that are included in the documentation (see the 1860# \dotfile command). 1861 1862DOTFILE_DIRS = 1863 1864# The MSCFILE_DIRS tag can be used to specify one or more directories that 1865# contain msc files that are included in the documentation (see the 1866# \mscfile command). 1867 1868MSCFILE_DIRS = 1869 1870# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1871# nodes that will be shown in the graph. If the number of nodes in a graph 1872# becomes larger than this value, doxygen will truncate the graph, which is 1873# visualized by representing a node as a red box. Note that doxygen if the 1874# number of direct children of the root node in a graph is already larger than 1875# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1876# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1877 1878DOT_GRAPH_MAX_NODES = 50 1879 1880# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1881# graphs generated by dot. A depth value of 3 means that only nodes reachable 1882# from the root by following a path via at most 3 edges will be shown. Nodes 1883# that lay further from the root node will be omitted. Note that setting this 1884# option to 1 or 2 may greatly reduce the computation time needed for large 1885# code bases. Also note that the size of a graph can be further restricted by 1886# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1887 1888MAX_DOT_GRAPH_DEPTH = 0 1889 1890# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1891# background. This is disabled by default, because dot on Windows does not 1892# seem to support this out of the box. Warning: Depending on the platform used, 1893# enabling this option may lead to badly anti-aliased labels on the edges of 1894# a graph (i.e. they become hard to read). 1895 1896DOT_TRANSPARENT = NO 1897 1898# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1899# files in one run (i.e. multiple -o and -T options on the command line). This 1900# makes dot run faster, but since only newer versions of dot (>1.8.10) 1901# support this, this feature is disabled by default. 1902 1903DOT_MULTI_TARGETS = NO 1904 1905# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1906# generate a legend page explaining the meaning of the various boxes and 1907# arrows in the dot generated graphs. 1908 1909GENERATE_LEGEND = YES 1910 1911# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1912# remove the intermediate dot files that are used to generate 1913# the various graphs. 1914 1915DOT_CLEANUP = YES 1916
