PageRenderTime 50ms CodeModel.GetById 15ms RepoModel.GetById 1ms app.codeStats 0ms

/Doxyfile

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