Advertisement
Guest User

Will Pittenger

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