Doxyfile
上传用户:wstnjxml
上传日期:2014-04-03
资源大小:7248k
文件大小:47k
源码类别:

Windows CE

开发平台:

C/C++

  1. # Doxyfile 1.3.9.1
  2. # This file describes the settings to be used by the documentation system
  3. # doxygen (www.doxygen.org) for a project
  4. #
  5. # All text after a hash (#) is considered a comment and will be ignored
  6. # The format is:
  7. #       TAG = value [value, ...]
  8. # For lists items can also be appended using:
  9. #       TAG += value [value, ...]
  10. # Values that contain spaces should be placed between quotes (" ")
  11. #---------------------------------------------------------------------------
  12. # Project related configuration options
  13. #---------------------------------------------------------------------------
  14. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
  15. # by quotes) that should identify the project.
  16. PROJECT_NAME           = libmusepack
  17. # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
  18. # This could be handy for archiving the generated documentation or 
  19. # if some version control system is used.
  20. PROJECT_NUMBER         = 1.1
  21. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
  22. # base path where the generated documentation will be put. 
  23. # If a relative path is entered, it will be relative to the location 
  24. # where doxygen was started. If left blank the current directory will be used.
  25. OUTPUT_DIRECTORY       = docs
  26. # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
  27. # 4096 sub-directories (in 2 levels) under the output directory of each output 
  28. # format and will distribute the generated files over these directories. 
  29. # Enabling this option can be useful when feeding doxygen a huge amount of source 
  30. # files, where putting all generated files in the same directory would otherwise 
  31. # cause performance problems for the file system.
  32. CREATE_SUBDIRS         = NO
  33. # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
  34. # documentation generated by doxygen is written. Doxygen will use this 
  35. # information to generate all constant output in the proper language. 
  36. # The default language is English, other supported languages are: 
  37. # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 
  38. # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 
  39. # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 
  40. # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 
  41. # Swedish, and Ukrainian.
  42. OUTPUT_LANGUAGE        = English
  43. # This tag can be used to specify the encoding used in the generated output. 
  44. # The encoding is not always determined by the language that is chosen, 
  45. # but also whether or not the output is meant for Windows or non-Windows users. 
  46. # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
  47. # forces the Windows encoding (this is the default for the Windows binary), 
  48. # whereas setting the tag to NO uses a Unix-style encoding (the default for 
  49. # all platforms other than Windows).
  50. USE_WINDOWS_ENCODING   = NO
  51. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
  52. # include brief member descriptions after the members that are listed in 
  53. # the file and class documentation (similar to JavaDoc). 
  54. # Set to NO to disable this.
  55. BRIEF_MEMBER_DESC      = YES
  56. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
  57. # the brief description of a member or function before the detailed description. 
  58. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
  59. # brief descriptions will be completely suppressed.
  60. REPEAT_BRIEF           = YES
  61. # This tag implements a quasi-intelligent brief description abbreviator 
  62. # that is used to form the text in various listings. Each string 
  63. # in this list, if found as the leading text of the brief description, will be 
  64. # stripped from the text and the result after processing the whole list, is used 
  65. # as the annotated text. Otherwise, the brief description is used as-is. If left 
  66. # blank, the following values are used ("$name" is automatically replaced with the 
  67. # name of the entity): "The $name class" "The $name widget" "The $name file" 
  68. # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
  69. ABBREVIATE_BRIEF       = 
  70. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
  71. # Doxygen will generate a detailed section even if there is only a brief 
  72. # description.
  73. ALWAYS_DETAILED_SEC    = NO
  74. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 
  75. # members of a class in the documentation of that class as if those members were 
  76. # ordinary class members. Constructors, destructors and assignment operators of 
  77. # the base classes will not be shown.
  78. INLINE_INHERITED_MEMB  = NO
  79. # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
  80. # path before files name in the file list and in the header files. If set 
  81. # to NO the shortest path that makes the file name unique will be used.
  82. FULL_PATH_NAMES        = YES
  83. # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
  84. # can be used to strip a user-defined part of the path. Stripping is 
  85. # only done if one of the specified strings matches the left-hand part of 
  86. # the path. The tag can be used to show relative paths in the file list. 
  87. # If left blank the directory from which doxygen is run is used as the 
  88. # path to strip.
  89. STRIP_FROM_PATH        = 
  90. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
  91. # the path mentioned in the documentation of a class, which tells 
  92. # the reader which header file to include in order to use a class. 
  93. # If left blank only the name of the header file containing the class 
  94. # definition is used. Otherwise one should specify the include paths that 
  95. # are normally passed to the compiler using the -I flag.
  96. STRIP_FROM_INC_PATH    = 
  97. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
  98. # (but less readable) file names. This can be useful is your file systems 
  99. # doesn't support long names like on DOS, Mac, or CD-ROM.
  100. SHORT_NAMES            = NO
  101. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
  102. # will interpret the first line (until the first dot) of a JavaDoc-style 
  103. # comment as the brief description. If set to NO, the JavaDoc 
  104. # comments will behave just like the Qt-style comments (thus requiring an 
  105. # explicit @brief command for a brief description.
  106. JAVADOC_AUTOBRIEF      = NO
  107. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
  108. # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
  109. # comments) as a brief description. This used to be the default behaviour. 
  110. # The new default is to treat a multi-line C++ comment block as a detailed 
  111. # description. Set this tag to YES if you prefer the old behaviour instead.
  112. MULTILINE_CPP_IS_BRIEF = NO
  113. # If the DETAILS_AT_TOP tag is set to YES then Doxygen 
  114. # will output the detailed description near the top, like JavaDoc.
  115. # If set to NO, the detailed description appears after the member 
  116. # documentation.
  117. DETAILS_AT_TOP         = NO
  118. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
  119. # member inherits the documentation from any documented member that it 
  120. # re-implements.
  121. INHERIT_DOCS           = YES
  122. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
  123. # tag is set to YES, then doxygen will reuse the documentation of the first 
  124. # member in the group (if any) for the other members of the group. By default 
  125. # all members of a group must be documented explicitly.
  126. DISTRIBUTE_GROUP_DOC   = NO
  127. # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
  128. # Doxygen uses this value to replace tabs by spaces in code fragments.
  129. TAB_SIZE               = 8
  130. # This tag can be used to specify a number of aliases that acts 
  131. # as commands in the documentation. An alias has the form "name=value". 
  132. # For example adding "sideeffect=par Side Effects:n" will allow you to 
  133. # put the command sideeffect (or @sideeffect) in the documentation, which 
  134. # will result in a user-defined paragraph with heading "Side Effects:". 
  135. # You can put n's in the value part of an alias to insert newlines.
  136. ALIASES                = 
  137. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
  138. # only. Doxygen will then generate output that is more tailored for C. 
  139. # For instance, some of the names that are used will be different. The list 
  140. # of all members will be omitted, etc.
  141. OPTIMIZE_OUTPUT_FOR_C  = NO
  142. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 
  143. # only. Doxygen will then generate output that is more tailored for Java. 
  144. # For instance, namespaces will be presented as packages, qualified scopes 
  145. # will look different, etc.
  146. OPTIMIZE_OUTPUT_JAVA   = NO
  147. # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
  148. # the same type (for instance a group of public functions) to be put as a 
  149. # subgroup of that type (e.g. under the Public Functions section). Set it to 
  150. # NO to prevent subgrouping. Alternatively, this can be done per class using 
  151. # the nosubgrouping command.
  152. SUBGROUPING            = YES
  153. #---------------------------------------------------------------------------
  154. # Build related configuration options
  155. #---------------------------------------------------------------------------
  156. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
  157. # documentation are documented, even if no documentation was available. 
  158. # Private class members and static file members will be hidden unless 
  159. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  160. EXTRACT_ALL            = NO
  161. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
  162. # will be included in the documentation.
  163. EXTRACT_PRIVATE        = NO
  164. # If the EXTRACT_STATIC tag is set to YES all static members of a file 
  165. # will be included in the documentation.
  166. EXTRACT_STATIC         = NO
  167. # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
  168. # defined locally in source files will be included in the documentation. 
  169. # If set to NO only classes defined in header files are included.
  170. EXTRACT_LOCAL_CLASSES  = YES
  171. # This flag is only useful for Objective-C code. When set to YES local 
  172. # methods, which are defined in the implementation section but not in 
  173. # the interface are included in the documentation. 
  174. # If set to NO (the default) only methods in the interface are included.
  175. EXTRACT_LOCAL_METHODS  = NO
  176. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
  177. # undocumented members of documented classes, files or namespaces. 
  178. # If set to NO (the default) these members will be included in the 
  179. # various overviews, but no documentation section is generated. 
  180. # This option has no effect if EXTRACT_ALL is enabled.
  181. HIDE_UNDOC_MEMBERS     = NO
  182. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
  183. # undocumented classes that are normally visible in the class hierarchy. 
  184. # If set to NO (the default) these classes will be included in the various 
  185. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  186. HIDE_UNDOC_CLASSES     = NO
  187. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
  188. # friend (class|struct|union) declarations. 
  189. # If set to NO (the default) these declarations will be included in the 
  190. # documentation.
  191. HIDE_FRIEND_COMPOUNDS  = NO
  192. # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
  193. # documentation blocks found inside the body of a function. 
  194. # If set to NO (the default) these blocks will be appended to the 
  195. # function's detailed documentation block.
  196. HIDE_IN_BODY_DOCS      = NO
  197. # The INTERNAL_DOCS tag determines if documentation 
  198. # that is typed after a internal command is included. If the tag is set 
  199. # to NO (the default) then the documentation will be excluded. 
  200. # Set it to YES to include the internal documentation.
  201. INTERNAL_DOCS          = NO
  202. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
  203. # file names in lower-case letters. If set to YES upper-case letters are also 
  204. # allowed. This is useful if you have classes or files whose names only differ 
  205. # in case and if your file system supports case sensitive file names. Windows 
  206. # and Mac users are advised to set this option to NO.
  207. CASE_SENSE_NAMES       = YES
  208. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
  209. # will show members with their full class and namespace scopes in the 
  210. # documentation. If set to YES the scope will be hidden.
  211. HIDE_SCOPE_NAMES       = NO
  212. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
  213. # will put a list of the files that are included by a file in the documentation 
  214. # of that file.
  215. SHOW_INCLUDE_FILES     = YES
  216. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
  217. # is inserted in the documentation for inline members.
  218. INLINE_INFO            = YES
  219. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
  220. # will sort the (detailed) documentation of file and class members 
  221. # alphabetically by member name. If set to NO the members will appear in 
  222. # declaration order.
  223. SORT_MEMBER_DOCS       = YES
  224. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
  225. # brief documentation of file, namespace and class members alphabetically 
  226. # by member name. If set to NO (the default) the members will appear in 
  227. # declaration order.
  228. SORT_BRIEF_DOCS        = NO
  229. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
  230. # sorted by fully-qualified names, including namespaces. If set to 
  231. # NO (the default), the class list will be sorted only by class name, 
  232. # not including the namespace part. 
  233. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  234. # Note: This option applies only to the class list, not to the 
  235. # alphabetical list.
  236. SORT_BY_SCOPE_NAME     = NO
  237. # The GENERATE_TODOLIST tag can be used to enable (YES) or 
  238. # disable (NO) the todo list. This list is created by putting todo 
  239. # commands in the documentation.
  240. GENERATE_TODOLIST      = YES
  241. # The GENERATE_TESTLIST tag can be used to enable (YES) or 
  242. # disable (NO) the test list. This list is created by putting test 
  243. # commands in the documentation.
  244. GENERATE_TESTLIST      = YES
  245. # The GENERATE_BUGLIST tag can be used to enable (YES) or 
  246. # disable (NO) the bug list. This list is created by putting bug 
  247. # commands in the documentation.
  248. GENERATE_BUGLIST       = YES
  249. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
  250. # disable (NO) the deprecated list. This list is created by putting 
  251. # deprecated commands in the documentation.
  252. GENERATE_DEPRECATEDLIST= YES
  253. # The ENABLED_SECTIONS tag can be used to enable conditional 
  254. # documentation sections, marked by if sectionname ... endif.
  255. ENABLED_SECTIONS       = 
  256. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
  257. # the initial value of a variable or define consists of for it to appear in 
  258. # the documentation. If the initializer consists of more lines than specified 
  259. # here it will be hidden. Use a value of 0 to hide initializers completely. 
  260. # The appearance of the initializer of individual variables and defines in the 
  261. # documentation can be controlled using showinitializer or hideinitializer 
  262. # command in the documentation regardless of this setting.
  263. MAX_INITIALIZER_LINES  = 30
  264. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
  265. # at the bottom of the documentation of classes and structs. If set to YES the 
  266. # list will mention the files that were used to generate the documentation.
  267. SHOW_USED_FILES        = YES
  268. # If the sources in your project are distributed over multiple directories 
  269. # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
  270. # in the documentation.
  271. SHOW_DIRECTORIES       = YES
  272. #---------------------------------------------------------------------------
  273. # configuration options related to warning and progress messages
  274. #---------------------------------------------------------------------------
  275. # The QUIET tag can be used to turn on/off the messages that are generated 
  276. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  277. QUIET                  = NO
  278. # The WARNINGS tag can be used to turn on/off the warning messages that are 
  279. # generated by doxygen. Possible values are YES and NO. If left blank 
  280. # NO is used.
  281. WARNINGS               = YES
  282. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
  283. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
  284. # automatically be disabled.
  285. WARN_IF_UNDOCUMENTED   = YES
  286. # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
  287. # potential errors in the documentation, such as not documenting some 
  288. # parameters in a documented function, or documenting parameters that 
  289. # don't exist or using markup commands wrongly.
  290. WARN_IF_DOC_ERROR      = YES
  291. # The WARN_FORMAT tag determines the format of the warning messages that 
  292. # doxygen can produce. The string should contain the $file, $line, and $text 
  293. # tags, which will be replaced by the file and line number from which the 
  294. # warning originated and the warning text.
  295. WARN_FORMAT            = "$file:$line: $text"
  296. # The WARN_LOGFILE tag can be used to specify a file to which warning 
  297. # and error messages should be written. If left blank the output is written 
  298. # to stderr.
  299. WARN_LOGFILE           = 
  300. #---------------------------------------------------------------------------
  301. # configuration options related to the input files
  302. #---------------------------------------------------------------------------
  303. # The INPUT tag can be used to specify the files and/or directories that contain 
  304. # documented source files. You may enter file names like "myfile.cpp" or 
  305. # directories like "/usr/src/myproject". Separate the files or directories 
  306. # with spaces.
  307. INPUT                  = include src
  308. # If the value of the INPUT tag contains directories, you can use the 
  309. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
  310. # and *.h) to filter out the source-files in the directories. If left 
  311. # blank the following patterns are tested: 
  312. # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
  313. # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
  314. FILE_PATTERNS          = 
  315. # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
  316. # should be searched for input files as well. Possible values are YES and NO. 
  317. # If left blank NO is used.
  318. RECURSIVE              = YES
  319. # The EXCLUDE tag can be used to specify files and/or directories that should 
  320. # excluded from the INPUT source files. This way you can easily exclude a 
  321. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  322. EXCLUDE                = include/config.h
  323. # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 
  324. # that are symbolic links (a Unix filesystem feature) are excluded from the input.
  325. EXCLUDE_SYMLINKS       = NO
  326. # If the value of the INPUT tag contains directories, you can use the 
  327. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
  328. # certain files from those directories.
  329. EXCLUDE_PATTERNS       = 
  330. # The EXAMPLE_PATH tag can be used to specify one or more files or 
  331. # directories that contain example code fragments that are included (see 
  332. # the include command).
  333. EXAMPLE_PATH           = 
  334. # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
  335. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
  336. # and *.h) to filter out the source-files in the directories. If left 
  337. # blank all files are included.
  338. EXAMPLE_PATTERNS       = 
  339. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
  340. # searched for input files to be used with the include or dontinclude 
  341. # commands irrespective of the value of the RECURSIVE tag. 
  342. # Possible values are YES and NO. If left blank NO is used.
  343. EXAMPLE_RECURSIVE      = NO
  344. # The IMAGE_PATH tag can be used to specify one or more files or 
  345. # directories that contain image that are included in the documentation (see 
  346. # the image command).
  347. IMAGE_PATH             = 
  348. # The INPUT_FILTER tag can be used to specify a program that doxygen should 
  349. # invoke to filter for each input file. Doxygen will invoke the filter program 
  350. # by executing (via popen()) the command <filter> <input-file>, where <filter> 
  351. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
  352. # input file. Doxygen will then use the output that the filter program writes 
  353. # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
  354. # ignored.
  355. INPUT_FILTER           = 
  356. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
  357. # basis.  Doxygen will compare the file name with each pattern and apply the 
  358. # filter if there is a match.  The filters are a list of the form: 
  359. # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
  360. # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
  361. # is applied to all files.
  362. FILTER_PATTERNS        = 
  363. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
  364. # INPUT_FILTER) will be used to filter the input files when producing source 
  365. # files to browse (i.e. when SOURCE_BROWSER is set to YES).
  366. FILTER_SOURCE_FILES    = NO
  367. #---------------------------------------------------------------------------
  368. # configuration options related to source browsing
  369. #---------------------------------------------------------------------------
  370. # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
  371. # be generated. Documented entities will be cross-referenced with these sources. 
  372. # Note: To get rid of all source code in the generated output, make sure also 
  373. # VERBATIM_HEADERS is set to NO.
  374. SOURCE_BROWSER         = YES
  375. # Setting the INLINE_SOURCES tag to YES will include the body 
  376. # of functions and classes directly in the documentation.
  377. INLINE_SOURCES         = NO
  378. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
  379. # doxygen to hide any special comment blocks from generated source code 
  380. # fragments. Normal C and C++ comments will always remain visible.
  381. STRIP_CODE_COMMENTS    = YES
  382. # If the REFERENCED_BY_RELATION tag is set to YES (the default) 
  383. # then for each documented function all documented 
  384. # functions referencing it will be listed.
  385. REFERENCED_BY_RELATION = YES
  386. # If the REFERENCES_RELATION tag is set to YES (the default) 
  387. # then for each documented function all documented entities 
  388. # called/used by that function will be listed.
  389. REFERENCES_RELATION    = YES
  390. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
  391. # will generate a verbatim copy of the header file for each class for 
  392. # which an include is specified. Set to NO to disable this.
  393. VERBATIM_HEADERS       = YES
  394. #---------------------------------------------------------------------------
  395. # configuration options related to the alphabetical class index
  396. #---------------------------------------------------------------------------
  397. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
  398. # of all compounds will be generated. Enable this if the project 
  399. # contains a lot of classes, structs, unions or interfaces.
  400. ALPHABETICAL_INDEX     = NO
  401. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
  402. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
  403. # in which this list will be split (can be a number in the range [1..20])
  404. COLS_IN_ALPHA_INDEX    = 5
  405. # In case all classes in a project start with a common prefix, all 
  406. # classes will be put under the same header in the alphabetical index. 
  407. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
  408. # should be ignored while generating the index headers.
  409. IGNORE_PREFIX          = 
  410. #---------------------------------------------------------------------------
  411. # configuration options related to the HTML output
  412. #---------------------------------------------------------------------------
  413. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
  414. # generate HTML output.
  415. GENERATE_HTML          = YES
  416. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
  417. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  418. # put in front of it. If left blank `html' will be used as the default path.
  419. HTML_OUTPUT            = html
  420. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
  421. # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
  422. # doxygen will generate files with .html extension.
  423. HTML_FILE_EXTENSION    = .html
  424. # The HTML_HEADER tag can be used to specify a personal HTML header for 
  425. # each generated HTML page. If it is left blank doxygen will generate a 
  426. # standard header.
  427. HTML_HEADER            = 
  428. # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
  429. # each generated HTML page. If it is left blank doxygen will generate a 
  430. # standard footer.
  431. HTML_FOOTER            = 
  432. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
  433. # style sheet that is used by each HTML page. It can be used to 
  434. # fine-tune the look of the HTML output. If the tag is left blank doxygen 
  435. # will generate a default style sheet. Note that doxygen will try to copy 
  436. # the style sheet file to the HTML output directory, so don't put your own 
  437. # stylesheet in the HTML output directory as well, or it will be erased!
  438. HTML_STYLESHEET        = docs/custom.css
  439. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
  440. # files or namespaces will be aligned in HTML using tables. If set to 
  441. # NO a bullet list will be used.
  442. HTML_ALIGN_MEMBERS     = YES
  443. # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
  444. # will be generated that can be used as input for tools like the 
  445. # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
  446. # of the generated HTML documentation.
  447. GENERATE_HTMLHELP      = NO
  448. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
  449. # be used to specify the file name of the resulting .chm file. You 
  450. # can add a path in front of the file if the result should not be 
  451. # written to the html output directory.
  452. CHM_FILE               = 
  453. # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
  454. # be used to specify the location (absolute path including file name) of 
  455. # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
  456. # the HTML help compiler on the generated index.hhp.
  457. HHC_LOCATION           = 
  458. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
  459. # controls if a separate .chi index file is generated (YES) or that 
  460. # it should be included in the master .chm file (NO).
  461. GENERATE_CHI           = NO
  462. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
  463. # controls whether a binary table of contents is generated (YES) or a 
  464. # normal table of contents (NO) in the .chm file.
  465. BINARY_TOC             = NO
  466. # The TOC_EXPAND flag can be set to YES to add extra items for group members 
  467. # to the contents of the HTML help documentation and to the tree view.
  468. TOC_EXPAND             = NO
  469. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
  470. # top of each HTML page. The value NO (the default) enables the index and 
  471. # the value YES disables it.
  472. DISABLE_INDEX          = NO
  473. # This tag can be used to set the number of enum values (range [1..20]) 
  474. # that doxygen will group on one line in the generated HTML documentation.
  475. ENUM_VALUES_PER_LINE   = 4
  476. # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
  477. # generated containing a tree-like index structure (just like the one that 
  478. # is generated for HTML Help). For this to work a browser that supports 
  479. # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
  480. # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
  481. # probably better off using the HTML help feature.
  482. GENERATE_TREEVIEW      = NO
  483. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
  484. # used to set the initial width (in pixels) of the frame in which the tree 
  485. # is shown.
  486. TREEVIEW_WIDTH         = 250
  487. #---------------------------------------------------------------------------
  488. # configuration options related to the LaTeX output
  489. #---------------------------------------------------------------------------
  490. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
  491. # generate Latex output.
  492. GENERATE_LATEX         = NO
  493. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
  494. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  495. # put in front of it. If left blank `latex' will be used as the default path.
  496. LATEX_OUTPUT           = latex
  497. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
  498. # invoked. If left blank `latex' will be used as the default command name.
  499. LATEX_CMD_NAME         = latex
  500. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
  501. # generate index for LaTeX. If left blank `makeindex' will be used as the 
  502. # default command name.
  503. MAKEINDEX_CMD_NAME     = makeindex
  504. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
  505. # LaTeX documents. This may be useful for small projects and may help to 
  506. # save some trees in general.
  507. COMPACT_LATEX          = NO
  508. # The PAPER_TYPE tag can be used to set the paper type that is used 
  509. # by the printer. Possible values are: a4, a4wide, letter, legal and 
  510. # executive. If left blank a4wide will be used.
  511. PAPER_TYPE             = a4wide
  512. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
  513. # packages that should be included in the LaTeX output.
  514. EXTRA_PACKAGES         = 
  515. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
  516. # the generated latex document. The header should contain everything until 
  517. # the first chapter. If it is left blank doxygen will generate a 
  518. # standard header. Notice: only use this tag if you know what you are doing!
  519. LATEX_HEADER           = 
  520. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
  521. # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
  522. # contain links (just like the HTML output) instead of page references 
  523. # This makes the output suitable for online browsing using a pdf viewer.
  524. PDF_HYPERLINKS         = NO
  525. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
  526. # plain latex in the generated Makefile. Set this option to YES to get a 
  527. # higher quality PDF documentation.
  528. USE_PDFLATEX           = NO
  529. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode. 
  530. # command to the generated LaTeX files. This will instruct LaTeX to keep 
  531. # running if errors occur, instead of asking the user for help. 
  532. # This option is also used when generating formulas in HTML.
  533. LATEX_BATCHMODE        = NO
  534. # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
  535. # include the index chapters (such as File Index, Compound Index, etc.) 
  536. # in the output.
  537. LATEX_HIDE_INDICES     = NO
  538. #---------------------------------------------------------------------------
  539. # configuration options related to the RTF output
  540. #---------------------------------------------------------------------------
  541. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
  542. # The RTF output is optimized for Word 97 and may not look very pretty with 
  543. # other RTF readers or editors.
  544. GENERATE_RTF           = NO
  545. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
  546. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  547. # put in front of it. If left blank `rtf' will be used as the default path.
  548. RTF_OUTPUT             = rtf
  549. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
  550. # RTF documents. This may be useful for small projects and may help to 
  551. # save some trees in general.
  552. COMPACT_RTF            = NO
  553. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
  554. # will contain hyperlink fields. The RTF file will 
  555. # contain links (just like the HTML output) instead of page references. 
  556. # This makes the output suitable for online browsing using WORD or other 
  557. # programs which support those fields. 
  558. # Note: wordpad (write) and others do not support links.
  559. RTF_HYPERLINKS         = NO
  560. # Load stylesheet definitions from file. Syntax is similar to doxygen's 
  561. # config file, i.e. a series of assignments. You only have to provide 
  562. # replacements, missing definitions are set to their default value.
  563. RTF_STYLESHEET_FILE    = 
  564. # Set optional variables used in the generation of an rtf document. 
  565. # Syntax is similar to doxygen's config file.
  566. RTF_EXTENSIONS_FILE    = 
  567. #---------------------------------------------------------------------------
  568. # configuration options related to the man page output
  569. #---------------------------------------------------------------------------
  570. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
  571. # generate man pages
  572. GENERATE_MAN           = NO
  573. # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
  574. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  575. # put in front of it. If left blank `man' will be used as the default path.
  576. MAN_OUTPUT             = man
  577. # The MAN_EXTENSION tag determines the extension that is added to 
  578. # the generated man pages (default is the subroutine's section .3)
  579. MAN_EXTENSION          = .3
  580. # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
  581. # then it will generate one additional man file for each entity 
  582. # documented in the real man page(s). These additional files 
  583. # only source the real man page, but without them the man command 
  584. # would be unable to find the correct page. The default is NO.
  585. MAN_LINKS              = NO
  586. #---------------------------------------------------------------------------
  587. # configuration options related to the XML output
  588. #---------------------------------------------------------------------------
  589. # If the GENERATE_XML tag is set to YES Doxygen will 
  590. # generate an XML file that captures the structure of 
  591. # the code including all documentation.
  592. GENERATE_XML           = NO
  593. # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
  594. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  595. # put in front of it. If left blank `xml' will be used as the default path.
  596. XML_OUTPUT             = xml
  597. # The XML_SCHEMA tag can be used to specify an XML schema, 
  598. # which can be used by a validating XML parser to check the 
  599. # syntax of the XML files.
  600. XML_SCHEMA             = 
  601. # The XML_DTD tag can be used to specify an XML DTD, 
  602. # which can be used by a validating XML parser to check the 
  603. # syntax of the XML files.
  604. XML_DTD                = 
  605. # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
  606. # dump the program listings (including syntax highlighting 
  607. # and cross-referencing information) to the XML output. Note that 
  608. # enabling this will significantly increase the size of the XML output.
  609. XML_PROGRAMLISTING     = YES
  610. #---------------------------------------------------------------------------
  611. # configuration options for the AutoGen Definitions output
  612. #---------------------------------------------------------------------------
  613. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
  614. # generate an AutoGen Definitions (see autogen.sf.net) file 
  615. # that captures the structure of the code including all 
  616. # documentation. Note that this feature is still experimental 
  617. # and incomplete at the moment.
  618. GENERATE_AUTOGEN_DEF   = NO
  619. #---------------------------------------------------------------------------
  620. # configuration options related to the Perl module output
  621. #---------------------------------------------------------------------------
  622. # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
  623. # generate a Perl module file that captures the structure of 
  624. # the code including all documentation. Note that this 
  625. # feature is still experimental and incomplete at the 
  626. # moment.
  627. GENERATE_PERLMOD       = NO
  628. # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
  629. # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
  630. # to generate PDF and DVI output from the Perl module output.
  631. PERLMOD_LATEX          = NO
  632. # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
  633. # nicely formatted so it can be parsed by a human reader.  This is useful 
  634. # if you want to understand what is going on.  On the other hand, if this 
  635. # tag is set to NO the size of the Perl module output will be much smaller 
  636. # and Perl will parse it just the same.
  637. PERLMOD_PRETTY         = YES
  638. # The names of the make variables in the generated doxyrules.make file 
  639. # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
  640. # This is useful so different doxyrules.make files included by the same 
  641. # Makefile don't overwrite each other's variables.
  642. PERLMOD_MAKEVAR_PREFIX = 
  643. #---------------------------------------------------------------------------
  644. # Configuration options related to the preprocessor   
  645. #---------------------------------------------------------------------------
  646. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
  647. # evaluate all C-preprocessor directives found in the sources and include 
  648. # files.
  649. ENABLE_PREPROCESSING   = YES
  650. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
  651. # names in the source code. If set to NO (the default) only conditional 
  652. # compilation will be performed. Macro expansion can be done in a controlled 
  653. # way by setting EXPAND_ONLY_PREDEF to YES.
  654. MACRO_EXPANSION        = NO
  655. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
  656. # then the macro expansion is limited to the macros specified with the 
  657. # PREDEFINED and EXPAND_AS_PREDEFINED tags.
  658. EXPAND_ONLY_PREDEF     = NO
  659. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
  660. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  661. SEARCH_INCLUDES        = YES
  662. # The INCLUDE_PATH tag can be used to specify one or more directories that 
  663. # contain include files that are not input files but should be processed by 
  664. # the preprocessor.
  665. INCLUDE_PATH           = 
  666. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
  667. # patterns (like *.h and *.hpp) to filter out the header-files in the 
  668. # directories. If left blank, the patterns specified with FILE_PATTERNS will 
  669. # be used.
  670. INCLUDE_FILE_PATTERNS  = 
  671. # The PREDEFINED tag can be used to specify one or more macro names that 
  672. # are defined before the preprocessor is started (similar to the -D option of 
  673. # gcc). The argument of the tag is a list of macros of the form: name 
  674. # or name=definition (no spaces). If the definition and the = are 
  675. # omitted =1 is assumed. To prevent a macro definition from being 
  676. # undefined via #undef or recursively expanded use the := operator 
  677. # instead of the = operator.
  678. PREDEFINED             = 
  679. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
  680. # this tag can be used to specify a list of macro names that should be expanded. 
  681. # The macro definition that is found in the sources will be used. 
  682. # Use the PREDEFINED tag if you want to use a different macro definition.
  683. EXPAND_AS_DEFINED      = 
  684. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
  685. # doxygen's preprocessor will remove all function-like macros that are alone 
  686. # on a line, have an all uppercase name, and do not end with a semicolon. Such 
  687. # function macros are typically used for boiler-plate code, and will confuse the 
  688. # parser if not removed.
  689. SKIP_FUNCTION_MACROS   = YES
  690. #---------------------------------------------------------------------------
  691. # Configuration::additions related to external references   
  692. #---------------------------------------------------------------------------
  693. # The TAGFILES option can be used to specify one or more tagfiles. 
  694. # Optionally an initial location of the external documentation 
  695. # can be added for each tagfile. The format of a tag file without 
  696. # this location is as follows: 
  697. #   TAGFILES = file1 file2 ... 
  698. # Adding location for the tag files is done as follows: 
  699. #   TAGFILES = file1=loc1 "file2 = loc2" ... 
  700. # where "loc1" and "loc2" can be relative or absolute paths or 
  701. # URLs. If a location is present for each tag, the installdox tool 
  702. # does not have to be run to correct the links.
  703. # Note that each tag file must have a unique name
  704. # (where the name does NOT include the path)
  705. # If a tag file is not located in the directory in which doxygen 
  706. # is run, you must also specify the path to the tagfile here.
  707. TAGFILES               = 
  708. # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
  709. # a tag file that is based on the input files it reads.
  710. GENERATE_TAGFILE       = 
  711. # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
  712. # in the class index. If set to NO only the inherited external classes 
  713. # will be listed.
  714. ALLEXTERNALS           = NO
  715. # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
  716. # in the modules index. If set to NO, only the current project's groups will 
  717. # be listed.
  718. EXTERNAL_GROUPS        = YES
  719. # The PERL_PATH should be the absolute path and name of the perl script 
  720. # interpreter (i.e. the result of `which perl').
  721. PERL_PATH              = /usr/bin/perl
  722. #---------------------------------------------------------------------------
  723. # Configuration options related to the dot tool   
  724. #---------------------------------------------------------------------------
  725. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
  726. # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 
  727. # super classes. Setting the tag to NO turns the diagrams off. Note that this 
  728. # option is superseded by the HAVE_DOT option below. This is only a fallback. It is 
  729. # recommended to install and use dot, since it yields more powerful graphs.
  730. CLASS_DIAGRAMS         = YES
  731. # If set to YES, the inheritance and collaboration graphs will hide 
  732. # inheritance and usage relations if the target is undocumented 
  733. # or is not a class.
  734. HIDE_UNDOC_RELATIONS   = YES
  735. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
  736. # available from the path. This tool is part of Graphviz, a graph visualization 
  737. # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
  738. # have no effect if this option is set to NO (the default)
  739. HAVE_DOT               = NO
  740. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
  741. # will generate a graph for each documented class showing the direct and 
  742. # indirect inheritance relations. Setting this tag to YES will force the 
  743. # the CLASS_DIAGRAMS tag to NO.
  744. CLASS_GRAPH            = YES
  745. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
  746. # will generate a graph for each documented class showing the direct and 
  747. # indirect implementation dependencies (inheritance, containment, and 
  748. # class references variables) of the class with other documented classes.
  749. COLLABORATION_GRAPH    = YES
  750. # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
  751. # collaboration diagrams in a style similar to the OMG's Unified Modeling 
  752. # Language.
  753. UML_LOOK               = NO
  754. # If set to YES, the inheritance and collaboration graphs will show the 
  755. # relations between templates and their instances.
  756. TEMPLATE_RELATIONS     = NO
  757. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
  758. # tags are set to YES then doxygen will generate a graph for each documented 
  759. # file showing the direct and indirect include dependencies of the file with 
  760. # other documented files.
  761. INCLUDE_GRAPH          = YES
  762. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
  763. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
  764. # documented header file showing the documented files that directly or 
  765. # indirectly include this file.
  766. INCLUDED_BY_GRAPH      = YES
  767. # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
  768. # generate a call dependency graph for every global function or class method. 
  769. # Note that enabling this option will significantly increase the time of a run. 
  770. # So in most cases it will be better to enable call graphs for selected 
  771. # functions only using the callgraph command.
  772. CALL_GRAPH             = NO
  773. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
  774. # will graphical hierarchy of all classes instead of a textual one.
  775. GRAPHICAL_HIERARCHY    = YES
  776. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
  777. # generated by dot. Possible values are png, jpg, or gif
  778. # If left blank png will be used.
  779. DOT_IMAGE_FORMAT       = png
  780. # The tag DOT_PATH can be used to specify the path where the dot tool can be 
  781. # found. If left blank, it is assumed the dot tool can be found on the path.
  782. DOT_PATH               = 
  783. # The DOTFILE_DIRS tag can be used to specify one or more directories that 
  784. # contain dot files that are included in the documentation (see the 
  785. # dotfile command).
  786. DOTFILE_DIRS           = 
  787. # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
  788. # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
  789. # this value, doxygen will try to truncate the graph, so that it fits within 
  790. # the specified constraint. Beware that most browsers cannot cope with very 
  791. # large images.
  792. MAX_DOT_GRAPH_WIDTH    = 1024
  793. # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
  794. # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
  795. # this value, doxygen will try to truncate the graph, so that it fits within 
  796. # the specified constraint. Beware that most browsers cannot cope with very 
  797. # large images.
  798. MAX_DOT_GRAPH_HEIGHT   = 1024
  799. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
  800. # graphs generated by dot. A depth value of 3 means that only nodes reachable 
  801. # from the root by following a path via at most 3 edges will be shown. Nodes that 
  802. # lay further from the root node will be omitted. Note that setting this option to 
  803. # 1 or 2 may greatly reduce the computation time needed for large code bases. Also 
  804. # note that a graph may be further truncated if the graph's image dimensions are 
  805. # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 
  806. # If 0 is used for the depth value (the default), the graph is not depth-constrained.
  807. MAX_DOT_GRAPH_DEPTH    = 0
  808. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
  809. # generate a legend page explaining the meaning of the various boxes and 
  810. # arrows in the dot generated graphs.
  811. GENERATE_LEGEND        = YES
  812. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
  813. # remove the intermediate dot files that are used to generate 
  814. # the various graphs.
  815. DOT_CLEANUP            = YES
  816. #---------------------------------------------------------------------------
  817. # Configuration::additions related to the search engine   
  818. #---------------------------------------------------------------------------
  819. # The SEARCHENGINE tag specifies whether or not a search engine should be 
  820. # used. If set to NO the values of all tags below this one will be ignored.
  821. SEARCHENGINE           = NO