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.

1318 line
53KB

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