You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1680 lines
69KB

  1. # Doxyfile 1.7.3
  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. # Project related configuration options
  13. #---------------------------------------------------------------------------
  14. # This tag specifies the encoding used for all characters in the config file
  15. # that follow. The default is UTF-8 which is also the encoding used for all
  16. # text before the first occurrence of this tag. Doxygen uses libiconv (or the
  17. # iconv built into libc) for the transcoding. See
  18. # http://www.gnu.org/software/libiconv for the list of possible encodings.
  19. DOXYFILE_ENCODING = UTF-8
  20. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
  21. # by quotes) that should identify the project.
  22. PROJECT_NAME = libpkg
  23. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
  24. # This could be handy for archiving the generated documentation or
  25. # if some version control system is used.
  26. PROJECT_NUMBER = %%PKGVERSION%%
  27. # Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.
  28. PROJECT_BRIEF = "Library to manage packages on FreeBSD"
  29. # With the PROJECT_LOGO tag one can specify an logo or icon that is
  30. # included in the documentation. The maximum height of the logo should not
  31. # exceed 55 pixels and the maximum width should not exceed 200 pixels.
  32. # Doxygen will copy the logo to the output directory.
  33. PROJECT_LOGO =
  34. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  35. # base path where the generated documentation will be put.
  36. # If a relative path is entered, it will be relative to the location
  37. # where doxygen was started. If left blank the current directory will be used.
  38. OUTPUT_DIRECTORY = ./docs
  39. # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
  40. # 4096 sub-directories (in 2 levels) under the output directory of each output
  41. # format and will distribute the generated files over these directories.
  42. # Enabling this option can be useful when feeding doxygen a huge amount of
  43. # source files, where putting all generated files in the same directory would
  44. # otherwise cause performance problems for the file system.
  45. CREATE_SUBDIRS = NO
  46. # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  47. # documentation generated by doxygen is written. Doxygen will use this
  48. # information to generate all constant output in the proper language.
  49. # The default language is English, other supported languages are:
  50. # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
  51. # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
  52. # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
  53. # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
  54. # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
  55. # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
  56. OUTPUT_LANGUAGE = English
  57. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  58. # include brief member descriptions after the members that are listed in
  59. # the file and class documentation (similar to JavaDoc).
  60. # Set to NO to disable this.
  61. BRIEF_MEMBER_DESC = YES
  62. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  63. # the brief description of a member or function before the detailed description.
  64. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  65. # brief descriptions will be completely suppressed.
  66. REPEAT_BRIEF = YES
  67. # This tag implements a quasi-intelligent brief description abbreviator
  68. # that is used to form the text in various listings. Each string
  69. # in this list, if found as the leading text of the brief description, will be
  70. # stripped from the text and the result after processing the whole list, is
  71. # used as the annotated text. Otherwise, the brief description is used as-is.
  72. # If left blank, the following values are used ("$name" is automatically
  73. # replaced with the name of the entity): "The $name class" "The $name widget"
  74. # "The $name file" "is" "provides" "specifies" "contains"
  75. # "represents" "a" "an" "the"
  76. ABBREVIATE_BRIEF =
  77. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  78. # Doxygen will generate a detailed section even if there is only a brief
  79. # description.
  80. ALWAYS_DETAILED_SEC = NO
  81. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  82. # inherited members of a class in the documentation of that class as if those
  83. # members were ordinary class members. Constructors, destructors and assignment
  84. # operators of the base classes will not be shown.
  85. INLINE_INHERITED_MEMB = NO
  86. # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  87. # path before files name in the file list and in the header files. If set
  88. # to NO the shortest path that makes the file name unique will be used.
  89. FULL_PATH_NAMES = YES
  90. # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  91. # can be used to strip a user-defined part of the path. Stripping is
  92. # only done if one of the specified strings matches the left-hand part of
  93. # the path. The tag can be used to show relative paths in the file list.
  94. # If left blank the directory from which doxygen is run is used as the
  95. # path to strip.
  96. STRIP_FROM_PATH =
  97. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
  98. # the path mentioned in the documentation of a class, which tells
  99. # the reader which header file to include in order to use a class.
  100. # If left blank only the name of the header file containing the class
  101. # definition is used. Otherwise one should specify the include paths that
  102. # are normally passed to the compiler using the -I flag.
  103. STRIP_FROM_INC_PATH =
  104. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
  105. # (but less readable) file names. This can be useful if your file system
  106. # doesn't support long names like on DOS, Mac, or CD-ROM.
  107. SHORT_NAMES = NO
  108. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  109. # will interpret the first line (until the first dot) of a JavaDoc-style
  110. # comment as the brief description. If set to NO, the JavaDoc
  111. # comments will behave just like regular Qt-style comments
  112. # (thus requiring an explicit @brief command for a brief description.)
  113. JAVADOC_AUTOBRIEF = YES
  114. # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
  115. # interpret the first line (until the first dot) of a Qt-style
  116. # comment as the brief description. If set to NO, the comments
  117. # will behave just like regular Qt-style comments (thus requiring
  118. # an explicit \brief command for a brief description.)
  119. QT_AUTOBRIEF = NO
  120. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
  121. # treat a multi-line C++ special comment block (i.e. a block of //! or ///
  122. # comments) as a brief description. This used to be the default behaviour.
  123. # The new default is to treat a multi-line C++ comment block as a detailed
  124. # description. Set this tag to YES if you prefer the old behaviour instead.
  125. MULTILINE_CPP_IS_BRIEF = NO
  126. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  127. # member inherits the documentation from any documented member that it
  128. # re-implements.
  129. INHERIT_DOCS = YES
  130. # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
  131. # a new page for each member. If set to NO, the documentation of a member will
  132. # be part of the file/class/namespace that contains it.
  133. SEPARATE_MEMBER_PAGES = NO
  134. # The TAB_SIZE tag can be used to set the number of spaces in a tab.
  135. # Doxygen uses this value to replace tabs by spaces in code fragments.
  136. TAB_SIZE = 4
  137. # This tag can be used to specify a number of aliases that acts
  138. # as commands in the documentation. An alias has the form "name=value".
  139. # For example adding "sideeffect=\par Side Effects:\n" will allow you to
  140. # put the command \sideeffect (or @sideeffect) in the documentation, which
  141. # will result in a user-defined paragraph with heading "Side Effects:".
  142. # You can put \n's in the value part of an alias to insert newlines.
  143. ALIASES =
  144. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
  145. # sources only. Doxygen will then generate output that is more tailored for C.
  146. # For instance, some of the names that are used will be different. The list
  147. # of all members will be omitted, etc.
  148. OPTIMIZE_OUTPUT_FOR_C = YES
  149. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
  150. # sources only. Doxygen will then generate output that is more tailored for
  151. # Java. For instance, namespaces will be presented as packages, qualified
  152. # scopes will look different, etc.
  153. OPTIMIZE_OUTPUT_JAVA = NO
  154. # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  155. # sources only. Doxygen will then generate output that is more tailored for
  156. # Fortran.
  157. OPTIMIZE_FOR_FORTRAN = NO
  158. # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  159. # sources. Doxygen will then generate output that is tailored for
  160. # VHDL.
  161. OPTIMIZE_OUTPUT_VHDL = NO
  162. # Doxygen selects the parser to use depending on the extension of the files it
  163. # parses. With this tag you can assign which parser to use for a given extension.
  164. # Doxygen has a built-in mapping, but you can override or extend it using this
  165. # tag. The format is ext=language, where ext is a file extension, and language
  166. # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
  167. # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
  168. # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
  169. # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
  170. # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
  171. EXTENSION_MAPPING =
  172. # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  173. # to include (a tag file for) the STL sources as input, then you should
  174. # set this tag to YES in order to let doxygen match functions declarations and
  175. # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
  176. # func(std::string) {}). This also makes the inheritance and collaboration
  177. # diagrams that involve STL classes more complete and accurate.
  178. BUILTIN_STL_SUPPORT = NO
  179. # If you use Microsoft's C++/CLI language, you should set this option to YES to
  180. # enable parsing support.
  181. CPP_CLI_SUPPORT = NO
  182. # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
  183. # Doxygen will parse them like normal C++ but will assume all classes use public
  184. # instead of private inheritance when no explicit protection keyword is present.
  185. SIP_SUPPORT = NO
  186. # For Microsoft's IDL there are propget and propput attributes to indicate getter
  187. # and setter methods for a property. Setting this option to YES (the default)
  188. # will make doxygen replace the get and set methods by a property in the
  189. # documentation. This will only work if the methods are indeed getting or
  190. # setting a simple type. If this is not the case, or you want to show the
  191. # methods anyway, you should set this option to NO.
  192. IDL_PROPERTY_SUPPORT = YES
  193. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  194. # tag is set to YES, then doxygen will reuse the documentation of the first
  195. # member in the group (if any) for the other members of the group. By default
  196. # all members of a group must be documented explicitly.
  197. DISTRIBUTE_GROUP_DOC = NO
  198. # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
  199. # the same type (for instance a group of public functions) to be put as a
  200. # subgroup of that type (e.g. under the Public Functions section). Set it to
  201. # NO to prevent subgrouping. Alternatively, this can be done per class using
  202. # the \nosubgrouping command.
  203. SUBGROUPING = YES
  204. # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
  205. # is documented as struct, union, or enum with the name of the typedef. So
  206. # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  207. # with name TypeT. When disabled the typedef will appear as a member of a file,
  208. # namespace, or class. And the struct will be named TypeS. This can typically
  209. # be useful for C code in case the coding convention dictates that all compound
  210. # types are typedef'ed and only the typedef is referenced, never the tag name.
  211. TYPEDEF_HIDES_STRUCT = NO
  212. # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
  213. # determine which symbols to keep in memory and which to flush to disk.
  214. # When the cache is full, less often used symbols will be written to disk.
  215. # For small to medium size projects (<1000 input files) the default value is
  216. # probably good enough. For larger projects a too small cache size can cause
  217. # doxygen to be busy swapping symbols to and from disk most of the time
  218. # causing a significant performance penalty.
  219. # If the system has enough physical memory increasing the cache will improve the
  220. # performance by keeping more symbols in memory. Note that the value works on
  221. # a logarithmic scale so increasing the size by one will roughly double the
  222. # memory usage. The cache size is given by this formula:
  223. # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
  224. # corresponding to a cache size of 2^16 = 65536 symbols
  225. SYMBOL_CACHE_SIZE = 0
  226. #---------------------------------------------------------------------------
  227. # Build related configuration options
  228. #---------------------------------------------------------------------------
  229. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  230. # documentation are documented, even if no documentation was available.
  231. # Private class members and static file members will be hidden unless
  232. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  233. EXTRACT_ALL = YES
  234. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  235. # will be included in the documentation.
  236. EXTRACT_PRIVATE = NO
  237. # If the EXTRACT_STATIC tag is set to YES all static members of a file
  238. # will be included in the documentation.
  239. EXTRACT_STATIC = YES
  240. # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
  241. # defined locally in source files will be included in the documentation.
  242. # If set to NO only classes defined in header files are included.
  243. EXTRACT_LOCAL_CLASSES = YES
  244. # This flag is only useful for Objective-C code. When set to YES local
  245. # methods, which are defined in the implementation section but not in
  246. # the interface are included in the documentation.
  247. # If set to NO (the default) only methods in the interface are included.
  248. EXTRACT_LOCAL_METHODS = NO
  249. # If this flag is set to YES, the members of anonymous namespaces will be
  250. # extracted and appear in the documentation as a namespace called
  251. # 'anonymous_namespace{file}', where file will be replaced with the base
  252. # name of the file that contains the anonymous namespace. By default
  253. # anonymous namespaces are hidden.
  254. EXTRACT_ANON_NSPACES = NO
  255. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  256. # undocumented members of documented classes, files or namespaces.
  257. # If set to NO (the default) these members will be included in the
  258. # various overviews, but no documentation section is generated.
  259. # This option has no effect if EXTRACT_ALL is enabled.
  260. HIDE_UNDOC_MEMBERS = NO
  261. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  262. # undocumented classes that are normally visible in the class hierarchy.
  263. # If set to NO (the default) these classes will be included in the various
  264. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  265. HIDE_UNDOC_CLASSES = NO
  266. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
  267. # friend (class|struct|union) declarations.
  268. # If set to NO (the default) these declarations will be included in the
  269. # documentation.
  270. HIDE_FRIEND_COMPOUNDS = NO
  271. # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
  272. # documentation blocks found inside the body of a function.
  273. # If set to NO (the default) these blocks will be appended to the
  274. # function's detailed documentation block.
  275. HIDE_IN_BODY_DOCS = NO
  276. # The INTERNAL_DOCS tag determines if documentation
  277. # that is typed after a \internal command is included. If the tag is set
  278. # to NO (the default) then the documentation will be excluded.
  279. # Set it to YES to include the internal documentation.
  280. INTERNAL_DOCS = NO
  281. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
  282. # file names in lower-case letters. If set to YES upper-case letters are also
  283. # allowed. This is useful if you have classes or files whose names only differ
  284. # in case and if your file system supports case sensitive file names. Windows
  285. # and Mac users are advised to set this option to NO.
  286. CASE_SENSE_NAMES = YES
  287. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  288. # will show members with their full class and namespace scopes in the
  289. # documentation. If set to YES the scope will be hidden.
  290. HIDE_SCOPE_NAMES = NO
  291. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
  292. # will put a list of the files that are included by a file in the documentation
  293. # of that file.
  294. SHOW_INCLUDE_FILES = YES
  295. # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
  296. # will list include files with double quotes in the documentation
  297. # rather than with sharp brackets.
  298. FORCE_LOCAL_INCLUDES = NO
  299. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  300. # is inserted in the documentation for inline members.
  301. INLINE_INFO = YES
  302. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
  303. # will sort the (detailed) documentation of file and class members
  304. # alphabetically by member name. If set to NO the members will appear in
  305. # declaration order.
  306. SORT_MEMBER_DOCS = YES
  307. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
  308. # brief documentation of file, namespace and class members alphabetically
  309. # by member name. If set to NO (the default) the members will appear in
  310. # declaration order.
  311. SORT_BRIEF_DOCS = NO
  312. # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
  313. # will sort the (brief and detailed) documentation of class members so that
  314. # constructors and destructors are listed first. If set to NO (the default)
  315. # the constructors will appear in the respective orders defined by
  316. # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
  317. # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
  318. # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
  319. SORT_MEMBERS_CTORS_1ST = NO
  320. # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
  321. # hierarchy of group names into alphabetical order. If set to NO (the default)
  322. # the group names will appear in their defined order.
  323. SORT_GROUP_NAMES = NO
  324. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
  325. # sorted by fully-qualified names, including namespaces. If set to
  326. # NO (the default), the class list will be sorted only by class name,
  327. # not including the namespace part.
  328. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  329. # Note: This option applies only to the class list, not to the
  330. # alphabetical list.
  331. SORT_BY_SCOPE_NAME = NO
  332. # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a
  333. # match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
  334. # will still accept a match between prototype and implementation in such cases.
  335. STRICT_PROTO_MATCHING = NO
  336. # The GENERATE_TODOLIST tag can be used to enable (YES) or
  337. # disable (NO) the todo list. This list is created by putting \todo
  338. # commands in the documentation.
  339. GENERATE_TODOLIST = YES
  340. # The GENERATE_TESTLIST tag can be used to enable (YES) or
  341. # disable (NO) the test list. This list is created by putting \test
  342. # commands in the documentation.
  343. GENERATE_TESTLIST = YES
  344. # The GENERATE_BUGLIST tag can be used to enable (YES) or
  345. # disable (NO) the bug list. This list is created by putting \bug
  346. # commands in the documentation.
  347. GENERATE_BUGLIST = YES
  348. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
  349. # disable (NO) the deprecated list. This list is created by putting
  350. # \deprecated commands in the documentation.
  351. GENERATE_DEPRECATEDLIST= YES
  352. # The ENABLED_SECTIONS tag can be used to enable conditional
  353. # documentation sections, marked by \if sectionname ... \endif.
  354. ENABLED_SECTIONS =
  355. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
  356. # the initial value of a variable or macro consists of for it to appear in
  357. # the documentation. If the initializer consists of more lines than specified
  358. # here it will be hidden. Use a value of 0 to hide initializers completely.
  359. # The appearance of the initializer of individual variables and macros in the
  360. # documentation can be controlled using \showinitializer or \hideinitializer
  361. # command in the documentation regardless of this setting.
  362. MAX_INITIALIZER_LINES = 30
  363. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
  364. # at the bottom of the documentation of classes and structs. If set to YES the
  365. # list will mention the files that were used to generate the documentation.
  366. SHOW_USED_FILES = YES
  367. # If the sources in your project are distributed over multiple directories
  368. # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
  369. # in the documentation. The default is NO.
  370. SHOW_DIRECTORIES = NO
  371. # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
  372. # This will remove the Files entry from the Quick Index and from the
  373. # Folder Tree View (if specified). The default is YES.
  374. SHOW_FILES = YES
  375. # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
  376. # Namespaces page.
  377. # This will remove the Namespaces entry from the Quick Index
  378. # and from the Folder Tree View (if specified). The default is YES.
  379. SHOW_NAMESPACES = YES
  380. # The FILE_VERSION_FILTER tag can be used to specify a program or script that
  381. # doxygen should invoke to get the current version for each file (typically from
  382. # the version control system). Doxygen will invoke the program by executing (via
  383. # popen()) the command <command> <input-file>, where <command> is the value of
  384. # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
  385. # provided by doxygen. Whatever the program writes to standard output
  386. # is used as the file version. See the manual for examples.
  387. FILE_VERSION_FILTER =
  388. # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  389. # by doxygen. The layout file controls the global structure of the generated
  390. # output files in an output format independent way. The create the layout file
  391. # that represents doxygen's defaults, run doxygen with the -l option.
  392. # You can optionally specify a file name after the option, if omitted
  393. # DoxygenLayout.xml will be used as the name of the layout file.
  394. LAYOUT_FILE =
  395. #---------------------------------------------------------------------------
  396. # configuration options related to warning and progress messages
  397. #---------------------------------------------------------------------------
  398. # The QUIET tag can be used to turn on/off the messages that are generated
  399. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  400. QUIET = NO
  401. # The WARNINGS tag can be used to turn on/off the warning messages that are
  402. # generated by doxygen. Possible values are YES and NO. If left blank
  403. # NO is used.
  404. WARNINGS = YES
  405. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  406. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  407. # automatically be disabled.
  408. WARN_IF_UNDOCUMENTED = YES
  409. # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
  410. # potential errors in the documentation, such as not documenting some
  411. # parameters in a documented function, or documenting parameters that
  412. # don't exist or using markup commands wrongly.
  413. WARN_IF_DOC_ERROR = YES
  414. # The WARN_NO_PARAMDOC option can be enabled to get warnings for
  415. # functions that are documented, but have no documentation for their parameters
  416. # or return value. If set to NO (the default) doxygen will only warn about
  417. # wrong or incomplete parameter documentation, but not about the absence of
  418. # documentation.
  419. WARN_NO_PARAMDOC = NO
  420. # The WARN_FORMAT tag determines the format of the warning messages that
  421. # doxygen can produce. The string should contain the $file, $line, and $text
  422. # tags, which will be replaced by the file and line number from which the
  423. # warning originated and the warning text. Optionally the format may contain
  424. # $version, which will be replaced by the version of the file (if it could
  425. # be obtained via FILE_VERSION_FILTER)
  426. WARN_FORMAT = "$file:$line: $text"
  427. # The WARN_LOGFILE tag can be used to specify a file to which warning
  428. # and error messages should be written. If left blank the output is written
  429. # to stderr.
  430. WARN_LOGFILE =
  431. #---------------------------------------------------------------------------
  432. # configuration options related to the input files
  433. #---------------------------------------------------------------------------
  434. # The INPUT tag can be used to specify the files and/or directories that contain
  435. # documented source files. You may enter file names like "myfile.cpp" or
  436. # directories like "/usr/src/myproject". Separate the files or directories
  437. # with spaces.
  438. INPUT = ./libpkg
  439. # This tag can be used to specify the character encoding of the source files
  440. # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
  441. # also the default input encoding. Doxygen uses libiconv (or the iconv built
  442. # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
  443. # the list of possible encodings.
  444. INPUT_ENCODING = UTF-8
  445. # If the value of the INPUT tag contains directories, you can use the
  446. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  447. # and *.h) to filter out the source-files in the directories. If left
  448. # blank the following patterns are tested:
  449. # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
  450. # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
  451. # *.f90 *.f *.for *.vhd *.vhdl
  452. FILE_PATTERNS = *.c *.h
  453. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  454. # should be searched for input files as well. Possible values are YES and NO.
  455. # If left blank NO is used.
  456. RECURSIVE = NO
  457. # The EXCLUDE tag can be used to specify files and/or directories that should
  458. # excluded from the INPUT source files. This way you can easily exclude a
  459. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  460. EXCLUDE =
  461. # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
  462. # directories that are symbolic links (a Unix file system feature) are excluded
  463. # from the input.
  464. EXCLUDE_SYMLINKS = NO
  465. # If the value of the INPUT tag contains directories, you can use the
  466. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  467. # certain files from those directories. Note that the wildcards are matched
  468. # against the file with absolute path, so to exclude all test directories
  469. # for example use the pattern */test/*
  470. EXCLUDE_PATTERNS =
  471. # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  472. # (namespaces, classes, functions, etc.) that should be excluded from the
  473. # output. The symbol name can be a fully qualified name, a word, or if the
  474. # wildcard * is used, a substring. Examples: ANamespace, AClass,
  475. # AClass::ANamespace, ANamespace::*Test
  476. EXCLUDE_SYMBOLS =
  477. # The EXAMPLE_PATH tag can be used to specify one or more files or
  478. # directories that contain example code fragments that are included (see
  479. # the \include command).
  480. EXAMPLE_PATH =
  481. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  482. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  483. # and *.h) to filter out the source-files in the directories. If left
  484. # blank all files are included.
  485. EXAMPLE_PATTERNS =
  486. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  487. # searched for input files to be used with the \include or \dontinclude
  488. # commands irrespective of the value of the RECURSIVE tag.
  489. # Possible values are YES and NO. If left blank NO is used.
  490. EXAMPLE_RECURSIVE = NO
  491. # The IMAGE_PATH tag can be used to specify one or more files or
  492. # directories that contain image that are included in the documentation (see
  493. # the \image command).
  494. IMAGE_PATH =
  495. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  496. # invoke to filter for each input file. Doxygen will invoke the filter program
  497. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  498. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  499. # input file. Doxygen will then use the output that the filter program writes
  500. # to standard output.
  501. # If FILTER_PATTERNS is specified, this tag will be
  502. # ignored.
  503. INPUT_FILTER =
  504. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  505. # basis.
  506. # Doxygen will compare the file name with each pattern and apply the
  507. # filter if there is a match.
  508. # The filters are a list of the form:
  509. # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
  510. # info on how filters are used. If FILTER_PATTERNS is empty or if
  511. # non of the patterns match the file name, INPUT_FILTER is applied.
  512. FILTER_PATTERNS =
  513. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  514. # INPUT_FILTER) will be used to filter the input files when producing source
  515. # files to browse (i.e. when SOURCE_BROWSER is set to YES).
  516. FILTER_SOURCE_FILES = NO
  517. # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  518. # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
  519. # and it is also possible to disable source filtering for a specific pattern
  520. # using *.ext= (so without naming a filter). This option only has effect when
  521. # FILTER_SOURCE_FILES is enabled.
  522. FILTER_SOURCE_PATTERNS =
  523. #---------------------------------------------------------------------------
  524. # configuration options related to source browsing
  525. #---------------------------------------------------------------------------
  526. # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  527. # be generated. Documented entities will be cross-referenced with these sources.
  528. # Note: To get rid of all source code in the generated output, make sure also
  529. # VERBATIM_HEADERS is set to NO.
  530. SOURCE_BROWSER = NO
  531. # Setting the INLINE_SOURCES tag to YES will include the body
  532. # of functions and classes directly in the documentation.
  533. INLINE_SOURCES = NO
  534. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  535. # doxygen to hide any special comment blocks from generated source code
  536. # fragments. Normal C and C++ comments will always remain visible.
  537. STRIP_CODE_COMMENTS = YES
  538. # If the REFERENCED_BY_RELATION tag is set to YES
  539. # then for each documented function all documented
  540. # functions referencing it will be listed.
  541. REFERENCED_BY_RELATION = NO
  542. # If the REFERENCES_RELATION tag is set to YES
  543. # then for each documented function all documented entities
  544. # called/used by that function will be listed.
  545. REFERENCES_RELATION = NO
  546. # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
  547. # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
  548. # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
  549. # link to the source code.
  550. # Otherwise they will link to the documentation.
  551. REFERENCES_LINK_SOURCE = YES
  552. # If the USE_HTAGS tag is set to YES then the references to source code
  553. # will point to the HTML generated by the htags(1) tool instead of doxygen
  554. # built-in source browser. The htags tool is part of GNU's global source
  555. # tagging system (see http://www.gnu.org/software/global/global.html). You
  556. # will need version 4.8.6 or higher.
  557. USE_HTAGS = NO
  558. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  559. # will generate a verbatim copy of the header file for each class for
  560. # which an include is specified. Set to NO to disable this.
  561. VERBATIM_HEADERS = YES
  562. #---------------------------------------------------------------------------
  563. # configuration options related to the alphabetical class index
  564. #---------------------------------------------------------------------------
  565. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  566. # of all compounds will be generated. Enable this if the project
  567. # contains a lot of classes, structs, unions or interfaces.
  568. ALPHABETICAL_INDEX = YES
  569. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  570. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  571. # in which this list will be split (can be a number in the range [1..20])
  572. COLS_IN_ALPHA_INDEX = 5
  573. # In case all classes in a project start with a common prefix, all
  574. # classes will be put under the same header in the alphabetical index.
  575. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  576. # should be ignored while generating the index headers.
  577. IGNORE_PREFIX =
  578. #---------------------------------------------------------------------------
  579. # configuration options related to the HTML output
  580. #---------------------------------------------------------------------------
  581. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  582. # generate HTML output.
  583. GENERATE_HTML = YES
  584. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  585. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  586. # put in front of it. If left blank `html' will be used as the default path.
  587. HTML_OUTPUT = html
  588. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
  589. # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
  590. # doxygen will generate files with .html extension.
  591. HTML_FILE_EXTENSION = .html
  592. # The HTML_HEADER tag can be used to specify a personal HTML header for
  593. # each generated HTML page. If it is left blank doxygen will generate a
  594. # standard header.
  595. HTML_HEADER =
  596. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  597. # each generated HTML page. If it is left blank doxygen will generate a
  598. # standard footer.
  599. HTML_FOOTER =
  600. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
  601. # style sheet that is used by each HTML page. It can be used to
  602. # fine-tune the look of the HTML output. If the tag is left blank doxygen
  603. # will generate a default style sheet. Note that doxygen will try to copy
  604. # the style sheet file to the HTML output directory, so don't put your own
  605. # stylesheet in the HTML output directory as well, or it will be erased!
  606. HTML_STYLESHEET =
  607. # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
  608. # Doxygen will adjust the colors in the stylesheet and background images
  609. # according to this color. Hue is specified as an angle on a colorwheel,
  610. # see http://en.wikipedia.org/wiki/Hue for more information.
  611. # For instance the value 0 represents red, 60 is yellow, 120 is green,
  612. # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
  613. # The allowed range is 0 to 359.
  614. HTML_COLORSTYLE_HUE = 220
  615. # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
  616. # the colors in the HTML output. For a value of 0 the output will use
  617. # grayscales only. A value of 255 will produce the most vivid colors.
  618. HTML_COLORSTYLE_SAT = 100
  619. # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
  620. # the luminance component of the colors in the HTML output. Values below
  621. # 100 gradually make the output lighter, whereas values above 100 make
  622. # the output darker. The value divided by 100 is the actual gamma applied,
  623. # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
  624. # and 100 does not change the gamma.
  625. HTML_COLORSTYLE_GAMMA = 80
  626. # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  627. # page will contain the date and time when the page was generated. Setting
  628. # this to NO can help when comparing the output of multiple runs.
  629. HTML_TIMESTAMP = YES
  630. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  631. # files or namespaces will be aligned in HTML using tables. If set to
  632. # NO a bullet list will be used.
  633. HTML_ALIGN_MEMBERS = YES
  634. # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  635. # documentation will contain sections that can be hidden and shown after the
  636. # page has loaded. For this to work a browser that supports
  637. # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
  638. # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
  639. HTML_DYNAMIC_SECTIONS = NO
  640. # If the GENERATE_DOCSET tag is set to YES, additional index files
  641. # will be generated that can be used as input for Apple's Xcode 3
  642. # integrated development environment, introduced with OSX 10.5 (Leopard).
  643. # To create a documentation set, doxygen will generate a Makefile in the
  644. # HTML output directory. Running make will produce the docset in that
  645. # directory and running "make install" will install the docset in
  646. # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
  647. # it at startup.
  648. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  649. # for more information.
  650. GENERATE_DOCSET = NO
  651. # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
  652. # feed. A documentation feed provides an umbrella under which multiple
  653. # documentation sets from a single provider (such as a company or product suite)
  654. # can be grouped.
  655. DOCSET_FEEDNAME = "Doxygen generated docs"
  656. # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
  657. # should uniquely identify the documentation set bundle. This should be a
  658. # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
  659. # will append .docset to the name.
  660. DOCSET_BUNDLE_ID = org.doxygen.Project
  661. # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
  662. # the documentation publisher. This should be a reverse domain-name style
  663. # string, e.g. com.mycompany.MyDocSet.documentation.
  664. DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  665. # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
  666. DOCSET_PUBLISHER_NAME = Publisher
  667. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  668. # will be generated that can be used as input for tools like the
  669. # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
  670. # of the generated HTML documentation.
  671. GENERATE_HTMLHELP = NO
  672. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
  673. # be used to specify the file name of the resulting .chm file. You
  674. # can add a path in front of the file if the result should not be
  675. # written to the html output directory.
  676. CHM_FILE =
  677. # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
  678. # be used to specify the location (absolute path including file name) of
  679. # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
  680. # the HTML help compiler on the generated index.hhp.
  681. HHC_LOCATION =
  682. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  683. # controls if a separate .chi index file is generated (YES) or that
  684. # it should be included in the master .chm file (NO).
  685. GENERATE_CHI = NO
  686. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
  687. # is used to encode HtmlHelp index (hhk), content (hhc) and project file
  688. # content.
  689. CHM_INDEX_ENCODING =
  690. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  691. # controls whether a binary table of contents is generated (YES) or a
  692. # normal table of contents (NO) in the .chm file.
  693. BINARY_TOC = NO
  694. # The TOC_EXPAND flag can be set to YES to add extra items for group members
  695. # to the contents of the HTML help documentation and to the tree view.
  696. TOC_EXPAND = NO
  697. # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  698. # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
  699. # that can be used as input for Qt's qhelpgenerator to generate a
  700. # Qt Compressed Help (.qch) of the generated HTML documentation.
  701. GENERATE_QHP = NO
  702. # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
  703. # be used to specify the file name of the resulting .qch file.
  704. # The path specified is relative to the HTML output folder.
  705. QCH_FILE =
  706. # The QHP_NAMESPACE tag specifies the namespace to use when generating
  707. # Qt Help Project output. For more information please see
  708. # http://doc.trolltech.com/qthelpproject.html#namespace
  709. QHP_NAMESPACE = org.doxygen.Project
  710. # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
  711. # Qt Help Project output. For more information please see
  712. # http://doc.trolltech.com/qthelpproject.html#virtual-folders
  713. QHP_VIRTUAL_FOLDER = doc
  714. # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
  715. # add. For more information please see
  716. # http://doc.trolltech.com/qthelpproject.html#custom-filters
  717. QHP_CUST_FILTER_NAME =
  718. # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
  719. # custom filter to add. For more information please see
  720. # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
  721. # Qt Help Project / Custom Filters</a>.
  722. QHP_CUST_FILTER_ATTRS =
  723. # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  724. # project's
  725. # filter section matches.
  726. # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
  727. # Qt Help Project / Filter Attributes</a>.
  728. QHP_SECT_FILTER_ATTRS =
  729. # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
  730. # be used to specify the location of Qt's qhelpgenerator.
  731. # If non-empty doxygen will try to run qhelpgenerator on the generated
  732. # .qhp file.
  733. QHG_LOCATION =
  734. # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
  735. # will be generated, which together with the HTML files, form an Eclipse help
  736. # plugin. To install this plugin and make it available under the help contents
  737. # menu in Eclipse, the contents of the directory containing the HTML and XML
  738. # files needs to be copied into the plugins directory of eclipse. The name of
  739. # the directory within the plugins directory should be the same as
  740. # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
  741. # the help appears.
  742. GENERATE_ECLIPSEHELP = NO
  743. # A unique identifier for the eclipse help plugin. When installing the plugin
  744. # the directory name containing the HTML and XML files should also have
  745. # this name.
  746. ECLIPSE_DOC_ID = org.doxygen.Project
  747. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  748. # top of each HTML page. The value NO (the default) enables the index and
  749. # the value YES disables it.
  750. DISABLE_INDEX = NO
  751. # This tag can be used to set the number of enum values (range [0,1..20])
  752. # that doxygen will group on one line in the generated HTML documentation.
  753. # Note that a value of 0 will completely suppress the enum values from appearing in the overview section.
  754. ENUM_VALUES_PER_LINE = 4
  755. # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  756. # structure should be generated to display hierarchical information.
  757. # If the tag value is set to YES, a side panel will be generated
  758. # containing a tree-like index structure (just like the one that
  759. # is generated for HTML Help). For this to work a browser that supports
  760. # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
  761. # Windows users are probably better off using the HTML help feature.
  762. GENERATE_TREEVIEW = NO
  763. # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
  764. # and Class Hierarchy pages using a tree view instead of an ordered list.
  765. USE_INLINE_TREES = NO
  766. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  767. # used to set the initial width (in pixels) of the frame in which the tree
  768. # is shown.
  769. TREEVIEW_WIDTH = 250
  770. # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
  771. # links to external symbols imported via tag files in a separate window.
  772. EXT_LINKS_IN_WINDOW = NO
  773. # Use this tag to change the font size of Latex formulas included
  774. # as images in the HTML documentation. The default is 10. Note that
  775. # when you change the font size after a successful doxygen run you need
  776. # to manually remove any form_*.png images from the HTML output directory
  777. # to force them to be regenerated.
  778. FORMULA_FONTSIZE = 10
  779. # Use the FORMULA_TRANPARENT tag to determine whether or not the images
  780. # generated for formulas are transparent PNGs. Transparent PNGs are
  781. # not supported properly for IE 6.0, but are supported on all modern browsers.
  782. # Note that when changing this option you need to delete any form_*.png files
  783. # in the HTML output before the changes have effect.
  784. FORMULA_TRANSPARENT = YES
  785. # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
  786. # (see http://www.mathjax.org) which uses client side Javascript for the
  787. # rendering instead of using prerendered bitmaps. Use this if you do not
  788. # have LaTeX installed or if you want to formulas look prettier in the HTML
  789. # output. When enabled you also need to install MathJax separately and
  790. # configure the path to it using the MATHJAX_RELPATH option.
  791. USE_MATHJAX = NO
  792. # When MathJax is enabled you need to specify the location relative to the
  793. # HTML output directory using the MATHJAX_RELPATH option. The destination
  794. # directory should contain the MathJax.js script. For instance, if the mathjax
  795. # directory is located at the same level as the HTML output directory, then
  796. # MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing
  797. # MathJax, but it is strongly recommended to install a local copy of MathJax
  798. # before deployment.
  799. MATHJAX_RELPATH = http://www.mathjax.org/mathjax
  800. # When the SEARCHENGINE tag is enabled doxygen will generate a search box
  801. # for the HTML output. The underlying search engine uses javascript
  802. # and DHTML and should work on any modern browser. Note that when using
  803. # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
  804. # (GENERATE_DOCSET) there is already a search function so this one should
  805. # typically be disabled. For large projects the javascript based search engine
  806. # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
  807. SEARCHENGINE = YES
  808. # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  809. # implemented using a PHP enabled web server instead of at the web client
  810. # using Javascript. Doxygen will generate the search PHP script and index
  811. # file to put on the web server. The advantage of the server
  812. # based approach is that it scales better to large projects and allows
  813. # full text search. The disadvantages are that it is more difficult to setup
  814. # and does not have live searching capabilities.
  815. SERVER_BASED_SEARCH = NO
  816. #---------------------------------------------------------------------------
  817. # configuration options related to the LaTeX output
  818. #---------------------------------------------------------------------------
  819. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  820. # generate Latex output.
  821. GENERATE_LATEX = NO
  822. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  823. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  824. # put in front of it. If left blank `latex' will be used as the default path.
  825. LATEX_OUTPUT = latex
  826. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  827. # invoked. If left blank `latex' will be used as the default command name.
  828. # Note that when enabling USE_PDFLATEX this option is only used for
  829. # generating bitmaps for formulas in the HTML output, but not in the
  830. # Makefile that is written to the output directory.
  831. LATEX_CMD_NAME = latex
  832. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  833. # generate index for LaTeX. If left blank `makeindex' will be used as the
  834. # default command name.
  835. MAKEINDEX_CMD_NAME = makeindex
  836. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  837. # LaTeX documents. This may be useful for small projects and may help to
  838. # save some trees in general.
  839. COMPACT_LATEX = NO
  840. # The PAPER_TYPE tag can be used to set the paper type that is used
  841. # by the printer. Possible values are: a4, letter, legal and
  842. # executive. If left blank a4wide will be used.
  843. PAPER_TYPE = a4
  844. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  845. # packages that should be included in the LaTeX output.
  846. EXTRA_PACKAGES =
  847. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  848. # the generated latex document. The header should contain everything until
  849. # the first chapter. If it is left blank doxygen will generate a
  850. # standard header. Notice: only use this tag if you know what you are doing!
  851. LATEX_HEADER =
  852. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  853. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  854. # contain links (just like the HTML output) instead of page references
  855. # This makes the output suitable for online browsing using a pdf viewer.
  856. PDF_HYPERLINKS = YES
  857. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  858. # plain latex in the generated Makefile. Set this option to YES to get a
  859. # higher quality PDF documentation.
  860. USE_PDFLATEX = YES
  861. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  862. # command to the generated LaTeX files. This will instruct LaTeX to keep
  863. # running if errors occur, instead of asking the user for help.
  864. # This option is also used when generating formulas in HTML.
  865. LATEX_BATCHMODE = NO
  866. # If LATEX_HIDE_INDICES is set to YES then doxygen will not
  867. # include the index chapters (such as File Index, Compound Index, etc.)
  868. # in the output.
  869. LATEX_HIDE_INDICES = NO
  870. # If LATEX_SOURCE_CODE is set to YES then doxygen will include
  871. # source code with syntax highlighting in the LaTeX output.
  872. # Note that which sources are shown also depends on other settings
  873. # such as SOURCE_BROWSER.
  874. LATEX_SOURCE_CODE = NO
  875. #---------------------------------------------------------------------------
  876. # configuration options related to the RTF output
  877. #---------------------------------------------------------------------------
  878. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  879. # The RTF output is optimized for Word 97 and may not look very pretty with
  880. # other RTF readers or editors.
  881. GENERATE_RTF = NO
  882. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  883. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  884. # put in front of it. If left blank `rtf' will be used as the default path.
  885. RTF_OUTPUT = rtf
  886. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  887. # RTF documents. This may be useful for small projects and may help to
  888. # save some trees in general.
  889. COMPACT_RTF = NO
  890. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  891. # will contain hyperlink fields. The RTF file will
  892. # contain links (just like the HTML output) instead of page references.
  893. # This makes the output suitable for online browsing using WORD or other
  894. # programs which support those fields.
  895. # Note: wordpad (write) and others do not support links.
  896. RTF_HYPERLINKS = NO
  897. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  898. # config file, i.e. a series of assignments. You only have to provide
  899. # replacements, missing definitions are set to their default value.
  900. RTF_STYLESHEET_FILE =
  901. # Set optional variables used in the generation of an rtf document.
  902. # Syntax is similar to doxygen's config file.
  903. RTF_EXTENSIONS_FILE =
  904. #---------------------------------------------------------------------------
  905. # configuration options related to the man page output
  906. #---------------------------------------------------------------------------
  907. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  908. # generate man pages
  909. GENERATE_MAN = NO
  910. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  911. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  912. # put in front of it. If left blank `man' will be used as the default path.
  913. MAN_OUTPUT = man
  914. # The MAN_EXTENSION tag determines the extension that is added to
  915. # the generated man pages (default is the subroutine's section .3)
  916. MAN_EXTENSION = .3
  917. # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  918. # then it will generate one additional man file for each entity
  919. # documented in the real man page(s). These additional files
  920. # only source the real man page, but without them the man command
  921. # would be unable to find the correct page. The default is NO.
  922. MAN_LINKS = NO
  923. #---------------------------------------------------------------------------
  924. # configuration options related to the XML output
  925. #---------------------------------------------------------------------------
  926. # If the GENERATE_XML tag is set to YES Doxygen will
  927. # generate an XML file that captures the structure of
  928. # the code including all documentation.
  929. GENERATE_XML = NO
  930. # The XML_OUTPUT tag is used to specify where the XML pages will be put.
  931. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  932. # put in front of it. If left blank `xml' will be used as the default path.
  933. XML_OUTPUT = xml
  934. # The XML_SCHEMA tag can be used to specify an XML schema,
  935. # which can be used by a validating XML parser to check the
  936. # syntax of the XML files.
  937. XML_SCHEMA =
  938. # The XML_DTD tag can be used to specify an XML DTD,
  939. # which can be used by a validating XML parser to check the
  940. # syntax of the XML files.
  941. XML_DTD =
  942. # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
  943. # dump the program listings (including syntax highlighting
  944. # and cross-referencing information) to the XML output. Note that
  945. # enabling this will significantly increase the size of the XML output.
  946. XML_PROGRAMLISTING = YES
  947. #---------------------------------------------------------------------------
  948. # configuration options for the AutoGen Definitions output
  949. #---------------------------------------------------------------------------
  950. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  951. # generate an AutoGen Definitions (see autogen.sf.net) file
  952. # that captures the structure of the code including all
  953. # documentation. Note that this feature is still experimental
  954. # and incomplete at the moment.
  955. GENERATE_AUTOGEN_DEF = NO
  956. #---------------------------------------------------------------------------
  957. # configuration options related to the Perl module output
  958. #---------------------------------------------------------------------------
  959. # If the GENERATE_PERLMOD tag is set to YES Doxygen will
  960. # generate a Perl module file that captures the structure of
  961. # the code including all documentation. Note that this
  962. # feature is still experimental and incomplete at the
  963. # moment.
  964. GENERATE_PERLMOD = NO
  965. # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
  966. # the necessary Makefile rules, Perl scripts and LaTeX code to be able
  967. # to generate PDF and DVI output from the Perl module output.
  968. PERLMOD_LATEX = NO
  969. # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
  970. # nicely formatted so it can be parsed by a human reader.
  971. # This is useful
  972. # if you want to understand what is going on.
  973. # On the other hand, if this
  974. # tag is set to NO the size of the Perl module output will be much smaller
  975. # and Perl will parse it just the same.
  976. PERLMOD_PRETTY = YES
  977. # The names of the make variables in the generated doxyrules.make file
  978. # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
  979. # This is useful so different doxyrules.make files included by the same
  980. # Makefile don't overwrite each other's variables.
  981. PERLMOD_MAKEVAR_PREFIX =
  982. #---------------------------------------------------------------------------
  983. # Configuration options related to the preprocessor
  984. #---------------------------------------------------------------------------
  985. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  986. # evaluate all C-preprocessor directives found in the sources and include
  987. # files.
  988. ENABLE_PREPROCESSING = YES
  989. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  990. # names in the source code. If set to NO (the default) only conditional
  991. # compilation will be performed. Macro expansion can be done in a controlled
  992. # way by setting EXPAND_ONLY_PREDEF to YES.
  993. MACRO_EXPANSION = NO
  994. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  995. # then the macro expansion is limited to the macros specified with the
  996. # PREDEFINED and EXPAND_AS_DEFINED tags.
  997. EXPAND_ONLY_PREDEF = NO
  998. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  999. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  1000. SEARCH_INCLUDES = YES
  1001. # The INCLUDE_PATH tag can be used to specify one or more directories that
  1002. # contain include files that are not input files but should be processed by
  1003. # the preprocessor.
  1004. INCLUDE_PATH =
  1005. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  1006. # patterns (like *.h and *.hpp) to filter out the header-files in the
  1007. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  1008. # be used.
  1009. INCLUDE_FILE_PATTERNS =
  1010. # The PREDEFINED tag can be used to specify one or more macro names that
  1011. # are defined before the preprocessor is started (similar to the -D option of
  1012. # gcc). The argument of the tag is a list of macros of the form: name
  1013. # or name=definition (no spaces). If the definition and the = are
  1014. # omitted =1 is assumed. To prevent a macro definition from being
  1015. # undefined via #undef or recursively expanded use the := operator
  1016. # instead of the = operator.
  1017. PREDEFINED =
  1018. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  1019. # this tag can be used to specify a list of macro names that should be expanded.
  1020. # The macro definition that is found in the sources will be used.
  1021. # Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code.
  1022. EXPAND_AS_DEFINED =
  1023. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  1024. # doxygen's preprocessor will remove all references to function-like macros
  1025. # that are alone on a line, have an all uppercase name, and do not end with a
  1026. # semicolon, because these will confuse the parser if not removed.
  1027. SKIP_FUNCTION_MACROS = YES
  1028. #---------------------------------------------------------------------------
  1029. # Configuration::additions related to external references
  1030. #---------------------------------------------------------------------------
  1031. # The TAGFILES option can be used to specify one or more tagfiles.
  1032. # Optionally an initial location of the external documentation
  1033. # can be added for each tagfile. The format of a tag file without
  1034. # this location is as follows:
  1035. #
  1036. # TAGFILES = file1 file2 ...
  1037. # Adding location for the tag files is done as follows:
  1038. #
  1039. # TAGFILES = file1=loc1 "file2 = loc2" ...
  1040. # where "loc1" and "loc2" can be relative or absolute paths or
  1041. # URLs. If a location is present for each tag, the installdox tool
  1042. # does not have to be run to correct the links.
  1043. # Note that each tag file must have a unique name
  1044. # (where the name does NOT include the path)
  1045. # If a tag file is not located in the directory in which doxygen
  1046. # is run, you must also specify the path to the tagfile here.
  1047. TAGFILES =
  1048. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  1049. # a tag file that is based on the input files it reads.
  1050. GENERATE_TAGFILE =
  1051. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  1052. # in the class index. If set to NO only the inherited external classes
  1053. # will be listed.
  1054. ALLEXTERNALS = NO
  1055. # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
  1056. # in the modules index. If set to NO, only the current project's groups will
  1057. # be listed.
  1058. EXTERNAL_GROUPS = YES
  1059. # The PERL_PATH should be the absolute path and name of the perl script
  1060. # interpreter (i.e. the result of `which perl').
  1061. PERL_PATH = /usr/bin/perl
  1062. #---------------------------------------------------------------------------
  1063. # Configuration options related to the dot tool
  1064. #---------------------------------------------------------------------------
  1065. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  1066. # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
  1067. # or super classes. Setting the tag to NO turns the diagrams off. Note that
  1068. # this option also works with HAVE_DOT disabled, but it is recommended to
  1069. # install and use dot, since it yields more powerful graphs.
  1070. CLASS_DIAGRAMS = YES
  1071. # You can define message sequence charts within doxygen comments using the \msc
  1072. # command. Doxygen will then run the mscgen tool (see
  1073. # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
  1074. # documentation. The MSCGEN_PATH tag allows you to specify the directory where
  1075. # the mscgen tool resides. If left empty the tool is assumed to be found in the
  1076. # default search path.
  1077. MSCGEN_PATH =
  1078. # If set to YES, the inheritance and collaboration graphs will hide
  1079. # inheritance and usage relations if the target is undocumented
  1080. # or is not a class.
  1081. HIDE_UNDOC_RELATIONS = YES
  1082. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  1083. # available from the path. This tool is part of Graphviz, a graph visualization
  1084. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  1085. # have no effect if this option is set to NO (the default)
  1086. HAVE_DOT = YES
  1087. # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
  1088. # allowed to run in parallel. When set to 0 (the default) doxygen will
  1089. # base this on the number of processors available in the system. You can set it
  1090. # explicitly to a value larger than 0 to get control over the balance
  1091. # between CPU load and processing speed.
  1092. DOT_NUM_THREADS = 0
  1093. # By default doxygen will write a font called Helvetica to the output
  1094. # directory and reference it in all dot files that doxygen generates.
  1095. # When you want a differently looking font you can specify the font name
  1096. # using DOT_FONTNAME. You need to make sure dot is able to find the font,
  1097. # which can be done by putting it in a standard location or by setting the
  1098. # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
  1099. # containing the font.
  1100. DOT_FONTNAME = Helvetica
  1101. # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
  1102. # The default size is 10pt.
  1103. DOT_FONTSIZE = 10
  1104. # By default doxygen will tell dot to use the output directory to look for the
  1105. # FreeSans.ttf font (which doxygen will put there itself). If you specify a
  1106. # different font using DOT_FONTNAME you can set the path where dot
  1107. # can find it using this tag.
  1108. DOT_FONTPATH =
  1109. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  1110. # will generate a graph for each documented class showing the direct and
  1111. # indirect inheritance relations. Setting this tag to YES will force the
  1112. # the CLASS_DIAGRAMS tag to NO.
  1113. CLASS_GRAPH = YES
  1114. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  1115. # will generate a graph for each documented class showing the direct and
  1116. # indirect implementation dependencies (inheritance, containment, and
  1117. # class references variables) of the class with other documented classes.
  1118. COLLABORATION_GRAPH = YES
  1119. # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
  1120. # will generate a graph for groups, showing the direct groups dependencies
  1121. GROUP_GRAPHS = YES
  1122. # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  1123. # collaboration diagrams in a style similar to the OMG's Unified Modeling
  1124. # Language.
  1125. UML_LOOK = NO
  1126. # If set to YES, the inheritance and collaboration graphs will show the
  1127. # relations between templates and their instances.
  1128. TEMPLATE_RELATIONS = NO
  1129. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  1130. # tags are set to YES then doxygen will generate a graph for each documented
  1131. # file showing the direct and indirect include dependencies of the file with
  1132. # other documented files.
  1133. INCLUDE_GRAPH = YES
  1134. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  1135. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  1136. # documented header file showing the documented files that directly or
  1137. # indirectly include this file.
  1138. INCLUDED_BY_GRAPH = YES
  1139. # If the CALL_GRAPH and HAVE_DOT options are set to YES then
  1140. # doxygen will generate a call dependency graph for every global function
  1141. # or class method. Note that enabling this option will significantly increase
  1142. # the time of a run. So in most cases it will be better to enable call graphs
  1143. # for selected functions only using the \callgraph command.
  1144. CALL_GRAPH = YES
  1145. # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
  1146. # doxygen will generate a caller dependency graph for every global function
  1147. # or class method. Note that enabling this option will significantly increase
  1148. # the time of a run. So in most cases it will be better to enable caller
  1149. # graphs for selected functions only using the \callergraph command.
  1150. CALLER_GRAPH = NO
  1151. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  1152. # will generate a graphical hierarchy of all classes instead of a textual one.
  1153. GRAPHICAL_HIERARCHY = YES
  1154. # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
  1155. # then doxygen will show the dependencies a directory has on other directories
  1156. # in a graphical way. The dependency relations are determined by the #include
  1157. # relations between the files in the directories.
  1158. DIRECTORY_GRAPH = YES
  1159. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  1160. # generated by dot. Possible values are png, svg, gif or svg.
  1161. # If left blank png will be used.
  1162. DOT_IMAGE_FORMAT = png
  1163. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  1164. # found. If left blank, it is assumed the dot tool can be found in the path.
  1165. DOT_PATH =
  1166. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  1167. # contain dot files that are included in the documentation (see the
  1168. # \dotfile command).
  1169. DOTFILE_DIRS =
  1170. # The MSCFILE_DIRS tag can be used to specify one or more directories that
  1171. # contain msc files that are included in the documentation (see the
  1172. # \mscfile command).
  1173. MSCFILE_DIRS =
  1174. # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
  1175. # nodes that will be shown in the graph. If the number of nodes in a graph
  1176. # becomes larger than this value, doxygen will truncate the graph, which is
  1177. # visualized by representing a node as a red box. Note that doxygen if the
  1178. # number of direct children of the root node in a graph is already larger than
  1179. # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
  1180. # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  1181. DOT_GRAPH_MAX_NODES = 50
  1182. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
  1183. # graphs generated by dot. A depth value of 3 means that only nodes reachable
  1184. # from the root by following a path via at most 3 edges will be shown. Nodes
  1185. # that lay further from the root node will be omitted. Note that setting this
  1186. # option to 1 or 2 may greatly reduce the computation time needed for large
  1187. # code bases. Also note that the size of a graph can be further restricted by
  1188. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  1189. MAX_DOT_GRAPH_DEPTH = 0
  1190. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  1191. # background. This is disabled by default, because dot on Windows does not
  1192. # seem to support this out of the box. Warning: Depending on the platform used,
  1193. # enabling this option may lead to badly anti-aliased labels on the edges of
  1194. # a graph (i.e. they become hard to read).
  1195. DOT_TRANSPARENT = NO
  1196. # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  1197. # files in one run (i.e. multiple -o and -T options on the command line). This
  1198. # makes dot run faster, but since only newer versions of dot (>1.8.10)
  1199. # support this, this feature is disabled by default.
  1200. DOT_MULTI_TARGETS = NO
  1201. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  1202. # generate a legend page explaining the meaning of the various boxes and
  1203. # arrows in the dot generated graphs.
  1204. GENERATE_LEGEND = YES
  1205. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  1206. # remove the intermediate dot files that are used to generate
  1207. # the various graphs.
  1208. DOT_CLEANUP = YES