@xpack/doxygen2docusaurus 2.0.0 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (365) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +3 -1
  3. package/bin/doxygen2docusaurus.js +5 -5
  4. package/dist/cli/main.d.ts +0 -14
  5. package/dist/cli/main.d.ts.map +1 -1
  6. package/dist/cli/main.js +0 -34
  7. package/dist/cli/main.js.map +1 -1
  8. package/dist/docusaurus/cli-options.d.ts +3 -292
  9. package/dist/docusaurus/cli-options.d.ts.map +1 -1
  10. package/dist/docusaurus/cli-options.js +6 -290
  11. package/dist/docusaurus/cli-options.js.map +1 -1
  12. package/dist/docusaurus/generator.d.ts +0 -172
  13. package/dist/docusaurus/generator.d.ts.map +1 -1
  14. package/dist/docusaurus/generator.js +20 -280
  15. package/dist/docusaurus/generator.js.map +1 -1
  16. package/dist/docusaurus/renderers/conceptparts.d.ts +9 -0
  17. package/dist/docusaurus/renderers/conceptparts.d.ts.map +1 -0
  18. package/dist/docusaurus/renderers/conceptparts.js +21 -0
  19. package/dist/docusaurus/renderers/conceptparts.js.map +1 -0
  20. package/dist/docusaurus/renderers/descriptiontype.d.ts +0 -417
  21. package/dist/docusaurus/renderers/descriptiontype.d.ts.map +1 -1
  22. package/dist/docusaurus/renderers/descriptiontype.js +11 -555
  23. package/dist/docusaurus/renderers/descriptiontype.js.map +1 -1
  24. package/dist/docusaurus/renderers/docinternalstype.d.ts +0 -132
  25. package/dist/docusaurus/renderers/docinternalstype.d.ts.map +1 -1
  26. package/dist/docusaurus/renderers/docinternalstype.js +0 -156
  27. package/dist/docusaurus/renderers/docinternalstype.js.map +1 -1
  28. package/dist/docusaurus/renderers/doclisttype.d.ts +0 -22
  29. package/dist/docusaurus/renderers/doclisttype.d.ts.map +1 -1
  30. package/dist/docusaurus/renderers/doclisttype.js +0 -42
  31. package/dist/docusaurus/renderers/doclisttype.js.map +1 -1
  32. package/dist/docusaurus/renderers/doctabletype.d.ts +0 -88
  33. package/dist/docusaurus/renderers/doctabletype.d.ts.map +1 -1
  34. package/dist/docusaurus/renderers/doctabletype.js +1 -113
  35. package/dist/docusaurus/renderers/doctabletype.js.map +1 -1
  36. package/dist/docusaurus/renderers/doctitletype.d.ts +0 -22
  37. package/dist/docusaurus/renderers/doctitletype.d.ts.map +1 -1
  38. package/dist/docusaurus/renderers/doctitletype.js +0 -42
  39. package/dist/docusaurus/renderers/doctitletype.js.map +1 -1
  40. package/dist/docusaurus/renderers/docvariablelisttype.d.ts +0 -44
  41. package/dist/docusaurus/renderers/docvariablelisttype.d.ts.map +1 -1
  42. package/dist/docusaurus/renderers/docvariablelisttype.js +1 -69
  43. package/dist/docusaurus/renderers/docvariablelisttype.js.map +1 -1
  44. package/dist/docusaurus/renderers/docxrefsecttype.d.ts +0 -22
  45. package/dist/docusaurus/renderers/docxrefsecttype.d.ts.map +1 -1
  46. package/dist/docusaurus/renderers/docxrefsecttype.js +0 -38
  47. package/dist/docusaurus/renderers/docxrefsecttype.js.map +1 -1
  48. package/dist/docusaurus/renderers/element-renderer-base.d.ts +0 -74
  49. package/dist/docusaurus/renderers/element-renderer-base.d.ts.map +1 -1
  50. package/dist/docusaurus/renderers/element-renderer-base.js +0 -64
  51. package/dist/docusaurus/renderers/element-renderer-base.js.map +1 -1
  52. package/dist/docusaurus/renderers/inctype.d.ts +0 -23
  53. package/dist/docusaurus/renderers/inctype.d.ts.map +1 -1
  54. package/dist/docusaurus/renderers/inctype.js +0 -41
  55. package/dist/docusaurus/renderers/inctype.js.map +1 -1
  56. package/dist/docusaurus/renderers/linkedtexttype.d.ts +0 -22
  57. package/dist/docusaurus/renderers/linkedtexttype.d.ts.map +1 -1
  58. package/dist/docusaurus/renderers/linkedtexttype.js +0 -45
  59. package/dist/docusaurus/renderers/linkedtexttype.js.map +1 -1
  60. package/dist/docusaurus/renderers/listingtype.d.ts +0 -52
  61. package/dist/docusaurus/renderers/listingtype.d.ts.map +1 -1
  62. package/dist/docusaurus/renderers/listingtype.js +1 -88
  63. package/dist/docusaurus/renderers/listingtype.js.map +1 -1
  64. package/dist/docusaurus/renderers/paramtype.d.ts +0 -22
  65. package/dist/docusaurus/renderers/paramtype.d.ts.map +1 -1
  66. package/dist/docusaurus/renderers/paramtype.js +2 -51
  67. package/dist/docusaurus/renderers/paramtype.js.map +1 -1
  68. package/dist/docusaurus/renderers/referencetype.d.ts +0 -23
  69. package/dist/docusaurus/renderers/referencetype.d.ts.map +1 -1
  70. package/dist/docusaurus/renderers/referencetype.js +0 -38
  71. package/dist/docusaurus/renderers/referencetype.js.map +1 -1
  72. package/dist/docusaurus/renderers/reftexttype.d.ts +0 -22
  73. package/dist/docusaurus/renderers/reftexttype.d.ts.map +1 -1
  74. package/dist/docusaurus/renderers/reftexttype.js +0 -38
  75. package/dist/docusaurus/renderers/reftexttype.js.map +1 -1
  76. package/dist/docusaurus/renderers/reftype.d.ts +0 -22
  77. package/dist/docusaurus/renderers/reftype.d.ts.map +1 -1
  78. package/dist/docusaurus/renderers/reftype.js +0 -38
  79. package/dist/docusaurus/renderers/reftype.js.map +1 -1
  80. package/dist/docusaurus/renderers/renderers.d.ts +0 -151
  81. package/dist/docusaurus/renderers/renderers.d.ts.map +1 -1
  82. package/dist/docusaurus/renderers/renderers.js +15 -186
  83. package/dist/docusaurus/renderers/renderers.js.map +1 -1
  84. package/dist/docusaurus/renderers/substringtype.d.ts +0 -22
  85. package/dist/docusaurus/renderers/substringtype.d.ts.map +1 -1
  86. package/dist/docusaurus/renderers/substringtype.js +0 -39
  87. package/dist/docusaurus/renderers/substringtype.js.map +1 -1
  88. package/dist/docusaurus/renderers/tableofcontentstype.d.ts +0 -22
  89. package/dist/docusaurus/renderers/tableofcontentstype.d.ts.map +1 -1
  90. package/dist/docusaurus/renderers/tableofcontentstype.js +0 -39
  91. package/dist/docusaurus/renderers/tableofcontentstype.js.map +1 -1
  92. package/dist/docusaurus/types.d.ts +0 -110
  93. package/dist/docusaurus/types.d.ts.map +1 -1
  94. package/dist/docusaurus/types.js +0 -11
  95. package/dist/docusaurus/types.js.map +1 -1
  96. package/dist/docusaurus/utils.d.ts +0 -214
  97. package/dist/docusaurus/utils.d.ts.map +1 -1
  98. package/dist/docusaurus/utils.js +0 -296
  99. package/dist/docusaurus/utils.js.map +1 -1
  100. package/dist/docusaurus/view-model/classes-vm.d.ts +0 -137
  101. package/dist/docusaurus/view-model/classes-vm.d.ts.map +1 -1
  102. package/dist/docusaurus/view-model/classes-vm.js +9 -225
  103. package/dist/docusaurus/view-model/classes-vm.js.map +1 -1
  104. package/dist/docusaurus/view-model/collection-base.d.ts +0 -120
  105. package/dist/docusaurus/view-model/collection-base.d.ts.map +1 -1
  106. package/dist/docusaurus/view-model/collection-base.js +11 -101
  107. package/dist/docusaurus/view-model/collection-base.js.map +1 -1
  108. package/dist/docusaurus/view-model/compound-base-vm.d.ts +2 -147
  109. package/dist/docusaurus/view-model/compound-base-vm.d.ts.map +1 -1
  110. package/dist/docusaurus/view-model/compound-base-vm.js +47 -225
  111. package/dist/docusaurus/view-model/compound-base-vm.js.map +1 -1
  112. package/dist/docusaurus/view-model/concepts-vm.d.ts +27 -0
  113. package/dist/docusaurus/view-model/concepts-vm.d.ts.map +1 -0
  114. package/dist/docusaurus/view-model/concepts-vm.js +337 -0
  115. package/dist/docusaurus/view-model/concepts-vm.js.map +1 -0
  116. package/dist/docusaurus/view-model/description-anchors.d.ts +0 -58
  117. package/dist/docusaurus/view-model/description-anchors.d.ts.map +1 -1
  118. package/dist/docusaurus/view-model/description-anchors.js +0 -71
  119. package/dist/docusaurus/view-model/description-anchors.js.map +1 -1
  120. package/dist/docusaurus/view-model/files-and-folders-vm.d.ts +0 -247
  121. package/dist/docusaurus/view-model/files-and-folders-vm.d.ts.map +1 -1
  122. package/dist/docusaurus/view-model/files-and-folders-vm.js +61 -353
  123. package/dist/docusaurus/view-model/files-and-folders-vm.js.map +1 -1
  124. package/dist/docusaurus/view-model/groups-vm.d.ts +0 -148
  125. package/dist/docusaurus/view-model/groups-vm.d.ts.map +1 -1
  126. package/dist/docusaurus/view-model/groups-vm.js +2 -223
  127. package/dist/docusaurus/view-model/groups-vm.js.map +1 -1
  128. package/dist/docusaurus/view-model/members-vm.d.ts +0 -552
  129. package/dist/docusaurus/view-model/members-vm.d.ts.map +1 -1
  130. package/dist/docusaurus/view-model/members-vm.js +17 -702
  131. package/dist/docusaurus/view-model/members-vm.js.map +1 -1
  132. package/dist/docusaurus/view-model/namespaces-vm.d.ts +5 -199
  133. package/dist/docusaurus/view-model/namespaces-vm.d.ts.map +1 -1
  134. package/dist/docusaurus/view-model/namespaces-vm.js +85 -284
  135. package/dist/docusaurus/view-model/namespaces-vm.js.map +1 -1
  136. package/dist/docusaurus/view-model/options.d.ts +0 -43
  137. package/dist/docusaurus/view-model/options.d.ts.map +1 -1
  138. package/dist/docusaurus/view-model/options.js +0 -57
  139. package/dist/docusaurus/view-model/options.js.map +1 -1
  140. package/dist/docusaurus/view-model/pages-vm.d.ts +0 -115
  141. package/dist/docusaurus/view-model/pages-vm.d.ts.map +1 -1
  142. package/dist/docusaurus/view-model/pages-vm.js +39 -162
  143. package/dist/docusaurus/view-model/pages-vm.js.map +1 -1
  144. package/dist/docusaurus/view-model/tree-entries-vm.d.ts +8 -142
  145. package/dist/docusaurus/view-model/tree-entries-vm.d.ts.map +1 -1
  146. package/dist/docusaurus/view-model/tree-entries-vm.js +54 -174
  147. package/dist/docusaurus/view-model/tree-entries-vm.js.map +1 -1
  148. package/dist/docusaurus/view-model/view-model.d.ts +0 -125
  149. package/dist/docusaurus/view-model/view-model.d.ts.map +1 -1
  150. package/dist/docusaurus/view-model/view-model.js +20 -182
  151. package/dist/docusaurus/view-model/view-model.js.map +1 -1
  152. package/dist/docusaurus/workspace.d.ts +1 -126
  153. package/dist/docusaurus/workspace.d.ts.map +1 -1
  154. package/dist/docusaurus/workspace.js +8 -221
  155. package/dist/docusaurus/workspace.js.map +1 -1
  156. package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts +7 -492
  157. package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts.map +1 -1
  158. package/dist/doxygen/data-model/compounds/compounddef-dm.js +28 -672
  159. package/dist/doxygen/data-model/compounds/compounddef-dm.js.map +1 -1
  160. package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts +0 -129
  161. package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts.map +1 -1
  162. package/dist/doxygen/data-model/compounds/compoundreftype-dm.js +1 -145
  163. package/dist/doxygen/data-model/compounds/compoundreftype-dm.js.map +1 -1
  164. package/dist/doxygen/data-model/compounds/concepts-dm.d.ts +23 -0
  165. package/dist/doxygen/data-model/compounds/concepts-dm.d.ts.map +1 -0
  166. package/dist/doxygen/data-model/compounds/concepts-dm.js +94 -0
  167. package/dist/doxygen/data-model/compounds/concepts-dm.js.map +1 -0
  168. package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts +104 -2848
  169. package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts.map +1 -1
  170. package/dist/doxygen/data-model/compounds/descriptiontype-dm.js +73 -3975
  171. package/dist/doxygen/data-model/compounds/descriptiontype-dm.js.map +1 -1
  172. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts +0 -165
  173. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts.map +1 -1
  174. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js +0 -229
  175. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js.map +1 -1
  176. package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts +0 -70
  177. package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts.map +1 -1
  178. package/dist/doxygen/data-model/compounds/doxygentype-dm.js +0 -105
  179. package/dist/doxygen/data-model/compounds/doxygentype-dm.js.map +1 -1
  180. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts +0 -84
  181. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts.map +1 -1
  182. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js +1 -122
  183. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js.map +1 -1
  184. package/dist/doxygen/data-model/compounds/inctype-dm.d.ts +0 -116
  185. package/dist/doxygen/data-model/compounds/inctype-dm.d.ts.map +1 -1
  186. package/dist/doxygen/data-model/compounds/inctype-dm.js +3 -155
  187. package/dist/doxygen/data-model/compounds/inctype-dm.js.map +1 -1
  188. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts +3 -138
  189. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts.map +1 -1
  190. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js +5 -180
  191. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js.map +1 -1
  192. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts +0 -76
  193. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts.map +1 -1
  194. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js +0 -107
  195. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js.map +1 -1
  196. package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts +0 -162
  197. package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts.map +1 -1
  198. package/dist/doxygen/data-model/compounds/locationtype-dm.js +4 -203
  199. package/dist/doxygen/data-model/compounds/locationtype-dm.js.map +1 -1
  200. package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts +2 -443
  201. package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts.map +1 -1
  202. package/dist/doxygen/data-model/compounds/memberdeftype-dm.js +19 -475
  203. package/dist/doxygen/data-model/compounds/memberdeftype-dm.js.map +1 -1
  204. package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts +0 -141
  205. package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts.map +1 -1
  206. package/dist/doxygen/data-model/compounds/memberreftype-dm.js +0 -176
  207. package/dist/doxygen/data-model/compounds/memberreftype-dm.js.map +1 -1
  208. package/dist/doxygen/data-model/compounds/membertype-dm.d.ts +0 -101
  209. package/dist/doxygen/data-model/compounds/membertype-dm.d.ts.map +1 -1
  210. package/dist/doxygen/data-model/compounds/membertype-dm.js +0 -115
  211. package/dist/doxygen/data-model/compounds/membertype-dm.js.map +1 -1
  212. package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts +0 -164
  213. package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts.map +1 -1
  214. package/dist/doxygen/data-model/compounds/paramtype-dm.js +0 -208
  215. package/dist/doxygen/data-model/compounds/paramtype-dm.js.map +1 -1
  216. package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts +0 -139
  217. package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts.map +1 -1
  218. package/dist/doxygen/data-model/compounds/referencetype-dm.js +2 -175
  219. package/dist/doxygen/data-model/compounds/referencetype-dm.js.map +1 -1
  220. package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts +0 -120
  221. package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts.map +1 -1
  222. package/dist/doxygen/data-model/compounds/reftexttype-dm.js +2 -141
  223. package/dist/doxygen/data-model/compounds/reftexttype-dm.js.map +1 -1
  224. package/dist/doxygen/data-model/compounds/reftype-dm.d.ts +0 -268
  225. package/dist/doxygen/data-model/compounds/reftype-dm.d.ts.map +1 -1
  226. package/dist/doxygen/data-model/compounds/reftype-dm.js +4 -326
  227. package/dist/doxygen/data-model/compounds/reftype-dm.js.map +1 -1
  228. package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts +0 -105
  229. package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts.map +1 -1
  230. package/dist/doxygen/data-model/compounds/reimplementtype-dm.js +1 -139
  231. package/dist/doxygen/data-model/compounds/reimplementtype-dm.js.map +1 -1
  232. package/dist/doxygen/data-model/compounds/requirements-dm.d.ts +2 -0
  233. package/dist/doxygen/data-model/compounds/requirements-dm.d.ts.map +1 -0
  234. package/dist/doxygen/data-model/compounds/requirements-dm.js +2 -0
  235. package/dist/doxygen/data-model/compounds/requirements-dm.js.map +1 -0
  236. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts +0 -168
  237. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts.map +1 -1
  238. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js +0 -209
  239. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js.map +1 -1
  240. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts +0 -267
  241. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts.map +1 -1
  242. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js +0 -354
  243. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js.map +1 -1
  244. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts +0 -66
  245. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts.map +1 -1
  246. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js +0 -97
  247. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js.map +1 -1
  248. package/dist/doxygen/data-model/data-model.d.ts +0 -149
  249. package/dist/doxygen/data-model/data-model.d.ts.map +1 -1
  250. package/dist/doxygen/data-model/data-model.js +8 -200
  251. package/dist/doxygen/data-model/data-model.js.map +1 -1
  252. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts +0 -115
  253. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts.map +1 -1
  254. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js +4 -129
  255. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js.map +1 -1
  256. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts +0 -87
  257. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts.map +1 -1
  258. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js +0 -118
  259. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js.map +1 -1
  260. package/dist/doxygen/data-model/doxygen-xml-parser.d.ts +0 -253
  261. package/dist/doxygen/data-model/doxygen-xml-parser.d.ts.map +1 -1
  262. package/dist/doxygen/data-model/doxygen-xml-parser.js +0 -291
  263. package/dist/doxygen/data-model/doxygen-xml-parser.js.map +1 -1
  264. package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts +0 -98
  265. package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts.map +1 -1
  266. package/dist/doxygen/data-model/index/indexcompoundtype-dm.js +2 -122
  267. package/dist/doxygen/data-model/index/indexcompoundtype-dm.js.map +1 -1
  268. package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts +0 -82
  269. package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts.map +1 -1
  270. package/dist/doxygen/data-model/index/indexdoxygentype-dm.js +0 -114
  271. package/dist/doxygen/data-model/index/indexdoxygentype-dm.js.map +1 -1
  272. package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts +0 -85
  273. package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts.map +1 -1
  274. package/dist/doxygen/data-model/index/indexmembertype-dm.js +1 -107
  275. package/dist/doxygen/data-model/index/indexmembertype-dm.js.map +1 -1
  276. package/dist/doxygen/data-model/types.d.ts +0 -104
  277. package/dist/doxygen/data-model/types.d.ts.map +1 -1
  278. package/dist/doxygen/data-model/types.js +0 -52
  279. package/dist/doxygen/data-model/types.js.map +1 -1
  280. package/dist/index.d.ts +5 -16
  281. package/dist/index.d.ts.map +1 -1
  282. package/dist/index.js +5 -42
  283. package/dist/index.js.map +1 -1
  284. package/package.json +49 -52
  285. package/src/cli/main.ts +122 -0
  286. package/src/docusaurus/cli-options.ts +560 -0
  287. package/src/docusaurus/generator.ts +788 -0
  288. package/src/docusaurus/renderers/conceptparts.ts +119 -0
  289. package/src/docusaurus/renderers/descriptiontype.ts +1299 -0
  290. package/src/docusaurus/renderers/docinternalstype.ts +354 -0
  291. package/src/docusaurus/renderers/doclisttype.ts +134 -0
  292. package/src/docusaurus/renderers/doctabletype.ts +220 -0
  293. package/src/docusaurus/renderers/doctitletype.ts +77 -0
  294. package/src/docusaurus/renderers/docvariablelisttype.ts +123 -0
  295. package/src/docusaurus/renderers/docxrefsecttype.ts +84 -0
  296. package/src/docusaurus/renderers/element-renderer-base.ts +112 -0
  297. package/src/docusaurus/renderers/inctype.ts +75 -0
  298. package/src/docusaurus/renderers/linkedtexttype.ts +64 -0
  299. package/src/docusaurus/renderers/listingtype.ts +235 -0
  300. package/src/docusaurus/renderers/paramtype.ts +116 -0
  301. package/src/docusaurus/renderers/referencetype.ts +83 -0
  302. package/src/docusaurus/renderers/reftexttype.ts +81 -0
  303. package/src/docusaurus/renderers/reftype.ts +77 -0
  304. package/src/docusaurus/renderers/renderers.ts +812 -0
  305. package/src/docusaurus/renderers/substringtype.ts +53 -0
  306. package/src/docusaurus/renderers/tableofcontentstype.ts +74 -0
  307. package/src/docusaurus/types.ts +187 -0
  308. package/src/docusaurus/utils.ts +409 -0
  309. package/src/docusaurus/view-model/README.md +12 -0
  310. package/src/docusaurus/view-model/classes-vm.ts +1088 -0
  311. package/src/docusaurus/view-model/collection-base.ts +352 -0
  312. package/src/docusaurus/view-model/compound-base-vm.ts +1340 -0
  313. package/src/docusaurus/view-model/concepts-vm.ts +749 -0
  314. package/src/docusaurus/view-model/description-anchors.ts +107 -0
  315. package/src/docusaurus/view-model/files-and-folders-vm.ts +1293 -0
  316. package/src/docusaurus/view-model/groups-vm.ts +548 -0
  317. package/src/docusaurus/view-model/members-vm.ts +1943 -0
  318. package/src/docusaurus/view-model/namespaces-vm.ts +1037 -0
  319. package/src/docusaurus/view-model/options.ts +95 -0
  320. package/src/docusaurus/view-model/pages-vm.ts +389 -0
  321. package/src/docusaurus/view-model/tree-entries-vm.ts +376 -0
  322. package/src/docusaurus/view-model/view-model.ts +513 -0
  323. package/src/docusaurus/workspace.ts +588 -0
  324. package/src/doxygen/data-model/README.md +13 -0
  325. package/src/doxygen/data-model/compounds/compounddef-dm.ts +1230 -0
  326. package/src/doxygen/data-model/compounds/compoundreftype-dm.ts +266 -0
  327. package/src/doxygen/data-model/compounds/concepts-dm.ts +362 -0
  328. package/src/doxygen/data-model/compounds/descriptiontype-dm.ts +10114 -0
  329. package/src/doxygen/data-model/compounds/docvarlistentrytype-dm.ts +354 -0
  330. package/src/doxygen/data-model/compounds/doxygentype-dm.ts +187 -0
  331. package/src/doxygen/data-model/compounds/enumvaluetype-dm.ts +218 -0
  332. package/src/doxygen/data-model/compounds/inctype-dm.ts +217 -0
  333. package/src/doxygen/data-model/compounds/linkedtexttype-dm.ts +288 -0
  334. package/src/doxygen/data-model/compounds/listofallmemberstype-dm.ts +160 -0
  335. package/src/doxygen/data-model/compounds/locationtype-dm.ts +284 -0
  336. package/src/doxygen/data-model/compounds/memberdeftype-dm.ts +881 -0
  337. package/src/doxygen/data-model/compounds/memberreftype-dm.ts +270 -0
  338. package/src/doxygen/data-model/compounds/membertype-dm.ts +239 -0
  339. package/src/doxygen/data-model/compounds/paramtype-dm.ts +302 -0
  340. package/src/doxygen/data-model/compounds/referencetype-dm.ts +248 -0
  341. package/src/doxygen/data-model/compounds/reftexttype-dm.ts +234 -0
  342. package/src/doxygen/data-model/compounds/reftype-dm.ts +430 -0
  343. package/src/doxygen/data-model/compounds/reimplementtype-dm.ts +201 -0
  344. package/src/doxygen/data-model/compounds/requirements-dm.ts +50 -0
  345. package/src/doxygen/data-model/compounds/sectiondeftype-dm.ts +330 -0
  346. package/src/doxygen/data-model/compounds/tableofcontentstype-dm.ts +564 -0
  347. package/src/doxygen/data-model/compounds/templateparamlisttype-dm.ts +150 -0
  348. package/src/doxygen/data-model/data-model.ts +378 -0
  349. package/src/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.ts +271 -0
  350. package/src/doxygen/data-model/doxyfile/doxyfiletype-dm.ts +200 -0
  351. package/src/doxygen/data-model/doxygen-xml-parser.ts +522 -0
  352. package/src/doxygen/data-model/index/indexcompoundtype-dm.ts +256 -0
  353. package/src/doxygen/data-model/index/indexdoxygentype-dm.ts +196 -0
  354. package/src/doxygen/data-model/index/indexmembertype-dm.ts +230 -0
  355. package/src/doxygen/data-model/types.ts +175 -0
  356. package/src/doxygen/data-model/xsds/README.md +6 -0
  357. package/src/doxygen/data-model/xsds/compound.xsd +1788 -0
  358. package/src/doxygen/data-model/xsds/doxyfile.xsd +365 -0
  359. package/src/doxygen/data-model/xsds/index.xsd +74 -0
  360. package/src/doxygen/data-model/xsds/xml.xsd +23 -0
  361. package/src/index.ts +267 -0
  362. package/src/tsconfig.json +12 -0
  363. package/dist/doxygen2docusaurus.d.ts +0 -4774
  364. package/dist/tsconfig.tsbuildinfo +0 -1
  365. package/dist/tsdoc-metadata.json +0 -11
