inkcpp_rb 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (273) hide show
  1. checksums.yaml +7 -0
  2. data/.ruby-version +1 -0
  3. data/CHANGELOG.md +1 -0
  4. data/Gemfile +10 -0
  5. data/Gemfile.lock +84 -0
  6. data/LICENSE +7 -0
  7. data/README.md +3 -0
  8. data/Rakefile +16 -0
  9. data/bin/console +15 -0
  10. data/bin/setup +10 -0
  11. data/bin/tapioca +29 -0
  12. data/ext/inkcpp_rb/extconf.rb +19 -0
  13. data/ext/inkcpp_rb/inkcpp/.clang-format +99 -0
  14. data/ext/inkcpp_rb/inkcpp/.github/FUNDING.yml +1 -0
  15. data/ext/inkcpp_rb/inkcpp/.github/workflows/build.yml +344 -0
  16. data/ext/inkcpp_rb/inkcpp/.github/workflows/release.yml +49 -0
  17. data/ext/inkcpp_rb/inkcpp/.gitignore +25 -0
  18. data/ext/inkcpp_rb/inkcpp/.gitmodules +9 -0
  19. data/ext/inkcpp_rb/inkcpp/CMakeLists.txt +170 -0
  20. data/ext/inkcpp_rb/inkcpp/CODE_OF_CONDUCT.md +76 -0
  21. data/ext/inkcpp_rb/inkcpp/CONTRIBUTING.md +55 -0
  22. data/ext/inkcpp_rb/inkcpp/Config.cmake.in +2 -0
  23. data/ext/inkcpp_rb/inkcpp/Documentation/cmake_example/CMakeLists.txt +13 -0
  24. data/ext/inkcpp_rb/inkcpp/Documentation/cmake_example/main.c +38 -0
  25. data/ext/inkcpp_rb/inkcpp/Documentation/cmake_example/main.cpp +40 -0
  26. data/ext/inkcpp_rb/inkcpp/Documentation/cmake_example/test.ink +8 -0
  27. data/ext/inkcpp_rb/inkcpp/Documentation/cmake_example/test.ink.json +1 -0
  28. data/ext/inkcpp_rb/inkcpp/Documentation/cmake_example.zip +0 -0
  29. data/ext/inkcpp_rb/inkcpp/Documentation/unreal/InkCPP_DEMO.zip +0 -0
  30. data/ext/inkcpp_rb/inkcpp/Documentation/unreal/imgs/CreateThread.png +0 -0
  31. data/ext/inkcpp_rb/inkcpp/Documentation/unreal/imgs/HandleChoice.png +0 -0
  32. data/ext/inkcpp_rb/inkcpp/Documentation/unreal/imgs/ListElementOf.png +0 -0
  33. data/ext/inkcpp_rb/inkcpp/Documentation/unreal/imgs/MinimalRuntime.png +0 -0
  34. data/ext/inkcpp_rb/inkcpp/Documentation/unreal/imgs/MinimalThread.png +0 -0
  35. data/ext/inkcpp_rb/inkcpp/Documentation/unreal/imgs/ObseverChange.png +0 -0
  36. data/ext/inkcpp_rb/inkcpp/Documentation/unreal/imgs/TagListGetValue.png +0 -0
  37. data/ext/inkcpp_rb/inkcpp/Documentation/unreal/imgs/YieldResume.png +0 -0
  38. data/ext/inkcpp_rb/inkcpp/Doxyfile +2825 -0
  39. data/ext/inkcpp_rb/inkcpp/LICENSE.txt +22 -0
  40. data/ext/inkcpp_rb/inkcpp/Minimal.runsettings +8 -0
  41. data/ext/inkcpp_rb/inkcpp/README.md +192 -0
  42. data/ext/inkcpp_rb/inkcpp/inkcpp/CMakeLists.txt +67 -0
  43. data/ext/inkcpp_rb/inkcpp/inkcpp/array.h +481 -0
  44. data/ext/inkcpp_rb/inkcpp/inkcpp/avl_array.h +833 -0
  45. data/ext/inkcpp_rb/inkcpp/inkcpp/casting.h +93 -0
  46. data/ext/inkcpp_rb/inkcpp/inkcpp/choice.cpp +54 -0
  47. data/ext/inkcpp_rb/inkcpp/inkcpp/collections/restorable.cpp +124 -0
  48. data/ext/inkcpp_rb/inkcpp/inkcpp/collections/restorable.h +406 -0
  49. data/ext/inkcpp_rb/inkcpp/inkcpp/container_operations.cpp +52 -0
  50. data/ext/inkcpp_rb/inkcpp/inkcpp/container_operations.h +34 -0
  51. data/ext/inkcpp_rb/inkcpp/inkcpp/executioner.h +179 -0
  52. data/ext/inkcpp_rb/inkcpp/inkcpp/functional.cpp +86 -0
  53. data/ext/inkcpp_rb/inkcpp/inkcpp/functions.cpp +54 -0
  54. data/ext/inkcpp_rb/inkcpp/inkcpp/functions.h +40 -0
  55. data/ext/inkcpp_rb/inkcpp/inkcpp/globals_impl.cpp +289 -0
  56. data/ext/inkcpp_rb/inkcpp/inkcpp/globals_impl.h +149 -0
  57. data/ext/inkcpp_rb/inkcpp/inkcpp/header.cpp +44 -0
  58. data/ext/inkcpp_rb/inkcpp/inkcpp/include/choice.h +106 -0
  59. data/ext/inkcpp_rb/inkcpp/inkcpp/include/functional.h +327 -0
  60. data/ext/inkcpp_rb/inkcpp/inkcpp/include/globals.h +196 -0
  61. data/ext/inkcpp_rb/inkcpp/inkcpp/include/list.h +187 -0
  62. data/ext/inkcpp_rb/inkcpp/inkcpp/include/runner.h +291 -0
  63. data/ext/inkcpp_rb/inkcpp/inkcpp/include/snapshot.h +61 -0
  64. data/ext/inkcpp_rb/inkcpp/inkcpp/include/story.h +219 -0
  65. data/ext/inkcpp_rb/inkcpp/inkcpp/include/story_ptr.h +233 -0
  66. data/ext/inkcpp_rb/inkcpp/inkcpp/include/traits.h +270 -0
  67. data/ext/inkcpp_rb/inkcpp/inkcpp/include/types.h +169 -0
  68. data/ext/inkcpp_rb/inkcpp/inkcpp/list_impl.cpp +79 -0
  69. data/ext/inkcpp_rb/inkcpp/inkcpp/list_impl.h +39 -0
  70. data/ext/inkcpp_rb/inkcpp/inkcpp/list_operations.cpp +276 -0
  71. data/ext/inkcpp_rb/inkcpp/inkcpp/list_operations.h +356 -0
  72. data/ext/inkcpp_rb/inkcpp/inkcpp/list_table.cpp +841 -0
  73. data/ext/inkcpp_rb/inkcpp/inkcpp/list_table.h +450 -0
  74. data/ext/inkcpp_rb/inkcpp/inkcpp/numeric_operations.cpp +40 -0
  75. data/ext/inkcpp_rb/inkcpp/inkcpp/numeric_operations.h +529 -0
  76. data/ext/inkcpp_rb/inkcpp/inkcpp/operation_bases.h +164 -0
  77. data/ext/inkcpp_rb/inkcpp/inkcpp/operations.h +100 -0
  78. data/ext/inkcpp_rb/inkcpp/inkcpp/output.cpp +528 -0
  79. data/ext/inkcpp_rb/inkcpp/inkcpp/output.h +153 -0
  80. data/ext/inkcpp_rb/inkcpp/inkcpp/platform.h +22 -0
  81. data/ext/inkcpp_rb/inkcpp/inkcpp/random.h +38 -0
  82. data/ext/inkcpp_rb/inkcpp/inkcpp/runner_impl.cpp +1396 -0
  83. data/ext/inkcpp_rb/inkcpp/inkcpp/runner_impl.h +336 -0
  84. data/ext/inkcpp_rb/inkcpp/inkcpp/simple_restorable_stack.h +335 -0
  85. data/ext/inkcpp_rb/inkcpp/inkcpp/snapshot_impl.cpp +182 -0
  86. data/ext/inkcpp_rb/inkcpp/inkcpp/snapshot_impl.h +91 -0
  87. data/ext/inkcpp_rb/inkcpp/inkcpp/snapshot_interface.h +57 -0
  88. data/ext/inkcpp_rb/inkcpp/inkcpp/stack.cpp +618 -0
  89. data/ext/inkcpp_rb/inkcpp/inkcpp/stack.h +243 -0
  90. data/ext/inkcpp_rb/inkcpp/inkcpp/story_impl.cpp +361 -0
  91. data/ext/inkcpp_rb/inkcpp/inkcpp/story_impl.h +92 -0
  92. data/ext/inkcpp_rb/inkcpp/inkcpp/story_ptr.cpp +75 -0
  93. data/ext/inkcpp_rb/inkcpp/inkcpp/string_operations.cpp +125 -0
  94. data/ext/inkcpp_rb/inkcpp/inkcpp/string_operations.h +67 -0
  95. data/ext/inkcpp_rb/inkcpp/inkcpp/string_table.cpp +149 -0
  96. data/ext/inkcpp_rb/inkcpp/inkcpp/string_table.h +47 -0
  97. data/ext/inkcpp_rb/inkcpp/inkcpp/string_utils.h +207 -0
  98. data/ext/inkcpp_rb/inkcpp/inkcpp/system.cpp +39 -0
  99. data/ext/inkcpp_rb/inkcpp/inkcpp/tuple.hpp +151 -0
  100. data/ext/inkcpp_rb/inkcpp/inkcpp/value.cpp +279 -0
  101. data/ext/inkcpp_rb/inkcpp/inkcpp/value.h +666 -0
  102. data/ext/inkcpp_rb/inkcpp/inkcpp_c/CMakeLists.txt +62 -0
  103. data/ext/inkcpp_rb/inkcpp/inkcpp_c/include/inkcpp.h +393 -0
  104. data/ext/inkcpp_rb/inkcpp/inkcpp_c/inkcpp.cpp +344 -0
  105. data/ext/inkcpp_rb/inkcpp/inkcpp_c/inkcpp_c.pc.in +10 -0
  106. data/ext/inkcpp_rb/inkcpp/inkcpp_c/tests/ExternalFunction.c +56 -0
  107. data/ext/inkcpp_rb/inkcpp/inkcpp_c/tests/Globals.c +98 -0
  108. data/ext/inkcpp_rb/inkcpp/inkcpp_c/tests/Lists.c +73 -0
  109. data/ext/inkcpp_rb/inkcpp/inkcpp_c/tests/Observer.c +36 -0
  110. data/ext/inkcpp_rb/inkcpp/inkcpp_c/tests/Snapshot.c +65 -0
  111. data/ext/inkcpp_rb/inkcpp/inkcpp_cl/CMakeLists.txt +49 -0
  112. data/ext/inkcpp_rb/inkcpp/inkcpp_cl/inkcpp_cl.cpp +215 -0
  113. data/ext/inkcpp_rb/inkcpp/inkcpp_cl/test.cpp +209 -0
  114. data/ext/inkcpp_rb/inkcpp/inkcpp_cl/test.h +8 -0
  115. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/CMakeLists.txt +37 -0
  116. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/binary_emitter.cpp +446 -0
  117. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/binary_emitter.h +70 -0
  118. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/binary_stream.cpp +166 -0
  119. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/binary_stream.h +79 -0
  120. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/command.cpp +107 -0
  121. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/compiler.cpp +96 -0
  122. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/emitter.cpp +62 -0
  123. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/emitter.h +104 -0
  124. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/include/compilation_results.h +22 -0
  125. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/include/compiler.h +44 -0
  126. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/json.hpp +24596 -0
  127. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/json_compiler.cpp +411 -0
  128. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/json_compiler.h +62 -0
  129. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/list_data.cpp +47 -0
  130. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/list_data.h +70 -0
  131. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/reporter.cpp +107 -0
  132. data/ext/inkcpp_rb/inkcpp/inkcpp_compiler/reporter.h +55 -0
  133. data/ext/inkcpp_rb/inkcpp/inkcpp_py/CMakeLists.txt +19 -0
  134. data/ext/inkcpp_rb/inkcpp/inkcpp_py/example.py +78 -0
  135. data/ext/inkcpp_rb/inkcpp/inkcpp_py/src/module.cpp +317 -0
  136. data/ext/inkcpp_rb/inkcpp/inkcpp_py/tests/conftest.py +53 -0
  137. data/ext/inkcpp_rb/inkcpp/inkcpp_py/tests/test_ExternalFunctions.py +35 -0
  138. data/ext/inkcpp_rb/inkcpp/inkcpp_py/tests/test_Globals.py +40 -0
  139. data/ext/inkcpp_rb/inkcpp/inkcpp_py/tests/test_Lists.py +43 -0
  140. data/ext/inkcpp_rb/inkcpp/inkcpp_py/tests/test_Observer.py +27 -0
  141. data/ext/inkcpp_rb/inkcpp/inkcpp_py/tests/test_Snapshot.py +57 -0
  142. data/ext/inkcpp_rb/inkcpp/inkcpp_py/unreal_example.ink +71 -0
  143. data/ext/inkcpp_rb/inkcpp/inkcpp_test/Array.cpp +115 -0
  144. data/ext/inkcpp_rb/inkcpp/inkcpp_test/CMakeLists.txt +117 -0
  145. data/ext/inkcpp_rb/inkcpp/inkcpp_test/Callstack.cpp +392 -0
  146. data/ext/inkcpp_rb/inkcpp/inkcpp_test/EmptyStringForDivert.cpp +36 -0
  147. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ExternalFunctionsExecuteProperly.cpp +34 -0
  148. data/ext/inkcpp_rb/inkcpp/inkcpp_test/FallbackFunction.cpp +77 -0
  149. data/ext/inkcpp_rb/inkcpp/inkcpp_test/Globals.cpp +73 -0
  150. data/ext/inkcpp_rb/inkcpp/inkcpp_test/InkyJson.cpp +34 -0
  151. data/ext/inkcpp_rb/inkcpp/inkcpp_test/LabelCondition.cpp +60 -0
  152. data/ext/inkcpp_rb/inkcpp/inkcpp_test/Lists.cpp +144 -0
  153. data/ext/inkcpp_rb/inkcpp/inkcpp_test/LookaheadSafe.cpp +46 -0
  154. data/ext/inkcpp_rb/inkcpp/inkcpp_test/Main.cpp +7 -0
  155. data/ext/inkcpp_rb/inkcpp/inkcpp_test/MoveTo.cpp +95 -0
  156. data/ext/inkcpp_rb/inkcpp/inkcpp_test/NewLines.cpp +76 -0
  157. data/ext/inkcpp_rb/inkcpp/inkcpp_test/NoEarlyTags.cpp +33 -0
  158. data/ext/inkcpp_rb/inkcpp/inkcpp_test/Observer.cpp +245 -0
  159. data/ext/inkcpp_rb/inkcpp/inkcpp_test/Pointer.cpp +191 -0
  160. data/ext/inkcpp_rb/inkcpp/inkcpp_test/Restorable.cpp +294 -0
  161. data/ext/inkcpp_rb/inkcpp/inkcpp_test/SpaceAfterBracketChoice.cpp +45 -0
  162. data/ext/inkcpp_rb/inkcpp/inkcpp_test/Stack.cpp +224 -0
  163. data/ext/inkcpp_rb/inkcpp/inkcpp_test/Tags.cpp +131 -0
  164. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ThirdTierChoiceAfterBrackets.cpp +38 -0
  165. data/ext/inkcpp_rb/inkcpp/inkcpp_test/UTF8.cpp +56 -0
  166. data/ext/inkcpp_rb/inkcpp/inkcpp_test/Value.cpp +210 -0
  167. data/ext/inkcpp_rb/inkcpp/inkcpp_test/catch.hpp +17970 -0
  168. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/AHF.ink +7 -0
  169. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/ChoiceBracketStory.ink +7 -0
  170. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/EmptyStringForDivert.ink +13 -0
  171. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/ExternalFunctionsExecuteProperly.ink +11 -0
  172. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/FallBack.ink +15 -0
  173. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/GlobalStory.ink +9 -0
  174. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/LabelConditionStory.ink +5 -0
  175. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/LinesStory.ink +42 -0
  176. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/ListLogicStory.ink +40 -0
  177. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/ListStory.ink +8 -0
  178. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/LookaheadSafe.ink +14 -0
  179. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/MoveTo.ink +36 -0
  180. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/NoEarlyTags.ink +19 -0
  181. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/ObserverStory.ink +8 -0
  182. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/SimpleStoryFlow.ink +65 -0
  183. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/TagsStory.ink +22 -0
  184. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/TheIntercept.ink +1686 -0
  185. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/ThirdTierChoiceAfterBracketsStory.ink +13 -0
  186. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/UTF-8-demo.txt +212 -0
  187. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/UTF8Story.ink +218 -0
  188. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/simple-1.1.1-inklecate.json +154 -0
  189. data/ext/inkcpp_rb/inkcpp/inkcpp_test/ink/simple-1.1.1-inky.json +160 -0
  190. data/ext/inkcpp_rb/inkcpp/notes/ArchitectureNotes.md +54 -0
  191. data/ext/inkcpp_rb/inkcpp/notes/ListNotes.md +69 -0
  192. data/ext/inkcpp_rb/inkcpp/notes/OperationNotes.md +35 -0
  193. data/ext/inkcpp_rb/inkcpp/notes/TagsNotes.md +24 -0
  194. data/ext/inkcpp_rb/inkcpp/notes/WhitespaceNotes.md +28 -0
  195. data/ext/inkcpp_rb/inkcpp/proofing/README.md +3 -0
  196. data/ext/inkcpp_rb/inkcpp/proofing/inkcpp_runtime_driver +12 -0
  197. data/ext/inkcpp_rb/inkcpp/pyproject.toml +63 -0
  198. data/ext/inkcpp_rb/inkcpp/setup.py +166 -0
  199. data/ext/inkcpp_rb/inkcpp/shared/CMakeLists.txt +14 -0
  200. data/ext/inkcpp_rb/inkcpp/shared/private/command.h +172 -0
  201. data/ext/inkcpp_rb/inkcpp/shared/private/header.h +46 -0
  202. data/ext/inkcpp_rb/inkcpp/shared/public/config.h +53 -0
  203. data/ext/inkcpp_rb/inkcpp/shared/public/system.h +307 -0
  204. data/ext/inkcpp_rb/inkcpp/shared/public/version.h +14 -0
  205. data/ext/inkcpp_rb/inkcpp/tests/TestAllSequenceTypes.ink +59 -0
  206. data/ext/inkcpp_rb/inkcpp/tests/TestArithmetic.ink +17 -0
  207. data/ext/inkcpp_rb/inkcpp/tests/TestBasicStringLiterals.ink +8 -0
  208. data/ext/inkcpp_rb/inkcpp/tests/TestBasicTunnel.ink +10 -0
  209. data/ext/inkcpp_rb/inkcpp/tests/TestBlanksInInlineSequences.ink +51 -0
  210. data/ext/inkcpp_rb/inkcpp/tests/TestCallStackEvaluation.ink +15 -0
  211. data/ext/inkcpp_rb/inkcpp/tests/TestChoiceCount.ink +15 -0
  212. data/ext/inkcpp_rb/inkcpp/tests/TestChoiceDivertsToDone.ink +6 -0
  213. data/ext/inkcpp_rb/inkcpp/tests/TestChoiceWithBracketsOnly.ink +9 -0
  214. data/ext/inkcpp_rb/inkcpp/tests/TestCompareDivertTargets.ink +26 -0
  215. data/ext/inkcpp_rb/inkcpp/tests/TestComplexTunnels.ink +22 -0
  216. data/ext/inkcpp_rb/inkcpp/tests/TestConditionalChoiceInWeave.ink +19 -0
  217. data/ext/inkcpp_rb/inkcpp/tests/TestTunnelOnwardsAfterTunnel.ink +17 -0
  218. data/ext/inkcpp_rb/inkcpp/unreal/CMakeLists.txt +51 -0
  219. data/ext/inkcpp_rb/inkcpp/unreal/UE_example.ink +92 -0
  220. data/ext/inkcpp_rb/inkcpp/unreal/blueprint_filter.js +377 -0
  221. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Resources/Icon128.png +0 -0
  222. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Private/InkAsset.cpp +47 -0
  223. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Private/InkChoice.cpp +40 -0
  224. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Private/InkList.cpp +86 -0
  225. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Private/InkRuntime.cpp +265 -0
  226. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Private/InkThread.cpp +239 -0
  227. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Private/InkVar.cpp +143 -0
  228. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Private/TagList.cpp +95 -0
  229. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Private/inkcpp.cpp +13 -0
  230. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Public/InkAsset.h +50 -0
  231. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Public/InkChoice.h +58 -0
  232. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Public/InkDelegates.h +139 -0
  233. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Public/InkList.h +102 -0
  234. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Public/InkRuntime.h +177 -0
  235. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Public/InkSnapshot.h +30 -0
  236. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Public/InkThread.h +215 -0
  237. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Public/InkVar.h +245 -0
  238. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Public/TagList.h +77 -0
  239. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/Public/inkcpp.h +217 -0
  240. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp/inkcpp.Build.cs +62 -0
  241. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp_editor/Private/InkAssetFactory.cpp +237 -0
  242. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp_editor/Private/InkAssetFactory.h +43 -0
  243. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp_editor/Private/inkcpp_editor.cpp +13 -0
  244. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp_editor/Private/inklecate_cmd.cpp.in +24 -0
  245. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp_editor/Public/inkcpp_editor.h +9 -0
  246. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/Source/inkcpp_editor/inkcpp_editor.Build.cs +61 -0
  247. data/ext/inkcpp_rb/inkcpp/unreal/inkcpp/inkcpp.uplugin +44 -0
  248. data/ext/inkcpp_rb/inkcpp/unreal/render.css +1 -0
  249. data/ext/inkcpp_rb/inkcpp_rb.cpp +321 -0
  250. data/inkcpp_rb.gemspec +54 -0
  251. data/rbi/inkcpp_rb.rbi +211 -0
  252. data/sorbet/config +4 -0
  253. data/sorbet/rbi/annotations/.gitattributes +1 -0
  254. data/sorbet/rbi/annotations/minitest.rbi +119 -0
  255. data/sorbet/rbi/gems/.gitattributes +1 -0
  256. data/sorbet/rbi/gems/benchmark@0.4.0.rbi +618 -0
  257. data/sorbet/rbi/gems/erubi@1.13.1.rbi +155 -0
  258. data/sorbet/rbi/gems/minitest@5.25.4.rbi +1547 -0
  259. data/sorbet/rbi/gems/netrc@0.11.0.rbi +159 -0
  260. data/sorbet/rbi/gems/parallel@1.26.3.rbi +291 -0
  261. data/sorbet/rbi/gems/prism@1.3.0.rbi +40040 -0
  262. data/sorbet/rbi/gems/rake-compiler@1.2.8.rbi +9 -0
  263. data/sorbet/rbi/gems/rake@13.2.1.rbi +3033 -0
  264. data/sorbet/rbi/gems/rbi@0.2.2.rbi +4527 -0
  265. data/sorbet/rbi/gems/rice@4.3.3.rbi +44 -0
  266. data/sorbet/rbi/gems/spoom@1.5.0.rbi +4932 -0
  267. data/sorbet/rbi/gems/tapioca@0.16.7.rbi +3611 -0
  268. data/sorbet/rbi/gems/thor@1.3.2.rbi +4378 -0
  269. data/sorbet/rbi/gems/yard-sorbet@0.9.0.rbi +435 -0
  270. data/sorbet/rbi/gems/yard@0.9.37.rbi +18379 -0
  271. data/sorbet/tapioca/config.yml +13 -0
  272. data/sorbet/tapioca/require.rb +4 -0
  273. metadata +400 -0
