Doxyfile.test
上传用户:romrleung
上传日期:2022-05-23
资源大小:18897k
文件大小:36k
源码类别:

MySQL数据库

开发平台:

Visual C++

  1. # Doxyfile 1.2.14
  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. # General 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           = "NDB Cluster Test Programs"
  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         = 
  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       =
  26. # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
  27. # documentation generated by doxygen is written. Doxygen will use this 
  28. # information to generate all constant output in the proper language. 
  29. # The default language is English, other supported languages are: 
  30. # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, 
  31. # German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, 
  32. # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
  33. OUTPUT_LANGUAGE        = English
  34. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
  35. # documentation are documented, even if no documentation was available. 
  36. # Private class members and static file members will be hidden unless 
  37. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  38. EXTRACT_ALL            = YES
  39. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
  40. # will be included in the documentation.
  41. EXTRACT_PRIVATE        = YES
  42. # If the EXTRACT_STATIC tag is set to YES all static members of a file 
  43. # will be included in the documentation.
  44. EXTRACT_STATIC         = YES
  45. # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
  46. # defined locally in source files will be included in the documentation. 
  47. # If set to NO only classes defined in header files are included.
  48. EXTRACT_LOCAL_CLASSES  = YES
  49. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
  50. # undocumented members of documented classes, files or namespaces. 
  51. # If set to NO (the default) these members will be included in the 
  52. # various overviews, but no documentation section is generated. 
  53. # This option has no effect if EXTRACT_ALL is enabled.
  54. HIDE_UNDOC_MEMBERS     = NO
  55. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
  56. # undocumented classes that are normally visible in the class hierarchy. 
  57. # If set to NO (the default) these class will be included in the various 
  58. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  59. HIDE_UNDOC_CLASSES     = NO
  60. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
  61. # include brief member descriptions after the members that are listed in 
  62. # the file and class documentation (similar to JavaDoc). 
  63. # Set to NO to disable this.
  64. BRIEF_MEMBER_DESC      = YES
  65. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
  66. # the brief description of a member or function before the detailed description. 
  67. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
  68. # brief descriptions will be completely suppressed.
  69. REPEAT_BRIEF           = YES
  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. It is allowed to use relative paths in the argument list.
  87. STRIP_FROM_PATH        = .
  88. # The INTERNAL_DOCS tag determines if documentation 
  89. # that is typed after a internal command is included. If the tag is set 
  90. # to NO (the default) then the documentation will be excluded. 
  91. # Set it to YES to include the internal documentation.
  92. INTERNAL_DOCS          = YES
  93. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
  94. # doxygen to hide any special comment blocks from generated source code 
  95. # fragments. Normal C and C++ comments will always remain visible.
  96. STRIP_CODE_COMMENTS    = YES
  97. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
  98. # file names in lower case letters. If set to YES upper case letters are also 
  99. # allowed. This is useful if you have classes or files whose names only differ 
  100. # in case and if your file system supports case sensitive file names. Windows 
  101. # users are adviced to set this option to NO.
  102. CASE_SENSE_NAMES       = YES
  103. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
  104. # (but less readable) file names. This can be useful is your file systems 
  105. # doesn't support long names like on DOS, Mac, or CD-ROM.
  106. SHORT_NAMES            = NO
  107. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
  108. # will show members with their full class and namespace scopes in the 
  109. # documentation. If set to YES the scope will be hidden.
  110. HIDE_SCOPE_NAMES       = NO
  111. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
  112. # will generate a verbatim copy of the header file for each class for 
  113. # which an include is specified. Set to NO to disable this.
  114. VERBATIM_HEADERS       = YES
  115. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
  116. # will put list of the files that are included by a file in the documentation 
  117. # of that file.
  118. SHOW_INCLUDE_FILES     = YES
  119. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
  120. # will interpret the first line (until the first dot) of a JavaDoc-style 
  121. # comment as the brief description. If set to NO, the JavaDoc 
  122. # comments  will behave just like the Qt-style comments (thus requiring an 
  123. # explict @brief command for a brief description.
  124. JAVADOC_AUTOBRIEF      = NO
  125. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
  126. # member inherits the documentation from any documented member that it 
  127. # reimplements.
  128. INHERIT_DOCS           = YES
  129. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
  130. # is inserted in the documentation for inline members.
  131. INLINE_INFO            = YES
  132. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
  133. # will sort the (detailed) documentation of file and class members 
  134. # alphabetically by member name. If set to NO the members will appear in 
  135. # declaration order.
  136. SORT_MEMBER_DOCS       = YES
  137. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
  138. # tag is set to YES, then doxygen will reuse the documentation of the first 
  139. # member in the group (if any) for the other members of the group. By default 
  140. # all members of a group must be documented explicitly.
  141. DISTRIBUTE_GROUP_DOC   = NO
  142. # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
  143. # Doxygen uses this value to replace tabs by spaces in code fragments.
  144. TAB_SIZE               = 8
  145. # The GENERATE_TODOLIST tag can be used to enable (YES) or 
  146. # disable (NO) the todo list. This list is created by putting todo 
  147. # commands in the documentation.
  148. GENERATE_TODOLIST      = YES
  149. # The GENERATE_TESTLIST tag can be used to enable (YES) or 
  150. # disable (NO) the test list. This list is created by putting test 
  151. # commands in the documentation.
  152. GENERATE_TESTLIST      = YES
  153. # The GENERATE_BUGLIST tag can be used to enable (YES) or 
  154. # disable (NO) the bug list. This list is created by putting bug 
  155. # commands in the documentation.
  156. GENERATE_BUGLIST       = YES
  157. # This tag can be used to specify a number of aliases that acts 
  158. # as commands in the documentation. An alias has the form "name=value". 
  159. # For example adding "sideeffect=par Side Effects:n" will allow you to 
  160. # put the command sideeffect (or @sideeffect) in the documentation, which 
  161. # will result in a user defined paragraph with heading "Side Effects:". 
  162. # You can put n's in the value part of an alias to insert newlines.
  163. ALIASES                = 
  164. # The ENABLED_SECTIONS tag can be used to enable conditional 
  165. # documentation sections, marked by if sectionname ... endif.
  166. ENABLED_SECTIONS       = 
  167. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
  168. # the initial value of a variable or define consist of for it to appear in 
  169. # the documentation. If the initializer consists of more lines than specified 
  170. # here it will be hidden. Use a value of 0 to hide initializers completely. 
  171. # The appearance of the initializer of individual variables and defines in the 
  172. # documentation can be controlled using showinitializer or hideinitializer 
  173. # command in the documentation regardless of this setting.
  174. MAX_INITIALIZER_LINES  = 30
  175. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
  176. # only. Doxygen will then generate output that is more tailored for C. 
  177. # For instance some of the names that are used will be different. The list 
  178. # of all members will be omitted, etc.
  179. OPTIMIZE_OUTPUT_FOR_C  = NO
  180. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
  181. # at the bottom of the documentation of classes and structs. If set to YES the 
  182. # list will mention the files that were used to generate the documentation.
  183. SHOW_USED_FILES        = YES
  184. #---------------------------------------------------------------------------
  185. # configuration options related to warning and progress messages
  186. #---------------------------------------------------------------------------
  187. # The QUIET tag can be used to turn on/off the messages that are generated 
  188. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  189. QUIET                  = NO
  190. # The WARNINGS tag can be used to turn on/off the warning messages that are 
  191. # generated by doxygen. Possible values are YES and NO. If left blank 
  192. # NO is used.
  193. WARNINGS               = YES
  194. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
  195. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
  196. # automatically be disabled.
  197. WARN_IF_UNDOCUMENTED   = YES
  198. # The WARN_FORMAT tag determines the format of the warning messages that 
  199. # doxygen can produce. The string should contain the $file, $line, and $text 
  200. # tags, which will be replaced by the file and line number from which the 
  201. # warning originated and the warning text.
  202. WARN_FORMAT            = "$file:$line: $text"
  203. # The WARN_LOGFILE tag can be used to specify a file to which warning 
  204. # and error messages should be written. If left blank the output is written 
  205. # to stderr.
  206. WARN_LOGFILE           = 
  207. #---------------------------------------------------------------------------
  208. # configuration options related to the input files
  209. #---------------------------------------------------------------------------
  210. # The INPUT tag can be used to specify the files and/or directories that contain 
  211. # documented source files. You may enter file names like "myfile.cpp" or 
  212. # directories like "/usr/src/myproject". Separate the files or directories 
  213. # with spaces.
  214. INPUT                  = test
  215. # If the value of the INPUT tag contains directories, you can use the 
  216. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
  217. # and *.h) to filter out the source-files in the directories. If left 
  218. # blank the following patterns are tested: 
  219. # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
  220. # *.h++ *.idl *.odl
  221. FILE_PATTERNS          = 
  222. # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
  223. # should be searched for input files as well. Possible values are YES and NO. 
  224. # If left blank NO is used.
  225. RECURSIVE              = YES
  226. # The EXCLUDE tag can be used to specify files and/or directories that should 
  227. # excluded from the INPUT source files. This way you can easily exclude a 
  228. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  229. EXCLUDE                = 
  230. # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 
  231. # that are symbolic links (a Unix filesystem feature) are excluded from the input.
  232. EXCLUDE_SYMLINKS       = NO
  233. # If the value of the INPUT tag contains directories, you can use the 
  234. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
  235. # certain files from those directories.
  236. EXCLUDE_PATTERNS       = 
  237. # The EXAMPLE_PATH tag can be used to specify one or more files or 
  238. # directories that contain example code fragments that are included (see 
  239. # the include command).
  240. EXAMPLE_PATH           = 
  241. # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
  242. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
  243. # and *.h) to filter out the source-files in the directories. If left 
  244. # blank all files are included.
  245. EXAMPLE_PATTERNS       = 
  246. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
  247. # searched for input files to be used with the include or dontinclude 
  248. # commands irrespective of the value of the RECURSIVE tag. 
  249. # Possible values are YES and NO. If left blank NO is used.
  250. EXAMPLE_RECURSIVE      = NO
  251. # The IMAGE_PATH tag can be used to specify one or more files or 
  252. # directories that contain image that are included in the documentation (see 
  253. # the image command).
  254. IMAGE_PATH             = 
  255. # The INPUT_FILTER tag can be used to specify a program that doxygen should 
  256. # invoke to filter for each input file. Doxygen will invoke the filter program 
  257. # by executing (via popen()) the command <filter> <input-file>, where <filter> 
  258. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
  259. # input file. Doxygen will then use the output that the filter program writes 
  260. # to standard output.
  261. INPUT_FILTER           = 
  262. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
  263. # INPUT_FILTER) will be used to filter the input files when producing source 
  264. # files to browse.
  265. FILTER_SOURCE_FILES    = NO
  266. #---------------------------------------------------------------------------
  267. # configuration options related to source browsing
  268. #---------------------------------------------------------------------------
  269. # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
  270. # be generated. Documented entities will be cross-referenced with these sources.
  271. SOURCE_BROWSER         = YES
  272. # Setting the INLINE_SOURCES tag to YES will include the body 
  273. # of functions and classes directly in the documentation.
  274. INLINE_SOURCES         = YES
  275. # If the REFERENCED_BY_RELATION tag is set to YES (the default) 
  276. # then for each documented function all documented 
  277. # functions referencing it will be listed.
  278. REFERENCED_BY_RELATION = YES
  279. # If the REFERENCES_RELATION tag is set to YES (the default) 
  280. # then for each documented function all documented entities 
  281. # called/used by that function will be listed.
  282. REFERENCES_RELATION    = YES
  283. #---------------------------------------------------------------------------
  284. # configuration options related to the alphabetical class index
  285. #---------------------------------------------------------------------------
  286. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
  287. # of all compounds will be generated. Enable this if the project 
  288. # contains a lot of classes, structs, unions or interfaces.
  289. ALPHABETICAL_INDEX     = YES
  290. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
  291. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
  292. # in which this list will be split (can be a number in the range [1..20])
  293. COLS_IN_ALPHA_INDEX    = 5
  294. # In case all classes in a project start with a common prefix, all 
  295. # classes will be put under the same header in the alphabetical index. 
  296. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
  297. # should be ignored while generating the index headers.
  298. IGNORE_PREFIX          = 
  299. #---------------------------------------------------------------------------
  300. # configuration options related to the HTML output
  301. #---------------------------------------------------------------------------
  302. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
  303. # generate HTML output.
  304. GENERATE_HTML          = YES
  305. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
  306. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  307. # put in front of it. If left blank `html' will be used as the default path.
  308. HTML_OUTPUT            = html
  309. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
  310. # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
  311. # doxygen will generate files with .html extension.
  312. HTML_FILE_EXTENSION    = .html
  313. # The HTML_HEADER tag can be used to specify a personal HTML header for 
  314. # each generated HTML page. If it is left blank doxygen will generate a 
  315. # standard header.
  316. HTML_HEADER            = 
  317. # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
  318. # each generated HTML page. If it is left blank doxygen will generate a 
  319. # standard footer.
  320. HTML_FOOTER            = 
  321. # The HTML_STYLESHEET tag can be used to specify a user defined cascading 
  322. # style sheet that is used by each HTML page. It can be used to 
  323. # fine-tune the look of the HTML output. If the tag is left blank doxygen 
  324. # will generate a default style sheet
  325. HTML_STYLESHEET        = 
  326. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
  327. # files or namespaces will be aligned in HTML using tables. If set to 
  328. # NO a bullet list will be used.
  329. HTML_ALIGN_MEMBERS     = YES
  330. # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
  331. # will be generated that can be used as input for tools like the 
  332. # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
  333. # of the generated HTML documentation.
  334. GENERATE_HTMLHELP      = NO
  335. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
  336. # controls if a separate .chi index file is generated (YES) or that 
  337. # it should be included in the master .chm file (NO).
  338. GENERATE_CHI           = NO
  339. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
  340. # controls whether a binary table of contents is generated (YES) or a 
  341. # normal table of contents (NO) in the .chm file.
  342. BINARY_TOC             = NO
  343. # The TOC_EXPAND flag can be set to YES to add extra items for group members 
  344. # to the contents of the Html help documentation and to the tree view.
  345. TOC_EXPAND             = NO
  346. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
  347. # top of each HTML page. The value NO (the default) enables the index and 
  348. # the value YES disables it.
  349. DISABLE_INDEX          = NO
  350. # This tag can be used to set the number of enum values (range [1..20]) 
  351. # that doxygen will group on one line in the generated HTML documentation.
  352. ENUM_VALUES_PER_LINE   = 4
  353. # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
  354. # generated containing a tree-like index structure (just like the one that 
  355. # is generated for HTML Help). For this to work a browser that supports 
  356. # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, 
  357. # or Internet explorer 4.0+). Note that for large projects the tree generation 
  358. # can take a very long time. In such cases it is better to disable this feature. 
  359. # Windows users are probably better off using the HTML help feature.
  360. GENERATE_TREEVIEW      = NO
  361. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
  362. # used to set the initial width (in pixels) of the frame in which the tree 
  363. # is shown.
  364. TREEVIEW_WIDTH         = 250
  365. #---------------------------------------------------------------------------
  366. # configuration options related to the LaTeX output
  367. #---------------------------------------------------------------------------
  368. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
  369. # generate Latex output.
  370. GENERATE_LATEX         = NO
  371. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
  372. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  373. # put in front of it. If left blank `latex' will be used as the default path.
  374. LATEX_OUTPUT           = latex
  375. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
  376. # LaTeX documents. This may be useful for small projects and may help to 
  377. # save some trees in general.
  378. COMPACT_LATEX          = NO
  379. # The PAPER_TYPE tag can be used to set the paper type that is used 
  380. # by the printer. Possible values are: a4, a4wide, letter, legal and 
  381. # executive. If left blank a4wide will be used.
  382. PAPER_TYPE             = a4wide
  383. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
  384. # packages that should be included in the LaTeX output.
  385. EXTRA_PACKAGES         = 
  386. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
  387. # the generated latex document. The header should contain everything until 
  388. # the first chapter. If it is left blank doxygen will generate a 
  389. # standard header. Notice: only use this tag if you know what you are doing!
  390. LATEX_HEADER           = 
  391. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
  392. # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
  393. # contain links (just like the HTML output) instead of page references 
  394. # This makes the output suitable for online browsing using a pdf viewer.
  395. PDF_HYPERLINKS         = NO
  396. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
  397. # plain latex in the generated Makefile. Set this option to YES to get a 
  398. # higher quality PDF documentation.
  399. USE_PDFLATEX           = NO
  400. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode. 
  401. # command to the generated LaTeX files. This will instruct LaTeX to keep 
  402. # running if errors occur, instead of asking the user for help. 
  403. # This option is also used when generating formulas in HTML.
  404. LATEX_BATCHMODE        = NO
  405. #---------------------------------------------------------------------------
  406. # configuration options related to the RTF output
  407. #---------------------------------------------------------------------------
  408. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
  409. # The RTF output is optimised for Word 97 and may not look very pretty with 
  410. # other RTF readers or editors.
  411. GENERATE_RTF           = NO
  412. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
  413. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  414. # put in front of it. If left blank `rtf' will be used as the default path.
  415. RTF_OUTPUT             = rtf
  416. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
  417. # RTF documents. This may be useful for small projects and may help to 
  418. # save some trees in general.
  419. COMPACT_RTF            = NO
  420. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
  421. # will contain hyperlink fields. The RTF file will 
  422. # contain links (just like the HTML output) instead of page references. 
  423. # This makes the output suitable for online browsing using WORD or other 
  424. # programs which support those fields. 
  425. # Note: wordpad (write) and others do not support links.
  426. RTF_HYPERLINKS         = NO
  427. # Load stylesheet definitions from file. Syntax is similar to doxygen's 
  428. # config file, i.e. a series of assigments. You only have to provide 
  429. # replacements, missing definitions are set to their default value.
  430. RTF_STYLESHEET_FILE    = 
  431. # Set optional variables used in the generation of an rtf document. 
  432. # Syntax is similar to doxygen's config file.
  433. RTF_EXTENSIONS_FILE    = 
  434. #---------------------------------------------------------------------------
  435. # configuration options related to the man page output
  436. #---------------------------------------------------------------------------
  437. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
  438. # generate man pages
  439. GENERATE_MAN           = NO
  440. # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
  441. # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
  442. # put in front of it. If left blank `man' will be used as the default path.
  443. MAN_OUTPUT             = man
  444. # The MAN_EXTENSION tag determines the extension that is added to 
  445. # the generated man pages (default is the subroutine's section .3)
  446. MAN_EXTENSION          = .3
  447. # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
  448. # then it will generate one additional man file for each entity 
  449. # documented in the real man page(s). These additional files 
  450. # only source the real man page, but without them the man command 
  451. # would be unable to find the correct page. The default is NO.
  452. MAN_LINKS              = NO
  453. #---------------------------------------------------------------------------
  454. # configuration options related to the XML output
  455. #---------------------------------------------------------------------------
  456. # If the GENERATE_XML tag is set to YES Doxygen will 
  457. # generate an XML file that captures the structure of 
  458. # the code including all documentation. Note that this 
  459. # feature is still experimental and incomplete at the 
  460. # moment.
  461. GENERATE_XML           = NO
  462. #---------------------------------------------------------------------------
  463. # configuration options for the AutoGen Definitions output
  464. #---------------------------------------------------------------------------
  465. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
  466. # generate an AutoGen Definitions (see autogen.sf.net) file 
  467. # that captures the structure of the code including all 
  468. # documentation. Note that this feature is still experimental 
  469. # and incomplete at the moment.
  470. GENERATE_AUTOGEN_DEF   = NO
  471. #---------------------------------------------------------------------------
  472. # Configuration options related to the preprocessor   
  473. #---------------------------------------------------------------------------
  474. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
  475. # evaluate all C-preprocessor directives found in the sources and include 
  476. # files.
  477. ENABLE_PREPROCESSING   = YES
  478. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
  479. # names in the source code. If set to NO (the default) only conditional 
  480. # compilation will be performed. Macro expansion can be done in a controlled 
  481. # way by setting EXPAND_ONLY_PREDEF to YES.
  482. MACRO_EXPANSION        = NO
  483. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
  484. # then the macro expansion is limited to the macros specified with the 
  485. # PREDEFINED and EXPAND_AS_PREDEFINED tags.
  486. EXPAND_ONLY_PREDEF     = NO
  487. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
  488. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  489. SEARCH_INCLUDES        = YES
  490. # The INCLUDE_PATH tag can be used to specify one or more directories that 
  491. # contain include files that are not input files but should be processed by 
  492. # the preprocessor.
  493. INCLUDE_PATH           = 
  494. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
  495. # patterns (like *.h and *.hpp) to filter out the header-files in the 
  496. # directories. If left blank, the patterns specified with FILE_PATTERNS will 
  497. # be used.
  498. INCLUDE_FILE_PATTERNS  = 
  499. # The PREDEFINED tag can be used to specify one or more macro names that 
  500. # are defined before the preprocessor is started (similar to the -D option of 
  501. # gcc). The argument of the tag is a list of macros of the form: name 
  502. # or name=definition (no spaces). If the definition and the = are 
  503. # omitted =1 is assumed.
  504. PREDEFINED             = 
  505. # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 
  506. # this tag can be used to specify a list of macro names that should be expanded. 
  507. # The macro definition that is found in the sources will be used. 
  508. # Use the PREDEFINED tag if you want to use a different macro definition.
  509. EXPAND_AS_DEFINED      = 
  510. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
  511. # doxygen's preprocessor will remove all function-like macros that are alone 
  512. # on a line and do not end with a semicolon. Such function macros are typically 
  513. # used for boiler-plate code, and will confuse the parser if not removed.
  514. SKIP_FUNCTION_MACROS   = YES
  515. #---------------------------------------------------------------------------
  516. # Configuration::addtions related to external references   
  517. #---------------------------------------------------------------------------
  518. # The TAGFILES tag can be used to specify one or more tagfiles.
  519. TAGFILES               = 
  520. # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
  521. # a tag file that is based on the input files it reads.
  522. GENERATE_TAGFILE       = 
  523. # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
  524. # in the class index. If set to NO only the inherited external classes 
  525. # will be listed.
  526. ALLEXTERNALS           = NO
  527. # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
  528. # in the modules index. If set to NO, only the current project's groups will 
  529. # be listed.
  530. EXTERNAL_GROUPS        = YES
  531. # The PERL_PATH should be the absolute path and name of the perl script 
  532. # interpreter (i.e. the result of `which perl').
  533. PERL_PATH              = /usr/bin/perl
  534. #---------------------------------------------------------------------------
  535. # Configuration options related to the dot tool   
  536. #---------------------------------------------------------------------------
  537. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
  538. # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or 
  539. # super classes. Setting the tag to NO turns the diagrams off. Note that this 
  540. # option is superceded by the HAVE_DOT option below. This is only a fallback. It is 
  541. # recommended to install and use dot, since it yield more powerful graphs.
  542. CLASS_DIAGRAMS         = YES
  543. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
  544. # available from the path. This tool is part of Graphviz, a graph visualization 
  545. # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
  546. # have no effect if this option is set to NO (the default)
  547. HAVE_DOT               = YES
  548. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
  549. # will generate a graph for each documented class showing the direct and 
  550. # indirect inheritance relations. Setting this tag to YES will force the 
  551. # the CLASS_DIAGRAMS tag to NO.
  552. CLASS_GRAPH            = YES
  553. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
  554. # will generate a graph for each documented class showing the direct and 
  555. # indirect implementation dependencies (inheritance, containment, and 
  556. # class references variables) of the class with other documented classes.
  557. COLLABORATION_GRAPH    = YES
  558. # If set to YES, the inheritance and collaboration graphs will show the 
  559. # relations between templates and their instances.
  560. TEMPLATE_RELATIONS     = YES
  561. # If set to YES, the inheritance and collaboration graphs will hide 
  562. # inheritance and usage relations if the target is undocumented 
  563. # or is not a class.
  564. HIDE_UNDOC_RELATIONS   = NO
  565. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
  566. # tags are set to YES then doxygen will generate a graph for each documented 
  567. # file showing the direct and indirect include dependencies of the file with 
  568. # other documented files.
  569. INCLUDE_GRAPH          = YES
  570. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
  571. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
  572. # documented header file showing the documented files that directly or 
  573. # indirectly include this file.
  574. INCLUDED_BY_GRAPH      = YES
  575. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
  576. # will graphical hierarchy of all classes instead of a textual one.
  577. GRAPHICAL_HIERARCHY    = YES
  578. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
  579. # generated by dot. Possible values are gif, jpg, and png
  580. # If left blank gif will be used.
  581. DOT_IMAGE_FORMAT       = gif
  582. # The tag DOT_PATH can be used to specify the path where the dot tool can be 
  583. # found. If left blank, it is assumed the dot tool can be found on the path.
  584. DOT_PATH               = 
  585. # The DOTFILE_DIRS tag can be used to specify one or more directories that 
  586. # contain dot files that are included in the documentation (see the 
  587. # dotfile command).
  588. DOTFILE_DIRS           = 
  589. # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
  590. # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
  591. # this value, doxygen will try to truncate the graph, so that it fits within 
  592. # the specified constraint. Beware that most browsers cannot cope with very 
  593. # large images.
  594. MAX_DOT_GRAPH_WIDTH    = 1024
  595. # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
  596. # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
  597. # this value, doxygen will try to truncate the graph, so that it fits within 
  598. # the specified constraint. Beware that most browsers cannot cope with very 
  599. # large images.
  600. MAX_DOT_GRAPH_HEIGHT   = 1024
  601. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
  602. # generate a legend page explaining the meaning of the various boxes and 
  603. # arrows in the dot generated graphs.
  604. GENERATE_LEGEND        = YES
  605. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
  606. # remove the intermedate dot files that are used to generate 
  607. # the various graphs.
  608. DOT_CLEANUP            = YES
  609. #---------------------------------------------------------------------------
  610. # Configuration::addtions related to the search engine   
  611. #---------------------------------------------------------------------------
  612. # The SEARCHENGINE tag specifies whether or not a search engine should be 
  613. # used. If set to NO the values of all tags below this one will be ignored.
  614. SEARCHENGINE           = NO
  615. # The CGI_NAME tag should be the name of the CGI script that 
  616. # starts the search engine (doxysearch) with the correct parameters. 
  617. # A script with this name will be generated by doxygen.
  618. CGI_NAME               = search.cgi
  619. # The CGI_URL tag should be the absolute URL to the directory where the 
  620. # cgi binaries are located. See the documentation of your http daemon for 
  621. # details.
  622. CGI_URL                = 
  623. # The DOC_URL tag should be the absolute URL to the directory where the 
  624. # documentation is located. If left blank the absolute path to the 
  625. # documentation, with file:// prepended to it, will be used.
  626. DOC_URL                = 
  627. # The DOC_ABSPATH tag should be the absolute path to the directory where the 
  628. # documentation is located. If left blank the directory on the local machine 
  629. # will be used.
  630. DOC_ABSPATH            = 
  631. # The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
  632. # is installed.
  633. BIN_ABSPATH            = /usr/local/bin
  634. # The EXT_DOC_PATHS tag can be used to specify one or more paths to 
  635. # documentation generated for other projects. This allows doxysearch to search 
  636. # the documentation for these projects as well.
  637. EXT_DOC_PATHS          =