@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,56 +1,7 @@
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
- // import assert from 'node:assert'
13
1
  import * as util from 'node:util';
14
2
  import { ElementLinesRendererBase } from './element-renderer-base.js';
15
- // ----------------------------------------------------------------------------
16
- // <xsd:complexType name="paramType">
17
- // <xsd:sequence>
18
- // <xsd:element name="attributes" type="xsd:string" minOccurs="0" />
19
- // <xsd:element name="type" type="linkedTextType" minOccurs="0" />
20
- // <xsd:element name="declname" type="xsd:string" minOccurs="0" />
21
- // <xsd:element name="defname" type="xsd:string" minOccurs="0" />
22
- // <xsd:element name="array" type="xsd:string" minOccurs="0" />
23
- // <xsd:element name="defval" type="linkedTextType" minOccurs="0" />
24
- // <xsd:element name="typeconstraint" type="linkedTextType" minOccurs="0" />
25
- // <xsd:element name="briefdescription" type="descriptionType"
26
- // minOccurs="0" />
27
- // </xsd:sequence>
28
- // </xsd:complexType>
29
- /**
30
- * Renderer for parameter type elements in function documentation.
31
- *
32
- * @remarks
33
- * Handles the rendering of function and method parameters as parsed from
34
- * Doxygen XML, converting them into formatted output that includes type
35
- * information, parameter names, and default values when available.
36
- *
37
- * @public
38
- */
39
3
  export class ParamTypeLinesRenderer extends ElementLinesRendererBase {
40
- /**
41
- * Renders a parameter element to formatted output lines.
42
- *
43
- * @remarks
44
- * Converts Doxygen parameter elements into formatted text including
45
- * type information, parameter names, array specifications, and default
46
- * values. Handles both declaration and definition name variants.
47
- *
48
- * @param element - The parameter element to render
49
- * @param type - The rendering context type
50
- * @returns Array of formatted output lines
51
- */
52
4
  renderToLines(element, type) {
53
- // console.log(util.inspect(element, { compact: false, depth: 999 }))
54
5
  if (element.attributes !== undefined) {
55
6
  console.error(util.inspect(element, { compact: false, depth: 999 }));
56
7
  console.error(element.elementName, 'property attributes not yet rendered in', this.constructor.name);
@@ -75,11 +26,11 @@ export class ParamTypeLinesRenderer extends ElementLinesRendererBase {
75
26
  text += `=${element.array}`;
76
27
  }
77
28
  if (element.defval !== undefined) {
78
- text += `=${this.workspace.renderElementToString(element.defval, type)}`;
29
+ const defvalStr = this.workspace.renderElementToString(element.defval, type);
30
+ text += `=${defvalStr}`;
79
31
  }
80
32
  }
81
33
  return [text];
82
34
  }
83
35
  }
84
- // ----------------------------------------------------------------------------
85
36
  //# sourceMappingURL=paramtype.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"paramtype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/paramtype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAGrE,+EAA+E;AAE/E,qCAAqC;AACrC,mBAAmB;AACnB,wEAAwE;AACxE,sEAAsE;AACtE,sEAAsE;AACtE,qEAAqE;AACrE,mEAAmE;AACnE,wEAAwE;AACxE,gFAAgF;AAChF,kEAAkE;AAClE,0BAA0B;AAC1B,oBAAoB;AACpB,qBAAqB;AAErB;;;;;;;;;GASG;AACH,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CAAC,OAA0B,EAAE,IAAY;QAC7D,qEAAqE;QAErE,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACrC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,yCAAyC,EACzC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,sCAAsC,EACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACzC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,6CAA6C,EAC7C,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YAC3C,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,+CAA+C,EAC/C,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QAED,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAChE,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAA;YAC9B,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAA;YAC7B,CAAC;YACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBACjC,IAAI,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAA;YAC1E,CAAC;QACH,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"paramtype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/paramtype.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AA6BrE,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IAazD,aAAa,CAAC,OAA0B,EAAE,IAAY;QAG7D,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACrC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,yCAAyC,EACzC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,sCAAsC,EACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACzC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,6CAA6C,EAC7C,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YAC3C,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,+CAA+C,EAC/C,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QAED,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAChE,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAA;YAC9B,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAA;YAC7B,CAAC;YACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBACjC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,qBAAqB,CACpD,OAAO,CAAC,MAAM,EACd,IAAI,CACL,CAAA;gBACD,IAAI,IAAI,IAAI,SAAS,EAAE,CAAA;YACzB,CAAC;QACH,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF"}
