doc_config
上传用户:cnryan
上传日期:2008-12-15
资源大小:260k
文件大小:43k
源码类别:

Linux/Unix编程

开发平台:

Unix_Linux

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