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