1# This file describes the settings to be used by the documentation system 2# doxygen (www.doxygen.org) for a project 3# 4# All text after a hash (#) is considered a comment and will be ignored 5# The format is: 6# TAG = value [value, ...] 7# For lists items can also be appended using: 8# TAG += value [value, ...] 9# Values that contain spaces should be placed between quotes (" ") 10 11#--------------------------------------------------------------------------- 12# Project related configuration options 13#--------------------------------------------------------------------------- 14 15# This tag specifies the encoding used for all characters in the config file 16# that follow. The default is UTF-8 which is also the encoding used for all 17# text before the first occurrence of this tag. Doxygen uses libiconv (or the 18# iconv built into libc) for the transcoding. See 19# http://www.gnu.org/software/libiconv for the list of possible encodings. 20 21DOXYFILE_ENCODING = UTF-8 22 23# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 24# by quotes) that should identify the project. 25 26PROJECT_NAME = Eigen - unsupported modules 27 28# The PROJECT_NUMBER tag can be used to enter a project or revision number. 29# This could be handy for archiving the generated documentation or 30# if some version control system is used. 31 32#EIGEN_VERSION is set in the root CMakeLists.txt 33PROJECT_NUMBER = "${EIGEN_VERSION}" 34 35# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 36# base path where the generated documentation will be put. 37# If a relative path is entered, it will be relative to the location 38# where doxygen was started. If left blank the current directory will be used. 39 40OUTPUT_DIRECTORY = "${Eigen_BINARY_DIR}/doc/unsupported" 41 42# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 43# 4096 sub-directories (in 2 levels) under the output directory of each output 44# format and will distribute the generated files over these directories. 45# Enabling this option can be useful when feeding doxygen a huge amount of 46# source files, where putting all generated files in the same directory would 47# otherwise cause performance problems for the file system. 48 49CREATE_SUBDIRS = NO 50 51# The OUTPUT_LANGUAGE tag is used to specify the language in which all 52# documentation generated by doxygen is written. Doxygen will use this 53# information to generate all constant output in the proper language. 54# The default language is English, other supported languages are: 55# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 56# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 57# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 58# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 59# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 60# and Ukrainian. 61 62OUTPUT_LANGUAGE = English 63 64# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 65# include brief member descriptions after the members that are listed in 66# the file and class documentation (similar to JavaDoc). 67# Set to NO to disable this. 68 69BRIEF_MEMBER_DESC = YES 70 71# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 72# the brief description of a member or function before the detailed description. 73# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 74# brief descriptions will be completely suppressed. 75 76REPEAT_BRIEF = YES 77 78# This tag implements a quasi-intelligent brief description abbreviator 79# that is used to form the text in various listings. Each string 80# in this list, if found as the leading text of the brief description, will be 81# stripped from the text and the result after processing the whole list, is 82# used as the annotated text. Otherwise, the brief description is used as-is. 83# If left blank, the following values are used ("$name" is automatically 84# replaced with the name of the entity): "The $name class" "The $name widget" 85# "The $name file" "is" "provides" "specifies" "contains" 86# "represents" "a" "an" "the" 87 88ABBREVIATE_BRIEF = "The $name class" \ 89 "The $name widget" \ 90 "The $name file" \ 91 is \ 92 provides \ 93 specifies \ 94 contains \ 95 represents \ 96 a \ 97 an \ 98 the 99 100# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 101# Doxygen will generate a detailed section even if there is only a brief 102# description. 103 104ALWAYS_DETAILED_SEC = NO 105 106# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 107# inherited members of a class in the documentation of that class as if those 108# members were ordinary class members. Constructors, destructors and assignment 109# operators of the base classes will not be shown. 110 111INLINE_INHERITED_MEMB = NO 112 113# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 114# path before files name in the file list and in the header files. If set 115# to NO the shortest path that makes the file name unique will be used. 116 117FULL_PATH_NAMES = NO 118 119# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 120# can be used to strip a user-defined part of the path. Stripping is 121# only done if one of the specified strings matches the left-hand part of 122# the path. The tag can be used to show relative paths in the file list. 123# If left blank the directory from which doxygen is run is used as the 124# path to strip. 125 126STRIP_FROM_PATH = 127 128# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 129# the path mentioned in the documentation of a class, which tells 130# the reader which header file to include in order to use a class. 131# If left blank only the name of the header file containing the class 132# definition is used. Otherwise one should specify the include paths that 133# are normally passed to the compiler using the -I flag. 134 135STRIP_FROM_INC_PATH = 136 137# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 138# (but less readable) file names. This can be useful is your file systems 139# doesn't support long names like on DOS, Mac, or CD-ROM. 140 141SHORT_NAMES = NO 142 143# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 144# will interpret the first line (until the first dot) of a JavaDoc-style 145# comment as the brief description. If set to NO, the JavaDoc 146# comments will behave just like regular Qt-style comments 147# (thus requiring an explicit @brief command for a brief description.) 148 149JAVADOC_AUTOBRIEF = NO 150 151# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 152# interpret the first line (until the first dot) of a Qt-style 153# comment as the brief description. If set to NO, the comments 154# will behave just like regular Qt-style comments (thus requiring 155# an explicit \brief command for a brief description.) 156 157QT_AUTOBRIEF = NO 158 159# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 160# treat a multi-line C++ special comment block (i.e. a block of //! or /// 161# comments) as a brief description. This used to be the default behaviour. 162# The new default is to treat a multi-line C++ comment block as a detailed 163# description. Set this tag to YES if you prefer the old behaviour instead. 164 165MULTILINE_CPP_IS_BRIEF = NO 166 167# If the DETAILS_AT_TOP tag is set to YES then Doxygen 168# will output the detailed description near the top, like JavaDoc. 169# If set to NO, the detailed description appears after the member 170# documentation. 171 172DETAILS_AT_TOP = YES 173 174# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 175# member inherits the documentation from any documented member that it 176# re-implements. 177 178INHERIT_DOCS = YES 179 180# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 181# a new page for each member. If set to NO, the documentation of a member will 182# be part of the file/class/namespace that contains it. 183 184SEPARATE_MEMBER_PAGES = NO 185 186# The TAB_SIZE tag can be used to set the number of spaces in a tab. 187# Doxygen uses this value to replace tabs by spaces in code fragments. 188 189TAB_SIZE = 8 190 191# This tag can be used to specify a number of aliases that acts 192# as commands in the documentation. An alias has the form "name=value". 193# For example adding "sideeffect=\par Side Effects:\n" will allow you to 194# put the command \sideeffect (or @sideeffect) in the documentation, which 195# will result in a user-defined paragraph with heading "Side Effects:". 196# You can put \n's in the value part of an alias to insert newlines. 197 198ALIASES = "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." \ 199 "array_module=This is defined in the %Array module. \code #include <Eigen/Array> \endcode" \ 200 "lu_module=This is defined in the %LU module. \code #include <Eigen/LU> \endcode" \ 201 "cholesky_module=This is defined in the %Cholesky module. \code #include <Eigen/Cholesky> \endcode" \ 202 "qr_module=This is defined in the %QR module. \code #include <Eigen/QR> \endcode" \ 203 "svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \ 204 "geometry_module=This is defined in the %Geometry module. \code #include <Eigen/Geometry> \endcode" \ 205 "label=\bug" \ 206 "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\"" 207 208# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 209# sources only. Doxygen will then generate output that is more tailored for C. 210# For instance, some of the names that are used will be different. The list 211# of all members will be omitted, etc. 212 213OPTIMIZE_OUTPUT_FOR_C = NO 214 215# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 216# sources only. Doxygen will then generate output that is more tailored for 217# Java. For instance, namespaces will be presented as packages, qualified 218# scopes will look different, etc. 219 220OPTIMIZE_OUTPUT_JAVA = NO 221 222# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 223# sources only. Doxygen will then generate output that is more tailored for 224# Fortran. 225 226OPTIMIZE_FOR_FORTRAN = NO 227 228# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 229# sources. Doxygen will then generate output that is tailored for 230# VHDL. 231 232OPTIMIZE_OUTPUT_VHDL = NO 233 234# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 235# to include (a tag file for) the STL sources as input, then you should 236# set this tag to YES in order to let doxygen match functions declarations and 237# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 238# func(std::string) {}). This also make the inheritance and collaboration 239# diagrams that involve STL classes more complete and accurate. 240 241BUILTIN_STL_SUPPORT = NO 242 243# If you use Microsoft's C++/CLI language, you should set this option to YES to 244# enable parsing support. 245 246CPP_CLI_SUPPORT = NO 247 248# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 249# Doxygen will parse them like normal C++ but will assume all classes use public 250# instead of private inheritance when no explicit protection keyword is present. 251 252SIP_SUPPORT = NO 253 254# For Microsoft's IDL there are propget and propput attributes to indicate getter 255# and setter methods for a property. Setting this option to YES (the default) 256# will make doxygen to replace the get and set methods by a property in the 257# documentation. This will only work if the methods are indeed getting or 258# setting a simple type. If this is not the case, or you want to show the 259# methods anyway, you should set this option to NO. 260 261IDL_PROPERTY_SUPPORT = YES 262 263# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 264# tag is set to YES, then doxygen will reuse the documentation of the first 265# member in the group (if any) for the other members of the group. By default 266# all members of a group must be documented explicitly. 267 268DISTRIBUTE_GROUP_DOC = NO 269 270# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 271# the same type (for instance a group of public functions) to be put as a 272# subgroup of that type (e.g. under the Public Functions section). Set it to 273# NO to prevent subgrouping. Alternatively, this can be done per class using 274# the \nosubgrouping command. 275 276SUBGROUPING = YES 277 278# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 279# is documented as struct, union, or enum with the name of the typedef. So 280# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 281# with name TypeT. When disabled the typedef will appear as a member of a file, 282# namespace, or class. And the struct will be named TypeS. This can typically 283# be useful for C code in case the coding convention dictates that all compound 284# types are typedef'ed and only the typedef is referenced, never the tag name. 285 286TYPEDEF_HIDES_STRUCT = NO 287 288#--------------------------------------------------------------------------- 289# Build related configuration options 290#--------------------------------------------------------------------------- 291 292# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 293# documentation are documented, even if no documentation was available. 294# Private class members and static file members will be hidden unless 295# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 296 297EXTRACT_ALL = NO 298 299# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 300# will be included in the documentation. 301 302EXTRACT_PRIVATE = NO 303 304# If the EXTRACT_STATIC tag is set to YES all static members of a file 305# will be included in the documentation. 306 307EXTRACT_STATIC = NO 308 309# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 310# defined locally in source files will be included in the documentation. 311# If set to NO only classes defined in header files are included. 312 313EXTRACT_LOCAL_CLASSES = NO 314 315# This flag is only useful for Objective-C code. When set to YES local 316# methods, which are defined in the implementation section but not in 317# the interface are included in the documentation. 318# If set to NO (the default) only methods in the interface are included. 319 320EXTRACT_LOCAL_METHODS = NO 321 322# If this flag is set to YES, the members of anonymous namespaces will be 323# extracted and appear in the documentation as a namespace called 324# 'anonymous_namespace{file}', where file will be replaced with the base 325# name of the file that contains the anonymous namespace. By default 326# anonymous namespace are hidden. 327 328EXTRACT_ANON_NSPACES = NO 329 330# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 331# undocumented members of documented classes, files or namespaces. 332# If set to NO (the default) these members will be included in the 333# various overviews, but no documentation section is generated. 334# This option has no effect if EXTRACT_ALL is enabled. 335 336HIDE_UNDOC_MEMBERS = NO 337 338# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 339# undocumented classes that are normally visible in the class hierarchy. 340# If set to NO (the default) these classes will be included in the various 341# overviews. This option has no effect if EXTRACT_ALL is enabled. 342 343HIDE_UNDOC_CLASSES = YES 344 345# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 346# friend (class|struct|union) declarations. 347# If set to NO (the default) these declarations will be included in the 348# documentation. 349 350HIDE_FRIEND_COMPOUNDS = YES 351 352# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 353# documentation blocks found inside the body of a function. 354# If set to NO (the default) these blocks will be appended to the 355# function's detailed documentation block. 356 357HIDE_IN_BODY_DOCS = NO 358 359# The INTERNAL_DOCS tag determines if documentation 360# that is typed after a \internal command is included. If the tag is set 361# to NO (the default) then the documentation will be excluded. 362# Set it to YES to include the internal documentation. 363 364INTERNAL_DOCS = NO 365 366# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 367# file names in lower-case letters. If set to YES upper-case letters are also 368# allowed. This is useful if you have classes or files whose names only differ 369# in case and if your file system supports case sensitive file names. Windows 370# and Mac users are advised to set this option to NO. 371 372CASE_SENSE_NAMES = YES 373 374# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 375# will show members with their full class and namespace scopes in the 376# documentation. If set to YES the scope will be hidden. 377 378HIDE_SCOPE_NAMES = YES 379 380# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 381# will put a list of the files that are included by a file in the documentation 382# of that file. 383 384SHOW_INCLUDE_FILES = YES 385 386# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 387# is inserted in the documentation for inline members. 388 389INLINE_INFO = YES 390 391# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 392# will sort the (detailed) documentation of file and class members 393# alphabetically by member name. If set to NO the members will appear in 394# declaration order. 395 396SORT_MEMBER_DOCS = YES 397 398# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 399# brief documentation of file, namespace and class members alphabetically 400# by member name. If set to NO (the default) the members will appear in 401# declaration order. 402 403SORT_BRIEF_DOCS = YES 404 405# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 406# hierarchy of group names into alphabetical order. If set to NO (the default) 407# the group names will appear in their defined order. 408 409SORT_GROUP_NAMES = NO 410 411# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 412# sorted by fully-qualified names, including namespaces. If set to 413# NO (the default), the class list will be sorted only by class name, 414# not including the namespace part. 415# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 416# Note: This option applies only to the class list, not to the 417# alphabetical list. 418 419SORT_BY_SCOPE_NAME = NO 420 421# The GENERATE_TODOLIST tag can be used to enable (YES) or 422# disable (NO) the todo list. This list is created by putting \todo 423# commands in the documentation. 424 425GENERATE_TODOLIST = NO 426 427# The GENERATE_TESTLIST tag can be used to enable (YES) or 428# disable (NO) the test list. This list is created by putting \test 429# commands in the documentation. 430 431GENERATE_TESTLIST = NO 432 433# The GENERATE_BUGLIST tag can be used to enable (YES) or 434# disable (NO) the bug list. This list is created by putting \bug 435# commands in the documentation. 436 437GENERATE_BUGLIST = NO 438 439# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 440# disable (NO) the deprecated list. This list is created by putting 441# \deprecated commands in the documentation. 442 443GENERATE_DEPRECATEDLIST= NO 444 445# The ENABLED_SECTIONS tag can be used to enable conditional 446# documentation sections, marked by \if sectionname ... \endif. 447 448ENABLED_SECTIONS = 449 450# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 451# the initial value of a variable or define consists of for it to appear in 452# the documentation. If the initializer consists of more lines than specified 453# here it will be hidden. Use a value of 0 to hide initializers completely. 454# The appearance of the initializer of individual variables and defines in the 455# documentation can be controlled using \showinitializer or \hideinitializer 456# command in the documentation regardless of this setting. 457 458MAX_INITIALIZER_LINES = 0 459 460# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 461# at the bottom of the documentation of classes and structs. If set to YES the 462# list will mention the files that were used to generate the documentation. 463 464SHOW_USED_FILES = YES 465 466# If the sources in your project are distributed over multiple directories 467# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 468# in the documentation. The default is NO. 469 470SHOW_DIRECTORIES = NO 471 472# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 473# This will remove the Files entry from the Quick Index and from the 474# Folder Tree View (if specified). The default is YES. 475 476SHOW_FILES = YES 477 478# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 479# Namespaces page. This will remove the Namespaces entry from the Quick Index 480# and from the Folder Tree View (if specified). The default is YES. 481 482SHOW_NAMESPACES = NO 483 484# The FILE_VERSION_FILTER tag can be used to specify a program or script that 485# doxygen should invoke to get the current version for each file (typically from 486# the version control system). Doxygen will invoke the program by executing (via 487# popen()) the command <command> <input-file>, where <command> is the value of 488# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 489# provided by doxygen. Whatever the program writes to standard output 490# is used as the file version. See the manual for examples. 491 492FILE_VERSION_FILTER = 493 494#--------------------------------------------------------------------------- 495# configuration options related to warning and progress messages 496#--------------------------------------------------------------------------- 497 498# The QUIET tag can be used to turn on/off the messages that are generated 499# by doxygen. Possible values are YES and NO. If left blank NO is used. 500 501QUIET = NO 502 503# The WARNINGS tag can be used to turn on/off the warning messages that are 504# generated by doxygen. Possible values are YES and NO. If left blank 505# NO is used. 506 507WARNINGS = YES 508 509# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 510# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 511# automatically be disabled. 512 513WARN_IF_UNDOCUMENTED = NO 514 515# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 516# potential errors in the documentation, such as not documenting some 517# parameters in a documented function, or documenting parameters that 518# don't exist or using markup commands wrongly. 519 520WARN_IF_DOC_ERROR = YES 521 522# This WARN_NO_PARAMDOC option can be abled to get warnings for 523# functions that are documented, but have no documentation for their parameters 524# or return value. If set to NO (the default) doxygen will only warn about 525# wrong or incomplete parameter documentation, but not about the absence of 526# documentation. 527 528WARN_NO_PARAMDOC = NO 529 530# The WARN_FORMAT tag determines the format of the warning messages that 531# doxygen can produce. The string should contain the $file, $line, and $text 532# tags, which will be replaced by the file and line number from which the 533# warning originated and the warning text. Optionally the format may contain 534# $version, which will be replaced by the version of the file (if it could 535# be obtained via FILE_VERSION_FILTER) 536 537WARN_FORMAT = "$file:$line: $text" 538 539# The WARN_LOGFILE tag can be used to specify a file to which warning 540# and error messages should be written. If left blank the output is written 541# to stderr. 542 543WARN_LOGFILE = 544 545#--------------------------------------------------------------------------- 546# configuration options related to the input files 547#--------------------------------------------------------------------------- 548 549# The INPUT tag can be used to specify the files and/or directories that contain 550# documented source files. You may enter file names like "myfile.cpp" or 551# directories like "/usr/src/myproject". Separate the files or directories 552# with spaces. 553 554INPUT = "${Eigen_SOURCE_DIR}/unsupported/Eigen" \ 555 "${Eigen_SOURCE_DIR}/unsupported/doc" 556 557# This tag can be used to specify the character encoding of the source files 558# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 559# also the default input encoding. Doxygen uses libiconv (or the iconv built 560# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 561# the list of possible encodings. 562 563INPUT_ENCODING = UTF-8 564 565# If the value of the INPUT tag contains directories, you can use the 566# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 567# and *.h) to filter out the source-files in the directories. If left 568# blank the following patterns are tested: 569# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 570# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 571 572FILE_PATTERNS = * 573 574# The RECURSIVE tag can be used to turn specify whether or not subdirectories 575# should be searched for input files as well. Possible values are YES and NO. 576# If left blank NO is used. 577 578RECURSIVE = YES 579 580# The EXCLUDE tag can be used to specify files and/or directories that should 581# excluded from the INPUT source files. This way you can easily exclude a 582# subdirectory from a directory tree whose root is specified with the INPUT tag. 583 584EXCLUDE = "${Eigen_SOURCE_DIR}/unsupported/doc/examples" \ 585 "${Eigen_SOURCE_DIR}/unsupported/doc/snippets" 586 587# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 588# directories that are symbolic links (a Unix filesystem feature) are excluded 589# from the input. 590 591EXCLUDE_SYMLINKS = NO 592 593# If the value of the INPUT tag contains directories, you can use the 594# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 595# certain files from those directories. Note that the wildcards are matched 596# against the file with absolute path, so to exclude all test directories 597# for example use the pattern */test/* 598 599EXCLUDE_PATTERNS = CMake* \ 600 *.txt \ 601 *.sh \ 602 *.diff \ 603 *.orig \ 604 diff \ 605 *~ 606 607# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 608# (namespaces, classes, functions, etc.) that should be excluded from the 609# output. The symbol name can be a fully qualified name, a word, or if the 610# wildcard * is used, a substring. Examples: ANamespace, AClass, 611# AClass::ANamespace, ANamespace::*Test 612 613EXCLUDE_SYMBOLS = MatrixBase<* MapBase<* RotationBase<* Matrix<* 614 615# The EXAMPLE_PATH tag can be used to specify one or more files or 616# directories that contain example code fragments that are included (see 617# the \include command). 618 619EXAMPLE_PATH = "${Eigen_SOURCE_DIR}/doc/snippets" \ 620 "${Eigen_BINARY_DIR}/doc/snippets" \ 621 "${Eigen_SOURCE_DIR}/doc/examples" \ 622 "${Eigen_BINARY_DIR}/doc/examples" \ 623 "${Eigen_SOURCE_DIR}/unsupported/doc/snippets" \ 624 "${Eigen_BINARY_DIR}/unsupported/doc/snippets" \ 625 "${Eigen_SOURCE_DIR}/unsupported/doc/examples" \ 626 "${Eigen_BINARY_DIR}/unsupported/doc/examples" 627 628# If the value of the EXAMPLE_PATH tag contains directories, you can use the 629# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 630# and *.h) to filter out the source-files in the directories. If left 631# blank all files are included. 632 633EXAMPLE_PATTERNS = * 634 635# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 636# searched for input files to be used with the \include or \dontinclude 637# commands irrespective of the value of the RECURSIVE tag. 638# Possible values are YES and NO. If left blank NO is used. 639 640EXAMPLE_RECURSIVE = NO 641 642# The IMAGE_PATH tag can be used to specify one or more files or 643# directories that contain image that are included in the documentation (see 644# the \image command). 645 646IMAGE_PATH = 647 648# The INPUT_FILTER tag can be used to specify a program that doxygen should 649# invoke to filter for each input file. Doxygen will invoke the filter program 650# by executing (via popen()) the command <filter> <input-file>, where <filter> 651# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 652# input file. Doxygen will then use the output that the filter program writes 653# to standard output. If FILTER_PATTERNS is specified, this tag will be 654# ignored. 655 656INPUT_FILTER = 657 658# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 659# basis. Doxygen will compare the file name with each pattern and apply the 660# filter if there is a match. The filters are a list of the form: 661# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 662# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 663# is applied to all files. 664 665FILTER_PATTERNS = 666 667# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 668# INPUT_FILTER) will be used to filter the input files when producing source 669# files to browse (i.e. when SOURCE_BROWSER is set to YES). 670 671FILTER_SOURCE_FILES = NO 672 673#--------------------------------------------------------------------------- 674# configuration options related to source browsing 675#--------------------------------------------------------------------------- 676 677# If the SOURCE_BROWSER tag is set to YES then a list of source files will 678# be generated. Documented entities will be cross-referenced with these sources. 679# Note: To get rid of all source code in the generated output, make sure also 680# VERBATIM_HEADERS is set to NO. 681 682SOURCE_BROWSER = NO 683 684# Setting the INLINE_SOURCES tag to YES will include the body 685# of functions and classes directly in the documentation. 686 687INLINE_SOURCES = NO 688 689# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 690# doxygen to hide any special comment blocks from generated source code 691# fragments. Normal C and C++ comments will always remain visible. 692 693STRIP_CODE_COMMENTS = YES 694 695# If the REFERENCED_BY_RELATION tag is set to YES 696# then for each documented function all documented 697# functions referencing it will be listed. 698 699REFERENCED_BY_RELATION = YES 700 701# If the REFERENCES_RELATION tag is set to YES 702# then for each documented function all documented entities 703# called/used by that function will be listed. 704 705REFERENCES_RELATION = YES 706 707# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 708# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 709# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 710# link to the source code. Otherwise they will link to the documentstion. 711 712REFERENCES_LINK_SOURCE = YES 713 714# If the USE_HTAGS tag is set to YES then the references to source code 715# will point to the HTML generated by the htags(1) tool instead of doxygen 716# built-in source browser. The htags tool is part of GNU's global source 717# tagging system (see http://www.gnu.org/software/global/global.html). You 718# will need version 4.8.6 or higher. 719 720USE_HTAGS = NO 721 722# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 723# will generate a verbatim copy of the header file for each class for 724# which an include is specified. Set to NO to disable this. 725 726VERBATIM_HEADERS = YES 727 728#--------------------------------------------------------------------------- 729# configuration options related to the alphabetical class index 730#--------------------------------------------------------------------------- 731 732# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 733# of all compounds will be generated. Enable this if the project 734# contains a lot of classes, structs, unions or interfaces. 735 736ALPHABETICAL_INDEX = NO 737 738# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 739# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 740# in which this list will be split (can be a number in the range [1..20]) 741 742COLS_IN_ALPHA_INDEX = 5 743 744# In case all classes in a project start with a common prefix, all 745# classes will be put under the same header in the alphabetical index. 746# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 747# should be ignored while generating the index headers. 748 749IGNORE_PREFIX = 750 751#--------------------------------------------------------------------------- 752# configuration options related to the HTML output 753#--------------------------------------------------------------------------- 754 755# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 756# generate HTML output. 757 758GENERATE_HTML = YES 759 760# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 761# If a relative path is entered the value of OUTPUT_DIRECTORY will be 762# put in front of it. If left blank `html' will be used as the default path. 763 764HTML_OUTPUT = "${Eigen_BINARY_DIR}/doc/html/unsupported" 765 766# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 767# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 768# doxygen will generate files with .html extension. 769 770HTML_FILE_EXTENSION = .html 771 772# The HTML_HEADER tag can be used to specify a personal HTML header for 773# each generated HTML page. If it is left blank doxygen will generate a 774# standard header. 775 776HTML_HEADER = "${Eigen_BINARY_DIR}/doc/eigendoxy_header.html" 777 778# The HTML_FOOTER tag can be used to specify a personal HTML footer for 779# each generated HTML page. If it is left blank doxygen will generate a 780# standard footer. 781 782# the footer has not been customized yet, so let's use the default one 783# ${Eigen_BINARY_DIR}/doc/eigendoxy_footer.html 784HTML_FOOTER = 785 786# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 787# style sheet that is used by each HTML page. It can be used to 788# fine-tune the look of the HTML output. If the tag is left blank doxygen 789# will generate a default style sheet. Note that doxygen will try to copy 790# the style sheet file to the HTML output directory, so don't put your own 791# stylesheet in the HTML output directory as well, or it will be erased! 792 793HTML_STYLESHEET = "${Eigen_SOURCE_DIR}/doc/eigendoxy.css" 794 795# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 796# files or namespaces will be aligned in HTML using tables. If set to 797# NO a bullet list will be used. 798 799HTML_ALIGN_MEMBERS = YES 800 801# If the GENERATE_HTMLHELP tag is set to YES, additional index files 802# will be generated that can be used as input for tools like the 803# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 804# of the generated HTML documentation. 805 806GENERATE_HTMLHELP = NO 807 808# If the GENERATE_DOCSET tag is set to YES, additional index files 809# will be generated that can be used as input for Apple's Xcode 3 810# integrated development environment, introduced with OSX 10.5 (Leopard). 811# To create a documentation set, doxygen will generate a Makefile in the 812# HTML output directory. Running make will produce the docset in that 813# directory and running "make install" will install the docset in 814# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 815# it at startup. 816 817GENERATE_DOCSET = NO 818 819# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 820# feed. A documentation feed provides an umbrella under which multiple 821# documentation sets from a single provider (such as a company or product suite) 822# can be grouped. 823 824DOCSET_FEEDNAME = "Doxygen generated docs" 825 826# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 827# should uniquely identify the documentation set bundle. This should be a 828# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 829# will append .docset to the name. 830 831DOCSET_BUNDLE_ID = org.doxygen.Project 832 833# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 834# documentation will contain sections that can be hidden and shown after the 835# page has loaded. For this to work a browser that supports 836# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 837# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 838 839HTML_DYNAMIC_SECTIONS = NO 840 841# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 842# be used to specify the file name of the resulting .chm file. You 843# can add a path in front of the file if the result should not be 844# written to the html output directory. 845 846CHM_FILE = 847 848# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 849# be used to specify the location (absolute path including file name) of 850# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 851# the HTML help compiler on the generated index.hhp. 852 853HHC_LOCATION = 854 855# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 856# controls if a separate .chi index file is generated (YES) or that 857# it should be included in the master .chm file (NO). 858 859GENERATE_CHI = NO 860 861# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 862# is used to encode HtmlHelp index (hhk), content (hhc) and project file 863# content. 864 865CHM_INDEX_ENCODING = 866 867# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 868# controls whether a binary table of contents is generated (YES) or a 869# normal table of contents (NO) in the .chm file. 870 871BINARY_TOC = NO 872 873# The TOC_EXPAND flag can be set to YES to add extra items for group members 874# to the contents of the HTML help documentation and to the tree view. 875 876TOC_EXPAND = NO 877 878# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 879# top of each HTML page. The value NO (the default) enables the index and 880# the value YES disables it. 881 882DISABLE_INDEX = NO 883 884# This tag can be used to set the number of enum values (range [1..20]) 885# that doxygen will group on one line in the generated HTML documentation. 886 887ENUM_VALUES_PER_LINE = 1 888 889# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 890# structure should be generated to display hierarchical information. 891# If the tag value is set to FRAME, a side panel will be generated 892# containing a tree-like index structure (just like the one that 893# is generated for HTML Help). For this to work a browser that supports 894# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 895# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 896# probably better off using the HTML help feature. Other possible values 897# for this tag are: HIERARCHIES, which will generate the Groups, Directories, 898# and Class Hiererachy pages using a tree view instead of an ordered list; 899# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which 900# disables this behavior completely. For backwards compatibility with previous 901# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE 902# respectively. 903 904GENERATE_TREEVIEW = NO 905 906# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 907# used to set the initial width (in pixels) of the frame in which the tree 908# is shown. 909 910TREEVIEW_WIDTH = 250 911 912# Use this tag to change the font size of Latex formulas included 913# as images in the HTML documentation. The default is 10. Note that 914# when you change the font size after a successful doxygen run you need 915# to manually remove any form_*.png images from the HTML output directory 916# to force them to be regenerated. 917 918FORMULA_FONTSIZE = 12 919 920#--------------------------------------------------------------------------- 921# configuration options related to the LaTeX output 922#--------------------------------------------------------------------------- 923 924# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 925# generate Latex output. 926 927GENERATE_LATEX = NO 928 929# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 930# If a relative path is entered the value of OUTPUT_DIRECTORY will be 931# put in front of it. If left blank `latex' will be used as the default path. 932 933LATEX_OUTPUT = latex 934 935# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 936# invoked. If left blank `latex' will be used as the default command name. 937 938LATEX_CMD_NAME = latex 939 940# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 941# generate index for LaTeX. If left blank `makeindex' will be used as the 942# default command name. 943 944MAKEINDEX_CMD_NAME = makeindex 945 946# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 947# LaTeX documents. This may be useful for small projects and may help to 948# save some trees in general. 949 950COMPACT_LATEX = NO 951 952# The PAPER_TYPE tag can be used to set the paper type that is used 953# by the printer. Possible values are: a4, a4wide, letter, legal and 954# executive. If left blank a4wide will be used. 955 956PAPER_TYPE = a4wide 957 958# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 959# packages that should be included in the LaTeX output. 960 961EXTRA_PACKAGES = amssymb \ 962 amsmath 963 964# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 965# the generated latex document. The header should contain everything until 966# the first chapter. If it is left blank doxygen will generate a 967# standard header. Notice: only use this tag if you know what you are doing! 968 969LATEX_HEADER = 970 971# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 972# is prepared for conversion to pdf (using ps2pdf). The pdf file will 973# contain links (just like the HTML output) instead of page references 974# This makes the output suitable for online browsing using a pdf viewer. 975 976PDF_HYPERLINKS = NO 977 978# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 979# plain latex in the generated Makefile. Set this option to YES to get a 980# higher quality PDF documentation. 981 982USE_PDFLATEX = NO 983 984# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 985# command to the generated LaTeX files. This will instruct LaTeX to keep 986# running if errors occur, instead of asking the user for help. 987# This option is also used when generating formulas in HTML. 988 989LATEX_BATCHMODE = NO 990 991# If LATEX_HIDE_INDICES is set to YES then doxygen will not 992# include the index chapters (such as File Index, Compound Index, etc.) 993# in the output. 994 995LATEX_HIDE_INDICES = NO 996 997#--------------------------------------------------------------------------- 998# configuration options related to the RTF output 999#--------------------------------------------------------------------------- 1000 1001# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1002# The RTF output is optimized for Word 97 and may not look very pretty with 1003# other RTF readers or editors. 1004 1005GENERATE_RTF = NO 1006 1007# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1008# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1009# put in front of it. If left blank `rtf' will be used as the default path. 1010 1011RTF_OUTPUT = rtf 1012 1013# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1014# RTF documents. This may be useful for small projects and may help to 1015# save some trees in general. 1016 1017COMPACT_RTF = NO 1018 1019# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1020# will contain hyperlink fields. The RTF file will 1021# contain links (just like the HTML output) instead of page references. 1022# This makes the output suitable for online browsing using WORD or other 1023# programs which support those fields. 1024# Note: wordpad (write) and others do not support links. 1025 1026RTF_HYPERLINKS = NO 1027 1028# Load stylesheet definitions from file. Syntax is similar to doxygen's 1029# config file, i.e. a series of assignments. You only have to provide 1030# replacements, missing definitions are set to their default value. 1031 1032RTF_STYLESHEET_FILE = 1033 1034# Set optional variables used in the generation of an rtf document. 1035# Syntax is similar to doxygen's config file. 1036 1037RTF_EXTENSIONS_FILE = 1038 1039#--------------------------------------------------------------------------- 1040# configuration options related to the man page output 1041#--------------------------------------------------------------------------- 1042 1043# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1044# generate man pages 1045 1046GENERATE_MAN = NO 1047 1048# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1049# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1050# put in front of it. If left blank `man' will be used as the default path. 1051 1052MAN_OUTPUT = man 1053 1054# The MAN_EXTENSION tag determines the extension that is added to 1055# the generated man pages (default is the subroutine's section .3) 1056 1057MAN_EXTENSION = .3 1058 1059# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1060# then it will generate one additional man file for each entity 1061# documented in the real man page(s). These additional files 1062# only source the real man page, but without them the man command 1063# would be unable to find the correct page. The default is NO. 1064 1065MAN_LINKS = NO 1066 1067#--------------------------------------------------------------------------- 1068# configuration options related to the XML output 1069#--------------------------------------------------------------------------- 1070 1071# If the GENERATE_XML tag is set to YES Doxygen will 1072# generate an XML file that captures the structure of 1073# the code including all documentation. 1074 1075GENERATE_XML = NO 1076 1077# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1078# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1079# put in front of it. If left blank `xml' will be used as the default path. 1080 1081XML_OUTPUT = xml 1082 1083# The XML_SCHEMA tag can be used to specify an XML schema, 1084# which can be used by a validating XML parser to check the 1085# syntax of the XML files. 1086 1087XML_SCHEMA = 1088 1089# The XML_DTD tag can be used to specify an XML DTD, 1090# which can be used by a validating XML parser to check the 1091# syntax of the XML files. 1092 1093XML_DTD = 1094 1095# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1096# dump the program listings (including syntax highlighting 1097# and cross-referencing information) to the XML output. Note that 1098# enabling this will significantly increase the size of the XML output. 1099 1100XML_PROGRAMLISTING = YES 1101 1102#--------------------------------------------------------------------------- 1103# configuration options for the AutoGen Definitions output 1104#--------------------------------------------------------------------------- 1105 1106# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1107# generate an AutoGen Definitions (see autogen.sf.net) file 1108# that captures the structure of the code including all 1109# documentation. Note that this feature is still experimental 1110# and incomplete at the moment. 1111 1112GENERATE_AUTOGEN_DEF = NO 1113 1114#--------------------------------------------------------------------------- 1115# configuration options related to the Perl module output 1116#--------------------------------------------------------------------------- 1117 1118# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1119# generate a Perl module file that captures the structure of 1120# the code including all documentation. Note that this 1121# feature is still experimental and incomplete at the 1122# moment. 1123 1124GENERATE_PERLMOD = NO 1125 1126# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1127# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1128# to generate PDF and DVI output from the Perl module output. 1129 1130PERLMOD_LATEX = NO 1131 1132# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1133# nicely formatted so it can be parsed by a human reader. This is useful 1134# if you want to understand what is going on. On the other hand, if this 1135# tag is set to NO the size of the Perl module output will be much smaller 1136# and Perl will parse it just the same. 1137 1138PERLMOD_PRETTY = YES 1139 1140# The names of the make variables in the generated doxyrules.make file 1141# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1142# This is useful so different doxyrules.make files included by the same 1143# Makefile don't overwrite each other's variables. 1144 1145PERLMOD_MAKEVAR_PREFIX = 1146 1147#--------------------------------------------------------------------------- 1148# Configuration options related to the preprocessor 1149#--------------------------------------------------------------------------- 1150 1151# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1152# evaluate all C-preprocessor directives found in the sources and include 1153# files. 1154 1155ENABLE_PREPROCESSING = YES 1156 1157# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1158# names in the source code. If set to NO (the default) only conditional 1159# compilation will be performed. Macro expansion can be done in a controlled 1160# way by setting EXPAND_ONLY_PREDEF to YES. 1161 1162MACRO_EXPANSION = YES 1163 1164# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1165# then the macro expansion is limited to the macros specified with the 1166# PREDEFINED and EXPAND_AS_DEFINED tags. 1167 1168EXPAND_ONLY_PREDEF = YES 1169 1170# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1171# in the INCLUDE_PATH (see below) will be search if a #include is found. 1172 1173SEARCH_INCLUDES = YES 1174 1175# The INCLUDE_PATH tag can be used to specify one or more directories that 1176# contain include files that are not input files but should be processed by 1177# the preprocessor. 1178 1179INCLUDE_PATH = 1180 1181# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1182# patterns (like *.h and *.hpp) to filter out the header-files in the 1183# directories. If left blank, the patterns specified with FILE_PATTERNS will 1184# be used. 1185 1186INCLUDE_FILE_PATTERNS = 1187 1188# The PREDEFINED tag can be used to specify one or more macro names that 1189# are defined before the preprocessor is started (similar to the -D option of 1190# gcc). The argument of the tag is a list of macros of the form: name 1191# or name=definition (no spaces). If the definition and the = are 1192# omitted =1 is assumed. To prevent a macro definition from being 1193# undefined via #undef or recursively expanded use the := operator 1194# instead of the = operator. 1195 1196PREDEFINED = EIGEN_EMPTY_STRUCT \ 1197 EIGEN_PARSED_BY_DOXYGEN \ 1198 EIGEN_VECTORIZE \ 1199 EIGEN_QT_SUPPORT \ 1200 EIGEN_STRONG_INLINE=inline 1201 1202# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1203# this tag can be used to specify a list of macro names that should be expanded. 1204# The macro definition that is found in the sources will be used. 1205# Use the PREDEFINED tag if you want to use a different macro definition. 1206 1207EXPAND_AS_DEFINED = EIGEN_MAKE_SCALAR_OPS \ 1208 EIGEN_MAKE_TYPEDEFS \ 1209 EIGEN_MAKE_TYPEDEFS_ALL_SIZES \ 1210 EIGEN_CWISE_UNOP_RETURN_TYPE \ 1211 EIGEN_CWISE_BINOP_RETURN_TYPE 1212 1213# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1214# doxygen's preprocessor will remove all function-like macros that are alone 1215# on a line, have an all uppercase name, and do not end with a semicolon. Such 1216# function macros are typically used for boiler-plate code, and will confuse 1217# the parser if not removed. 1218 1219SKIP_FUNCTION_MACROS = YES 1220 1221#--------------------------------------------------------------------------- 1222# Configuration::additions related to external references 1223#--------------------------------------------------------------------------- 1224 1225# The TAGFILES option can be used to specify one or more tagfiles. 1226# Optionally an initial location of the external documentation 1227# can be added for each tagfile. The format of a tag file without 1228# this location is as follows: 1229# TAGFILES = file1 file2 ... 1230# Adding location for the tag files is done as follows: 1231# TAGFILES = file1=loc1 "file2 = loc2" ... 1232# where "loc1" and "loc2" can be relative or absolute paths or 1233# URLs. If a location is present for each tag, the installdox tool 1234# does not have to be run to correct the links. 1235# Note that each tag file must have a unique name 1236# (where the name does NOT include the path) 1237# If a tag file is not located in the directory in which doxygen 1238# is run, you must also specify the path to the tagfile here. 1239 1240TAGFILES = "${Eigen_BINARY_DIR}/doc/eigen.doxytags"=../ 1241 1242# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1243# a tag file that is based on the input files it reads. 1244 1245GENERATE_TAGFILE = "${Eigen_BINARY_DIR}/doc/eigen-unsupported.doxytags" 1246 1247# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1248# in the class index. If set to NO only the inherited external classes 1249# will be listed. 1250 1251ALLEXTERNALS = NO 1252 1253# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1254# in the modules index. If set to NO, only the current project's groups will 1255# be listed. 1256 1257EXTERNAL_GROUPS = YES 1258 1259# The PERL_PATH should be the absolute path and name of the perl script 1260# interpreter (i.e. the result of `which perl'). 1261 1262PERL_PATH = /usr/bin/perl 1263 1264#--------------------------------------------------------------------------- 1265# Configuration options related to the dot tool 1266#--------------------------------------------------------------------------- 1267 1268# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1269# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1270# or super classes. Setting the tag to NO turns the diagrams off. Note that 1271# this option is superseded by the HAVE_DOT option below. This is only a 1272# fallback. It is recommended to install and use dot, since it yields more 1273# powerful graphs. 1274 1275CLASS_DIAGRAMS = NO 1276 1277# You can define message sequence charts within doxygen comments using the \msc 1278# command. Doxygen will then run the mscgen tool (see 1279# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1280# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1281# the mscgen tool resides. If left empty the tool is assumed to be found in the 1282# default search path. 1283 1284MSCGEN_PATH = NO 1285 1286# If set to YES, the inheritance and collaboration graphs will hide 1287# inheritance and usage relations if the target is undocumented 1288# or is not a class. 1289 1290HIDE_UNDOC_RELATIONS = NO 1291 1292# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1293# available from the path. This tool is part of Graphviz, a graph visualization 1294# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1295# have no effect if this option is set to NO (the default) 1296 1297HAVE_DOT = NO 1298 1299# By default doxygen will write a font called FreeSans.ttf to the output 1300# directory and reference it in all dot files that doxygen generates. This 1301# font does not include all possible unicode characters however, so when you need 1302# these (or just want a differently looking font) you can specify the font name 1303# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1304# which can be done by putting it in a standard location or by setting the 1305# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1306# containing the font. 1307 1308DOT_FONTNAME = FreeSans 1309 1310# By default doxygen will tell dot to use the output directory to look for the 1311# FreeSans.ttf font (which doxygen will put there itself). If you specify a 1312# different font using DOT_FONTNAME you can set the path where dot 1313# can find it using this tag. 1314 1315DOT_FONTPATH = 1316 1317# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1318# will generate a graph for each documented class showing the direct and 1319# indirect inheritance relations. Setting this tag to YES will force the 1320# the CLASS_DIAGRAMS tag to NO. 1321 1322CLASS_GRAPH = NO 1323 1324# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1325# will generate a graph for each documented class showing the direct and 1326# indirect implementation dependencies (inheritance, containment, and 1327# class references variables) of the class with other documented classes. 1328 1329COLLABORATION_GRAPH = NO 1330 1331# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1332# will generate a graph for groups, showing the direct groups dependencies 1333 1334GROUP_GRAPHS = NO 1335 1336# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1337# collaboration diagrams in a style similar to the OMG's Unified Modeling 1338# Language. 1339 1340UML_LOOK = NO 1341 1342# If set to YES, the inheritance and collaboration graphs will show the 1343# relations between templates and their instances. 1344 1345TEMPLATE_RELATIONS = NO 1346 1347# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1348# tags are set to YES then doxygen will generate a graph for each documented 1349# file showing the direct and indirect include dependencies of the file with 1350# other documented files. 1351 1352INCLUDE_GRAPH = NO 1353 1354# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1355# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1356# documented header file showing the documented files that directly or 1357# indirectly include this file. 1358 1359INCLUDED_BY_GRAPH = NO 1360 1361# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1362# doxygen will generate a call dependency graph for every global function 1363# or class method. Note that enabling this option will significantly increase 1364# the time of a run. So in most cases it will be better to enable call graphs 1365# for selected functions only using the \callgraph command. 1366 1367CALL_GRAPH = NO 1368 1369# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1370# doxygen will generate a caller dependency graph for every global function 1371# or class method. Note that enabling this option will significantly increase 1372# the time of a run. So in most cases it will be better to enable caller 1373# graphs for selected functions only using the \callergraph command. 1374 1375CALLER_GRAPH = NO 1376 1377# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1378# will graphical hierarchy of all classes instead of a textual one. 1379 1380GRAPHICAL_HIERARCHY = NO 1381 1382# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1383# then doxygen will show the dependencies a directory has on other directories 1384# in a graphical way. The dependency relations are determined by the #include 1385# relations between the files in the directories. 1386 1387DIRECTORY_GRAPH = NO 1388 1389# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1390# generated by dot. Possible values are png, jpg, or gif 1391# If left blank png will be used. 1392 1393DOT_IMAGE_FORMAT = png 1394 1395# The tag DOT_PATH can be used to specify the path where the dot tool can be 1396# found. If left blank, it is assumed the dot tool can be found in the path. 1397 1398DOT_PATH = 1399 1400# The DOTFILE_DIRS tag can be used to specify one or more directories that 1401# contain dot files that are included in the documentation (see the 1402# \dotfile command). 1403 1404DOTFILE_DIRS = 1405 1406# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1407# nodes that will be shown in the graph. If the number of nodes in a graph 1408# becomes larger than this value, doxygen will truncate the graph, which is 1409# visualized by representing a node as a red box. Note that doxygen if the 1410# number of direct children of the root node in a graph is already larger than 1411# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1412# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1413 1414DOT_GRAPH_MAX_NODES = 50 1415 1416# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1417# graphs generated by dot. A depth value of 3 means that only nodes reachable 1418# from the root by following a path via at most 3 edges will be shown. Nodes 1419# that lay further from the root node will be omitted. Note that setting this 1420# option to 1 or 2 may greatly reduce the computation time needed for large 1421# code bases. Also note that the size of a graph can be further restricted by 1422# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1423 1424MAX_DOT_GRAPH_DEPTH = 1000 1425 1426# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1427# background. This is enabled by default, which results in a transparent 1428# background. Warning: Depending on the platform used, enabling this option 1429# may lead to badly anti-aliased labels on the edges of a graph (i.e. they 1430# become hard to read). 1431 1432DOT_TRANSPARENT = NO 1433 1434# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1435# files in one run (i.e. multiple -o and -T options on the command line). This 1436# makes dot run faster, but since only newer versions of dot (>1.8.10) 1437# support this, this feature is disabled by default. 1438 1439DOT_MULTI_TARGETS = NO 1440 1441# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1442# generate a legend page explaining the meaning of the various boxes and 1443# arrows in the dot generated graphs. 1444 1445GENERATE_LEGEND = NO 1446 1447# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1448# remove the intermediate dot files that are used to generate 1449# the various graphs. 1450 1451DOT_CLEANUP = NO 1452 1453#--------------------------------------------------------------------------- 1454# Configuration::additions related to the search engine 1455#--------------------------------------------------------------------------- 1456 1457# The SEARCHENGINE tag specifies whether or not a search engine should be 1458# used. If set to NO the values of all tags below this one will be ignored. 1459 1460SEARCHENGINE = NO 1461