Doxyfile
上传用户:sunlush021
上传日期:2022-06-22
资源大小:90k
文件大小:62k
源码类别:

操作系统开发

开发平台:

C/C++

  1. # Doxyfile 1.5.8
  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. # This tag specifies the encoding used for all characters in the config file 
  15. # that follow. The default is UTF-8 which is also the encoding used for all 
  16. # text before the first occurrence of this tag. Doxygen uses libiconv (or the 
  17. # iconv built into libc) for the transcoding. See 
  18. # http://www.gnu.org/software/libiconv for the list of possible encodings.
  19. DOXYFILE_ENCODING      = UTF-8
  20. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
  21. # by quotes) that should identify the project.
  22. PROJECT_NAME           = TinyThread++
  23. # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
  24. # This could be handy for archiving the generated documentation or 
  25. # if some version control system is used.
  26. PROJECT_NUMBER         = 0.6
  27. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
  28. # base path where the generated documentation will be put. 
  29. # If a relative path is entered, it will be relative to the location 
  30. # where doxygen was started. If left blank the current directory will be used.
  31. OUTPUT_DIRECTORY       =
  32. # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
  33. # 4096 sub-directories (in 2 levels) under the output directory of each output 
  34. # format and will distribute the generated files over these directories. 
  35. # Enabling this option can be useful when feeding doxygen a huge amount of 
  36. # source files, where putting all generated files in the same directory would 
  37. # otherwise cause performance problems for the file system.
  38. CREATE_SUBDIRS         = NO
  39. # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
  40. # documentation generated by doxygen is written. Doxygen will use this 
  41. # information to generate all constant output in the proper language. 
  42. # The default language is English, other supported languages are: 
  43. # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
  44. # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 
  45. # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 
  46. # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 
  47. # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, 
  48. # Spanish, Swedish, and Ukrainian.
  49. OUTPUT_LANGUAGE        = English
  50. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
  51. # include brief member descriptions after the members that are listed in 
  52. # the file and class documentation (similar to JavaDoc). 
  53. # Set to NO to disable this.
  54. BRIEF_MEMBER_DESC      = YES
  55. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
  56. # the brief description of a member or function before the detailed description. 
  57. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
  58. # brief descriptions will be completely suppressed.
  59. REPEAT_BRIEF           = YES
  60. # This tag implements a quasi-intelligent brief description abbreviator 
  61. # that is used to form the text in various listings. Each string 
  62. # in this list, if found as the leading text of the brief description, will be 
  63. # stripped from the text and the result after processing the whole list, is 
  64. # used as the annotated text. Otherwise, the brief description is used as-is. 
  65. # If left blank, the following values are used ("$name" is automatically 
  66. # replaced with the name of the entity): "The $name class" "The $name widget" 
  67. # "The $name file" "is" "provides" "specifies" "contains" 
  68. # "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 
  75. # inherited members of a class in the documentation of that class as if those 
  76. # members were ordinary class members. Constructors, destructors and assignment 
  77. # operators of 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        = NO
  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 regular Qt-style comments 
  105. # (thus requiring an explicit @brief command for a brief description.)
  106. JAVADOC_AUTOBRIEF      = YES
  107. # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
  108. # interpret the first line (until the first dot) of a Qt-style 
  109. # comment as the brief description. If set to NO, the comments 
  110. # will behave just like regular Qt-style comments (thus requiring 
  111. # an explicit brief command for a brief description.)
  112. QT_AUTOBRIEF           = NO
  113. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
  114. # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
  115. # comments) as a brief description. This used to be the default behaviour. 
  116. # The new default is to treat a multi-line C++ comment block as a detailed 
  117. # description. Set this tag to YES if you prefer the old behaviour instead.
  118. MULTILINE_CPP_IS_BRIEF = NO
  119. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
  120. # member inherits the documentation from any documented member that it 
  121. # re-implements.
  122. INHERIT_DOCS           = YES
  123. # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
  124. # a new page for each member. If set to NO, the documentation of a member will 
  125. # be part of the file/class/namespace that contains it.
  126. SEPARATE_MEMBER_PAGES  = 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               = 2
  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 
  138. # sources 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 
  143. # sources only. Doxygen will then generate output that is more tailored for 
  144. # Java. For instance, namespaces will be presented as packages, qualified 
  145. # scopes will look different, etc.
  146. OPTIMIZE_OUTPUT_JAVA   = NO
  147. # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
  148. # sources only. Doxygen will then generate output that is more tailored for 
  149. # Fortran.
  150. OPTIMIZE_FOR_FORTRAN   = NO
  151. # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
  152. # sources. Doxygen will then generate output that is tailored for 
  153. # VHDL.
  154. OPTIMIZE_OUTPUT_VHDL   = NO
  155. # Doxygen selects the parser to use depending on the extension of the files it parses. 
  156. # With this tag you can assign which parser to use for a given extension. 
  157. # Doxygen has a built-in mapping, but you can override or extend it using this tag. 
  158. # The format is ext=language, where ext is a file extension, and language is one of 
  159. # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 
  160. # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 
  161. # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 
  162. # use: inc=Fortran f=C
  163. EXTENSION_MAPPING      = 
  164. # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
  165. # to include (a tag file for) the STL sources as input, then you should 
  166. # set this tag to YES in order to let doxygen match functions declarations and 
  167. # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
  168. # func(std::string) {}). This also make the inheritance and collaboration 
  169. # diagrams that involve STL classes more complete and accurate.
  170. BUILTIN_STL_SUPPORT    = NO
  171. # If you use Microsoft's C++/CLI language, you should set this option to YES to 
  172. # enable parsing support.
  173. CPP_CLI_SUPPORT        = NO
  174. # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
  175. # Doxygen will parse them like normal C++ but will assume all classes use public 
  176. # instead of private inheritance when no explicit protection keyword is present.
  177. SIP_SUPPORT            = NO
  178. # For Microsoft's IDL there are propget and propput attributes to indicate getter 
  179. # and setter methods for a property. Setting this option to YES (the default) 
  180. # will make doxygen to replace the get and set methods by a property in the 
  181. # documentation. This will only work if the methods are indeed getting or 
  182. # setting a simple type. If this is not the case, or you want to show the 
  183. # methods anyway, you should set this option to NO.
  184. IDL_PROPERTY_SUPPORT   = YES
  185. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
  186. # tag is set to YES, then doxygen will reuse the documentation of the first 
  187. # member in the group (if any) for the other members of the group. By default 
  188. # all members of a group must be documented explicitly.
  189. DISTRIBUTE_GROUP_DOC   = NO
  190. # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
  191. # the same type (for instance a group of public functions) to be put as a 
  192. # subgroup of that type (e.g. under the Public Functions section). Set it to 
  193. # NO to prevent subgrouping. Alternatively, this can be done per class using 
  194. # the nosubgrouping command.
  195. SUBGROUPING            = YES
  196. # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
  197. # is documented as struct, union, or enum with the name of the typedef. So 
  198. # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
  199. # with name TypeT. When disabled the typedef will appear as a member of a file, 
  200. # namespace, or class. And the struct will be named TypeS. This can typically 
  201. # be useful for C code in case the coding convention dictates that all compound 
  202. # types are typedef'ed and only the typedef is referenced, never the tag name.
  203. TYPEDEF_HIDES_STRUCT   = NO
  204. # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
  205. # determine which symbols to keep in memory and which to flush to disk. 
  206. # When the cache is full, less often used symbols will be written to disk. 
  207. # For small to medium size projects (<1000 input files) the default value is 
  208. # probably good enough. For larger projects a too small cache size can cause 
  209. # doxygen to be busy swapping symbols to and from disk most of the time 
  210. # causing a significant performance penality. 
  211. # If the system has enough physical memory increasing the cache will improve the 
  212. # performance by keeping more symbols in memory. Note that the value works on 
  213. # a logarithmic scale so increasing the size by one will rougly double the 
  214. # memory usage. The cache size is given by this formula: 
  215. # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
  216. # corresponding to a cache size of 2^16 = 65536 symbols
  217. SYMBOL_CACHE_SIZE      = 0
  218. #---------------------------------------------------------------------------
  219. # Build related configuration options
  220. #---------------------------------------------------------------------------
  221. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
  222. # documentation are documented, even if no documentation was available. 
  223. # Private class members and static file members will be hidden unless 
  224. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  225. EXTRACT_ALL            = NO
  226. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
  227. # will be included in the documentation.
  228. EXTRACT_PRIVATE        = NO
  229. # If the EXTRACT_STATIC tag is set to YES all static members of a file 
  230. # will be included in the documentation.
  231. EXTRACT_STATIC         = NO
  232. # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
  233. # defined locally in source files will be included in the documentation. 
  234. # If set to NO only classes defined in header files are included.
  235. EXTRACT_LOCAL_CLASSES  = YES
  236. # This flag is only useful for Objective-C code. When set to YES local 
  237. # methods, which are defined in the implementation section but not in 
  238. # the interface are included in the documentation. 
  239. # If set to NO (the default) only methods in the interface are included.
  240. EXTRACT_LOCAL_METHODS  = NO
  241. # If this flag is set to YES, the members of anonymous namespaces will be 
  242. # extracted and appear in the documentation as a namespace called 
  243. # 'anonymous_namespace{file}', where file will be replaced with the base 
  244. # name of the file that contains the anonymous namespace. By default 
  245. # anonymous namespace are hidden.
  246. EXTRACT_ANON_NSPACES   = NO
  247. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
  248. # undocumented members of documented classes, files or namespaces. 
  249. # If set to NO (the default) these members will be included in the 
  250. # various overviews, but no documentation section is generated. 
  251. # This option has no effect if EXTRACT_ALL is enabled.
  252. HIDE_UNDOC_MEMBERS     = YES
  253. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
  254. # undocumented classes that are normally visible in the class hierarchy. 
  255. # If set to NO (the default) these classes will be included in the various 
  256. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  257. HIDE_UNDOC_CLASSES     = NO
  258. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
  259. # friend (class|struct|union) declarations. 
  260. # If set to NO (the default) these declarations will be included in the 
  261. # documentation.
  262. HIDE_FRIEND_COMPOUNDS  = NO
  263. # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
  264. # documentation blocks found inside the body of a function. 
  265. # If set to NO (the default) these blocks will be appended to the 
  266. # function's detailed documentation block.
  267. HIDE_IN_BODY_DOCS      = NO
  268. # The INTERNAL_DOCS tag determines if documentation 
  269. # that is typed after a internal command is included. If the tag is set 
  270. # to NO (the default) then the documentation will be excluded. 
  271. # Set it to YES to include the internal documentation.
  272. INTERNAL_DOCS          = NO
  273. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
  274. # file names in lower-case letters. If set to YES upper-case letters are also 
  275. # allowed. This is useful if you have classes or files whose names only differ 
  276. # in case and if your file system supports case sensitive file names. Windows 
  277. # and Mac users are advised to set this option to NO.
  278. CASE_SENSE_NAMES       = NO
  279. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
  280. # will show members with their full class and namespace scopes in the 
  281. # documentation. If set to YES the scope will be hidden.
  282. HIDE_SCOPE_NAMES       = NO
  283. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
  284. # will put a list of the files that are included by a file in the documentation 
  285. # of that file.
  286. SHOW_INCLUDE_FILES     = YES
  287. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
  288. # is inserted in the documentation for inline members.
  289. INLINE_INFO            = YES
  290. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
  291. # will sort the (detailed) documentation of file and class members 
  292. # alphabetically by member name. If set to NO the members will appear in 
  293. # declaration order.
  294. SORT_MEMBER_DOCS       = YES
  295. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
  296. # brief documentation of file, namespace and class members alphabetically 
  297. # by member name. If set to NO (the default) the members will appear in 
  298. # declaration order.
  299. SORT_BRIEF_DOCS        = NO
  300. # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
  301. # hierarchy of group names into alphabetical order. If set to NO (the default) 
  302. # the group names will appear in their defined order.
  303. SORT_GROUP_NAMES       = NO
  304. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
  305. # sorted by fully-qualified names, including namespaces. If set to 
  306. # NO (the default), the class list will be sorted only by class name, 
  307. # not including the namespace part. 
  308. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
  309. # Note: This option applies only to the class list, not to the 
  310. # alphabetical list.
  311. SORT_BY_SCOPE_NAME     = NO
  312. # The GENERATE_TODOLIST tag can be used to enable (YES) or 
  313. # disable (NO) the todo list. This list is created by putting todo 
  314. # commands in the documentation.
  315. GENERATE_TODOLIST      = YES
  316. # The GENERATE_TESTLIST tag can be used to enable (YES) or 
  317. # disable (NO) the test list. This list is created by putting test 
  318. # commands in the documentation.
  319. GENERATE_TESTLIST      = YES
  320. # The GENERATE_BUGLIST tag can be used to enable (YES) or 
  321. # disable (NO) the bug list. This list is created by putting bug 
  322. # commands in the documentation.
  323. GENERATE_BUGLIST       = YES
  324. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
  325. # disable (NO) the deprecated list. This list is created by putting 
  326. # deprecated commands in the documentation.
  327. GENERATE_DEPRECATEDLIST= YES
  328. # The ENABLED_SECTIONS tag can be used to enable conditional 
  329. # documentation sections, marked by if sectionname ... endif.
  330. ENABLED_SECTIONS       = 
  331. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
  332. # the initial value of a variable or define consists of for it to appear in 
  333. # the documentation. If the initializer consists of more lines than specified 
  334. # here it will be hidden. Use a value of 0 to hide initializers completely. 
  335. # The appearance of the initializer of individual variables and defines in the 
  336. # documentation can be controlled using showinitializer or hideinitializer 
  337. # command in the documentation regardless of this setting.
  338. MAX_INITIALIZER_LINES  = 30
  339. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
  340. # at the bottom of the documentation of classes and structs. If set to YES the 
  341. # list will mention the files that were used to generate the documentation.
  342. SHOW_USED_FILES        = YES
  343. # If the sources in your project are distributed over multiple directories 
  344. # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
  345. # in the documentation. The default is NO.
  346. SHOW_DIRECTORIES       = NO
  347. # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 
  348. # This will remove the Files entry from the Quick Index and from the 
  349. # Folder Tree View (if specified). The default is YES.
  350. SHOW_FILES             = YES
  351. # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
  352. # Namespaces page. 
  353. # This will remove the Namespaces entry from the Quick Index 
  354. # and from the Folder Tree View (if specified). The default is YES.
  355. SHOW_NAMESPACES        = YES
  356. # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
  357. # doxygen should invoke to get the current version for each file (typically from 
  358. # the version control system). Doxygen will invoke the program by executing (via 
  359. # popen()) the command <command> <input-file>, where <command> is the value of 
  360. # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
  361. # provided by doxygen. Whatever the program writes to standard output 
  362. # is used as the file version. See the manual for examples.
  363. FILE_VERSION_FILTER    = 
  364. # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 
  365. # doxygen. The layout file controls the global structure of the generated output files 
  366. # in an output format independent way. The create the layout file that represents 
  367. # doxygen's defaults, run doxygen with the -l option. You can optionally specify a 
  368. # file name after the option, if omitted DoxygenLayout.xml will be used as the name 
  369. # of the layout file.
  370. LAYOUT_FILE            = 
  371. #---------------------------------------------------------------------------
  372. # configuration options related to warning and progress messages
  373. #---------------------------------------------------------------------------
  374. # The QUIET tag can be used to turn on/off the messages that are generated 
  375. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  376. QUIET                  = NO
  377. # The WARNINGS tag can be used to turn on/off the warning messages that are 
  378. # generated by doxygen. Possible values are YES and NO. If left blank 
  379. # NO is used.
  380. WARNINGS               = YES
  381. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
  382. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
  383. # automatically be disabled.
  384. WARN_IF_UNDOCUMENTED   = YES
  385. # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
  386. # potential errors in the documentation, such as not documenting some 
  387. # parameters in a documented function, or documenting parameters that 
  388. # don't exist or using markup commands wrongly.
  389. WARN_IF_DOC_ERROR      = YES
  390. # This WARN_NO_PARAMDOC option can be abled to get warnings for 
  391. # functions that are documented, but have no documentation for their parameters 
  392. # or return value. If set to NO (the default) doxygen will only warn about 
  393. # wrong or incomplete parameter documentation, but not about the absence of 
  394. # documentation.
  395. WARN_NO_PARAMDOC       = NO
  396. # The WARN_FORMAT tag determines the format of the warning messages that 
  397. # doxygen can produce. The string should contain the $file, $line, and $text 
  398. # tags, which will be replaced by the file and line number from which the 
  399. # warning originated and the warning text. Optionally the format may contain 
  400. # $version, which will be replaced by the version of the file (if it could 
  401. # be obtained via FILE_VERSION_FILTER)
  402. WARN_FORMAT            = "$file:$line: $text"
  403. # The WARN_LOGFILE tag can be used to specify a file to which warning 
  404. # and error messages should be written. If left blank the output is written 
  405. # to stderr.
  406. WARN_LOGFILE           = 
  407. #---------------------------------------------------------------------------
  408. # configuration options related to the input files
  409. #---------------------------------------------------------------------------
  410. # The INPUT tag can be used to specify the files and/or directories that contain 
  411. # documented source files. You may enter file names like "myfile.cpp" or 
  412. # directories like "/usr/src/myproject". Separate the files or directories 
  413. # with spaces.
  414. INPUT                  = "../source"
  415. # This tag can be used to specify the character encoding of the source files 
  416. # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
  417. # also the default input encoding. Doxygen uses libiconv (or the iconv built 
  418. # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
  419. # the list of possible encodings.
  420. INPUT_ENCODING         = UTF-8
  421. # If the value of the INPUT tag contains directories, you can use the 
  422. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
  423. # and *.h) to filter out the source-files in the directories. If left 
  424. # blank the following patterns are tested: 
  425. # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
  426. # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
  427. FILE_PATTERNS          = *.h
  428. # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
  429. # should be searched for input files as well. Possible values are YES and NO. 
  430. # If left blank NO is used.
  431. RECURSIVE              = YES
  432. # The EXCLUDE tag can be used to specify files and/or directories that should 
  433. # excluded from the INPUT source files. This way you can easily exclude a 
  434. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  435. EXCLUDE                = 
  436. # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
  437. # directories that are symbolic links (a Unix filesystem feature) are excluded 
  438. # from the input.
  439. EXCLUDE_SYMLINKS       = NO
  440. # If the value of the INPUT tag contains directories, you can use the 
  441. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
  442. # certain files from those directories. Note that the wildcards are matched 
  443. # against the file with absolute path, so to exclude all test directories 
  444. # for example use the pattern */test/*
  445. EXCLUDE_PATTERNS       = 
  446. # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
  447. # (namespaces, classes, functions, etc.) that should be excluded from the 
  448. # output. The symbol name can be a fully qualified name, a word, or if the 
  449. # wildcard * is used, a substring. Examples: ANamespace, AClass, 
  450. # AClass::ANamespace, ANamespace::*Test
  451. EXCLUDE_SYMBOLS        = 
  452. # The EXAMPLE_PATH tag can be used to specify one or more files or 
  453. # directories that contain example code fragments that are included (see 
  454. # the include command).
  455. EXAMPLE_PATH           = 
  456. # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
  457. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
  458. # and *.h) to filter out the source-files in the directories. If left 
  459. # blank all files are included.
  460. EXAMPLE_PATTERNS       = 
  461. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
  462. # searched for input files to be used with the include or dontinclude 
  463. # commands irrespective of the value of the RECURSIVE tag. 
  464. # Possible values are YES and NO. If left blank NO is used.
  465. EXAMPLE_RECURSIVE      = NO
  466. # The IMAGE_PATH tag can be used to specify one or more files or 
  467. # directories that contain image that are included in the documentation (see 
  468. # the image command).
  469. IMAGE_PATH             = 
  470. # The INPUT_FILTER tag can be used to specify a program that doxygen should 
  471. # invoke to filter for each input file. Doxygen will invoke the filter program 
  472. # by executing (via popen()) the command <filter> <input-file>, where <filter> 
  473. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
  474. # input file. Doxygen will then use the output that the filter program writes 
  475. # to standard output. 
  476. # If FILTER_PATTERNS is specified, this tag will be 
  477. # ignored.
  478. INPUT_FILTER           = 
  479. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
  480. # basis. 
  481. # Doxygen will compare the file name with each pattern and apply the 
  482. # filter if there is a match. 
  483. # The filters are a list of the form: 
  484. # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
  485. # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
  486. # is applied to all files.
  487. FILTER_PATTERNS        = 
  488. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
  489. # INPUT_FILTER) will be used to filter the input files when producing source 
  490. # files to browse (i.e. when SOURCE_BROWSER is set to YES).
  491. FILTER_SOURCE_FILES    = NO
  492. #---------------------------------------------------------------------------
  493. # configuration options related to source browsing
  494. #---------------------------------------------------------------------------
  495. # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
  496. # be generated. Documented entities will be cross-referenced with these sources. 
  497. # Note: To get rid of all source code in the generated output, make sure also 
  498. # VERBATIM_HEADERS is set to NO.
  499. SOURCE_BROWSER         = NO
  500. # Setting the INLINE_SOURCES tag to YES will include the body 
  501. # of functions and classes directly in the documentation.
  502. INLINE_SOURCES         = NO
  503. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
  504. # doxygen to hide any special comment blocks from generated source code 
  505. # fragments. Normal C and C++ comments will always remain visible.
  506. STRIP_CODE_COMMENTS    = YES
  507. # If the REFERENCED_BY_RELATION tag is set to YES 
  508. # then for each documented function all documented 
  509. # functions referencing it will be listed.
  510. REFERENCED_BY_RELATION = NO
  511. # If the REFERENCES_RELATION tag is set to YES 
  512. # then for each documented function all documented entities 
  513. # called/used by that function will be listed.
  514. REFERENCES_RELATION    = NO
  515. # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
  516. # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
  517. # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
  518. # link to the source code. 
  519. # Otherwise they will link to the documentation.
  520. REFERENCES_LINK_SOURCE = YES
  521. # If the USE_HTAGS tag is set to YES then the references to source code 
  522. # will point to the HTML generated by the htags(1) tool instead of doxygen 
  523. # built-in source browser. The htags tool is part of GNU's global source 
  524. # tagging system (see http://www.gnu.org/software/global/global.html). You 
  525. # will need version 4.8.6 or higher.
  526. USE_HTAGS              = NO
  527. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
  528. # will generate a verbatim copy of the header file for each class for 
  529. # which an include is specified. Set to NO to disable this.
  530. VERBATIM_HEADERS       = YES
  531. #---------------------------------------------------------------------------
  532. # configuration options related to the alphabetical class index
  533. #---------------------------------------------------------------------------
  534. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
  535. # of all compounds will be generated. Enable this if the project 
  536. # contains a lot of classes, structs, unions or interfaces.
  537. ALPHABETICAL_INDEX     = NO
  538. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
  539. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
  540. # in which this list will be split (can be a number in the range [1..20])
  541. COLS_IN_ALPHA_INDEX    = 5
  542. # In case all classes in a project start with a common prefix, all 
  543. # classes will be put under the same header in the alphabetical index. 
  544. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
  545. # should be ignored while generating the index headers.
  546. IGNORE_PREFIX          = 
  547. #---------------------------------------------------------------------------
  548. # configuration options related to the HTML output
  549. #---------------------------------------------------------------------------
  550. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
  551. # generate HTML output.
  552. GENERATE_HTML          = YES
  553. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
  554. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  555. # put in front of it. If left blank `html' will be used as the default path.
  556. HTML_OUTPUT            = html
  557. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
  558. # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
  559. # doxygen will generate files with .html extension.
  560. HTML_FILE_EXTENSION    = .html
  561. # The HTML_HEADER tag can be used to specify a personal HTML header for 
  562. # each generated HTML page. If it is left blank doxygen will generate a 
  563. # standard header.
  564. HTML_HEADER            = 
  565. # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
  566. # each generated HTML page. If it is left blank doxygen will generate a 
  567. # standard footer.
  568. HTML_FOOTER            = 
  569. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
  570. # style sheet that is used by each HTML page. It can be used to 
  571. # fine-tune the look of the HTML output. If the tag is left blank doxygen 
  572. # will generate a default style sheet. Note that doxygen will try to copy 
  573. # the style sheet file to the HTML output directory, so don't put your own 
  574. # stylesheet in the HTML output directory as well, or it will be erased!
  575. HTML_STYLESHEET        = 
  576. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
  577. # files or namespaces will be aligned in HTML using tables. If set to 
  578. # NO a bullet list will be used.
  579. HTML_ALIGN_MEMBERS     = YES
  580. # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
  581. # documentation will contain sections that can be hidden and shown after the 
  582. # page has loaded. For this to work a browser that supports 
  583. # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
  584. # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
  585. HTML_DYNAMIC_SECTIONS  = NO
  586. # If the GENERATE_DOCSET tag is set to YES, additional index files 
  587. # will be generated that can be used as input for Apple's Xcode 3 
  588. # integrated development environment, introduced with OSX 10.5 (Leopard). 
  589. # To create a documentation set, doxygen will generate a Makefile in the 
  590. # HTML output directory. Running make will produce the docset in that 
  591. # directory and running "make install" will install the docset in 
  592. # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
  593. # it at startup. 
  594. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
  595. GENERATE_DOCSET        = NO
  596. # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
  597. # feed. A documentation feed provides an umbrella under which multiple 
  598. # documentation sets from a single provider (such as a company or product suite) 
  599. # can be grouped.
  600. DOCSET_FEEDNAME        = "Doxygen generated docs"
  601. # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
  602. # should uniquely identify the documentation set bundle. This should be a 
  603. # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
  604. # will append .docset to the name.
  605. DOCSET_BUNDLE_ID       = org.doxygen.Project
  606. # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
  607. # will be generated that can be used as input for tools like the 
  608. # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
  609. # of the generated HTML documentation.
  610. GENERATE_HTMLHELP      = NO
  611. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
  612. # be used to specify the file name of the resulting .chm file. You 
  613. # can add a path in front of the file if the result should not be 
  614. # written to the html output directory.
  615. CHM_FILE               = 
  616. # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
  617. # be used to specify the location (absolute path including file name) of 
  618. # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
  619. # the HTML help compiler on the generated index.hhp.
  620. HHC_LOCATION           = 
  621. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
  622. # controls if a separate .chi index file is generated (YES) or that 
  623. # it should be included in the master .chm file (NO).
  624. GENERATE_CHI           = NO
  625. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
  626. # is used to encode HtmlHelp index (hhk), content (hhc) and project file 
  627. # content.
  628. CHM_INDEX_ENCODING     = 
  629. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
  630. # controls whether a binary table of contents is generated (YES) or a 
  631. # normal table of contents (NO) in the .chm file.
  632. BINARY_TOC             = NO
  633. # The TOC_EXPAND flag can be set to YES to add extra items for group members 
  634. # to the contents of the HTML help documentation and to the tree view.
  635. TOC_EXPAND             = NO
  636. # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 
  637. # are set, an additional index file will be generated that can be used as input for 
  638. # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 
  639. # HTML documentation.
  640. GENERATE_QHP           = NO
  641. # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
  642. # be used to specify the file name of the resulting .qch file. 
  643. # The path specified is relative to the HTML output folder.
  644. QCH_FILE               = 
  645. # The QHP_NAMESPACE tag specifies the namespace to use when generating 
  646. # Qt Help Project output. For more information please see 
  647. # http://doc.trolltech.com/qthelpproject.html#namespace
  648. QHP_NAMESPACE          = 
  649. # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
  650. # Qt Help Project output. For more information please see 
  651. # http://doc.trolltech.com/qthelpproject.html#virtual-folders
  652. QHP_VIRTUAL_FOLDER     = doc
  653. # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 
  654. # For more information please see 
  655. # http://doc.trolltech.com/qthelpproject.html#custom-filters
  656. QHP_CUST_FILTER_NAME   = 
  657. # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 
  658. # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
  659. QHP_CUST_FILTER_ATTRS  = 
  660. # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 
  661. # filter section matches. 
  662. # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
  663. QHP_SECT_FILTER_ATTRS  = 
  664. # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
  665. # be used to specify the location of Qt's qhelpgenerator. 
  666. # If non-empty doxygen will try to run qhelpgenerator on the generated 
  667. # .qhp file.
  668. QHG_LOCATION           = 
  669. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
  670. # top of each HTML page. The value NO (the default) enables the index and 
  671. # the value YES disables it.
  672. DISABLE_INDEX          = NO
  673. # This tag can be used to set the number of enum values (range [1..20]) 
  674. # that doxygen will group on one line in the generated HTML documentation.
  675. ENUM_VALUES_PER_LINE   = 4
  676. # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
  677. # structure should be generated to display hierarchical information. 
  678. # If the tag value is set to FRAME, a side panel will be generated 
  679. # containing a tree-like index structure (just like the one that 
  680. # is generated for HTML Help). For this to work a browser that supports 
  681. # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
  682. # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
  683. # probably better off using the HTML help feature. Other possible values 
  684. # for this tag are: HIERARCHIES, which will generate the Groups, Directories, 
  685. # and Class Hierarchy pages using a tree view instead of an ordered list; 
  686. # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which 
  687. # disables this behavior completely. For backwards compatibility with previous 
  688. # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE 
  689. # respectively.
  690. GENERATE_TREEVIEW      = NONE
  691. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
  692. # used to set the initial width (in pixels) of the frame in which the tree 
  693. # is shown.
  694. TREEVIEW_WIDTH         = 250
  695. # Use this tag to change the font size of Latex formulas included 
  696. # as images in the HTML documentation. The default is 10. Note that 
  697. # when you change the font size after a successful doxygen run you need 
  698. # to manually remove any form_*.png images from the HTML output directory 
  699. # to force them to be regenerated.
  700. FORMULA_FONTSIZE       = 10
  701. #---------------------------------------------------------------------------
  702. # configuration options related to the LaTeX output
  703. #---------------------------------------------------------------------------
  704. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
  705. # generate Latex output.
  706. GENERATE_LATEX         = NO
  707. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
  708. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  709. # put in front of it. If left blank `latex' will be used as the default path.
  710. LATEX_OUTPUT           = latex
  711. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
  712. # invoked. If left blank `latex' will be used as the default command name.
  713. LATEX_CMD_NAME         = latex
  714. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
  715. # generate index for LaTeX. If left blank `makeindex' will be used as the 
  716. # default command name.
  717. MAKEINDEX_CMD_NAME     = makeindex
  718. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
  719. # LaTeX documents. This may be useful for small projects and may help to 
  720. # save some trees in general.
  721. COMPACT_LATEX          = NO
  722. # The PAPER_TYPE tag can be used to set the paper type that is used 
  723. # by the printer. Possible values are: a4, a4wide, letter, legal and 
  724. # executive. If left blank a4wide will be used.
  725. PAPER_TYPE             = a4wide
  726. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
  727. # packages that should be included in the LaTeX output.
  728. EXTRA_PACKAGES         = 
  729. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
  730. # the generated latex document. The header should contain everything until 
  731. # the first chapter. If it is left blank doxygen will generate a 
  732. # standard header. Notice: only use this tag if you know what you are doing!
  733. LATEX_HEADER           = 
  734. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
  735. # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
  736. # contain links (just like the HTML output) instead of page references 
  737. # This makes the output suitable for online browsing using a pdf viewer.
  738. PDF_HYPERLINKS         = YES
  739. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
  740. # plain latex in the generated Makefile. Set this option to YES to get a 
  741. # higher quality PDF documentation.
  742. USE_PDFLATEX           = YES
  743. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode. 
  744. # command to the generated LaTeX files. This will instruct LaTeX to keep 
  745. # running if errors occur, instead of asking the user for help. 
  746. # This option is also used when generating formulas in HTML.
  747. LATEX_BATCHMODE        = NO
  748. # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
  749. # include the index chapters (such as File Index, Compound Index, etc.) 
  750. # in the output.
  751. LATEX_HIDE_INDICES     = NO
  752. #---------------------------------------------------------------------------
  753. # configuration options related to the RTF output
  754. #---------------------------------------------------------------------------
  755. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
  756. # The RTF output is optimized for Word 97 and may not look very pretty with 
  757. # other RTF readers or editors.
  758. GENERATE_RTF           = NO
  759. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
  760. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  761. # put in front of it. If left blank `rtf' will be used as the default path.
  762. RTF_OUTPUT             = rtf
  763. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
  764. # RTF documents. This may be useful for small projects and may help to 
  765. # save some trees in general.
  766. COMPACT_RTF            = NO
  767. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
  768. # will contain hyperlink fields. The RTF file will 
  769. # contain links (just like the HTML output) instead of page references. 
  770. # This makes the output suitable for online browsing using WORD or other 
  771. # programs which support those fields. 
  772. # Note: wordpad (write) and others do not support links.
  773. RTF_HYPERLINKS         = NO
  774. # Load stylesheet definitions from file. Syntax is similar to doxygen's 
  775. # config file, i.e. a series of assignments. You only have to provide 
  776. # replacements, missing definitions are set to their default value.
  777. RTF_STYLESHEET_FILE    = 
  778. # Set optional variables used in the generation of an rtf document. 
  779. # Syntax is similar to doxygen's config file.
  780. RTF_EXTENSIONS_FILE    = 
  781. #---------------------------------------------------------------------------
  782. # configuration options related to the man page output
  783. #---------------------------------------------------------------------------
  784. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
  785. # generate man pages
  786. GENERATE_MAN           = NO
  787. # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
  788. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  789. # put in front of it. If left blank `man' will be used as the default path.
  790. MAN_OUTPUT             = man
  791. # The MAN_EXTENSION tag determines the extension that is added to 
  792. # the generated man pages (default is the subroutine's section .3)
  793. MAN_EXTENSION          = .3
  794. # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
  795. # then it will generate one additional man file for each entity 
  796. # documented in the real man page(s). These additional files 
  797. # only source the real man page, but without them the man command 
  798. # would be unable to find the correct page. The default is NO.
  799. MAN_LINKS              = NO
  800. #---------------------------------------------------------------------------
  801. # configuration options related to the XML output
  802. #---------------------------------------------------------------------------
  803. # If the GENERATE_XML tag is set to YES Doxygen will 
  804. # generate an XML file that captures the structure of 
  805. # the code including all documentation.
  806. GENERATE_XML           = NO
  807. # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
  808. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  809. # put in front of it. If left blank `xml' will be used as the default path.
  810. XML_OUTPUT             = xml
  811. # The XML_SCHEMA tag can be used to specify an XML schema, 
  812. # which can be used by a validating XML parser to check the 
  813. # syntax of the XML files.
  814. XML_SCHEMA             = 
  815. # The XML_DTD tag can be used to specify an XML DTD, 
  816. # which can be used by a validating XML parser to check the 
  817. # syntax of the XML files.
  818. XML_DTD                = 
  819. # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
  820. # dump the program listings (including syntax highlighting 
  821. # and cross-referencing information) to the XML output. Note that 
  822. # enabling this will significantly increase the size of the XML output.
  823. XML_PROGRAMLISTING     = YES
  824. #---------------------------------------------------------------------------
  825. # configuration options for the AutoGen Definitions output
  826. #---------------------------------------------------------------------------
  827. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
  828. # generate an AutoGen Definitions (see autogen.sf.net) file 
  829. # that captures the structure of the code including all 
  830. # documentation. Note that this feature is still experimental 
  831. # and incomplete at the moment.
  832. GENERATE_AUTOGEN_DEF   = NO
  833. #---------------------------------------------------------------------------
  834. # configuration options related to the Perl module output
  835. #---------------------------------------------------------------------------
  836. # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
  837. # generate a Perl module file that captures the structure of 
  838. # the code including all documentation. Note that this 
  839. # feature is still experimental and incomplete at the 
  840. # moment.
  841. GENERATE_PERLMOD       = NO
  842. # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
  843. # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
  844. # to generate PDF and DVI output from the Perl module output.
  845. PERLMOD_LATEX          = NO
  846. # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
  847. # nicely formatted so it can be parsed by a human reader. 
  848. # This is useful 
  849. # if you want to understand what is going on. 
  850. # On the other hand, if this 
  851. # tag is set to NO the size of the Perl module output will be much smaller 
  852. # and Perl will parse it just the same.
  853. PERLMOD_PRETTY         = YES
  854. # The names of the make variables in the generated doxyrules.make file 
  855. # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
  856. # This is useful so different doxyrules.make files included by the same 
  857. # Makefile don't overwrite each other's variables.
  858. PERLMOD_MAKEVAR_PREFIX = 
  859. #---------------------------------------------------------------------------
  860. # Configuration options related to the preprocessor   
  861. #---------------------------------------------------------------------------
  862. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
  863. # evaluate all C-preprocessor directives found in the sources and include 
  864. # files.
  865. ENABLE_PREPROCESSING   = YES
  866. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
  867. # names in the source code. If set to NO (the default) only conditional 
  868. # compilation will be performed. Macro expansion can be done in a controlled 
  869. # way by setting EXPAND_ONLY_PREDEF to YES.
  870. MACRO_EXPANSION        = NO
  871. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
  872. # then the macro expansion is limited to the macros specified with the 
  873. # PREDEFINED and EXPAND_AS_DEFINED tags.
  874. EXPAND_ONLY_PREDEF     = NO
  875. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
  876. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  877. SEARCH_INCLUDES        = YES
  878. # The INCLUDE_PATH tag can be used to specify one or more directories that 
  879. # contain include files that are not input files but should be processed by 
  880. # the preprocessor.
  881. INCLUDE_PATH           = 
  882. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
  883. # patterns (like *.h and *.hpp) to filter out the header-files in the 
  884. # directories. If left blank, the patterns specified with FILE_PATTERNS will 
  885. # be used.
  886. INCLUDE_FILE_PATTERNS  = 
  887. # The PREDEFINED tag can be used to specify one or more macro names that 
  888. # are defined before the preprocessor is started (similar to the -D option of 
  889. # gcc). The argument of the tag is a list of macros of the form: name 
  890. # or name=definition (no spaces). If the definition and the = are 
  891. # omitted =1 is assumed. To prevent a macro definition from being 
  892. # undefined via #undef or recursively expanded use the := operator 
  893. # instead of the = operator.
  894. PREDEFINED             = 
  895. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
  896. # this tag can be used to specify a list of macro names that should be expanded. 
  897. # The macro definition that is found in the sources will be used. 
  898. # Use the PREDEFINED tag if you want to use a different macro definition.
  899. EXPAND_AS_DEFINED      = 
  900. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
  901. # doxygen's preprocessor will remove all function-like macros that are alone 
  902. # on a line, have an all uppercase name, and do not end with a semicolon. Such 
  903. # function macros are typically used for boiler-plate code, and will confuse 
  904. # the parser if not removed.
  905. SKIP_FUNCTION_MACROS   = YES
  906. #---------------------------------------------------------------------------
  907. # Configuration::additions related to external references   
  908. #---------------------------------------------------------------------------
  909. # The TAGFILES option can be used to specify one or more tagfiles. 
  910. # Optionally an initial location of the external documentation 
  911. # can be added for each tagfile. The format of a tag file without 
  912. # this location is as follows: 
  913. #  
  914. # TAGFILES = file1 file2 ... 
  915. # Adding location for the tag files is done as follows: 
  916. #  
  917. # TAGFILES = file1=loc1 "file2 = loc2" ... 
  918. # where "loc1" and "loc2" can be relative or absolute paths or 
  919. # URLs. If a location is present for each tag, the installdox tool 
  920. # does not have to be run to correct the links. 
  921. # Note that each tag file must have a unique name 
  922. # (where the name does NOT include the path) 
  923. # If a tag file is not located in the directory in which doxygen 
  924. # is run, you must also specify the path to the tagfile here.
  925. TAGFILES               = 
  926. # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
  927. # a tag file that is based on the input files it reads.
  928. GENERATE_TAGFILE       = 
  929. # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
  930. # in the class index. If set to NO only the inherited external classes 
  931. # will be listed.
  932. ALLEXTERNALS           = NO
  933. # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
  934. # in the modules index. If set to NO, only the current project's groups will 
  935. # be listed.
  936. EXTERNAL_GROUPS        = YES
  937. # The PERL_PATH should be the absolute path and name of the perl script 
  938. # interpreter (i.e. the result of `which perl').
  939. PERL_PATH              = /usr/bin/perl
  940. #---------------------------------------------------------------------------
  941. # Configuration options related to the dot tool   
  942. #---------------------------------------------------------------------------
  943. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
  944. # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
  945. # or super classes. Setting the tag to NO turns the diagrams off. Note that 
  946. # this option is superseded by the HAVE_DOT option below. This is only a 
  947. # fallback. It is recommended to install and use dot, since it yields more 
  948. # powerful graphs.
  949. CLASS_DIAGRAMS         = YES
  950. # You can define message sequence charts within doxygen comments using the msc 
  951. # command. Doxygen will then run the mscgen tool (see 
  952. # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
  953. # documentation. The MSCGEN_PATH tag allows you to specify the directory where 
  954. # the mscgen tool resides. If left empty the tool is assumed to be found in the 
  955. # default search path.
  956. MSCGEN_PATH            = 
  957. # If set to YES, the inheritance and collaboration graphs will hide 
  958. # inheritance and usage relations if the target is undocumented 
  959. # or is not a class.
  960. HIDE_UNDOC_RELATIONS   = YES
  961. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
  962. # available from the path. This tool is part of Graphviz, a graph visualization 
  963. # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
  964. # have no effect if this option is set to NO (the default)
  965. HAVE_DOT               = NO
  966. # By default doxygen will write a font called FreeSans.ttf to the output 
  967. # directory and reference it in all dot files that doxygen generates. This 
  968. # font does not include all possible unicode characters however, so when you need 
  969. # these (or just want a differently looking font) you can specify the font name 
  970. # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
  971. # which can be done by putting it in a standard location or by setting the 
  972. # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
  973. # containing the font.
  974. DOT_FONTNAME           = FreeSans
  975. # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 
  976. # The default size is 10pt.
  977. DOT_FONTSIZE           = 10
  978. # By default doxygen will tell dot to use the output directory to look for the 
  979. # FreeSans.ttf font (which doxygen will put there itself). If you specify a 
  980. # different font using DOT_FONTNAME you can set the path where dot 
  981. # can find it using this tag.
  982. DOT_FONTPATH           = 
  983. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
  984. # will generate a graph for each documented class showing the direct and 
  985. # indirect inheritance relations. Setting this tag to YES will force the 
  986. # the CLASS_DIAGRAMS tag to NO.
  987. CLASS_GRAPH            = YES
  988. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
  989. # will generate a graph for each documented class showing the direct and 
  990. # indirect implementation dependencies (inheritance, containment, and 
  991. # class references variables) of the class with other documented classes.
  992. COLLABORATION_GRAPH    = YES
  993. # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
  994. # will generate a graph for groups, showing the direct groups dependencies
  995. GROUP_GRAPHS           = YES
  996. # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
  997. # collaboration diagrams in a style similar to the OMG's Unified Modeling 
  998. # Language.
  999. UML_LOOK               = NO
  1000. # If set to YES, the inheritance and collaboration graphs will show the 
  1001. # relations between templates and their instances.
  1002. TEMPLATE_RELATIONS     = NO
  1003. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
  1004. # tags are set to YES then doxygen will generate a graph for each documented 
  1005. # file showing the direct and indirect include dependencies of the file with 
  1006. # other documented files.
  1007. INCLUDE_GRAPH          = YES
  1008. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
  1009. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
  1010. # documented header file showing the documented files that directly or 
  1011. # indirectly include this file.
  1012. INCLUDED_BY_GRAPH      = YES
  1013. # If the CALL_GRAPH and HAVE_DOT options are set to YES then 
  1014. # doxygen will generate a call dependency graph for every global function 
  1015. # or class method. Note that enabling this option will significantly increase 
  1016. # the time of a run. So in most cases it will be better to enable call graphs 
  1017. # for selected functions only using the callgraph command.
  1018. CALL_GRAPH             = NO
  1019. # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
  1020. # doxygen will generate a caller dependency graph for every global function 
  1021. # or class method. Note that enabling this option will significantly increase 
  1022. # the time of a run. So in most cases it will be better to enable caller 
  1023. # graphs for selected functions only using the callergraph command.
  1024. CALLER_GRAPH           = NO
  1025. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
  1026. # will graphical hierarchy of all classes instead of a textual one.
  1027. GRAPHICAL_HIERARCHY    = YES
  1028. # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
  1029. # then doxygen will show the dependencies a directory has on other directories 
  1030. # in a graphical way. The dependency relations are determined by the #include 
  1031. # relations between the files in the directories.
  1032. DIRECTORY_GRAPH        = YES
  1033. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
  1034. # generated by dot. Possible values are png, jpg, or gif 
  1035. # If left blank png will be used.
  1036. DOT_IMAGE_FORMAT       = png
  1037. # The tag DOT_PATH can be used to specify the path where the dot tool can be 
  1038. # found. If left blank, it is assumed the dot tool can be found in the path.
  1039. DOT_PATH               = 
  1040. # The DOTFILE_DIRS tag can be used to specify one or more directories that 
  1041. # contain dot files that are included in the documentation (see the 
  1042. # dotfile command).
  1043. DOTFILE_DIRS           = 
  1044. # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
  1045. # nodes that will be shown in the graph. If the number of nodes in a graph 
  1046. # becomes larger than this value, doxygen will truncate the graph, which is 
  1047. # visualized by representing a node as a red box. Note that doxygen if the 
  1048. # number of direct children of the root node in a graph is already larger than 
  1049. # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
  1050. # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  1051. DOT_GRAPH_MAX_NODES    = 50
  1052. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
  1053. # graphs generated by dot. A depth value of 3 means that only nodes reachable 
  1054. # from the root by following a path via at most 3 edges will be shown. Nodes 
  1055. # that lay further from the root node will be omitted. Note that setting this 
  1056. # option to 1 or 2 may greatly reduce the computation time needed for large 
  1057. # code bases. Also note that the size of a graph can be further restricted by 
  1058. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  1059. MAX_DOT_GRAPH_DEPTH    = 0
  1060. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
  1061. # background. This is disabled by default, because dot on Windows does not 
  1062. # seem to support this out of the box. Warning: Depending on the platform used, 
  1063. # enabling this option may lead to badly anti-aliased labels on the edges of 
  1064. # a graph (i.e. they become hard to read).
  1065. DOT_TRANSPARENT        = NO
  1066. # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
  1067. # files in one run (i.e. multiple -o and -T options on the command line). This 
  1068. # makes dot run faster, but since only newer versions of dot (>1.8.10) 
  1069. # support this, this feature is disabled by default.
  1070. DOT_MULTI_TARGETS      = NO
  1071. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
  1072. # generate a legend page explaining the meaning of the various boxes and 
  1073. # arrows in the dot generated graphs.
  1074. GENERATE_LEGEND        = YES
  1075. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
  1076. # remove the intermediate dot files that are used to generate 
  1077. # the various graphs.
  1078. DOT_CLEANUP            = YES
  1079. #---------------------------------------------------------------------------
  1080. # Options related to the search engine
  1081. #---------------------------------------------------------------------------
  1082. # The SEARCHENGINE tag specifies whether or not a search engine should be 
  1083. # used. If set to NO the values of all tags below this one will be ignored.
  1084. SEARCHENGINE           = NO