@@ -0,0 +1,2825 @@
1
+ # Doxyfile 1.9.8
2
+
3
+ # This file describes the settings to be used by the documentation system
4
+ # doxygen (www.doxygen.org) for a project.
5
+ #
6
+ # All text after a double hash (##) is considered a comment and is placed in
7
+ # front of the TAG it is preceding.
8
+ #
9
+ # All text after a single hash (#) is considered a comment and will be ignored.
10
+ # The format is:
11
+ # TAG = value [value, ...]
12
+ # For lists, items can also be appended using:
13
+ # TAG += value [value, ...]
14
+ # Values that contain spaces should be placed between quotes (\" \").
15
+ #
16
+ # 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 = inkcpp
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 = Documentation
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 punctuation 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 = NO
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 = YES
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 = NO
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 = NO
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 = NO
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 = NO
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 = YES
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 = YES
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 = inkcpp/include \
947
+ shared/public \
948
+ inkcpp_compiler/include \
949
+ unreal/inkcpp/Source/inkcpp/Public \
950
+ inkcpp_c/include
951
+
952
+ # This tag can be used to specify the character encoding of the source files
953
+ # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
954
+ # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
955
+ # documentation (see:
956
+ # https://www.gnu.org/software/libiconv/) for the list of possible encodings.
957
+ # See also: INPUT_FILE_ENCODING
958
+ # The default value is: UTF-8.
959
+
960
+ INPUT_ENCODING = UTF-8
961
+
962
+ # This tag can be used to specify the character encoding of the source files
963
+ # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
964
+ # character encoding on a per file pattern basis. Doxygen will compare the file
965
+ # name with each pattern and apply the encoding instead of the default
966
+ # INPUT_ENCODING) if there is a match. The character encodings are a list of the
967
+ # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
968
+ # "INPUT_ENCODING" for further information on supported encodings.
969
+
970
+ INPUT_FILE_ENCODING =
971
+
972
+ # If the value of the INPUT tag contains directories, you can use the
973
+ # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
974
+ # *.h) to filter out the source-files in the directories.
975
+ #
976
+ # Note that for custom extensions or not directly supported extensions you also
977
+ # need to set EXTENSION_MAPPING for the extension otherwise the files are not
978
+ # read by doxygen.
979
+ #
980
+ # Note the list of default checked file patterns might differ from the list of
981
+ # default file extension mappings.
982
+ #
983
+ # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
984
+ # *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl,
985
+ # *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php,
986
+ # *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be
987
+ # provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
988
+ # *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
989
+
990
+ FILE_PATTERNS = *.c \
991
+ *.cc \
992
+ *.cxx \
993
+ *.cpp \
994
+ *.c++ \
995
+ *.java \
996
+ *.ii \
997
+ *.ixx \
998
+ *.ipp \
999
+ *.i++ \
1000
+ *.inl \
1001
+ *.idl \
1002
+ *.ddl \
1003
+ *.odl \
1004
+ *.h \
1005
+ *.hh \
1006
+ *.hxx \
1007
+ *.hpp \
1008
+ *.h++ \
1009
+ *.cs \
1010
+ *.d \
1011
+ *.php \
1012
+ *.php4 \
1013
+ *.php5 \
1014
+ *.phtml \
1015
+ *.inc \
1016
+ *.m \
1017
+ *.markdown \
1018
+ *.md \
1019
+ *.mm \
1020
+ *.dox \
1021
+ *.py \
1022
+ *.pyw \
1023
+ *.f90 \
1024
+ *.f95 \
1025
+ *.f03 \
1026
+ *.f08 \
1027
+ *.f \
1028
+ *.for \
1029
+ *.tcl \
1030
+ *.vhd \
1031
+ *.vhdl \
1032
+ *.ucf \
1033
+ *.qsf \
1034
+ *.ice
1035
+
1036
+ # The RECURSIVE tag can be used to specify whether or not subdirectories should
1037
+ # be searched for input files as well.
1038
+ # The default value is: NO.
1039
+
1040
+ RECURSIVE = NO
1041
+
1042
+ # The EXCLUDE tag can be used to specify files and/or directories that should be
1043
+ # excluded from the INPUT source files. This way you can easily exclude a
1044
+ # subdirectory from a directory tree whose root is specified with the INPUT tag.
1045
+ #
1046
+ # Note that relative paths are relative to the directory from which doxygen is
1047
+ # run.
1048
+
1049
+ EXCLUDE =
1050
+
1051
+ # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1052
+ # directories that are symbolic links (a Unix file system feature) are excluded
1053
+ # from the input.
1054
+ # The default value is: NO.
1055
+
1056
+ EXCLUDE_SYMLINKS = NO
1057
+
1058
+ # If the value of the INPUT tag contains directories, you can use the
1059
+ # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1060
+ # certain files from those directories.
1061
+ #
1062
+ # Note that the wildcards are matched against the file with absolute path, so to
1063
+ # exclude all test directories for example use the pattern */test/*
1064
+
1065
+ EXCLUDE_PATTERNS =
1066
+
1067
+ # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1068
+ # (namespaces, classes, functions, etc.) that should be excluded from the
1069
+ # output. The symbol name can be a fully qualified name, a word, or if the
1070
+ # wildcard * is used, a substring. Examples: ANamespace, AClass,
1071
+ # ANamespace::AClass, ANamespace::*Test
1072
+
1073
+ EXCLUDE_SYMBOLS = ink::list_flag ink::runtime::internal* ink::internal*
1074
+
1075
+ # The EXAMPLE_PATH tag can be used to specify one or more files or directories
1076
+ # that contain example code fragments that are included (see the \include
1077
+ # command).
1078
+
1079
+ EXAMPLE_PATH = Documentation
1080
+
1081
+ # If the value of the EXAMPLE_PATH tag contains directories, you can use the
1082
+ # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1083
+ # *.h) to filter out the source-files in the directories. If left blank all
1084
+ # files are included.
1085
+
1086
+ EXAMPLE_PATTERNS = *
1087
+
1088
+ # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1089
+ # searched for input files to be used with the \include or \dontinclude commands
1090
+ # irrespective of the value of the RECURSIVE tag.
1091
+ # The default value is: NO.
1092
+
1093
+ EXAMPLE_RECURSIVE = NO
1094
+
1095
+ # The IMAGE_PATH tag can be used to specify one or more files or directories
1096
+ # that contain images that are to be included in the documentation (see the
1097
+ # \image command).
1098
+
1099
+ IMAGE_PATH =
1100
+
1101
+ # The INPUT_FILTER tag can be used to specify a program that doxygen should
1102
+ # invoke to filter for each input file. Doxygen will invoke the filter program
1103
+ # by executing (via popen()) the command:
1104
+ #
1105
+ # <filter> <input-file>
1106
+ #
1107
+ # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1108
+ # name of an input file. Doxygen will then use the output that the filter
1109
+ # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1110
+ # will be ignored.
1111
+ #
1112
+ # Note that the filter must not add or remove lines; it is applied before the
1113
+ # code is scanned, but not when the output code is generated. If lines are added
1114
+ # or removed, the anchors will not be placed correctly.
1115
+ #
1116
+ # Note that doxygen will use the data processed and written to standard output
1117
+ # for further processing, therefore nothing else, like debug statements or used
1118
+ # commands (so in case of a Windows batch file always use @echo OFF), should be
1119
+ # written to standard output.
1120
+ #
1121
+ # Note that for custom extensions or not directly supported extensions you also
1122
+ # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1123
+ # properly processed by doxygen.
1124
+
1125
+ INPUT_FILTER =
1126
+
1127
+ # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1128
+ # basis. Doxygen will compare the file name with each pattern and apply the
1129
+ # filter if there is a match. The filters are a list of the form: pattern=filter
1130
+ # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1131
+ # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1132
+ # patterns match the file name, INPUT_FILTER is applied.
1133
+ #
1134
+ # Note that for custom extensions or not directly supported extensions you also
1135
+ # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1136
+ # properly processed by doxygen.
1137
+
1138
+ FILTER_PATTERNS =
1139
+
1140
+ # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1141
+ # INPUT_FILTER) will also be used to filter the input files that are used for
1142
+ # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1143
+ # The default value is: NO.
1144
+
1145
+ FILTER_SOURCE_FILES = NO
1146
+
1147
+ # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1148
+ # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1149
+ # it is also possible to disable source filtering for a specific pattern using
1150
+ # *.ext= (so without naming a filter).
1151
+ # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1152
+
1153
+ FILTER_SOURCE_PATTERNS =
1154
+
1155
+ # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1156
+ # is part of the input, its contents will be placed on the main page
1157
+ # (index.html). This can be useful if you have a project on for instance GitHub
1158
+ # and want to reuse the introduction page also for the doxygen output.
1159
+
1160
+ USE_MDFILE_AS_MAINPAGE =
1161
+
1162
+ # The Fortran standard specifies that for fixed formatted Fortran code all
1163
+ # characters from position 72 are to be considered as comment. A common
1164
+ # extension is to allow longer lines before the automatic comment starts. The
1165
+ # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1166
+ # be processed before the automatic comment starts.
1167
+ # Minimum value: 7, maximum value: 10000, default value: 72.
1168
+
1169
+ FORTRAN_COMMENT_AFTER = 72
1170
+
1171
+ #---------------------------------------------------------------------------
1172
+ # Configuration options related to source browsing
1173
+ #---------------------------------------------------------------------------
1174
+
1175
+ # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1176
+ # generated. Documented entities will be cross-referenced with these sources.
1177
+ #
1178
+ # Note: To get rid of all source code in the generated output, make sure that
1179
+ # also VERBATIM_HEADERS is set to NO.
1180
+ # The default value is: NO.
1181
+
1182
+ SOURCE_BROWSER = NO
1183
+
1184
+ # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1185
+ # classes and enums directly into the documentation.
1186
+ # The default value is: NO.
1187
+
1188
+ INLINE_SOURCES = NO
1189
+
1190
+ # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1191
+ # special comment blocks from generated source code fragments. Normal C, C++ and
1192
+ # Fortran comments will always remain visible.
1193
+ # The default value is: YES.
1194
+
1195
+ STRIP_CODE_COMMENTS = YES
1196
+
1197
+ # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1198
+ # entity all documented functions referencing it will be listed.
1199
+ # The default value is: NO.
1200
+
1201
+ REFERENCED_BY_RELATION = NO
1202
+
1203
+ # If the REFERENCES_RELATION tag is set to YES then for each documented function
1204
+ # all documented entities called/used by that function will be listed.
1205
+ # The default value is: NO.
1206
+
1207
+ REFERENCES_RELATION = NO
1208
+
1209
+ # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1210
+ # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1211
+ # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1212
+ # link to the documentation.
1213
+ # The default value is: YES.
1214
+
1215
+ REFERENCES_LINK_SOURCE = YES
1216
+
1217
+ # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1218
+ # source code will show a tooltip with additional information such as prototype,
1219
+ # brief description and links to the definition and documentation. Since this
1220
+ # will make the HTML file larger and loading of large files a bit slower, you
1221
+ # can opt to disable this feature.
1222
+ # The default value is: YES.
1223
+ # This tag requires that the tag SOURCE_BROWSER is set to YES.
1224
+
1225
+ SOURCE_TOOLTIPS = YES
1226
+
1227
+ # If the USE_HTAGS tag is set to YES then the references to source code will
1228
+ # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1229
+ # source browser. The htags tool is part of GNU's global source tagging system
1230
+ # (see https://www.gnu.org/software/global/global.html). You will need version
1231
+ # 4.8.6 or higher.
1232
+ #
1233
+ # To use it do the following:
1234
+ # - Install the latest version of global
1235
+ # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1236
+ # - Make sure the INPUT points to the root of the source tree
1237
+ # - Run doxygen as normal
1238
+ #
1239
+ # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1240
+ # tools must be available from the command line (i.e. in the search path).
1241
+ #
1242
+ # The result: instead of the source browser generated by doxygen, the links to
1243
+ # source code will now point to the output of htags.
1244
+ # The default value is: NO.
1245
+ # This tag requires that the tag SOURCE_BROWSER is set to YES.
1246
+
1247
+ USE_HTAGS = NO
1248
+
1249
+ # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1250
+ # verbatim copy of the header file for each class for which an include is
1251
+ # specified. Set to NO to disable this.
1252
+ # See also: Section \class.
1253
+ # The default value is: YES.
1254
+
1255
+ VERBATIM_HEADERS = YES
1256
+
1257
+ #---------------------------------------------------------------------------
1258
+ # Configuration options related to the alphabetical class index
1259
+ #---------------------------------------------------------------------------
1260
+
1261
+ # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1262
+ # compounds will be generated. Enable this if the project contains a lot of
1263
+ # classes, structs, unions or interfaces.
1264
+ # The default value is: YES.
1265
+
1266
+ ALPHABETICAL_INDEX = YES
1267
+
1268
+ # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1269
+ # that should be ignored while generating the index headers. The IGNORE_PREFIX
1270
+ # tag works for classes, function and member names. The entity will be placed in
1271
+ # the alphabetical list under the first letter of the entity name that remains
1272
+ # after removing the prefix.
1273
+ # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1274
+
1275
+ IGNORE_PREFIX =
1276
+
1277
+ #---------------------------------------------------------------------------
1278
+ # Configuration options related to the HTML output
1279
+ #---------------------------------------------------------------------------
1280
+
1281
+ # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1282
+ # The default value is: YES.
1283
+
1284
+ GENERATE_HTML = YES
1285
+
1286
+ # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1287
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1288
+ # it.
1289
+ # The default directory is: html.
1290
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1291
+
1292
+ HTML_OUTPUT = html
1293
+
1294
+ # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1295
+ # generated HTML page (for example: .htm, .php, .asp).
1296
+ # The default value is: .html.
1297
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1298
+
1299
+ HTML_FILE_EXTENSION = .html
1300
+
1301
+ # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1302
+ # each generated HTML page. If the tag is left blank doxygen will generate a
1303
+ # standard header.
1304
+ #
1305
+ # To get valid HTML the header file that includes any scripts and style sheets
1306
+ # that doxygen needs, which is dependent on the configuration options used (e.g.
1307
+ # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1308
+ # default header using
1309
+ # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1310
+ # YourConfigFile
1311
+ # and then modify the file new_header.html. See also section "Doxygen usage"
1312
+ # for information on how to generate the default header that doxygen normally
1313
+ # uses.
1314
+ # Note: The header is subject to change so you typically have to regenerate the
1315
+ # default header when upgrading to a newer version of doxygen. For a description
1316
+ # of the possible markers and block names see the documentation.
1317
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1318
+
1319
+ HTML_HEADER =
1320
+
1321
+ # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1322
+ # generated HTML page. If the tag is left blank doxygen will generate a standard
1323
+ # footer. See HTML_HEADER for more information on how to generate a default
1324
+ # footer and what special commands can be used inside the footer. See also
1325
+ # section "Doxygen usage" for information on how to generate the default footer
1326
+ # that doxygen normally uses.
1327
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1328
+
1329
+ HTML_FOOTER =
1330
+
1331
+ # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1332
+ # sheet that is used by each HTML page. It can be used to fine-tune the look of
1333
+ # the HTML output. If left blank doxygen will generate a default style sheet.
1334
+ # See also section "Doxygen usage" for information on how to generate the style
1335
+ # sheet that doxygen normally uses.
1336
+ # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1337
+ # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1338
+ # obsolete.
1339
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1340
+
1341
+ HTML_STYLESHEET =
1342
+
1343
+ # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1344
+ # cascading style sheets that are included after the standard style sheets
1345
+ # created by doxygen. Using this option one can overrule certain style aspects.
1346
+ # This is preferred over using HTML_STYLESHEET since it does not replace the
1347
+ # standard style sheet and is therefore more robust against future updates.
1348
+ # Doxygen will copy the style sheet files to the output directory.
1349
+ # Note: The order of the extra style sheet files is of importance (e.g. the last
1350
+ # style sheet in the list overrules the setting of the previous ones in the
1351
+ # list).
1352
+ # Note: Since the styling of scrollbars can currently not be overruled in
1353
+ # Webkit/Chromium, the styling will be left out of the default doxygen.css if
1354
+ # one or more extra stylesheets have been specified. So if scrollbar
1355
+ # customization is desired it has to be added explicitly. For an example see the
1356
+ # documentation.
1357
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1358
+
1359
+ HTML_EXTRA_STYLESHEET =
1360
+
1361
+ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1362
+ # other source files which should be copied to the HTML output directory. Note
1363
+ # that these files will be copied to the base HTML output directory. Use the
1364
+ # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1365
+ # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1366
+ # files will be copied as-is; there are no commands or markers available.
1367
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1368
+
1369
+ HTML_EXTRA_FILES = Documentation/inkcpp_py.html
1370
+
1371
+ # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1372
+ # should be rendered with a dark or light theme.
1373
+ # Possible values are: LIGHT always generate light mode output, DARK always
1374
+ # generate dark mode output, AUTO_LIGHT automatically set the mode according to
1375
+ # the user preference, use light mode if no preference is set (the default),
1376
+ # AUTO_DARK automatically set the mode according to the user preference, use
1377
+ # dark mode if no preference is set and TOGGLE allow to user to switch between
1378
+ # light and dark mode via a button.
1379
+ # The default value is: AUTO_LIGHT.
1380
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1381
+
1382
+ HTML_COLORSTYLE = AUTO_LIGHT
1383
+
1384
+ # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1385
+ # will adjust the colors in the style sheet and background images according to
1386
+ # this color. Hue is specified as an angle on a color-wheel, see
1387
+ # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1388
+ # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1389
+ # purple, and 360 is red again.
1390
+ # Minimum value: 0, maximum value: 359, default value: 220.
1391
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1392
+
1393
+ HTML_COLORSTYLE_HUE = 220
1394
+
1395
+ # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1396
+ # in the HTML output. For a value of 0 the output will use gray-scales only. A
1397
+ # value of 255 will produce the most vivid colors.
1398
+ # Minimum value: 0, maximum value: 255, default value: 100.
1399
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1400
+
1401
+ HTML_COLORSTYLE_SAT = 100
1402
+
1403
+ # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1404
+ # luminance component of the colors in the HTML output. Values below 100
1405
+ # gradually make the output lighter, whereas values above 100 make the output
1406
+ # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1407
+ # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1408
+ # change the gamma.
1409
+ # Minimum value: 40, maximum value: 240, default value: 80.
1410
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1411
+
1412
+ HTML_COLORSTYLE_GAMMA = 80
1413
+
1414
+ # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1415
+ # documentation will contain a main index with vertical navigation menus that
1416
+ # are dynamically created via JavaScript. If disabled, the navigation index will
1417
+ # consists of multiple levels of tabs that are statically embedded in every HTML
1418
+ # page. Disable this option to support browsers that do not have JavaScript,
1419
+ # like the Qt help browser.
1420
+ # The default value is: YES.
1421
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1422
+
1423
+ HTML_DYNAMIC_MENUS = YES
1424
+
1425
+ # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1426
+ # documentation will contain sections that can be hidden and shown after the
1427
+ # page has loaded.
1428
+ # The default value is: NO.
1429
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1430
+
1431
+ HTML_DYNAMIC_SECTIONS = NO
1432
+
1433
+ # If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
1434
+ # dynamically folded and expanded in the generated HTML source code.
1435
+ # The default value is: YES.
1436
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1437
+
1438
+ HTML_CODE_FOLDING = YES
1439
+
1440
+ # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1441
+ # shown in the various tree structured indices initially; the user can expand
1442
+ # and collapse entries dynamically later on. Doxygen will expand the tree to
1443
+ # such a level that at most the specified number of entries are visible (unless
1444
+ # a fully collapsed tree already exceeds this amount). So setting the number of
1445
+ # entries 1 will produce a full collapsed tree by default. 0 is a special value
1446
+ # representing an infinite number of entries and will result in a full expanded
1447
+ # tree by default.
1448
+ # Minimum value: 0, maximum value: 9999, default value: 100.
1449
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1450
+
1451
+ HTML_INDEX_NUM_ENTRIES = 32
1452
+
1453
+ # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1454
+ # generated that can be used as input for Apple's Xcode 3 integrated development
1455
+ # environment (see:
1456
+ # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1457
+ # create a documentation set, doxygen will generate a Makefile in the HTML
1458
+ # output directory. Running make will produce the docset in that directory and
1459
+ # running make install will install the docset in
1460
+ # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1461
+ # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1462
+ # genXcode/_index.html for more information.
1463
+ # The default value is: NO.
1464
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1465
+
1466
+ GENERATE_DOCSET = NO
1467
+
1468
+ # This tag determines the name of the docset feed. A documentation feed provides
1469
+ # an umbrella under which multiple documentation sets from a single provider
1470
+ # (such as a company or product suite) can be grouped.
1471
+ # The default value is: Doxygen generated docs.
1472
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1473
+
1474
+ DOCSET_FEEDNAME = "Doxygen generated docs"
1475
+
1476
+ # This tag determines the URL of the docset feed. A documentation feed provides
1477
+ # an umbrella under which multiple documentation sets from a single provider
1478
+ # (such as a company or product suite) can be grouped.
1479
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1480
+
1481
+ DOCSET_FEEDURL =
1482
+
1483
+ # This tag specifies a string that should uniquely identify the documentation
1484
+ # set bundle. This should be a reverse domain-name style string, e.g.
1485
+ # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1486
+ # The default value is: org.doxygen.Project.
1487
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1488
+
1489
+ DOCSET_BUNDLE_ID = org.doxygen.Project
1490
+
1491
+ # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1492
+ # the documentation publisher. This should be a reverse domain-name style
1493
+ # string, e.g. com.mycompany.MyDocSet.documentation.
1494
+ # The default value is: org.doxygen.Publisher.
1495
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1496
+
1497
+ DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1498
+
1499
+ # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1500
+ # The default value is: Publisher.
1501
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1502
+
1503
+ DOCSET_PUBLISHER_NAME = Publisher
1504
+
1505
+ # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1506
+ # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1507
+ # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1508
+ # on Windows. In the beginning of 2021 Microsoft took the original page, with
1509
+ # a.o. the download links, offline the HTML help workshop was already many years
1510
+ # in maintenance mode). You can download the HTML help workshop from the web
1511
+ # archives at Installation executable (see:
1512
+ # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
1513
+ # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1514
+ #
1515
+ # The HTML Help Workshop contains a compiler that can convert all HTML output
1516
+ # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1517
+ # files are now used as the Windows 98 help format, and will replace the old
1518
+ # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1519
+ # HTML files also contain an index, a table of contents, and you can search for
1520
+ # words in the documentation. The HTML workshop also contains a viewer for
1521
+ # compressed HTML files.
1522
+ # The default value is: NO.
1523
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1524
+
1525
+ GENERATE_HTMLHELP = NO
1526
+
1527
+ # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1528
+ # file. You can add a path in front of the file if the result should not be
1529
+ # written to the html output directory.
1530
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1531
+
1532
+ CHM_FILE =
1533
+
1534
+ # The HHC_LOCATION tag can be used to specify the location (absolute path
1535
+ # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1536
+ # doxygen will try to run the HTML help compiler on the generated index.hhp.
1537
+ # The file has to be specified with full path.
1538
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1539
+
1540
+ HHC_LOCATION =
1541
+
1542
+ # The GENERATE_CHI flag controls if a separate .chi index file is generated
1543
+ # (YES) or that it should be included in the main .chm file (NO).
1544
+ # The default value is: NO.
1545
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1546
+
1547
+ GENERATE_CHI = NO
1548
+
1549
+ # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1550
+ # and project file content.
1551
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1552
+
1553
+ CHM_INDEX_ENCODING =
1554
+
1555
+ # The BINARY_TOC flag controls whether a binary table of contents is generated
1556
+ # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1557
+ # enables the Previous and Next buttons.
1558
+ # The default value is: NO.
1559
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1560
+
1561
+ BINARY_TOC = NO
1562
+
1563
+ # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1564
+ # the table of contents of the HTML help documentation and to the tree view.
1565
+ # The default value is: NO.
1566
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1567
+
1568
+ TOC_EXPAND = NO
1569
+
1570
+ # The SITEMAP_URL tag is used to specify the full URL of the place where the
1571
+ # generated documentation will be placed on the server by the user during the
1572
+ # deployment of the documentation. The generated sitemap is called sitemap.xml
1573
+ # and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
1574
+ # is specified no sitemap is generated. For information about the sitemap
1575
+ # protocol see https://www.sitemaps.org
1576
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1577
+
1578
+ SITEMAP_URL =
1579
+
1580
+ # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1581
+ # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1582
+ # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1583
+ # (.qch) of the generated HTML documentation.
1584
+ # The default value is: NO.
1585
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1586
+
1587
+ GENERATE_QHP = NO
1588
+
1589
+ # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1590
+ # the file name of the resulting .qch file. The path specified is relative to
1591
+ # the HTML output folder.
1592
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1593
+
1594
+ QCH_FILE =
1595
+
1596
+ # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1597
+ # Project output. For more information please see Qt Help Project / Namespace
1598
+ # (see:
1599
+ # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1600
+ # The default value is: org.doxygen.Project.
1601
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1602
+
1603
+ QHP_NAMESPACE = org.doxygen.Project
1604
+
1605
+ # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1606
+ # Help Project output. For more information please see Qt Help Project / Virtual
1607
+ # Folders (see:
1608
+ # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1609
+ # The default value is: doc.
1610
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1611
+
1612
+ QHP_VIRTUAL_FOLDER = doc
1613
+
1614
+ # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1615
+ # filter to add. For more information please see Qt Help Project / Custom
1616
+ # Filters (see:
1617
+ # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1618
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1619
+
1620
+ QHP_CUST_FILTER_NAME =
1621
+
1622
+ # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1623
+ # custom filter to add. For more information please see Qt Help Project / Custom
1624
+ # Filters (see:
1625
+ # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1626
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1627
+
1628
+ QHP_CUST_FILTER_ATTRS =
1629
+
1630
+ # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1631
+ # project's filter section matches. Qt Help Project / Filter Attributes (see:
1632
+ # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1633
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1634
+
1635
+ QHP_SECT_FILTER_ATTRS =
1636
+
1637
+ # The QHG_LOCATION tag can be used to specify the location (absolute path
1638
+ # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1639
+ # run qhelpgenerator on the generated .qhp file.
1640
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1641
+
1642
+ QHG_LOCATION =
1643
+
1644
+ # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1645
+ # generated, together with the HTML files, they form an Eclipse help plugin. To
1646
+ # install this plugin and make it available under the help contents menu in
1647
+ # Eclipse, the contents of the directory containing the HTML and XML files needs
1648
+ # to be copied into the plugins directory of eclipse. The name of the directory
1649
+ # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1650
+ # After copying Eclipse needs to be restarted before the help appears.
1651
+ # The default value is: NO.
1652
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1653
+
1654
+ GENERATE_ECLIPSEHELP = NO
1655
+
1656
+ # A unique identifier for the Eclipse help plugin. When installing the plugin
1657
+ # the directory name containing the HTML and XML files should also have this
1658
+ # name. Each documentation set should have its own identifier.
1659
+ # The default value is: org.doxygen.Project.
1660
+ # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1661
+
1662
+ ECLIPSE_DOC_ID = org.doxygen.Project
1663
+
1664
+ # If you want full control over the layout of the generated HTML pages it might
1665
+ # be necessary to disable the index and replace it with your own. The
1666
+ # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1667
+ # of each HTML page. A value of NO enables the index and the value YES disables
1668
+ # it. Since the tabs in the index contain the same information as the navigation
1669
+ # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1670
+ # The default value is: NO.
1671
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1672
+
1673
+ DISABLE_INDEX = NO
1674
+
1675
+ # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1676
+ # structure should be generated to display hierarchical information. If the tag
1677
+ # value is set to YES, a side panel will be generated containing a tree-like
1678
+ # index structure (just like the one that is generated for HTML Help). For this
1679
+ # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1680
+ # (i.e. any modern browser). Windows users are probably better off using the
1681
+ # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1682
+ # further fine tune the look of the index (see "Fine-tuning the output"). As an
1683
+ # example, the default style sheet generated by doxygen has an example that
1684
+ # shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1685
+ # Since the tree basically has the same information as the tab index, you could
1686
+ # consider setting DISABLE_INDEX to YES when enabling this option.
1687
+ # The default value is: NO.
1688
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1689
+
1690
+ GENERATE_TREEVIEW = YES
1691
+
1692
+ # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
1693
+ # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1694
+ # area (value NO) or if it should extend to the full height of the window (value
1695
+ # YES). Setting this to YES gives a layout similar to
1696
+ # https://docs.readthedocs.io with more room for contents, but less room for the
1697
+ # project logo, title, and description. If either GENERATE_TREEVIEW or
1698
+ # DISABLE_INDEX is set to NO, this option has no effect.
1699
+ # The default value is: NO.
1700
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1701
+
1702
+ FULL_SIDEBAR = NO
1703
+
1704
+ # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1705
+ # doxygen will group on one line in the generated HTML documentation.
1706
+ #
1707
+ # Note that a value of 0 will completely suppress the enum values from appearing
1708
+ # in the overview section.
1709
+ # Minimum value: 0, maximum value: 20, default value: 4.
1710
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1711
+
1712
+ ENUM_VALUES_PER_LINE = 4
1713
+
1714
+ # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1715
+ # to set the initial width (in pixels) of the frame in which the tree is shown.
1716
+ # Minimum value: 0, maximum value: 1500, default value: 250.
1717
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1718
+
1719
+ TREEVIEW_WIDTH = 250
1720
+
1721
+ # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1722
+ # external symbols imported via tag files in a separate window.
1723
+ # The default value is: NO.
1724
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1725
+
1726
+ EXT_LINKS_IN_WINDOW = NO
1727
+
1728
+ # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1729
+ # addresses.
1730
+ # The default value is: YES.
1731
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1732
+
1733
+ OBFUSCATE_EMAILS = YES
1734
+
1735
+ # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1736
+ # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1737
+ # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1738
+ # the HTML output. These images will generally look nicer at scaled resolutions.
1739
+ # Possible values are: png (the default) and svg (looks nicer but requires the
1740
+ # pdf2svg or inkscape tool).
1741
+ # The default value is: png.
1742
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1743
+
1744
+ HTML_FORMULA_FORMAT = png
1745
+
1746
+ # Use this tag to change the font size of LaTeX formulas included as images in
1747
+ # the HTML documentation. When you change the font size after a successful
1748
+ # doxygen run you need to manually remove any form_*.png images from the HTML
1749
+ # output directory to force them to be regenerated.
1750
+ # Minimum value: 8, maximum value: 50, default value: 10.
1751
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1752
+
1753
+ FORMULA_FONTSIZE = 10
1754
+
1755
+ # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1756
+ # to create new LaTeX commands to be used in formulas as building blocks. See
1757
+ # the section "Including formulas" for details.
1758
+
1759
+ FORMULA_MACROFILE =
1760
+
1761
+ # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1762
+ # https://www.mathjax.org) which uses client side JavaScript for the rendering
1763
+ # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1764
+ # installed or if you want to formulas look prettier in the HTML output. When
1765
+ # enabled you may also need to install MathJax separately and configure the path
1766
+ # to it using the MATHJAX_RELPATH option.
1767
+ # The default value is: NO.
1768
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1769
+
1770
+ USE_MATHJAX = NO
1771
+
1772
+ # With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1773
+ # Note that the different versions of MathJax have different requirements with
1774
+ # regards to the different settings, so it is possible that also other MathJax
1775
+ # settings have to be changed when switching between the different MathJax
1776
+ # versions.
1777
+ # Possible values are: MathJax_2 and MathJax_3.
1778
+ # The default value is: MathJax_2.
1779
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1780
+
1781
+ MATHJAX_VERSION = MathJax_2
1782
+
1783
+ # When MathJax is enabled you can set the default output format to be used for
1784
+ # the MathJax output. For more details about the output format see MathJax
1785
+ # version 2 (see:
1786
+ # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1787
+ # (see:
1788
+ # http://docs.mathjax.org/en/latest/web/components/output.html).
1789
+ # Possible values are: HTML-CSS (which is slower, but has the best
1790
+ # compatibility. This is the name for Mathjax version 2, for MathJax version 3
1791
+ # this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1792
+ # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1793
+ # is the name for Mathjax version 3, for MathJax version 2 this will be
1794
+ # translated into HTML-CSS) and SVG.
1795
+ # The default value is: HTML-CSS.
1796
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1797
+
1798
+ MATHJAX_FORMAT = HTML-CSS
1799
+
1800
+ # When MathJax is enabled you need to specify the location relative to the HTML
1801
+ # output directory using the MATHJAX_RELPATH option. The destination directory
1802
+ # should contain the MathJax.js script. For instance, if the mathjax directory
1803
+ # is located at the same level as the HTML output directory, then
1804
+ # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1805
+ # Content Delivery Network so you can quickly see the result without installing
1806
+ # MathJax. However, it is strongly recommended to install a local copy of
1807
+ # MathJax from https://www.mathjax.org before deployment. The default value is:
1808
+ # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1809
+ # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1810
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1811
+
1812
+ MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
1813
+
1814
+ # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1815
+ # extension names that should be enabled during MathJax rendering. For example
1816
+ # for MathJax version 2 (see
1817
+ # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1818
+ # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1819
+ # For example for MathJax version 3 (see
1820
+ # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
1821
+ # MATHJAX_EXTENSIONS = ams
1822
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1823
+
1824
+ MATHJAX_EXTENSIONS =
1825
+
1826
+ # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1827
+ # of code that will be used on startup of the MathJax code. See the MathJax site
1828
+ # (see:
1829
+ # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1830
+ # example see the documentation.
1831
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1832
+
1833
+ MATHJAX_CODEFILE =
1834
+
1835
+ # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1836
+ # the HTML output. The underlying search engine uses javascript and DHTML and
1837
+ # should work on any modern browser. Note that when using HTML help
1838
+ # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1839
+ # there is already a search function so this one should typically be disabled.
1840
+ # For large projects the javascript based search engine can be slow, then
1841
+ # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1842
+ # search using the keyboard; to jump to the search box use <access key> + S
1843
+ # (what the <access key> is depends on the OS and browser, but it is typically
1844
+ # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1845
+ # key> to jump into the search results window, the results can be navigated
1846
+ # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1847
+ # the search. The filter options can be selected when the cursor is inside the
1848
+ # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1849
+ # to select a filter and <Enter> or <escape> to activate or cancel the filter
1850
+ # option.
1851
+ # The default value is: YES.
1852
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1853
+
1854
+ SEARCHENGINE = YES
1855
+
1856
+ # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1857
+ # implemented using a web server instead of a web client using JavaScript. There
1858
+ # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1859
+ # setting. When disabled, doxygen will generate a PHP script for searching and
1860
+ # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1861
+ # and searching needs to be provided by external tools. See the section
1862
+ # "External Indexing and Searching" for details.
1863
+ # The default value is: NO.
1864
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1865
+
1866
+ SERVER_BASED_SEARCH = NO
1867
+
1868
+ # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1869
+ # script for searching. Instead the search results are written to an XML file
1870
+ # which needs to be processed by an external indexer. Doxygen will invoke an
1871
+ # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1872
+ # search results.
1873
+ #
1874
+ # Doxygen ships with an example indexer (doxyindexer) and search engine
1875
+ # (doxysearch.cgi) which are based on the open source search engine library
1876
+ # Xapian (see:
1877
+ # https://xapian.org/).
1878
+ #
1879
+ # See the section "External Indexing and Searching" for details.
1880
+ # The default value is: NO.
1881
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1882
+
1883
+ EXTERNAL_SEARCH = NO
1884
+
1885
+ # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1886
+ # which will return the search results when EXTERNAL_SEARCH is enabled.
1887
+ #
1888
+ # Doxygen ships with an example indexer (doxyindexer) and search engine
1889
+ # (doxysearch.cgi) which are based on the open source search engine library
1890
+ # Xapian (see:
1891
+ # https://xapian.org/). See the section "External Indexing and Searching" for
1892
+ # details.
1893
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1894
+
1895
+ SEARCHENGINE_URL =
1896
+
1897
+ # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1898
+ # search data is written to a file for indexing by an external tool. With the
1899
+ # SEARCHDATA_FILE tag the name of this file can be specified.
1900
+ # The default file is: searchdata.xml.
1901
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1902
+
1903
+ SEARCHDATA_FILE = searchdata.xml
1904
+
1905
+ # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1906
+ # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1907
+ # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1908
+ # projects and redirect the results back to the right project.
1909
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1910
+
1911
+ EXTERNAL_SEARCH_ID =
1912
+
1913
+ # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1914
+ # projects other than the one defined by this configuration file, but that are
1915
+ # all added to the same external search index. Each project needs to have a
1916
+ # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1917
+ # to a relative location where the documentation can be found. The format is:
1918
+ # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1919
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1920
+
1921
+ EXTRA_SEARCH_MAPPINGS =
1922
+
1923
+ #---------------------------------------------------------------------------
1924
+ # Configuration options related to the LaTeX output
1925
+ #---------------------------------------------------------------------------
1926
+
1927
+ # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1928
+ # The default value is: YES.
1929
+
1930
+ GENERATE_LATEX = NO
1931
+
1932
+ # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1933
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1934
+ # it.
1935
+ # The default directory is: latex.
1936
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1937
+
1938
+ LATEX_OUTPUT = latex
1939
+
1940
+ # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1941
+ # invoked.
1942
+ #
1943
+ # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1944
+ # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1945
+ # chosen this is overwritten by pdflatex. For specific output languages the
1946
+ # default can have been set differently, this depends on the implementation of
1947
+ # the output language.
1948
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1949
+
1950
+ LATEX_CMD_NAME =
1951
+
1952
+ # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1953
+ # index for LaTeX.
1954
+ # Note: This tag is used in the Makefile / make.bat.
1955
+ # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1956
+ # (.tex).
1957
+ # The default file is: makeindex.
1958
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1959
+
1960
+ MAKEINDEX_CMD_NAME = makeindex
1961
+
1962
+ # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1963
+ # generate index for LaTeX. In case there is no backslash (\) as first character
1964
+ # it will be automatically added in the LaTeX code.
1965
+ # Note: This tag is used in the generated output file (.tex).
1966
+ # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1967
+ # The default value is: makeindex.
1968
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1969
+
1970
+ LATEX_MAKEINDEX_CMD = makeindex
1971
+
1972
+ # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1973
+ # documents. This may be useful for small projects and may help to save some
1974
+ # trees in general.
1975
+ # The default value is: NO.
1976
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1977
+
1978
+ COMPACT_LATEX = NO
1979
+
1980
+ # The PAPER_TYPE tag can be used to set the paper type that is used by the
1981
+ # printer.
1982
+ # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1983
+ # 14 inches) and executive (7.25 x 10.5 inches).
1984
+ # The default value is: a4.
1985
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1986
+
1987
+ PAPER_TYPE = a4
1988
+
1989
+ # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1990
+ # that should be included in the LaTeX output. The package can be specified just
1991
+ # by its name or with the correct syntax as to be used with the LaTeX
1992
+ # \usepackage command. To get the times font for instance you can specify :
1993
+ # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1994
+ # To use the option intlimits with the amsmath package you can specify:
1995
+ # EXTRA_PACKAGES=[intlimits]{amsmath}
1996
+ # If left blank no extra packages will be included.
1997
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1998
+
1999
+ EXTRA_PACKAGES =
2000
+
2001
+ # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
2002
+ # the generated LaTeX document. The header should contain everything until the
2003
+ # first chapter. If it is left blank doxygen will generate a standard header. It
2004
+ # is highly recommended to start with a default header using
2005
+ # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
2006
+ # and then modify the file new_header.tex. See also section "Doxygen usage" for
2007
+ # information on how to generate the default header that doxygen normally uses.
2008
+ #
2009
+ # Note: Only use a user-defined header if you know what you are doing!
2010
+ # Note: The header is subject to change so you typically have to regenerate the
2011
+ # default header when upgrading to a newer version of doxygen. The following
2012
+ # commands have a special meaning inside the header (and footer): For a
2013
+ # description of the possible markers and block names see the documentation.
2014
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2015
+
2016
+ LATEX_HEADER =
2017
+
2018
+ # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2019
+ # the generated LaTeX document. The footer should contain everything after the
2020
+ # last chapter. If it is left blank doxygen will generate a standard footer. See
2021
+ # LATEX_HEADER for more information on how to generate a default footer and what
2022
+ # special commands can be used inside the footer. See also section "Doxygen
2023
+ # usage" for information on how to generate the default footer that doxygen
2024
+ # normally uses. Note: Only use a user-defined footer if you know what you are
2025
+ # doing!
2026
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2027
+
2028
+ LATEX_FOOTER =
2029
+
2030
+ # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2031
+ # LaTeX style sheets that are included after the standard style sheets created
2032
+ # by doxygen. Using this option one can overrule certain style aspects. Doxygen
2033
+ # will copy the style sheet files to the output directory.
2034
+ # Note: The order of the extra style sheet files is of importance (e.g. the last
2035
+ # style sheet in the list overrules the setting of the previous ones in the
2036
+ # list).
2037
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2038
+
2039
+ LATEX_EXTRA_STYLESHEET =
2040
+
2041
+ # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2042
+ # other source files which should be copied to the LATEX_OUTPUT output
2043
+ # directory. Note that the files will be copied as-is; there are no commands or
2044
+ # markers available.
2045
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2046
+
2047
+ LATEX_EXTRA_FILES =
2048
+
2049
+ # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2050
+ # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2051
+ # contain links (just like the HTML output) instead of page references. This
2052
+ # makes the output suitable for online browsing using a PDF viewer.
2053
+ # The default value is: YES.
2054
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2055
+
2056
+ PDF_HYPERLINKS = YES
2057
+
2058
+ # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
2059
+ # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
2060
+ # files. Set this option to YES, to get a higher quality PDF documentation.
2061
+ #
2062
+ # See also section LATEX_CMD_NAME for selecting the engine.
2063
+ # The default value is: YES.
2064
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2065
+
2066
+ USE_PDFLATEX = YES
2067
+
2068
+ # The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error.
2069
+ # Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
2070
+ # mode nothing is printed on the terminal, errors are scrolled as if <return> is
2071
+ # hit at every error; missing files that TeX tries to input or request from
2072
+ # keyboard input (\read on a not open input stream) cause the job to abort,
2073
+ # NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
2074
+ # but there is no possibility of user interaction just like in batch mode,
2075
+ # SCROLL In scroll mode, TeX will stop only for missing files to input or if
2076
+ # keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
2077
+ # each error, asking for user intervention.
2078
+ # The default value is: NO.
2079
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2080
+
2081
+ LATEX_BATCHMODE = NO
2082
+
2083
+ # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2084
+ # index chapters (such as File Index, Compound Index, etc.) in the output.
2085
+ # The default value is: NO.
2086
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2087
+
2088
+ LATEX_HIDE_INDICES = NO
2089
+
2090
+ # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2091
+ # bibliography, e.g. plainnat, or ieeetr. See
2092
+ # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2093
+ # The default value is: plain.
2094
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2095
+
2096
+ LATEX_BIB_STYLE = plain
2097
+
2098
+ # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2099
+ # path from which the emoji images will be read. If a relative path is entered,
2100
+ # it will be relative to the LATEX_OUTPUT directory. If left blank the
2101
+ # LATEX_OUTPUT directory will be used.
2102
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
2103
+
2104
+ LATEX_EMOJI_DIRECTORY =
2105
+
2106
+ #---------------------------------------------------------------------------
2107
+ # Configuration options related to the RTF output
2108
+ #---------------------------------------------------------------------------
2109
+
2110
+ # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2111
+ # RTF output is optimized for Word 97 and may not look too pretty with other RTF
2112
+ # readers/editors.
2113
+ # The default value is: NO.
2114
+
2115
+ GENERATE_RTF = NO
2116
+
2117
+ # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2118
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2119
+ # it.
2120
+ # The default directory is: rtf.
2121
+ # This tag requires that the tag GENERATE_RTF is set to YES.
2122
+
2123
+ RTF_OUTPUT = rtf
2124
+
2125
+ # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2126
+ # documents. This may be useful for small projects and may help to save some
2127
+ # trees in general.
2128
+ # The default value is: NO.
2129
+ # This tag requires that the tag GENERATE_RTF is set to YES.
2130
+
2131
+ COMPACT_RTF = NO
2132
+
2133
+ # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2134
+ # contain hyperlink fields. The RTF file will contain links (just like the HTML
2135
+ # output) instead of page references. This makes the output suitable for online
2136
+ # browsing using Word or some other Word compatible readers that support those
2137
+ # fields.
2138
+ #
2139
+ # Note: WordPad (write) and others do not support links.
2140
+ # The default value is: NO.
2141
+ # This tag requires that the tag GENERATE_RTF is set to YES.
2142
+
2143
+ RTF_HYPERLINKS = NO
2144
+
2145
+ # Load stylesheet definitions from file. Syntax is similar to doxygen's
2146
+ # configuration file, i.e. a series of assignments. You only have to provide
2147
+ # replacements, missing definitions are set to their default value.
2148
+ #
2149
+ # See also section "Doxygen usage" for information on how to generate the
2150
+ # default style sheet that doxygen normally uses.
2151
+ # This tag requires that the tag GENERATE_RTF is set to YES.
2152
+
2153
+ RTF_STYLESHEET_FILE =
2154
+
2155
+ # Set optional variables used in the generation of an RTF document. Syntax is
2156
+ # similar to doxygen's configuration file. A template extensions file can be
2157
+ # generated using doxygen -e rtf extensionFile.
2158
+ # This tag requires that the tag GENERATE_RTF is set to YES.
2159
+
2160
+ RTF_EXTENSIONS_FILE =
2161
+
2162
+ #---------------------------------------------------------------------------
2163
+ # Configuration options related to the man page output
2164
+ #---------------------------------------------------------------------------
2165
+
2166
+ # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2167
+ # classes and files.
2168
+ # The default value is: NO.
2169
+
2170
+ GENERATE_MAN = NO
2171
+
2172
+ # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2173
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2174
+ # it. A directory man3 will be created inside the directory specified by
2175
+ # MAN_OUTPUT.
2176
+ # The default directory is: man.
2177
+ # This tag requires that the tag GENERATE_MAN is set to YES.
2178
+
2179
+ MAN_OUTPUT = man
2180
+
2181
+ # The MAN_EXTENSION tag determines the extension that is added to the generated
2182
+ # man pages. In case the manual section does not start with a number, the number
2183
+ # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2184
+ # optional.
2185
+ # The default value is: .3.
2186
+ # This tag requires that the tag GENERATE_MAN is set to YES.
2187
+
2188
+ MAN_EXTENSION = .3
2189
+
2190
+ # The MAN_SUBDIR tag determines the name of the directory created within
2191
+ # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2192
+ # MAN_EXTENSION with the initial . removed.
2193
+ # This tag requires that the tag GENERATE_MAN is set to YES.
2194
+
2195
+ MAN_SUBDIR =
2196
+
2197
+ # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2198
+ # will generate one additional man file for each entity documented in the real
2199
+ # man page(s). These additional files only source the real man page, but without
2200
+ # them the man command would be unable to find the correct page.
2201
+ # The default value is: NO.
2202
+ # This tag requires that the tag GENERATE_MAN is set to YES.
2203
+
2204
+ MAN_LINKS = NO
2205
+
2206
+ #---------------------------------------------------------------------------
2207
+ # Configuration options related to the XML output
2208
+ #---------------------------------------------------------------------------
2209
+
2210
+ # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2211
+ # captures the structure of the code including all documentation.
2212
+ # The default value is: NO.
2213
+
2214
+ GENERATE_XML = NO
2215
+
2216
+ # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2217
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2218
+ # it.
2219
+ # The default directory is: xml.
2220
+ # This tag requires that the tag GENERATE_XML is set to YES.
2221
+
2222
+ XML_OUTPUT = xml
2223
+
2224
+ # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2225
+ # listings (including syntax highlighting and cross-referencing information) to
2226
+ # the XML output. Note that enabling this will significantly increase the size
2227
+ # of the XML output.
2228
+ # The default value is: YES.
2229
+ # This tag requires that the tag GENERATE_XML is set to YES.
2230
+
2231
+ XML_PROGRAMLISTING = YES
2232
+
2233
+ # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2234
+ # namespace members in file scope as well, matching the HTML output.
2235
+ # The default value is: NO.
2236
+ # This tag requires that the tag GENERATE_XML is set to YES.
2237
+
2238
+ XML_NS_MEMB_FILE_SCOPE = NO
2239
+
2240
+ #---------------------------------------------------------------------------
2241
+ # Configuration options related to the DOCBOOK output
2242
+ #---------------------------------------------------------------------------
2243
+
2244
+ # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2245
+ # that can be used to generate PDF.
2246
+ # The default value is: NO.
2247
+
2248
+ GENERATE_DOCBOOK = NO
2249
+
2250
+ # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2251
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2252
+ # front of it.
2253
+ # The default directory is: docbook.
2254
+ # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2255
+
2256
+ DOCBOOK_OUTPUT = docbook
2257
+
2258
+ #---------------------------------------------------------------------------
2259
+ # Configuration options for the AutoGen Definitions output
2260
+ #---------------------------------------------------------------------------
2261
+
2262
+ # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2263
+ # AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures
2264
+ # the structure of the code including all documentation. Note that this feature
2265
+ # is still experimental and incomplete at the moment.
2266
+ # The default value is: NO.
2267
+
2268
+ GENERATE_AUTOGEN_DEF = NO
2269
+
2270
+ #---------------------------------------------------------------------------
2271
+ # Configuration options related to Sqlite3 output
2272
+ #---------------------------------------------------------------------------
2273
+
2274
+ # If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3
2275
+ # database with symbols found by doxygen stored in tables.
2276
+ # The default value is: NO.
2277
+
2278
+ GENERATE_SQLITE3 = NO
2279
+
2280
+ # The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
2281
+ # put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2282
+ # in front of it.
2283
+ # The default directory is: sqlite3.
2284
+ # This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2285
+
2286
+ SQLITE3_OUTPUT = sqlite3
2287
+
2288
+ # The SQLITE3_OVERWRITE_DB tag is set to YES, the existing doxygen_sqlite3.db
2289
+ # database file will be recreated with each doxygen run. If set to NO, doxygen
2290
+ # will warn if an a database file is already found and not modify it.
2291
+ # The default value is: YES.
2292
+ # This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2293
+
2294
+ SQLITE3_RECREATE_DB = YES
2295
+
2296
+ #---------------------------------------------------------------------------
2297
+ # Configuration options related to the Perl module output
2298
+ #---------------------------------------------------------------------------
2299
+
2300
+ # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2301
+ # file that captures the structure of the code including all documentation.
2302
+ #
2303
+ # Note that this feature is still experimental and incomplete at the moment.
2304
+ # The default value is: NO.
2305
+
2306
+ GENERATE_PERLMOD = NO
2307
+
2308
+ # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2309
+ # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2310
+ # output from the Perl module output.
2311
+ # The default value is: NO.
2312
+ # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2313
+
2314
+ PERLMOD_LATEX = NO
2315
+
2316
+ # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2317
+ # formatted so it can be parsed by a human reader. This is useful if you want to
2318
+ # understand what is going on. On the other hand, if this tag is set to NO, the
2319
+ # size of the Perl module output will be much smaller and Perl will parse it
2320
+ # just the same.
2321
+ # The default value is: YES.
2322
+ # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2323
+
2324
+ PERLMOD_PRETTY = YES
2325
+
2326
+ # The names of the make variables in the generated doxyrules.make file are
2327
+ # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2328
+ # so different doxyrules.make files included by the same Makefile don't
2329
+ # overwrite each other's variables.
2330
+ # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2331
+
2332
+ PERLMOD_MAKEVAR_PREFIX =
2333
+
2334
+ #---------------------------------------------------------------------------
2335
+ # Configuration options related to the preprocessor
2336
+ #---------------------------------------------------------------------------
2337
+
2338
+ # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2339
+ # C-preprocessor directives found in the sources and include files.
2340
+ # The default value is: YES.
2341
+
2342
+ ENABLE_PREPROCESSING = YES
2343
+
2344
+ # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2345
+ # in the source code. If set to NO, only conditional compilation will be
2346
+ # performed. Macro expansion can be done in a controlled way by setting
2347
+ # EXPAND_ONLY_PREDEF to YES.
2348
+ # The default value is: NO.
2349
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2350
+
2351
+ MACRO_EXPANSION = YES
2352
+
2353
+ # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2354
+ # the macro expansion is limited to the macros specified with the PREDEFINED and
2355
+ # EXPAND_AS_DEFINED tags.
2356
+ # The default value is: NO.
2357
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2358
+
2359
+ EXPAND_ONLY_PREDEF = YES
2360
+
2361
+ # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2362
+ # INCLUDE_PATH will be searched if a #include is found.
2363
+ # The default value is: YES.
2364
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2365
+
2366
+ SEARCH_INCLUDES = YES
2367
+
2368
+ # The INCLUDE_PATH tag can be used to specify one or more directories that
2369
+ # contain include files that are not input files but should be processed by the
2370
+ # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2371
+ # RECURSIVE has no effect here.
2372
+ # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2373
+
2374
+ INCLUDE_PATH =
2375
+
2376
+ # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2377
+ # patterns (like *.h and *.hpp) to filter out the header-files in the
2378
+ # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2379
+ # used.
2380
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2381
+
2382
+ INCLUDE_FILE_PATTERNS =
2383
+
2384
+ # The PREDEFINED tag can be used to specify one or more macro names that are
2385
+ # defined before the preprocessor is started (similar to the -D option of e.g.
2386
+ # gcc). The argument of the tag is a list of macros of the form: name or
2387
+ # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2388
+ # is assumed. To prevent a macro definition from being undefined via #undef or
2389
+ # recursively expanded use the := operator instead of the = operator.
2390
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2391
+
2392
+ PREDEFINED = DOXYGEN \
2393
+ INK_ENABLE_STL \
2394
+ INK_ENABLE_CSTD \
2395
+ INK_ENABLE_UNREAL \
2396
+ UFUNCTION(...):=
2397
+
2398
+ # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2399
+ # tag can be used to specify a list of macro names that should be expanded. The
2400
+ # macro definition that is found in the sources will be used. Use the PREDEFINED
2401
+ # tag if you want to use a different macro definition that overrules the
2402
+ # definition found in the source code.
2403
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2404
+
2405
+ EXPAND_AS_DEFINED = UFUNCTION
2406
+
2407
+ # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2408
+ # remove all references to function-like macros that are alone on a line, have
2409
+ # an all uppercase name, and do not end with a semicolon. Such function macros
2410
+ # are typically used for boiler-plate code, and will confuse the parser if not
2411
+ # removed.
2412
+ # The default value is: YES.
2413
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2414
+
2415
+ SKIP_FUNCTION_MACROS = YES
2416
+
2417
+ #---------------------------------------------------------------------------
2418
+ # Configuration options related to external references
2419
+ #---------------------------------------------------------------------------
2420
+
2421
+ # The TAGFILES tag can be used to specify one or more tag files. For each tag
2422
+ # file the location of the external documentation should be added. The format of
2423
+ # a tag file without this location is as follows:
2424
+ # TAGFILES = file1 file2 ...
2425
+ # Adding location for the tag files is done as follows:
2426
+ # TAGFILES = file1=loc1 "file2 = loc2" ...
2427
+ # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2428
+ # section "Linking to external documentation" for more information about the use
2429
+ # of tag files.
2430
+ # Note: Each tag file must have a unique name (where the name does NOT include
2431
+ # the path). If a tag file is not located in the directory in which doxygen is
2432
+ # run, you must also specify the path to the tagfile here.
2433
+
2434
+ TAGFILES =
2435
+
2436
+ # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2437
+ # tag file that is based on the input files it reads. See section "Linking to
2438
+ # external documentation" for more information about the usage of tag files.
2439
+
2440
+ GENERATE_TAGFILE =
2441
+
2442
+ # If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
2443
+ # will be listed in the class and namespace index. If set to NO, only the
2444
+ # inherited external classes will be listed.
2445
+ # The default value is: NO.
2446
+
2447
+ ALLEXTERNALS = NO
2448
+
2449
+ # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2450
+ # in the topic index. If set to NO, only the current project's groups will be
2451
+ # listed.
2452
+ # The default value is: YES.
2453
+
2454
+ EXTERNAL_GROUPS = YES
2455
+
2456
+ # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2457
+ # the related pages index. If set to NO, only the current project's pages will
2458
+ # be listed.
2459
+ # The default value is: YES.
2460
+
2461
+ EXTERNAL_PAGES = YES
2462
+
2463
+ #---------------------------------------------------------------------------
2464
+ # Configuration options related to diagram generator tools
2465
+ #---------------------------------------------------------------------------
2466
+
2467
+ # If set to YES the inheritance and collaboration graphs will hide inheritance
2468
+ # and usage relations if the target is undocumented or is not a class.
2469
+ # The default value is: YES.
2470
+
2471
+ HIDE_UNDOC_RELATIONS = YES
2472
+
2473
+ # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2474
+ # available from the path. This tool is part of Graphviz (see:
2475
+ # https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2476
+ # Bell Labs. The other options in this section have no effect if this option is
2477
+ # set to NO
2478
+ # The default value is: NO.
2479
+
2480
+ HAVE_DOT = NO
2481
+
2482
+ # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2483
+ # to run in parallel. When set to 0 doxygen will base this on the number of
2484
+ # processors available in the system. You can set it explicitly to a value
2485
+ # larger than 0 to get control over the balance between CPU load and processing
2486
+ # speed.
2487
+ # Minimum value: 0, maximum value: 32, default value: 0.
2488
+ # This tag requires that the tag HAVE_DOT is set to YES.
2489
+
2490
+ DOT_NUM_THREADS = 0
2491
+
2492
+ # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2493
+ # subgraphs. When you want a differently looking font in the dot files that
2494
+ # doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2495
+ # For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
2496
+ # Edge and Graph Attributes specification</a> You need to make sure dot is able
2497
+ # to find the font, which can be done by putting it in a standard location or by
2498
+ # setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2499
+ # directory containing the font. Default graphviz fontsize is 14.
2500
+ # The default value is: fontname=Helvetica,fontsize=10.
2501
+ # This tag requires that the tag HAVE_DOT is set to YES.
2502
+
2503
+ DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
2504
+
2505
+ # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2506
+ # add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
2507
+ # href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
2508
+ # arrows shapes.</a>
2509
+ # The default value is: labelfontname=Helvetica,labelfontsize=10.
2510
+ # This tag requires that the tag HAVE_DOT is set to YES.
2511
+
2512
+ DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
2513
+
2514
+ # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2515
+ # around nodes set 'shape=plain' or 'shape=plaintext' <a
2516
+ # href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
2517
+ # The default value is: shape=box,height=0.2,width=0.4.
2518
+ # This tag requires that the tag HAVE_DOT is set to YES.
2519
+
2520
+ DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
2521
+
2522
+ # You can set the path where dot can find font specified with fontname in
2523
+ # DOT_COMMON_ATTR and others dot attributes.
2524
+ # This tag requires that the tag HAVE_DOT is set to YES.
2525
+
2526
+ DOT_FONTPATH =
2527
+
2528
+ # If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
2529
+ # generate a graph for each documented class showing the direct and indirect
2530
+ # inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
2531
+ # HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2532
+ # the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
2533
+ # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2534
+ # If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
2535
+ # relations will be shown as texts / links.
2536
+ # Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
2537
+ # The default value is: YES.
2538
+
2539
+ CLASS_GRAPH = YES
2540
+
2541
+ # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2542
+ # graph for each documented class showing the direct and indirect implementation
2543
+ # dependencies (inheritance, containment, and class references variables) of the
2544
+ # class with other documented classes. Explicit enabling a collaboration graph,
2545
+ # when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
2546
+ # command \collaborationgraph. Disabling a collaboration graph can be
2547
+ # accomplished by means of the command \hidecollaborationgraph.
2548
+ # The default value is: YES.
2549
+ # This tag requires that the tag HAVE_DOT is set to YES.
2550
+
2551
+ COLLABORATION_GRAPH = YES
2552
+
2553
+ # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2554
+ # groups, showing the direct groups dependencies. Explicit enabling a group
2555
+ # dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
2556
+ # of the command \groupgraph. Disabling a directory graph can be accomplished by
2557
+ # means of the command \hidegroupgraph. See also the chapter Grouping in the
2558
+ # manual.
2559
+ # The default value is: YES.
2560
+ # This tag requires that the tag HAVE_DOT is set to YES.
2561
+
2562
+ GROUP_GRAPHS = YES
2563
+
2564
+ # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2565
+ # collaboration diagrams in a style similar to the OMG's Unified Modeling
2566
+ # Language.
2567
+ # The default value is: NO.
2568
+ # This tag requires that the tag HAVE_DOT is set to YES.
2569
+
2570
+ UML_LOOK = NO
2571
+
2572
+ # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2573
+ # class node. If there are many fields or methods and many nodes the graph may
2574
+ # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2575
+ # number of items for each type to make the size more manageable. Set this to 0
2576
+ # for no limit. Note that the threshold may be exceeded by 50% before the limit
2577
+ # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2578
+ # but if the number exceeds 15, the total amount of fields shown is limited to
2579
+ # 10.
2580
+ # Minimum value: 0, maximum value: 100, default value: 10.
2581
+ # This tag requires that the tag UML_LOOK is set to YES.
2582
+
2583
+ UML_LIMIT_NUM_FIELDS = 10
2584
+
2585
+ # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2586
+ # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2587
+ # tag is set to YES, doxygen will add type and arguments for attributes and
2588
+ # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2589
+ # will not generate fields with class member information in the UML graphs. The
2590
+ # class diagrams will look similar to the default class diagrams but using UML
2591
+ # notation for the relationships.
2592
+ # Possible values are: NO, YES and NONE.
2593
+ # The default value is: NO.
2594
+ # This tag requires that the tag UML_LOOK is set to YES.
2595
+
2596
+ DOT_UML_DETAILS = NO
2597
+
2598
+ # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2599
+ # to display on a single line. If the actual line length exceeds this threshold
2600
+ # significantly it will wrapped across multiple lines. Some heuristics are apply
2601
+ # to avoid ugly line breaks.
2602
+ # Minimum value: 0, maximum value: 1000, default value: 17.
2603
+ # This tag requires that the tag HAVE_DOT is set to YES.
2604
+
2605
+ DOT_WRAP_THRESHOLD = 17
2606
+
2607
+ # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2608
+ # collaboration graphs will show the relations between templates and their
2609
+ # instances.
2610
+ # The default value is: NO.
2611
+ # This tag requires that the tag HAVE_DOT is set to YES.
2612
+
2613
+ TEMPLATE_RELATIONS = NO
2614
+
2615
+ # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2616
+ # YES then doxygen will generate a graph for each documented file showing the
2617
+ # direct and indirect include dependencies of the file with other documented
2618
+ # files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO,
2619
+ # can be accomplished by means of the command \includegraph. Disabling an
2620
+ # include graph can be accomplished by means of the command \hideincludegraph.
2621
+ # The default value is: YES.
2622
+ # This tag requires that the tag HAVE_DOT is set to YES.
2623
+
2624
+ INCLUDE_GRAPH = YES
2625
+
2626
+ # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2627
+ # set to YES then doxygen will generate a graph for each documented file showing
2628
+ # the direct and indirect include dependencies of the file with other documented
2629
+ # files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
2630
+ # to NO, can be accomplished by means of the command \includedbygraph. Disabling
2631
+ # an included by graph can be accomplished by means of the command
2632
+ # \hideincludedbygraph.
2633
+ # The default value is: YES.
2634
+ # This tag requires that the tag HAVE_DOT is set to YES.
2635
+
2636
+ INCLUDED_BY_GRAPH = YES
2637
+
2638
+ # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2639
+ # dependency graph for every global function or class method.
2640
+ #
2641
+ # Note that enabling this option will significantly increase the time of a run.
2642
+ # So in most cases it will be better to enable call graphs for selected
2643
+ # functions only using the \callgraph command. Disabling a call graph can be
2644
+ # accomplished by means of the command \hidecallgraph.
2645
+ # The default value is: NO.
2646
+ # This tag requires that the tag HAVE_DOT is set to YES.
2647
+
2648
+ CALL_GRAPH = NO
2649
+
2650
+ # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2651
+ # dependency graph for every global function or class method.
2652
+ #
2653
+ # Note that enabling this option will significantly increase the time of a run.
2654
+ # So in most cases it will be better to enable caller graphs for selected
2655
+ # functions only using the \callergraph command. Disabling a caller graph can be
2656
+ # accomplished by means of the command \hidecallergraph.
2657
+ # The default value is: NO.
2658
+ # This tag requires that the tag HAVE_DOT is set to YES.
2659
+
2660
+ CALLER_GRAPH = NO
2661
+
2662
+ # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2663
+ # hierarchy of all classes instead of a textual one.
2664
+ # The default value is: YES.
2665
+ # This tag requires that the tag HAVE_DOT is set to YES.
2666
+
2667
+ GRAPHICAL_HIERARCHY = YES
2668
+
2669
+ # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2670
+ # dependencies a directory has on other directories in a graphical way. The
2671
+ # dependency relations are determined by the #include relations between the
2672
+ # files in the directories. Explicit enabling a directory graph, when
2673
+ # DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
2674
+ # \directorygraph. Disabling a directory graph can be accomplished by means of
2675
+ # the command \hidedirectorygraph.
2676
+ # The default value is: YES.
2677
+ # This tag requires that the tag HAVE_DOT is set to YES.
2678
+
2679
+ DIRECTORY_GRAPH = YES
2680
+
2681
+ # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
2682
+ # of child directories generated in directory dependency graphs by dot.
2683
+ # Minimum value: 1, maximum value: 25, default value: 1.
2684
+ # This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2685
+
2686
+ DIR_GRAPH_MAX_DEPTH = 1
2687
+
2688
+ # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2689
+ # generated by dot. For an explanation of the image formats see the section
2690
+ # output formats in the documentation of the dot tool (Graphviz (see:
2691
+ # https://www.graphviz.org/)).
2692
+ # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2693
+ # to make the SVG files visible in IE 9+ (other browsers do not have this
2694
+ # requirement).
2695
+ # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2696
+ # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2697
+ # png:gdiplus:gdiplus.
2698
+ # The default value is: png.
2699
+ # This tag requires that the tag HAVE_DOT is set to YES.
2700
+
2701
+ DOT_IMAGE_FORMAT = png
2702
+
2703
+ # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2704
+ # enable generation of interactive SVG images that allow zooming and panning.
2705
+ #
2706
+ # Note that this requires a modern browser other than Internet Explorer. Tested
2707
+ # and working are Firefox, Chrome, Safari, and Opera.
2708
+ # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2709
+ # the SVG files visible. Older versions of IE do not have SVG support.
2710
+ # The default value is: NO.
2711
+ # This tag requires that the tag HAVE_DOT is set to YES.
2712
+
2713
+ INTERACTIVE_SVG = NO
2714
+
2715
+ # The DOT_PATH tag can be used to specify the path where the dot tool can be
2716
+ # found. If left blank, it is assumed the dot tool can be found in the path.
2717
+ # This tag requires that the tag HAVE_DOT is set to YES.
2718
+
2719
+ DOT_PATH =
2720
+
2721
+ # The DOTFILE_DIRS tag can be used to specify one or more directories that
2722
+ # contain dot files that are included in the documentation (see the \dotfile
2723
+ # command).
2724
+ # This tag requires that the tag HAVE_DOT is set to YES.
2725
+
2726
+ DOTFILE_DIRS =
2727
+
2728
+ # You can include diagrams made with dia in doxygen documentation. Doxygen will
2729
+ # then run dia to produce the diagram and insert it in the documentation. The
2730
+ # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2731
+ # If left empty dia is assumed to be found in the default search path.
2732
+
2733
+ DIA_PATH =
2734
+
2735
+ # The DIAFILE_DIRS tag can be used to specify one or more directories that
2736
+ # contain dia files that are included in the documentation (see the \diafile
2737
+ # command).
2738
+
2739
+ DIAFILE_DIRS =
2740
+
2741
+ # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2742
+ # path where java can find the plantuml.jar file or to the filename of jar file
2743
+ # to be used. If left blank, it is assumed PlantUML is not used or called during
2744
+ # a preprocessing step. Doxygen will generate a warning when it encounters a
2745
+ # \startuml command in this case and will not generate output for the diagram.
2746
+
2747
+ PLANTUML_JAR_PATH =
2748
+
2749
+ # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2750
+ # configuration file for plantuml.
2751
+
2752
+ PLANTUML_CFG_FILE =
2753
+
2754
+ # When using plantuml, the specified paths are searched for files specified by
2755
+ # the !include statement in a plantuml block.
2756
+
2757
+ PLANTUML_INCLUDE_PATH =
2758
+
2759
+ # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2760
+ # that will be shown in the graph. If the number of nodes in a graph becomes
2761
+ # larger than this value, doxygen will truncate the graph, which is visualized
2762
+ # by representing a node as a red box. Note that doxygen if the number of direct
2763
+ # children of the root node in a graph is already larger than
2764
+ # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2765
+ # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2766
+ # Minimum value: 0, maximum value: 10000, default value: 50.
2767
+ # This tag requires that the tag HAVE_DOT is set to YES.
2768
+
2769
+ DOT_GRAPH_MAX_NODES = 50
2770
+
2771
+ # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2772
+ # generated by dot. A depth value of 3 means that only nodes reachable from the
2773
+ # root by following a path via at most 3 edges will be shown. Nodes that lay
2774
+ # further from the root node will be omitted. Note that setting this option to 1
2775
+ # or 2 may greatly reduce the computation time needed for large code bases. Also
2776
+ # note that the size of a graph can be further restricted by
2777
+ # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2778
+ # Minimum value: 0, maximum value: 1000, default value: 0.
2779
+ # This tag requires that the tag HAVE_DOT is set to YES.
2780
+
2781
+ MAX_DOT_GRAPH_DEPTH = 0
2782
+
2783
+ # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2784
+ # files in one run (i.e. multiple -o and -T options on the command line). This
2785
+ # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2786
+ # this, this feature is disabled by default.
2787
+ # The default value is: NO.
2788
+ # This tag requires that the tag HAVE_DOT is set to YES.
2789
+
2790
+ DOT_MULTI_TARGETS = NO
2791
+
2792
+ # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2793
+ # explaining the meaning of the various boxes and arrows in the dot generated
2794
+ # graphs.
2795
+ # Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
2796
+ # graphical representation for inheritance and collaboration diagrams is used.
2797
+ # The default value is: YES.
2798
+ # This tag requires that the tag HAVE_DOT is set to YES.
2799
+
2800
+ GENERATE_LEGEND = YES
2801
+
2802
+ # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2803
+ # files that are used to generate the various graphs.
2804
+ #
2805
+ # Note: This setting is not only used for dot files but also for msc temporary
2806
+ # files.
2807
+ # The default value is: YES.
2808
+
2809
+ DOT_CLEANUP = YES
2810
+
2811
+ # You can define message sequence charts within doxygen comments using the \msc
2812
+ # command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will
2813
+ # use a built-in version of mscgen tool to produce the charts. Alternatively,
2814
+ # the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
2815
+ # specifying prog as the value, doxygen will call the tool as prog -T
2816
+ # <outfile_format> -o <outputfile> <inputfile>. The external tool should support
2817
+ # output file formats "png", "eps", "svg", and "ismap".
2818
+
2819
+ MSCGEN_TOOL =
2820
+
2821
+ # The MSCFILE_DIRS tag can be used to specify one or more directories that
2822
+ # contain msc files that are included in the documentation (see the \mscfile
2823
+ # command).
2824
+
2825
+ MSCFILE_DIRS =