Advertisement
justin_hanekom

Doxyfile.in for doxygen

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