PageRenderTime 59ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 1ms

/docs/doxygen.config

https://github.com/yiwenjingren/cocos2d-x
ASP.NET | 2334 lines | 1808 code | 526 blank | 0 comment | 159 complexity | 29e05a1ff9c243352c829fc531908fca MD5 | raw file
Possible License(s): BSD-2-Clause, CC-BY-SA-3.0, LGPL-3.0, LGPL-2.1, JSON, BSD-3-Clause, MPL-2.0-no-copyleft-exception, MIT

Large files files are truncated, but you can click here to view the full file

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

Large files files are truncated, but you can click here to view the full file