PCSX2 IPC API Reference implementation
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.
 
 
 
 
 
 

2551 lines
108 KiB

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