🛠️🐜 Antkeeper superbuild with dependencies included https://antkeeper.com
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.

2609 lines
112 KiB

  1. # Doxyfile 1.9.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 double hash (##) is considered a comment and is placed in
  6. # front of the TAG it is preceding.
  7. #
  8. # All text after a single hash (#) is considered a comment and will be ignored.
  9. # The format is:
  10. # TAG = value [value, ...]
  11. # For lists, items can also be appended using:
  12. # TAG += value [value, ...]
  13. # Values that contain spaces should be placed between quotes (\" \").
  14. #---------------------------------------------------------------------------
  15. # Project related configuration options
  16. #---------------------------------------------------------------------------
  17. # This tag specifies the encoding used for all characters in the configuration
  18. # file that follow. The default is UTF-8 which is also the encoding used for all
  19. # text before the first occurrence of this tag. Doxygen uses libiconv (or the
  20. # iconv built into libc) for the transcoding. See
  21. # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
  22. # The default value is: UTF-8.
  23. DOXYFILE_ENCODING = UTF-8
  24. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
  25. # double-quotes, unless you are using Doxywizard) that should identify the
  26. # project for which the documentation is generated. This name is used in the
  27. # title of most generated pages and in a few other places.
  28. # The default value is: My Project.
  29. PROJECT_NAME = @PROJECT_NAME@
  30. # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
  31. # could be handy for archiving the generated documentation or if some version
  32. # control system is used.
  33. PROJECT_NUMBER = @PROJECT_VERSION@
  34. # Using the PROJECT_BRIEF tag one can provide an optional one line description
  35. # for a project that appears at the top of each page and should give viewer a
  36. # quick idea about the purpose of the project. Keep the description short.
  37. PROJECT_BRIEF =
  38. # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
  39. # in the documentation. The maximum height of the logo should not exceed 55
  40. # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
  41. # the logo to the output directory.
  42. PROJECT_LOGO =
  43. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
  44. # into which the generated documentation will be written. If a relative path is
  45. # entered, it will be relative to the location where doxygen was started. If
  46. # left blank the current directory will be used.
  47. OUTPUT_DIRECTORY = @DOXY_OUTPUT_DIRECTORY@
  48. # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
  49. # directories (in 2 levels) under the output directory of each output format and
  50. # will distribute the generated files over these directories. Enabling this
  51. # option can be useful when feeding doxygen a huge amount of source files, where
  52. # putting all generated files in the same directory would otherwise causes
  53. # performance problems for the file system.
  54. # The default value is: NO.
  55. CREATE_SUBDIRS = NO
  56. # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
  57. # characters to appear in the names of generated files. If set to NO, non-ASCII
  58. # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
  59. # U+3044.
  60. # The default value is: NO.
  61. ALLOW_UNICODE_NAMES = NO
  62. # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  63. # documentation generated by doxygen is written. Doxygen will use this
  64. # information to generate all constant output in the proper language.
  65. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
  66. # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
  67. # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
  68. # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
  69. # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
  70. # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
  71. # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
  72. # Ukrainian and Vietnamese.
  73. # The default value is: English.
  74. OUTPUT_LANGUAGE = English
  75. # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
  76. # documentation generated by doxygen is written. Doxygen will use this
  77. # information to generate all generated output in the proper direction.
  78. # Possible values are: None, LTR, RTL and Context.
  79. # The default value is: None.
  80. OUTPUT_TEXT_DIRECTION = None
  81. # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
  82. # descriptions after the members that are listed in the file and class
  83. # documentation (similar to Javadoc). Set to NO to disable this.
  84. # The default value is: YES.
  85. BRIEF_MEMBER_DESC = YES
  86. # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
  87. # description of a member or function before the detailed description
  88. #
  89. # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  90. # brief descriptions will be completely suppressed.
  91. # The default value is: YES.
  92. REPEAT_BRIEF = YES
  93. # This tag implements a quasi-intelligent brief description abbreviator that is
  94. # used to form the text in various listings. Each string in this list, if found
  95. # as the leading text of the brief description, will be stripped from the text
  96. # and the result, after processing the whole list, is used as the annotated
  97. # text. Otherwise, the brief description is used as-is. If left blank, the
  98. # following values are used ($name is automatically replaced with the name of
  99. # the entity):The $name class, The $name widget, The $name file, is, provides,
  100. # specifies, contains, represents, a, an and the.
  101. ABBREVIATE_BRIEF =
  102. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  103. # doxygen will generate a detailed section even if there is only a brief
  104. # description.
  105. # The default value is: NO.
  106. ALWAYS_DETAILED_SEC = NO
  107. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  108. # inherited members of a class in the documentation of that class as if those
  109. # members were ordinary class members. Constructors, destructors and assignment
  110. # operators of the base classes will not be shown.
  111. # The default value is: NO.
  112. INLINE_INHERITED_MEMB = NO
  113. # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
  114. # before files name in the file list and in the header files. If set to NO the
  115. # shortest path that makes the file name unique will be used
  116. # The default value is: YES.
  117. FULL_PATH_NAMES = YES
  118. # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
  119. # Stripping is only done if one of the specified strings matches the left-hand
  120. # part of the path. The tag can be used to show relative paths in the file list.
  121. # If left blank the directory from which doxygen is run is used as the path to
  122. # strip.
  123. #
  124. # Note that you can specify absolute paths here, but also relative paths, which
  125. # will be relative from the directory where doxygen is started.
  126. # This tag requires that the tag FULL_PATH_NAMES is set to YES.
  127. STRIP_FROM_PATH =
  128. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
  129. # path mentioned in the documentation of a class, which tells the reader which
  130. # header file to include in order to use a class. If left blank only the name of
  131. # the header file containing the class definition is used. Otherwise one should
  132. # specify the list of include paths that are normally passed to the compiler
  133. # using the -I flag.
  134. STRIP_FROM_INC_PATH =
  135. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
  136. # less readable) file names. This can be useful is your file systems doesn't
  137. # support long names like on DOS, Mac, or CD-ROM.
  138. # The default value is: NO.
  139. SHORT_NAMES = NO
  140. # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
  141. # first line (until the first dot) of a Javadoc-style comment as the brief
  142. # description. If set to NO, the Javadoc-style will behave just like regular Qt-
  143. # style comments (thus requiring an explicit @brief command for a brief
  144. # description.)
  145. # The default value is: NO.
  146. JAVADOC_AUTOBRIEF = NO
  147. # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
  148. # such as
  149. # /***************
  150. # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
  151. # Javadoc-style will behave just like regular comments and it will not be
  152. # interpreted by doxygen.
  153. # The default value is: NO.
  154. JAVADOC_BANNER = NO
  155. # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
  156. # line (until the first dot) of a Qt-style comment as the brief description. If
  157. # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
  158. # requiring an explicit \brief command for a brief description.)
  159. # The default value is: NO.
  160. QT_AUTOBRIEF = NO
  161. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
  162. # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
  163. # a brief description. This used to be the default behavior. The new default is
  164. # to treat a multi-line C++ comment block as a detailed description. Set this
  165. # tag to YES if you prefer the old behavior instead.
  166. #
  167. # Note that setting this tag to YES also means that rational rose comments are
  168. # not recognized any more.
  169. # The default value is: NO.
  170. MULTILINE_CPP_IS_BRIEF = NO
  171. # By default Python docstrings are displayed as preformatted text and doxygen's
  172. # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
  173. # doxygen's special commands can be used and the contents of the docstring
  174. # documentation blocks is shown as doxygen documentation.
  175. # The default value is: YES.
  176. PYTHON_DOCSTRING = YES
  177. # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
  178. # documentation from any documented member that it re-implements.
  179. # The default value is: YES.
  180. INHERIT_DOCS = YES
  181. # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
  182. # page for each member. If set to NO, the documentation of a member will be part
  183. # of the file/class/namespace that contains it.
  184. # The default value is: NO.
  185. SEPARATE_MEMBER_PAGES = NO
  186. # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
  187. # uses this value to replace tabs by spaces in code fragments.
  188. # Minimum value: 1, maximum value: 16, default value: 4.
  189. TAB_SIZE = 4
  190. # This tag can be used to specify a number of aliases that act as commands in
  191. # the documentation. An alias has the form:
  192. # name=value
  193. # For example adding
  194. # "sideeffect=@par Side Effects:\n"
  195. # will allow you to put the command \sideeffect (or @sideeffect) in the
  196. # documentation, which will result in a user-defined paragraph with heading
  197. # "Side Effects:". You can put \n's in the value part of an alias to insert
  198. # newlines (in the resulting output). You can put ^^ in the value part of an
  199. # alias to insert a newline as if a physical newline was in the original file.
  200. # When you need a literal { or } or , in the value part of an alias you have to
  201. # escape them by means of a backslash (\), this can lead to conflicts with the
  202. # commands \{ and \} for these it is advised to use the version @{ and @} or use
  203. # a double escape (\\{ and \\})
  204. ALIASES =
  205. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  206. # only. Doxygen will then generate output that is more tailored for C. For
  207. # instance, some of the names that are used will be different. The list of all
  208. # members will be omitted, etc.
  209. # The default value is: NO.
  210. OPTIMIZE_OUTPUT_FOR_C = NO
  211. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
  212. # Python sources only. Doxygen will then generate output that is more tailored
  213. # for that language. For instance, namespaces will be presented as packages,
  214. # qualified scopes will look different, etc.
  215. # The default value is: NO.
  216. OPTIMIZE_OUTPUT_JAVA = NO
  217. # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  218. # sources. Doxygen will then generate output that is tailored for Fortran.
  219. # The default value is: NO.
  220. OPTIMIZE_FOR_FORTRAN = NO
  221. # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  222. # sources. Doxygen will then generate output that is tailored for VHDL.
  223. # The default value is: NO.
  224. OPTIMIZE_OUTPUT_VHDL = NO
  225. # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
  226. # sources only. Doxygen will then generate output that is more tailored for that
  227. # language. For instance, namespaces will be presented as modules, types will be
  228. # separated into more groups, etc.
  229. # The default value is: NO.
  230. OPTIMIZE_OUTPUT_SLICE = NO
  231. # Doxygen selects the parser to use depending on the extension of the files it
  232. # parses. With this tag you can assign which parser to use for a given
  233. # extension. Doxygen has a built-in mapping, but you can override or extend it
  234. # using this tag. The format is ext=language, where ext is a file extension, and
  235. # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
  236. # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
  237. # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
  238. # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
  239. # tries to guess whether the code is fixed or free formatted code, this is the
  240. # default for Fortran type files). For instance to make doxygen treat .inc files
  241. # as Fortran files (default is PHP), and .f files as C (default is Fortran),
  242. # use: inc=Fortran f=C.
  243. #
  244. # Note: For files without extension you can use no_extension as a placeholder.
  245. #
  246. # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
  247. # the files are not read by doxygen. When specifying no_extension you should add
  248. # * to the FILE_PATTERNS.
  249. #
  250. # Note see also the list of default file extension mappings.
  251. EXTENSION_MAPPING =
  252. # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
  253. # according to the Markdown format, which allows for more readable
  254. # documentation. See https://daringfireball.net/projects/markdown/ for details.
  255. # The output of markdown processing is further processed by doxygen, so you can
  256. # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
  257. # case of backward compatibilities issues.
  258. # The default value is: YES.
  259. MARKDOWN_SUPPORT = YES
  260. # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
  261. # to that level are automatically included in the table of contents, even if
  262. # they do not have an id attribute.
  263. # Note: This feature currently applies only to Markdown headings.
  264. # Minimum value: 0, maximum value: 99, default value: 5.
  265. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
  266. TOC_INCLUDE_HEADINGS = 5
  267. # When enabled doxygen tries to link words that correspond to documented
  268. # classes, or namespaces to their corresponding documentation. Such a link can
  269. # be prevented in individual cases by putting a % sign in front of the word or
  270. # globally by setting AUTOLINK_SUPPORT to NO.
  271. # The default value is: YES.
  272. AUTOLINK_SUPPORT = YES
  273. # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  274. # to include (a tag file for) the STL sources as input, then you should set this
  275. # tag to YES in order to let doxygen match functions declarations and
  276. # definitions whose arguments contain STL classes (e.g. func(std::string);
  277. # versus func(std::string) {}). This also make the inheritance and collaboration
  278. # diagrams that involve STL classes more complete and accurate.
  279. # The default value is: NO.
  280. BUILTIN_STL_SUPPORT = NO
  281. # If you use Microsoft's C++/CLI language, you should set this option to YES to
  282. # enable parsing support.
  283. # The default value is: NO.
  284. CPP_CLI_SUPPORT = NO
  285. # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
  286. # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
  287. # will parse them like normal C++ but will assume all classes use public instead
  288. # of private inheritance when no explicit protection keyword is present.
  289. # The default value is: NO.
  290. SIP_SUPPORT = NO
  291. # For Microsoft's IDL there are propget and propput attributes to indicate
  292. # getter and setter methods for a property. Setting this option to YES will make
  293. # doxygen to replace the get and set methods by a property in the documentation.
  294. # This will only work if the methods are indeed getting or setting a simple
  295. # type. If this is not the case, or you want to show the methods anyway, you
  296. # should set this option to NO.
  297. # The default value is: YES.
  298. IDL_PROPERTY_SUPPORT = YES
  299. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  300. # tag is set to YES then doxygen will reuse the documentation of the first
  301. # member in the group (if any) for the other members of the group. By default
  302. # all members of a group must be documented explicitly.
  303. # The default value is: NO.
  304. DISTRIBUTE_GROUP_DOC = NO
  305. # If one adds a struct or class to a group and this option is enabled, then also
  306. # any nested class or struct is added to the same group. By default this option
  307. # is disabled and one has to add nested compounds explicitly via \ingroup.
  308. # The default value is: NO.
  309. GROUP_NESTED_COMPOUNDS = NO
  310. # Set the SUBGROUPING tag to YES to allow class member groups of the same type
  311. # (for instance a group of public functions) to be put as a subgroup of that
  312. # type (e.g. under the Public Functions section). Set it to NO to prevent
  313. # subgrouping. Alternatively, this can be done per class using the
  314. # \nosubgrouping command.
  315. # The default value is: YES.
  316. SUBGROUPING = YES
  317. # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
  318. # are shown inside the group in which they are included (e.g. using \ingroup)
  319. # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
  320. # and RTF).
  321. #
  322. # Note that this feature does not work in combination with
  323. # SEPARATE_MEMBER_PAGES.
  324. # The default value is: NO.
  325. INLINE_GROUPED_CLASSES = NO
  326. # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
  327. # with only public data fields or simple typedef fields will be shown inline in
  328. # the documentation of the scope in which they are defined (i.e. file,
  329. # namespace, or group documentation), provided this scope is documented. If set
  330. # to NO, structs, classes, and unions are shown on a separate page (for HTML and
  331. # Man pages) or section (for LaTeX and RTF).
  332. # The default value is: NO.
  333. INLINE_SIMPLE_STRUCTS = NO
  334. # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
  335. # enum is documented as struct, union, or enum with the name of the typedef. So
  336. # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  337. # with name TypeT. When disabled the typedef will appear as a member of a file,
  338. # namespace, or class. And the struct will be named TypeS. This can typically be
  339. # useful for C code in case the coding convention dictates that all compound
  340. # types are typedef'ed and only the typedef is referenced, never the tag name.
  341. # The default value is: NO.
  342. TYPEDEF_HIDES_STRUCT = NO
  343. # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
  344. # cache is used to resolve symbols given their name and scope. Since this can be
  345. # an expensive process and often the same symbol appears multiple times in the
  346. # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
  347. # doxygen will become slower. If the cache is too large, memory is wasted. The
  348. # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
  349. # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
  350. # symbols. At the end of a run doxygen will report the cache usage and suggest
  351. # the optimal cache size from a speed point of view.
  352. # Minimum value: 0, maximum value: 9, default value: 0.
  353. LOOKUP_CACHE_SIZE = 0
  354. # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
  355. # during processing. When set to 0 doxygen will based this on the number of
  356. # cores available in the system. You can set it explicitly to a value larger
  357. # than 0 to get more control over the balance between CPU load and processing
  358. # speed. At this moment only the input processing can be done using multiple
  359. # threads. Since this is still an experimental feature the default is set to 1,
  360. # which efficively disables parallel processing. Please report any issues you
  361. # encounter. Generating dot graphs in parallel is controlled by the
  362. # DOT_NUM_THREADS setting.
  363. # Minimum value: 0, maximum value: 32, default value: 1.
  364. NUM_PROC_THREADS = 1
  365. #---------------------------------------------------------------------------
  366. # Build related configuration options
  367. #---------------------------------------------------------------------------
  368. # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
  369. # documentation are documented, even if no documentation was available. Private
  370. # class members and static file members will be hidden unless the
  371. # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
  372. # Note: This will also disable the warnings about undocumented members that are
  373. # normally produced when WARNINGS is set to YES.
  374. # The default value is: NO.
  375. EXTRACT_ALL = NO
  376. # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
  377. # be included in the documentation.
  378. # The default value is: NO.
  379. EXTRACT_PRIVATE = NO
  380. # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
  381. # methods of a class will be included in the documentation.
  382. # The default value is: NO.
  383. EXTRACT_PRIV_VIRTUAL = NO
  384. # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
  385. # scope will be included in the documentation.
  386. # The default value is: NO.
  387. EXTRACT_PACKAGE = NO
  388. # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
  389. # included in the documentation.
  390. # The default value is: NO.
  391. EXTRACT_STATIC = NO
  392. # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
  393. # locally in source files will be included in the documentation. If set to NO,
  394. # only classes defined in header files are included. Does not have any effect
  395. # for Java sources.
  396. # The default value is: YES.
  397. EXTRACT_LOCAL_CLASSES = YES
  398. # This flag is only useful for Objective-C code. If set to YES, local methods,
  399. # which are defined in the implementation section but not in the interface are
  400. # included in the documentation. If set to NO, only methods in the interface are
  401. # included.
  402. # The default value is: NO.
  403. EXTRACT_LOCAL_METHODS = NO
  404. # If this flag is set to YES, the members of anonymous namespaces will be
  405. # extracted and appear in the documentation as a namespace called
  406. # 'anonymous_namespace{file}', where file will be replaced with the base name of
  407. # the file that contains the anonymous namespace. By default anonymous namespace
  408. # are hidden.
  409. # The default value is: NO.
  410. EXTRACT_ANON_NSPACES = NO
  411. # If this flag is set to YES, the name of an unnamed parameter in a declaration
  412. # will be determined by the corresponding definition. By default unnamed
  413. # parameters remain unnamed in the output.
  414. # The default value is: YES.
  415. RESOLVE_UNNAMED_PARAMS = YES
  416. # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
  417. # undocumented members inside documented classes or files. If set to NO these
  418. # members will be included in the various overviews, but no documentation
  419. # section is generated. This option has no effect if EXTRACT_ALL is enabled.
  420. # The default value is: NO.
  421. HIDE_UNDOC_MEMBERS = NO
  422. # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
  423. # undocumented classes that are normally visible in the class hierarchy. If set
  424. # to NO, these classes will be included in the various overviews. This option
  425. # has no effect if EXTRACT_ALL is enabled.
  426. # The default value is: NO.
  427. HIDE_UNDOC_CLASSES = NO
  428. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
  429. # declarations. If set to NO, these declarations will be included in the
  430. # documentation.
  431. # The default value is: NO.
  432. HIDE_FRIEND_COMPOUNDS = NO
  433. # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
  434. # documentation blocks found inside the body of a function. If set to NO, these
  435. # blocks will be appended to the function's detailed documentation block.
  436. # The default value is: NO.
  437. HIDE_IN_BODY_DOCS = NO
  438. # The INTERNAL_DOCS tag determines if documentation that is typed after a
  439. # \internal command is included. If the tag is set to NO then the documentation
  440. # will be excluded. Set it to YES to include the internal documentation.
  441. # The default value is: NO.
  442. INTERNAL_DOCS = NO
  443. # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
  444. # able to match the capabilities of the underlying filesystem. In case the
  445. # filesystem is case sensitive (i.e. it supports files in the same directory
  446. # whose names only differ in casing), the option must be set to YES to properly
  447. # deal with such files in case they appear in the input. For filesystems that
  448. # are not case sensitive the option should be be set to NO to properly deal with
  449. # output files written for symbols that only differ in casing, such as for two
  450. # classes, one named CLASS and the other named Class, and to also support
  451. # references to files without having to specify the exact matching casing. On
  452. # Windows (including Cygwin) and MacOS, users should typically set this option
  453. # to NO, whereas on Linux or other Unix flavors it should typically be set to
  454. # YES.
  455. # The default value is: system dependent.
  456. CASE_SENSE_NAMES = YES
  457. # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
  458. # their full class and namespace scopes in the documentation. If set to YES, the
  459. # scope will be hidden.
  460. # The default value is: NO.
  461. HIDE_SCOPE_NAMES = NO
  462. # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
  463. # append additional text to a page's title, such as Class Reference. If set to
  464. # YES the compound reference will be hidden.
  465. # The default value is: NO.
  466. HIDE_COMPOUND_REFERENCE= NO
  467. # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
  468. # the files that are included by a file in the documentation of that file.
  469. # The default value is: YES.
  470. SHOW_INCLUDE_FILES = YES
  471. # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
  472. # grouped member an include statement to the documentation, telling the reader
  473. # which file to include in order to use the member.
  474. # The default value is: NO.
  475. SHOW_GROUPED_MEMB_INC = NO
  476. # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
  477. # files with double quotes in the documentation rather than with sharp brackets.
  478. # The default value is: NO.
  479. FORCE_LOCAL_INCLUDES = NO
  480. # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
  481. # documentation for inline members.
  482. # The default value is: YES.
  483. INLINE_INFO = YES
  484. # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
  485. # (detailed) documentation of file and class members alphabetically by member
  486. # name. If set to NO, the members will appear in declaration order.
  487. # The default value is: YES.
  488. SORT_MEMBER_DOCS = YES
  489. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
  490. # descriptions of file, namespace and class members alphabetically by member
  491. # name. If set to NO, the members will appear in declaration order. Note that
  492. # this will also influence the order of the classes in the class list.
  493. # The default value is: NO.
  494. SORT_BRIEF_DOCS = NO
  495. # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
  496. # (brief and detailed) documentation of class members so that constructors and
  497. # destructors are listed first. If set to NO the constructors will appear in the
  498. # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
  499. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
  500. # member documentation.
  501. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
  502. # detailed member documentation.
  503. # The default value is: NO.
  504. SORT_MEMBERS_CTORS_1ST = NO
  505. # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
  506. # of group names into alphabetical order. If set to NO the group names will
  507. # appear in their defined order.
  508. # The default value is: NO.
  509. SORT_GROUP_NAMES = NO
  510. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
  511. # fully-qualified names, including namespaces. If set to NO, the class list will
  512. # be sorted only by class name, not including the namespace part.
  513. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  514. # Note: This option applies only to the class list, not to the alphabetical
  515. # list.
  516. # The default value is: NO.
  517. SORT_BY_SCOPE_NAME = NO
  518. # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
  519. # type resolution of all parameters of a function it will reject a match between
  520. # the prototype and the implementation of a member function even if there is
  521. # only one candidate or it is obvious which candidate to choose by doing a
  522. # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
  523. # accept a match between prototype and implementation in such cases.
  524. # The default value is: NO.
  525. STRICT_PROTO_MATCHING = NO
  526. # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
  527. # list. This list is created by putting \todo commands in the documentation.
  528. # The default value is: YES.
  529. GENERATE_TODOLIST = YES
  530. # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
  531. # list. This list is created by putting \test commands in the documentation.
  532. # The default value is: YES.
  533. GENERATE_TESTLIST = YES
  534. # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
  535. # list. This list is created by putting \bug commands in the documentation.
  536. # The default value is: YES.
  537. GENERATE_BUGLIST = YES
  538. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
  539. # the deprecated list. This list is created by putting \deprecated commands in
  540. # the documentation.
  541. # The default value is: YES.
  542. GENERATE_DEPRECATEDLIST= YES
  543. # The ENABLED_SECTIONS tag can be used to enable conditional documentation
  544. # sections, marked by \if <section_label> ... \endif and \cond <section_label>
  545. # ... \endcond blocks.
  546. ENABLED_SECTIONS =
  547. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
  548. # initial value of a variable or macro / define can have for it to appear in the
  549. # documentation. If the initializer consists of more lines than specified here
  550. # it will be hidden. Use a value of 0 to hide initializers completely. The
  551. # appearance of the value of individual variables and macros / defines can be
  552. # controlled using \showinitializer or \hideinitializer command in the
  553. # documentation regardless of this setting.
  554. # Minimum value: 0, maximum value: 10000, default value: 30.
  555. MAX_INITIALIZER_LINES = 30
  556. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
  557. # the bottom of the documentation of classes and structs. If set to YES, the
  558. # list will mention the files that were used to generate the documentation.
  559. # The default value is: YES.
  560. SHOW_USED_FILES = YES
  561. # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
  562. # will remove the Files entry from the Quick Index and from the Folder Tree View
  563. # (if specified).
  564. # The default value is: YES.
  565. SHOW_FILES = YES
  566. # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
  567. # page. This will remove the Namespaces entry from the Quick Index and from the
  568. # Folder Tree View (if specified).
  569. # The default value is: YES.
  570. SHOW_NAMESPACES = YES
  571. # The FILE_VERSION_FILTER tag can be used to specify a program or script that
  572. # doxygen should invoke to get the current version for each file (typically from
  573. # the version control system). Doxygen will invoke the program by executing (via
  574. # popen()) the command command input-file, where command is the value of the
  575. # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
  576. # by doxygen. Whatever the program writes to standard output is used as the file
  577. # version. For an example see the documentation.
  578. FILE_VERSION_FILTER =
  579. # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  580. # by doxygen. The layout file controls the global structure of the generated
  581. # output files in an output format independent way. To create the layout file
  582. # that represents doxygen's defaults, run doxygen with the -l option. You can
  583. # optionally specify a file name after the option, if omitted DoxygenLayout.xml
  584. # will be used as the name of the layout file.
  585. #
  586. # Note that if you run doxygen from a directory containing a file called
  587. # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
  588. # tag is left empty.
  589. LAYOUT_FILE =
  590. # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
  591. # the reference definitions. This must be a list of .bib files. The .bib
  592. # extension is automatically appended if omitted. This requires the bibtex tool
  593. # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
  594. # For LaTeX the style of the bibliography can be controlled using
  595. # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
  596. # search path. See also \cite for info how to create references.
  597. CITE_BIB_FILES =
  598. #---------------------------------------------------------------------------
  599. # Configuration options related to warning and progress messages
  600. #---------------------------------------------------------------------------
  601. # The QUIET tag can be used to turn on/off the messages that are generated to
  602. # standard output by doxygen. If QUIET is set to YES this implies that the
  603. # messages are off.
  604. # The default value is: NO.
  605. QUIET = NO
  606. # The WARNINGS tag can be used to turn on/off the warning messages that are
  607. # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
  608. # this implies that the warnings are on.
  609. #
  610. # Tip: Turn warnings on while writing the documentation.
  611. # The default value is: YES.
  612. WARNINGS = YES
  613. # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
  614. # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
  615. # will automatically be disabled.
  616. # The default value is: YES.
  617. WARN_IF_UNDOCUMENTED = YES
  618. # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
  619. # potential errors in the documentation, such as not documenting some parameters
  620. # in a documented function, or documenting parameters that don't exist or using
  621. # markup commands wrongly.
  622. # The default value is: YES.
  623. WARN_IF_DOC_ERROR = YES
  624. # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
  625. # are documented, but have no documentation for their parameters or return
  626. # value. If set to NO, doxygen will only warn about wrong or incomplete
  627. # parameter documentation, but not about the absence of documentation. If
  628. # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
  629. # The default value is: NO.
  630. WARN_NO_PARAMDOC = YES
  631. # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
  632. # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
  633. # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
  634. # at the end of the doxygen process doxygen will return with a non-zero status.
  635. # Possible values are: NO, YES and FAIL_ON_WARNINGS.
  636. # The default value is: NO.
  637. WARN_AS_ERROR = NO
  638. # The WARN_FORMAT tag determines the format of the warning messages that doxygen
  639. # can produce. The string should contain the $file, $line, and $text tags, which
  640. # will be replaced by the file and line number from which the warning originated
  641. # and the warning text. Optionally the format may contain $version, which will
  642. # be replaced by the version of the file (if it could be obtained via
  643. # FILE_VERSION_FILTER)
  644. # The default value is: $file:$line: $text.
  645. WARN_FORMAT = "$file:$line: $text"
  646. # The WARN_LOGFILE tag can be used to specify a file to which warning and error
  647. # messages should be written. If left blank the output is written to standard
  648. # error (stderr).
  649. WARN_LOGFILE =
  650. #---------------------------------------------------------------------------
  651. # Configuration options related to the input files
  652. #---------------------------------------------------------------------------
  653. # The INPUT tag is used to specify the files and/or directories that contain
  654. # documented source files. You may enter file names like myfile.cpp or
  655. # directories like /usr/src/myproject. Separate the files or directories with
  656. # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
  657. # Note: If this tag is empty the current directory is searched.
  658. INPUT = @DOXY_SOURCE_DIRECTORY@ \
  659. @DOXY_DOCS_DIRECTORY@ \
  660. @PROJECT_SOURCE_DIR@/README.md
  661. # This tag can be used to specify the character encoding of the source files
  662. # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
  663. # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
  664. # documentation (see:
  665. # https://www.gnu.org/software/libiconv/) for the list of possible encodings.
  666. # The default value is: UTF-8.
  667. INPUT_ENCODING = UTF-8
  668. # If the value of the INPUT tag contains directories, you can use the
  669. # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
  670. # *.h) to filter out the source-files in the directories.
  671. #
  672. # Note that for custom extensions or not directly supported extensions you also
  673. # need to set EXTENSION_MAPPING for the extension otherwise the files are not
  674. # read by doxygen.
  675. #
  676. # Note the list of default checked file patterns might differ from the list of
  677. # default file extension mappings.
  678. #
  679. # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
  680. # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
  681. # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
  682. # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
  683. # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
  684. # *.ucf, *.qsf and *.ice.
  685. FILE_PATTERNS = *.h \
  686. *.hpp \
  687. *.md \
  688. *.dox
  689. # The RECURSIVE tag can be used to specify whether or not subdirectories should
  690. # be searched for input files as well.
  691. # The default value is: NO.
  692. RECURSIVE = YES
  693. # The EXCLUDE tag can be used to specify files and/or directories that should be
  694. # excluded from the INPUT source files. This way you can easily exclude a
  695. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  696. #
  697. # Note that relative paths are relative to the directory from which doxygen is
  698. # run.
  699. EXCLUDE = @DOXY_DEPS_DIRECTORY@
  700. # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
  701. # directories that are symbolic links (a Unix file system feature) are excluded
  702. # from the input.
  703. # The default value is: NO.
  704. EXCLUDE_SYMLINKS = NO
  705. # If the value of the INPUT tag contains directories, you can use the
  706. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  707. # certain files from those directories.
  708. #
  709. # Note that the wildcards are matched against the file with absolute path, so to
  710. # exclude all test directories for example use the pattern */test/*
  711. EXCLUDE_PATTERNS =
  712. # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  713. # (namespaces, classes, functions, etc.) that should be excluded from the
  714. # output. The symbol name can be a fully qualified name, a word, or if the
  715. # wildcard * is used, a substring. Examples: ANamespace, AClass,
  716. # AClass::ANamespace, ANamespace::*Test
  717. #
  718. # Note that the wildcards are matched against the file with absolute path, so to
  719. # exclude all test directories use the pattern */test/*
  720. EXCLUDE_SYMBOLS =
  721. # The EXAMPLE_PATH tag can be used to specify one or more files or directories
  722. # that contain example code fragments that are included (see the \include
  723. # command).
  724. EXAMPLE_PATH =
  725. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  726. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
  727. # *.h) to filter out the source-files in the directories. If left blank all
  728. # files are included.
  729. EXAMPLE_PATTERNS = *
  730. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  731. # searched for input files to be used with the \include or \dontinclude commands
  732. # irrespective of the value of the RECURSIVE tag.
  733. # The default value is: NO.
  734. EXAMPLE_RECURSIVE = NO
  735. # The IMAGE_PATH tag can be used to specify one or more files or directories
  736. # that contain images that are to be included in the documentation (see the
  737. # \image command).
  738. IMAGE_PATH =
  739. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  740. # invoke to filter for each input file. Doxygen will invoke the filter program
  741. # by executing (via popen()) the command:
  742. #
  743. # <filter> <input-file>
  744. #
  745. # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
  746. # name of an input file. Doxygen will then use the output that the filter
  747. # program writes to standard output. If FILTER_PATTERNS is specified, this tag
  748. # will be ignored.
  749. #
  750. # Note that the filter must not add or remove lines; it is applied before the
  751. # code is scanned, but not when the output code is generated. If lines are added
  752. # or removed, the anchors will not be placed correctly.
  753. #
  754. # Note that for custom extensions or not directly supported extensions you also
  755. # need to set EXTENSION_MAPPING for the extension otherwise the files are not
  756. # properly processed by doxygen.
  757. INPUT_FILTER =
  758. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  759. # basis. Doxygen will compare the file name with each pattern and apply the
  760. # filter if there is a match. The filters are a list of the form: pattern=filter
  761. # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
  762. # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
  763. # patterns match the file name, INPUT_FILTER is applied.
  764. #
  765. # Note that for custom extensions or not directly supported extensions you also
  766. # need to set EXTENSION_MAPPING for the extension otherwise the files are not
  767. # properly processed by doxygen.
  768. FILTER_PATTERNS =
  769. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  770. # INPUT_FILTER) will also be used to filter the input files that are used for
  771. # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
  772. # The default value is: NO.
  773. FILTER_SOURCE_FILES = NO
  774. # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  775. # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
  776. # it is also possible to disable source filtering for a specific pattern using
  777. # *.ext= (so without naming a filter).
  778. # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
  779. FILTER_SOURCE_PATTERNS =
  780. # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
  781. # is part of the input, its contents will be placed on the main page
  782. # (index.html). This can be useful if you have a project on for instance GitHub
  783. # and want to reuse the introduction page also for the doxygen output.
  784. USE_MDFILE_AS_MAINPAGE = @PROJECT_SOURCE_DIR@/README.md
  785. #---------------------------------------------------------------------------
  786. # Configuration options related to source browsing
  787. #---------------------------------------------------------------------------
  788. # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
  789. # generated. Documented entities will be cross-referenced with these sources.
  790. #
  791. # Note: To get rid of all source code in the generated output, make sure that
  792. # also VERBATIM_HEADERS is set to NO.
  793. # The default value is: NO.
  794. SOURCE_BROWSER = YES
  795. # Setting the INLINE_SOURCES tag to YES will include the body of functions,
  796. # classes and enums directly into the documentation.
  797. # The default value is: NO.
  798. INLINE_SOURCES = NO
  799. # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
  800. # special comment blocks from generated source code fragments. Normal C, C++ and
  801. # Fortran comments will always remain visible.
  802. # The default value is: YES.
  803. STRIP_CODE_COMMENTS = YES
  804. # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
  805. # entity all documented functions referencing it will be listed.
  806. # The default value is: NO.
  807. REFERENCED_BY_RELATION = NO
  808. # If the REFERENCES_RELATION tag is set to YES then for each documented function
  809. # all documented entities called/used by that function will be listed.
  810. # The default value is: NO.
  811. REFERENCES_RELATION = NO
  812. # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
  813. # to YES then the hyperlinks from functions in REFERENCES_RELATION and
  814. # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
  815. # link to the documentation.
  816. # The default value is: YES.
  817. REFERENCES_LINK_SOURCE = YES
  818. # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
  819. # source code will show a tooltip with additional information such as prototype,
  820. # brief description and links to the definition and documentation. Since this
  821. # will make the HTML file larger and loading of large files a bit slower, you
  822. # can opt to disable this feature.
  823. # The default value is: YES.
  824. # This tag requires that the tag SOURCE_BROWSER is set to YES.
  825. SOURCE_TOOLTIPS = YES
  826. # If the USE_HTAGS tag is set to YES then the references to source code will
  827. # point to the HTML generated by the htags(1) tool instead of doxygen built-in
  828. # source browser. The htags tool is part of GNU's global source tagging system
  829. # (see https://www.gnu.org/software/global/global.html). You will need version
  830. # 4.8.6 or higher.
  831. #
  832. # To use it do the following:
  833. # - Install the latest version of global
  834. # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
  835. # - Make sure the INPUT points to the root of the source tree
  836. # - Run doxygen as normal
  837. #
  838. # Doxygen will invoke htags (and that will in turn invoke gtags), so these
  839. # tools must be available from the command line (i.e. in the search path).
  840. #
  841. # The result: instead of the source browser generated by doxygen, the links to
  842. # source code will now point to the output of htags.
  843. # The default value is: NO.
  844. # This tag requires that the tag SOURCE_BROWSER is set to YES.
  845. USE_HTAGS = NO
  846. # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
  847. # verbatim copy of the header file for each class for which an include is
  848. # specified. Set to NO to disable this.
  849. # See also: Section \class.
  850. # The default value is: YES.
  851. VERBATIM_HEADERS = YES
  852. # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
  853. # clang parser (see:
  854. # http://clang.llvm.org/) for more accurate parsing at the cost of reduced
  855. # performance. This can be particularly helpful with template rich C++ code for
  856. # which doxygen's built-in parser lacks the necessary type information.
  857. # Note: The availability of this option depends on whether or not doxygen was
  858. # generated with the -Duse_libclang=ON option for CMake.
  859. # The default value is: NO.
  860. CLANG_ASSISTED_PARSING = NO
  861. # If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to
  862. # YES then doxygen will add the directory of each input to the include path.
  863. # The default value is: YES.
  864. CLANG_ADD_INC_PATHS = YES
  865. # If clang assisted parsing is enabled you can provide the compiler with command
  866. # line options that you would normally use when invoking the compiler. Note that
  867. # the include paths will already be set by doxygen for the files and directories
  868. # specified with INPUT and INCLUDE_PATH.
  869. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
  870. CLANG_OPTIONS =
  871. # If clang assisted parsing is enabled you can provide the clang parser with the
  872. # path to the directory containing a file called compile_commands.json. This
  873. # file is the compilation database (see:
  874. # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
  875. # options used when the source files were built. This is equivalent to
  876. # specifying the -p option to a clang tool, such as clang-check. These options
  877. # will then be passed to the parser. Any options specified with CLANG_OPTIONS
  878. # will be added as well.
  879. # Note: The availability of this option depends on whether or not doxygen was
  880. # generated with the -Duse_libclang=ON option for CMake.
  881. CLANG_DATABASE_PATH =
  882. #---------------------------------------------------------------------------
  883. # Configuration options related to the alphabetical class index
  884. #---------------------------------------------------------------------------
  885. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
  886. # compounds will be generated. Enable this if the project contains a lot of
  887. # classes, structs, unions or interfaces.
  888. # The default value is: YES.
  889. ALPHABETICAL_INDEX = YES
  890. # In case all classes in a project start with a common prefix, all classes will
  891. # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
  892. # can be used to specify a prefix (or a list of prefixes) that should be ignored
  893. # while generating the index headers.
  894. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  895. IGNORE_PREFIX =
  896. #---------------------------------------------------------------------------
  897. # Configuration options related to the HTML output
  898. #---------------------------------------------------------------------------
  899. # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
  900. # The default value is: YES.
  901. GENERATE_HTML = YES
  902. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
  903. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  904. # it.
  905. # The default directory is: html.
  906. # This tag requires that the tag GENERATE_HTML is set to YES.
  907. HTML_OUTPUT = html
  908. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
  909. # generated HTML page (for example: .htm, .php, .asp).
  910. # The default value is: .html.
  911. # This tag requires that the tag GENERATE_HTML is set to YES.
  912. HTML_FILE_EXTENSION = .html
  913. # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
  914. # each generated HTML page. If the tag is left blank doxygen will generate a
  915. # standard header.
  916. #
  917. # To get valid HTML the header file that includes any scripts and style sheets
  918. # that doxygen needs, which is dependent on the configuration options used (e.g.
  919. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
  920. # default header using
  921. # doxygen -w html new_header.html new_footer.html new_stylesheet.css
  922. # YourConfigFile
  923. # and then modify the file new_header.html. See also section "Doxygen usage"
  924. # for information on how to generate the default header that doxygen normally
  925. # uses.
  926. # Note: The header is subject to change so you typically have to regenerate the
  927. # default header when upgrading to a newer version of doxygen. For a description
  928. # of the possible markers and block names see the documentation.
  929. # This tag requires that the tag GENERATE_HTML is set to YES.
  930. HTML_HEADER =
  931. # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
  932. # generated HTML page. If the tag is left blank doxygen will generate a standard
  933. # footer. See HTML_HEADER for more information on how to generate a default
  934. # footer and what special commands can be used inside the footer. See also
  935. # section "Doxygen usage" for information on how to generate the default footer
  936. # that doxygen normally uses.
  937. # This tag requires that the tag GENERATE_HTML is set to YES.
  938. HTML_FOOTER =
  939. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
  940. # sheet that is used by each HTML page. It can be used to fine-tune the look of
  941. # the HTML output. If left blank doxygen will generate a default style sheet.
  942. # See also section "Doxygen usage" for information on how to generate the style
  943. # sheet that doxygen normally uses.
  944. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
  945. # it is more robust and this tag (HTML_STYLESHEET) will in the future become
  946. # obsolete.
  947. # This tag requires that the tag GENERATE_HTML is set to YES.
  948. HTML_STYLESHEET =
  949. # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  950. # cascading style sheets that are included after the standard style sheets
  951. # created by doxygen. Using this option one can overrule certain style aspects.
  952. # This is preferred over using HTML_STYLESHEET since it does not replace the
  953. # standard style sheet and is therefore more robust against future updates.
  954. # Doxygen will copy the style sheet files to the output directory.
  955. # Note: The order of the extra style sheet files is of importance (e.g. the last
  956. # style sheet in the list overrules the setting of the previous ones in the
  957. # list). For an example see the documentation.
  958. # This tag requires that the tag GENERATE_HTML is set to YES.
  959. HTML_EXTRA_STYLESHEET =
  960. # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  961. # other source files which should be copied to the HTML output directory. Note
  962. # that these files will be copied to the base HTML output directory. Use the
  963. # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  964. # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
  965. # files will be copied as-is; there are no commands or markers available.
  966. # This tag requires that the tag GENERATE_HTML is set to YES.
  967. HTML_EXTRA_FILES =
  968. # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
  969. # will adjust the colors in the style sheet and background images according to
  970. # this color. Hue is specified as an angle on a colorwheel, see
  971. # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
  972. # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
  973. # purple, and 360 is red again.
  974. # Minimum value: 0, maximum value: 359, default value: 220.
  975. # This tag requires that the tag GENERATE_HTML is set to YES.
  976. HTML_COLORSTYLE_HUE = 220
  977. # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
  978. # in the HTML output. For a value of 0 the output will use grayscales only. A
  979. # value of 255 will produce the most vivid colors.
  980. # Minimum value: 0, maximum value: 255, default value: 100.
  981. # This tag requires that the tag GENERATE_HTML is set to YES.
  982. HTML_COLORSTYLE_SAT = 100
  983. # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
  984. # luminance component of the colors in the HTML output. Values below 100
  985. # gradually make the output lighter, whereas values above 100 make the output
  986. # darker. The value divided by 100 is the actual gamma applied, so 80 represents
  987. # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
  988. # change the gamma.
  989. # Minimum value: 40, maximum value: 240, default value: 80.
  990. # This tag requires that the tag GENERATE_HTML is set to YES.
  991. HTML_COLORSTYLE_GAMMA = 80
  992. # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  993. # page will contain the date and time when the page was generated. Setting this
  994. # to YES can help to show when doxygen was last run and thus if the
  995. # documentation is up to date.
  996. # The default value is: NO.
  997. # This tag requires that the tag GENERATE_HTML is set to YES.
  998. HTML_TIMESTAMP = NO
  999. # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
  1000. # documentation will contain a main index with vertical navigation menus that
  1001. # are dynamically created via JavaScript. If disabled, the navigation index will
  1002. # consists of multiple levels of tabs that are statically embedded in every HTML
  1003. # page. Disable this option to support browsers that do not have JavaScript,
  1004. # like the Qt help browser.
  1005. # The default value is: YES.
  1006. # This tag requires that the tag GENERATE_HTML is set to YES.
  1007. HTML_DYNAMIC_MENUS = YES
  1008. # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  1009. # documentation will contain sections that can be hidden and shown after the
  1010. # page has loaded.
  1011. # The default value is: NO.
  1012. # This tag requires that the tag GENERATE_HTML is set to YES.
  1013. HTML_DYNAMIC_SECTIONS = NO
  1014. # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
  1015. # shown in the various tree structured indices initially; the user can expand
  1016. # and collapse entries dynamically later on. Doxygen will expand the tree to
  1017. # such a level that at most the specified number of entries are visible (unless
  1018. # a fully collapsed tree already exceeds this amount). So setting the number of
  1019. # entries 1 will produce a full collapsed tree by default. 0 is a special value
  1020. # representing an infinite number of entries and will result in a full expanded
  1021. # tree by default.
  1022. # Minimum value: 0, maximum value: 9999, default value: 100.
  1023. # This tag requires that the tag GENERATE_HTML is set to YES.
  1024. HTML_INDEX_NUM_ENTRIES = 100
  1025. # If the GENERATE_DOCSET tag is set to YES, additional index files will be
  1026. # generated that can be used as input for Apple's Xcode 3 integrated development
  1027. # environment (see:
  1028. # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
  1029. # create a documentation set, doxygen will generate a Makefile in the HTML
  1030. # output directory. Running make will produce the docset in that directory and
  1031. # running make install will install the docset in
  1032. # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
  1033. # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
  1034. # genXcode/_index.html for more information.
  1035. # The default value is: NO.
  1036. # This tag requires that the tag GENERATE_HTML is set to YES.
  1037. GENERATE_DOCSET = NO
  1038. # This tag determines the name of the docset feed. A documentation feed provides
  1039. # an umbrella under which multiple documentation sets from a single provider
  1040. # (such as a company or product suite) can be grouped.
  1041. # The default value is: Doxygen generated docs.
  1042. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1043. DOCSET_FEEDNAME = "Doxygen generated docs"
  1044. # This tag specifies a string that should uniquely identify the documentation
  1045. # set bundle. This should be a reverse domain-name style string, e.g.
  1046. # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
  1047. # The default value is: org.doxygen.Project.
  1048. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1049. DOCSET_BUNDLE_ID = org.doxygen.Project
  1050. # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
  1051. # the documentation publisher. This should be a reverse domain-name style
  1052. # string, e.g. com.mycompany.MyDocSet.documentation.
  1053. # The default value is: org.doxygen.Publisher.
  1054. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1055. DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  1056. # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
  1057. # The default value is: Publisher.
  1058. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1059. DOCSET_PUBLISHER_NAME = Publisher
  1060. # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
  1061. # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
  1062. # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
  1063. # (see:
  1064. # https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
  1065. #
  1066. # The HTML Help Workshop contains a compiler that can convert all HTML output
  1067. # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
  1068. # files are now used as the Windows 98 help format, and will replace the old
  1069. # Windows help format (.hlp) on all Windows platforms in the future. Compressed
  1070. # HTML files also contain an index, a table of contents, and you can search for
  1071. # words in the documentation. The HTML workshop also contains a viewer for
  1072. # compressed HTML files.
  1073. # The default value is: NO.
  1074. # This tag requires that the tag GENERATE_HTML is set to YES.
  1075. GENERATE_HTMLHELP = NO
  1076. # The CHM_FILE tag can be used to specify the file name of the resulting .chm
  1077. # file. You can add a path in front of the file if the result should not be
  1078. # written to the html output directory.
  1079. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1080. CHM_FILE =
  1081. # The HHC_LOCATION tag can be used to specify the location (absolute path
  1082. # including file name) of the HTML help compiler (hhc.exe). If non-empty,
  1083. # doxygen will try to run the HTML help compiler on the generated index.hhp.
  1084. # The file has to be specified with full path.
  1085. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1086. HHC_LOCATION =
  1087. # The GENERATE_CHI flag controls if a separate .chi index file is generated
  1088. # (YES) or that it should be included in the main .chm file (NO).
  1089. # The default value is: NO.
  1090. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1091. GENERATE_CHI = NO
  1092. # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
  1093. # and project file content.
  1094. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1095. CHM_INDEX_ENCODING =
  1096. # The BINARY_TOC flag controls whether a binary table of contents is generated
  1097. # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
  1098. # enables the Previous and Next buttons.
  1099. # The default value is: NO.
  1100. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1101. BINARY_TOC = NO
  1102. # The TOC_EXPAND flag can be set to YES to add extra items for group members to
  1103. # the table of contents of the HTML help documentation and to the tree view.
  1104. # The default value is: NO.
  1105. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1106. TOC_EXPAND = NO
  1107. # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  1108. # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
  1109. # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
  1110. # (.qch) of the generated HTML documentation.
  1111. # The default value is: NO.
  1112. # This tag requires that the tag GENERATE_HTML is set to YES.
  1113. GENERATE_QHP = NO
  1114. # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
  1115. # the file name of the resulting .qch file. The path specified is relative to
  1116. # the HTML output folder.
  1117. # This tag requires that the tag GENERATE_QHP is set to YES.
  1118. QCH_FILE =
  1119. # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
  1120. # Project output. For more information please see Qt Help Project / Namespace
  1121. # (see:
  1122. # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
  1123. # The default value is: org.doxygen.Project.
  1124. # This tag requires that the tag GENERATE_QHP is set to YES.
  1125. QHP_NAMESPACE = org.doxygen.Project
  1126. # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
  1127. # Help Project output. For more information please see Qt Help Project / Virtual
  1128. # Folders (see:
  1129. # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
  1130. # The default value is: doc.
  1131. # This tag requires that the tag GENERATE_QHP is set to YES.
  1132. QHP_VIRTUAL_FOLDER = doc
  1133. # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
  1134. # filter to add. For more information please see Qt Help Project / Custom
  1135. # Filters (see:
  1136. # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
  1137. # This tag requires that the tag GENERATE_QHP is set to YES.
  1138. QHP_CUST_FILTER_NAME =
  1139. # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
  1140. # custom filter to add. For more information please see Qt Help Project / Custom
  1141. # Filters (see:
  1142. # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
  1143. # This tag requires that the tag GENERATE_QHP is set to YES.
  1144. QHP_CUST_FILTER_ATTRS =
  1145. # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  1146. # project's filter section matches. Qt Help Project / Filter Attributes (see:
  1147. # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
  1148. # This tag requires that the tag GENERATE_QHP is set to YES.
  1149. QHP_SECT_FILTER_ATTRS =
  1150. # The QHG_LOCATION tag can be used to specify the location (absolute path
  1151. # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
  1152. # run qhelpgenerator on the generated .qhp file.
  1153. # This tag requires that the tag GENERATE_QHP is set to YES.
  1154. QHG_LOCATION =
  1155. # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
  1156. # generated, together with the HTML files, they form an Eclipse help plugin. To
  1157. # install this plugin and make it available under the help contents menu in
  1158. # Eclipse, the contents of the directory containing the HTML and XML files needs
  1159. # to be copied into the plugins directory of eclipse. The name of the directory
  1160. # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
  1161. # After copying Eclipse needs to be restarted before the help appears.
  1162. # The default value is: NO.
  1163. # This tag requires that the tag GENERATE_HTML is set to YES.
  1164. GENERATE_ECLIPSEHELP = NO
  1165. # A unique identifier for the Eclipse help plugin. When installing the plugin
  1166. # the directory name containing the HTML and XML files should also have this
  1167. # name. Each documentation set should have its own identifier.
  1168. # The default value is: org.doxygen.Project.
  1169. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
  1170. ECLIPSE_DOC_ID = org.doxygen.Project
  1171. # If you want full control over the layout of the generated HTML pages it might
  1172. # be necessary to disable the index and replace it with your own. The
  1173. # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
  1174. # of each HTML page. A value of NO enables the index and the value YES disables
  1175. # it. Since the tabs in the index contain the same information as the navigation
  1176. # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
  1177. # The default value is: NO.
  1178. # This tag requires that the tag GENERATE_HTML is set to YES.
  1179. DISABLE_INDEX = NO
  1180. # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  1181. # structure should be generated to display hierarchical information. If the tag
  1182. # value is set to YES, a side panel will be generated containing a tree-like
  1183. # index structure (just like the one that is generated for HTML Help). For this
  1184. # to work a browser that supports JavaScript, DHTML, CSS and frames is required
  1185. # (i.e. any modern browser). Windows users are probably better off using the
  1186. # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
  1187. # further fine-tune the look of the index. As an example, the default style
  1188. # sheet generated by doxygen has an example that shows how to put an image at
  1189. # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
  1190. # the same information as the tab index, you could consider setting
  1191. # DISABLE_INDEX to YES when enabling this option.
  1192. # The default value is: NO.
  1193. # This tag requires that the tag GENERATE_HTML is set to YES.
  1194. GENERATE_TREEVIEW = NO
  1195. # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
  1196. # doxygen will group on one line in the generated HTML documentation.
  1197. #
  1198. # Note that a value of 0 will completely suppress the enum values from appearing
  1199. # in the overview section.
  1200. # Minimum value: 0, maximum value: 20, default value: 4.
  1201. # This tag requires that the tag GENERATE_HTML is set to YES.
  1202. ENUM_VALUES_PER_LINE = 4
  1203. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
  1204. # to set the initial width (in pixels) of the frame in which the tree is shown.
  1205. # Minimum value: 0, maximum value: 1500, default value: 250.
  1206. # This tag requires that the tag GENERATE_HTML is set to YES.
  1207. TREEVIEW_WIDTH = 250
  1208. # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
  1209. # external symbols imported via tag files in a separate window.
  1210. # The default value is: NO.
  1211. # This tag requires that the tag GENERATE_HTML is set to YES.
  1212. EXT_LINKS_IN_WINDOW = NO
  1213. # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
  1214. # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
  1215. # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
  1216. # the HTML output. These images will generally look nicer at scaled resolutions.
  1217. # Possible values are: png (the default) and svg (looks nicer but requires the
  1218. # pdf2svg or inkscape tool).
  1219. # The default value is: png.
  1220. # This tag requires that the tag GENERATE_HTML is set to YES.
  1221. HTML_FORMULA_FORMAT = png
  1222. # Use this tag to change the font size of LaTeX formulas included as images in
  1223. # the HTML documentation. When you change the font size after a successful
  1224. # doxygen run you need to manually remove any form_*.png images from the HTML
  1225. # output directory to force them to be regenerated.
  1226. # Minimum value: 8, maximum value: 50, default value: 10.
  1227. # This tag requires that the tag GENERATE_HTML is set to YES.
  1228. FORMULA_FONTSIZE = 10
  1229. # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
  1230. # generated for formulas are transparent PNGs. Transparent PNGs are not
  1231. # supported properly for IE 6.0, but are supported on all modern browsers.
  1232. #
  1233. # Note that when changing this option you need to delete any form_*.png files in
  1234. # the HTML output directory before the changes have effect.
  1235. # The default value is: YES.
  1236. # This tag requires that the tag GENERATE_HTML is set to YES.
  1237. FORMULA_TRANSPARENT = YES
  1238. # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
  1239. # to create new LaTeX commands to be used in formulas as building blocks. See
  1240. # the section "Including formulas" for details.
  1241. FORMULA_MACROFILE =
  1242. # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
  1243. # https://www.mathjax.org) which uses client side JavaScript for the rendering
  1244. # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
  1245. # installed or if you want to formulas look prettier in the HTML output. When
  1246. # enabled you may also need to install MathJax separately and configure the path
  1247. # to it using the MATHJAX_RELPATH option.
  1248. # The default value is: NO.
  1249. # This tag requires that the tag GENERATE_HTML is set to YES.
  1250. USE_MATHJAX = NO
  1251. # When MathJax is enabled you can set the default output format to be used for
  1252. # the MathJax output. See the MathJax site (see:
  1253. # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
  1254. # Possible values are: HTML-CSS (which is slower, but has the best
  1255. # compatibility), NativeMML (i.e. MathML) and SVG.
  1256. # The default value is: HTML-CSS.
  1257. # This tag requires that the tag USE_MATHJAX is set to YES.
  1258. MATHJAX_FORMAT = HTML-CSS
  1259. # When MathJax is enabled you need to specify the location relative to the HTML
  1260. # output directory using the MATHJAX_RELPATH option. The destination directory
  1261. # should contain the MathJax.js script. For instance, if the mathjax directory
  1262. # is located at the same level as the HTML output directory, then
  1263. # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
  1264. # Content Delivery Network so you can quickly see the result without installing
  1265. # MathJax. However, it is strongly recommended to install a local copy of
  1266. # MathJax from https://www.mathjax.org before deployment.
  1267. # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
  1268. # This tag requires that the tag USE_MATHJAX is set to YES.
  1269. MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
  1270. # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
  1271. # extension names that should be enabled during MathJax rendering. For example
  1272. # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
  1273. # This tag requires that the tag USE_MATHJAX is set to YES.
  1274. MATHJAX_EXTENSIONS =
  1275. # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
  1276. # of code that will be used on startup of the MathJax code. See the MathJax site
  1277. # (see:
  1278. # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
  1279. # example see the documentation.
  1280. # This tag requires that the tag USE_MATHJAX is set to YES.
  1281. MATHJAX_CODEFILE =
  1282. # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
  1283. # the HTML output. The underlying search engine uses javascript and DHTML and
  1284. # should work on any modern browser. Note that when using HTML help
  1285. # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
  1286. # there is already a search function so this one should typically be disabled.
  1287. # For large projects the javascript based search engine can be slow, then
  1288. # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
  1289. # search using the keyboard; to jump to the search box use <access key> + S
  1290. # (what the <access key> is depends on the OS and browser, but it is typically
  1291. # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
  1292. # key> to jump into the search results window, the results can be navigated
  1293. # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
  1294. # the search. The filter options can be selected when the cursor is inside the
  1295. # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
  1296. # to select a filter and <Enter> or <escape> to activate or cancel the filter
  1297. # option.
  1298. # The default value is: YES.
  1299. # This tag requires that the tag GENERATE_HTML is set to YES.
  1300. SEARCHENGINE = YES
  1301. # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  1302. # implemented using a web server instead of a web client using JavaScript. There
  1303. # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
  1304. # setting. When disabled, doxygen will generate a PHP script for searching and
  1305. # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
  1306. # and searching needs to be provided by external tools. See the section
  1307. # "External Indexing and Searching" for details.
  1308. # The default value is: NO.
  1309. # This tag requires that the tag SEARCHENGINE is set to YES.
  1310. SERVER_BASED_SEARCH = NO
  1311. # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
  1312. # script for searching. Instead the search results are written to an XML file
  1313. # which needs to be processed by an external indexer. Doxygen will invoke an
  1314. # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
  1315. # search results.
  1316. #
  1317. # Doxygen ships with an example indexer (doxyindexer) and search engine
  1318. # (doxysearch.cgi) which are based on the open source search engine library
  1319. # Xapian (see:
  1320. # https://xapian.org/).
  1321. #
  1322. # See the section "External Indexing and Searching" for details.
  1323. # The default value is: NO.
  1324. # This tag requires that the tag SEARCHENGINE is set to YES.
  1325. EXTERNAL_SEARCH = NO
  1326. # The SEARCHENGINE_URL should point to a search engine hosted by a web server
  1327. # which will return the search results when EXTERNAL_SEARCH is enabled.
  1328. #
  1329. # Doxygen ships with an example indexer (doxyindexer) and search engine
  1330. # (doxysearch.cgi) which are based on the open source search engine library
  1331. # Xapian (see:
  1332. # https://xapian.org/). See the section "External Indexing and Searching" for
  1333. # details.
  1334. # This tag requires that the tag SEARCHENGINE is set to YES.
  1335. SEARCHENGINE_URL =
  1336. # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
  1337. # search data is written to a file for indexing by an external tool. With the
  1338. # SEARCHDATA_FILE tag the name of this file can be specified.
  1339. # The default file is: searchdata.xml.
  1340. # This tag requires that the tag SEARCHENGINE is set to YES.
  1341. SEARCHDATA_FILE = searchdata.xml
  1342. # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
  1343. # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
  1344. # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
  1345. # projects and redirect the results back to the right project.
  1346. # This tag requires that the tag SEARCHENGINE is set to YES.
  1347. EXTERNAL_SEARCH_ID =
  1348. # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
  1349. # projects other than the one defined by this configuration file, but that are
  1350. # all added to the same external search index. Each project needs to have a
  1351. # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
  1352. # to a relative location where the documentation can be found. The format is:
  1353. # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
  1354. # This tag requires that the tag SEARCHENGINE is set to YES.
  1355. EXTRA_SEARCH_MAPPINGS =
  1356. #---------------------------------------------------------------------------
  1357. # Configuration options related to the LaTeX output
  1358. #---------------------------------------------------------------------------
  1359. # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
  1360. # The default value is: YES.
  1361. GENERATE_LATEX = NO
  1362. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
  1363. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1364. # it.
  1365. # The default directory is: latex.
  1366. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1367. LATEX_OUTPUT = latex
  1368. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  1369. # invoked.
  1370. #
  1371. # Note that when not enabling USE_PDFLATEX the default is latex when enabling
  1372. # USE_PDFLATEX the default is pdflatex and when in the later case latex is
  1373. # chosen this is overwritten by pdflatex. For specific output languages the
  1374. # default can have been set differently, this depends on the implementation of
  1375. # the output language.
  1376. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1377. LATEX_CMD_NAME =
  1378. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
  1379. # index for LaTeX.
  1380. # Note: This tag is used in the Makefile / make.bat.
  1381. # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
  1382. # (.tex).
  1383. # The default file is: makeindex.
  1384. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1385. MAKEINDEX_CMD_NAME = makeindex
  1386. # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
  1387. # generate index for LaTeX. In case there is no backslash (\) as first character
  1388. # it will be automatically added in the LaTeX code.
  1389. # Note: This tag is used in the generated output file (.tex).
  1390. # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
  1391. # The default value is: makeindex.
  1392. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1393. LATEX_MAKEINDEX_CMD = makeindex
  1394. # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
  1395. # documents. This may be useful for small projects and may help to save some
  1396. # trees in general.
  1397. # The default value is: NO.
  1398. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1399. COMPACT_LATEX = NO
  1400. # The PAPER_TYPE tag can be used to set the paper type that is used by the
  1401. # printer.
  1402. # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
  1403. # 14 inches) and executive (7.25 x 10.5 inches).
  1404. # The default value is: a4.
  1405. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1406. PAPER_TYPE = a4
  1407. # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
  1408. # that should be included in the LaTeX output. The package can be specified just
  1409. # by its name or with the correct syntax as to be used with the LaTeX
  1410. # \usepackage command. To get the times font for instance you can specify :
  1411. # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
  1412. # To use the option intlimits with the amsmath package you can specify:
  1413. # EXTRA_PACKAGES=[intlimits]{amsmath}
  1414. # If left blank no extra packages will be included.
  1415. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1416. EXTRA_PACKAGES =
  1417. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
  1418. # generated LaTeX document. The header should contain everything until the first
  1419. # chapter. If it is left blank doxygen will generate a standard header. See
  1420. # section "Doxygen usage" for information on how to let doxygen write the
  1421. # default header to a separate file.
  1422. #
  1423. # Note: Only use a user-defined header if you know what you are doing! The
  1424. # following commands have a special meaning inside the header: $title,
  1425. # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
  1426. # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
  1427. # string, for the replacement values of the other commands the user is referred
  1428. # to HTML_HEADER.
  1429. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1430. LATEX_HEADER =
  1431. # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
  1432. # generated LaTeX document. The footer should contain everything after the last
  1433. # chapter. If it is left blank doxygen will generate a standard footer. See
  1434. # LATEX_HEADER for more information on how to generate a default footer and what
  1435. # special commands can be used inside the footer.
  1436. #
  1437. # Note: Only use a user-defined footer if you know what you are doing!
  1438. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1439. LATEX_FOOTER =
  1440. # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  1441. # LaTeX style sheets that are included after the standard style sheets created
  1442. # by doxygen. Using this option one can overrule certain style aspects. Doxygen
  1443. # will copy the style sheet files to the output directory.
  1444. # Note: The order of the extra style sheet files is of importance (e.g. the last
  1445. # style sheet in the list overrules the setting of the previous ones in the
  1446. # list).
  1447. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1448. LATEX_EXTRA_STYLESHEET =
  1449. # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
  1450. # other source files which should be copied to the LATEX_OUTPUT output
  1451. # directory. Note that the files will be copied as-is; there are no commands or
  1452. # markers available.
  1453. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1454. LATEX_EXTRA_FILES =
  1455. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
  1456. # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
  1457. # contain links (just like the HTML output) instead of page references. This
  1458. # makes the output suitable for online browsing using a PDF viewer.
  1459. # The default value is: YES.
  1460. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1461. PDF_HYPERLINKS = YES
  1462. # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
  1463. # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
  1464. # files. Set this option to YES, to get a higher quality PDF documentation.
  1465. #
  1466. # See also section LATEX_CMD_NAME for selecting the engine.
  1467. # The default value is: YES.
  1468. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1469. USE_PDFLATEX = YES
  1470. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
  1471. # command to the generated LaTeX files. This will instruct LaTeX to keep running
  1472. # if errors occur, instead of asking the user for help. This option is also used
  1473. # when generating formulas in HTML.
  1474. # The default value is: NO.
  1475. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1476. LATEX_BATCHMODE = NO
  1477. # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
  1478. # index chapters (such as File Index, Compound Index, etc.) in the output.
  1479. # The default value is: NO.
  1480. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1481. LATEX_HIDE_INDICES = NO
  1482. # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
  1483. # code with syntax highlighting in the LaTeX output.
  1484. #
  1485. # Note that which sources are shown also depends on other settings such as
  1486. # SOURCE_BROWSER.
  1487. # The default value is: NO.
  1488. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1489. LATEX_SOURCE_CODE = NO
  1490. # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1491. # bibliography, e.g. plainnat, or ieeetr. See
  1492. # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  1493. # The default value is: plain.
  1494. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1495. LATEX_BIB_STYLE = plain
  1496. # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
  1497. # page will contain the date and time when the page was generated. Setting this
  1498. # to NO can help when comparing the output of multiple runs.
  1499. # The default value is: NO.
  1500. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1501. LATEX_TIMESTAMP = NO
  1502. # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
  1503. # path from which the emoji images will be read. If a relative path is entered,
  1504. # it will be relative to the LATEX_OUTPUT directory. If left blank the
  1505. # LATEX_OUTPUT directory will be used.
  1506. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1507. LATEX_EMOJI_DIRECTORY =
  1508. #---------------------------------------------------------------------------
  1509. # Configuration options related to the RTF output
  1510. #---------------------------------------------------------------------------
  1511. # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
  1512. # RTF output is optimized for Word 97 and may not look too pretty with other RTF
  1513. # readers/editors.
  1514. # The default value is: NO.
  1515. GENERATE_RTF = NO
  1516. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
  1517. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1518. # it.
  1519. # The default directory is: rtf.
  1520. # This tag requires that the tag GENERATE_RTF is set to YES.
  1521. RTF_OUTPUT = rtf
  1522. # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
  1523. # documents. This may be useful for small projects and may help to save some
  1524. # trees in general.
  1525. # The default value is: NO.
  1526. # This tag requires that the tag GENERATE_RTF is set to YES.
  1527. COMPACT_RTF = NO
  1528. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
  1529. # contain hyperlink fields. The RTF file will contain links (just like the HTML
  1530. # output) instead of page references. This makes the output suitable for online
  1531. # browsing using Word or some other Word compatible readers that support those
  1532. # fields.
  1533. #
  1534. # Note: WordPad (write) and others do not support links.
  1535. # The default value is: NO.
  1536. # This tag requires that the tag GENERATE_RTF is set to YES.
  1537. RTF_HYPERLINKS = NO
  1538. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  1539. # configuration file, i.e. a series of assignments. You only have to provide
  1540. # replacements, missing definitions are set to their default value.
  1541. #
  1542. # See also section "Doxygen usage" for information on how to generate the
  1543. # default style sheet that doxygen normally uses.
  1544. # This tag requires that the tag GENERATE_RTF is set to YES.
  1545. RTF_STYLESHEET_FILE =
  1546. # Set optional variables used in the generation of an RTF document. Syntax is
  1547. # similar to doxygen's configuration file. A template extensions file can be
  1548. # generated using doxygen -e rtf extensionFile.
  1549. # This tag requires that the tag GENERATE_RTF is set to YES.
  1550. RTF_EXTENSIONS_FILE =
  1551. # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
  1552. # with syntax highlighting in the RTF output.
  1553. #
  1554. # Note that which sources are shown also depends on other settings such as
  1555. # SOURCE_BROWSER.
  1556. # The default value is: NO.
  1557. # This tag requires that the tag GENERATE_RTF is set to YES.
  1558. RTF_SOURCE_CODE = NO
  1559. #---------------------------------------------------------------------------
  1560. # Configuration options related to the man page output
  1561. #---------------------------------------------------------------------------
  1562. # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
  1563. # classes and files.
  1564. # The default value is: NO.
  1565. GENERATE_MAN = NO
  1566. # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
  1567. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1568. # it. A directory man3 will be created inside the directory specified by
  1569. # MAN_OUTPUT.
  1570. # The default directory is: man.
  1571. # This tag requires that the tag GENERATE_MAN is set to YES.
  1572. MAN_OUTPUT = man
  1573. # The MAN_EXTENSION tag determines the extension that is added to the generated
  1574. # man pages. In case the manual section does not start with a number, the number
  1575. # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
  1576. # optional.
  1577. # The default value is: .3.
  1578. # This tag requires that the tag GENERATE_MAN is set to YES.
  1579. MAN_EXTENSION = .3
  1580. # The MAN_SUBDIR tag determines the name of the directory created within
  1581. # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
  1582. # MAN_EXTENSION with the initial . removed.
  1583. # This tag requires that the tag GENERATE_MAN is set to YES.
  1584. MAN_SUBDIR =
  1585. # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
  1586. # will generate one additional man file for each entity documented in the real
  1587. # man page(s). These additional files only source the real man page, but without
  1588. # them the man command would be unable to find the correct page.
  1589. # The default value is: NO.
  1590. # This tag requires that the tag GENERATE_MAN is set to YES.
  1591. MAN_LINKS = NO
  1592. #---------------------------------------------------------------------------
  1593. # Configuration options related to the XML output
  1594. #---------------------------------------------------------------------------
  1595. # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
  1596. # captures the structure of the code including all documentation.
  1597. # The default value is: NO.
  1598. GENERATE_XML = NO
  1599. # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
  1600. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1601. # it.
  1602. # The default directory is: xml.
  1603. # This tag requires that the tag GENERATE_XML is set to YES.
  1604. XML_OUTPUT = xml
  1605. # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
  1606. # listings (including syntax highlighting and cross-referencing information) to
  1607. # the XML output. Note that enabling this will significantly increase the size
  1608. # of the XML output.
  1609. # The default value is: YES.
  1610. # This tag requires that the tag GENERATE_XML is set to YES.
  1611. XML_PROGRAMLISTING = YES
  1612. # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
  1613. # namespace members in file scope as well, matching the HTML output.
  1614. # The default value is: NO.
  1615. # This tag requires that the tag GENERATE_XML is set to YES.
  1616. XML_NS_MEMB_FILE_SCOPE = NO
  1617. #---------------------------------------------------------------------------
  1618. # Configuration options related to the DOCBOOK output
  1619. #---------------------------------------------------------------------------
  1620. # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
  1621. # that can be used to generate PDF.
  1622. # The default value is: NO.
  1623. GENERATE_DOCBOOK = NO
  1624. # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
  1625. # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
  1626. # front of it.
  1627. # The default directory is: docbook.
  1628. # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1629. DOCBOOK_OUTPUT = docbook
  1630. # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
  1631. # program listings (including syntax highlighting and cross-referencing
  1632. # information) to the DOCBOOK output. Note that enabling this will significantly
  1633. # increase the size of the DOCBOOK output.
  1634. # The default value is: NO.
  1635. # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1636. DOCBOOK_PROGRAMLISTING = NO
  1637. #---------------------------------------------------------------------------
  1638. # Configuration options for the AutoGen Definitions output
  1639. #---------------------------------------------------------------------------
  1640. # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
  1641. # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
  1642. # the structure of the code including all documentation. Note that this feature
  1643. # is still experimental and incomplete at the moment.
  1644. # The default value is: NO.
  1645. GENERATE_AUTOGEN_DEF = NO
  1646. #---------------------------------------------------------------------------
  1647. # Configuration options related to the Perl module output
  1648. #---------------------------------------------------------------------------
  1649. # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
  1650. # file that captures the structure of the code including all documentation.
  1651. #
  1652. # Note that this feature is still experimental and incomplete at the moment.
  1653. # The default value is: NO.
  1654. GENERATE_PERLMOD = NO
  1655. # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
  1656. # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
  1657. # output from the Perl module output.
  1658. # The default value is: NO.
  1659. # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1660. PERLMOD_LATEX = NO
  1661. # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
  1662. # formatted so it can be parsed by a human reader. This is useful if you want to
  1663. # understand what is going on. On the other hand, if this tag is set to NO, the
  1664. # size of the Perl module output will be much smaller and Perl will parse it
  1665. # just the same.
  1666. # The default value is: YES.
  1667. # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1668. PERLMOD_PRETTY = YES
  1669. # The names of the make variables in the generated doxyrules.make file are
  1670. # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
  1671. # so different doxyrules.make files included by the same Makefile don't
  1672. # overwrite each other's variables.
  1673. # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1674. PERLMOD_MAKEVAR_PREFIX =
  1675. #---------------------------------------------------------------------------
  1676. # Configuration options related to the preprocessor
  1677. #---------------------------------------------------------------------------
  1678. # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
  1679. # C-preprocessor directives found in the sources and include files.
  1680. # The default value is: YES.
  1681. ENABLE_PREPROCESSING = YES
  1682. # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
  1683. # in the source code. If set to NO, only conditional compilation will be
  1684. # performed. Macro expansion can be done in a controlled way by setting
  1685. # EXPAND_ONLY_PREDEF to YES.
  1686. # The default value is: NO.
  1687. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1688. MACRO_EXPANSION = YES
  1689. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
  1690. # the macro expansion is limited to the macros specified with the PREDEFINED and
  1691. # EXPAND_AS_DEFINED tags.
  1692. # The default value is: NO.
  1693. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1694. EXPAND_ONLY_PREDEF = NO
  1695. # If the SEARCH_INCLUDES tag is set to YES, the include files in the
  1696. # INCLUDE_PATH will be searched if a #include is found.
  1697. # The default value is: YES.
  1698. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1699. SEARCH_INCLUDES = YES
  1700. # The INCLUDE_PATH tag can be used to specify one or more directories that
  1701. # contain include files that are not input files but should be processed by the
  1702. # preprocessor.
  1703. # This tag requires that the tag SEARCH_INCLUDES is set to YES.
  1704. INCLUDE_PATH =
  1705. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  1706. # patterns (like *.h and *.hpp) to filter out the header-files in the
  1707. # directories. If left blank, the patterns specified with FILE_PATTERNS will be
  1708. # used.
  1709. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1710. INCLUDE_FILE_PATTERNS =
  1711. # The PREDEFINED tag can be used to specify one or more macro names that are
  1712. # defined before the preprocessor is started (similar to the -D option of e.g.
  1713. # gcc). The argument of the tag is a list of macros of the form: name or
  1714. # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
  1715. # is assumed. To prevent a macro definition from being undefined via #undef or
  1716. # recursively expanded use the := operator instead of the = operator.
  1717. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1718. PREDEFINED =
  1719. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
  1720. # tag can be used to specify a list of macro names that should be expanded. The
  1721. # macro definition that is found in the sources will be used. Use the PREDEFINED
  1722. # tag if you want to use a different macro definition that overrules the
  1723. # definition found in the source code.
  1724. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1725. EXPAND_AS_DEFINED =
  1726. # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
  1727. # remove all references to function-like macros that are alone on a line, have
  1728. # an all uppercase name, and do not end with a semicolon. Such function macros
  1729. # are typically used for boiler-plate code, and will confuse the parser if not
  1730. # removed.
  1731. # The default value is: YES.
  1732. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1733. SKIP_FUNCTION_MACROS = YES
  1734. #---------------------------------------------------------------------------
  1735. # Configuration options related to external references
  1736. #---------------------------------------------------------------------------
  1737. # The TAGFILES tag can be used to specify one or more tag files. For each tag
  1738. # file the location of the external documentation should be added. The format of
  1739. # a tag file without this location is as follows:
  1740. # TAGFILES = file1 file2 ...
  1741. # Adding location for the tag files is done as follows:
  1742. # TAGFILES = file1=loc1 "file2 = loc2" ...
  1743. # where loc1 and loc2 can be relative or absolute paths or URLs. See the
  1744. # section "Linking to external documentation" for more information about the use
  1745. # of tag files.
  1746. # Note: Each tag file must have a unique name (where the name does NOT include
  1747. # the path). If a tag file is not located in the directory in which doxygen is
  1748. # run, you must also specify the path to the tagfile here.
  1749. TAGFILES =
  1750. # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
  1751. # tag file that is based on the input files it reads. See section "Linking to
  1752. # external documentation" for more information about the usage of tag files.
  1753. GENERATE_TAGFILE =
  1754. # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
  1755. # the class index. If set to NO, only the inherited external classes will be
  1756. # listed.
  1757. # The default value is: NO.
  1758. ALLEXTERNALS = NO
  1759. # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
  1760. # in the modules index. If set to NO, only the current project's groups will be
  1761. # listed.
  1762. # The default value is: YES.
  1763. EXTERNAL_GROUPS = YES
  1764. # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
  1765. # the related pages index. If set to NO, only the current project's pages will
  1766. # be listed.
  1767. # The default value is: YES.
  1768. EXTERNAL_PAGES = YES
  1769. #---------------------------------------------------------------------------
  1770. # Configuration options related to the dot tool
  1771. #---------------------------------------------------------------------------
  1772. # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
  1773. # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
  1774. # NO turns the diagrams off. Note that this option also works with HAVE_DOT
  1775. # disabled, but it is recommended to install and use dot, since it yields more
  1776. # powerful graphs.
  1777. # The default value is: YES.
  1778. CLASS_DIAGRAMS = YES
  1779. # You can include diagrams made with dia in doxygen documentation. Doxygen will
  1780. # then run dia to produce the diagram and insert it in the documentation. The
  1781. # DIA_PATH tag allows you to specify the directory where the dia binary resides.
  1782. # If left empty dia is assumed to be found in the default search path.
  1783. DIA_PATH =
  1784. # If set to YES the inheritance and collaboration graphs will hide inheritance
  1785. # and usage relations if the target is undocumented or is not a class.
  1786. # The default value is: YES.
  1787. HIDE_UNDOC_RELATIONS = YES
  1788. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  1789. # available from the path. This tool is part of Graphviz (see:
  1790. # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
  1791. # Bell Labs. The other options in this section have no effect if this option is
  1792. # set to NO
  1793. # The default value is: YES.
  1794. HAVE_DOT = YES
  1795. # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
  1796. # to run in parallel. When set to 0 doxygen will base this on the number of
  1797. # processors available in the system. You can set it explicitly to a value
  1798. # larger than 0 to get control over the balance between CPU load and processing
  1799. # speed.
  1800. # Minimum value: 0, maximum value: 32, default value: 0.
  1801. # This tag requires that the tag HAVE_DOT is set to YES.
  1802. DOT_NUM_THREADS = 0
  1803. # When you want a differently looking font in the dot files that doxygen
  1804. # generates you can specify the font name using DOT_FONTNAME. You need to make
  1805. # sure dot is able to find the font, which can be done by putting it in a
  1806. # standard location or by setting the DOTFONTPATH environment variable or by
  1807. # setting DOT_FONTPATH to the directory containing the font.
  1808. # The default value is: Helvetica.
  1809. # This tag requires that the tag HAVE_DOT is set to YES.
  1810. DOT_FONTNAME = Helvetica
  1811. # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
  1812. # dot graphs.
  1813. # Minimum value: 4, maximum value: 24, default value: 10.
  1814. # This tag requires that the tag HAVE_DOT is set to YES.
  1815. DOT_FONTSIZE = 10
  1816. # By default doxygen will tell dot to use the default font as specified with
  1817. # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
  1818. # the path where dot can find it using this tag.
  1819. # This tag requires that the tag HAVE_DOT is set to YES.
  1820. DOT_FONTPATH =
  1821. # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
  1822. # each documented class showing the direct and indirect inheritance relations.
  1823. # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
  1824. # The default value is: YES.
  1825. # This tag requires that the tag HAVE_DOT is set to YES.
  1826. CLASS_GRAPH = YES
  1827. # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
  1828. # graph for each documented class showing the direct and indirect implementation
  1829. # dependencies (inheritance, containment, and class references variables) of the
  1830. # class with other documented classes.
  1831. # The default value is: YES.
  1832. # This tag requires that the tag HAVE_DOT is set to YES.
  1833. COLLABORATION_GRAPH = YES
  1834. # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
  1835. # groups, showing the direct groups dependencies.
  1836. # The default value is: YES.
  1837. # This tag requires that the tag HAVE_DOT is set to YES.
  1838. GROUP_GRAPHS = YES
  1839. # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
  1840. # collaboration diagrams in a style similar to the OMG's Unified Modeling
  1841. # Language.
  1842. # The default value is: NO.
  1843. # This tag requires that the tag HAVE_DOT is set to YES.
  1844. UML_LOOK = NO
  1845. # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
  1846. # class node. If there are many fields or methods and many nodes the graph may
  1847. # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
  1848. # number of items for each type to make the size more manageable. Set this to 0
  1849. # for no limit. Note that the threshold may be exceeded by 50% before the limit
  1850. # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
  1851. # but if the number exceeds 15, the total amount of fields shown is limited to
  1852. # 10.
  1853. # Minimum value: 0, maximum value: 100, default value: 10.
  1854. # This tag requires that the tag UML_LOOK is set to YES.
  1855. UML_LIMIT_NUM_FIELDS = 10
  1856. # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
  1857. # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
  1858. # tag is set to YES, doxygen will add type and arguments for attributes and
  1859. # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
  1860. # will not generate fields with class member information in the UML graphs. The
  1861. # class diagrams will look similar to the default class diagrams but using UML
  1862. # notation for the relationships.
  1863. # Possible values are: NO, YES and NONE.
  1864. # The default value is: NO.
  1865. # This tag requires that the tag UML_LOOK is set to YES.
  1866. DOT_UML_DETAILS = NO
  1867. # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
  1868. # to display on a single line. If the actual line length exceeds this threshold
  1869. # significantly it will wrapped across multiple lines. Some heuristics are apply
  1870. # to avoid ugly line breaks.
  1871. # Minimum value: 0, maximum value: 1000, default value: 17.
  1872. # This tag requires that the tag HAVE_DOT is set to YES.
  1873. DOT_WRAP_THRESHOLD = 17
  1874. # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
  1875. # collaboration graphs will show the relations between templates and their
  1876. # instances.
  1877. # The default value is: NO.
  1878. # This tag requires that the tag HAVE_DOT is set to YES.
  1879. TEMPLATE_RELATIONS = NO
  1880. # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
  1881. # YES then doxygen will generate a graph for each documented file showing the
  1882. # direct and indirect include dependencies of the file with other documented
  1883. # files.
  1884. # The default value is: YES.
  1885. # This tag requires that the tag HAVE_DOT is set to YES.
  1886. INCLUDE_GRAPH = YES
  1887. # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
  1888. # set to YES then doxygen will generate a graph for each documented file showing
  1889. # the direct and indirect include dependencies of the file with other documented
  1890. # files.
  1891. # The default value is: YES.
  1892. # This tag requires that the tag HAVE_DOT is set to YES.
  1893. INCLUDED_BY_GRAPH = YES
  1894. # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
  1895. # dependency graph for every global function or class method.
  1896. #
  1897. # Note that enabling this option will significantly increase the time of a run.
  1898. # So in most cases it will be better to enable call graphs for selected
  1899. # functions only using the \callgraph command. Disabling a call graph can be
  1900. # accomplished by means of the command \hidecallgraph.
  1901. # The default value is: NO.
  1902. # This tag requires that the tag HAVE_DOT is set to YES.
  1903. CALL_GRAPH = NO
  1904. # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
  1905. # dependency graph for every global function or class method.
  1906. #
  1907. # Note that enabling this option will significantly increase the time of a run.
  1908. # So in most cases it will be better to enable caller graphs for selected
  1909. # functions only using the \callergraph command. Disabling a caller graph can be
  1910. # accomplished by means of the command \hidecallergraph.
  1911. # The default value is: NO.
  1912. # This tag requires that the tag HAVE_DOT is set to YES.
  1913. CALLER_GRAPH = NO
  1914. # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
  1915. # hierarchy of all classes instead of a textual one.
  1916. # The default value is: YES.
  1917. # This tag requires that the tag HAVE_DOT is set to YES.
  1918. GRAPHICAL_HIERARCHY = YES
  1919. # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
  1920. # dependencies a directory has on other directories in a graphical way. The
  1921. # dependency relations are determined by the #include relations between the
  1922. # files in the directories.
  1923. # The default value is: YES.
  1924. # This tag requires that the tag HAVE_DOT is set to YES.
  1925. DIRECTORY_GRAPH = YES
  1926. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  1927. # generated by dot. For an explanation of the image formats see the section
  1928. # output formats in the documentation of the dot tool (Graphviz (see:
  1929. # http://www.graphviz.org/)).
  1930. # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
  1931. # to make the SVG files visible in IE 9+ (other browsers do not have this
  1932. # requirement).
  1933. # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
  1934. # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
  1935. # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
  1936. # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
  1937. # png:gdiplus:gdiplus.
  1938. # The default value is: png.
  1939. # This tag requires that the tag HAVE_DOT is set to YES.
  1940. DOT_IMAGE_FORMAT = png
  1941. # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  1942. # enable generation of interactive SVG images that allow zooming and panning.
  1943. #
  1944. # Note that this requires a modern browser other than Internet Explorer. Tested
  1945. # and working are Firefox, Chrome, Safari, and Opera.
  1946. # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
  1947. # the SVG files visible. Older versions of IE do not have SVG support.
  1948. # The default value is: NO.
  1949. # This tag requires that the tag HAVE_DOT is set to YES.
  1950. INTERACTIVE_SVG = NO
  1951. # The DOT_PATH tag can be used to specify the path where the dot tool can be
  1952. # found. If left blank, it is assumed the dot tool can be found in the path.
  1953. # This tag requires that the tag HAVE_DOT is set to YES.
  1954. DOT_PATH =
  1955. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  1956. # contain dot files that are included in the documentation (see the \dotfile
  1957. # command).
  1958. # This tag requires that the tag HAVE_DOT is set to YES.
  1959. DOTFILE_DIRS =
  1960. # The MSCFILE_DIRS tag can be used to specify one or more directories that
  1961. # contain msc files that are included in the documentation (see the \mscfile
  1962. # command).
  1963. MSCFILE_DIRS =
  1964. # The DIAFILE_DIRS tag can be used to specify one or more directories that
  1965. # contain dia files that are included in the documentation (see the \diafile
  1966. # command).
  1967. DIAFILE_DIRS =
  1968. # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
  1969. # path where java can find the plantuml.jar file. If left blank, it is assumed
  1970. # PlantUML is not used or called during a preprocessing step. Doxygen will
  1971. # generate a warning when it encounters a \startuml command in this case and
  1972. # will not generate output for the diagram.
  1973. PLANTUML_JAR_PATH =
  1974. # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
  1975. # configuration file for plantuml.
  1976. PLANTUML_CFG_FILE =
  1977. # When using plantuml, the specified paths are searched for files specified by
  1978. # the !include statement in a plantuml block.
  1979. PLANTUML_INCLUDE_PATH =
  1980. # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
  1981. # that will be shown in the graph. If the number of nodes in a graph becomes
  1982. # larger than this value, doxygen will truncate the graph, which is visualized
  1983. # by representing a node as a red box. Note that doxygen if the number of direct
  1984. # children of the root node in a graph is already larger than
  1985. # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
  1986. # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  1987. # Minimum value: 0, maximum value: 10000, default value: 50.
  1988. # This tag requires that the tag HAVE_DOT is set to YES.
  1989. DOT_GRAPH_MAX_NODES = 50
  1990. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
  1991. # generated by dot. A depth value of 3 means that only nodes reachable from the
  1992. # root by following a path via at most 3 edges will be shown. Nodes that lay
  1993. # further from the root node will be omitted. Note that setting this option to 1
  1994. # or 2 may greatly reduce the computation time needed for large code bases. Also
  1995. # note that the size of a graph can be further restricted by
  1996. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  1997. # Minimum value: 0, maximum value: 1000, default value: 0.
  1998. # This tag requires that the tag HAVE_DOT is set to YES.
  1999. MAX_DOT_GRAPH_DEPTH = 0
  2000. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  2001. # background. This is disabled by default, because dot on Windows does not seem
  2002. # to support this out of the box.
  2003. #
  2004. # Warning: Depending on the platform used, enabling this option may lead to
  2005. # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  2006. # read).
  2007. # The default value is: NO.
  2008. # This tag requires that the tag HAVE_DOT is set to YES.
  2009. DOT_TRANSPARENT = NO
  2010. # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
  2011. # files in one run (i.e. multiple -o and -T options on the command line). This
  2012. # makes dot run faster, but since only newer versions of dot (>1.8.10) support
  2013. # this, this feature is disabled by default.
  2014. # The default value is: NO.
  2015. # This tag requires that the tag HAVE_DOT is set to YES.
  2016. DOT_MULTI_TARGETS = NO
  2017. # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
  2018. # explaining the meaning of the various boxes and arrows in the dot generated
  2019. # graphs.
  2020. # The default value is: YES.
  2021. # This tag requires that the tag HAVE_DOT is set to YES.
  2022. GENERATE_LEGEND = YES
  2023. # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
  2024. # files that are used to generate the various graphs.
  2025. #
  2026. # Note: This setting is not only used for dot files but also for msc and
  2027. # plantuml temporary files.
  2028. # The default value is: YES.
  2029. DOT_CLEANUP = YES