Doxyfile 39 KB

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