Doxyfile.in
上传用户:awang829
上传日期:2019-07-14
资源大小:2356k
文件大小:51k
源码类别:

网络

开发平台:

Unix_Linux

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