@@ -1,274 +1,30 @@
1
- /*
2
- * This file is part of the xPack project (http://xpack.github.io).
3
- * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
4
- *
5
- * Permission to use, copy, modify, and/or distribute this software
6
- * for any purpose is hereby granted, under the terms of the MIT license.
7
- *
8
- * If a copy of the license was not distributed with this file, it can
9
- * be obtained from https://opensource.org/licenses/MIT.
10
- */
11
- // ----------------------------------------------------------------------------
12
1
  import assert from 'node:assert';
13
2
  import * as fs from 'node:fs/promises';
14
3
  import * as path from 'node:path';
15
- /**
16
- * Comprehensive CLI options class for documentation generation configuration.
17
- *
18
- * @remarks
19
- * The CliOptions class contains all configuration parameters that control
20
- * the behaviour of the doxygen2docusaurus conversion process, including
21
- * paths, URLs, styling, and feature toggles.
22
- *
23
- * @public
24
- */
25
4
  export class CliOptions {
26
- /**
27
- * Path to the Doxygen XML input folder relative to the website folder.
28
- *
29
- * @remarks
30
- * Specifies the location of XML files generated by Doxygen, typically
31
- * containing the parsed documentation data. Path should not include
32
- * initial or final slashes.
33
- *
34
- * @defaultValue 'doxygen/xml'
35
- */
36
5
  doxygenXmlInputFolderPath = 'doxygen/xml';
37
- /**
38
- * Path to the documentation folder relative to the website folder.
39
- *
40
- * @remarks
41
- * Defines the base folder where generated documentation will be placed
42
- * within the Docusaurus website structure. Path should not include
43
- * initial or final slashes.
44
- *
45
- * @defaultValue 'docs'
46
- */
47
6
  docsFolderPath = 'docs';
48
- /**
49
- * Path to the API documentation folder relative to the docs folder.
50
- *
51
- * @remarks
52
- * Specifies the subfolder within the docs folder where API reference
53
- * documentation will be generated. Path should not include initial
54
- * or final slashes.
55
- *
56
- * @defaultValue 'api'
57
- */
58
7
  apiFolderPath = 'api';
59
- /**
60
- * Base URL for the entire website.
61
- *
62
- * @remarks
63
- * Defines the root URL path for the website, typically '/' for root
64
- * deployment or '/project-name/' for GitHub Pages or similar hosting.
65
- *
66
- * @defaultValue '/'
67
- */
68
8
  baseUrl = '/';
69
- /**
70
- * URL path to the documentation section relative to the website root.
71
- *
72
- * @remarks
73
- * Specifies the URL segment that leads to the documentation section,
74
- * without initial or final slashes. Used for navigation and linking.
75
- *
76
- * @defaultValue 'docs'
77
- */
78
9
  docsBaseUrl = 'docs';
79
- /**
80
- * URL path to the API documentation relative to the docs section.
81
- *
82
- * @remarks
83
- * Defines the URL segment for API documentation within the docs section,
84
- * without initial or final slashes. Used for generating navigation links.
85
- *
86
- * @defaultValue 'api'
87
- */
88
10
  apiBaseUrl = 'api';
89
- /**
90
- * Path for images relative to the `static` folder.
91
- *
92
- * @remarks
93
- * Specifies where Doxygen-generated images will be stored within the
94
- * Docusaurus static assets folder structure.
95
- *
96
- * @defaultValue 'assets/images/doxygen'
97
- */
98
11
  imagesFolderPath = 'assets/images/doxygen';
99
- /**
100
- * Output folder for compatibility redirect files.
101
- *
102
- * @remarks
103
- * Optional path relative to the website/static folder where HTML redirect
104
- * files will be generated to maintain compatibility with original Doxygen
105
- * URLs. When undefined, no redirect files are created.
106
- */
107
12
  compatibilityRedirectsOutputFolderPath;
108
- /**
109
- * Title displayed on the main API documentation page.
110
- *
111
- * @remarks
112
- * When specified, this title overrides the default title generated from
113
- * the project brief. When empty, the title is automatically constructed
114
- * from the project configuration.
115
- *
116
- * @defaultValue ''
117
- */
118
13
  mainPageTitle = '';
119
- /**
120
- * Path to the sidebar category configuration file.
121
- *
122
- * @remarks
123
- * Specifies the location where the generated sidebar category JSON
124
- * configuration will be written, relative to the current website folder.
125
- *
126
- * @defaultValue 'sidebar-category-doxygen.json'
127
- */
128
14
  sidebarCategoryFilePath = 'sidebar-category-doxygen.json';
129
- /**
130
- * Label displayed in the Docusaurus sidebar for the API documentation.
131
- *
132
- * @remarks
133
- * Short descriptive text that appears in the sidebar navigation to
134
- * identify the API reference section.
135
- *
136
- * @defaultValue 'API Reference (Doxygen)'
137
- */
138
15
  sidebarCategoryLabel = 'API Reference (Doxygen)';
139
- /**
140
- * Path to the navbar configuration file.
141
- *
142
- * @remarks
143
- * Specifies the location where the generated navbar dropdown JSON
144
- * configuration will be written, relative to the current website folder.
145
- *
146
- * @defaultValue 'docusaurus-config-navbar-doxygen.json'
147
- */
148
- navbarFilePath = 'docusaurus-config-navbar-doxygen.json';
149
- /**
150
- * Label displayed in the top navigation bar.
151
- *
152
- * @remarks
153
- * Short text that appears in the Docusaurus top navigation bar to
154
- * provide access to the API documentation section.
155
- *
156
- * @defaultValue 'Reference'
157
- */
158
- navbarLabel = 'Reference';
159
- /**
160
- * Position of the navigation menu in the top bar.
161
- *
162
- * @remarks
163
- * Determines whether the API documentation menu appears on the left
164
- * or right side of the Docusaurus navigation bar.
165
- *
166
- * @defaultValue 'left'
167
- */
168
- navbarPosition = 'left';
169
- /**
170
- * Path to the custom CSS file for styling overrides.
171
- *
172
- * @remarks
173
- * Specifies the location where custom CSS styles will be written to
174
- * provide Doxygen-specific styling within the Docusaurus theme.
175
- * Path is relative to the current website folder.
176
- *
177
- * @defaultValue 'src/css/custom-doxygen2docusaurus.css'
178
- */
16
+ navbarDropdownFilePath = 'docusaurus-config-navbar-doxygen.json';
17
+ navbarDropdownLabel = 'API Reference';
18
+ navbarDropdownPosition = 'left';
179
19
  customCssFilePath = 'src/css/custom-doxygen2docusaurus.css';
180
- /**
181
- * Controls verbose output during the conversion process.
182
- *
183
- * @remarks
184
- * When enabled, provides detailed logging information about the
185
- * conversion process, including file processing status and statistics.
186
- *
187
- * @defaultValue false
188
- */
189
20
  verbose = false;
190
- /**
191
- * Controls debug-level output during the conversion process.
192
- *
193
- * @remarks
194
- * When enabled, provides extensive debugging information useful for
195
- * troubleshooting issues. Automatically enables verbose output as well.
196
- *
197
- * @defaultValue false
198
- */
199
21
  debug = false;
200
- /**
201
- * Controls whether TODO suggestion descriptions are displayed.
202
- *
203
- * @remarks
204
- * When enabled, shows suggestions for improvements or missing content
205
- * that could enhance the generated documentation quality.
206
- *
207
- * @defaultValue false
208
- */
209
22
  suggestToDoDescriptions = false;
210
- /**
211
- * Controls whether pages are listed at the top of the sidebar.
212
- *
213
- * @remarks
214
- * When enabled, places page links prominently at the top of the sidebar
215
- * navigation structure for easier access to important pages.
216
- *
217
- * @defaultValue true
218
- */
219
23
  listPagesAtTop = true;
220
- /**
221
- * Controls program listing rendering in File pages.
222
- *
223
- * @remarks
224
- * When enabled, includes syntax-highlighted source code listings
225
- * within the generated File documentation pages.
226
- *
227
- * @defaultValue true
228
- */
229
24
  renderProgramListing = true;
230
- /**
231
- * Controls program listing rendering in member definition sections.
232
- *
233
- * @remarks
234
- * When enabled, includes inline syntax-highlighted code snippets
235
- * within member documentation sections for better context.
236
- *
237
- * @defaultValue true
238
- */
239
25
  renderProgramListingInline = true;
240
- /**
241
- * Note about the location of original Doxygen pages.
242
- *
243
- * @remarks
244
- * Provides information about where to find the original Doxygen HTML
245
- * pages for comparison purposes. When populated, this note is displayed
246
- * to inform users about the availability of alternative documentation
247
- * formats.
248
- */
249
26
  originalPagesNote = '';
250
- /**
251
- * String identifier for distinguishing multiple configuration instances.
252
- *
253
- * @remarks
254
- * Used when multiple configuration instances exist to provide unique
255
- * identification. Particularly useful in multi-configuration scenarios
256
- * where different settings need to be applied to different outputs.
257
- *
258
- * @defaultValue 'default'
259
- */
260
27
  id = 'default';
261
- /**
262
- * Creates a new CliOptions instance with the specified command options.
263
- *
264
- * @remarks
265
- * Initialises the configuration object by setting the ID and optional
266
- * flags like verbose and debug. When the ID is not 'default', adjusts
267
- * folder paths and file names to include the ID for multi-configuration
268
- * scenarios.
269
- *
270
- * @param commandOptions - Command-line options object containing ID and flags
271
- */
272
28
  constructor(commandOptions) {
273
29
  this.id = commandOptions.id;
274
30
  if (commandOptions.verbose !== undefined) {
@@ -283,7 +39,7 @@ export class CliOptions {
283
39
  this.imagesFolderPath = `img/doxygen-${this.id}`;
284
40
  this.sidebarCategoryFilePath =
285
41
  'sidebar-category-doxygen' + `-${this.id}.json`;
286
- this.navbarFilePath =
42
+ this.navbarDropdownFilePath =
287
43
  'docusaurus-config-navbar-doxygen' + `-${this.id}.json`;
288
44
  }
289
45
  else {
@@ -291,83 +47,58 @@ export class CliOptions {
291
47
  this.apiBaseUrl = 'api';
292
48
  this.imagesFolderPath = `img/doxygen`;
293
49
  this.sidebarCategoryFilePath = `sidebar-category-doxygen.json`;
294
- this.navbarFilePath = `docusaurus-config-navbar-doxygen.json`;
50
+ this.navbarDropdownFilePath = `docusaurus-config-navbar-doxygen.json`;
295
51
  }
296
52
  }
297
- /**
298
- * Parses configuration options from various JSON configuration sources.
299
- *
300
- * @remarks
301
- * Attempts to load configuration from multiple locations in order of
302
- * preference: config/doxygen2docusaurus.json, doxygen2docusaurus.json,
303
- * and package.json. Validates required properties and enables debug
304
- * output if requested.
305
- *
306
- * @throws Assertion error if required configuration properties are missing
307
- */
308
53
  async parse() {
309
54
  let configurationOptions = undefined;
310
55
  try {
311
56
  const userPackageJsonPath = path.resolve(process.cwd(), 'config', 'doxygen2docusaurus.json');
312
57
  const pkgJsonRaw = await fs.readFile(userPackageJsonPath, 'utf8');
313
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
314
58
  const multiConfigurations = JSON.parse(pkgJsonRaw);
315
59
  configurationOptions = this.selectMultiConfiguration(multiConfigurations);
316
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
317
60
  }
318
61
  catch (err) {
319
- /* Cannot read/parse JSON */
320
62
  }
321
63
  if (configurationOptions === undefined) {
322
64
  try {
323
65
  const userPackageJsonPath = path.resolve(process.cwd(), 'doxygen2docusaurus.json');
324
66
  const pkgJsonRaw = await fs.readFile(userPackageJsonPath, 'utf8');
325
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
326
67
  const multiConfigurations = JSON.parse(pkgJsonRaw);
327
68
  configurationOptions =
328
69
  this.selectMultiConfiguration(multiConfigurations);
329
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
330
70
  }
331
71
  catch (err) {
332
- /* Cannot read/parse JSON */
333
72
  }
334
73
  }
335
74
  if (configurationOptions === undefined) {
336
75
  try {
337
- // Try to get the configuration from
338
- // package.json/[config/]doxygen2docusaurus.
339
76
  const userPackageJsonPath = path.resolve(process.cwd(), 'package.json');
340
77
  const pkgJsonRaw = await fs.readFile(userPackageJsonPath, 'utf8');
341
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
342
78
  const pkgJson = JSON.parse(pkgJsonRaw);
343
79
  const multiConfigurations = pkgJson.config?.doxygen2docusaurus ?? pkgJson.doxygen2docusaurus;
344
80
  if (multiConfigurations !== undefined) {
345
81
  configurationOptions =
346
82
  this.selectMultiConfiguration(multiConfigurations);
347
83
  }
348
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
349
84
  }
350
85
  catch (err) {
351
- /* Cannot read/parse JSON */
352
86
  }
353
87
  }
354
88
  if (configurationOptions !== undefined) {
355
89
  if (this.debug) {
356
90
  console.log(configurationOptions);
357
91
  }
358
- // Override only properties that exist in CliOptions
359
92
  const thisProperties = Object.getOwnPropertyNames(this);
360
93
  for (const key of Object.keys(configurationOptions)) {
361
94
  const value = configurationOptions[key];
362
- // console.log(key, value)
363
95
  if (value !== undefined && thisProperties.includes(key)) {
364
96
  const thisProperty = this[key];
365
97
  const thisType = typeof thisProperty;
366
98
  const valueType = typeof value;
367
- if (['id', 'verbose', 'debug'].includes(key)) {
99
+ if (['id'].includes(key)) {
368
100
  continue;
369
101
  }
370
- // Override only if types match.
371
102
  if (thisType === valueType) {
372
103
  ;
373
104
  this[key] = value;
@@ -386,20 +117,8 @@ export class CliOptions {
386
117
  assert(this.docsFolderPath.length > 0, 'docsFolderPath is required');
387
118
  assert(this.apiFolderPath.length > 0, 'apiFolderPath is required');
388
119
  assert(this.docsBaseUrl.length > 0, 'docsBaseUrl is required');
389
- // assert(this.apiBaseUrl.length > 0, 'apiBaseUrl is required')
390
120
  assert(this.sidebarCategoryFilePath.length > 0, 'sidebarCategoryFilePath is required');
391
121
  }
392
- /**
393
- * Selects the appropriate configuration from multi-configuration options.
394
- *
395
- * @remarks
396
- * When using a specific ID, returns the corresponding configuration.
397
- * For the default ID, returns either the 'default' configuration or
398
- * treats the entire object as a single configuration.
399
- *
400
- * @param multiConfigurations - Configuration object or multi-config map
401
- * @returns Selected configuration options or undefined if not found
402
- */
403
122
  selectMultiConfiguration(multiConfigurations) {
404
123
  let configurationOptions = undefined;
405
124
  if (this.id !== 'default') {
@@ -418,9 +137,6 @@ export class CliOptions {
418
137
  return configurationOptions;
419
138
  }
420
139
  }
421
- // Was used during development. Now stick to true.
422
140
  export const renderParagraphs = true;
423
- // Does not make noticeable differences.
424
141
  export const maxParallelPromises = 42;
425
- // ----------------------------------------------------------------------------
426
142
  //# sourceMappingURL=cli-options.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"cli-options.js","sourceRoot":"","sources":["../../src/docusaurus/cli-options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AA+DjC;;;;;;;;;GASG;AACH,MAAM,OAAO,UAAU;IACrB;;;;;;;;;OASG;IACH,yBAAyB,GAAG,aAAa,CAAA;IAEzC;;;;;;;;;OASG;IACH,cAAc,GAAG,MAAM,CAAA;IAEvB;;;;;;;;;OASG;IACH,aAAa,GAAG,KAAK,CAAA;IAErB;;;;;;;;OAQG;IACH,OAAO,GAAG,GAAG,CAAA;IAEb;;;;;;;;OAQG;IACH,WAAW,GAAG,MAAM,CAAA;IAEpB;;;;;;;;OAQG;IACH,UAAU,GAAG,KAAK,CAAA;IAElB;;;;;;;;OAQG;IACH,gBAAgB,GAAG,uBAAuB,CAAA;IAE1C;;;;;;;OAOG;IACH,sCAAsC,CAAqB;IAE3D;;;;;;;;;OASG;IACH,aAAa,GAAG,EAAE,CAAA;IAElB;;;;;;;;OAQG;IACH,uBAAuB,GAAG,+BAA+B,CAAA;IAEzD;;;;;;;;OAQG;IACH,oBAAoB,GAAG,yBAAyB,CAAA;IAEhD;;;;;;;;OAQG;IACH,cAAc,GAAG,uCAAuC,CAAA;IAExD;;;;;;;;OAQG;IACH,WAAW,GAAG,WAAW,CAAA;IAEzB;;;;;;;;OAQG;IACH,cAAc,GAAqB,MAAM,CAAA;IAEzC;;;;;;;;;OASG;IACH,iBAAiB,GAAG,uCAAuC,CAAA;IAE3D;;;;;;;;OAQG;IACH,OAAO,GAAG,KAAK,CAAA;IAEf;;;;;;;;OAQG;IACH,KAAK,GAAG,KAAK,CAAA;IAEb;;;;;;;;OAQG;IACH,uBAAuB,GAAG,KAAK,CAAA;IAE/B;;;;;;;;OAQG;IACH,cAAc,GAAG,IAAI,CAAA;IAErB;;;;;;;;OAQG;IACH,oBAAoB,GAAG,IAAI,CAAA;IAE3B;;;;;;;;OAQG;IACH,0BAA0B,GAAG,IAAI,CAAA;IAEjC;;;;;;;;OAQG;IACH,iBAAiB,GAAG,EAAE,CAAA;IAEtB;;;;;;;;;OASG;IACH,EAAE,GAAG,SAAS,CAAA;IAEd;;;;;;;;;;OAUG;IACH,YAAY,cAA8B;QACxC,IAAI,CAAC,EAAE,GAAG,cAAc,CAAC,EAAY,CAAA;QAErC,IAAI,cAAc,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACrB,CAAC;QAED,IAAI,cAAc,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACnB,CAAC;QAED,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,EAAE,CAAA;YAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,CAAA;YACzB,IAAI,CAAC,gBAAgB,GAAG,eAAe,IAAI,CAAC,EAAE,EAAE,CAAA;YAChD,IAAI,CAAC,uBAAuB;gBAC1B,0BAA0B,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,CAAA;YACjD,IAAI,CAAC,cAAc;gBACjB,kCAAkC,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,CAAA;QAC3D,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;YAC1B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;YACvB,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAA;YACrC,IAAI,CAAC,uBAAuB,GAAG,+BAA+B,CAAA;YAC9D,IAAI,CAAC,cAAc,GAAG,uCAAuC,CAAA;QAC/D,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,oBAAoB,GAAwC,SAAS,CAAA;QAEzE,IAAI,CAAC;YACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,CAAC,GAAG,EAAE,EACb,QAAQ,EACR,yBAAyB,CAC1B,CAAA;YACD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;YAEjE,mEAAmE;YACnE,MAAM,mBAAmB,GAAwB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;YAEvE,oBAAoB,GAAG,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;YACzE,6DAA6D;QAC/D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,4BAA4B;QAC9B,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,CAAC,GAAG,EAAE,EACb,yBAAyB,CAC1B,CAAA;gBACD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;gBAEjE,mEAAmE;gBACnE,MAAM,mBAAmB,GAAwB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;gBAEvE,oBAAoB;oBAClB,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;gBACpD,6DAA6D;YAC/D,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,4BAA4B;YAC9B,CAAC;QACH,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,oCAAoC;gBACpC,4CAA4C;gBAC5C,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAA;gBACvE,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;gBAEjE,mEAAmE;gBACnE,MAAM,OAAO,GAAgC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;gBAEnE,MAAM,mBAAmB,GAIvB,OAAO,CAAC,MAAM,EAAE,kBAAkB,IAAI,OAAO,CAAC,kBAAkB,CAAA;gBAElE,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBACtC,oBAAoB;wBAClB,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;gBACtD,CAAC;gBACD,6DAA6D;YAC/D,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,4BAA4B;YAC9B,CAAC;QACH,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;YACnC,CAAC;YACD,oDAAoD;YACpD,MAAM,cAAc,GAAG,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;YAEvD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBACpD,MAAM,KAAK,GAAY,oBAAoB,CAAC,GAAG,CAAC,CAAA;gBAChD,0BAA0B;gBAC1B,IAAI,KAAK,KAAK,SAAS,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxD,MAAM,YAAY,GAAI,IAAgC,CAAC,GAAG,CAAC,CAAA;oBAC3D,MAAM,QAAQ,GAAG,OAAO,YAAY,CAAA;oBACpC,MAAM,SAAS,GAAG,OAAO,KAAK,CAAA;oBAE9B,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;wBAC7C,SAAQ;oBACV,CAAC;oBAED,gCAAgC;oBAChC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;wBAC3B,CAAC;wBAAC,IAAgC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;oBACjD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACrB,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,CAAC,GAAG,EAAE,CAAA;YACb,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACnB,CAAC;QAED,MAAM,CACJ,IAAI,CAAC,yBAAyB,CAAC,MAAM,GAAG,CAAC,EACzC,uCAAuC,CACxC,CAAA;QAED,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,4BAA4B,CAAC,CAAA;QACpE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,2BAA2B,CAAC,CAAA;QAElE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,yBAAyB,CAAC,CAAA;QAC9D,+DAA+D;QAE/D,MAAM,CACJ,IAAI,CAAC,uBAAuB,CAAC,MAAM,GAAG,CAAC,EACvC,qCAAqC,CACtC,CAAA;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,wBAAwB,CACtB,mBAAkE;QAElE,IAAI,oBAAoB,GAAwC,SAAS,CAAA;QACzE,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC1B,oBAAoB,GAClB,mBAID,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAEV,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;gBACvC,oBAAoB,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;YACnC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,WAAW,GAAG,mBAA0C,CAAA;YAC9D,oBAAoB;gBAClB,SAAS,IAAI,WAAW;oBACtB,CAAC,CAAC,WAAW,CAAC,OAAO;oBACrB,CAAC,CAAE,mBAA+C,CAAA;QACxD,CAAC;QACD,OAAO,oBAAoB,CAAA;IAC7B,CAAC;CACF;AAED,kDAAkD;AAClD,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAA;AAEpC,wCAAwC;AACxC,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAA;AAErC,+EAA+E"}
1
+ {"version":3,"file":"cli-options.js","sourceRoot":"","sources":["../../src/docusaurus/cli-options.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAyEjC,MAAM,OAAO,UAAU;IAWrB,yBAAyB,GAAG,aAAa,CAAA;IAYzC,cAAc,GAAG,MAAM,CAAA;IAYvB,aAAa,GAAG,KAAK,CAAA;IAWrB,OAAO,GAAG,GAAG,CAAA;IAWb,WAAW,GAAG,MAAM,CAAA;IAWpB,UAAU,GAAG,KAAK,CAAA;IAWlB,gBAAgB,GAAG,uBAAuB,CAAA;IAU1C,sCAAsC,CAAqB;IAY3D,aAAa,GAAG,EAAE,CAAA;IAWlB,uBAAuB,GAAG,+BAA+B,CAAA;IAWzD,oBAAoB,GAAG,yBAAyB,CAAA;IAWhD,sBAAsB,GAAG,uCAAuC,CAAA;IAWhE,mBAAmB,GAAG,eAAe,CAAA;IAWrC,sBAAsB,GAAqB,MAAM,CAAA;IAYjD,iBAAiB,GAAG,uCAAuC,CAAA;IAW3D,OAAO,GAAG,KAAK,CAAA;IAWf,KAAK,GAAG,KAAK,CAAA;IAWb,uBAAuB,GAAG,KAAK,CAAA;IAW/B,cAAc,GAAG,IAAI,CAAA;IAWrB,oBAAoB,GAAG,IAAI,CAAA;IAW3B,0BAA0B,GAAG,IAAI,CAAA;IAWjC,iBAAiB,GAAG,EAAE,CAAA;IAYtB,EAAE,GAAG,SAAS,CAAA;IAad,YAAY,cAA8B;QACxC,IAAI,CAAC,EAAE,GAAG,cAAc,CAAC,EAAY,CAAA;QAErC,IAAI,cAAc,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACrB,CAAC;QAED,IAAI,cAAc,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACnB,CAAC;QAED,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,EAAE,CAAA;YAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,CAAA;YACzB,IAAI,CAAC,gBAAgB,GAAG,eAAe,IAAI,CAAC,EAAE,EAAE,CAAA;YAChD,IAAI,CAAC,uBAAuB;gBAC1B,0BAA0B,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,CAAA;YACjD,IAAI,CAAC,sBAAsB;gBACzB,kCAAkC,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,CAAA;QAC3D,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;YAC1B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;YACvB,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAA;YACrC,IAAI,CAAC,uBAAuB,GAAG,+BAA+B,CAAA;YAC9D,IAAI,CAAC,sBAAsB,GAAG,uCAAuC,CAAA;QACvE,CAAC;IACH,CAAC;IAaD,KAAK,CAAC,KAAK;QACT,IAAI,oBAAoB,GAAwC,SAAS,CAAA;QAEzE,IAAI,CAAC;YACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,CAAC,GAAG,EAAE,EACb,QAAQ,EACR,yBAAyB,CAC1B,CAAA;YACD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;YAGjE,MAAM,mBAAmB,GAAwB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;YAEvE,oBAAoB,GAAG,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;QAE3E,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;QAEf,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,CAAC,GAAG,EAAE,EACb,yBAAyB,CAC1B,CAAA;gBACD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;gBAGjE,MAAM,mBAAmB,GAAwB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;gBAEvE,oBAAoB;oBAClB,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;YAEtD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;YAEf,CAAC;QACH,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC;gBAGH,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAA;gBACvE,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;gBAGjE,MAAM,OAAO,GAAgC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;gBAEnE,MAAM,mBAAmB,GAIvB,OAAO,CAAC,MAAM,EAAE,kBAAkB,IAAI,OAAO,CAAC,kBAAkB,CAAA;gBAElE,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBACtC,oBAAoB;wBAClB,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;gBACtD,CAAC;YAEH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;YAEf,CAAC;QACH,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;YACnC,CAAC;YAED,MAAM,cAAc,GAAG,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;YAEvD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBACpD,MAAM,KAAK,GAAY,oBAAoB,CAAC,GAAG,CAAC,CAAA;gBAEhD,IAAI,KAAK,KAAK,SAAS,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxD,MAAM,YAAY,GAAI,IAAgC,CAAC,GAAG,CAAC,CAAA;oBAC3D,MAAM,QAAQ,GAAG,OAAO,YAAY,CAAA;oBACpC,MAAM,SAAS,GAAG,OAAO,KAAK,CAAA;oBAG9B,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;wBACzB,SAAQ;oBACV,CAAC;oBAGD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;wBAC3B,CAAC;wBAAC,IAAgC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;oBACjD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACrB,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,CAAC,GAAG,EAAE,CAAA;YACb,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACnB,CAAC;QAED,MAAM,CACJ,IAAI,CAAC,yBAAyB,CAAC,MAAM,GAAG,CAAC,EACzC,uCAAuC,CACxC,CAAA;QAED,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,4BAA4B,CAAC,CAAA;QACpE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,2BAA2B,CAAC,CAAA;QAElE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,yBAAyB,CAAC,CAAA;QAG9D,MAAM,CACJ,IAAI,CAAC,uBAAuB,CAAC,MAAM,GAAG,CAAC,EACvC,qCAAqC,CACtC,CAAA;IACH,CAAC;IAaD,wBAAwB,CACtB,mBAAkE;QAElE,IAAI,oBAAoB,GAAwC,SAAS,CAAA;QACzE,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC1B,oBAAoB,GAClB,mBAID,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAEV,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;gBACvC,oBAAoB,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;YACnC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,WAAW,GAAG,mBAA0C,CAAA;YAC9D,oBAAoB;gBAClB,SAAS,IAAI,WAAW;oBACtB,CAAC,CAAC,WAAW,CAAC,OAAO;oBACrB,CAAC,CAAE,mBAA+C,CAAA;QACxD,CAAC;QACD,OAAO,oBAAoB,CAAA;IAC7B,CAAC;CACF;AAGD,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAA;AAGpC,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAA"}
@@ -2,196 +2,24 @@ import { Workspace } from './workspace.js';
2
2
  import { CliOptions } from './cli-options.js';
3
3
  import type { SidebarCategory, NavbarItem } from './types.js';
4
4
  import type { CompoundBase } from './view-model/compound-base-vm.js';
5
- /**
6
- * Generates Docusaurus-compatible Markdown files and configuration from
7
- * Doxygen XML output.
8
- *
9
- * @remarks
10
- * This class orchestrates the conversion process, creating documentation pages,
11
- * navigation structures, and associated assets for integration with Docusaurus
12
- * websites. It handles parallel processing for performance optimisation and
13
- * manages the complete workflow from XML parsing to final site generation.
14
- *
15
- * @public
16
- */
17
5
  export declare class DocusaurusGenerator {
18
- /** The workspace containing the data model and configuration options. */
19
6
  workspace: Workspace;
20
- /** CLI options that control the generation process. */
21
7
  options: CliOptions;
22
- /**
23
- * Constructs a new Docusaurus generator instance.
24
- *
25
- * @remarks
26
- * Initialises the generator with the provided workspace, which contains
27
- * the parsed Doxygen data model and configuration options required for
28
- * the generation process.
29
- *
30
- * @param workspace - The workspace containing the data model and
31
- * configuration.
32
- */
33
8
  constructor(workspace: Workspace);
34
- /**
35
- * Executes the complete generation process.
36
- *
37
- * @remarks
38
- * Orchestrates the creation of all Docusaurus assets including Markdown
39
- * files, navigation structures, redirect files, and static assets. The
40
- * process follows a specific sequence to ensure proper dependencies and
41
- * optimal performance through parallel processing where appropriate.
42
- *
43
- * @returns A promise that resolves to the exit code (0 for success).
44
- */
45
9
  run(): Promise<number>;
46
- /**
47
- * Prepares the output folder for generated content.
48
- *
49
- * @remarks
50
- * Removes any existing output folder and creates a new empty directory
51
- * structure for the generated Docusaurus files. This ensures a clean
52
- * starting state for each generation run and prevents conflicts with
53
- * previous builds.
54
- */
55
10
  prepareOutputFolder(): Promise<void>;
56
- /**
57
- * Generates the sidebar category structure for Docusaurus navigation.
58
- *
59
- * @remarks
60
- * Creates a hierarchical category structure that organises all generated
61
- * documentation pages into a logical navigation tree. The structure includes
62
- * top-level pages and follows the configured collection ordering to maintain
63
- * consistent navigation patterns.
64
- *
65
- * @returns The complete sidebar category configuration object.
66
- */
67
11
  generateSidebarCategory(): SidebarCategory;
68
- /**
69
- * Writes the sidebar configuration to a JSON file.
70
- *
71
- * @remarks
72
- * Serialises the sidebar category structure and writes it to the configured
73
- * output path for integration with Docusaurus. The resulting JSON file
74
- * provides the complete navigation structure for the documentation site.
75
- *
76
- * @param sidebarCategory - The sidebar configuration to write.
77
- */
78
12
  writeSidebarFile(sidebarCategory: SidebarCategory): Promise<void>;
79
- /**
80
- * Generates the navbar dropdown configuration for the top navigation.
81
- *
82
- * @remarks
83
- * Creates a navigation menu structure that provides quick access to
84
- * different sections of the generated documentation. When no items are
85
- * available, falls back to a simple link format for consistency.
86
- *
87
- * @returns The navbar item configuration for Docusaurus.
88
- */
89
13
  generateNavbarItem(): NavbarItem;
90
- /**
91
- * Writes the navbar configuration to a JSON file.
92
- *
93
- * @remarks
94
- * Serialises the navbar item structure and writes it to the configured
95
- * output path for integration with Docusaurus navigation. The resulting
96
- * JSON file provides the top-level navigation menu configuration.
97
- *
98
- * @param navbarItem - The navbar configuration to write.
99
- */
100
14
  writeNavbarFile(navbarItem: NavbarItem): Promise<void>;
101
- /**
102
- * Generates index Markdown files for all collections.
103
- *
104
- * @remarks
105
- * Creates overview pages for each documentation collection (classes, files,
106
- * namespaces, etc.) that provide organised access to the content. These
107
- * index files serve as entry points for navigating large documentation
108
- * collections efficiently.
109
- */
110
15
  generateCollectionsIndexDotMdFiles(): Promise<void>;
111
- /**
112
- * Generates the main index Markdown file for the API documentation.
113
- *
114
- * @remarks
115
- * Creates the landing page that serves as the entry point to the generated
116
- * documentation, including topics overview and main page content. This
117
- * combines the Doxygen @mainpage content with a structured topics table
118
- * for comprehensive navigation.
119
- */
120
16
  generateTopIndexDotMdFile(): Promise<void>;
121
- /**
122
- * Generates alphabetical index files organised by initial letters.
123
- *
124
- * @remarks
125
- * Creates index pages that group documentation items by their first letter,
126
- * facilitating alphabetical navigation through large sets of documentation.
127
- * This approach improves usability when dealing with extensive API
128
- * documentation containing numerous items.
129
- */
130
17
  generatePerInitialsIndexDotMdFiles(): Promise<void>;
131
- /**
132
- * Generates all individual Markdown files for documentation compounds.
133
- *
134
- * @remarks
135
- * Processes all compounds (classes, files, namespaces, etc.) from the
136
- * Doxygen XML and converts them into Docusaurus-compatible Markdown pages.
137
- * Supports parallel processing for improved performance whilst maintaining
138
- * proper error handling and resource management.
139
- */
140
18
  generateMdFiles(): Promise<void>;
141
- /**
142
- * Generates a single Markdown page for a documentation compound.
143
- *
144
- * @remarks
145
- * Converts an individual compound (class, file, namespace, etc.) into a
146
- * properly formatted Docusaurus Markdown file with appropriate front matter
147
- * and content. The method handles permalink generation, metadata creation,
148
- * and content rendering for optimal integration with Docusaurus.
149
- *
150
- * @param compound - The compound to generate a page for.
151
- */
152
19
  generatePage(compound: CompoundBase): Promise<void>;
153
- /**
154
- * Generates HTML redirect files for backwards compatibility.
155
- *
156
- * @remarks
157
- * Creates redirect files that map original Doxygen URLs to the new
158
- * Docusaurus URLs, maintaining compatibility with existing bookmarks
159
- * and external links. This ensures a smooth transition when migrating
160
- * from Doxygen-generated documentation to Docusaurus.
161
- */
162
20
  generateCompatibilityRedirectFiles(): Promise<void>;
163
- /**
164
- * Generates an HTML redirect file for URL redirection.
165
- *
166
- * @remarks
167
- * Creates a client-side redirect page that automatically forwards visitors
168
- * from old Doxygen URLs to the corresponding Docusaurus pages. The redirect
169
- * preserves query parameters and hash fragments to maintain deep linking
170
- * functionality across the migration.
171
- *
172
- * @param filePath - The path where the redirect file should be created.
173
- * @param permalink - The target URL to redirect to.
174
- */
175
21
  private generateRedirectFile;
176
- /**
177
- * Copies required static files to the output directory.
178
- *
179
- * @remarks
180
- * Transfers essential template files including SVG icons and CSS
181
- * stylesheets to the appropriate locations in the static directory
182
- * for use by the generated documentation. These assets provide the
183
- * visual styling and iconography for the documentation site.
184
- */
185
22
  copyFiles(): Promise<void>;
186
- /**
187
- * Copies image files referenced in the documentation.
188
- *
189
- * @remarks
190
- * Transfers all image files that are referenced within the Doxygen
191
- * documentation to the appropriate static directory, ensuring they
192
- * remain accessible in the generated Docusaurus site. Duplicate
193
- * image names are automatically deduplicated for efficiency.
194
- */
195
23
  copyImageFiles(): Promise<void>;
196
24
  }
197
25
  //# sourceMappingURL=generator.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/docusaurus/generator.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAuB,MAAM,kBAAkB,CAAA;AAClE,OAAO,KAAK,EAAE,eAAe,EAAe,UAAU,EAAE,MAAM,YAAY,CAAA;AAK1E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AAKpE;;;;;;;;;;;GAWG;AACH,qBAAa,mBAAmB;IAC9B,yEAAyE;IACzE,SAAS,EAAE,SAAS,CAAA;IAEpB,uDAAuD;IACvD,OAAO,EAAE,UAAU,CAAA;IAInB;;;;;;;;;;OAUG;gBACS,SAAS,EAAE,SAAS;IAQhC;;;;;;;;;;OAUG;IACG,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC;IA+C5B;;;;;;;;OAQG;IAEG,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAiB1C;;;;;;;;;;OAUG;IACH,uBAAuB,IAAI,eAAe;IA8B1C;;;;;;;;;OASG;IACG,gBAAgB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAYvE;;;;;;;;;OASG;IACH,kBAAkB,IAAI,UAAU;IAoChC;;;;;;;;;OASG;IACG,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAa5D;;;;;;;;OAQG;IACG,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;IAYzD;;;;;;;;OAQG;IACG,yBAAyB,IAAI,OAAO,CAAC,IAAI,CAAC;IA2EhD;;;;;;;;OAQG;IACG,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;IAYzD;;;;;;;;OAQG;IACG,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IA+CtC;;;;;;;;;;OAUG;IACG,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCzD;;;;;;;;OAQG;IACG,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;IA0GzD;;;;;;;;;;;OAWG;YAGW,oBAAoB;IAuClC;;;;;;;;OAQG;IACG,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAyChC;;;;;;;;OAQG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CA0CtC"}
1
+ {"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/docusaurus/generator.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAuB,MAAM,kBAAkB,CAAA;AAClE,OAAO,KAAK,EAAE,eAAe,EAAe,UAAU,EAAE,MAAM,YAAY,CAAA;AAK1E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AAiBpE,qBAAa,mBAAmB;IAE9B,SAAS,EAAE,SAAS,CAAA;IAGpB,OAAO,EAAE,UAAU,CAAA;gBAeP,SAAS,EAAE,SAAS;IAmB1B,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC;IAyDtB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IA4B1C,uBAAuB,IAAI,eAAe;IAwCpC,gBAAgB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBvE,kBAAkB,IAAI,UAAU;IA8C1B,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBtD,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;IAqBnD,yBAAyB,IAAI,OAAO,CAAC,IAAI,CAAC;IAoF1C,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;IAqBnD,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IA0DhC,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IA2CnD,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;YA0H3C,oBAAoB;IAgD5B,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAkD1B,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CA0CtC"}