dub 0.2.2 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of dub might be problematic. Click here for more details.

Files changed (277) hide show
  1. data/History.txt +92 -0
  2. data/LICENSE +20 -0
  3. data/README.rdoc +115 -0
  4. data/Rakefile +59 -0
  5. data/dub.gemspec +197 -0
  6. data/lib/dub/argument.rb +286 -0
  7. data/lib/dub/entities_unescape.rb +9 -0
  8. data/lib/dub/function.rb +177 -0
  9. data/lib/dub/function_group.rb +72 -0
  10. data/lib/dub/generator.rb +15 -0
  11. data/lib/dub/group.rb +20 -0
  12. data/lib/dub/klass.rb +338 -0
  13. data/lib/dub/lua/class.cpp.erb +114 -0
  14. data/lib/dub/lua/class_gen.rb +96 -0
  15. data/lib/dub/lua/function.cpp.erb +15 -0
  16. data/lib/dub/lua/function_gen.rb +329 -0
  17. data/lib/dub/lua/group.cpp.erb +9 -0
  18. data/lib/dub/lua/lua_cpp_helper.cpp +259 -0
  19. data/lib/dub/lua/lua_cpp_helper.h +219 -0
  20. data/lib/dub/lua/lua_object.cpp +158 -0
  21. data/lib/dub/lua/lua_object.h +69 -0
  22. data/lib/dub/lua/namespace.cpp.erb +42 -0
  23. data/lib/dub/lua/namespace_gen.rb +69 -0
  24. data/lib/dub/lua.rb +24 -0
  25. data/lib/dub/member_extraction.rb +128 -0
  26. data/lib/dub/namespace.rb +295 -0
  27. data/lib/dub/opts_parser.rb +30 -0
  28. data/lib/dub/parser.rb +46 -0
  29. data/lib/dub/templates/lua_template.erb +21 -0
  30. data/lib/dub/version.rb +3 -0
  31. data/lib/dub.rb +24 -20
  32. data/test/argument_test.rb +581 -0
  33. data/test/fixtures/app/CMakeLists.txt +54 -0
  34. data/test/fixtures/app/Doxyfile +1600 -0
  35. data/test/fixtures/app/bindings/all_lua.cpp +299 -0
  36. data/test/fixtures/app/include/matrix.h +283 -0
  37. data/test/fixtures/app/make_lua_bindings.rb +13 -0
  38. data/test/fixtures/app/vendor/lua/CMakeLists.txt +25 -0
  39. data/test/fixtures/app/vendor/lua/COPYRIGHT +34 -0
  40. data/test/fixtures/app/vendor/lua/HISTORY +183 -0
  41. data/test/fixtures/app/vendor/lua/INSTALL +99 -0
  42. data/test/fixtures/app/vendor/lua/Makefile +183 -0
  43. data/test/fixtures/app/vendor/lua/README +37 -0
  44. data/test/fixtures/app/vendor/lua/lapi.c +1080 -0
  45. data/test/fixtures/app/vendor/lua/lapi.h +16 -0
  46. data/test/fixtures/app/vendor/lua/lauxlib.c +653 -0
  47. data/test/fixtures/app/vendor/lua/lauxlib.h +174 -0
  48. data/test/fixtures/app/vendor/lua/lbaselib.c +643 -0
  49. data/test/fixtures/app/vendor/lua/lcode.c +839 -0
  50. data/test/fixtures/app/vendor/lua/lcode.h +76 -0
  51. data/test/fixtures/app/vendor/lua/ldblib.c +397 -0
  52. data/test/fixtures/app/vendor/lua/ldebug.c +622 -0
  53. data/test/fixtures/app/vendor/lua/ldebug.h +33 -0
  54. data/test/fixtures/app/vendor/lua/ldo.c +516 -0
  55. data/test/fixtures/app/vendor/lua/ldo.h +57 -0
  56. data/test/fixtures/app/vendor/lua/ldump.c +164 -0
  57. data/test/fixtures/app/vendor/lua/lfunc.c +174 -0
  58. data/test/fixtures/app/vendor/lua/lfunc.h +34 -0
  59. data/test/fixtures/app/vendor/lua/lgc.c +711 -0
  60. data/test/fixtures/app/vendor/lua/lgc.h +110 -0
  61. data/test/fixtures/app/vendor/lua/liblua.a +0 -0
  62. data/test/fixtures/app/vendor/lua/linit.c +38 -0
  63. data/test/fixtures/app/vendor/lua/liolib.c +532 -0
  64. data/test/fixtures/app/vendor/lua/llex.c +461 -0
  65. data/test/fixtures/app/vendor/lua/llex.h +81 -0
  66. data/test/fixtures/app/vendor/lua/llimits.h +128 -0
  67. data/test/fixtures/app/vendor/lua/lmathlib.c +263 -0
  68. data/test/fixtures/app/vendor/lua/lmem.c +86 -0
  69. data/test/fixtures/app/vendor/lua/lmem.h +49 -0
  70. data/test/fixtures/app/vendor/lua/loadlib.c +664 -0
  71. data/test/fixtures/app/vendor/lua/lobject.c +214 -0
  72. data/test/fixtures/app/vendor/lua/lobject.h +381 -0
  73. data/test/fixtures/app/vendor/lua/lopcodes.c +102 -0
  74. data/test/fixtures/app/vendor/lua/lopcodes.h +268 -0
  75. data/test/fixtures/app/vendor/lua/loslib.c +244 -0
  76. data/test/fixtures/app/vendor/lua/lparser.c +1337 -0
  77. data/test/fixtures/app/vendor/lua/lparser.h +82 -0
  78. data/test/fixtures/app/vendor/lua/lstate.c +214 -0
  79. data/test/fixtures/app/vendor/lua/lstate.h +168 -0
  80. data/test/fixtures/app/vendor/lua/lstring.c +111 -0
  81. data/test/fixtures/app/vendor/lua/lstring.h +31 -0
  82. data/test/fixtures/app/vendor/lua/lstrlib.c +868 -0
  83. data/test/fixtures/app/vendor/lua/ltable.c +588 -0
  84. data/test/fixtures/app/vendor/lua/ltable.h +40 -0
  85. data/test/fixtures/app/vendor/lua/ltablib.c +278 -0
  86. data/test/fixtures/app/vendor/lua/ltm.c +75 -0
  87. data/test/fixtures/app/vendor/lua/ltm.h +54 -0
  88. data/test/fixtures/app/vendor/lua/lua.c +695 -0
  89. data/test/fixtures/app/vendor/lua/lua.h +385 -0
  90. data/test/fixtures/app/vendor/lua/lua_dub_helper.h +77 -0
  91. data/test/fixtures/app/vendor/lua/luac +0 -0
  92. data/test/fixtures/app/vendor/lua/luac.c +200 -0
  93. data/test/fixtures/app/vendor/lua/luaconf.h +762 -0
  94. data/test/fixtures/app/vendor/lua/lualib.h +53 -0
  95. data/test/fixtures/app/vendor/lua/lundump.c +223 -0
  96. data/test/fixtures/app/vendor/lua/lundump.h +36 -0
  97. data/test/fixtures/app/vendor/lua/lvm.c +765 -0
  98. data/test/fixtures/app/vendor/lua/lvm.h +36 -0
  99. data/test/fixtures/app/vendor/lua/lzio.c +82 -0
  100. data/test/fixtures/app/vendor/lua/lzio.h +67 -0
  101. data/test/fixtures/app/vendor/lua/matrix.h +102 -0
  102. data/test/fixtures/app/vendor/lua/print.c +227 -0
  103. data/test/fixtures/app/vendor/lua/test/README +26 -0
  104. data/test/fixtures/app/vendor/lua/test/bisect.lua +27 -0
  105. data/test/fixtures/app/vendor/lua/test/cf.lua +16 -0
  106. data/test/fixtures/app/vendor/lua/test/echo.lua +5 -0
  107. data/test/fixtures/app/vendor/lua/test/env.lua +7 -0
  108. data/test/fixtures/app/vendor/lua/test/factorial.lua +32 -0
  109. data/test/fixtures/app/vendor/lua/test/fib.lua +40 -0
  110. data/test/fixtures/app/vendor/lua/test/fibfor.lua +13 -0
  111. data/test/fixtures/app/vendor/lua/test/globals.lua +13 -0
  112. data/test/fixtures/app/vendor/lua/test/hello.lua +3 -0
  113. data/test/fixtures/app/vendor/lua/test/life.lua +111 -0
  114. data/test/fixtures/app/vendor/lua/test/luac.lua +7 -0
  115. data/test/fixtures/app/vendor/lua/test/printf.lua +7 -0
  116. data/test/fixtures/app/vendor/lua/test/readonly.lua +12 -0
  117. data/test/fixtures/app/vendor/lua/test/sieve.lua +29 -0
  118. data/test/fixtures/app/vendor/lua/test/sort.lua +66 -0
  119. data/test/fixtures/app/vendor/lua/test/table.lua +12 -0
  120. data/test/fixtures/app/vendor/lua/test/trace-calls.lua +32 -0
  121. data/test/fixtures/app/vendor/lua/test/trace-globals.lua +38 -0
  122. data/test/fixtures/app/vendor/lua/test/xd.lua +14 -0
  123. data/test/fixtures/app/xml/classdub_1_1_base.xml +85 -0
  124. data/test/fixtures/app/xml/classdub_1_1_custom_destructor.xml +67 -0
  125. data/test/fixtures/app/xml/classdub_1_1_deletable_out_of_lua.xml +43 -0
  126. data/test/fixtures/app/xml/classdub_1_1_matrix.xml +482 -0
  127. data/test/fixtures/app/xml/classdub_1_1_no_destructor.xml +49 -0
  128. data/test/fixtures/app/xml/classdub_1_1_priv_sub_base.xml +89 -0
  129. data/test/fixtures/app/xml/classdub_1_1_private_constr.xml +68 -0
  130. data/test/fixtures/app/xml/classdub_1_1_static_constr.xml +69 -0
  131. data/test/fixtures/app/xml/classdub_1_1_sub_base.xml +89 -0
  132. data/test/fixtures/app/xml/classdub_1_1_t_mat.xml +252 -0
  133. data/test/fixtures/app/xml/combine.xslt +15 -0
  134. data/test/fixtures/app/xml/compound.xsd +814 -0
  135. data/test/fixtures/app/xml/dir_53661a2bdeb1d55e60581a7e15deb763.xml +12 -0
  136. data/test/fixtures/app/xml/index.xml +91 -0
  137. data/test/fixtures/app/xml/index.xsd +66 -0
  138. data/test/fixtures/app/xml/matrix_8h.xml +310 -0
  139. data/test/fixtures/app/xml/namespacedub.xml +48 -0
  140. data/test/fixtures/classcv_1_1_mat.xml +1996 -0
  141. data/test/fixtures/classcv_1_1_point__.xml +341 -0
  142. data/test/fixtures/classcv_1_1_scalar__.xml +269 -0
  143. data/test/fixtures/classcv_1_1_size__.xml +270 -0
  144. data/test/fixtures/dummy_class.cpp.erb +1 -0
  145. data/test/fixtures/dummy_function.cpp.erb +1 -0
  146. data/test/fixtures/group___magic_type.xml +406 -0
  147. data/test/fixtures/namespacecv.xml +12659 -0
  148. data/test/function_group_test.rb +43 -0
  149. data/test/function_test.rb +405 -0
  150. data/test/group_test.rb +241 -0
  151. data/test/helper.rb +34 -0
  152. data/test/klass_test.rb +551 -0
  153. data/test/lua_function_gen_test.rb +242 -0
  154. data/test/namespace_test.rb +220 -0
  155. data/test/parser_test.rb +36 -0
  156. metadata +229 -272
  157. checksums.yaml +0 -7
  158. data/lib/open_api_sdk/analytics.rb +0 -99
  159. data/lib/open_api_sdk/domains.rb +0 -353
  160. data/lib/open_api_sdk/dub.rb +0 -88
  161. data/lib/open_api_sdk/links.rb +0 -766
  162. data/lib/open_api_sdk/metatags.rb +0 -54
  163. data/lib/open_api_sdk/models/operations/bulkcreatelinks_response.rb +0 -60
  164. data/lib/open_api_sdk/models/operations/bulkupdatelinks_requestbody.rb +0 -27
  165. data/lib/open_api_sdk/models/operations/bulkupdatelinks_response.rb +0 -60
  166. data/lib/open_api_sdk/models/operations/color.rb +0 -24
  167. data/lib/open_api_sdk/models/operations/createdomain_requestbody.rb +0 -33
  168. data/lib/open_api_sdk/models/operations/createdomain_response.rb +0 -60
  169. data/lib/open_api_sdk/models/operations/createlink_requestbody.rb +0 -95
  170. data/lib/open_api_sdk/models/operations/createlink_response.rb +0 -60
  171. data/lib/open_api_sdk/models/operations/createtag_requestbody.rb +0 -32
  172. data/lib/open_api_sdk/models/operations/createtag_response.rb +0 -60
  173. data/lib/open_api_sdk/models/operations/data.rb +0 -83
  174. data/lib/open_api_sdk/models/operations/deletedomain_request.rb +0 -24
  175. data/lib/open_api_sdk/models/operations/deletedomain_response.rb +0 -60
  176. data/lib/open_api_sdk/models/operations/deletedomain_responsebody.rb +0 -24
  177. data/lib/open_api_sdk/models/operations/deletelink_request.rb +0 -24
  178. data/lib/open_api_sdk/models/operations/deletelink_response.rb +0 -60
  179. data/lib/open_api_sdk/models/operations/deletelink_responsebody.rb +0 -24
  180. data/lib/open_api_sdk/models/operations/event.rb +0 -21
  181. data/lib/open_api_sdk/models/operations/getlinkinfo_request.rb +0 -33
  182. data/lib/open_api_sdk/models/operations/getlinkinfo_response.rb +0 -60
  183. data/lib/open_api_sdk/models/operations/getlinks_request.rb +0 -51
  184. data/lib/open_api_sdk/models/operations/getlinks_response.rb +0 -60
  185. data/lib/open_api_sdk/models/operations/getlinkscount_request.rb +0 -48
  186. data/lib/open_api_sdk/models/operations/getlinkscount_response.rb +0 -60
  187. data/lib/open_api_sdk/models/operations/getmetatags_request.rb +0 -24
  188. data/lib/open_api_sdk/models/operations/getmetatags_response.rb +0 -33
  189. data/lib/open_api_sdk/models/operations/getmetatags_responsebody.rb +0 -30
  190. data/lib/open_api_sdk/models/operations/getqrcode_request.rb +0 -39
  191. data/lib/open_api_sdk/models/operations/getqrcode_response.rb +0 -60
  192. data/lib/open_api_sdk/models/operations/gettags_response.rb +0 -60
  193. data/lib/open_api_sdk/models/operations/getworkspace_request.rb +0 -24
  194. data/lib/open_api_sdk/models/operations/getworkspace_response.rb +0 -60
  195. data/lib/open_api_sdk/models/operations/groupby.rb +0 -28
  196. data/lib/open_api_sdk/models/operations/interval.rb +0 -25
  197. data/lib/open_api_sdk/models/operations/level.rb +0 -21
  198. data/lib/open_api_sdk/models/operations/listdomains_response.rb +0 -60
  199. data/lib/open_api_sdk/models/operations/paymentprocessor.rb +0 -20
  200. data/lib/open_api_sdk/models/operations/requestbody.rb +0 -95
  201. data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb +0 -81
  202. data/lib/open_api_sdk/models/operations/retrieveanalytics_response.rb +0 -60
  203. data/lib/open_api_sdk/models/operations/sort.rb +0 -20
  204. data/lib/open_api_sdk/models/operations/trackcustomer_requestbody.rb +0 -33
  205. data/lib/open_api_sdk/models/operations/trackcustomer_response.rb +0 -60
  206. data/lib/open_api_sdk/models/operations/trackcustomer_responsebody.rb +0 -33
  207. data/lib/open_api_sdk/models/operations/tracklead_requestbody.rb +0 -42
  208. data/lib/open_api_sdk/models/operations/tracklead_response.rb +0 -60
  209. data/lib/open_api_sdk/models/operations/tracklead_responsebody.rb +0 -42
  210. data/lib/open_api_sdk/models/operations/tracksale_requestbody.rb +0 -42
  211. data/lib/open_api_sdk/models/operations/tracksale_response.rb +0 -60
  212. data/lib/open_api_sdk/models/operations/tracksale_responsebody.rb +0 -42
  213. data/lib/open_api_sdk/models/operations/updatedomain_request.rb +0 -27
  214. data/lib/open_api_sdk/models/operations/updatedomain_requestbody.rb +0 -33
  215. data/lib/open_api_sdk/models/operations/updatedomain_response.rb +0 -60
  216. data/lib/open_api_sdk/models/operations/updatelink_request.rb +0 -27
  217. data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb +0 -95
  218. data/lib/open_api_sdk/models/operations/updatelink_response.rb +0 -60
  219. data/lib/open_api_sdk/models/operations/updatetag_color.rb +0 -24
  220. data/lib/open_api_sdk/models/operations/updatetag_request.rb +0 -27
  221. data/lib/open_api_sdk/models/operations/updatetag_requestbody.rb +0 -32
  222. data/lib/open_api_sdk/models/operations/updatetag_response.rb +0 -60
  223. data/lib/open_api_sdk/models/operations/updateworkspace_request.rb +0 -27
  224. data/lib/open_api_sdk/models/operations/updateworkspace_requestbody.rb +0 -27
  225. data/lib/open_api_sdk/models/operations/updateworkspace_response.rb +0 -60
  226. data/lib/open_api_sdk/models/operations/upsertlink_requestbody.rb +0 -95
  227. data/lib/open_api_sdk/models/operations/upsertlink_response.rb +0 -60
  228. data/lib/open_api_sdk/models/operations.rb +0 -74
  229. data/lib/open_api_sdk/models/shared/badrequest.rb +0 -24
  230. data/lib/open_api_sdk/models/shared/code.rb +0 -18
  231. data/lib/open_api_sdk/models/shared/color.rb +0 -24
  232. data/lib/open_api_sdk/models/shared/conflict.rb +0 -24
  233. data/lib/open_api_sdk/models/shared/conflict_code.rb +0 -18
  234. data/lib/open_api_sdk/models/shared/conflict_error.rb +0 -30
  235. data/lib/open_api_sdk/models/shared/countrycode.rb +0 -267
  236. data/lib/open_api_sdk/models/shared/domains.rb +0 -27
  237. data/lib/open_api_sdk/models/shared/domainschema.rb +0 -48
  238. data/lib/open_api_sdk/models/shared/error.rb +0 -30
  239. data/lib/open_api_sdk/models/shared/forbidden.rb +0 -24
  240. data/lib/open_api_sdk/models/shared/forbidden_code.rb +0 -18
  241. data/lib/open_api_sdk/models/shared/forbidden_error.rb +0 -30
  242. data/lib/open_api_sdk/models/shared/geo.rb +0 -771
  243. data/lib/open_api_sdk/models/shared/internalservererror.rb +0 -24
  244. data/lib/open_api_sdk/models/shared/internalservererror_code.rb +0 -18
  245. data/lib/open_api_sdk/models/shared/internalservererror_error.rb +0 -30
  246. data/lib/open_api_sdk/models/shared/inviteexpired.rb +0 -24
  247. data/lib/open_api_sdk/models/shared/inviteexpired_code.rb +0 -18
  248. data/lib/open_api_sdk/models/shared/inviteexpired_error.rb +0 -30
  249. data/lib/open_api_sdk/models/shared/linkgeotargeting.rb +0 -771
  250. data/lib/open_api_sdk/models/shared/linkschema.rb +0 -142
  251. data/lib/open_api_sdk/models/shared/notfound.rb +0 -24
  252. data/lib/open_api_sdk/models/shared/notfound_code.rb +0 -18
  253. data/lib/open_api_sdk/models/shared/notfound_error.rb +0 -30
  254. data/lib/open_api_sdk/models/shared/plan.rb +0 -24
  255. data/lib/open_api_sdk/models/shared/ratelimitexceeded.rb +0 -24
  256. data/lib/open_api_sdk/models/shared/ratelimitexceeded_code.rb +0 -18
  257. data/lib/open_api_sdk/models/shared/ratelimitexceeded_error.rb +0 -30
  258. data/lib/open_api_sdk/models/shared/role.rb +0 -19
  259. data/lib/open_api_sdk/models/shared/security.rb +0 -24
  260. data/lib/open_api_sdk/models/shared/tagschema.rb +0 -30
  261. data/lib/open_api_sdk/models/shared/unauthorized.rb +0 -24
  262. data/lib/open_api_sdk/models/shared/unauthorized_code.rb +0 -18
  263. data/lib/open_api_sdk/models/shared/unauthorized_error.rb +0 -30
  264. data/lib/open_api_sdk/models/shared/unprocessableentity.rb +0 -24
  265. data/lib/open_api_sdk/models/shared/unprocessableentity_code.rb +0 -18
  266. data/lib/open_api_sdk/models/shared/unprocessableentity_error.rb +0 -30
  267. data/lib/open_api_sdk/models/shared/users.rb +0 -24
  268. data/lib/open_api_sdk/models/shared/workspaceschema.rb +0 -81
  269. data/lib/open_api_sdk/models/shared.rb +0 -49
  270. data/lib/open_api_sdk/qr_codes.rb +0 -97
  271. data/lib/open_api_sdk/sdkconfiguration.rb +0 -52
  272. data/lib/open_api_sdk/tags.rb +0 -272
  273. data/lib/open_api_sdk/track.rb +0 -276
  274. data/lib/open_api_sdk/utils/metadata_fields.rb +0 -150
  275. data/lib/open_api_sdk/utils/t.rb +0 -59
  276. data/lib/open_api_sdk/utils/utils.rb +0 -772
  277. data/lib/open_api_sdk/workspaces.rb +0 -192