@@ -1,29 +1,6 @@
1
1
  import { ElementStringRendererBase } from './element-renderer-base.js';
2
2
  import { type AbstractReferenceType } from '../../doxygen/data-model/compounds/referencetype-dm.js';
3
- /**
4
- * Renderer for reference elements in documentation cross-references.
5
- *
6
- * @remarks
7
- * Handles the rendering of cross-reference elements that link to other
8
- * documented members, creating appropriate hyperlinks with proper
9
- * permalinks for navigation within the documentation.
10
- *
11
- * @public
12
- */
13
3
  export declare class ReferenceTypeStringRenderer extends ElementStringRendererBase {
14
- /**
15
- * Renders a reference element to a formatted string with hyperlinks.
16
- *
17
- * @remarks
18
- * Converts Doxygen reference elements into HTML anchor tags with
19
- * appropriate permalinks to the referenced members. Handles both
20
- * forward references and reverse references whilst sanitising
21
- * anonymous namespace names for display.
22
- *
23
- * @param element - The reference element to render
24
- * @param type - The rendering context type
25
- * @returns Formatted HTML string with hyperlink
26
- */
27
4
  renderToString(element: AbstractReferenceType, type: string): string;
28
5
  }
29
6
  //# sourceMappingURL=referencetype.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"referencetype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/referencetype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EACL,KAAK,qBAAqB,EAG3B,MAAM,wDAAwD,CAAA;AAK/D;;;;;;;;;GASG;AACH,qBAAa,2BAA4B,SAAQ,yBAAyB;IACxE;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CA8BrE"}
1
+ {"version":3,"file":"referencetype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/referencetype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EACL,KAAK,qBAAqB,EAG3B,MAAM,wDAAwD,CAAA;AAe/D,qBAAa,2BAA4B,SAAQ,yBAAyB;IAcxE,cAAc,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CA8BrE"}
@@ -1,46 +1,9 @@
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
- // import * as util from 'node:util'
14
2
  import { ElementStringRendererBase } from './element-renderer-base.js';
15
3
  import { ReferenceDataModel, ReferencedByDataModel, } from '../../doxygen/data-model/compounds/referencetype-dm.js';
16
4
  import { sanitizeAnonymousNamespace } from '../utils.js';
