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.

1484 lines
63 KiB

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