@@ -0,0 +1,1600 @@
1
+ # Doxyfile 1.6.3
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 hash (#) is considered a comment and will be ignored
7
+ # The format is:
8
+ # TAG = value [value, ...]
9
+ # For lists items can also be appended using:
10
+ # TAG += value [value, ...]
11
+ # Values that contain spaces should be placed between quotes (" ")
12
+
13
+ #---------------------------------------------------------------------------
14
+ # Project related configuration options
15
+ #---------------------------------------------------------------------------
16
+
17
+ # This tag specifies the encoding used for all characters in the config file
18
+ # that follow. The default is UTF-8 which is also the encoding used for all
19
+ # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20
+ # iconv built into libc) for the transcoding. See
21
+ # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
+
23
+ DOXYFILE_ENCODING = UTF-8
24
+
25
+ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26
+ # by quotes) that should identify the project.
27
+
28
+ PROJECT_NAME = "dub test app"
29
+
30
+ # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31
+ # This could be handy for archiving the generated documentation or
32
+ # if some version control system is used.
33
+
34
+ PROJECT_NUMBER =
35
+
36
+ # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37
+ # base path where the generated documentation will be put.
38
+ # If a relative path is entered, it will be relative to the location
39
+ # where doxygen was started. If left blank the current directory will be used.
40
+
41
+ OUTPUT_DIRECTORY =
42
+
43
+ # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44
+ # 4096 sub-directories (in 2 levels) under the output directory of each output
45
+ # format and will distribute the generated files over these directories.
46
+ # Enabling this option can be useful when feeding doxygen a huge amount of
47
+ # source files, where putting all generated files in the same directory would
48
+ # otherwise cause performance problems for the file system.
49
+
50
+ CREATE_SUBDIRS = NO
51
+
52
+ # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53
+ # documentation generated by doxygen is written. Doxygen will use this
54
+ # information to generate all constant output in the proper language.
55
+ # The default language is English, other supported languages are:
56
+ # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57
+ # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58
+ # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59
+ # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60
+ # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61
+ # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
62
+
63
+ OUTPUT_LANGUAGE = English
64
+
65
+ # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66
+ # include brief member descriptions after the members that are listed in
67
+ # the file and class documentation (similar to JavaDoc).
68
+ # Set to NO to disable this.
69
+
70
+ BRIEF_MEMBER_DESC = YES
71
+
72
+ # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73
+ # the brief description of a member or function before the detailed description.
74
+ # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75
+ # brief descriptions will be completely suppressed.
76
+
77
+ REPEAT_BRIEF = YES
78
+
79
+ # This tag implements a quasi-intelligent brief description abbreviator
80
+ # that is used to form the text in various listings. Each string
81
+ # in this list, if found as the leading text of the brief description, will be
82
+ # stripped from the text and the result after processing the whole list, is
83
+ # used as the annotated text. Otherwise, the brief description is used as-is.
84
+ # If left blank, the following values are used ("$name" is automatically
85
+ # replaced with the name of the entity): "The $name class" "The $name widget"
86
+ # "The $name file" "is" "provides" "specifies" "contains"
87
+ # "represents" "a" "an" "the"
88
+
89
+ ABBREVIATE_BRIEF = "The $name class" \
90
+ "The $name widget" \
91
+ "The $name file" \
92
+ is \
93
+ provides \
94
+ specifies \
95
+ contains \
96
+ represents \
97
+ a \
98
+ an \
99
+ the
100
+
101
+ # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102
+ # Doxygen will generate a detailed section even if there is only a brief
103
+ # description.
104
+
105
+ ALWAYS_DETAILED_SEC = NO
106
+
107
+ # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108
+ # inherited members of a class in the documentation of that class as if those
109
+ # members were ordinary class members. Constructors, destructors and assignment
110
+ # operators of the base classes will not be shown.
111
+
112
+ INLINE_INHERITED_MEMB = NO
113
+
114
+ # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115
+ # path before files name in the file list and in the header files. If set
116
+ # to NO the shortest path that makes the file name unique will be used.
117
+
118
+ FULL_PATH_NAMES = YES
119
+
120
+ # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121
+ # can be used to strip a user-defined part of the path. Stripping is
122
+ # only done if one of the specified strings matches the left-hand part of
123
+ # the path. The tag can be used to show relative paths in the file list.
124
+ # If left blank the directory from which doxygen is run is used as the
125
+ # path to strip.
126
+
127
+ STRIP_FROM_PATH =
128
+
129
+ # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130
+ # the path mentioned in the documentation of a class, which tells
131
+ # the reader which header file to include in order to use a class.
132
+ # If left blank only the name of the header file containing the class
133
+ # definition is used. Otherwise one should specify the include paths that
134
+ # are normally passed to the compiler using the -I flag.
135
+
136
+ STRIP_FROM_INC_PATH =
137
+
138
+ # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139
+ # (but less readable) file names. This can be useful is your file systems
140
+ # doesn't support long names like on DOS, Mac, or CD-ROM.
141
+
142
+ SHORT_NAMES = NO
143
+
144
+ # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145
+ # will interpret the first line (until the first dot) of a JavaDoc-style
146
+ # comment as the brief description. If set to NO, the JavaDoc
147
+ # comments will behave just like regular Qt-style comments
148
+ # (thus requiring an explicit @brief command for a brief description.)
149
+
150
+ JAVADOC_AUTOBRIEF = NO
151
+
152
+ # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
153
+ # interpret the first line (until the first dot) of a Qt-style
154
+ # comment as the brief description. If set to NO, the comments
155
+ # will behave just like regular Qt-style comments (thus requiring
156
+ # an explicit \brief command for a brief description.)
157
+
158
+ QT_AUTOBRIEF = NO
159
+
160
+ # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
161
+ # treat a multi-line C++ special comment block (i.e. a block of //! or ///
162
+ # comments) as a brief description. This used to be the default behaviour.
163
+ # The new default is to treat a multi-line C++ comment block as a detailed
164
+ # description. Set this tag to YES if you prefer the old behaviour instead.
165
+
166
+ MULTILINE_CPP_IS_BRIEF = NO
167
+
168
+ # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
169
+ # member inherits the documentation from any documented member that it
170
+ # re-implements.
171
+
172
+ INHERIT_DOCS = YES
173
+
174
+ # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175
+ # a new page for each member. If set to NO, the documentation of a member will
176
+ # be part of the file/class/namespace that contains it.
177
+
178
+ SEPARATE_MEMBER_PAGES = NO
179
+
180
+ # The TAB_SIZE tag can be used to set the number of spaces in a tab.
181
+ # Doxygen uses this value to replace tabs by spaces in code fragments.
182
+
183
+ TAB_SIZE = 8
184
+
185
+ # This tag can be used to specify a number of aliases that acts
186
+ # as commands in the documentation. An alias has the form "name=value".
187
+ # For example adding "sideeffect=\par Side Effects:\n" will allow you to
188
+ # put the command \sideeffect (or @sideeffect) in the documentation, which
189
+ # will result in a user-defined paragraph with heading "Side Effects:".
190
+ # You can put \n's in the value part of an alias to insert newlines.
191
+
192
+ ALIASES = "dub=\par Bindings info:\n"
193
+
194
+ # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
195
+ # sources only. Doxygen will then generate output that is more tailored for C.
196
+ # For instance, some of the names that are used will be different. The list
197
+ # of all members will be omitted, etc.
198
+
199
+ OPTIMIZE_OUTPUT_FOR_C = NO
200
+
201
+ # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
202
+ # sources only. Doxygen will then generate output that is more tailored for
203
+ # Java. For instance, namespaces will be presented as packages, qualified
204
+ # scopes will look different, etc.
205
+
206
+ OPTIMIZE_OUTPUT_JAVA = NO
207
+
208
+ # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
209
+ # sources only. Doxygen will then generate output that is more tailored for
210
+ # Fortran.
211
+
212
+ OPTIMIZE_FOR_FORTRAN = NO
213
+
214
+ # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
215
+ # sources. Doxygen will then generate output that is tailored for
216
+ # VHDL.
217
+
218
+ OPTIMIZE_OUTPUT_VHDL = NO
219
+
220
+ # Doxygen selects the parser to use depending on the extension of the files it parses.
221
+ # With this tag you can assign which parser to use for a given extension.
222
+ # Doxygen has a built-in mapping, but you can override or extend it using this tag.
223
+ # The format is ext=language, where ext is a file extension, and language is one of
224
+ # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
225
+ # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
226
+ # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
227
+ # use: inc=Fortran f=C. Note that for custom extensions you also need to set
228
+ # FILE_PATTERNS otherwise the files are not read by doxygen.
229
+
230
+ EXTENSION_MAPPING =
231
+
232
+ # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
233
+ # to include (a tag file for) the STL sources as input, then you should
234
+ # set this tag to YES in order to let doxygen match functions declarations and
235
+ # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
236
+ # func(std::string) {}). This also make the inheritance and collaboration
237
+ # diagrams that involve STL classes more complete and accurate.
238
+
239
+ BUILTIN_STL_SUPPORT = NO
240
+
241
+ # If you use Microsoft's C++/CLI language, you should set this option to YES to
242
+ # enable parsing support.
243
+
244
+ CPP_CLI_SUPPORT = NO
245
+
246
+ # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
247
+ # Doxygen will parse them like normal C++ but will assume all classes use public
248
+ # instead of private inheritance when no explicit protection keyword is present.
249
+
250
+ SIP_SUPPORT = NO
251
+
252
+ # For Microsoft's IDL there are propget and propput attributes to indicate getter
253
+ # and setter methods for a property. Setting this option to YES (the default)
254
+ # will make doxygen to replace the get and set methods by a property in the
255
+ # documentation. This will only work if the methods are indeed getting or
256
+ # setting a simple type. If this is not the case, or you want to show the
257
+ # methods anyway, you should set this option to NO.
258
+
259
+ IDL_PROPERTY_SUPPORT = YES
260
+
261
+ # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
262
+ # tag is set to YES, then doxygen will reuse the documentation of the first
263
+ # member in the group (if any) for the other members of the group. By default
264
+ # all members of a group must be documented explicitly.
265
+
266
+ DISTRIBUTE_GROUP_DOC = NO
267
+
268
+ # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
269
+ # the same type (for instance a group of public functions) to be put as a
270
+ # subgroup of that type (e.g. under the Public Functions section). Set it to
271
+ # NO to prevent subgrouping. Alternatively, this can be done per class using
272
+ # the \nosubgrouping command.
273
+
274
+ SUBGROUPING = YES
275
+
276
+ # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
277
+ # is documented as struct, union, or enum with the name of the typedef. So
278
+ # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
279
+ # with name TypeT. When disabled the typedef will appear as a member of a file,
280
+ # namespace, or class. And the struct will be named TypeS. This can typically
281
+ # be useful for C code in case the coding convention dictates that all compound
282
+ # types are typedef'ed and only the typedef is referenced, never the tag name.
283
+
284
+ TYPEDEF_HIDES_STRUCT = NO
285
+
286
+ # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
287
+ # determine which symbols to keep in memory and which to flush to disk.
288
+ # When the cache is full, less often used symbols will be written to disk.
289
+ # For small to medium size projects (<1000 input files) the default value is
290
+ # probably good enough. For larger projects a too small cache size can cause
291
+ # doxygen to be busy swapping symbols to and from disk most of the time
292
+ # causing a significant performance penality.
293
+ # If the system has enough physical memory increasing the cache will improve the
294
+ # performance by keeping more symbols in memory. Note that the value works on
295
+ # a logarithmic scale so increasing the size by one will rougly double the
296
+ # memory usage. The cache size is given by this formula:
297
+ # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
298
+ # corresponding to a cache size of 2^16 = 65536 symbols
299
+
300
+ SYMBOL_CACHE_SIZE = 0
301
+
302
+ #---------------------------------------------------------------------------
303
+ # Build related configuration options
304
+ #---------------------------------------------------------------------------
305
+
306
+ # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
307
+ # documentation are documented, even if no documentation was available.
308
+ # Private class members and static file members will be hidden unless
309
+ # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
310
+
311
+ EXTRACT_ALL = NO
312
+
313
+ # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
314
+ # will be included in the documentation.
315
+
316
+ EXTRACT_PRIVATE = NO
317
+
318
+ # If the EXTRACT_STATIC tag is set to YES all static members of a file
319
+ # will be included in the documentation.
320
+
321
+ EXTRACT_STATIC = NO
322
+
323
+ # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
324
+ # defined locally in source files will be included in the documentation.
325
+ # If set to NO only classes defined in header files are included.
326
+
327
+ EXTRACT_LOCAL_CLASSES = YES
328
+
329
+ # This flag is only useful for Objective-C code. When set to YES local
330
+ # methods, which are defined in the implementation section but not in
331
+ # the interface are included in the documentation.
332
+ # If set to NO (the default) only methods in the interface are included.
333
+
334
+ EXTRACT_LOCAL_METHODS = NO
335
+
336
+ # If this flag is set to YES, the members of anonymous namespaces will be
337
+ # extracted and appear in the documentation as a namespace called
338
+ # 'anonymous_namespace{file}', where file will be replaced with the base
339
+ # name of the file that contains the anonymous namespace. By default
340
+ # anonymous namespace are hidden.
341
+
342
+ EXTRACT_ANON_NSPACES = NO
343
+
344
+ # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
345
+ # undocumented members of documented classes, files or namespaces.
346
+ # If set to NO (the default) these members will be included in the
347
+ # various overviews, but no documentation section is generated.
348
+ # This option has no effect if EXTRACT_ALL is enabled.
349
+
350
+ HIDE_UNDOC_MEMBERS = NO
351
+
352
+ # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
353
+ # undocumented classes that are normally visible in the class hierarchy.
354
+ # If set to NO (the default) these classes will be included in the various
355
+ # overviews. This option has no effect if EXTRACT_ALL is enabled.
356
+
357
+ HIDE_UNDOC_CLASSES = NO
358
+
359
+ # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
360
+ # friend (class|struct|union) declarations.
361
+ # If set to NO (the default) these declarations will be included in the
362
+ # documentation.
363
+
364
+ HIDE_FRIEND_COMPOUNDS = NO
365
+
366
+ # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
367
+ # documentation blocks found inside the body of a function.
368
+ # If set to NO (the default) these blocks will be appended to the
369
+ # function's detailed documentation block.
370
+
371
+ HIDE_IN_BODY_DOCS = NO
372
+
373
+ # The INTERNAL_DOCS tag determines if documentation
374
+ # that is typed after a \internal command is included. If the tag is set
375
+ # to NO (the default) then the documentation will be excluded.
376
+ # Set it to YES to include the internal documentation.
377
+
378
+ INTERNAL_DOCS = NO
379
+
380
+ # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
381
+ # file names in lower-case letters. If set to YES upper-case letters are also
382
+ # allowed. This is useful if you have classes or files whose names only differ
383
+ # in case and if your file system supports case sensitive file names. Windows
384
+ # and Mac users are advised to set this option to NO.
385
+
386
+ CASE_SENSE_NAMES = NO
387
+
388
+ # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
389
+ # will show members with their full class and namespace scopes in the
390
+ # documentation. If set to YES the scope will be hidden.
391
+
392
+ HIDE_SCOPE_NAMES = NO
393
+
394
+ # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
395
+ # will put a list of the files that are included by a file in the documentation
396
+ # of that file.
397
+
398
+ SHOW_INCLUDE_FILES = YES
399
+
400
+ # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
401
+ # will list include files with double quotes in the documentation
402
+ # rather than with sharp brackets.
403
+
404
+ FORCE_LOCAL_INCLUDES = NO
405
+
406
+ # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
407
+ # is inserted in the documentation for inline members.
408
+
409
+ INLINE_INFO = YES
410
+
411
+ # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
412
+ # will sort the (detailed) documentation of file and class members
413
+ # alphabetically by member name. If set to NO the members will appear in
414
+ # declaration order.
415
+
416
+ SORT_MEMBER_DOCS = YES
417
+
418
+ # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
419
+ # brief documentation of file, namespace and class members alphabetically
420
+ # by member name. If set to NO (the default) the members will appear in
421
+ # declaration order.
422
+
423
+ SORT_BRIEF_DOCS = NO
424
+
425
+ # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
426
+ # will sort the (brief and detailed) documentation of class members so that
427
+ # constructors and destructors are listed first. If set to NO (the default)
428
+ # the constructors will appear in the respective orders defined by
429
+ # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
430
+ # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
431
+ # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
432
+
433
+ SORT_MEMBERS_CTORS_1ST = NO
434
+
435
+ # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
436
+ # hierarchy of group names into alphabetical order. If set to NO (the default)
437
+ # the group names will appear in their defined order.
438
+
439
+ SORT_GROUP_NAMES = NO
440
+
441
+ # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
442
+ # sorted by fully-qualified names, including namespaces. If set to
443
+ # NO (the default), the class list will be sorted only by class name,
444
+ # not including the namespace part.
445
+ # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
446
+ # Note: This option applies only to the class list, not to the
447
+ # alphabetical list.
448
+
449
+ SORT_BY_SCOPE_NAME = NO
450
+
451
+ # The GENERATE_TODOLIST tag can be used to enable (YES) or
452
+ # disable (NO) the todo list. This list is created by putting \todo
453
+ # commands in the documentation.
454
+
455
+ GENERATE_TODOLIST = YES
456
+
457
+ # The GENERATE_TESTLIST tag can be used to enable (YES) or
458
+ # disable (NO) the test list. This list is created by putting \test
459
+ # commands in the documentation.
460
+
461
+ GENERATE_TESTLIST = YES
462
+
463
+ # The GENERATE_BUGLIST tag can be used to enable (YES) or
464
+ # disable (NO) the bug list. This list is created by putting \bug
465
+ # commands in the documentation.
466
+
467
+ GENERATE_BUGLIST = YES
468
+
469
+ # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
470
+ # disable (NO) the deprecated list. This list is created by putting
471
+ # \deprecated commands in the documentation.
472
+
473
+ GENERATE_DEPRECATEDLIST= YES
474
+
475
+ # The ENABLED_SECTIONS tag can be used to enable conditional
476
+ # documentation sections, marked by \if sectionname ... \endif.
477
+
478
+ ENABLED_SECTIONS =
479
+
480
+ # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
481
+ # the initial value of a variable or define consists of for it to appear in
482
+ # the documentation. If the initializer consists of more lines than specified
483
+ # here it will be hidden. Use a value of 0 to hide initializers completely.
484
+ # The appearance of the initializer of individual variables and defines in the
485
+ # documentation can be controlled using \showinitializer or \hideinitializer
486
+ # command in the documentation regardless of this setting.
487
+
488
+ MAX_INITIALIZER_LINES = 30
489
+
490
+ # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
491
+ # at the bottom of the documentation of classes and structs. If set to YES the
492
+ # list will mention the files that were used to generate the documentation.
493
+
494
+ SHOW_USED_FILES = YES
495
+
496
+ # If the sources in your project are distributed over multiple directories
497
+ # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
498
+ # in the documentation. The default is NO.
499
+
500
+ SHOW_DIRECTORIES = NO
501
+
502
+ # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
503
+ # This will remove the Files entry from the Quick Index and from the
504
+ # Folder Tree View (if specified). The default is YES.
505
+
506
+ SHOW_FILES = YES
507
+
508
+ # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
509
+ # Namespaces page. This will remove the Namespaces entry from the Quick Index
510
+ # and from the Folder Tree View (if specified). The default is YES.
511
+
512
+ SHOW_NAMESPACES = YES
513
+
514
+ # The FILE_VERSION_FILTER tag can be used to specify a program or script that
515
+ # doxygen should invoke to get the current version for each file (typically from
516
+ # the version control system). Doxygen will invoke the program by executing (via
517
+ # popen()) the command <command> <input-file>, where <command> is the value of
518
+ # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
519
+ # provided by doxygen. Whatever the program writes to standard output
520
+ # is used as the file version. See the manual for examples.
521
+
522
+ FILE_VERSION_FILTER =
523
+
524
+ # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
525
+ # doxygen. The layout file controls the global structure of the generated output files
526
+ # in an output format independent way. The create the layout file that represents
527
+ # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
528
+ # file name after the option, if omitted DoxygenLayout.xml will be used as the name
529
+ # of the layout file.
530
+
531
+ LAYOUT_FILE =
532
+
533
+ #---------------------------------------------------------------------------
534
+ # configuration options related to warning and progress messages
535
+ #---------------------------------------------------------------------------
536
+
537
+ # The QUIET tag can be used to turn on/off the messages that are generated
538
+ # by doxygen. Possible values are YES and NO. If left blank NO is used.
539
+
540
+ QUIET = NO
541
+
542
+ # The WARNINGS tag can be used to turn on/off the warning messages that are
543
+ # generated by doxygen. Possible values are YES and NO. If left blank
544
+ # NO is used.
545
+
546
+ WARNINGS = YES
547
+
548
+ # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
549
+ # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
550
+ # automatically be disabled.
551
+
552
+ WARN_IF_UNDOCUMENTED = YES
553
+
554
+ # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
555
+ # potential errors in the documentation, such as not documenting some
556
+ # parameters in a documented function, or documenting parameters that
557
+ # don't exist or using markup commands wrongly.
558
+
559
+ WARN_IF_DOC_ERROR = YES
560
+
561
+ # This WARN_NO_PARAMDOC option can be abled to get warnings for
562
+ # functions that are documented, but have no documentation for their parameters
563
+ # or return value. If set to NO (the default) doxygen will only warn about
564
+ # wrong or incomplete parameter documentation, but not about the absence of
565
+ # documentation.
566
+
567
+ WARN_NO_PARAMDOC = NO
568
+
569
+ # The WARN_FORMAT tag determines the format of the warning messages that
570
+ # doxygen can produce. The string should contain the $file, $line, and $text
571
+ # tags, which will be replaced by the file and line number from which the
572
+ # warning originated and the warning text. Optionally the format may contain
573
+ # $version, which will be replaced by the version of the file (if it could
574
+ # be obtained via FILE_VERSION_FILTER)
575
+
576
+ WARN_FORMAT = "$file:$line: $text"
577
+
578
+ # The WARN_LOGFILE tag can be used to specify a file to which warning
579
+ # and error messages should be written. If left blank the output is written
580
+ # to stderr.
581
+
582
+ WARN_LOGFILE =
583
+
584
+ #---------------------------------------------------------------------------
585
+ # configuration options related to the input files
586
+ #---------------------------------------------------------------------------
587
+
588
+ # The INPUT tag can be used to specify the files and/or directories that contain
589
+ # documented source files. You may enter file names like "myfile.cpp" or
590
+ # directories like "/usr/src/myproject". Separate the files or directories
591
+ # with spaces.
592
+
593
+ INPUT = include
594
+
595
+ # This tag can be used to specify the character encoding of the source files
596
+ # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
597
+ # also the default input encoding. Doxygen uses libiconv (or the iconv built
598
+ # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
599
+ # the list of possible encodings.
600
+
601
+ INPUT_ENCODING = UTF-8
602
+
603
+ # If the value of the INPUT tag contains directories, you can use the
604
+ # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
605
+ # and *.h) to filter out the source-files in the directories. If left
606
+ # blank the following patterns are tested:
607
+ # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
608
+ # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
609
+
610
+ FILE_PATTERNS = *.c \
611
+ *.cc \
612
+ *.cxx \
613
+ *.cpp \
614
+ *.c++ \
615
+ *.d \
616
+ *.java \
617
+ *.ii \
618
+ *.ixx \
619
+ *.ipp \
620
+ *.i++ \
621
+ *.inl \
622
+ *.h \
623
+ *.hh \
624
+ *.hxx \
625
+ *.hpp \
626
+ *.h++ \
627
+ *.idl \
628
+ *.odl \
629
+ *.cs \
630
+ *.php \
631
+ *.php3 \
632
+ *.inc \
633
+ *.m \
634
+ *.mm \
635
+ *.dox \
636
+ *.py \
637
+ *.f90 \
638
+ *.f \
639
+ *.vhd \
640
+ *.vhdl
641
+
642
+ # The RECURSIVE tag can be used to turn specify whether or not subdirectories
643
+ # should be searched for input files as well. Possible values are YES and NO.
644
+ # If left blank NO is used.
645
+
646
+ RECURSIVE = NO
647
+
648
+ # The EXCLUDE tag can be used to specify files and/or directories that should
649
+ # excluded from the INPUT source files. This way you can easily exclude a
650
+ # subdirectory from a directory tree whose root is specified with the INPUT tag.
651
+
652
+ EXCLUDE =
653
+
654
+ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
655
+ # directories that are symbolic links (a Unix filesystem feature) are excluded
656
+ # from the input.
657
+
658
+ EXCLUDE_SYMLINKS = NO
659
+
660
+ # If the value of the INPUT tag contains directories, you can use the
661
+ # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
662
+ # certain files from those directories. Note that the wildcards are matched
663
+ # against the file with absolute path, so to exclude all test directories
664
+ # for example use the pattern */test/*
665
+
666
+ EXCLUDE_PATTERNS =
667
+
668
+ # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
669
+ # (namespaces, classes, functions, etc.) that should be excluded from the
670
+ # output. The symbol name can be a fully qualified name, a word, or if the
671
+ # wildcard * is used, a substring. Examples: ANamespace, AClass,
672
+ # AClass::ANamespace, ANamespace::*Test
673
+
674
+ EXCLUDE_SYMBOLS =
675
+
676
+ # The EXAMPLE_PATH tag can be used to specify one or more files or
677
+ # directories that contain example code fragments that are included (see
678
+ # the \include command).
679
+
680
+ EXAMPLE_PATH =
681
+
682
+ # If the value of the EXAMPLE_PATH tag contains directories, you can use the
683
+ # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
684
+ # and *.h) to filter out the source-files in the directories. If left
685
+ # blank all files are included.
686
+
687
+ EXAMPLE_PATTERNS = *
688
+
689
+ # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
690
+ # searched for input files to be used with the \include or \dontinclude
691
+ # commands irrespective of the value of the RECURSIVE tag.
692
+ # Possible values are YES and NO. If left blank NO is used.
693
+
694
+ EXAMPLE_RECURSIVE = NO
695
+
696
+ # The IMAGE_PATH tag can be used to specify one or more files or
697
+ # directories that contain image that are included in the documentation (see
698
+ # the \image command).
699
+
700
+ IMAGE_PATH =
701
+
702
+ # The INPUT_FILTER tag can be used to specify a program that doxygen should
703
+ # invoke to filter for each input file. Doxygen will invoke the filter program
704
+ # by executing (via popen()) the command <filter> <input-file>, where <filter>
705
+ # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
706
+ # input file. Doxygen will then use the output that the filter program writes
707
+ # to standard output. If FILTER_PATTERNS is specified, this tag will be
708
+ # ignored.
709
+
710
+ INPUT_FILTER =
711
+
712
+ # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
713
+ # basis. Doxygen will compare the file name with each pattern and apply the
714
+ # filter if there is a match. The filters are a list of the form:
715
+ # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
716
+ # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
717
+ # is applied to all files.
718
+
719
+ FILTER_PATTERNS =
720
+
721
+ # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
722
+ # INPUT_FILTER) will be used to filter the input files when producing source
723
+ # files to browse (i.e. when SOURCE_BROWSER is set to YES).
724
+
725
+ FILTER_SOURCE_FILES = NO
726
+
727
+ #---------------------------------------------------------------------------
728
+ # configuration options related to source browsing
729
+ #---------------------------------------------------------------------------
730
+
731
+ # If the SOURCE_BROWSER tag is set to YES then a list of source files will
732
+ # be generated. Documented entities will be cross-referenced with these sources.
733
+ # Note: To get rid of all source code in the generated output, make sure also
734
+ # VERBATIM_HEADERS is set to NO.
735
+
736
+ SOURCE_BROWSER = NO
737
+
738
+ # Setting the INLINE_SOURCES tag to YES will include the body
739
+ # of functions and classes directly in the documentation.
740
+
741
+ INLINE_SOURCES = NO
742
+
743
+ # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
744
+ # doxygen to hide any special comment blocks from generated source code
745
+ # fragments. Normal C and C++ comments will always remain visible.
746
+
747
+ STRIP_CODE_COMMENTS = YES
748
+
749
+ # If the REFERENCED_BY_RELATION tag is set to YES
750
+ # then for each documented function all documented
751
+ # functions referencing it will be listed.
752
+
753
+ REFERENCED_BY_RELATION = NO
754
+
755
+ # If the REFERENCES_RELATION tag is set to YES
756
+ # then for each documented function all documented entities
757
+ # called/used by that function will be listed.
758
+
759
+ REFERENCES_RELATION = NO
760
+
761
+ # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
762
+ # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
763
+ # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
764
+ # link to the source code. Otherwise they will link to the documentation.
765
+
766
+ REFERENCES_LINK_SOURCE = YES
767
+
768
+ # If the USE_HTAGS tag is set to YES then the references to source code
769
+ # will point to the HTML generated by the htags(1) tool instead of doxygen
770
+ # built-in source browser. The htags tool is part of GNU's global source
771
+ # tagging system (see http://www.gnu.org/software/global/global.html). You
772
+ # will need version 4.8.6 or higher.
773
+
774
+ USE_HTAGS = NO
775
+
776
+ # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
777
+ # will generate a verbatim copy of the header file for each class for
778
+ # which an include is specified. Set to NO to disable this.
779
+
780
+ VERBATIM_HEADERS = YES
781
+
782
+ #---------------------------------------------------------------------------
783
+ # configuration options related to the alphabetical class index
784
+ #---------------------------------------------------------------------------
785
+
786
+ # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
787
+ # of all compounds will be generated. Enable this if the project
788
+ # contains a lot of classes, structs, unions or interfaces.
789
+
790
+ ALPHABETICAL_INDEX = NO
791
+
792
+ # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
793
+ # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
794
+ # in which this list will be split (can be a number in the range [1..20])
795
+
796
+ COLS_IN_ALPHA_INDEX = 5
797
+
798
+ # In case all classes in a project start with a common prefix, all
799
+ # classes will be put under the same header in the alphabetical index.
800
+ # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
801
+ # should be ignored while generating the index headers.
802
+
803
+ IGNORE_PREFIX =
804
+
805
+ #---------------------------------------------------------------------------
806
+ # configuration options related to the HTML output
807
+ #---------------------------------------------------------------------------
808
+
809
+ # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
810
+ # generate HTML output.
811
+
812
+ GENERATE_HTML = YES
813
+
814
+ # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
815
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
816
+ # put in front of it. If left blank `html' will be used as the default path.
817
+
818
+ HTML_OUTPUT = html
819
+
820
+ # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
821
+ # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
822
+ # doxygen will generate files with .html extension.
823
+
824
+ HTML_FILE_EXTENSION = .html
825
+
826
+ # The HTML_HEADER tag can be used to specify a personal HTML header for
827
+ # each generated HTML page. If it is left blank doxygen will generate a
828
+ # standard header.
829
+
830
+ HTML_HEADER =
831
+
832
+ # The HTML_FOOTER tag can be used to specify a personal HTML footer for
833
+ # each generated HTML page. If it is left blank doxygen will generate a
834
+ # standard footer.
835
+
836
+ HTML_FOOTER =
837
+
838
+ # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
839
+ # style sheet that is used by each HTML page. It can be used to
840
+ # fine-tune the look of the HTML output. If the tag is left blank doxygen
841
+ # will generate a default style sheet. Note that doxygen will try to copy
842
+ # the style sheet file to the HTML output directory, so don't put your own
843
+ # stylesheet in the HTML output directory as well, or it will be erased!
844
+
845
+ HTML_STYLESHEET =
846
+
847
+ # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
848
+ # page will contain the date and time when the page was generated. Setting
849
+ # this to NO can help when comparing the output of multiple runs.
850
+
851
+ HTML_TIMESTAMP = YES
852
+
853
+ # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
854
+ # files or namespaces will be aligned in HTML using tables. If set to
855
+ # NO a bullet list will be used.
856
+
857
+ HTML_ALIGN_MEMBERS = YES
858
+
859
+ # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
860
+ # documentation will contain sections that can be hidden and shown after the
861
+ # page has loaded. For this to work a browser that supports
862
+ # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
863
+ # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
864
+
865
+ HTML_DYNAMIC_SECTIONS = NO
866
+
867
+ # If the GENERATE_DOCSET tag is set to YES, additional index files
868
+ # will be generated that can be used as input for Apple's Xcode 3
869
+ # integrated development environment, introduced with OSX 10.5 (Leopard).
870
+ # To create a documentation set, doxygen will generate a Makefile in the
871
+ # HTML output directory. Running make will produce the docset in that
872
+ # directory and running "make install" will install the docset in
873
+ # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
874
+ # it at startup.
875
+ # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
876
+
877
+ GENERATE_DOCSET = NO
878
+
879
+ # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
880
+ # feed. A documentation feed provides an umbrella under which multiple
881
+ # documentation sets from a single provider (such as a company or product suite)
882
+ # can be grouped.
883
+
884
+ DOCSET_FEEDNAME = "Doxygen generated docs"
885
+
886
+ # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
887
+ # should uniquely identify the documentation set bundle. This should be a
888
+ # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
889
+ # will append .docset to the name.
890
+
891
+ DOCSET_BUNDLE_ID = org.doxygen.Project
892
+
893
+ # If the GENERATE_HTMLHELP tag is set to YES, additional index files
894
+ # will be generated that can be used as input for tools like the
895
+ # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
896
+ # of the generated HTML documentation.
897
+
898
+ GENERATE_HTMLHELP = NO
899
+
900
+ # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
901
+ # be used to specify the file name of the resulting .chm file. You
902
+ # can add a path in front of the file if the result should not be
903
+ # written to the html output directory.
904
+
905
+ CHM_FILE =
906
+
907
+ # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
908
+ # be used to specify the location (absolute path including file name) of
909
+ # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
910
+ # the HTML help compiler on the generated index.hhp.
911
+
912
+ HHC_LOCATION =
913
+
914
+ # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
915
+ # controls if a separate .chi index file is generated (YES) or that
916
+ # it should be included in the master .chm file (NO).
917
+
918
+ GENERATE_CHI = NO
919
+
920
+ # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
921
+ # is used to encode HtmlHelp index (hhk), content (hhc) and project file
922
+ # content.
923
+
924
+ CHM_INDEX_ENCODING =
925
+
926
+ # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
927
+ # controls whether a binary table of contents is generated (YES) or a
928
+ # normal table of contents (NO) in the .chm file.
929
+
930
+ BINARY_TOC = NO
931
+
932
+ # The TOC_EXPAND flag can be set to YES to add extra items for group members
933
+ # to the contents of the HTML help documentation and to the tree view.
934
+
935
+ TOC_EXPAND = NO
936
+
937
+ # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
938
+ # are set, an additional index file will be generated that can be used as input for
939
+ # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
940
+ # HTML documentation.
941
+
942
+ GENERATE_QHP = NO
943
+
944
+ # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
945
+ # be used to specify the file name of the resulting .qch file.
946
+ # The path specified is relative to the HTML output folder.
947
+
948
+ QCH_FILE =
949
+
950
+ # The QHP_NAMESPACE tag specifies the namespace to use when generating
951
+ # Qt Help Project output. For more information please see
952
+ # http://doc.trolltech.com/qthelpproject.html#namespace
953
+
954
+ QHP_NAMESPACE = org.doxygen.Project
955
+
956
+ # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
957
+ # Qt Help Project output. For more information please see
958
+ # http://doc.trolltech.com/qthelpproject.html#virtual-folders
959
+
960
+ QHP_VIRTUAL_FOLDER = doc
961
+
962
+ # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
963
+ # For more information please see
964
+ # http://doc.trolltech.com/qthelpproject.html#custom-filters
965
+
966
+ QHP_CUST_FILTER_NAME =
967
+
968
+ # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
969
+ # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
970
+
971
+ QHP_CUST_FILTER_ATTRS =
972
+
973
+ # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
974
+ # filter section matches.
975
+ # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
976
+
977
+ QHP_SECT_FILTER_ATTRS =
978
+
979
+ # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
980
+ # be used to specify the location of Qt's qhelpgenerator.
981
+ # If non-empty doxygen will try to run qhelpgenerator on the generated
982
+ # .qhp file.
983
+
984
+ QHG_LOCATION =
985
+
986
+ # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
987
+ # will be generated, which together with the HTML files, form an Eclipse help
988
+ # plugin. To install this plugin and make it available under the help contents
989
+ # menu in Eclipse, the contents of the directory containing the HTML and XML
990
+ # files needs to be copied into the plugins directory of eclipse. The name of
991
+ # the directory within the plugins directory should be the same as
992
+ # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
993
+ # the help appears.
994
+
995
+ GENERATE_ECLIPSEHELP = NO
996
+
997
+ # A unique identifier for the eclipse help plugin. When installing the plugin
998
+ # the directory name containing the HTML and XML files should also have
999
+ # this name.
1000
+
1001
+ ECLIPSE_DOC_ID = org.doxygen.Project
1002
+
1003
+ # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1004
+ # top of each HTML page. The value NO (the default) enables the index and
1005
+ # the value YES disables it.
1006
+
1007
+ DISABLE_INDEX = NO
1008
+
1009
+ # This tag can be used to set the number of enum values (range [1..20])
1010
+ # that doxygen will group on one line in the generated HTML documentation.
1011
+
1012
+ ENUM_VALUES_PER_LINE = 4
1013
+
1014
+ # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1015
+ # structure should be generated to display hierarchical information.
1016
+ # If the tag value is set to YES, a side panel will be generated
1017
+ # containing a tree-like index structure (just like the one that
1018
+ # is generated for HTML Help). For this to work a browser that supports
1019
+ # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1020
+ # Windows users are probably better off using the HTML help feature.
1021
+
1022
+ GENERATE_TREEVIEW = NO
1023
+
1024
+ # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1025
+ # and Class Hierarchy pages using a tree view instead of an ordered list.
1026
+
1027
+ USE_INLINE_TREES = NO
1028
+
1029
+ # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1030
+ # used to set the initial width (in pixels) of the frame in which the tree
1031
+ # is shown.
1032
+
1033
+ TREEVIEW_WIDTH = 250
1034
+
1035
+ # Use this tag to change the font size of Latex formulas included
1036
+ # as images in the HTML documentation. The default is 10. Note that
1037
+ # when you change the font size after a successful doxygen run you need
1038
+ # to manually remove any form_*.png images from the HTML output directory
1039
+ # to force them to be regenerated.
1040
+
1041
+ FORMULA_FONTSIZE = 10
1042
+
1043
+ # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1044
+ # for the HTML output. The underlying search engine uses javascript
1045
+ # and DHTML and should work on any modern browser. Note that when using
1046
+ # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1047
+ # (GENERATE_DOCSET) there is already a search function so this one should
1048
+ # typically be disabled. For large projects the javascript based search engine
1049
+ # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1050
+
1051
+ SEARCHENGINE = YES
1052
+
1053
+ # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1054
+ # implemented using a PHP enabled web server instead of at the web client
1055
+ # using Javascript. Doxygen will generate the search PHP script and index
1056
+ # file to put on the web server. The advantage of the server
1057
+ # based approach is that it scales better to large projects and allows
1058
+ # full text search. The disadvances is that it is more difficult to setup
1059
+ # and does not have live searching capabilities.
1060
+
1061
+ SERVER_BASED_SEARCH = NO
1062
+
1063
+ #---------------------------------------------------------------------------
1064
+ # configuration options related to the LaTeX output
1065
+ #---------------------------------------------------------------------------
1066
+
1067
+ # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1068
+ # generate Latex output.
1069
+
1070
+ GENERATE_LATEX = NO
1071
+
1072
+ # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1073
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1074
+ # put in front of it. If left blank `latex' will be used as the default path.
1075
+
1076
+ LATEX_OUTPUT = latex
1077
+
1078
+ # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1079
+ # invoked. If left blank `latex' will be used as the default command name.
1080
+ # Note that when enabling USE_PDFLATEX this option is only used for
1081
+ # generating bitmaps for formulas in the HTML output, but not in the
1082
+ # Makefile that is written to the output directory.
1083
+
1084
+ LATEX_CMD_NAME = latex
1085
+
1086
+ # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1087
+ # generate index for LaTeX. If left blank `makeindex' will be used as the
1088
+ # default command name.
1089
+
1090
+ MAKEINDEX_CMD_NAME = makeindex
1091
+
1092
+ # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1093
+ # LaTeX documents. This may be useful for small projects and may help to
1094
+ # save some trees in general.
1095
+
1096
+ COMPACT_LATEX = NO
1097
+
1098
+ # The PAPER_TYPE tag can be used to set the paper type that is used
1099
+ # by the printer. Possible values are: a4, a4wide, letter, legal and
1100
+ # executive. If left blank a4wide will be used.
1101
+
1102
+ PAPER_TYPE = a4wide
1103
+
1104
+ # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1105
+ # packages that should be included in the LaTeX output.
1106
+
1107
+ EXTRA_PACKAGES =
1108
+
1109
+ # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1110
+ # the generated latex document. The header should contain everything until
1111
+ # the first chapter. If it is left blank doxygen will generate a
1112
+ # standard header. Notice: only use this tag if you know what you are doing!
1113
+
1114
+ LATEX_HEADER =
1115
+
1116
+ # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1117
+ # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1118
+ # contain links (just like the HTML output) instead of page references
1119
+ # This makes the output suitable for online browsing using a pdf viewer.
1120
+
1121
+ PDF_HYPERLINKS = YES
1122
+
1123
+ # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1124
+ # plain latex in the generated Makefile. Set this option to YES to get a
1125
+ # higher quality PDF documentation.
1126
+
1127
+ USE_PDFLATEX = YES
1128
+
1129
+ # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1130
+ # command to the generated LaTeX files. This will instruct LaTeX to keep
1131
+ # running if errors occur, instead of asking the user for help.
1132
+ # This option is also used when generating formulas in HTML.
1133
+
1134
+ LATEX_BATCHMODE = NO
1135
+
1136
+ # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1137
+ # include the index chapters (such as File Index, Compound Index, etc.)
1138
+ # in the output.
1139
+
1140
+ LATEX_HIDE_INDICES = NO
1141
+
1142
+ # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1143
+ # source code with syntax highlighting in the LaTeX output.
1144
+ # Note that which sources are shown also depends on other settings
1145
+ # such as SOURCE_BROWSER.
1146
+
1147
+ LATEX_SOURCE_CODE = NO
1148
+
1149
+ #---------------------------------------------------------------------------
1150
+ # configuration options related to the RTF output
1151
+ #---------------------------------------------------------------------------
1152
+
1153
+ # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1154
+ # The RTF output is optimized for Word 97 and may not look very pretty with
1155
+ # other RTF readers or editors.
1156
+
1157
+ GENERATE_RTF = NO
1158
+
1159
+ # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1160
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1161
+ # put in front of it. If left blank `rtf' will be used as the default path.
1162
+
1163
+ RTF_OUTPUT = rtf
1164
+
1165
+ # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1166
+ # RTF documents. This may be useful for small projects and may help to
1167
+ # save some trees in general.
1168
+
1169
+ COMPACT_RTF = NO
1170
+
1171
+ # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1172
+ # will contain hyperlink fields. The RTF file will
1173
+ # contain links (just like the HTML output) instead of page references.
1174
+ # This makes the output suitable for online browsing using WORD or other
1175
+ # programs which support those fields.
1176
+ # Note: wordpad (write) and others do not support links.
1177
+
1178
+ RTF_HYPERLINKS = NO
1179
+
1180
+ # Load stylesheet definitions from file. Syntax is similar to doxygen's
1181
+ # config file, i.e. a series of assignments. You only have to provide
1182
+ # replacements, missing definitions are set to their default value.
1183
+
1184
+ RTF_STYLESHEET_FILE =
1185
+
1186
+ # Set optional variables used in the generation of an rtf document.
1187
+ # Syntax is similar to doxygen's config file.
1188
+
1189
+ RTF_EXTENSIONS_FILE =
1190
+
1191
+ #---------------------------------------------------------------------------
1192
+ # configuration options related to the man page output
1193
+ #---------------------------------------------------------------------------
1194
+
1195
+ # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1196
+ # generate man pages
1197
+
1198
+ GENERATE_MAN = NO
1199
+
1200
+ # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1201
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1202
+ # put in front of it. If left blank `man' will be used as the default path.
1203
+
1204
+ MAN_OUTPUT = man
1205
+
1206
+ # The MAN_EXTENSION tag determines the extension that is added to
1207
+ # the generated man pages (default is the subroutine's section .3)
1208
+
1209
+ MAN_EXTENSION = .3
1210
+
1211
+ # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1212
+ # then it will generate one additional man file for each entity
1213
+ # documented in the real man page(s). These additional files
1214
+ # only source the real man page, but without them the man command
1215
+ # would be unable to find the correct page. The default is NO.
1216
+
1217
+ MAN_LINKS = NO
1218
+
1219
+ #---------------------------------------------------------------------------
1220
+ # configuration options related to the XML output
1221
+ #---------------------------------------------------------------------------
1222
+
1223
+ # If the GENERATE_XML tag is set to YES Doxygen will
1224
+ # generate an XML file that captures the structure of
1225
+ # the code including all documentation.
1226
+
1227
+ GENERATE_XML = YES
1228
+
1229
+ # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1230
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1231
+ # put in front of it. If left blank `xml' will be used as the default path.
1232
+
1233
+ XML_OUTPUT = xml
1234
+
1235
+ # The XML_SCHEMA tag can be used to specify an XML schema,
1236
+ # which can be used by a validating XML parser to check the
1237
+ # syntax of the XML files.
1238
+
1239
+ XML_SCHEMA =
1240
+
1241
+ # The XML_DTD tag can be used to specify an XML DTD,
1242
+ # which can be used by a validating XML parser to check the
1243
+ # syntax of the XML files.
1244
+
1245
+ XML_DTD =
1246
+
1247
+ # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1248
+ # dump the program listings (including syntax highlighting
1249
+ # and cross-referencing information) to the XML output. Note that
1250
+ # enabling this will significantly increase the size of the XML output.
1251
+
1252
+ XML_PROGRAMLISTING = YES
1253
+
1254
+ #---------------------------------------------------------------------------
1255
+ # configuration options for the AutoGen Definitions output
1256
+ #---------------------------------------------------------------------------
1257
+
1258
+ # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1259
+ # generate an AutoGen Definitions (see autogen.sf.net) file
1260
+ # that captures the structure of the code including all
1261
+ # documentation. Note that this feature is still experimental
1262
+ # and incomplete at the moment.
1263
+
1264
+ GENERATE_AUTOGEN_DEF = NO
1265
+
1266
+ #---------------------------------------------------------------------------
1267
+ # configuration options related to the Perl module output
1268
+ #---------------------------------------------------------------------------
1269
+
1270
+ # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1271
+ # generate a Perl module file that captures the structure of
1272
+ # the code including all documentation. Note that this
1273
+ # feature is still experimental and incomplete at the
1274
+ # moment.
1275
+
1276
+ GENERATE_PERLMOD = NO
1277
+
1278
+ # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1279
+ # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1280
+ # to generate PDF and DVI output from the Perl module output.
1281
+
1282
+ PERLMOD_LATEX = NO
1283
+
1284
+ # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1285
+ # nicely formatted so it can be parsed by a human reader. This is useful
1286
+ # if you want to understand what is going on. On the other hand, if this
1287
+ # tag is set to NO the size of the Perl module output will be much smaller
1288
+ # and Perl will parse it just the same.
1289
+
1290
+ PERLMOD_PRETTY = YES
1291
+
1292
+ # The names of the make variables in the generated doxyrules.make file
1293
+ # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1294
+ # This is useful so different doxyrules.make files included by the same
1295
+ # Makefile don't overwrite each other's variables.
1296
+
1297
+ PERLMOD_MAKEVAR_PREFIX =
1298
+
1299
+ #---------------------------------------------------------------------------
1300
+ # Configuration options related to the preprocessor
1301
+ #---------------------------------------------------------------------------
1302
+
1303
+ # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1304
+ # evaluate all C-preprocessor directives found in the sources and include
1305
+ # files.
1306
+
1307
+ ENABLE_PREPROCESSING = YES
1308
+
1309
+ # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1310
+ # names in the source code. If set to NO (the default) only conditional
1311
+ # compilation will be performed. Macro expansion can be done in a controlled
1312
+ # way by setting EXPAND_ONLY_PREDEF to YES.
1313
+
1314
+ MACRO_EXPANSION = NO
1315
+
1316
+ # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1317
+ # then the macro expansion is limited to the macros specified with the
1318
+ # PREDEFINED and EXPAND_AS_DEFINED tags.
1319
+
1320
+ EXPAND_ONLY_PREDEF = NO
1321
+
1322
+ # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1323
+ # in the INCLUDE_PATH (see below) will be search if a #include is found.
1324
+
1325
+ SEARCH_INCLUDES = YES
1326
+
1327
+ # The INCLUDE_PATH tag can be used to specify one or more directories that
1328
+ # contain include files that are not input files but should be processed by
1329
+ # the preprocessor.
1330
+
1331
+ INCLUDE_PATH =
1332
+
1333
+ # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1334
+ # patterns (like *.h and *.hpp) to filter out the header-files in the
1335
+ # directories. If left blank, the patterns specified with FILE_PATTERNS will
1336
+ # be used.
1337
+
1338
+ INCLUDE_FILE_PATTERNS =
1339
+
1340
+ # The PREDEFINED tag can be used to specify one or more macro names that
1341
+ # are defined before the preprocessor is started (similar to the -D option of
1342
+ # gcc). The argument of the tag is a list of macros of the form: name
1343
+ # or name=definition (no spaces). If the definition and the = are
1344
+ # omitted =1 is assumed. To prevent a macro definition from being
1345
+ # undefined via #undef or recursively expanded use the := operator
1346
+ # instead of the = operator.
1347
+
1348
+ PREDEFINED =
1349
+
1350
+ # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1351
+ # this tag can be used to specify a list of macro names that should be expanded.
1352
+ # The macro definition that is found in the sources will be used.
1353
+ # Use the PREDEFINED tag if you want to use a different macro definition.
1354
+
1355
+ EXPAND_AS_DEFINED =
1356
+
1357
+ # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1358
+ # doxygen's preprocessor will remove all function-like macros that are alone
1359
+ # on a line, have an all uppercase name, and do not end with a semicolon. Such
1360
+ # function macros are typically used for boiler-plate code, and will confuse
1361
+ # the parser if not removed.
1362
+
1363
+ SKIP_FUNCTION_MACROS = YES
1364
+
1365
+ #---------------------------------------------------------------------------
1366
+ # Configuration::additions related to external references
1367
+ #---------------------------------------------------------------------------
1368
+
1369
+ # The TAGFILES option can be used to specify one or more tagfiles.
1370
+ # Optionally an initial location of the external documentation
1371
+ # can be added for each tagfile. The format of a tag file without
1372
+ # this location is as follows:
1373
+ # TAGFILES = file1 file2 ...
1374
+ # Adding location for the tag files is done as follows:
1375
+ # TAGFILES = file1=loc1 "file2 = loc2" ...
1376
+ # where "loc1" and "loc2" can be relative or absolute paths or
1377
+ # URLs. If a location is present for each tag, the installdox tool
1378
+ # does not have to be run to correct the links.
1379
+ # Note that each tag file must have a unique name
1380
+ # (where the name does NOT include the path)
1381
+ # If a tag file is not located in the directory in which doxygen
1382
+ # is run, you must also specify the path to the tagfile here.
1383
+
1384
+ TAGFILES =
1385
+
1386
+ # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1387
+ # a tag file that is based on the input files it reads.
1388
+
1389
+ GENERATE_TAGFILE =
1390
+
1391
+ # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1392
+ # in the class index. If set to NO only the inherited external classes
1393
+ # will be listed.
1394
+
1395
+ ALLEXTERNALS = NO
1396
+
1397
+ # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1398
+ # in the modules index. If set to NO, only the current project's groups will
1399
+ # be listed.
1400
+
1401
+ EXTERNAL_GROUPS = YES
1402
+
1403
+ # The PERL_PATH should be the absolute path and name of the perl script
1404
+ # interpreter (i.e. the result of `which perl').
1405
+
1406
+ PERL_PATH = /usr/bin/perl
1407
+
1408
+ #---------------------------------------------------------------------------
1409
+ # Configuration options related to the dot tool
1410
+ #---------------------------------------------------------------------------
1411
+
1412
+ # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1413
+ # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1414
+ # or super classes. Setting the tag to NO turns the diagrams off. Note that
1415
+ # this option is superseded by the HAVE_DOT option below. This is only a
1416
+ # fallback. It is recommended to install and use dot, since it yields more
1417
+ # powerful graphs.
1418
+
1419
+ CLASS_DIAGRAMS = YES
1420
+
1421
+ # You can define message sequence charts within doxygen comments using the \msc
1422
+ # command. Doxygen will then run the mscgen tool (see
1423
+ # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1424
+ # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1425
+ # the mscgen tool resides. If left empty the tool is assumed to be found in the
1426
+ # default search path.
1427
+
1428
+ MSCGEN_PATH =
1429
+
1430
+ # If set to YES, the inheritance and collaboration graphs will hide
1431
+ # inheritance and usage relations if the target is undocumented
1432
+ # or is not a class.
1433
+
1434
+ HIDE_UNDOC_RELATIONS = YES
1435
+
1436
+ # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1437
+ # available from the path. This tool is part of Graphviz, a graph visualization
1438
+ # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1439
+ # have no effect if this option is set to NO (the default)
1440
+
1441
+ HAVE_DOT = NO
1442
+
1443
+ # By default doxygen will write a font called FreeSans.ttf to the output
1444
+ # directory and reference it in all dot files that doxygen generates. This
1445
+ # font does not include all possible unicode characters however, so when you need
1446
+ # these (or just want a differently looking font) you can specify the font name
1447
+ # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1448
+ # which can be done by putting it in a standard location or by setting the
1449
+ # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1450
+ # containing the font.
1451
+
1452
+ DOT_FONTNAME = FreeSans
1453
+
1454
+ # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1455
+ # The default size is 10pt.
1456
+
1457
+ DOT_FONTSIZE = 10
1458
+
1459
+ # By default doxygen will tell dot to use the output directory to look for the
1460
+ # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1461
+ # different font using DOT_FONTNAME you can set the path where dot
1462
+ # can find it using this tag.
1463
+
1464
+ DOT_FONTPATH =
1465
+
1466
+ # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1467
+ # will generate a graph for each documented class showing the direct and
1468
+ # indirect inheritance relations. Setting this tag to YES will force the
1469
+ # the CLASS_DIAGRAMS tag to NO.
1470
+
1471
+ CLASS_GRAPH = YES
1472
+
1473
+ # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1474
+ # will generate a graph for each documented class showing the direct and
1475
+ # indirect implementation dependencies (inheritance, containment, and
1476
+ # class references variables) of the class with other documented classes.
1477
+
1478
+ COLLABORATION_GRAPH = YES
1479
+
1480
+ # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1481
+ # will generate a graph for groups, showing the direct groups dependencies
1482
+
1483
+ GROUP_GRAPHS = YES
1484
+
1485
+ # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1486
+ # collaboration diagrams in a style similar to the OMG's Unified Modeling
1487
+ # Language.
1488
+
1489
+ UML_LOOK = NO
1490
+
1491
+ # If set to YES, the inheritance and collaboration graphs will show the
1492
+ # relations between templates and their instances.
1493
+
1494
+ TEMPLATE_RELATIONS = NO
1495
+
1496
+ # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1497
+ # tags are set to YES then doxygen will generate a graph for each documented
1498
+ # file showing the direct and indirect include dependencies of the file with
1499
+ # other documented files.
1500
+
1501
+ INCLUDE_GRAPH = YES
1502
+
1503
+ # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1504
+ # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1505
+ # documented header file showing the documented files that directly or
1506
+ # indirectly include this file.
1507
+
1508
+ INCLUDED_BY_GRAPH = YES
1509
+
1510
+ # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1511
+ # doxygen will generate a call dependency graph for every global function
1512
+ # or class method. Note that enabling this option will significantly increase
1513
+ # the time of a run. So in most cases it will be better to enable call graphs
1514
+ # for selected functions only using the \callgraph command.
1515
+
1516
+ CALL_GRAPH = NO
1517
+
1518
+ # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1519
+ # doxygen will generate a caller dependency graph for every global function
1520
+ # or class method. Note that enabling this option will significantly increase
1521
+ # the time of a run. So in most cases it will be better to enable caller
1522
+ # graphs for selected functions only using the \callergraph command.
1523
+
1524
+ CALLER_GRAPH = NO
1525
+
1526
+ # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1527
+ # will graphical hierarchy of all classes instead of a textual one.
1528
+
1529
+ GRAPHICAL_HIERARCHY = YES
1530
+
1531
+ # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1532
+ # then doxygen will show the dependencies a directory has on other directories
1533
+ # in a graphical way. The dependency relations are determined by the #include
1534
+ # relations between the files in the directories.
1535
+
1536
+ DIRECTORY_GRAPH = YES
1537
+
1538
+ # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1539
+ # generated by dot. Possible values are png, jpg, or gif
1540
+ # If left blank png will be used.
1541
+
1542
+ DOT_IMAGE_FORMAT = png
1543
+
1544
+ # The tag DOT_PATH can be used to specify the path where the dot tool can be
1545
+ # found. If left blank, it is assumed the dot tool can be found in the path.
1546
+
1547
+ DOT_PATH =
1548
+
1549
+ # The DOTFILE_DIRS tag can be used to specify one or more directories that
1550
+ # contain dot files that are included in the documentation (see the
1551
+ # \dotfile command).
1552
+
1553
+ DOTFILE_DIRS =
1554
+
1555
+ # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1556
+ # nodes that will be shown in the graph. If the number of nodes in a graph
1557
+ # becomes larger than this value, doxygen will truncate the graph, which is
1558
+ # visualized by representing a node as a red box. Note that doxygen if the
1559
+ # number of direct children of the root node in a graph is already larger than
1560
+ # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1561
+ # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1562
+
1563
+ DOT_GRAPH_MAX_NODES = 50
1564
+
1565
+ # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1566
+ # graphs generated by dot. A depth value of 3 means that only nodes reachable
1567
+ # from the root by following a path via at most 3 edges will be shown. Nodes
1568
+ # that lay further from the root node will be omitted. Note that setting this
1569
+ # option to 1 or 2 may greatly reduce the computation time needed for large
1570
+ # code bases. Also note that the size of a graph can be further restricted by
1571
+ # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1572
+
1573
+ MAX_DOT_GRAPH_DEPTH = 0
1574
+
1575
+ # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1576
+ # background. This is disabled by default, because dot on Windows does not
1577
+ # seem to support this out of the box. Warning: Depending on the platform used,
1578
+ # enabling this option may lead to badly anti-aliased labels on the edges of
1579
+ # a graph (i.e. they become hard to read).
1580
+
1581
+ DOT_TRANSPARENT = NO
1582
+
1583
+ # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1584
+ # files in one run (i.e. multiple -o and -T options on the command line). This
1585
+ # makes dot run faster, but since only newer versions of dot (>1.8.10)
1586
+ # support this, this feature is disabled by default.
1587
+
1588
+ DOT_MULTI_TARGETS = NO
1589
+
1590
+ # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1591
+ # generate a legend page explaining the meaning of the various boxes and
1592
+ # arrows in the dot generated graphs.
1593
+
1594
+ GENERATE_LEGEND = YES
1595
+
1596
+ # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1597
+ # remove the intermediate dot files that are used to generate
1598
+ # the various graphs.
1599
+
1600
+ DOT_CLEANUP = YES