17
- // ----------------------------------------------------------------------------
18
- /**
19
- * Renderer for reference elements in documentation cross-references.
20
- *
21
- * @remarks
22
- * Handles the rendering of cross-reference elements that link to other
23
- * documented members, creating appropriate hyperlinks with proper
24
- * permalinks for navigation within the documentation.
25
- *
26
- * @public
27
- */
28
5
  export class ReferenceTypeStringRenderer extends ElementStringRendererBase {
29
- /**
30
- * Renders a reference element to a formatted string with hyperlinks.
31
- *
32
- * @remarks
33
- * Converts Doxygen reference elements into HTML anchor tags with
34
- * appropriate permalinks to the referenced members. Handles both
35
- * forward references and reverse references whilst sanitising
36
- * anonymous namespace names for display.
37
- *
38
- * @param element - The reference element to render
39
- * @param type - The rendering context type
40
- * @returns Formatted HTML string with hyperlink
41
- */
42
6
  renderToString(element, type) {
43
- // console.log(util.inspect(element, { compact: false, depth: 999 }))
44
7
  let text = '';
45
8
  if (element instanceof ReferencedByDataModel ||
46
9
  element instanceof ReferenceDataModel) {
@@ -59,5 +22,4 @@ export class ReferenceTypeStringRenderer extends ElementStringRendererBase {
59
22
  return text;
60
23
  }
61
24
  }
62
- // ----------------------------------------------------------------------------
63
25
  //# sourceMappingURL=referencetype.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"referencetype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/referencetype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,oCAAoC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EAEL,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,wDAAwD,CAAA;AAC/D,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AAExD,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,2BAA4B,SAAQ,yBAAyB;IACxE;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,OAA8B,EAAE,IAAY;QACzD,qEAAqE;QAErE,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IACE,OAAO,YAAY,qBAAqB;YACxC,OAAO,YAAY,kBAAkB,EACrC,CAAC;YACD,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;gBAClD,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,OAAO,EAAE,QAAQ;aAClB,CAAC,CAAA;YACF,MAAM,CAAC,eAAe,KAAK,SAAS,CAAC,CAAA;YACrC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CACtC,0BAA0B,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAC/C,IAAI,CACL,CAAA;YACD,IAAI,IAAI,YAAY,eAAe,KAAK,IAAI,MAAM,CAAA;QACpD,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,CAAC,IAAI,EACxB,oBAAoB,EACpB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACD,OAAO,EAAE,CAAA;QACX,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"referencetype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/referencetype.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAGhC,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EAEL,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,wDAAwD,CAAA;AAC/D,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AAcxD,MAAM,OAAO,2BAA4B,SAAQ,yBAAyB;IAcxE,cAAc,CAAC,OAA8B,EAAE,IAAY;QAGzD,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IACE,OAAO,YAAY,qBAAqB;YACxC,OAAO,YAAY,kBAAkB,EACrC,CAAC;YACD,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;gBAClD,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,OAAO,EAAE,QAAQ;aAClB,CAAC,CAAA;YACF,MAAM,CAAC,eAAe,KAAK,SAAS,CAAC,CAAA;YACrC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CACtC,0BAA0B,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAC/C,IAAI,CACL,CAAA;YACD,IAAI,IAAI,YAAY,eAAe,KAAK,IAAI,MAAM,CAAA;QACpD,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,CAAC,IAAI,EACxB,oBAAoB,EACpB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACD,OAAO,EAAE,CAAA;QACX,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;CACF"}
@@ -1,28 +1,6 @@
1
1
  import { ElementStringRendererBase } from './element-renderer-base.js';
2
2
  import type { AbstractRefTextType } from '../../doxygen/data-model/compounds/reftexttype-dm.js';
3
- /**
4
- * Renderer for Doxygen reference text elements with linking functionality.
5
- *
6
- * @remarks
7
- * Converts reference text elements into HTML anchor tags when a valid
8
- * permalink is available, otherwise renders as plain text. Provides
9
- * cross-reference functionality for Doxygen elements.
10
- *
11
- * @public
12
- */
13
3
  export declare class RefTextTypeStringRenderer extends ElementStringRendererBase {
14
- /**
15
- * Renders a reference text element to a formatted string with linking.
16
- *
17
- * @remarks
18
- * Generates an HTML anchor tag when a valid permalink exists for the
19
- * referenced element, otherwise renders the text content directly.
20
- * Logs warnings for unsupported attributes that are not yet implemented.
21
- *
22
- * @param element - The reference text element to render
23
- * @param type - The rendering context type
24
- * @returns The formatted HTML string with optional link
25
- */
26
4
  renderToString(element: AbstractRefTextType, type: string): string;
27
5
  }
28
6
  //# sourceMappingURL=reftexttype.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"reftexttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftexttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sDAAsD,CAAA;AAI/F;;;;;;;;;GASG;AACH,qBAAa,yBAA0B,SAAQ,yBAAyB;IACtE;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAkCnE"}
1
+ {"version":3,"file":"reftexttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftexttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sDAAsD,CAAA;AAc/F,qBAAa,yBAA0B,SAAQ,yBAAyB;IAatE,cAAc,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAkCnE"}
@@ -1,43 +1,6 @@
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
- // import assert from 'node:assert'
13
- // import * as util from 'node:util'
14
1
  import { ElementStringRendererBase } from './element-renderer-base.js';
15
- // ----------------------------------------------------------------------------
16
- /**
17
- * Renderer for Doxygen reference text elements with linking functionality.
18
- *
19
- * @remarks
20
- * Converts reference text elements into HTML anchor tags when a valid
21
- * permalink is available, otherwise renders as plain text. Provides
22
- * cross-reference functionality for Doxygen elements.
23
- *
24
- * @public
25
- */
26
2
  export class RefTextTypeStringRenderer extends ElementStringRendererBase {
27
- /**
28
- * Renders a reference text element to a formatted string with linking.
29
- *
30
- * @remarks
31
- * Generates an HTML anchor tag when a valid permalink exists for the
32
- * referenced element, otherwise renders the text content directly.
33
- * Logs warnings for unsupported attributes that are not yet implemented.
34
- *
35
- * @param element - The reference text element to render
36
- * @param type - The rendering context type
37
- * @returns The formatted HTML string with optional link
38
- */
39
3
  renderToString(element, type) {
40
- // console.log(util.inspect(element, { compact: false, depth: 999 }))
41
4
  if (element.external !== undefined) {
42
5
  console.error(element.elementName, 'attribute external not yet rendered in', this.constructor.name);
43
6
  }
@@ -59,5 +22,4 @@ export class RefTextTypeStringRenderer extends ElementStringRendererBase {
59
22
  return text;
60
23
  }
61
24
  }
62
- // ----------------------------------------------------------------------------
63
25
  //# sourceMappingURL=reftexttype.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"reftexttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftexttype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AAGtE,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,yBAA0B,SAAQ,yBAAyB;IACtE;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,OAA4B,EAAE,IAAY;QACvD,qEAAqE;QAErE,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,wCAAwC,EACxC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,uCAAuC,EACvC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QAED,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;YAC5C,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;QACtE,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,IAAI,IAAI,YAAY,SAAS,KAAK,OAAO,MAAM,CAAA;QACjD,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,OAAO,CAAA;QACjB,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"reftexttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftexttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AAetE,MAAM,OAAO,yBAA0B,SAAQ,yBAAyB;IAatE,cAAc,CAAC,OAA4B,EAAE,IAAY;QAGvD,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,wCAAwC,EACxC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,uCAAuC,EACvC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QAED,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;YAC5C,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;QACtE,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,IAAI,IAAI,YAAY,SAAS,KAAK,OAAO,MAAM,CAAA;QACjD,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,OAAO,CAAA;QACjB,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;CACF"}
@@ -1,28 +1,6 @@
1
1
  import { ElementLinesRendererBase } from './element-renderer-base.js';
2
2
  import type { AbstractRefType } from '../../doxygen/data-model/compounds/reftype-dm.js';
3
- /**
4
- * Renderer for reference type elements in documentation cross-references.
5
- *
6
- * @remarks
7
- * Handles the rendering of reference elements that link to other documented
8
- * entities, creating appropriate hyperlinks with permalinks when targets
9
- * are available. Used for cross-referencing between documentation elements.
10
- *
11
- * @public
12
- */
13
3
  export declare class RefTypeLinesRenderer extends ElementLinesRendererBase {
14
- /**
15
- * Renders a reference element to formatted output lines.
16
- *
17
- * @remarks
18
- * Converts Doxygen reference elements into HTML anchor tags with
19
- * appropriate permalinks to the referenced entities. Falls back to
20
- * plain text when no permalink is available for the target.
21
- *
22
- * @param element - The reference element to render
23
- * @param type - The rendering context type
24
- * @returns Array of formatted output lines
25
- */
26
4
  renderToLines(element: AbstractRefType, type: string): string[];
27
5
  }
28
6
  //# sourceMappingURL=reftype.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"reftype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kDAAkD,CAAA;AAIvF;;;;;;;;;GASG;AACH,qBAAa,oBAAqB,SAAQ,wBAAwB;IAChE;;;;;;;;;;;OAWG;IACM,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CA8BzE"}
1
+ {"version":3,"file":"reftype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kDAAkD,CAAA;AAcvF,qBAAa,oBAAqB,SAAQ,wBAAwB;IAavD,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CA8BzE"}
@@ -1,43 +1,6 @@
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
- // import assert from 'node:assert'
13
- // import * as util from 'node:util'
14
1
  import { ElementLinesRendererBase } from './element-renderer-base.js';
15
- // ----------------------------------------------------------------------------
16
- /**
17
- * Renderer for reference type elements in documentation cross-references.
18
- *
19
- * @remarks
20
- * Handles the rendering of reference elements that link to other documented
21
- * entities, creating appropriate hyperlinks with permalinks when targets
22
- * are available. Used for cross-referencing between documentation elements.
23
- *
24
- * @public
25
- */
26
2
  export class RefTypeLinesRenderer extends ElementLinesRendererBase {
27
- /**
28
- * Renders a reference element to formatted output lines.
29
- *
30
- * @remarks
31
- * Converts Doxygen reference elements into HTML anchor tags with
32
- * appropriate permalinks to the referenced entities. Falls back to
33
- * plain text when no permalink is available for the target.
34
- *
35
- * @param element - The reference element to render
36
- * @param type - The rendering context type
37
- * @returns Array of formatted output lines
38
- */
39
3
  renderToLines(element, type) {
40
- // console.log(util.inspect(element, { compact: false, depth: 999 }))
41
4
  if (element.prot !== undefined) {
42
5
  console.error(element.elementName, 'attribute prot not yet rendered in', this.constructor.name);
43
6
  }
@@ -56,5 +19,4 @@ export class RefTypeLinesRenderer extends ElementLinesRendererBase {
56
19
  return lines;
57
20
  }
58
21
  }
59
- // ----------------------------------------------------------------------------
60
22
  //# sourceMappingURL=reftype.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"reftype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAGrE,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,oBAAqB,SAAQ,wBAAwB;IAChE;;;;;;;;;;;OAWG;IACM,aAAa,CAAC,OAAwB,EAAE,IAAY;QAC3D,qEAAqE;QAErE,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,oCAAoC,EACpC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,sCAAsC,EACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;QACtE,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAChE,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,KAAK,CAAC,IAAI,CAAC,YAAY,SAAS,KAAK,OAAO,MAAM,CAAC,CAAA;QACrD,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrB,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"reftype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAerE,MAAM,OAAO,oBAAqB,SAAQ,wBAAwB;IAavD,aAAa,CAAC,OAAwB,EAAE,IAAY;QAG3D,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,oCAAoC,EACpC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,sCAAsC,EACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;QACtE,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAChE,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,KAAK,CAAC,IAAI,CAAC,YAAY,SAAS,KAAK,OAAO,MAAM,CAAC,CAAA;QACrD,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrB,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF"}
@@ -1,177 +1,26 @@
1
1
  import type { ElementLinesRendererBase, ElementStringRendererBase } from './element-renderer-base.js';
2
2
  import type { Workspace } from '../workspace.js';
3
3
  import type { DataModelElement } from '../../doxygen/data-model/types.js';
4
- /**
5
- * Central registry and coordinator for all rendering functionality.
6
- *
7
- * The Renderers class manages the registration and lookup of specialised
8
- * renderer objects that convert Doxygen data model elements into
9
- * Docusaurus-compatible Markdown output.
10
- *
11
- * @public
12
- */
13
4
  export declare class Renderers {
14
- /** Map of element types to their corresponding line-based renderers. */
15
5
  elementLinesRenderers: Map<string, ElementLinesRendererBase>;
16
- /** Map of element types to their corresponding string-based renderers. */
17
6
  elementStringRenderers: Map<string, ElementStringRendererBase>;
18
- /**
19
- * Registers all available renderers with the rendering system.
20
- *
21
- * Initialises and maps all specialised renderer instances to their
22
- * corresponding data model element types, enabling proper conversion
23
- * of XML elements to Markdown format.
24
- *
25
- * @param workspace - The workspace context containing configuration and data.
26
- */
27
7
  registerRenderers(workspace: Workspace): void;
28
- /**
29
- * Retrieves a line-based renderer for the specified element.
30
- *
31
- * @remarks
32
- * Searches through the element's class hierarchy to find a registered
33
- * line-based renderer. Uses prototype chain traversal to support
34
- * inheritance-based renderer selection for abstract types.
35
- *
36
- * @param element - The element object to find a renderer for
37
- * @returns The corresponding line-based renderer, or undefined if none found
38
- */
39
8
  getElementLinesRenderer(element: object): ElementLinesRendererBase | undefined;
40
- /**
41
- * Retrieves a string-based renderer for the specified element.
42
- *
43
- * @remarks
44
- * Searches through the element's class hierarchy to find a registered
45
- * string-based renderer. Uses prototype chain traversal to support
46
- * inheritance-based renderer selection for abstract types.
47
- *
48
- * @param element - The element object to find a renderer for
49
- * @returns The corresponding string-based renderer, or undefined if not found
50
- */
51
9
  getElementTextRenderer(element: object): ElementStringRendererBase | undefined;
52
- /**
53
- * Renders a string with appropriate escaping for the target format.
54
- *
55
- * @remarks
56
- * Applies format-specific character escaping to ensure proper rendering
57
- * in different output contexts. Handles HTML entity escaping for HTML
58
- * output and Markdown character escaping for Markdown output.
59
- *
60
- * @param element - The string to render and escape
61
- * @param type - The target format ('text', 'markdown', 'html')
62
- * @returns The properly escaped string for the target format
63
- */
64
10
  renderString(element: string, type: string): string;
65
- /**
66
- * Renders an array of elements to formatted output lines.
67
- *
68
- * @remarks
69
- * Processes each element in the array through the appropriate renderer
70
- * and concatenates the resulting lines. Handles undefined arrays
71
- * gracefully by returning empty arrays.
72
- *
73
- * @param elements - Array of elements to render, or undefined
74
- * @param type - The rendering context type
75
- * @returns Array of formatted output lines from all elements
76
- */
77
11
  renderElementsArrayToLines(elements: DataModelElement[] | undefined, type: string): string[];
78
- /**
79
- * Renders a single element or element array to formatted output lines.
80
- *
81
- * @remarks
82
- * Determines the appropriate renderer based on element type and delegates
83
- * rendering. Handles strings, arrays, and objects with fallback logic
84
- * between line and string renderers. Provides error handling for
85
- * unrecognised element types.
86
- *
87
- * @param element - The element to render (single, array, or undefined)
88
- * @param type - The rendering context type
89
- * @returns Array of formatted output lines
90
- */
91
12
  renderElementToLines(element: DataModelElement | DataModelElement[] | undefined, type: string): string[];
92
- /**
93
- * Renders an array of elements to a concatenated string.
94
- *
95
- * @remarks
96
- * Processes each element in the array through string rendering and
97
- * concatenates all results into a single string. Handles undefined
98
- * arrays by returning empty strings.
99
- *
100
- * @param elements - Array of elements to render, or undefined
101
- * @param type - The rendering context type
102
- * @returns Concatenated string from all rendered elements
103
- */
104
13
  renderElementsArrayToString(elements: DataModelElement[] | undefined, type: string): string;
105
- /**
106
- * Renders a single element or element array to a formatted string.
107
- *
108
- * @remarks
109
- * Determines the appropriate renderer based on element type and delegates
110
- * string rendering. Prioritises string renderers over line renderers
111
- * with fallback conversion. Handles strings, arrays, and objects with
112
- * comprehensive error handling.
113
- *
114
- * @param element - The element to render (single, array, or undefined)
115
- * @param type - The rendering context type
116
- * @returns The formatted string representation
117
- */
118
14
  renderElementToString(element: DataModelElement | DataModelElement[] | undefined, type: string): string;
119
- /**
120
- * Renders a member index item to formatted HTML table rows.
121
- *
122
- * @remarks
123
- * Generates HTML table rows for member documentation indices with
124
- * support for templates, types, names, and descriptions. Creates
125
- * structured layouts with appropriate CSS classes for consistent
126
- * member presentation.
127
- *
128
- * @param params - Object containing member index rendering parameters
129
- * @param params.template - Optional template text for member display
130
- * @param params.type - Optional type information for the member
131
- * @param params.name - The member name (required)
132
- * @param params.childrenLines - Optional description lines for the member
133
- * @returns Array of HTML table row strings
134
- */
135
15
  renderMembersIndexItemToHtmlLines({ template, type, name, childrenLines, }: {
136
16
  template?: string | undefined;
137
17
  type?: string | undefined;
138
18
  name: string;
139
19
  childrenLines?: string[] | undefined;
140
20
  }): string[];
141
- /**
142
- * Renders tree-structured data as HTML table with hierarchical display.
143
- *
144
- * @remarks
145
- * Converts tree node structures into formatted HTML tables with
146
- * predefined column layouts and CSS classes. Provides structured
147
- * presentation for hierarchical data with consistent table markup
148
- * and width-proportioned columns.
149
- *
150
- * @param params - Object containing tree table rendering parameters
151
- * @param params.contentLines - Array of HTML content lines for table rows
152
- * @returns Array of HTML table strings with wrapper markup
153
- */
154
21
  renderTreeTableToHtmlLines({ contentLines, }: {
155
22
  contentLines: string[];
156
23
  }): string[];
157
- /**
158
- * Renders individual tree table row with hierarchical styling and content.
159
- *
160
- * @remarks
161
- * Generates HTML table rows for tree structures with depth-based
162
- * indentation, icon support, and linked labels. Provides consistent
163
- * formatting for tree node presentation including descriptions and
164
- * visual hierarchy indicators.
165
- *
166
- * @param params - Object containing tree row rendering parameters
167
- * @param params.itemIconLetter - Optional icon character for the item
168
- * @param params.itemIconClass - Optional CSS class for icon styling
169
- * @param params.itemLabel - The display label for the tree item
170
- * @param params.itemLink - The URL link for the tree item
171
- * @param params.depth - The hierarchical depth level (0-based)
172
- * @param params.description - The descriptive text for the item
173
- * @returns Array of HTML table row strings
174
- */
175
24
  renderTreeTableRowToHtmlLines({ itemIconLetter, itemIconClass, itemLabel, itemLink, depth, description, }: {
176
25
  itemIconLetter?: string;
177
26
  itemIconClass?: string;
@@ -1 +1 @@
1
- {"version":3,"file":"renderers.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/renderers.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,4BAA4B,CAAA;AA8CnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAUhD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AAIzE;;;;;;;;GAQG;AACH,qBAAa,SAAS;IACpB,wEAAwE;IACxE,qBAAqB,wCAA8C;IAEnE,0EAA0E;IAC1E,sBAAsB,yCAA+C;IAErE;;;;;;;;OAQG;IACH,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IA6L7C;;;;;;;;;;OAUG;IACH,uBAAuB,CACrB,OAAO,EAAE,MAAM,GACd,wBAAwB,GAAG,SAAS;IAgBvC;;;;;;;;;;OAUG;IACH,sBAAsB,CACpB,OAAO,EAAE,MAAM,GACd,yBAAyB,GAAG,SAAS;IAoBxC;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAyBnD;;;;;;;;;;;OAWG;IACH,0BAA0B,CACxB,QAAQ,EAAE,gBAAgB,EAAE,GAAG,SAAS,EACxC,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;IAcX;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAClB,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,GAAG,SAAS,EAC1D,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;IA4CX;;;;;;;;;;;OAWG;IACH,2BAA2B,CACzB,QAAQ,EAAE,gBAAgB,EAAE,GAAG,SAAS,EACxC,IAAI,EAAE,MAAM,GACX,MAAM;IAaT;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,GAAG,SAAS,EAC1D,IAAI,EAAE,MAAM,GACX,MAAM;IA+CT;;;;;;;;;;;;;;;OAeG;IACH,iCAAiC,CAAC,EAChC,QAAQ,EACR,IAAI,EACJ,IAAI,EACJ,aAAa,GACd,EAAE;QACD,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC7B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACzB,IAAI,EAAE,MAAM,CAAA;QACZ,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;KACrC,GAAG,MAAM,EAAE;IA0DZ;;;;;;;;;;;;OAYG;IACH,0BAA0B,CAAC,EACzB,YAAY,GACb,EAAE;QACD,YAAY,EAAE,MAAM,EAAE,CAAA;KACvB,GAAG,MAAM,EAAE;IAeZ;;;;;;;;;;;;;;;;;OAiBG;IACH,6BAA6B,CAAC,EAC5B,cAAc,EACd,aAAa,EACb,SAAS,EACT,QAAQ,EACR,KAAK,EACL,WAAW,GACZ,EAAE;QACD,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;QACb,WAAW,EAAE,MAAM,CAAA;KACpB,GAAG,MAAM,EAAE;CAiCb"}
1
+ {"version":3,"file":"renderers.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/renderers.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,4BAA4B,CAAA;AA8CnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAUhD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AAiBzE,qBAAa,SAAS;IAEpB,qBAAqB,wCAA8C;IAGnE,sBAAsB,yCAA+C;IAWrE,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAiP7C,uBAAuB,CACrB,OAAO,EAAE,MAAM,GACd,wBAAwB,GAAG,SAAS;IA2BvC,sBAAsB,CACpB,OAAO,EAAE,MAAM,GACd,yBAAyB,GAAG,SAAS;IAgCxC,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAqCnD,0BAA0B,CACxB,QAAQ,EAAE,gBAAgB,EAAE,GAAG,SAAS,EACxC,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;IA6BX,oBAAoB,CAClB,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,GAAG,SAAS,EAC1D,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;IAiEX,2BAA2B,CACzB,QAAQ,EAAE,gBAAgB,EAAE,GAAG,SAAS,EACxC,IAAI,EAAE,MAAM,GACX,MAAM;IA0BT,qBAAqB,CACnB,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,GAAG,SAAS,EAC1D,IAAI,EAAE,MAAM,GACX,MAAM;IA+DT,iCAAiC,CAAC,EAChC,QAAQ,EACR,IAAI,EACJ,IAAI,EACJ,aAAa,GACd,EAAE;QACD,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC7B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACzB,IAAI,EAAE,MAAM,CAAA;QACZ,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;KACrC,GAAG,MAAM,EAAE;IAuEZ,0BAA0B,CAAC,EACzB,YAAY,GACb,EAAE;QACD,YAAY,EAAE,MAAM,EAAE,CAAA;KACvB,GAAG,MAAM,EAAE;IAiCZ,6BAA6B,CAAC,EAC5B,cAAc,EACd,aAAa,EACb,SAAS,EACT,QAAQ,EACR,KAAK,EACL,WAAW,GACZ,EAAE;QACD,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;QACb,WAAW,EAAE,MAAM,CAAA;KACpB,GAAG,MAAM,EAAE;CAiCb"}