tool to fixes some issues in baseline tiffs (with extensions), see http://andreas-romeyke.de
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.
 
 
 

1890 lines
80 KiB

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