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.

2447 lines
105 KiB

  1. # Doxyfile 1.8.13
  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 double hash (##) is considered a comment and is placed in
  6. # front of the TAG it is preceding.
  7. #
  8. # All text after a single hash (#) is considered a comment and will be ignored.
  9. # The format is:
  10. # TAG = value [value, ...]
  11. # For lists, items can also be appended using:
  12. # TAG += value [value, ...]
  13. # Values that contain spaces should be placed between quotes (\" \").
  14. #---------------------------------------------------------------------------
  15. # Project related configuration options
  16. #---------------------------------------------------------------------------
  17. # This tag specifies the encoding used for all characters in the config file
  18. # that follow. The default is UTF-8 which is also the encoding used for all text
  19. # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
  20. # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
  21. # for the list of possible encodings.
  22. # The default value is: UTF-8.
  23. DOXYFILE_ENCODING = UTF-8
  24. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
  25. # double-quotes, unless you are using Doxywizard) that should identify the
  26. # project for which the documentation is generated. This name is used in the
  27. # title of most generated pages and in a few other places.
  28. # The default value is: My Project.
  29. PROJECT_NAME = "Arduino Hardware I2C for AVR MCUs (plain c)"
  30. # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
  31. # could be handy for archiving the generated documentation or if some version
  32. # control system is used.
  33. PROJECT_NUMBER = 1.3
  34. # Using the PROJECT_BRIEF tag one can provide an optional one line description
  35. # for a project that appears at the top of each page and should give viewer a
  36. # quick idea about the purpose of the project. Keep the description short.
  37. PROJECT_BRIEF = "Arduino Hardware I2C for AVR MCUs (plain c) documentation"
  38. # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
  39. # in the documentation. The maximum height of the logo should not exceed 55
  40. # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
  41. # the logo to the output directory.
  42. PROJECT_LOGO =
  43. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
  44. # into which the generated documentation will be written. If a relative path is
  45. # entered, it will be relative to the location where doxygen was started. If
  46. # left blank the current directory will be used.
  47. OUTPUT_DIRECTORY =
  48. # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
  49. # directories (in 2 levels) under the output directory of each output format and
  50. # will distribute the generated files over these directories. Enabling this
  51. # option can be useful when feeding doxygen a huge amount of source files, where
  52. # putting all generated files in the same directory would otherwise causes
  53. # performance problems for the file system.
  54. # The default value is: NO.
  55. CREATE_SUBDIRS = NO
  56. # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
  57. # characters to appear in the names of generated files. If set to NO, non-ASCII
  58. # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
  59. # U+3044.
  60. # The default value is: NO.
  61. ALLOW_UNICODE_NAMES = NO
  62. # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  63. # documentation generated by doxygen is written. Doxygen will use this
  64. # information to generate all constant output in the proper language.
  65. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
  66. # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
  67. # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
  68. # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
  69. # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
  70. # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
  71. # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
  72. # Ukrainian and Vietnamese.
  73. # The default value is: English.
  74. OUTPUT_LANGUAGE = English
  75. # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
  76. # descriptions after the members that are listed in the file and class
  77. # documentation (similar to Javadoc). Set to NO to disable this.
  78. # The default value is: YES.
  79. BRIEF_MEMBER_DESC = YES
  80. # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
  81. # description of a member or function before the detailed description
  82. #
  83. # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  84. # brief descriptions will be completely suppressed.
  85. # The default value is: YES.
  86. REPEAT_BRIEF = YES
  87. # This tag implements a quasi-intelligent brief description abbreviator that is
  88. # used to form the text in various listings. Each string in this list, if found
  89. # as the leading text of the brief description, will be stripped from the text
  90. # and the result, after processing the whole list, is used as the annotated
  91. # text. Otherwise, the brief description is used as-is. If left blank, the
  92. # following values are used ($name is automatically replaced with the name of
  93. # the entity):The $name class, The $name widget, The $name file, is, provides,
  94. # specifies, contains, represents, a, an and the.
  95. ABBREVIATE_BRIEF =
  96. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  97. # doxygen will generate a detailed section even if there is only a brief
  98. # description.
  99. # The default value is: NO.
  100. ALWAYS_DETAILED_SEC = NO
  101. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  102. # inherited members of a class in the documentation of that class as if those
  103. # members were ordinary class members. Constructors, destructors and assignment
  104. # operators of the base classes will not be shown.
  105. # The default value is: NO.
  106. INLINE_INHERITED_MEMB = NO
  107. # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
  108. # before files name in the file list and in the header files. If set to NO the
  109. # shortest path that makes the file name unique will be used
  110. # The default value is: YES.
  111. FULL_PATH_NAMES = YES
  112. # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
  113. # Stripping is only done if one of the specified strings matches the left-hand
  114. # part of the path. The tag can be used to show relative paths in the file list.
  115. # If left blank the directory from which doxygen is run is used as the path to
  116. # strip.
  117. #
  118. # Note that you can specify absolute paths here, but also relative paths, which
  119. # will be relative from the directory where doxygen is started.
  120. # This tag requires that the tag FULL_PATH_NAMES is set to YES.
  121. STRIP_FROM_PATH = ./
  122. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
  123. # path mentioned in the documentation of a class, which tells the reader which
  124. # header file to include in order to use a class. If left blank only the name of
  125. # the header file containing the class definition is used. Otherwise one should
  126. # specify the list of include paths that are normally passed to the compiler
  127. # using the -I flag.
  128. STRIP_FROM_INC_PATH = ./
  129. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
  130. # less readable) file names. This can be useful is your file systems doesn't
  131. # support long names like on DOS, Mac, or CD-ROM.
  132. # The default value is: NO.
  133. SHORT_NAMES = NO
  134. # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
  135. # first line (until the first dot) of a Javadoc-style comment as the brief
  136. # description. If set to NO, the Javadoc-style will behave just like regular Qt-
  137. # style comments (thus requiring an explicit @brief command for a brief
  138. # description.)
  139. # The default value is: NO.
  140. JAVADOC_AUTOBRIEF = NO
  141. # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
  142. # line (until the first dot) of a Qt-style comment as the brief description. If
  143. # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
  144. # requiring an explicit \brief command for a brief description.)
  145. # The default value is: NO.
  146. QT_AUTOBRIEF = NO
  147. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
  148. # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
  149. # a brief description. This used to be the default behavior. The new default is
  150. # to treat a multi-line C++ comment block as a detailed description. Set this
  151. # tag to YES if you prefer the old behavior instead.
  152. #
  153. # Note that setting this tag to YES also means that rational rose comments are
  154. # not recognized any more.
  155. # The default value is: NO.
  156. MULTILINE_CPP_IS_BRIEF = NO
  157. # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
  158. # documentation from any documented member that it re-implements.
  159. # The default value is: YES.
  160. INHERIT_DOCS = YES
  161. # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
  162. # page for each member. If set to NO, the documentation of a member will be part
  163. # of the file/class/namespace that contains it.
  164. # The default value is: NO.
  165. SEPARATE_MEMBER_PAGES = NO
  166. # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
  167. # uses this value to replace tabs by spaces in code fragments.
  168. # Minimum value: 1, maximum value: 16, default value: 4.
  169. TAB_SIZE = 4
  170. # This tag can be used to specify a number of aliases that act as commands in
  171. # the documentation. An alias has the form:
  172. # name=value
  173. # For example adding
  174. # "sideeffect=@par Side Effects:\n"
  175. # will allow you to put the command \sideeffect (or @sideeffect) in the
  176. # documentation, which will result in a user-defined paragraph with heading
  177. # "Side Effects:". You can put \n's in the value part of an alias to insert
  178. # newlines.
  179. ALIASES = "issue=\xrefitem issue \"Issue\" \"Issues List\"" \
  180. "isr=\xrefitem isr \"Interrupt\" \"ISR List\"" \
  181. "attribute=\xrefitem attribute \"GCC Attributes\" \"GCC Attributes List\""
  182. # This tag can be used to specify a number of word-keyword mappings (TCL only).
  183. # A mapping has the form "name=value". For example adding "class=itcl::class"
  184. # will allow you to use the command class in the itcl::class meaning.
  185. TCL_SUBST =
  186. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  187. # only. Doxygen will then generate output that is more tailored for C. For
  188. # instance, some of the names that are used will be different. The list of all
  189. # members will be omitted, etc.
  190. # The default value is: NO.
  191. OPTIMIZE_OUTPUT_FOR_C = YES
  192. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
  193. # Python sources only. Doxygen will then generate output that is more tailored
  194. # for that language. For instance, namespaces will be presented as packages,
  195. # qualified scopes will look different, etc.
  196. # The default value is: NO.
  197. OPTIMIZE_OUTPUT_JAVA = NO
  198. # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  199. # sources. Doxygen will then generate output that is tailored for Fortran.
  200. # The default value is: NO.
  201. OPTIMIZE_FOR_FORTRAN = NO
  202. # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  203. # sources. Doxygen will then generate output that is tailored for VHDL.
  204. # The default value is: NO.
  205. OPTIMIZE_OUTPUT_VHDL = NO
  206. # Doxygen selects the parser to use depending on the extension of the files it
  207. # parses. With this tag you can assign which parser to use for a given
  208. # extension. Doxygen has a built-in mapping, but you can override or extend it
  209. # using this tag. The format is ext=language, where ext is a file extension, and
  210. # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
  211. # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
  212. # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
  213. # Fortran. In the later case the parser tries to guess whether the code is fixed
  214. # or free formatted code, this is the default for Fortran type files), VHDL. For
  215. # instance to make doxygen treat .inc files as Fortran files (default is PHP),
  216. # and .f files as C (default is Fortran), use: inc=Fortran f=C.
  217. #
  218. # Note: For files without extension you can use no_extension as a placeholder.
  219. #
  220. # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
  221. # the files are not read by doxygen.
  222. EXTENSION_MAPPING = ino=C++
  223. # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
  224. # according to the Markdown format, which allows for more readable
  225. # documentation. See http://daringfireball.net/projects/markdown/ for details.
  226. # The output of markdown processing is further processed by doxygen, so you can
  227. # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
  228. # case of backward compatibilities issues.
  229. # The default value is: YES.
  230. MARKDOWN_SUPPORT = YES
  231. # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
  232. # to that level are automatically included in the table of contents, even if
  233. # they do not have an id attribute.
  234. # Note: This feature currently applies only to Markdown headings.
  235. # Minimum value: 0, maximum value: 99, default value: 0.
  236. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
  237. TOC_INCLUDE_HEADINGS = 0
  238. # When enabled doxygen tries to link words that correspond to documented
  239. # classes, or namespaces to their corresponding documentation. Such a link can
  240. # be prevented in individual cases by putting a % sign in front of the word or
  241. # globally by setting AUTOLINK_SUPPORT to NO.
  242. # The default value is: YES.
  243. AUTOLINK_SUPPORT = YES
  244. # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  245. # to include (a tag file for) the STL sources as input, then you should set this
  246. # tag to YES in order to let doxygen match functions declarations and
  247. # definitions whose arguments contain STL classes (e.g. func(std::string);
  248. # versus func(std::string) {}). This also make the inheritance and collaboration
  249. # diagrams that involve STL classes more complete and accurate.
  250. # The default value is: NO.
  251. BUILTIN_STL_SUPPORT = NO
  252. # If you use Microsoft's C++/CLI language, you should set this option to YES to
  253. # enable parsing support.
  254. # The default value is: NO.
  255. CPP_CLI_SUPPORT = NO
  256. # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
  257. # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
  258. # will parse them like normal C++ but will assume all classes use public instead
  259. # of private inheritance when no explicit protection keyword is present.
  260. # The default value is: NO.
  261. SIP_SUPPORT = NO
  262. # For Microsoft's IDL there are propget and propput attributes to indicate
  263. # getter and setter methods for a property. Setting this option to YES will make
  264. # doxygen to replace the get and set methods by a property in the documentation.
  265. # This will only work if the methods are indeed getting or setting a simple
  266. # type. If this is not the case, or you want to show the methods anyway, you
  267. # should set this option to NO.
  268. # The default value is: YES.
  269. IDL_PROPERTY_SUPPORT = YES
  270. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  271. # tag is set to YES then doxygen will reuse the documentation of the first
  272. # member in the group (if any) for the other members of the group. By default
  273. # all members of a group must be documented explicitly.
  274. # The default value is: NO.
  275. DISTRIBUTE_GROUP_DOC = NO
  276. # If one adds a struct or class to a group and this option is enabled, then also
  277. # any nested class or struct is added to the same group. By default this option
  278. # is disabled and one has to add nested compounds explicitly via \ingroup.
  279. # The default value is: NO.
  280. GROUP_NESTED_COMPOUNDS = NO
  281. # Set the SUBGROUPING tag to YES to allow class member groups of the same type
  282. # (for instance a group of public functions) to be put as a subgroup of that
  283. # type (e.g. under the Public Functions section). Set it to NO to prevent
  284. # subgrouping. Alternatively, this can be done per class using the
  285. # \nosubgrouping command.
  286. # The default value is: YES.
  287. SUBGROUPING = YES
  288. # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
  289. # are shown inside the group in which they are included (e.g. using \ingroup)
  290. # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
  291. # and RTF).
  292. #
  293. # Note that this feature does not work in combination with
  294. # SEPARATE_MEMBER_PAGES.
  295. # The default value is: NO.
  296. INLINE_GROUPED_CLASSES = NO
  297. # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
  298. # with only public data fields or simple typedef fields will be shown inline in
  299. # the documentation of the scope in which they are defined (i.e. file,
  300. # namespace, or group documentation), provided this scope is documented. If set
  301. # to NO, structs, classes, and unions are shown on a separate page (for HTML and
  302. # Man pages) or section (for LaTeX and RTF).
  303. # The default value is: NO.
  304. INLINE_SIMPLE_STRUCTS = NO
  305. # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
  306. # enum is documented as struct, union, or enum with the name of the typedef. So
  307. # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  308. # with name TypeT. When disabled the typedef will appear as a member of a file,
  309. # namespace, or class. And the struct will be named TypeS. This can typically be
  310. # useful for C code in case the coding convention dictates that all compound
  311. # types are typedef'ed and only the typedef is referenced, never the tag name.
  312. # The default value is: NO.
  313. TYPEDEF_HIDES_STRUCT = NO
  314. # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
  315. # cache is used to resolve symbols given their name and scope. Since this can be
  316. # an expensive process and often the same symbol appears multiple times in the
  317. # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
  318. # doxygen will become slower. If the cache is too large, memory is wasted. The
  319. # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
  320. # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
  321. # symbols. At the end of a run doxygen will report the cache usage and suggest
  322. # the optimal cache size from a speed point of view.
  323. # Minimum value: 0, maximum value: 9, default value: 0.
  324. LOOKUP_CACHE_SIZE = 0
  325. #---------------------------------------------------------------------------
  326. # Build related configuration options
  327. #---------------------------------------------------------------------------
  328. # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
  329. # documentation are documented, even if no documentation was available. Private
  330. # class members and static file members will be hidden unless the
  331. # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
  332. # Note: This will also disable the warnings about undocumented members that are
  333. # normally produced when WARNINGS is set to YES.
  334. # The default value is: NO.
  335. EXTRACT_ALL = YES
  336. # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
  337. # be included in the documentation.
  338. # The default value is: NO.
  339. EXTRACT_PRIVATE = NO
  340. # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
  341. # scope will be included in the documentation.
  342. # The default value is: NO.
  343. EXTRACT_PACKAGE = NO
  344. # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
  345. # included in the documentation.
  346. # The default value is: NO.
  347. EXTRACT_STATIC = NO
  348. # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
  349. # locally in source files will be included in the documentation. If set to NO,
  350. # only classes defined in header files are included. Does not have any effect
  351. # for Java sources.
  352. # The default value is: YES.
  353. EXTRACT_LOCAL_CLASSES = YES
  354. # This flag is only useful for Objective-C code. If set to YES, local methods,
  355. # which are defined in the implementation section but not in the interface are
  356. # included in the documentation. If set to NO, only methods in the interface are
  357. # included.
  358. # The default value is: NO.
  359. EXTRACT_LOCAL_METHODS = NO
  360. # If this flag is set to YES, the members of anonymous namespaces will be
  361. # extracted and appear in the documentation as a namespace called
  362. # 'anonymous_namespace{file}', where file will be replaced with the base name of
  363. # the file that contains the anonymous namespace. By default anonymous namespace
  364. # are hidden.
  365. # The default value is: NO.
  366. EXTRACT_ANON_NSPACES = NO
  367. # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
  368. # undocumented members inside documented classes or files. If set to NO these
  369. # members will be included in the various overviews, but no documentation
  370. # section is generated. This option has no effect if EXTRACT_ALL is enabled.
  371. # The default value is: NO.
  372. HIDE_UNDOC_MEMBERS = NO
  373. # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
  374. # undocumented classes that are normally visible in the class hierarchy. If set
  375. # to NO, these classes will be included in the various overviews. This option
  376. # has no effect if EXTRACT_ALL is enabled.
  377. # The default value is: NO.
  378. HIDE_UNDOC_CLASSES = NO
  379. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
  380. # (class|struct|union) declarations. If set to NO, these declarations will be
  381. # included in the documentation.
  382. # The default value is: NO.
  383. HIDE_FRIEND_COMPOUNDS = NO
  384. # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
  385. # documentation blocks found inside the body of a function. If set to NO, these
  386. # blocks will be appended to the function's detailed documentation block.
  387. # The default value is: NO.
  388. HIDE_IN_BODY_DOCS = NO
  389. # The INTERNAL_DOCS tag determines if documentation that is typed after a
  390. # \internal command is included. If the tag is set to NO then the documentation
  391. # will be excluded. Set it to YES to include the internal documentation.
  392. # The default value is: NO.
  393. INTERNAL_DOCS = NO
  394. # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
  395. # names in lower-case letters. If set to YES, upper-case letters are also
  396. # allowed. This is useful if you have classes or files whose names only differ
  397. # in case and if your file system supports case sensitive file names. Windows
  398. # and Mac users are advised to set this option to NO.
  399. # The default value is: system dependent.
  400. CASE_SENSE_NAMES = NO
  401. # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
  402. # their full class and namespace scopes in the documentation. If set to YES, the
  403. # scope will be hidden.
  404. # The default value is: NO.
  405. HIDE_SCOPE_NAMES = NO
  406. # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
  407. # append additional text to a page's title, such as Class Reference. If set to
  408. # YES the compound reference will be hidden.
  409. # The default value is: NO.
  410. HIDE_COMPOUND_REFERENCE= NO
  411. # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
  412. # the files that are included by a file in the documentation of that file.
  413. # The default value is: YES.
  414. SHOW_INCLUDE_FILES = YES
  415. # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
  416. # grouped member an include statement to the documentation, telling the reader
  417. # which file to include in order to use the member.
  418. # The default value is: NO.
  419. SHOW_GROUPED_MEMB_INC = NO
  420. # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
  421. # files with double quotes in the documentation rather than with sharp brackets.
  422. # The default value is: NO.
  423. FORCE_LOCAL_INCLUDES = NO
  424. # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
  425. # documentation for inline members.
  426. # The default value is: YES.
  427. INLINE_INFO = YES
  428. # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
  429. # (detailed) documentation of file and class members alphabetically by member
  430. # name. If set to NO, the members will appear in declaration order.
  431. # The default value is: YES.
  432. SORT_MEMBER_DOCS = YES
  433. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
  434. # descriptions of file, namespace and class members alphabetically by member
  435. # name. If set to NO, the members will appear in declaration order. Note that
  436. # this will also influence the order of the classes in the class list.
  437. # The default value is: NO.
  438. SORT_BRIEF_DOCS = NO
  439. # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
  440. # (brief and detailed) documentation of class members so that constructors and
  441. # destructors are listed first. If set to NO the constructors will appear in the
  442. # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
  443. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
  444. # member documentation.
  445. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
  446. # detailed member documentation.
  447. # The default value is: NO.
  448. SORT_MEMBERS_CTORS_1ST = NO
  449. # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
  450. # of group names into alphabetical order. If set to NO the group names will
  451. # appear in their defined order.
  452. # The default value is: NO.
  453. SORT_GROUP_NAMES = NO
  454. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
  455. # fully-qualified names, including namespaces. If set to NO, the class list will
  456. # be sorted only by class name, not including the namespace part.
  457. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  458. # Note: This option applies only to the class list, not to the alphabetical
  459. # list.
  460. # The default value is: NO.
  461. SORT_BY_SCOPE_NAME = NO
  462. # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
  463. # type resolution of all parameters of a function it will reject a match between
  464. # the prototype and the implementation of a member function even if there is
  465. # only one candidate or it is obvious which candidate to choose by doing a
  466. # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
  467. # accept a match between prototype and implementation in such cases.
  468. # The default value is: NO.
  469. STRICT_PROTO_MATCHING = NO
  470. # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
  471. # list. This list is created by putting \todo commands in the documentation.
  472. # The default value is: YES.
  473. GENERATE_TODOLIST = YES
  474. # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
  475. # list. This list is created by putting \test commands in the documentation.
  476. # The default value is: YES.
  477. GENERATE_TESTLIST = YES
  478. # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
  479. # list. This list is created by putting \bug commands in the documentation.
  480. # The default value is: YES.
  481. GENERATE_BUGLIST = YES
  482. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
  483. # the deprecated list. This list is created by putting \deprecated commands in
  484. # the documentation.
  485. # The default value is: YES.
  486. GENERATE_DEPRECATEDLIST= YES
  487. # The ENABLED_SECTIONS tag can be used to enable conditional documentation
  488. # sections, marked by \if <section_label> ... \endif and \cond <section_label>
  489. # ... \endcond blocks.
  490. ENABLED_SECTIONS =
  491. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
  492. # initial value of a variable or macro / define can have for it to appear in the
  493. # documentation. If the initializer consists of more lines than specified here
  494. # it will be hidden. Use a value of 0 to hide initializers completely. The
  495. # appearance of the value of individual variables and macros / defines can be
  496. # controlled using \showinitializer or \hideinitializer command in the
  497. # documentation regardless of this setting.
  498. # Minimum value: 0, maximum value: 10000, default value: 30.
  499. MAX_INITIALIZER_LINES = 30
  500. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
  501. # the bottom of the documentation of classes and structs. If set to YES, the
  502. # list will mention the files that were used to generate the documentation.
  503. # The default value is: YES.
  504. SHOW_USED_FILES = YES
  505. # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
  506. # will remove the Files entry from the Quick Index and from the Folder Tree View
  507. # (if specified).
  508. # The default value is: YES.
  509. SHOW_FILES = YES
  510. # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
  511. # page. This will remove the Namespaces entry from the Quick Index and from the
  512. # Folder Tree View (if specified).
  513. # The default value is: YES.
  514. SHOW_NAMESPACES = YES
  515. # The FILE_VERSION_FILTER tag can be used to specify a program or script that
  516. # doxygen should invoke to get the current version for each file (typically from
  517. # the version control system). Doxygen will invoke the program by executing (via
  518. # popen()) the command command input-file, where command is the value of the
  519. # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
  520. # by doxygen. Whatever the program writes to standard output is used as the file
  521. # version. For an example see the documentation.
  522. FILE_VERSION_FILTER =
  523. # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  524. # by doxygen. The layout file controls the global structure of the generated
  525. # output files in an output format independent way. To create the layout file
  526. # that represents doxygen's defaults, run doxygen with the -l option. You can
  527. # optionally specify a file name after the option, if omitted DoxygenLayout.xml
  528. # will be used as the name of the layout file.
  529. #
  530. # Note that if you run doxygen from a directory containing a file called
  531. # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
  532. # tag is left empty.
  533. LAYOUT_FILE =
  534. # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
  535. # the reference definitions. This must be a list of .bib files. The .bib
  536. # extension is automatically appended if omitted. This requires the bibtex tool
  537. # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
  538. # For LaTeX the style of the bibliography can be controlled using
  539. # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
  540. # search path. See also \cite for info how to create references.
  541. CITE_BIB_FILES =
  542. #---------------------------------------------------------------------------
  543. # Configuration options related to warning and progress messages
  544. #---------------------------------------------------------------------------
  545. # The QUIET tag can be used to turn on/off the messages that are generated to
  546. # standard output by doxygen. If QUIET is set to YES this implies that the
  547. # messages are off.
  548. # The default value is: NO.
  549. QUIET = YES
  550. # The WARNINGS tag can be used to turn on/off the warning messages that are
  551. # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
  552. # this implies that the warnings are on.
  553. #
  554. # Tip: Turn warnings on while writing the documentation.
  555. # The default value is: YES.
  556. WARNINGS = YES
  557. # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
  558. # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
  559. # will automatically be disabled.
  560. # The default value is: YES.
  561. WARN_IF_UNDOCUMENTED = YES
  562. # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
  563. # potential errors in the documentation, such as not documenting some parameters
  564. # in a documented function, or documenting parameters that don't exist or using
  565. # markup commands wrongly.
  566. # The default value is: YES.
  567. WARN_IF_DOC_ERROR = YES
  568. # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
  569. # are documented, but have no documentation for their parameters or return
  570. # value. If set to NO, doxygen will only warn about wrong or incomplete
  571. # parameter documentation, but not about the absence of documentation.
  572. # The default value is: NO.
  573. WARN_NO_PARAMDOC = YES
  574. # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
  575. # a warning is encountered.
  576. # The default value is: NO.
  577. WARN_AS_ERROR = NO
  578. # The WARN_FORMAT tag determines the format of the warning messages that doxygen
  579. # can produce. The string should contain the $file, $line, and $text tags, which
  580. # will be replaced by the file and line number from which the warning originated
  581. # and the warning text. Optionally the format may contain $version, which will
  582. # be replaced by the version of the file (if it could be obtained via
  583. # FILE_VERSION_FILTER)
  584. # The default value is: $file:$line: $text.
  585. WARN_FORMAT = "$file:$line: $text"
  586. # The WARN_LOGFILE tag can be used to specify a file to which warning and error
  587. # messages should be written. If left blank the output is written to standard
  588. # error (stderr).
  589. WARN_LOGFILE = doxy.log
  590. #---------------------------------------------------------------------------
  591. # Configuration options related to the input files
  592. #---------------------------------------------------------------------------
  593. # The INPUT tag is used to specify the files and/or directories that contain
  594. # documented source files. You may enter file names like myfile.cpp or
  595. # directories like /usr/src/myproject. Separate the files or directories with
  596. # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
  597. # Note: If this tag is empty the current directory is searched.
  598. INPUT = ./ \
  599. ./src
  600. # This tag can be used to specify the character encoding of the source files
  601. # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
  602. # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
  603. # documentation (see: http://www.gnu.org/software/libiconv) for the list of
  604. # possible encodings.
  605. # The default value is: UTF-8.
  606. INPUT_ENCODING = UTF-8
  607. # If the value of the INPUT tag contains directories, you can use the
  608. # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
  609. # *.h) to filter out the source-files in the directories.
  610. #
  611. # Note that for custom extensions or not directly supported extensions you also
  612. # need to set EXTENSION_MAPPING for the extension otherwise the files are not
  613. # read by doxygen.
  614. #
  615. # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
  616. # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
  617. # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
  618. # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
  619. # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
  620. FILE_PATTERNS = *.c \
  621. *.cpp \
  622. *.h \
  623. *.ino
  624. # The RECURSIVE tag can be used to specify whether or not subdirectories should
  625. # be searched for input files as well.
  626. # The default value is: NO.
  627. RECURSIVE = YES
  628. # The EXCLUDE tag can be used to specify files and/or directories that should be
  629. # excluded from the INPUT source files. This way you can easily exclude a
  630. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  631. #
  632. # Note that relative paths are relative to the directory from which doxygen is
  633. # run.
  634. EXCLUDE = *.s
  635. # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
  636. # directories that are symbolic links (a Unix file system feature) are excluded
  637. # from the input.
  638. # The default value is: NO.
  639. EXCLUDE_SYMLINKS = NO
  640. # If the value of the INPUT tag contains directories, you can use the
  641. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  642. # certain files from those directories.
  643. #
  644. # Note that the wildcards are matched against the file with absolute path, so to
  645. # exclude all test directories for example use the pattern */test/*
  646. EXCLUDE_PATTERNS =
  647. # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  648. # (namespaces, classes, functions, etc.) that should be excluded from the
  649. # output. The symbol name can be a fully qualified name, a word, or if the
  650. # wildcard * is used, a substring. Examples: ANamespace, AClass,
  651. # AClass::ANamespace, ANamespace::*Test
  652. #
  653. # Note that the wildcards are matched against the file with absolute path, so to
  654. # exclude all test directories use the pattern */test/*
  655. EXCLUDE_SYMBOLS =
  656. # The EXAMPLE_PATH tag can be used to specify one or more files or directories
  657. # that contain example code fragments that are included (see the \include
  658. # command).
  659. EXAMPLE_PATH = examples/
  660. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  661. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
  662. # *.h) to filter out the source-files in the directories. If left blank all
  663. # files are included.
  664. EXAMPLE_PATTERNS = *
  665. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  666. # searched for input files to be used with the \include or \dontinclude commands
  667. # irrespective of the value of the RECURSIVE tag.
  668. # The default value is: NO.
  669. EXAMPLE_RECURSIVE = YES
  670. # The IMAGE_PATH tag can be used to specify one or more files or directories
  671. # that contain images that are to be included in the documentation (see the
  672. # \image command).
  673. IMAGE_PATH =
  674. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  675. # invoke to filter for each input file. Doxygen will invoke the filter program
  676. # by executing (via popen()) the command:
  677. #
  678. # <filter> <input-file>
  679. #
  680. # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
  681. # name of an input file. Doxygen will then use the output that the filter
  682. # program writes to standard output. If FILTER_PATTERNS is specified, this tag
  683. # will be ignored.
  684. #
  685. # Note that the filter must not add or remove lines; it is applied before the
  686. # code is scanned, but not when the output code is generated. If lines are added
  687. # or removed, the anchors will not be placed correctly.
  688. #
  689. # Note that for custom extensions or not directly supported extensions you also
  690. # need to set EXTENSION_MAPPING for the extension otherwise the files are not
  691. # properly processed by doxygen.
  692. INPUT_FILTER =
  693. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  694. # basis. Doxygen will compare the file name with each pattern and apply the
  695. # filter if there is a match. The filters are a list of the form: pattern=filter
  696. # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
  697. # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
  698. # patterns match the file name, INPUT_FILTER is applied.
  699. #
  700. # Note that for custom extensions or not directly supported extensions you also
  701. # need to set EXTENSION_MAPPING for the extension otherwise the files are not
  702. # properly processed by doxygen.
  703. FILTER_PATTERNS =
  704. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  705. # INPUT_FILTER) will also be used to filter the input files that are used for
  706. # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
  707. # The default value is: NO.
  708. FILTER_SOURCE_FILES = NO
  709. # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  710. # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
  711. # it is also possible to disable source filtering for a specific pattern using
  712. # *.ext= (so without naming a filter).
  713. # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
  714. FILTER_SOURCE_PATTERNS =
  715. # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
  716. # is part of the input, its contents will be placed on the main page
  717. # (index.html). This can be useful if you have a project on for instance GitHub
  718. # and want to reuse the introduction page also for the doxygen output.
  719. USE_MDFILE_AS_MAINPAGE = README.md
  720. #---------------------------------------------------------------------------
  721. # Configuration options related to source browsing
  722. #---------------------------------------------------------------------------
  723. # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
  724. # generated. Documented entities will be cross-referenced with these sources.
  725. #
  726. # Note: To get rid of all source code in the generated output, make sure that
  727. # also VERBATIM_HEADERS is set to NO.
  728. # The default value is: NO.
  729. SOURCE_BROWSER = NO
  730. # Setting the INLINE_SOURCES tag to YES will include the body of functions,
  731. # classes and enums directly into the documentation.
  732. # The default value is: NO.
  733. INLINE_SOURCES = NO
  734. # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
  735. # special comment blocks from generated source code fragments. Normal C, C++ and
  736. # Fortran comments will always remain visible.
  737. # The default value is: YES.
  738. STRIP_CODE_COMMENTS = YES
  739. # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
  740. # function all documented functions referencing it will be listed.
  741. # The default value is: NO.
  742. REFERENCED_BY_RELATION = NO
  743. # If the REFERENCES_RELATION tag is set to YES then for each documented function
  744. # all documented entities called/used by that function will be listed.
  745. # The default value is: NO.
  746. REFERENCES_RELATION = NO
  747. # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
  748. # to YES then the hyperlinks from functions in REFERENCES_RELATION and
  749. # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
  750. # link to the documentation.
  751. # The default value is: YES.
  752. REFERENCES_LINK_SOURCE = YES
  753. # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
  754. # source code will show a tooltip with additional information such as prototype,
  755. # brief description and links to the definition and documentation. Since this
  756. # will make the HTML file larger and loading of large files a bit slower, you
  757. # can opt to disable this feature.
  758. # The default value is: YES.
  759. # This tag requires that the tag SOURCE_BROWSER is set to YES.
  760. SOURCE_TOOLTIPS = YES
  761. # If the USE_HTAGS tag is set to YES then the references to source code will
  762. # point to the HTML generated by the htags(1) tool instead of doxygen built-in
  763. # source browser. The htags tool is part of GNU's global source tagging system
  764. # (see http://www.gnu.org/software/global/global.html). You will need version
  765. # 4.8.6 or higher.
  766. #
  767. # To use it do the following:
  768. # - Install the latest version of global
  769. # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
  770. # - Make sure the INPUT points to the root of the source tree
  771. # - Run doxygen as normal
  772. #
  773. # Doxygen will invoke htags (and that will in turn invoke gtags), so these
  774. # tools must be available from the command line (i.e. in the search path).
  775. #
  776. # The result: instead of the source browser generated by doxygen, the links to
  777. # source code will now point to the output of htags.
  778. # The default value is: NO.
  779. # This tag requires that the tag SOURCE_BROWSER is set to YES.
  780. USE_HTAGS = NO
  781. # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
  782. # verbatim copy of the header file for each class for which an include is
  783. # specified. Set to NO to disable this.
  784. # See also: Section \class.
  785. # The default value is: YES.
  786. VERBATIM_HEADERS = YES
  787. # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
  788. # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
  789. # cost of reduced performance. This can be particularly helpful with template
  790. # rich C++ code for which doxygen's built-in parser lacks the necessary type
  791. # information.
  792. # Note: The availability of this option depends on whether or not doxygen was
  793. # generated with the -Duse-libclang=ON option for CMake.
  794. # The default value is: NO.
  795. CLANG_ASSISTED_PARSING = NO
  796. # If clang assisted parsing is enabled you can provide the compiler with command
  797. # line options that you would normally use when invoking the compiler. Note that
  798. # the include paths will already be set by doxygen for the files and directories
  799. # specified with INPUT and INCLUDE_PATH.
  800. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
  801. CLANG_OPTIONS =
  802. #---------------------------------------------------------------------------
  803. # Configuration options related to the alphabetical class index
  804. #---------------------------------------------------------------------------
  805. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
  806. # compounds will be generated. Enable this if the project contains a lot of
  807. # classes, structs, unions or interfaces.
  808. # The default value is: YES.
  809. ALPHABETICAL_INDEX = YES
  810. # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
  811. # which the alphabetical index list will be split.
  812. # Minimum value: 1, maximum value: 20, default value: 5.
  813. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  814. COLS_IN_ALPHA_INDEX = 5
  815. # In case all classes in a project start with a common prefix, all classes will
  816. # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
  817. # can be used to specify a prefix (or a list of prefixes) that should be ignored
  818. # while generating the index headers.
  819. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  820. IGNORE_PREFIX =
  821. #---------------------------------------------------------------------------
  822. # Configuration options related to the HTML output
  823. #---------------------------------------------------------------------------
  824. # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
  825. # The default value is: YES.
  826. GENERATE_HTML = YES
  827. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
  828. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  829. # it.
  830. # The default directory is: html.
  831. # This tag requires that the tag GENERATE_HTML is set to YES.
  832. HTML_OUTPUT = html
  833. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
  834. # generated HTML page (for example: .htm, .php, .asp).
  835. # The default value is: .html.
  836. # This tag requires that the tag GENERATE_HTML is set to YES.
  837. HTML_FILE_EXTENSION = .html
  838. # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
  839. # each generated HTML page. If the tag is left blank doxygen will generate a
  840. # standard header.
  841. #
  842. # To get valid HTML the header file that includes any scripts and style sheets
  843. # that doxygen needs, which is dependent on the configuration options used (e.g.
  844. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
  845. # default header using
  846. # doxygen -w html new_header.html new_footer.html new_stylesheet.css
  847. # YourConfigFile
  848. # and then modify the file new_header.html. See also section "Doxygen usage"
  849. # for information on how to generate the default header that doxygen normally
  850. # uses.
  851. # Note: The header is subject to change so you typically have to regenerate the
  852. # default header when upgrading to a newer version of doxygen. For a description
  853. # of the possible markers and block names see the documentation.
  854. # This tag requires that the tag GENERATE_HTML is set to YES.
  855. HTML_HEADER =
  856. # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
  857. # generated HTML page. If the tag is left blank doxygen will generate a standard
  858. # footer. See HTML_HEADER for more information on how to generate a default
  859. # footer and what special commands can be used inside the footer. See also
  860. # section "Doxygen usage" for information on how to generate the default footer
  861. # that doxygen normally uses.
  862. # This tag requires that the tag GENERATE_HTML is set to YES.
  863. HTML_FOOTER =
  864. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
  865. # sheet that is used by each HTML page. It can be used to fine-tune the look of
  866. # the HTML output. If left blank doxygen will generate a default style sheet.
  867. # See also section "Doxygen usage" for information on how to generate the style
  868. # sheet that doxygen normally uses.
  869. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
  870. # it is more robust and this tag (HTML_STYLESHEET) will in the future become
  871. # obsolete.
  872. # This tag requires that the tag GENERATE_HTML is set to YES.
  873. HTML_STYLESHEET =
  874. # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  875. # cascading style sheets that are included after the standard style sheets
  876. # created by doxygen. Using this option one can overrule certain style aspects.
  877. # This is preferred over using HTML_STYLESHEET since it does not replace the
  878. # standard style sheet and is therefore more robust against future updates.
  879. # Doxygen will copy the style sheet files to the output directory.
  880. # Note: The order of the extra style sheet files is of importance (e.g. the last
  881. # style sheet in the list overrules the setting of the previous ones in the
  882. # list). For an example see the documentation.
  883. # This tag requires that the tag GENERATE_HTML is set to YES.
  884. HTML_EXTRA_STYLESHEET =
  885. # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  886. # other source files which should be copied to the HTML output directory. Note
  887. # that these files will be copied to the base HTML output directory. Use the
  888. # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  889. # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
  890. # files will be copied as-is; there are no commands or markers available.
  891. # This tag requires that the tag GENERATE_HTML is set to YES.
  892. HTML_EXTRA_FILES =
  893. # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
  894. # will adjust the colors in the style sheet and background images according to
  895. # this color. Hue is specified as an angle on a colorwheel, see
  896. # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
  897. # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
  898. # purple, and 360 is red again.
  899. # Minimum value: 0, maximum value: 359, default value: 220.
  900. # This tag requires that the tag GENERATE_HTML is set to YES.
  901. HTML_COLORSTYLE_HUE = 220
  902. # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
  903. # in the HTML output. For a value of 0 the output will use grayscales only. A
  904. # value of 255 will produce the most vivid colors.
  905. # Minimum value: 0, maximum value: 255, default value: 100.
  906. # This tag requires that the tag GENERATE_HTML is set to YES.
  907. HTML_COLORSTYLE_SAT = 100
  908. # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
  909. # luminance component of the colors in the HTML output. Values below 100
  910. # gradually make the output lighter, whereas values above 100 make the output
  911. # darker. The value divided by 100 is the actual gamma applied, so 80 represents
  912. # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
  913. # change the gamma.
  914. # Minimum value: 40, maximum value: 240, default value: 80.
  915. # This tag requires that the tag GENERATE_HTML is set to YES.
  916. HTML_COLORSTYLE_GAMMA = 80
  917. # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  918. # page will contain the date and time when the page was generated. Setting this
  919. # to YES can help to show when doxygen was last run and thus if the
  920. # documentation is up to date.
  921. # The default value is: NO.
  922. # This tag requires that the tag GENERATE_HTML is set to YES.
  923. HTML_TIMESTAMP = NO
  924. # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  925. # documentation will contain sections that can be hidden and shown after the
  926. # page has loaded.
  927. # The default value is: NO.
  928. # This tag requires that the tag GENERATE_HTML is set to YES.
  929. HTML_DYNAMIC_SECTIONS = NO
  930. # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
  931. # shown in the various tree structured indices initially; the user can expand
  932. # and collapse entries dynamically later on. Doxygen will expand the tree to
  933. # such a level that at most the specified number of entries are visible (unless
  934. # a fully collapsed tree already exceeds this amount). So setting the number of
  935. # entries 1 will produce a full collapsed tree by default. 0 is a special value
  936. # representing an infinite number of entries and will result in a full expanded
  937. # tree by default.
  938. # Minimum value: 0, maximum value: 9999, default value: 100.
  939. # This tag requires that the tag GENERATE_HTML is set to YES.
  940. HTML_INDEX_NUM_ENTRIES = 100
  941. # If the GENERATE_DOCSET tag is set to YES, additional index files will be
  942. # generated that can be used as input for Apple's Xcode 3 integrated development
  943. # environment (see: http://developer.apple.com/tools/xcode/), introduced with
  944. # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
  945. # Makefile in the HTML output directory. Running make will produce the docset in
  946. # that directory and running make install will install the docset in
  947. # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
  948. # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  949. # for more information.
  950. # The default value is: NO.
  951. # This tag requires that the tag GENERATE_HTML is set to YES.
  952. GENERATE_DOCSET = NO
  953. # This tag determines the name of the docset feed. A documentation feed provides
  954. # an umbrella under which multiple documentation sets from a single provider
  955. # (such as a company or product suite) can be grouped.
  956. # The default value is: Doxygen generated docs.
  957. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  958. DOCSET_FEEDNAME = "Doxygen generated docs"
  959. # This tag specifies a string that should uniquely identify the documentation
  960. # set bundle. This should be a reverse domain-name style string, e.g.
  961. # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
  962. # The default value is: org.doxygen.Project.
  963. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  964. DOCSET_BUNDLE_ID = org.doxygen.Project
  965. # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
  966. # the documentation publisher. This should be a reverse domain-name style
  967. # string, e.g. com.mycompany.MyDocSet.documentation.
  968. # The default value is: org.doxygen.Publisher.
  969. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  970. DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  971. # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
  972. # The default value is: Publisher.
  973. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  974. DOCSET_PUBLISHER_NAME = Publisher
  975. # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
  976. # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
  977. # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
  978. # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
  979. # Windows.
  980. #
  981. # The HTML Help Workshop contains a compiler that can convert all HTML output
  982. # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
  983. # files are now used as the Windows 98 help format, and will replace the old
  984. # Windows help format (.hlp) on all Windows platforms in the future. Compressed
  985. # HTML files also contain an index, a table of contents, and you can search for
  986. # words in the documentation. The HTML workshop also contains a viewer for
  987. # compressed HTML files.
  988. # The default value is: NO.
  989. # This tag requires that the tag GENERATE_HTML is set to YES.
  990. GENERATE_HTMLHELP = NO
  991. # The CHM_FILE tag can be used to specify the file name of the resulting .chm
  992. # file. You can add a path in front of the file if the result should not be
  993. # written to the html output directory.
  994. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  995. CHM_FILE =
  996. # The HHC_LOCATION tag can be used to specify the location (absolute path
  997. # including file name) of the HTML help compiler (hhc.exe). If non-empty,
  998. # doxygen will try to run the HTML help compiler on the generated index.hhp.
  999. # The file has to be specified with full path.
  1000. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1001. HHC_LOCATION =
  1002. # The GENERATE_CHI flag controls if a separate .chi index file is generated
  1003. # (YES) or that it should be included in the master .chm file (NO).
  1004. # The default value is: NO.
  1005. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1006. GENERATE_CHI = NO
  1007. # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
  1008. # and project file content.
  1009. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1010. CHM_INDEX_ENCODING =
  1011. # The BINARY_TOC flag controls whether a binary table of contents is generated
  1012. # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
  1013. # enables the Previous and Next buttons.
  1014. # The default value is: NO.
  1015. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1016. BINARY_TOC = NO
  1017. # The TOC_EXPAND flag can be set to YES to add extra items for group members to
  1018. # the table of contents of the HTML help documentation and to the tree view.
  1019. # The default value is: NO.
  1020. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1021. TOC_EXPAND = NO
  1022. # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  1023. # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
  1024. # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
  1025. # (.qch) of the generated HTML documentation.
  1026. # The default value is: NO.
  1027. # This tag requires that the tag GENERATE_HTML is set to YES.
  1028. GENERATE_QHP = NO
  1029. # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
  1030. # the file name of the resulting .qch file. The path specified is relative to
  1031. # the HTML output folder.
  1032. # This tag requires that the tag GENERATE_QHP is set to YES.
  1033. QCH_FILE =
  1034. # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
  1035. # Project output. For more information please see Qt Help Project / Namespace
  1036. # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
  1037. # The default value is: org.doxygen.Project.
  1038. # This tag requires that the tag GENERATE_QHP is set to YES.
  1039. QHP_NAMESPACE = org.doxygen.Project
  1040. # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
  1041. # Help Project output. For more information please see Qt Help Project / Virtual
  1042. # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
  1043. # folders).
  1044. # The default value is: doc.
  1045. # This tag requires that the tag GENERATE_QHP is set to YES.
  1046. QHP_VIRTUAL_FOLDER = doc
  1047. # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
  1048. # filter to add. For more information please see Qt Help Project / Custom
  1049. # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1050. # filters).
  1051. # This tag requires that the tag GENERATE_QHP is set to YES.
  1052. QHP_CUST_FILTER_NAME =
  1053. # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
  1054. # custom filter to add. For more information please see Qt Help Project / Custom
  1055. # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1056. # filters).
  1057. # This tag requires that the tag GENERATE_QHP is set to YES.
  1058. QHP_CUST_FILTER_ATTRS =
  1059. # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  1060. # project's filter section matches. Qt Help Project / Filter Attributes (see:
  1061. # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
  1062. # This tag requires that the tag GENERATE_QHP is set to YES.
  1063. QHP_SECT_FILTER_ATTRS =
  1064. # The QHG_LOCATION tag can be used to specify the location of Qt's
  1065. # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
  1066. # generated .qhp file.
  1067. # This tag requires that the tag GENERATE_QHP is set to YES.
  1068. QHG_LOCATION =
  1069. # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
  1070. # generated, together with the HTML files, they form an Eclipse help plugin. To
  1071. # install this plugin and make it available under the help contents menu in
  1072. # Eclipse, the contents of the directory containing the HTML and XML files needs
  1073. # to be copied into the plugins directory of eclipse. The name of the directory
  1074. # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
  1075. # After copying Eclipse needs to be restarted before the help appears.
  1076. # The default value is: NO.
  1077. # This tag requires that the tag GENERATE_HTML is set to YES.
  1078. GENERATE_ECLIPSEHELP = NO
  1079. # A unique identifier for the Eclipse help plugin. When installing the plugin
  1080. # the directory name containing the HTML and XML files should also have this
  1081. # name. Each documentation set should have its own identifier.
  1082. # The default value is: org.doxygen.Project.
  1083. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
  1084. ECLIPSE_DOC_ID = org.doxygen.Project
  1085. # If you want full control over the layout of the generated HTML pages it might
  1086. # be necessary to disable the index and replace it with your own. The
  1087. # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
  1088. # of each HTML page. A value of NO enables the index and the value YES disables
  1089. # it. Since the tabs in the index contain the same information as the navigation
  1090. # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
  1091. # The default value is: NO.
  1092. # This tag requires that the tag GENERATE_HTML is set to YES.
  1093. DISABLE_INDEX = NO
  1094. # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  1095. # structure should be generated to display hierarchical information. If the tag
  1096. # value is set to YES, a side panel will be generated containing a tree-like
  1097. # index structure (just like the one that is generated for HTML Help). For this
  1098. # to work a browser that supports JavaScript, DHTML, CSS and frames is required
  1099. # (i.e. any modern browser). Windows users are probably better off using the
  1100. # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
  1101. # further fine-tune the look of the index. As an example, the default style
  1102. # sheet generated by doxygen has an example that shows how to put an image at
  1103. # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
  1104. # the same information as the tab index, you could consider setting
  1105. # DISABLE_INDEX to YES when enabling this option.
  1106. # The default value is: NO.
  1107. # This tag requires that the tag GENERATE_HTML is set to YES.
  1108. GENERATE_TREEVIEW = NO
  1109. # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
  1110. # doxygen will group on one line in the generated HTML documentation.
  1111. #
  1112. # Note that a value of 0 will completely suppress the enum values from appearing
  1113. # in the overview section.
  1114. # Minimum value: 0, maximum value: 20, default value: 4.
  1115. # This tag requires that the tag GENERATE_HTML is set to YES.
  1116. ENUM_VALUES_PER_LINE = 4
  1117. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
  1118. # to set the initial width (in pixels) of the frame in which the tree is shown.
  1119. # Minimum value: 0, maximum value: 1500, default value: 250.
  1120. # This tag requires that the tag GENERATE_HTML is set to YES.
  1121. TREEVIEW_WIDTH = 250
  1122. # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
  1123. # external symbols imported via tag files in a separate window.
  1124. # The default value is: NO.
  1125. # This tag requires that the tag GENERATE_HTML is set to YES.
  1126. EXT_LINKS_IN_WINDOW = NO
  1127. # Use this tag to change the font size of LaTeX formulas included as images in
  1128. # the HTML documentation. When you change the font size after a successful
  1129. # doxygen run you need to manually remove any form_*.png images from the HTML
  1130. # output directory to force them to be regenerated.
  1131. # Minimum value: 8, maximum value: 50, default value: 10.
  1132. # This tag requires that the tag GENERATE_HTML is set to YES.
  1133. FORMULA_FONTSIZE = 10
  1134. # Use the FORMULA_TRANPARENT tag to determine whether or not the images
  1135. # generated for formulas are transparent PNGs. Transparent PNGs are not
  1136. # supported properly for IE 6.0, but are supported on all modern browsers.
  1137. #
  1138. # Note that when changing this option you need to delete any form_*.png files in
  1139. # the HTML output directory before the changes have effect.
  1140. # The default value is: YES.
  1141. # This tag requires that the tag GENERATE_HTML is set to YES.
  1142. FORMULA_TRANSPARENT = YES
  1143. # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
  1144. # http://www.mathjax.org) which uses client side Javascript for the rendering
  1145. # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
  1146. # installed or if you want to formulas look prettier in the HTML output. When
  1147. # enabled you may also need to install MathJax separately and configure the path
  1148. # to it using the MATHJAX_RELPATH option.
  1149. # The default value is: NO.
  1150. # This tag requires that the tag GENERATE_HTML is set to YES.
  1151. USE_MATHJAX = NO
  1152. # When MathJax is enabled you can set the default output format to be used for
  1153. # the MathJax output. See the MathJax site (see:
  1154. # http://docs.mathjax.org/en/latest/output.html) for more details.
  1155. # Possible values are: HTML-CSS (which is slower, but has the best
  1156. # compatibility), NativeMML (i.e. MathML) and SVG.
  1157. # The default value is: HTML-CSS.
  1158. # This tag requires that the tag USE_MATHJAX is set to YES.
  1159. MATHJAX_FORMAT = HTML-CSS
  1160. # When MathJax is enabled you need to specify the location relative to the HTML
  1161. # output directory using the MATHJAX_RELPATH option. The destination directory
  1162. # should contain the MathJax.js script. For instance, if the mathjax directory
  1163. # is located at the same level as the HTML output directory, then
  1164. # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
  1165. # Content Delivery Network so you can quickly see the result without installing
  1166. # MathJax. However, it is strongly recommended to install a local copy of
  1167. # MathJax from http://www.mathjax.org before deployment.
  1168. # The default value is: http://cdn.mathjax.org/mathjax/latest.
  1169. # This tag requires that the tag USE_MATHJAX is set to YES.
  1170. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
  1171. # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
  1172. # extension names that should be enabled during MathJax rendering. For example
  1173. # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
  1174. # This tag requires that the tag USE_MATHJAX is set to YES.
  1175. MATHJAX_EXTENSIONS =
  1176. # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
  1177. # of code that will be used on startup of the MathJax code. See the MathJax site
  1178. # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
  1179. # example see the documentation.
  1180. # This tag requires that the tag USE_MATHJAX is set to YES.
  1181. MATHJAX_CODEFILE =
  1182. # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
  1183. # the HTML output. The underlying search engine uses javascript and DHTML and
  1184. # should work on any modern browser. Note that when using HTML help
  1185. # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
  1186. # there is already a search function so this one should typically be disabled.
  1187. # For large projects the javascript based search engine can be slow, then
  1188. # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
  1189. # search using the keyboard; to jump to the search box use <access key> + S
  1190. # (what the <access key> is depends on the OS and browser, but it is typically
  1191. # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
  1192. # key> to jump into the search results window, the results can be navigated
  1193. # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
  1194. # the search. The filter options can be selected when the cursor is inside the
  1195. # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
  1196. # to select a filter and <Enter> or <escape> to activate or cancel the filter
  1197. # option.
  1198. # The default value is: YES.
  1199. # This tag requires that the tag GENERATE_HTML is set to YES.
  1200. SEARCHENGINE = YES
  1201. # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  1202. # implemented using a web server instead of a web client using Javascript. There
  1203. # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
  1204. # setting. When disabled, doxygen will generate a PHP script for searching and
  1205. # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
  1206. # and searching needs to be provided by external tools. See the section
  1207. # "External Indexing and Searching" for details.
  1208. # The default value is: NO.
  1209. # This tag requires that the tag SEARCHENGINE is set to YES.
  1210. SERVER_BASED_SEARCH = NO
  1211. # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
  1212. # script for searching. Instead the search results are written to an XML file
  1213. # which needs to be processed by an external indexer. Doxygen will invoke an
  1214. # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
  1215. # search results.
  1216. #
  1217. # Doxygen ships with an example indexer (doxyindexer) and search engine
  1218. # (doxysearch.cgi) which are based on the open source search engine library
  1219. # Xapian (see: http://xapian.org/).
  1220. #
  1221. # See the section "External Indexing and Searching" for details.
  1222. # The default value is: NO.
  1223. # This tag requires that the tag SEARCHENGINE is set to YES.
  1224. EXTERNAL_SEARCH = NO
  1225. # The SEARCHENGINE_URL should point to a search engine hosted by a web server
  1226. # which will return the search results when EXTERNAL_SEARCH is enabled.
  1227. #
  1228. # Doxygen ships with an example indexer (doxyindexer) and search engine
  1229. # (doxysearch.cgi) which are based on the open source search engine library
  1230. # Xapian (see: http://xapian.org/). See the section "External Indexing and
  1231. # Searching" for details.
  1232. # This tag requires that the tag SEARCHENGINE is set to YES.
  1233. SEARCHENGINE_URL =
  1234. # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
  1235. # search data is written to a file for indexing by an external tool. With the
  1236. # SEARCHDATA_FILE tag the name of this file can be specified.
  1237. # The default file is: searchdata.xml.
  1238. # This tag requires that the tag SEARCHENGINE is set to YES.
  1239. SEARCHDATA_FILE = searchdata.xml
  1240. # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
  1241. # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
  1242. # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
  1243. # projects and redirect the results back to the right project.
  1244. # This tag requires that the tag SEARCHENGINE is set to YES.
  1245. EXTERNAL_SEARCH_ID =
  1246. # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
  1247. # projects other than the one defined by this configuration file, but that are
  1248. # all added to the same external search index. Each project needs to have a
  1249. # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
  1250. # to a relative location where the documentation can be found. The format is:
  1251. # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
  1252. # This tag requires that the tag SEARCHENGINE is set to YES.
  1253. EXTRA_SEARCH_MAPPINGS =
  1254. #---------------------------------------------------------------------------
  1255. # Configuration options related to the LaTeX output
  1256. #---------------------------------------------------------------------------
  1257. # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
  1258. # The default value is: YES.
  1259. GENERATE_LATEX = NO
  1260. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
  1261. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1262. # it.
  1263. # The default directory is: latex.
  1264. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1265. LATEX_OUTPUT = latex
  1266. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  1267. # invoked.
  1268. #
  1269. # Note that when enabling USE_PDFLATEX this option is only used for generating
  1270. # bitmaps for formulas in the HTML output, but not in the Makefile that is
  1271. # written to the output directory.
  1272. # The default file is: latex.
  1273. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1274. LATEX_CMD_NAME = latex
  1275. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
  1276. # index for LaTeX.
  1277. # The default file is: makeindex.
  1278. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1279. MAKEINDEX_CMD_NAME = makeindex
  1280. # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
  1281. # documents. This may be useful for small projects and may help to save some
  1282. # trees in general.
  1283. # The default value is: NO.
  1284. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1285. COMPACT_LATEX = YES
  1286. # The PAPER_TYPE tag can be used to set the paper type that is used by the
  1287. # printer.
  1288. # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
  1289. # 14 inches) and executive (7.25 x 10.5 inches).
  1290. # The default value is: a4.
  1291. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1292. PAPER_TYPE = a4
  1293. # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
  1294. # that should be included in the LaTeX output. The package can be specified just
  1295. # by its name or with the correct syntax as to be used with the LaTeX
  1296. # \usepackage command. To get the times font for instance you can specify :
  1297. # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
  1298. # To use the option intlimits with the amsmath package you can specify:
  1299. # EXTRA_PACKAGES=[intlimits]{amsmath}
  1300. # If left blank no extra packages will be included.
  1301. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1302. EXTRA_PACKAGES =
  1303. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
  1304. # generated LaTeX document. The header should contain everything until the first
  1305. # chapter. If it is left blank doxygen will generate a standard header. See
  1306. # section "Doxygen usage" for information on how to let doxygen write the
  1307. # default header to a separate file.
  1308. #
  1309. # Note: Only use a user-defined header if you know what you are doing! The
  1310. # following commands have a special meaning inside the header: $title,
  1311. # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
  1312. # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
  1313. # string, for the replacement values of the other commands the user is referred
  1314. # to HTML_HEADER.
  1315. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1316. LATEX_HEADER =
  1317. # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
  1318. # generated LaTeX document. The footer should contain everything after the last
  1319. # chapter. If it is left blank doxygen will generate a standard footer. See
  1320. # LATEX_HEADER for more information on how to generate a default footer and what
  1321. # special commands can be used inside the footer.
  1322. #
  1323. # Note: Only use a user-defined footer if you know what you are doing!
  1324. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1325. LATEX_FOOTER =
  1326. # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  1327. # LaTeX style sheets that are included after the standard style sheets created
  1328. # by doxygen. Using this option one can overrule certain style aspects. Doxygen
  1329. # will copy the style sheet files to the output directory.
  1330. # Note: The order of the extra style sheet files is of importance (e.g. the last
  1331. # style sheet in the list overrules the setting of the previous ones in the
  1332. # list).
  1333. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1334. LATEX_EXTRA_STYLESHEET =
  1335. # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
  1336. # other source files which should be copied to the LATEX_OUTPUT output
  1337. # directory. Note that the files will be copied as-is; there are no commands or
  1338. # markers available.
  1339. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1340. LATEX_EXTRA_FILES =
  1341. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
  1342. # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
  1343. # contain links (just like the HTML output) instead of page references. This
  1344. # makes the output suitable for online browsing using a PDF viewer.
  1345. # The default value is: YES.
  1346. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1347. PDF_HYPERLINKS = YES
  1348. # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
  1349. # the PDF file directly from the LaTeX files. Set this option to YES, to get a
  1350. # higher quality PDF documentation.
  1351. # The default value is: YES.
  1352. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1353. USE_PDFLATEX = YES
  1354. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
  1355. # command to the generated LaTeX files. This will instruct LaTeX to keep running
  1356. # if errors occur, instead of asking the user for help. This option is also used
  1357. # when generating formulas in HTML.
  1358. # The default value is: NO.
  1359. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1360. LATEX_BATCHMODE = NO
  1361. # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
  1362. # index chapters (such as File Index, Compound Index, etc.) in the output.
  1363. # The default value is: NO.
  1364. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1365. LATEX_HIDE_INDICES = NO
  1366. # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
  1367. # code with syntax highlighting in the LaTeX output.
  1368. #
  1369. # Note that which sources are shown also depends on other settings such as
  1370. # SOURCE_BROWSER.
  1371. # The default value is: NO.
  1372. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1373. LATEX_SOURCE_CODE = NO
  1374. # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1375. # bibliography, e.g. plainnat, or ieeetr. See
  1376. # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  1377. # The default value is: plain.
  1378. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1379. LATEX_BIB_STYLE = plain
  1380. # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
  1381. # page will contain the date and time when the page was generated. Setting this
  1382. # to NO can help when comparing the output of multiple runs.
  1383. # The default value is: NO.
  1384. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1385. LATEX_TIMESTAMP = NO
  1386. #---------------------------------------------------------------------------
  1387. # Configuration options related to the RTF output
  1388. #---------------------------------------------------------------------------
  1389. # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
  1390. # RTF output is optimized for Word 97 and may not look too pretty with other RTF
  1391. # readers/editors.
  1392. # The default value is: NO.
  1393. GENERATE_RTF = NO
  1394. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
  1395. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1396. # it.
  1397. # The default directory is: rtf.
  1398. # This tag requires that the tag GENERATE_RTF is set to YES.
  1399. RTF_OUTPUT = rtf
  1400. # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
  1401. # documents. This may be useful for small projects and may help to save some
  1402. # trees in general.
  1403. # The default value is: NO.
  1404. # This tag requires that the tag GENERATE_RTF is set to YES.
  1405. COMPACT_RTF = YES
  1406. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
  1407. # contain hyperlink fields. The RTF file will contain links (just like the HTML
  1408. # output) instead of page references. This makes the output suitable for online
  1409. # browsing using Word or some other Word compatible readers that support those
  1410. # fields.
  1411. #
  1412. # Note: WordPad (write) and others do not support links.
  1413. # The default value is: NO.
  1414. # This tag requires that the tag GENERATE_RTF is set to YES.
  1415. RTF_HYPERLINKS = YES
  1416. # Load stylesheet definitions from file. Syntax is similar to doxygen's config
  1417. # file, i.e. a series of assignments. You only have to provide replacements,
  1418. # missing definitions are set to their default value.
  1419. #
  1420. # See also section "Doxygen usage" for information on how to generate the
  1421. # default style sheet that doxygen normally uses.
  1422. # This tag requires that the tag GENERATE_RTF is set to YES.
  1423. RTF_STYLESHEET_FILE =
  1424. # Set optional variables used in the generation of an RTF document. Syntax is
  1425. # similar to doxygen's config file. A template extensions file can be generated
  1426. # using doxygen -e rtf extensionFile.
  1427. # This tag requires that the tag GENERATE_RTF is set to YES.
  1428. RTF_EXTENSIONS_FILE =
  1429. # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
  1430. # with syntax highlighting in the RTF output.
  1431. #
  1432. # Note that which sources are shown also depends on other settings such as
  1433. # SOURCE_BROWSER.
  1434. # The default value is: NO.
  1435. # This tag requires that the tag GENERATE_RTF is set to YES.
  1436. RTF_SOURCE_CODE = YES
  1437. #---------------------------------------------------------------------------
  1438. # Configuration options related to the man page output
  1439. #---------------------------------------------------------------------------
  1440. # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
  1441. # classes and files.
  1442. # The default value is: NO.
  1443. GENERATE_MAN = NO
  1444. # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
  1445. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1446. # it. A directory man3 will be created inside the directory specified by
  1447. # MAN_OUTPUT.
  1448. # The default directory is: man.
  1449. # This tag requires that the tag GENERATE_MAN is set to YES.
  1450. MAN_OUTPUT = man
  1451. # The MAN_EXTENSION tag determines the extension that is added to the generated
  1452. # man pages. In case the manual section does not start with a number, the number
  1453. # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
  1454. # optional.
  1455. # The default value is: .3.
  1456. # This tag requires that the tag GENERATE_MAN is set to YES.
  1457. MAN_EXTENSION = .3
  1458. # The MAN_SUBDIR tag determines the name of the directory created within
  1459. # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
  1460. # MAN_EXTENSION with the initial . removed.
  1461. # This tag requires that the tag GENERATE_MAN is set to YES.
  1462. MAN_SUBDIR = pages
  1463. # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
  1464. # will generate one additional man file for each entity documented in the real
  1465. # man page(s). These additional files only source the real man page, but without
  1466. # them the man command would be unable to find the correct page.
  1467. # The default value is: NO.
  1468. # This tag requires that the tag GENERATE_MAN is set to YES.
  1469. MAN_LINKS = YES
  1470. #---------------------------------------------------------------------------
  1471. # Configuration options related to the XML output
  1472. #---------------------------------------------------------------------------
  1473. # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
  1474. # captures the structure of the code including all documentation.
  1475. # The default value is: NO.
  1476. GENERATE_XML = NO
  1477. # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
  1478. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1479. # it.
  1480. # The default directory is: xml.
  1481. # This tag requires that the tag GENERATE_XML is set to YES.
  1482. XML_OUTPUT = xml
  1483. # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
  1484. # listings (including syntax highlighting and cross-referencing information) to
  1485. # the XML output. Note that enabling this will significantly increase the size
  1486. # of the XML output.
  1487. # The default value is: YES.
  1488. # This tag requires that the tag GENERATE_XML is set to YES.
  1489. XML_PROGRAMLISTING = YES
  1490. #---------------------------------------------------------------------------
  1491. # Configuration options related to the DOCBOOK output
  1492. #---------------------------------------------------------------------------
  1493. # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
  1494. # that can be used to generate PDF.
  1495. # The default value is: NO.
  1496. GENERATE_DOCBOOK = NO
  1497. # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
  1498. # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
  1499. # front of it.
  1500. # The default directory is: docbook.
  1501. # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1502. DOCBOOK_OUTPUT = docbook
  1503. # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
  1504. # program listings (including syntax highlighting and cross-referencing
  1505. # information) to the DOCBOOK output. Note that enabling this will significantly
  1506. # increase the size of the DOCBOOK output.
  1507. # The default value is: NO.
  1508. # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1509. DOCBOOK_PROGRAMLISTING = NO
  1510. #---------------------------------------------------------------------------
  1511. # Configuration options for the AutoGen Definitions output
  1512. #---------------------------------------------------------------------------
  1513. # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
  1514. # AutoGen Definitions (see http://autogen.sf.net) file that captures the
  1515. # structure of the code including all documentation. Note that this feature is
  1516. # still experimental and incomplete at the moment.
  1517. # The default value is: NO.
  1518. GENERATE_AUTOGEN_DEF = NO
  1519. #---------------------------------------------------------------------------
  1520. # Configuration options related to the Perl module output
  1521. #---------------------------------------------------------------------------
  1522. # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
  1523. # file that captures the structure of the code including all documentation.
  1524. #
  1525. # Note that this feature is still experimental and incomplete at the moment.
  1526. # The default value is: NO.
  1527. GENERATE_PERLMOD = NO
  1528. # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
  1529. # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
  1530. # output from the Perl module output.
  1531. # The default value is: NO.
  1532. # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1533. PERLMOD_LATEX = NO
  1534. # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
  1535. # formatted so it can be parsed by a human reader. This is useful if you want to
  1536. # understand what is going on. On the other hand, if this tag is set to NO, the
  1537. # size of the Perl module output will be much smaller and Perl will parse it
  1538. # just the same.
  1539. # The default value is: YES.
  1540. # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1541. PERLMOD_PRETTY = YES
  1542. # The names of the make variables in the generated doxyrules.make file are
  1543. # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
  1544. # so different doxyrules.make files included by the same Makefile don't
  1545. # overwrite each other's variables.
  1546. # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1547. PERLMOD_MAKEVAR_PREFIX =
  1548. #---------------------------------------------------------------------------
  1549. # Configuration options related to the preprocessor
  1550. #---------------------------------------------------------------------------
  1551. # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
  1552. # C-preprocessor directives found in the sources and include files.
  1553. # The default value is: YES.
  1554. ENABLE_PREPROCESSING = YES
  1555. # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
  1556. # in the source code. If set to NO, only conditional compilation will be
  1557. # performed. Macro expansion can be done in a controlled way by setting
  1558. # EXPAND_ONLY_PREDEF to YES.
  1559. # The default value is: NO.
  1560. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1561. MACRO_EXPANSION = YES
  1562. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
  1563. # the macro expansion is limited to the macros specified with the PREDEFINED and
  1564. # EXPAND_AS_DEFINED tags.
  1565. # The default value is: NO.
  1566. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1567. EXPAND_ONLY_PREDEF = NO
  1568. # If the SEARCH_INCLUDES tag is set to YES, the include files in the
  1569. # INCLUDE_PATH will be searched if a #include is found.
  1570. # The default value is: YES.
  1571. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1572. SEARCH_INCLUDES = YES
  1573. # The INCLUDE_PATH tag can be used to specify one or more directories that
  1574. # contain include files that are not input files but should be processed by the
  1575. # preprocessor.
  1576. # This tag requires that the tag SEARCH_INCLUDES is set to YES.
  1577. INCLUDE_PATH =
  1578. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  1579. # patterns (like *.h and *.hpp) to filter out the header-files in the
  1580. # directories. If left blank, the patterns specified with FILE_PATTERNS will be
  1581. # used.
  1582. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1583. INCLUDE_FILE_PATTERNS = *.h
  1584. # The PREDEFINED tag can be used to specify one or more macro names that are
  1585. # defined before the preprocessor is started (similar to the -D option of e.g.
  1586. # gcc). The argument of the tag is a list of macros of the form: name or
  1587. # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
  1588. # is assumed. To prevent a macro definition from being undefined via #undef or
  1589. # recursively expanded use the := operator instead of the = operator.
  1590. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1591. PREDEFINED = ARDUINO=10506 \
  1592. DOXY=1
  1593. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
  1594. # tag can be used to specify a list of macro names that should be expanded. The
  1595. # macro definition that is found in the sources will be used. Use the PREDEFINED
  1596. # tag if you want to use a different macro definition that overrules the
  1597. # definition found in the source code.
  1598. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1599. EXPAND_AS_DEFINED =
  1600. # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
  1601. # remove all references to function-like macros that are alone on a line, have
  1602. # an all uppercase name, and do not end with a semicolon. Such function macros
  1603. # are typically used for boiler-plate code, and will confuse the parser if not
  1604. # removed.
  1605. # The default value is: YES.
  1606. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1607. SKIP_FUNCTION_MACROS = NO
  1608. #---------------------------------------------------------------------------
  1609. # Configuration options related to external references
  1610. #---------------------------------------------------------------------------
  1611. # The TAGFILES tag can be used to specify one or more tag files. For each tag
  1612. # file the location of the external documentation should be added. The format of
  1613. # a tag file without this location is as follows:
  1614. # TAGFILES = file1 file2 ...
  1615. # Adding location for the tag files is done as follows:
  1616. # TAGFILES = file1=loc1 "file2 = loc2" ...
  1617. # where loc1 and loc2 can be relative or absolute paths or URLs. See the
  1618. # section "Linking to external documentation" for more information about the use
  1619. # of tag files.
  1620. # Note: Each tag file must have a unique name (where the name does NOT include
  1621. # the path). If a tag file is not located in the directory in which doxygen is
  1622. # run, you must also specify the path to the tagfile here.
  1623. TAGFILES =
  1624. # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
  1625. # tag file that is based on the input files it reads. See section "Linking to
  1626. # external documentation" for more information about the usage of tag files.
  1627. GENERATE_TAGFILE =
  1628. # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
  1629. # the class index. If set to NO, only the inherited external classes will be
  1630. # listed.
  1631. # The default value is: NO.
  1632. ALLEXTERNALS = NO
  1633. # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
  1634. # in the modules index. If set to NO, only the current project's groups will be
  1635. # listed.
  1636. # The default value is: YES.
  1637. EXTERNAL_GROUPS = YES
  1638. # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
  1639. # the related pages index. If set to NO, only the current project's pages will
  1640. # be listed.
  1641. # The default value is: YES.
  1642. EXTERNAL_PAGES = YES
  1643. # The PERL_PATH should be the absolute path and name of the perl script
  1644. # interpreter (i.e. the result of 'which perl').
  1645. # The default file (with absolute path) is: /usr/bin/perl.
  1646. PERL_PATH = /usr/bin/perl
  1647. #---------------------------------------------------------------------------
  1648. # Configuration options related to the dot tool
  1649. #---------------------------------------------------------------------------
  1650. # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
  1651. # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
  1652. # NO turns the diagrams off. Note that this option also works with HAVE_DOT
  1653. # disabled, but it is recommended to install and use dot, since it yields more
  1654. # powerful graphs.
  1655. # The default value is: YES.
  1656. CLASS_DIAGRAMS = YES
  1657. # You can define message sequence charts within doxygen comments using the \msc
  1658. # command. Doxygen will then run the mscgen tool (see:
  1659. # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
  1660. # documentation. The MSCGEN_PATH tag allows you to specify the directory where
  1661. # the mscgen tool resides. If left empty the tool is assumed to be found in the
  1662. # default search path.
  1663. MSCGEN_PATH =
  1664. # You can include diagrams made with dia in doxygen documentation. Doxygen will
  1665. # then run dia to produce the diagram and insert it in the documentation. The
  1666. # DIA_PATH tag allows you to specify the directory where the dia binary resides.
  1667. # If left empty dia is assumed to be found in the default search path.
  1668. DIA_PATH =
  1669. # If set to YES the inheritance and collaboration graphs will hide inheritance
  1670. # and usage relations if the target is undocumented or is not a class.
  1671. # The default value is: YES.
  1672. HIDE_UNDOC_RELATIONS = YES
  1673. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  1674. # available from the path. This tool is part of Graphviz (see:
  1675. # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
  1676. # Bell Labs. The other options in this section have no effect if this option is
  1677. # set to NO
  1678. # The default value is: NO.
  1679. HAVE_DOT = YES
  1680. # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
  1681. # to run in parallel. When set to 0 doxygen will base this on the number of
  1682. # processors available in the system. You can set it explicitly to a value
  1683. # larger than 0 to get control over the balance between CPU load and processing
  1684. # speed.
  1685. # Minimum value: 0, maximum value: 32, default value: 0.
  1686. # This tag requires that the tag HAVE_DOT is set to YES.
  1687. DOT_NUM_THREADS = 0
  1688. # When you want a differently looking font in the dot files that doxygen
  1689. # generates you can specify the font name using DOT_FONTNAME. You need to make
  1690. # sure dot is able to find the font, which can be done by putting it in a
  1691. # standard location or by setting the DOTFONTPATH environment variable or by
  1692. # setting DOT_FONTPATH to the directory containing the font.
  1693. # The default value is: Helvetica.
  1694. # This tag requires that the tag HAVE_DOT is set to YES.
  1695. DOT_FONTNAME = Helvetica
  1696. # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
  1697. # dot graphs.
  1698. # Minimum value: 4, maximum value: 24, default value: 10.
  1699. # This tag requires that the tag HAVE_DOT is set to YES.
  1700. DOT_FONTSIZE = 10
  1701. # By default doxygen will tell dot to use the default font as specified with
  1702. # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
  1703. # the path where dot can find it using this tag.
  1704. # This tag requires that the tag HAVE_DOT is set to YES.
  1705. DOT_FONTPATH =
  1706. # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
  1707. # each documented class showing the direct and indirect inheritance relations.
  1708. # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
  1709. # The default value is: YES.
  1710. # This tag requires that the tag HAVE_DOT is set to YES.
  1711. CLASS_GRAPH = YES
  1712. # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
  1713. # graph for each documented class showing the direct and indirect implementation
  1714. # dependencies (inheritance, containment, and class references variables) of the
  1715. # class with other documented classes.
  1716. # The default value is: YES.
  1717. # This tag requires that the tag HAVE_DOT is set to YES.
  1718. COLLABORATION_GRAPH = YES
  1719. # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
  1720. # groups, showing the direct groups dependencies.
  1721. # The default value is: YES.
  1722. # This tag requires that the tag HAVE_DOT is set to YES.
  1723. GROUP_GRAPHS = YES
  1724. # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
  1725. # collaboration diagrams in a style similar to the OMG's Unified Modeling
  1726. # Language.
  1727. # The default value is: NO.
  1728. # This tag requires that the tag HAVE_DOT is set to YES.
  1729. UML_LOOK = NO
  1730. # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
  1731. # class node. If there are many fields or methods and many nodes the graph may
  1732. # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
  1733. # number of items for each type to make the size more manageable. Set this to 0
  1734. # for no limit. Note that the threshold may be exceeded by 50% before the limit
  1735. # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
  1736. # but if the number exceeds 15, the total amount of fields shown is limited to
  1737. # 10.
  1738. # Minimum value: 0, maximum value: 100, default value: 10.
  1739. # This tag requires that the tag HAVE_DOT is set to YES.
  1740. UML_LIMIT_NUM_FIELDS = 10
  1741. # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
  1742. # collaboration graphs will show the relations between templates and their
  1743. # instances.
  1744. # The default value is: NO.
  1745. # This tag requires that the tag HAVE_DOT is set to YES.
  1746. TEMPLATE_RELATIONS = NO
  1747. # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
  1748. # YES then doxygen will generate a graph for each documented file showing the
  1749. # direct and indirect include dependencies of the file with other documented
  1750. # files.
  1751. # The default value is: YES.
  1752. # This tag requires that the tag HAVE_DOT is set to YES.
  1753. INCLUDE_GRAPH = YES
  1754. # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
  1755. # set to YES then doxygen will generate a graph for each documented file showing
  1756. # the direct and indirect include dependencies of the file with other documented
  1757. # files.
  1758. # The default value is: YES.
  1759. # This tag requires that the tag HAVE_DOT is set to YES.
  1760. INCLUDED_BY_GRAPH = YES
  1761. # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
  1762. # dependency graph for every global function or class method.
  1763. #
  1764. # Note that enabling this option will significantly increase the time of a run.
  1765. # So in most cases it will be better to enable call graphs for selected
  1766. # functions only using the \callgraph command. Disabling a call graph can be
  1767. # accomplished by means of the command \hidecallgraph.
  1768. # The default value is: NO.
  1769. # This tag requires that the tag HAVE_DOT is set to YES.
  1770. CALL_GRAPH = YES
  1771. # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
  1772. # dependency graph for every global function or class method.
  1773. #
  1774. # Note that enabling this option will significantly increase the time of a run.
  1775. # So in most cases it will be better to enable caller graphs for selected
  1776. # functions only using the \callergraph command. Disabling a caller graph can be
  1777. # accomplished by means of the command \hidecallergraph.
  1778. # The default value is: NO.
  1779. # This tag requires that the tag HAVE_DOT is set to YES.
  1780. CALLER_GRAPH = YES
  1781. # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
  1782. # hierarchy of all classes instead of a textual one.
  1783. # The default value is: YES.
  1784. # This tag requires that the tag HAVE_DOT is set to YES.
  1785. GRAPHICAL_HIERARCHY = YES
  1786. # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
  1787. # dependencies a directory has on other directories in a graphical way. The
  1788. # dependency relations are determined by the #include relations between the
  1789. # files in the directories.
  1790. # The default value is: YES.
  1791. # This tag requires that the tag HAVE_DOT is set to YES.
  1792. DIRECTORY_GRAPH = YES
  1793. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  1794. # generated by dot. For an explanation of the image formats see the section
  1795. # output formats in the documentation of the dot tool (Graphviz (see:
  1796. # http://www.graphviz.org/)).
  1797. # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
  1798. # to make the SVG files visible in IE 9+ (other browsers do not have this
  1799. # requirement).
  1800. # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
  1801. # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
  1802. # png:gdiplus:gdiplus.
  1803. # The default value is: png.
  1804. # This tag requires that the tag HAVE_DOT is set to YES.
  1805. DOT_IMAGE_FORMAT = png
  1806. # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  1807. # enable generation of interactive SVG images that allow zooming and panning.
  1808. #
  1809. # Note that this requires a modern browser other than Internet Explorer. Tested
  1810. # and working are Firefox, Chrome, Safari, and Opera.
  1811. # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
  1812. # the SVG files visible. Older versions of IE do not have SVG support.
  1813. # The default value is: NO.
  1814. # This tag requires that the tag HAVE_DOT is set to YES.
  1815. INTERACTIVE_SVG = NO
  1816. # The DOT_PATH tag can be used to specify the path where the dot tool can be
  1817. # found. If left blank, it is assumed the dot tool can be found in the path.
  1818. # This tag requires that the tag HAVE_DOT is set to YES.
  1819. DOT_PATH =
  1820. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  1821. # contain dot files that are included in the documentation (see the \dotfile
  1822. # command).
  1823. # This tag requires that the tag HAVE_DOT is set to YES.
  1824. DOTFILE_DIRS =
  1825. # The MSCFILE_DIRS tag can be used to specify one or more directories that
  1826. # contain msc files that are included in the documentation (see the \mscfile
  1827. # command).
  1828. MSCFILE_DIRS =
  1829. # The DIAFILE_DIRS tag can be used to specify one or more directories that
  1830. # contain dia files that are included in the documentation (see the \diafile
  1831. # command).
  1832. DIAFILE_DIRS =
  1833. # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
  1834. # path where java can find the plantuml.jar file. If left blank, it is assumed
  1835. # PlantUML is not used or called during a preprocessing step. Doxygen will
  1836. # generate a warning when it encounters a \startuml command in this case and
  1837. # will not generate output for the diagram.
  1838. PLANTUML_JAR_PATH =
  1839. # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
  1840. # configuration file for plantuml.
  1841. PLANTUML_CFG_FILE =
  1842. # When using plantuml, the specified paths are searched for files specified by
  1843. # the !include statement in a plantuml block.
  1844. PLANTUML_INCLUDE_PATH =
  1845. # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
  1846. # that will be shown in the graph. If the number of nodes in a graph becomes
  1847. # larger than this value, doxygen will truncate the graph, which is visualized
  1848. # by representing a node as a red box. Note that doxygen if the number of direct
  1849. # children of the root node in a graph is already larger than
  1850. # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
  1851. # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  1852. # Minimum value: 0, maximum value: 10000, default value: 50.
  1853. # This tag requires that the tag HAVE_DOT is set to YES.
  1854. DOT_GRAPH_MAX_NODES = 50
  1855. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
  1856. # generated by dot. A depth value of 3 means that only nodes reachable from the
  1857. # root by following a path via at most 3 edges will be shown. Nodes that lay
  1858. # further from the root node will be omitted. Note that setting this option to 1
  1859. # or 2 may greatly reduce the computation time needed for large code bases. Also
  1860. # note that the size of a graph can be further restricted by
  1861. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  1862. # Minimum value: 0, maximum value: 1000, default value: 0.
  1863. # This tag requires that the tag HAVE_DOT is set to YES.
  1864. MAX_DOT_GRAPH_DEPTH = 0
  1865. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  1866. # background. This is disabled by default, because dot on Windows does not seem
  1867. # to support this out of the box.
  1868. #
  1869. # Warning: Depending on the platform used, enabling this option may lead to
  1870. # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  1871. # read).
  1872. # The default value is: NO.
  1873. # This tag requires that the tag HAVE_DOT is set to YES.
  1874. DOT_TRANSPARENT = NO
  1875. # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
  1876. # files in one run (i.e. multiple -o and -T options on the command line). This
  1877. # makes dot run faster, but since only newer versions of dot (>1.8.10) support
  1878. # this, this feature is disabled by default.
  1879. # The default value is: NO.
  1880. # This tag requires that the tag HAVE_DOT is set to YES.
  1881. DOT_MULTI_TARGETS = NO
  1882. # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
  1883. # explaining the meaning of the various boxes and arrows in the dot generated
  1884. # graphs.
  1885. # The default value is: YES.
  1886. # This tag requires that the tag HAVE_DOT is set to YES.
  1887. GENERATE_LEGEND = YES
  1888. # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
  1889. # files that are used to generate the various graphs.
  1890. # The default value is: YES.
  1891. # This tag requires that the tag HAVE_DOT is set to YES.
  1892. DOT_CLEANUP = YES