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