/Tools/Documentation/Cappuccino.doxygen

http://github.com/cacaodev/cappuccino · Unknown · 2353 lines · 1825 code · 528 blank · 0 comment · 0 complexity · 79d888f4fedafdfff08504e66287477a MD5 · raw file

Large files are truncated click here to view the full file

  1. # Doxyfile 1.8.7
  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 config file
  18. # that follow. The default is UTF-8 which is also the encoding used for all text
  19. # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
  20. # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
  21. # 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 = " API"
  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 = 0.9.7-1
  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 an logo or icon that is included in
  39. # the documentation. The maximum height of the logo should not exceed 55 pixels
  40. # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
  41. # to the output directory.
  42. PROJECT_LOGO = ./Tools/Documentation/logo.png
  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 = Documentation
  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. # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
  76. # descriptions after the members that are listed in the file and class
  77. # documentation (similar to Javadoc). Set to NO to disable this.
  78. # The default value is: YES.
  79. BRIEF_MEMBER_DESC = YES
  80. # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
  81. # description of a member or function before the detailed description
  82. #
  83. # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  84. # brief descriptions will be completely suppressed.
  85. # The default value is: YES.
  86. REPEAT_BRIEF = YES
  87. # This tag implements a quasi-intelligent brief description abbreviator that is
  88. # used to form the text in various listings. Each string in this list, if found
  89. # as the leading text of the brief description, will be stripped from the text
  90. # and the result, after processing the whole list, is used as the annotated
  91. # text. Otherwise, the brief description is used as-is. If left blank, the
  92. # following values are used ($name is automatically replaced with the name of
  93. # the entity):The $name class, The $name widget, The $name file, is, provides,
  94. # specifies, contains, represents, a, an and the.
  95. ABBREVIATE_BRIEF = "The $name class" \
  96. "The $name widget" \
  97. "The $name file" \
  98. is \
  99. provides \
  100. specifies \
  101. contains \
  102. represents \
  103. a \
  104. an \
  105. the
  106. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  107. # doxygen will generate a detailed section even if there is only a brief
  108. # description.
  109. # The default value is: NO.
  110. ALWAYS_DETAILED_SEC = NO
  111. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  112. # inherited members of a class in the documentation of that class as if those
  113. # members were ordinary class members. Constructors, destructors and assignment
  114. # operators of the base classes will not be shown.
  115. # The default value is: NO.
  116. INLINE_INHERITED_MEMB = NO
  117. # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
  118. # before files name in the file list and in the header files. If set to NO the
  119. # shortest path that makes the file name unique will be used
  120. # The default value is: YES.
  121. FULL_PATH_NAMES = YES
  122. # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
  123. # Stripping is only done if one of the specified strings matches the left-hand
  124. # part of the path. The tag can be used to show relative paths in the file list.
  125. # If left blank the directory from which doxygen is run is used as the path to
  126. # strip.
  127. #
  128. # Note that you can specify absolute paths here, but also relative paths, which
  129. # will be relative from the directory where doxygen is started.
  130. # This tag requires that the tag FULL_PATH_NAMES is set to YES.
  131. STRIP_FROM_PATH =
  132. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
  133. # path mentioned in the documentation of a class, which tells the reader which
  134. # header file to include in order to use a class. If left blank only the name of
  135. # the header file containing the class definition is used. Otherwise one should
  136. # specify the list of include paths that are normally passed to the compiler
  137. # using the -I flag.
  138. STRIP_FROM_INC_PATH =
  139. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
  140. # less readable) file names. This can be useful is your file systems doesn't
  141. # support long names like on DOS, Mac, or CD-ROM.
  142. # The default value is: NO.
  143. SHORT_NAMES = NO
  144. # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
  145. # first line (until the first dot) of a Javadoc-style comment as the brief
  146. # description. If set to NO, the Javadoc-style will behave just like regular Qt-
  147. # style comments (thus requiring an explicit @brief command for a brief
  148. # description.)
  149. # The default value is: NO.
  150. JAVADOC_AUTOBRIEF = NO
  151. # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
  152. # line (until the first dot) of a Qt-style comment as the brief description. If
  153. # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
  154. # requiring an explicit \brief command for a brief description.)
  155. # The default value is: NO.
  156. QT_AUTOBRIEF = NO
  157. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
  158. # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
  159. # a brief description. This used to be the default behavior. The new default is
  160. # to treat a multi-line C++ comment block as a detailed description. Set this
  161. # tag to YES if you prefer the old behavior instead.
  162. #
  163. # Note that setting this tag to YES also means that rational rose comments are
  164. # not recognized any more.
  165. # The default value is: NO.
  166. MULTILINE_CPP_IS_BRIEF = NO
  167. # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
  168. # documentation from any documented member that it re-implements.
  169. # The default value is: YES.
  170. INHERIT_DOCS = YES
  171. # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
  172. # new page for each member. If set to NO, the documentation of a member will be
  173. # part of the file/class/namespace that contains it.
  174. # The default value is: NO.
  175. SEPARATE_MEMBER_PAGES = NO
  176. # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
  177. # uses this value to replace tabs by spaces in code fragments.
  178. # Minimum value: 1, maximum value: 16, default value: 4.
  179. TAB_SIZE = 8
  180. # This tag can be used to specify a number of aliases that act as commands in
  181. # the documentation. An alias has the form:
  182. # name=value
  183. # For example adding
  184. # "sideeffect=@par Side Effects:\n"
  185. # will allow you to put the command \sideeffect (or @sideeffect) in the
  186. # documentation, which will result in a user-defined paragraph with heading
  187. # "Side Effects:". You can put \n's in the value part of an alias to insert
  188. # newlines.
  189. ALIASES =
  190. # This tag can be used to specify a number of word-keyword mappings (TCL only).
  191. # A mapping has the form "name=value". For example adding "class=itcl::class"
  192. # will allow you to use the command class in the itcl::class meaning.
  193. TCL_SUBST =
  194. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  195. # only. Doxygen will then generate output that is more tailored for C. For
  196. # instance, some of the names that are used will be different. The list of all
  197. # members will be omitted, etc.
  198. # The default value is: NO.
  199. OPTIMIZE_OUTPUT_FOR_C = NO
  200. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
  201. # Python sources only. Doxygen will then generate output that is more tailored
  202. # for that language. For instance, namespaces will be presented as packages,
  203. # qualified scopes will look different, etc.
  204. # The default value is: NO.
  205. OPTIMIZE_OUTPUT_JAVA = NO
  206. # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  207. # sources. Doxygen will then generate output that is tailored for Fortran.
  208. # The default value is: NO.
  209. OPTIMIZE_FOR_FORTRAN = NO
  210. # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  211. # sources. Doxygen will then generate output that is tailored for VHDL.
  212. # The default value is: NO.
  213. OPTIMIZE_OUTPUT_VHDL = NO
  214. # Doxygen selects the parser to use depending on the extension of the files it
  215. # parses. With this tag you can assign which parser to use for a given
  216. # extension. Doxygen has a built-in mapping, but you can override or extend it
  217. # using this tag. The format is ext=language, where ext is a file extension, and
  218. # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
  219. # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
  220. # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
  221. # Fortran. In the later case the parser tries to guess whether the code is fixed
  222. # or free formatted code, this is the default for Fortran type files), VHDL. For
  223. # instance to make doxygen treat .inc files as Fortran files (default is PHP),
  224. # and .f files as C (default is Fortran), use: inc=Fortran f=C.
  225. #
  226. # Note For files without extension you can use no_extension as a placeholder.
  227. #
  228. # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
  229. # the files are not read by doxygen.
  230. EXTENSION_MAPPING = j=Objective-C
  231. # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
  232. # according to the Markdown format, which allows for more readable
  233. # documentation. See http://daringfireball.net/projects/markdown/ for details.
  234. # The output of markdown processing is further processed by doxygen, so you can
  235. # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
  236. # case of backward compatibilities issues.
  237. # The default value is: YES.
  238. MARKDOWN_SUPPORT = YES
  239. # When enabled doxygen tries to link words that correspond to documented
  240. # classes, or namespaces to their corresponding documentation. Such a link can
  241. # be prevented in individual cases by by putting a % sign in front of the word
  242. # or globally by setting AUTOLINK_SUPPORT to NO.
  243. # The default value is: YES.
  244. AUTOLINK_SUPPORT = YES
  245. # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  246. # to include (a tag file for) the STL sources as input, then you should set this
  247. # tag to YES in order to let doxygen match functions declarations and
  248. # definitions whose arguments contain STL classes (e.g. func(std::string);
  249. # versus func(std::string) {}). This also make the inheritance and collaboration
  250. # diagrams that involve STL classes more complete and accurate.
  251. # The default value is: NO.
  252. BUILTIN_STL_SUPPORT = NO
  253. # If you use Microsoft's C++/CLI language, you should set this option to YES to
  254. # enable parsing support.
  255. # The default value is: NO.
  256. CPP_CLI_SUPPORT = NO
  257. # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
  258. # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
  259. # will parse them like normal C++ but will assume all classes use public instead
  260. # of private inheritance when no explicit protection keyword is present.
  261. # The default value is: NO.
  262. SIP_SUPPORT = NO
  263. # For Microsoft's IDL there are propget and propput attributes to indicate
  264. # getter and setter methods for a property. Setting this option to YES will make
  265. # doxygen to replace the get and set methods by a property in the documentation.
  266. # This will only work if the methods are indeed getting or setting a simple
  267. # type. If this is not the case, or you want to show the methods anyway, you
  268. # should set this option to NO.
  269. # The default value is: YES.
  270. IDL_PROPERTY_SUPPORT = NO
  271. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  272. # tag is set to YES, then doxygen will reuse the documentation of the first
  273. # member in the group (if any) for the other members of the group. By default
  274. # all members of a group must be documented explicitly.
  275. # The default value is: NO.
  276. DISTRIBUTE_GROUP_DOC = NO
  277. # Set the SUBGROUPING tag to YES to allow class member groups of the same type
  278. # (for instance a group of public functions) to be put as a subgroup of that
  279. # type (e.g. under the Public Functions section). Set it to NO to prevent
  280. # subgrouping. Alternatively, this can be done per class using the
  281. # \nosubgrouping command.
  282. # The default value is: YES.
  283. SUBGROUPING = YES
  284. # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
  285. # are shown inside the group in which they are included (e.g. using \ingroup)
  286. # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
  287. # and RTF).
  288. #
  289. # Note that this feature does not work in combination with
  290. # SEPARATE_MEMBER_PAGES.
  291. # The default value is: NO.
  292. INLINE_GROUPED_CLASSES = NO
  293. # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
  294. # with only public data fields or simple typedef fields will be shown inline in
  295. # the documentation of the scope in which they are defined (i.e. file,
  296. # namespace, or group documentation), provided this scope is documented. If set
  297. # to NO, structs, classes, and unions are shown on a separate page (for HTML and
  298. # Man pages) or section (for LaTeX and RTF).
  299. # The default value is: NO.
  300. INLINE_SIMPLE_STRUCTS = NO
  301. # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
  302. # enum is documented as struct, union, or enum with the name of the typedef. So
  303. # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  304. # with name TypeT. When disabled the typedef will appear as a member of a file,
  305. # namespace, or class. And the struct will be named TypeS. This can typically be
  306. # useful for C code in case the coding convention dictates that all compound
  307. # types are typedef'ed and only the typedef is referenced, never the tag name.
  308. # The default value is: NO.
  309. TYPEDEF_HIDES_STRUCT = NO
  310. # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
  311. # cache is used to resolve symbols given their name and scope. Since this can be
  312. # an expensive process and often the same symbol appears multiple times in the
  313. # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
  314. # doxygen will become slower. If the cache is too large, memory is wasted. The
  315. # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
  316. # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
  317. # symbols. At the end of a run doxygen will report the cache usage and suggest
  318. # the optimal cache size from a speed point of view.
  319. # Minimum value: 0, maximum value: 9, default value: 0.
  320. LOOKUP_CACHE_SIZE = 0
  321. #---------------------------------------------------------------------------
  322. # Build related configuration options
  323. #---------------------------------------------------------------------------
  324. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  325. # documentation are documented, even if no documentation was available. Private
  326. # class members and static file members will be hidden unless the
  327. # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
  328. # Note: This will also disable the warnings about undocumented members that are
  329. # normally produced when WARNINGS is set to YES.
  330. # The default value is: NO.
  331. EXTRACT_ALL = YES
  332. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
  333. # be included in the documentation.
  334. # The default value is: NO.
  335. EXTRACT_PRIVATE = YES
  336. # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
  337. # scope will be included in the documentation.
  338. # The default value is: NO.
  339. EXTRACT_PACKAGE = NO
  340. # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
  341. # included in the documentation.
  342. # The default value is: NO.
  343. EXTRACT_STATIC = YES
  344. # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
  345. # locally in source files will be included in the documentation. If set to NO
  346. # only classes defined in header files are included. Does not have any effect
  347. # for Java sources.
  348. # The default value is: YES.
  349. EXTRACT_LOCAL_CLASSES = YES
  350. # This flag is only useful for Objective-C code. When set to YES local methods,
  351. # which are defined in the implementation section but not in the interface are
  352. # included in the documentation. If set to NO only methods in the interface are
  353. # included.
  354. # The default value is: NO.
  355. EXTRACT_LOCAL_METHODS = YES
  356. # If this flag is set to YES, the members of anonymous namespaces will be
  357. # extracted and appear in the documentation as a namespace called
  358. # 'anonymous_namespace{file}', where file will be replaced with the base name of
  359. # the file that contains the anonymous namespace. By default anonymous namespace
  360. # are hidden.
  361. # The default value is: NO.
  362. EXTRACT_ANON_NSPACES = NO
  363. # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
  364. # undocumented members inside documented classes or files. If set to NO these
  365. # members will be included in the various overviews, but no documentation
  366. # section is generated. This option has no effect if EXTRACT_ALL is enabled.
  367. # The default value is: NO.
  368. HIDE_UNDOC_MEMBERS = NO
  369. # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
  370. # undocumented classes that are normally visible in the class hierarchy. If set
  371. # to NO these classes will be included in the various overviews. This option has
  372. # no effect if EXTRACT_ALL is enabled.
  373. # The default value is: NO.
  374. HIDE_UNDOC_CLASSES = NO
  375. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
  376. # (class|struct|union) declarations. If set to NO these declarations will be
  377. # included in the documentation.
  378. # The default value is: NO.
  379. HIDE_FRIEND_COMPOUNDS = NO
  380. # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
  381. # documentation blocks found inside the body of a function. If set to NO these
  382. # blocks will be appended to the function's detailed documentation block.
  383. # The default value is: NO.
  384. HIDE_IN_BODY_DOCS = NO
  385. # The INTERNAL_DOCS tag determines if documentation that is typed after a
  386. # \internal command is included. If the tag is set to NO then the documentation
  387. # will be excluded. Set it to YES to include the internal documentation.
  388. # The default value is: NO.
  389. INTERNAL_DOCS = NO
  390. # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
  391. # names in lower-case letters. If set to YES upper-case letters are also
  392. # allowed. This is useful if you have classes or files whose names only differ
  393. # in case and if your file system supports case sensitive file names. Windows
  394. # and Mac users are advised to set this option to NO.
  395. # The default value is: system dependent.
  396. CASE_SENSE_NAMES = NO
  397. # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
  398. # their full class and namespace scopes in the documentation. If set to YES the
  399. # scope will be hidden.
  400. # The default value is: NO.
  401. HIDE_SCOPE_NAMES = NO
  402. # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
  403. # the files that are included by a file in the documentation of that file.
  404. # The default value is: YES.
  405. SHOW_INCLUDE_FILES = YES
  406. # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
  407. # grouped member an include statement to the documentation, telling the reader
  408. # which file to include in order to use the member.
  409. # The default value is: NO.
  410. SHOW_GROUPED_MEMB_INC = NO
  411. # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
  412. # files with double quotes in the documentation rather than with sharp brackets.
  413. # The default value is: NO.
  414. FORCE_LOCAL_INCLUDES = NO
  415. # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
  416. # documentation for inline members.
  417. # The default value is: YES.
  418. INLINE_INFO = YES
  419. # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
  420. # (detailed) documentation of file and class members alphabetically by member
  421. # name. If set to NO the members will appear in declaration order.
  422. # The default value is: YES.
  423. SORT_MEMBER_DOCS = YES
  424. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
  425. # descriptions of file, namespace and class members alphabetically by member
  426. # name. If set to NO the members will appear in declaration order. Note that
  427. # this will also influence the order of the classes in the class list.
  428. # The default value is: NO.
  429. SORT_BRIEF_DOCS = YES
  430. # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
  431. # (brief and detailed) documentation of class members so that constructors and
  432. # destructors are listed first. If set to NO the constructors will appear in the
  433. # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
  434. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
  435. # member documentation.
  436. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
  437. # detailed member documentation.
  438. # The default value is: NO.
  439. SORT_MEMBERS_CTORS_1ST = NO
  440. # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
  441. # of group names into alphabetical order. If set to NO the group names will
  442. # appear in their defined order.
  443. # The default value is: NO.
  444. SORT_GROUP_NAMES = YES
  445. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
  446. # fully-qualified names, including namespaces. If set to NO, the class list will
  447. # be sorted only by class name, not including the namespace part.
  448. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  449. # Note: This option applies only to the class list, not to the alphabetical
  450. # list.
  451. # The default value is: NO.
  452. SORT_BY_SCOPE_NAME = NO
  453. # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
  454. # type resolution of all parameters of a function it will reject a match between
  455. # the prototype and the implementation of a member function even if there is
  456. # only one candidate or it is obvious which candidate to choose by doing a
  457. # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
  458. # accept a match between prototype and implementation in such cases.
  459. # The default value is: NO.
  460. STRICT_PROTO_MATCHING = NO
  461. # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
  462. # todo list. This list is created by putting \todo commands in the
  463. # documentation.
  464. # The default value is: YES.
  465. GENERATE_TODOLIST = NO
  466. # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
  467. # test list. This list is created by putting \test commands in the
  468. # documentation.
  469. # The default value is: YES.
  470. GENERATE_TESTLIST = NO
  471. # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
  472. # list. This list is created by putting \bug commands in the documentation.
  473. # The default value is: YES.
  474. GENERATE_BUGLIST = NO
  475. # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
  476. # the deprecated list. This list is created by putting \deprecated commands in
  477. # the documentation.
  478. # The default value is: YES.
  479. GENERATE_DEPRECATEDLIST= YES
  480. # The ENABLED_SECTIONS tag can be used to enable conditional documentation
  481. # sections, marked by \if <section_label> ... \endif and \cond <section_label>
  482. # ... \endcond blocks.
  483. ENABLED_SECTIONS =
  484. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
  485. # initial value of a variable or macro / define can have for it to appear in the
  486. # documentation. If the initializer consists of more lines than specified here
  487. # it will be hidden. Use a value of 0 to hide initializers completely. The
  488. # appearance of the value of individual variables and macros / defines can be
  489. # controlled using \showinitializer or \hideinitializer command in the
  490. # documentation regardless of this setting.
  491. # Minimum value: 0, maximum value: 10000, default value: 30.
  492. MAX_INITIALIZER_LINES = 30
  493. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
  494. # the bottom of the documentation of classes and structs. If set to YES the list
  495. # will mention the files that were used to generate the documentation.
  496. # The default value is: YES.
  497. SHOW_USED_FILES = YES
  498. # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
  499. # will remove the Files entry from the Quick Index and from the Folder Tree View
  500. # (if specified).
  501. # The default value is: YES.
  502. SHOW_FILES = YES
  503. # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
  504. # page. This will remove the Namespaces entry from the Quick Index and from the
  505. # Folder Tree View (if specified).
  506. # The default value is: YES.
  507. SHOW_NAMESPACES = YES
  508. # The FILE_VERSION_FILTER tag can be used to specify a program or script that
  509. # doxygen should invoke to get the current version for each file (typically from
  510. # the version control system). Doxygen will invoke the program by executing (via
  511. # popen()) the command command input-file, where command is the value of the
  512. # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
  513. # by doxygen. Whatever the program writes to standard output is used as the file
  514. # version. For an example see the documentation.
  515. FILE_VERSION_FILTER =
  516. # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  517. # by doxygen. The layout file controls the global structure of the generated
  518. # output files in an output format independent way. To create the layout file
  519. # that represents doxygen's defaults, run doxygen with the -l option. You can
  520. # optionally specify a file name after the option, if omitted DoxygenLayout.xml
  521. # will be used as the name of the layout file.
  522. #
  523. # Note that if you run doxygen from a directory containing a file called
  524. # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
  525. # tag is left empty.
  526. LAYOUT_FILE =
  527. # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
  528. # the reference definitions. This must be a list of .bib files. The .bib
  529. # extension is automatically appended if omitted. This requires the bibtex tool
  530. # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
  531. # For LaTeX the style of the bibliography can be controlled using
  532. # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
  533. # search path. Do not use file names with spaces, bibtex cannot handle them. See
  534. # also \cite for info how to create references.
  535. CITE_BIB_FILES =
  536. #---------------------------------------------------------------------------
  537. # Configuration options related to warning and progress messages
  538. #---------------------------------------------------------------------------
  539. # The QUIET tag can be used to turn on/off the messages that are generated to
  540. # standard output by doxygen. If QUIET is set to YES this implies that the
  541. # messages are off.
  542. # The default value is: NO.
  543. QUIET = NO
  544. # The WARNINGS tag can be used to turn on/off the warning messages that are
  545. # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
  546. # this implies that the warnings are on.
  547. #
  548. # Tip: Turn warnings on while writing the documentation.
  549. # The default value is: YES.
  550. WARNINGS = YES
  551. # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
  552. # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
  553. # will automatically be disabled.
  554. # The default value is: YES.
  555. WARN_IF_UNDOCUMENTED = NO
  556. # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
  557. # potential errors in the documentation, such as not documenting some parameters
  558. # in a documented function, or documenting parameters that don't exist or using
  559. # markup commands wrongly.
  560. # The default value is: YES.
  561. WARN_IF_DOC_ERROR = NO
  562. # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
  563. # are documented, but have no documentation for their parameters or return
  564. # value. If set to NO doxygen will only warn about wrong or incomplete parameter
  565. # documentation, but not about the absence of documentation.
  566. # The default value is: NO.
  567. WARN_NO_PARAMDOC = NO
  568. # The WARN_FORMAT tag determines the format of the warning messages that doxygen
  569. # can produce. The string should contain the $file, $line, and $text tags, which
  570. # will be replaced by the file and line number from which the warning originated
  571. # and the warning text. Optionally the format may contain $version, which will
  572. # be replaced by the version of the file (if it could be obtained via
  573. # FILE_VERSION_FILTER)
  574. # The default value is: $file:$line: $text.
  575. WARN_FORMAT = "$file:$line: $text"
  576. # The WARN_LOGFILE tag can be used to specify a file to which warning and error
  577. # messages should be written. If left blank the output is written to standard
  578. # error (stderr).
  579. WARN_LOGFILE = debug.txt
  580. #---------------------------------------------------------------------------
  581. # Configuration options related to the input files
  582. #---------------------------------------------------------------------------
  583. # The INPUT tag is used to specify the files and/or directories that contain
  584. # documented source files. You may enter file names like myfile.cpp or
  585. # directories like /usr/src/myproject. Separate the files or directories with
  586. # spaces.
  587. # Note: If this tag is empty the current directory is searched.
  588. INPUT = AppKit.doc \
  589. Foundation.doc
  590. # This tag can be used to specify the character encoding of the source files
  591. # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
  592. # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
  593. # documentation (see: http://www.gnu.org/software/libiconv) for the list of
  594. # possible encodings.
  595. # The default value is: UTF-8.
  596. INPUT_ENCODING = UTF-8
  597. # If the value of the INPUT tag contains directories, you can use the
  598. # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
  599. # *.h) to filter out the source-files in the directories. If left blank the
  600. # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
  601. # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
  602. # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
  603. # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
  604. # *.qsf, *.as and *.js.
  605. FILE_PATTERNS = *.c \
  606. *.cc \
  607. *.cxx \
  608. *.cpp \
  609. *.c++ \
  610. *.d \
  611. *.java \
  612. *.ii \
  613. *.ixx \
  614. *.ipp \
  615. *.i++ \
  616. *.inl \
  617. *.h \
  618. *.hh \
  619. *.hxx \
  620. *.hpp \
  621. *.h++ \
  622. *.idl \
  623. *.odl \
  624. *.cs \
  625. *.php \
  626. *.php3 \
  627. *.inc \
  628. *.m \
  629. *.mm \
  630. *.dox \
  631. *.py \
  632. *.f90 \
  633. *.f \
  634. *.vhd \
  635. *.vhdl \
  636. *.j
  637. # The RECURSIVE tag can be used to specify whether or not subdirectories should
  638. # be searched for input files as well.
  639. # The default value is: NO.
  640. RECURSIVE = YES
  641. # The EXCLUDE tag can be used to specify files and/or directories that should be
  642. # excluded from the INPUT source files. This way you can easily exclude a
  643. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  644. #
  645. # Note that relative paths are relative to the directory from which doxygen is
  646. # run.
  647. EXCLUDE =
  648. # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
  649. # directories that are symbolic links (a Unix file system feature) are excluded
  650. # from the input.
  651. # The default value is: NO.
  652. EXCLUDE_SYMLINKS = NO
  653. # If the value of the INPUT tag contains directories, you can use the
  654. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  655. # certain files from those directories.
  656. #
  657. # Note that the wildcards are matched against the file with absolute path, so to
  658. # exclude all test directories for example use the pattern */test/*
  659. EXCLUDE_PATTERNS = _*
  660. # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  661. # (namespaces, classes, functions, etc.) that should be excluded from the
  662. # output. The symbol name can be a fully qualified name, a word, or if the
  663. # wildcard * is used, a substring. Examples: ANamespace, AClass,
  664. # AClass::ANamespace, ANamespace::*Test
  665. #
  666. # Note that the wildcards are matched against the file with absolute path, so to
  667. # exclude all test directories use the pattern */test/*
  668. EXCLUDE_SYMBOLS = _*
  669. # The EXAMPLE_PATH tag can be used to specify one or more files or directories
  670. # that contain example code fragments that are included (see the \include
  671. # command).
  672. EXAMPLE_PATH = ./Tools/Documentation/README.html \
  673. ./LICENSE
  674. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  675. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
  676. # *.h) to filter out the source-files in the directories. If left blank all
  677. # files are included.
  678. EXAMPLE_PATTERNS = *
  679. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  680. # searched for input files to be used with the \include or \dontinclude commands
  681. # irrespective of the value of the RECURSIVE tag.
  682. # The default value is: NO.
  683. EXAMPLE_RECURSIVE = NO
  684. # The IMAGE_PATH tag can be used to specify one or more files or directories
  685. # that contain images that are to be included in the documentation (see the
  686. # \image command).
  687. IMAGE_PATH =
  688. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  689. # invoke to filter for each input file. Doxygen will invoke the filter program
  690. # by executing (via popen()) the command:
  691. #
  692. # <filter> <input-file>
  693. #
  694. # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
  695. # name of an input file. Doxygen will then use the output that the filter
  696. # program writes to standard output. If FILTER_PATTERNS is specified, this tag
  697. # will be ignored.
  698. #
  699. # Note that the filter must not add or remove lines; it is applied before the
  700. # code is scanned, but not when the output code is generated. If lines are added
  701. # or removed, the anchors will not be placed correctly.
  702. INPUT_FILTER =
  703. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  704. # basis. Doxygen will compare the file name with each pattern and apply the
  705. # filter if there is a match. The filters are a list of the form: pattern=filter
  706. # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
  707. # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
  708. # patterns match the file name, INPUT_FILTER is applied.
  709. FILTER_PATTERNS =
  710. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  711. # INPUT_FILTER ) will also be used to filter the input files that are used for
  712. # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
  713. # The default value is: NO.
  714. FILTER_SOURCE_FILES = NO
  715. # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  716. # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
  717. # it is also possible to disable source filtering for a specific pattern using
  718. # *.ext= (so without naming a filter).
  719. # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
  720. FILTER_SOURCE_PATTERNS =
  721. # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
  722. # is part of the input, its contents will be placed on the main page
  723. # (index.html). This can be useful if you have a project on for instance GitHub
  724. # and want to reuse the introduction page also for the doxygen output.
  725. USE_MDFILE_AS_MAINPAGE =
  726. #---------------------------------------------------------------------------
  727. # Configuration options related to source browsing
  728. #---------------------------------------------------------------------------
  729. # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
  730. # generated. Documented entities will be cross-referenced with these sources.
  731. #
  732. # Note: To get rid of all source code in the generated output, make sure that
  733. # also VERBATIM_HEADERS is set to NO.
  734. # The default value is: NO.
  735. SOURCE_BROWSER = YES
  736. # Setting the INLINE_SOURCES tag to YES will include the body of functions,
  737. # classes and enums directly into the documentation.
  738. # The default value is: NO.
  739. INLINE_SOURCES = NO
  740. # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
  741. # special comment blocks from generated source code fragments. Normal C, C++ and
  742. # Fortran comments will always remain visible.
  743. # The default value is: YES.
  744. STRIP_CODE_COMMENTS = YES
  745. # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
  746. # function all documented functions referencing it will be listed.
  747. # The default value is: NO.
  748. REFERENCED_BY_RELATION = NO
  749. # If the REFERENCES_RELATION tag is set to YES then for each documented function
  750. # all documented entities called/used by that function will be listed.
  751. # The default value is: NO.
  752. REFERENCES_RELATION = NO
  753. # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
  754. # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
  755. # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
  756. # link to the documentation.
  757. # The default value is: YES.
  758. REFERENCES_LINK_SOURCE = YES
  759. # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
  760. # source code will show a tooltip with additional information such as prototype,
  761. # brief description and links to the definition and documentation. Since this
  762. # will make the HTML file larger and loading of large files a bit slower, you
  763. # can opt to disable this feature.
  764. # The default value is: YES.
  765. # This tag requires that the tag SOURCE_BROWSER is set to YES.
  766. SOURCE_TOOLTIPS = YES
  767. # If the USE_HTAGS tag is set to YES then the references to source code will
  768. # point to the HTML generated by the htags(1) tool instead of doxygen built-in
  769. # source browser. The htags tool is part of GNU's global source tagging system
  770. # (see http://www.gnu.org/software/global/global.html). You will need version
  771. # 4.8.6 or higher.
  772. #
  773. # To use it do the following:
  774. # - Install the latest version of global
  775. # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
  776. # - Make sure the INPUT points to the root of the source tree
  777. # - Run doxygen as normal
  778. #
  779. # Doxygen will invoke htags (and that will in turn invoke gtags), so these
  780. # tools must be available from the command line (i.e. in the search path).
  781. #
  782. # The result: instead of the source browser generated by doxygen, the links to
  783. # source code will now point to the output of htags.
  784. # The default value is: NO.
  785. # This tag requires that the tag SOURCE_BROWSER is set to YES.
  786. USE_HTAGS = NO
  787. # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
  788. # verbatim copy of the header file for each class for which an include is
  789. # specified. Set to NO to disable this.
  790. # See also: Section \class.
  791. # The default value is: YES.
  792. VERBATIM_HEADERS = YES
  793. #---------------------------------------------------------------------------
  794. # Configuration options related to the alphabetical class index
  795. #---------------------------------------------------------------------------
  796. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
  797. # compounds will be generated. Enable this if the project contains a lot of
  798. # classes, structs, unions or interfaces.
  799. # The default value is: YES.
  800. ALPHABETICAL_INDEX = YES
  801. # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
  802. # which the alphabetical index list will be split.
  803. # Minimum value: 1, maximum value: 20, default value: 5.
  804. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  805. COLS_IN_ALPHA_INDEX = 5
  806. # In case all classes in a project start with a common prefix, all classes will
  807. # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
  808. # can be used to specify a prefix (or a list of prefixes) that should be ignored
  809. # while generating the index headers.
  810. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  811. IGNORE_PREFIX =
  812. #---------------------------------------------------------------------------
  813. # Configuration options related to the HTML output
  814. #---------------------------------------------------------------------------
  815. # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
  816. # The default value is: YES.
  817. GENERATE_HTML = YES
  818. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
  819. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  820. # it.
  821. # The default directory is: html.
  822. # This tag requires that the tag GENERATE_HTML is set to YES.
  823. HTML_OUTPUT = html
  824. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
  825. # generated HTML page (for example: .htm, .php, .asp).
  826. # The default value is: .html.
  827. # This tag requires that the tag GENERATE_HTML is set to YES.
  828. HTML_FILE_EXTENSION = .html
  829. # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
  830. # each generated HTML page. If the tag is left blank doxygen will generate a
  831. # standard header.
  832. #
  833. # To get valid HTML the header file that includes any scripts and style sheets
  834. # that doxygen needs, which is dependent on the configuration options used (e.g.
  835. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
  836. # default header using
  837. # doxygen -w html new_header.html new_footer.html new_stylesheet.css
  838. # YourConfigFile
  839. # and then modify the file new_header.html. See also section "Doxygen usage"
  840. # for information on how to generate the default header that doxygen normally
  841. # uses.
  842. # Note: The header is subject to change so you typically have to regenerate the
  843. # default header when upgrading to a newer version of doxygen. For a description
  844. # of the possible markers and block names see the documentation.
  845. # This tag requires that the tag GENERATE_HTML is set to YES.
  846. HTML_HEADER =
  847. # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
  848. # generated HTML page. If the tag is left blank doxygen will generate a standard
  849. # footer. See HTML_HEADER for more information on how to generate a default
  850. # footer and what special commands can be used inside the footer. See also
  851. # section "Doxygen usage" for information on how to generate the default footer
  852. # that doxygen normally uses.
  853. # This tag requires that the tag GENERATE_HTML is set to YES.
  854. HTML_FOOTER =
  855. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
  856. # sheet that is used by each HTML page. It can be used to fine-tune the look of
  857. # the HTML output. If left blank doxygen will generate a default style sheet.
  858. # See also section "Doxygen usage" for information on how to generate the style
  859. # sheet that doxygen normally uses.
  860. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
  861. # it is more robust and this tag (HTML_STYLESHEET) will in the future become
  862. # obsolete.
  863. # This tag requires that the tag GENERATE_HTML is set to YES.
  864. HTML_STYLESHEET =
  865. # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
  866. # defined cascading style sheet that is included after the standard style sheets
  867. # created by doxygen. Using this option one can overrule certain style aspects.
  868. # This is preferred over using HTML_STYLESHEET since it does not replace the
  869. # standard style sheet and is therefor more robust against future updates.
  870. # Doxygen will copy the style sheet file to the output directory. For an example
  871. # see the documentation.
  872. # This tag requires that the tag GENERATE_HTML is set to YES.
  873. HTML_EXTRA_STYLESHEET =
  874. # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  875. # other source files which should be copied to the HTML output directory. Note
  876. # that these files will be copied to the base HTML output directory. Use the
  877. # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  878. # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
  879. # files will be copied as-is; there are no commands or markers available.
  880. # This tag requires that the tag GENERATE_HTML is set to YES.
  881. HTML_EXTRA_FILES =
  882. # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
  883. # will adjust the colors in the stylesheet and background images according to
  884. # this color. Hue is specified as an angle on a colorwheel, see
  885. # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
  886. # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
  887. # purple, and 360 is red again.
  888. # Minimum value: 0, maximum value: 359, default value: 220.
  889. # This tag requires that the tag GENERATE_HTML is set to YES.
  890. HTML_COLORSTYLE_HUE = 220
  891. # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
  892. # in the HTML output. For a value of 0 the output will use grayscales only. A
  893. # value of 255 will produce the most vivid colors.
  894. # Minimum value: 0, maximum value: 255, default value: 100.
  895. # This tag requires that the tag GENERATE_HTML is set to YES.
  896. HTML_COLORSTYLE_SAT = 98
  897. # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
  898. # luminance component of the colors in the HTML output. Values below 100
  899. # gradually make the output lighter, whereas values above 100 make the output
  900. # darker. The value divided by 100 is the actual gamma applied, so 80 represents
  901. # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
  902. # change t…