Advertisement
Guest User

Untitled

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