You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1875 lines
82 KiB

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