Doxyfile 39 KB

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