@xpack/doxygen2docusaurus 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (350) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +2 -1
  3. package/bin/doxygen2docusaurus.js +1 -1
  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/descriptiontype.d.ts +0 -417
  17. package/dist/docusaurus/renderers/descriptiontype.d.ts.map +1 -1
  18. package/dist/docusaurus/renderers/descriptiontype.js +11 -555
  19. package/dist/docusaurus/renderers/descriptiontype.js.map +1 -1
  20. package/dist/docusaurus/renderers/docinternalstype.d.ts +0 -132
  21. package/dist/docusaurus/renderers/docinternalstype.d.ts.map +1 -1
  22. package/dist/docusaurus/renderers/docinternalstype.js +0 -156
  23. package/dist/docusaurus/renderers/docinternalstype.js.map +1 -1
  24. package/dist/docusaurus/renderers/doclisttype.d.ts +0 -22
  25. package/dist/docusaurus/renderers/doclisttype.d.ts.map +1 -1
  26. package/dist/docusaurus/renderers/doclisttype.js +0 -42
  27. package/dist/docusaurus/renderers/doclisttype.js.map +1 -1
  28. package/dist/docusaurus/renderers/doctabletype.d.ts +0 -88
  29. package/dist/docusaurus/renderers/doctabletype.d.ts.map +1 -1
  30. package/dist/docusaurus/renderers/doctabletype.js +1 -113
  31. package/dist/docusaurus/renderers/doctabletype.js.map +1 -1
  32. package/dist/docusaurus/renderers/doctitletype.d.ts +0 -22
  33. package/dist/docusaurus/renderers/doctitletype.d.ts.map +1 -1
  34. package/dist/docusaurus/renderers/doctitletype.js +0 -42
  35. package/dist/docusaurus/renderers/doctitletype.js.map +1 -1
  36. package/dist/docusaurus/renderers/docvariablelisttype.d.ts +0 -44
  37. package/dist/docusaurus/renderers/docvariablelisttype.d.ts.map +1 -1
  38. package/dist/docusaurus/renderers/docvariablelisttype.js +1 -69
  39. package/dist/docusaurus/renderers/docvariablelisttype.js.map +1 -1
  40. package/dist/docusaurus/renderers/docxrefsecttype.d.ts +0 -22
  41. package/dist/docusaurus/renderers/docxrefsecttype.d.ts.map +1 -1
  42. package/dist/docusaurus/renderers/docxrefsecttype.js +0 -38
  43. package/dist/docusaurus/renderers/docxrefsecttype.js.map +1 -1
  44. package/dist/docusaurus/renderers/element-renderer-base.d.ts +0 -74
  45. package/dist/docusaurus/renderers/element-renderer-base.d.ts.map +1 -1
  46. package/dist/docusaurus/renderers/element-renderer-base.js +0 -64
  47. package/dist/docusaurus/renderers/element-renderer-base.js.map +1 -1
  48. package/dist/docusaurus/renderers/inctype.d.ts +0 -23
  49. package/dist/docusaurus/renderers/inctype.d.ts.map +1 -1
  50. package/dist/docusaurus/renderers/inctype.js +0 -41
  51. package/dist/docusaurus/renderers/inctype.js.map +1 -1
  52. package/dist/docusaurus/renderers/linkedtexttype.d.ts +0 -22
  53. package/dist/docusaurus/renderers/linkedtexttype.d.ts.map +1 -1
  54. package/dist/docusaurus/renderers/linkedtexttype.js +0 -45
  55. package/dist/docusaurus/renderers/linkedtexttype.js.map +1 -1
  56. package/dist/docusaurus/renderers/listingtype.d.ts +0 -52
  57. package/dist/docusaurus/renderers/listingtype.d.ts.map +1 -1
  58. package/dist/docusaurus/renderers/listingtype.js +1 -88
  59. package/dist/docusaurus/renderers/listingtype.js.map +1 -1
  60. package/dist/docusaurus/renderers/paramtype.d.ts +0 -22
  61. package/dist/docusaurus/renderers/paramtype.d.ts.map +1 -1
  62. package/dist/docusaurus/renderers/paramtype.js +2 -51
  63. package/dist/docusaurus/renderers/paramtype.js.map +1 -1
  64. package/dist/docusaurus/renderers/referencetype.d.ts +0 -23
  65. package/dist/docusaurus/renderers/referencetype.d.ts.map +1 -1
  66. package/dist/docusaurus/renderers/referencetype.js +0 -38
  67. package/dist/docusaurus/renderers/referencetype.js.map +1 -1
  68. package/dist/docusaurus/renderers/reftexttype.d.ts +0 -22
  69. package/dist/docusaurus/renderers/reftexttype.d.ts.map +1 -1
  70. package/dist/docusaurus/renderers/reftexttype.js +0 -38
  71. package/dist/docusaurus/renderers/reftexttype.js.map +1 -1
  72. package/dist/docusaurus/renderers/reftype.d.ts +0 -22
  73. package/dist/docusaurus/renderers/reftype.d.ts.map +1 -1
  74. package/dist/docusaurus/renderers/reftype.js +0 -38
  75. package/dist/docusaurus/renderers/reftype.js.map +1 -1
  76. package/dist/docusaurus/renderers/renderers.d.ts +0 -151
  77. package/dist/docusaurus/renderers/renderers.d.ts.map +1 -1
  78. package/dist/docusaurus/renderers/renderers.js +4 -184
  79. package/dist/docusaurus/renderers/renderers.js.map +1 -1
  80. package/dist/docusaurus/renderers/substringtype.d.ts +0 -22
  81. package/dist/docusaurus/renderers/substringtype.d.ts.map +1 -1
  82. package/dist/docusaurus/renderers/substringtype.js +0 -39
  83. package/dist/docusaurus/renderers/substringtype.js.map +1 -1
  84. package/dist/docusaurus/renderers/tableofcontentstype.d.ts +0 -22
  85. package/dist/docusaurus/renderers/tableofcontentstype.d.ts.map +1 -1
  86. package/dist/docusaurus/renderers/tableofcontentstype.js +0 -39
  87. package/dist/docusaurus/renderers/tableofcontentstype.js.map +1 -1
  88. package/dist/docusaurus/types.d.ts +0 -110
  89. package/dist/docusaurus/types.d.ts.map +1 -1
  90. package/dist/docusaurus/types.js +0 -11
  91. package/dist/docusaurus/types.js.map +1 -1
  92. package/dist/docusaurus/utils.d.ts +0 -214
  93. package/dist/docusaurus/utils.d.ts.map +1 -1
  94. package/dist/docusaurus/utils.js +0 -296
  95. package/dist/docusaurus/utils.js.map +1 -1
  96. package/dist/docusaurus/view-model/classes-vm.d.ts +0 -137
  97. package/dist/docusaurus/view-model/classes-vm.d.ts.map +1 -1
  98. package/dist/docusaurus/view-model/classes-vm.js +9 -225
  99. package/dist/docusaurus/view-model/classes-vm.js.map +1 -1
  100. package/dist/docusaurus/view-model/collection-base.d.ts +0 -120
  101. package/dist/docusaurus/view-model/collection-base.d.ts.map +1 -1
  102. package/dist/docusaurus/view-model/collection-base.js +11 -101
  103. package/dist/docusaurus/view-model/collection-base.js.map +1 -1
  104. package/dist/docusaurus/view-model/compound-base-vm.d.ts +2 -147
  105. package/dist/docusaurus/view-model/compound-base-vm.d.ts.map +1 -1
  106. package/dist/docusaurus/view-model/compound-base-vm.js +47 -225
  107. package/dist/docusaurus/view-model/compound-base-vm.js.map +1 -1
  108. package/dist/docusaurus/view-model/concepts-vm.d.ts +26 -0
  109. package/dist/docusaurus/view-model/concepts-vm.d.ts.map +1 -0
  110. package/dist/docusaurus/view-model/concepts-vm.js +329 -0
  111. package/dist/docusaurus/view-model/concepts-vm.js.map +1 -0
  112. package/dist/docusaurus/view-model/description-anchors.d.ts +0 -58
  113. package/dist/docusaurus/view-model/description-anchors.d.ts.map +1 -1
  114. package/dist/docusaurus/view-model/description-anchors.js +0 -71
  115. package/dist/docusaurus/view-model/description-anchors.js.map +1 -1
  116. package/dist/docusaurus/view-model/files-and-folders-vm.d.ts +0 -247
  117. package/dist/docusaurus/view-model/files-and-folders-vm.d.ts.map +1 -1
  118. package/dist/docusaurus/view-model/files-and-folders-vm.js +61 -353
  119. package/dist/docusaurus/view-model/files-and-folders-vm.js.map +1 -1
  120. package/dist/docusaurus/view-model/groups-vm.d.ts +0 -148
  121. package/dist/docusaurus/view-model/groups-vm.d.ts.map +1 -1
  122. package/dist/docusaurus/view-model/groups-vm.js +2 -223
  123. package/dist/docusaurus/view-model/groups-vm.js.map +1 -1
  124. package/dist/docusaurus/view-model/members-vm.d.ts +0 -552
  125. package/dist/docusaurus/view-model/members-vm.d.ts.map +1 -1
  126. package/dist/docusaurus/view-model/members-vm.js +17 -702
  127. package/dist/docusaurus/view-model/members-vm.js.map +1 -1
  128. package/dist/docusaurus/view-model/namespaces-vm.d.ts +4 -199
  129. package/dist/docusaurus/view-model/namespaces-vm.d.ts.map +1 -1
  130. package/dist/docusaurus/view-model/namespaces-vm.js +79 -284
  131. package/dist/docusaurus/view-model/namespaces-vm.js.map +1 -1
  132. package/dist/docusaurus/view-model/options.d.ts +0 -43
  133. package/dist/docusaurus/view-model/options.d.ts.map +1 -1
  134. package/dist/docusaurus/view-model/options.js +0 -57
  135. package/dist/docusaurus/view-model/options.js.map +1 -1
  136. package/dist/docusaurus/view-model/pages-vm.d.ts +0 -115
  137. package/dist/docusaurus/view-model/pages-vm.d.ts.map +1 -1
  138. package/dist/docusaurus/view-model/pages-vm.js +0 -162
  139. package/dist/docusaurus/view-model/pages-vm.js.map +1 -1
  140. package/dist/docusaurus/view-model/tree-entries-vm.d.ts +8 -142
  141. package/dist/docusaurus/view-model/tree-entries-vm.d.ts.map +1 -1
  142. package/dist/docusaurus/view-model/tree-entries-vm.js +54 -174
  143. package/dist/docusaurus/view-model/tree-entries-vm.js.map +1 -1
  144. package/dist/docusaurus/view-model/view-model.d.ts +0 -125
  145. package/dist/docusaurus/view-model/view-model.d.ts.map +1 -1
  146. package/dist/docusaurus/view-model/view-model.js +20 -182
  147. package/dist/docusaurus/view-model/view-model.js.map +1 -1
  148. package/dist/docusaurus/workspace.d.ts +1 -126
  149. package/dist/docusaurus/workspace.d.ts.map +1 -1
  150. package/dist/docusaurus/workspace.js +8 -221
  151. package/dist/docusaurus/workspace.js.map +1 -1
  152. package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts +5 -492
  153. package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts.map +1 -1
  154. package/dist/doxygen/data-model/compounds/compounddef-dm.js +23 -672
  155. package/dist/doxygen/data-model/compounds/compounddef-dm.js.map +1 -1
  156. package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts +0 -129
  157. package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts.map +1 -1
  158. package/dist/doxygen/data-model/compounds/compoundreftype-dm.js +1 -145
  159. package/dist/doxygen/data-model/compounds/compoundreftype-dm.js.map +1 -1
  160. package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts +104 -2848
  161. package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts.map +1 -1
  162. package/dist/doxygen/data-model/compounds/descriptiontype-dm.js +73 -3975
  163. package/dist/doxygen/data-model/compounds/descriptiontype-dm.js.map +1 -1
  164. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts +0 -165
  165. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts.map +1 -1
  166. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js +0 -229
  167. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js.map +1 -1
  168. package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts +0 -70
  169. package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts.map +1 -1
  170. package/dist/doxygen/data-model/compounds/doxygentype-dm.js +0 -105
  171. package/dist/doxygen/data-model/compounds/doxygentype-dm.js.map +1 -1
  172. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts +0 -84
  173. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts.map +1 -1
  174. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js +1 -122
  175. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js.map +1 -1
  176. package/dist/doxygen/data-model/compounds/inctype-dm.d.ts +0 -116
  177. package/dist/doxygen/data-model/compounds/inctype-dm.d.ts.map +1 -1
  178. package/dist/doxygen/data-model/compounds/inctype-dm.js +3 -155
  179. package/dist/doxygen/data-model/compounds/inctype-dm.js.map +1 -1
  180. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts +3 -138
  181. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts.map +1 -1
  182. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js +5 -180
  183. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js.map +1 -1
  184. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts +0 -76
  185. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts.map +1 -1
  186. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js +0 -107
  187. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js.map +1 -1
  188. package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts +0 -162
  189. package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts.map +1 -1
  190. package/dist/doxygen/data-model/compounds/locationtype-dm.js +4 -203
  191. package/dist/doxygen/data-model/compounds/locationtype-dm.js.map +1 -1
  192. package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts +2 -443
  193. package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts.map +1 -1
  194. package/dist/doxygen/data-model/compounds/memberdeftype-dm.js +19 -475
  195. package/dist/doxygen/data-model/compounds/memberdeftype-dm.js.map +1 -1
  196. package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts +0 -141
  197. package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts.map +1 -1
  198. package/dist/doxygen/data-model/compounds/memberreftype-dm.js +0 -176
  199. package/dist/doxygen/data-model/compounds/memberreftype-dm.js.map +1 -1
  200. package/dist/doxygen/data-model/compounds/membertype-dm.d.ts +0 -101
  201. package/dist/doxygen/data-model/compounds/membertype-dm.d.ts.map +1 -1
  202. package/dist/doxygen/data-model/compounds/membertype-dm.js +0 -115
  203. package/dist/doxygen/data-model/compounds/membertype-dm.js.map +1 -1
  204. package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts +0 -164
  205. package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts.map +1 -1
  206. package/dist/doxygen/data-model/compounds/paramtype-dm.js +0 -208
  207. package/dist/doxygen/data-model/compounds/paramtype-dm.js.map +1 -1
  208. package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts +0 -139
  209. package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts.map +1 -1
  210. package/dist/doxygen/data-model/compounds/referencetype-dm.js +2 -175
  211. package/dist/doxygen/data-model/compounds/referencetype-dm.js.map +1 -1
  212. package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts +0 -120
  213. package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts.map +1 -1
  214. package/dist/doxygen/data-model/compounds/reftexttype-dm.js +2 -141
  215. package/dist/doxygen/data-model/compounds/reftexttype-dm.js.map +1 -1
  216. package/dist/doxygen/data-model/compounds/reftype-dm.d.ts +0 -268
  217. package/dist/doxygen/data-model/compounds/reftype-dm.d.ts.map +1 -1
  218. package/dist/doxygen/data-model/compounds/reftype-dm.js +4 -326
  219. package/dist/doxygen/data-model/compounds/reftype-dm.js.map +1 -1
  220. package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts +0 -105
  221. package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts.map +1 -1
  222. package/dist/doxygen/data-model/compounds/reimplementtype-dm.js +1 -139
  223. package/dist/doxygen/data-model/compounds/reimplementtype-dm.js.map +1 -1
  224. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts +0 -168
  225. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts.map +1 -1
  226. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js +0 -209
  227. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js.map +1 -1
  228. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts +0 -267
  229. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts.map +1 -1
  230. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js +0 -354
  231. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js.map +1 -1
  232. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts +0 -66
  233. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts.map +1 -1
  234. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js +0 -97
  235. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js.map +1 -1
  236. package/dist/doxygen/data-model/data-model.d.ts +0 -149
  237. package/dist/doxygen/data-model/data-model.d.ts.map +1 -1
  238. package/dist/doxygen/data-model/data-model.js +4 -197
  239. package/dist/doxygen/data-model/data-model.js.map +1 -1
  240. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts +0 -115
  241. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts.map +1 -1
  242. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js +4 -129
  243. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js.map +1 -1
  244. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts +0 -87
  245. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts.map +1 -1
  246. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js +0 -118
  247. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js.map +1 -1
  248. package/dist/doxygen/data-model/doxygen-xml-parser.d.ts +0 -253
  249. package/dist/doxygen/data-model/doxygen-xml-parser.d.ts.map +1 -1
  250. package/dist/doxygen/data-model/doxygen-xml-parser.js +0 -291
  251. package/dist/doxygen/data-model/doxygen-xml-parser.js.map +1 -1
  252. package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts +0 -98
  253. package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts.map +1 -1
  254. package/dist/doxygen/data-model/index/indexcompoundtype-dm.js +2 -122
  255. package/dist/doxygen/data-model/index/indexcompoundtype-dm.js.map +1 -1
  256. package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts +0 -82
  257. package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts.map +1 -1
  258. package/dist/doxygen/data-model/index/indexdoxygentype-dm.js +0 -114
  259. package/dist/doxygen/data-model/index/indexdoxygentype-dm.js.map +1 -1
  260. package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts +0 -85
  261. package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts.map +1 -1
  262. package/dist/doxygen/data-model/index/indexmembertype-dm.js +1 -107
  263. package/dist/doxygen/data-model/index/indexmembertype-dm.js.map +1 -1
  264. package/dist/doxygen/data-model/types.d.ts +0 -104
  265. package/dist/doxygen/data-model/types.d.ts.map +1 -1
  266. package/dist/doxygen/data-model/types.js +0 -52
  267. package/dist/doxygen/data-model/types.js.map +1 -1
  268. package/dist/index.d.ts +4 -16
  269. package/dist/index.d.ts.map +1 -1
  270. package/dist/index.js +4 -42
  271. package/dist/index.js.map +1 -1
  272. package/package.json +45 -51
  273. package/src/cli/main.ts +122 -0
  274. package/src/docusaurus/cli-options.ts +560 -0
  275. package/src/docusaurus/generator.ts +788 -0
  276. package/src/docusaurus/renderers/descriptiontype.ts +1299 -0
  277. package/src/docusaurus/renderers/docinternalstype.ts +354 -0
  278. package/src/docusaurus/renderers/doclisttype.ts +134 -0
  279. package/src/docusaurus/renderers/doctabletype.ts +220 -0
  280. package/src/docusaurus/renderers/doctitletype.ts +77 -0
  281. package/src/docusaurus/renderers/docvariablelisttype.ts +123 -0
  282. package/src/docusaurus/renderers/docxrefsecttype.ts +84 -0
  283. package/src/docusaurus/renderers/element-renderer-base.ts +112 -0
  284. package/src/docusaurus/renderers/inctype.ts +75 -0
  285. package/src/docusaurus/renderers/linkedtexttype.ts +64 -0
  286. package/src/docusaurus/renderers/listingtype.ts +235 -0
  287. package/src/docusaurus/renderers/paramtype.ts +116 -0
  288. package/src/docusaurus/renderers/referencetype.ts +83 -0
  289. package/src/docusaurus/renderers/reftexttype.ts +81 -0
  290. package/src/docusaurus/renderers/reftype.ts +77 -0
  291. package/src/docusaurus/renderers/renderers.ts +756 -0
  292. package/src/docusaurus/renderers/substringtype.ts +53 -0
  293. package/src/docusaurus/renderers/tableofcontentstype.ts +74 -0
  294. package/src/docusaurus/types.ts +187 -0
  295. package/src/docusaurus/utils.ts +409 -0
  296. package/src/docusaurus/view-model/README.md +12 -0
  297. package/src/docusaurus/view-model/classes-vm.ts +1088 -0
  298. package/src/docusaurus/view-model/collection-base.ts +352 -0
  299. package/src/docusaurus/view-model/compound-base-vm.ts +1340 -0
  300. package/src/docusaurus/view-model/concepts-vm.ts +719 -0
  301. package/src/docusaurus/view-model/description-anchors.ts +107 -0
  302. package/src/docusaurus/view-model/files-and-folders-vm.ts +1293 -0
  303. package/src/docusaurus/view-model/groups-vm.ts +548 -0
  304. package/src/docusaurus/view-model/members-vm.ts +1943 -0
  305. package/src/docusaurus/view-model/namespaces-vm.ts +1018 -0
  306. package/src/docusaurus/view-model/options.ts +95 -0
  307. package/src/docusaurus/view-model/pages-vm.ts +342 -0
  308. package/src/docusaurus/view-model/tree-entries-vm.ts +376 -0
  309. package/src/docusaurus/view-model/view-model.ts +513 -0
  310. package/src/docusaurus/workspace.ts +588 -0
  311. package/src/doxygen/data-model/README.md +13 -0
  312. package/src/doxygen/data-model/compounds/compounddef-dm.ts +1156 -0
  313. package/src/doxygen/data-model/compounds/compoundreftype-dm.ts +266 -0
  314. package/src/doxygen/data-model/compounds/descriptiontype-dm.ts +10107 -0
  315. package/src/doxygen/data-model/compounds/docvarlistentrytype-dm.ts +354 -0
  316. package/src/doxygen/data-model/compounds/doxygentype-dm.ts +187 -0
  317. package/src/doxygen/data-model/compounds/enumvaluetype-dm.ts +218 -0
  318. package/src/doxygen/data-model/compounds/inctype-dm.ts +217 -0
  319. package/src/doxygen/data-model/compounds/linkedtexttype-dm.ts +288 -0
  320. package/src/doxygen/data-model/compounds/listofallmemberstype-dm.ts +160 -0
  321. package/src/doxygen/data-model/compounds/locationtype-dm.ts +284 -0
  322. package/src/doxygen/data-model/compounds/memberdeftype-dm.ts +874 -0
  323. package/src/doxygen/data-model/compounds/memberreftype-dm.ts +270 -0
  324. package/src/doxygen/data-model/compounds/membertype-dm.ts +239 -0
  325. package/src/doxygen/data-model/compounds/paramtype-dm.ts +302 -0
  326. package/src/doxygen/data-model/compounds/referencetype-dm.ts +248 -0
  327. package/src/doxygen/data-model/compounds/reftexttype-dm.ts +234 -0
  328. package/src/doxygen/data-model/compounds/reftype-dm.ts +430 -0
  329. package/src/doxygen/data-model/compounds/reimplementtype-dm.ts +201 -0
  330. package/src/doxygen/data-model/compounds/sectiondeftype-dm.ts +330 -0
  331. package/src/doxygen/data-model/compounds/tableofcontentstype-dm.ts +563 -0
  332. package/src/doxygen/data-model/compounds/templateparamlisttype-dm.ts +150 -0
  333. package/src/doxygen/data-model/data-model.ts +377 -0
  334. package/src/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.ts +271 -0
  335. package/src/doxygen/data-model/doxyfile/doxyfiletype-dm.ts +200 -0
  336. package/src/doxygen/data-model/doxygen-xml-parser.ts +522 -0
  337. package/src/doxygen/data-model/index/indexcompoundtype-dm.ts +256 -0
  338. package/src/doxygen/data-model/index/indexdoxygentype-dm.ts +196 -0
  339. package/src/doxygen/data-model/index/indexmembertype-dm.ts +230 -0
  340. package/src/doxygen/data-model/types.ts +175 -0
  341. package/src/doxygen/data-model/xsds/README.md +6 -0
  342. package/src/doxygen/data-model/xsds/compound.xsd +1699 -0
  343. package/src/doxygen/data-model/xsds/doxyfile.xsd +355 -0
  344. package/src/doxygen/data-model/xsds/index.xsd +72 -0
  345. package/src/doxygen/data-model/xsds/xml.xsd +23 -0
  346. package/src/index.ts +261 -0
  347. package/src/tsconfig.json +10 -0
  348. package/dist/doxygen2docusaurus.d.ts +0 -4774
  349. package/dist/tsconfig.tsbuildinfo +0 -1
  350. package/dist/tsdoc-metadata.json +0 -11
@@ -1,127 +1,17 @@
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 util from 'node:util';
14
3
  import { AbstractDataModelBase } from '../types.js';
15
- // ----------------------------------------------------------------------------
16
- // <xsd:complexType name="referenceType" mixed="true">
17
- // <xsd:attribute name="refid" type="xsd:string" />
18
- // <xsd:attribute name="compoundref" type="xsd:string" use="optional" />
19
- // <xsd:attribute name="startline" type="xsd:integer" />
20
- // <xsd:attribute name="endline" type="xsd:integer" />
21
- // </xsd:complexType>
22
- /**
23
- * Abstract base class for reference type data models.
24
- *
25
- * @remarks
26
- * Represents the foundational structure for reference relationship elements
27
- * within Doxygen XML documentation, corresponding to the referenceType
28
- * complex type in the XML schema. This class manages bidirectional reference
29
- * relationships between documented entities, capturing both the descriptive
30
- * text and precise location information including line number ranges. The
31
- * reference system enables comprehensive dependency tracking and cross-
32
- * referencing capabilities, essential for understanding code relationships
33
- * and generating accurate documentation navigation structures.
34
- *
35
- * @public
36
- */
37
4
  export class AbstractReferenceType extends AbstractDataModelBase {
38
- /**
39
- * The descriptive text content for this reference relationship.
40
- *
41
- * @remarks
42
- * Contains the textual description of the reference relationship, typically
43
- * including the name or signature of the referenced entity. This text
44
- * provides human-readable context about the relationship and is used for
45
- * display purposes within the generated documentation. Note that this
46
- * property is not explicitly defined in the XML schema DTD but appears
47
- * in practice within reference elements.
48
- */
49
- // WARNING: not in DTD?
50
5
  text = '';
51
- /**
52
- * The unique reference identifier for the referenced entity.
53
- *
54
- * @remarks
55
- * Mandatory attribute that provides a unique identifier for the entity
56
- * being referenced. This identifier enables precise linking and cross-
57
- * referencing between documentation elements, allowing navigation to the
58
- * detailed documentation of the referenced item within the documentation
59
- * structure.
60
- */
61
6
  refid = '';
62
- /**
63
- * The starting line number where the reference occurs.
64
- *
65
- * @remarks
66
- * Specifies the line number in the source code where the reference
67
- * relationship begins. This location information enables precise source
68
- * code navigation and helps establish the exact context of the reference
69
- * within the original source files. Note that this attribute may be missing
70
- * in some reference elements despite being defined as mandatory in the
71
- * XML schema.
72
- */
73
- // WARNING: may be missing
74
7
  startline;
75
- /**
76
- * The ending line number where the reference concludes.
77
- *
78
- * @remarks
79
- * Specifies the line number in the source code where the reference
80
- * relationship ends. Combined with the starting line, this provides a
81
- * complete range for the reference occurrence, enabling precise source
82
- * code highlighting and navigation capabilities. Note that this attribute
83
- * may be missing in some reference elements despite being defined as
84
- * mandatory in the XML schema.
85
- */
86
- // WARNING: may be missing
87
8
  endline;
88
- /**
89
- * The compound reference identifier for the containing entity.
90
- *
91
- * @remarks
92
- * Optional attribute that provides the identifier of the compound entity
93
- * (such as a class or namespace) that contains the referenced item. This
94
- * additional context enables more precise navigation and helps establish
95
- * the hierarchical relationship between the referencing and referenced
96
- * entities within the documentation structure.
97
- */
98
9
  compoundref;
99
- /**
100
- * Constructs a new abstract reference type from XML data.
101
- *
102
- * @param xml - The Doxygen XML parser instance
103
- * @param element - The XML element containing reference relationship data
104
- * @param elementName - The expected XML element name
105
- *
106
- * @remarks
107
- * Parses the provided XML element to construct a complete reference
108
- * relationship data model. The parsing process extracts the textual content
109
- * from the element and processes all defined attributes including the
110
- * mandatory refid attribute, line number information, and optional compound
111
- * reference data. Validation ensures that the reference identifier is
112
- * present, maintaining the integrity of the reference relationship
113
- * documentation.
114
- */
115
10
  constructor(xml, element, elementName) {
116
11
  super(elementName);
117
- // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
118
- // ------------------------------------------------------------------------
119
- // Process elements.
120
12
  assert(xml.isInnerElementText(element, elementName));
121
13
  this.text = xml.getInnerElementText(element, elementName);
122
14
  assert(this.text.length > 0);
123
- // ------------------------------------------------------------------------
124
- // Process attributes.
125
15
  assert(xml.hasAttributes(element));
126
16
  const attributesNames = xml.getAttributesNames(element);
127
17
  for (const attributeName of attributesNames) {
@@ -129,10 +19,10 @@ export class AbstractReferenceType extends AbstractDataModelBase {
129
19
  this.refid = xml.getAttributeStringValue(element, '@_refid');
130
20
  }
131
21
  else if (attributeName === '@_startline') {
132
- this.startline = Number(xml.getAttributeNumberValue(element, '@_startline'));
22
+ this.startline = xml.getAttributeNumberValue(element, '@_startline');
133
23
  }
134
24
  else if (attributeName === '@_endline') {
135
- this.endline = Number(xml.getAttributeNumberValue(element, '@_endline'));
25
+ this.endline = xml.getAttributeNumberValue(element, '@_endline');
136
26
  }
137
27
  else if (attributeName === '@_compoundref') {
138
28
  this.compoundref = xml.getAttributeStringValue(element, '@_compoundref');
@@ -143,79 +33,16 @@ export class AbstractReferenceType extends AbstractDataModelBase {
143
33
  }
144
34
  }
145
35
  assert(this.refid.length > 0);
146
- // ------------------------------------------------------------------------
147
- // console.log(util.inspect(this, { compact: false, depth: 999 }))
148
36
  }
149
37
  }
150
- // ----------------------------------------------------------------------------
151
- // <xsd:element name="references" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
152
- // <xsd:element name="referencedby" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
153
- /**
154
- * Data model for reference relationship elements.
155
- *
156
- * @remarks
157
- * Represents a forward reference relationship within Doxygen XML
158
- * documentation, corresponding to the references XML element. This class
159
- * manages relationships where the current entity references or depends upon
160
- * another documented entity. The relationship captures both the descriptive
161
- * information and precise location data, enabling comprehensive dependency
162
- * tracking and navigation capabilities. Forward references help document
163
- * how entities use or depend on other components within the codebase.
164
- *
165
- * @public
166
- */
167
38
  export class ReferenceDataModel extends AbstractReferenceType {
168
- /**
169
- * Constructs a new reference relationship data model from XML.
170
- *
171
- * @param xml - The Doxygen XML parser instance
172
- * @param element - The XML element containing reference relationship data
173
- *
174
- * @remarks
175
- * Creates a complete forward reference relationship data model by parsing
176
- * the provided XML element. This constructor delegates to the parent class
177
- * to handle all standard parsing operations for the references element type,
178
- * establishing the forward dependency relationship between the current
179
- * entity and the referenced component.
180
- */
181
39
  constructor(xml, element) {
182
- // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
183
40
  super(xml, element, 'references');
184
41
  }
185
42
  }
186
- /**
187
- * Data model for referenced-by relationship elements.
188
- *
189
- * @remarks
190
- * Represents a reverse reference relationship within Doxygen XML
191
- * documentation, corresponding to the referencedby XML element. This class
192
- * manages relationships where the current entity is referenced or used by
193
- * another documented entity. The relationship provides bidirectional
194
- * dependency information, enabling comprehensive understanding of how
195
- * entities are utilised throughout the codebase. Referenced-by relationships
196
- * are essential for impact analysis and understanding the scope of changes
197
- * when modifying documented components.
198
- *
199
- * @public
200
- */
201
43
  export class ReferencedByDataModel extends AbstractReferenceType {
202
- /**
203
- * Constructs a new referenced-by relationship data model from XML.
204
- *
205
- * @param xml - The Doxygen XML parser instance
206
- * @param element - The XML element containing referenced-by relationship data
207
- *
208
- * @remarks
209
- * Creates a complete reverse reference relationship data model by parsing
210
- * the provided XML element. This constructor delegates to the parent class
211
- * to handle all standard parsing operations for the referencedby element
212
- * type, establishing the reverse dependency relationship indicating how
213
- * other entities utilise the current component.
214
- */
215
44
  constructor(xml, element) {
216
- // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
217
45
  super(xml, element, 'referencedby');
218
46
  }
219
47
  }
220
- // ----------------------------------------------------------------------------
221
48
  //# sourceMappingURL=referencetype-dm.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"referencetype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/referencetype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,sDAAsD;AACtD,qDAAqD;AACrD,0EAA0E;AAC1E,0DAA0D;AAC1D,wDAAwD;AACxD,qBAAqB;AAErB;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAgB,qBAAsB,SAAQ,qBAAqB;IACvE;;;;;;;;;;OAUG;IACH,uBAAuB;IACvB,IAAI,GAAG,EAAE,CAAA;IAET;;;;;;;;;OASG;IACH,KAAK,GAAG,EAAE,CAAA;IAEV;;;;;;;;;;OAUG;IACH,0BAA0B;IAC1B,SAAS,CAAoB;IAE7B;;;;;;;;;;OAUG;IACH,0BAA0B;IAC1B,OAAO,CAAoB;IAE3B;;;;;;;;;OASG;IACH,WAAW,CAAqB;IAEhC;;;;;;;;;;;;;;;OAeG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAEzD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAC3E,sBAAsB;QAEtB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAElC,MAAM,eAAe,GAAG,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACvD,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,aAAa,KAAK,aAAa,EAAE,CAAC;gBAC3C,IAAI,CAAC,SAAS,GAAG,MAAM,CACrB,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,aAAa,CAAC,CACpD,CAAA;YACH,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;YAC1E,CAAC;iBAAM,IAAI,aAAa,KAAK,eAAe,EAAE,CAAC;gBAC7C,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAA;YAC1E,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;gBACpE,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,aAAa,EAC3B,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE7B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,6FAA6F;AAC7F,+FAA+F;AAE/F;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IAC3D;;;;;;;;;;;;OAYG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,qBAAsB,SAAQ,qBAAqB;IAC9D;;;;;;;;;;;;OAYG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;IACrC,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"referencetype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/referencetype-dm.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA0BnD,MAAM,OAAgB,qBAAsB,SAAQ,qBAAqB;IAavE,IAAI,GAAG,EAAE,CAAA;IAYT,KAAK,GAAG,EAAE,CAAA;IAcV,SAAS,CAAoB;IAc7B,OAAO,CAAoB;IAY3B,WAAW,CAAqB;IAkBhC,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAOlB,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAEzD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAK5B,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAElC,MAAM,eAAe,GAAG,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACvD,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,aAAa,KAAK,aAAa,EAAE,CAAC;gBAC3C,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;YACtE,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,CAAC;iBAAM,IAAI,aAAa,KAAK,eAAe,EAAE,CAAC;gBAC7C,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAA;YAC1E,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;gBACpE,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,aAAa,EAC3B,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAK/B,CAAC;CACF;AAqBD,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IAc3D,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAiBD,MAAM,OAAO,qBAAsB,SAAQ,qBAAqB;IAc9D,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;IACrC,CAAC;CACF"}
@@ -1,135 +1,15 @@
1
1
  import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
2
2
  import { AbstractDataModelBase } from '../types.js';
3
- /**
4
- * Abstract base class for reference text type data models.
5
- *
6
- * @remarks
7
- * Represents the foundational structure for reference text elements within
8
- * Doxygen XML documentation, corresponding to the refTextType complex type
9
- * in the XML schema. This class manages textual references to documented
10
- * entities with enhanced metadata including reference classification, external
11
- * linking capabilities, and tooltip information. Reference text elements
12
- * provide rich linking functionality within documentation content, enabling
13
- * precise navigation to related entities whilst maintaining readability and
14
- * contextual information for enhanced user experience.
15
- *
16
- * @public
17
- */
18
3
  export declare abstract class AbstractRefTextType extends AbstractDataModelBase {
19
- /**
20
- * The textual content of the reference.
21
- *
22
- * @remarks
23
- * Mandatory element containing the display text for the reference, passed
24
- * as the element's text content. This text provides the human-readable
25
- * representation of the referenced entity and is typically the name or
26
- * identifier that appears in the documentation content where the reference
27
- * is embedded.
28
- */
29
4
  text: string;
30
- /**
31
- * The unique reference identifier for the referenced entity.
32
- *
33
- * @remarks
34
- * Mandatory attribute that provides a unique identifier for the referenced
35
- * entity within the Doxygen documentation system. This identifier enables
36
- * precise linking and cross-referencing between documentation elements,
37
- * allowing navigation to the detailed documentation of the referenced item.
38
- */
39
5
  refid: string;
40
- /**
41
- * The kind classification of the referenced entity.
42
- *
43
- * @remarks
44
- * Mandatory attribute specifying the type of entity being referenced,
45
- * according to the DoxRefKind enumeration. This classification determines
46
- * how the reference is processed and presented, distinguishing between
47
- * compound entities (such as classes or namespaces) and member entities
48
- * (such as functions or variables).
49
- */
50
6
  kindref: string;
51
- /**
52
- * The external reference location for cross-project linking.
53
- *
54
- * @remarks
55
- * Optional attribute that specifies an external location for the referenced
56
- * entity, enabling cross-project or cross-documentation linking. When
57
- * present, this attribute indicates that the referenced entity is defined
58
- * in external documentation, requiring special handling for link generation
59
- * and navigation.
60
- */
61
7
  external?: string | undefined;
62
- /**
63
- * The tooltip text for enhanced reference information.
64
- *
65
- * @remarks
66
- * Optional attribute that provides additional contextual information to be
67
- * displayed as a tooltip when interacting with the reference. This tooltip
68
- * enhances the user experience by providing immediate context about the
69
- * referenced entity without requiring navigation to the target documentation.
70
- */
71
8
  tooltip?: string | undefined;
72
- /**
73
- * Constructs a new abstract reference text type from XML data.
74
- *
75
- * @param xml - The Doxygen XML parser instance
76
- * @param element - The XML element containing reference text data
77
- * @param elementName - The expected XML element name
78
- *
79
- * @remarks
80
- * Parses the provided XML element to construct a complete reference text
81
- * data model. The parsing process extracts the textual content from the
82
- * element and processes all defined attributes including the mandatory
83
- * refid and kindref attributes, as well as optional external and tooltip
84
- * attributes. Validation ensures that required elements and attributes are
85
- * present and conform to the expected XML schema structure.
86
- */
87
9
  constructor(xml: DoxygenXmlParser, element: object, elementName: string);
88
10
  }
89
- /**
90
- * Type definition for Doxygen reference kind classifications.
91
- *
92
- * @remarks
93
- * Represents the enumeration of valid reference kinds within Doxygen XML
94
- * documentation, corresponding to the DoxRefKind simple type in the XML
95
- * schema. This type distinguishes between compound entities (such as classes,
96
- * structs, interfaces, and namespaces) and member entities (such as functions,
97
- * variables, enumerations, and typedefs). The classification affects how
98
- * references are processed, linked, and presented in the generated
99
- * documentation structure.
100
- *
101
- * @public
102
- */
103
11
  export type DoxRefKind = 'compound' | 'member';
104
- /**
105
- * Data model for reference text elements.
106
- *
107
- * @remarks
108
- * Represents a specific textual reference within Doxygen XML documentation,
109
- * corresponding to the ref XML element. This class manages rich textual
110
- * references that appear within documentation content, providing enhanced
111
- * linking capabilities with metadata support. Reference text elements enable
112
- * seamless navigation between related documentation entities whilst
113
- * maintaining the flow and readability of the containing text. The class
114
- * supports both internal and external references, with optional tooltip
115
- * information for improved user experience.
116
- *
117
- * @public
118
- */
119
12
  export declare class RefTextDataModel extends AbstractRefTextType {
120
- /**
121
- * Constructs a new reference text data model from XML.
122
- *
123
- * @param xml - The Doxygen XML parser instance
124
- * @param element - The XML element containing reference text data
125
- *
126
- * @remarks
127
- * Creates a complete reference text data model by parsing the provided XML
128
- * element. This constructor delegates to the parent class to handle all
129
- * standard parsing operations for the ref element type, establishing the
130
- * textual reference with full metadata support for enhanced linking and
131
- * navigation capabilities.
132
- */
133
13
  constructor(xml: DoxygenXmlParser, element: object);
134
14
  }
135
15
  //# sourceMappingURL=reftexttype-dm.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"reftexttype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftexttype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAenD;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,mBAAoB,SAAQ,qBAAqB;IACrE;;;;;;;;;OASG;IACH,IAAI,SAAK;IAET;;;;;;;;OAQG;IACH,KAAK,SAAK;IAEV;;;;;;;;;OASG;IACH,OAAO,SAAK;IAEZ;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE7B;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE5B;;;;;;;;;;;;;;OAcG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA8CxE;AAWD;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAA;AAM9C;;;;;;;;;;;;;;GAcG;AACH,qBAAa,gBAAiB,SAAQ,mBAAmB;IACvD;;;;;;;;;;;;OAYG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
1
+ {"version":3,"file":"reftexttype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftexttype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA8BnD,8BAAsB,mBAAoB,SAAQ,qBAAqB;IAWrE,IAAI,SAAK;IAWT,KAAK,SAAK;IAYV,OAAO,SAAK;IAYZ,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAW7B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;gBAiBhB,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA8CxE;AAyBD,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAA;AAqB9C,qBAAa,gBAAiB,SAAQ,mBAAmB;gBAc3C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
@@ -1,122 +1,17 @@
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 util from 'node:util';
14
3
  import { AbstractDataModelBase } from '../types.js';
15
- // ----------------------------------------------------------------------------
16
- // <xsd:complexType name="refTextType">
17
- // <xsd:simpleContent>
18
- // <xsd:extension base="xsd:string">
19
- // <xsd:attribute name="refid" type="xsd:string" />
20
- // <xsd:attribute name="kindref" type="DoxRefKind" />
21
- // <xsd:attribute name="external" type="xsd:string" use="optional"/>
22
- // <xsd:attribute name="tooltip" type="xsd:string" use="optional"/>
23
- // </xsd:extension>
24
- // </xsd:simpleContent>
25
- // </xsd:complexType>
26
- /**
27
- * Abstract base class for reference text type data models.
28
- *
29
- * @remarks
30
- * Represents the foundational structure for reference text elements within
31
- * Doxygen XML documentation, corresponding to the refTextType complex type
32
- * in the XML schema. This class manages textual references to documented
33
- * entities with enhanced metadata including reference classification, external
34
- * linking capabilities, and tooltip information. Reference text elements
35
- * provide rich linking functionality within documentation content, enabling
36
- * precise navigation to related entities whilst maintaining readability and
37
- * contextual information for enhanced user experience.
38
- *
39
- * @public
40
- */
41
4
  export class AbstractRefTextType extends AbstractDataModelBase {
42
- /**
43
- * The textual content of the reference.
44
- *
45
- * @remarks
46
- * Mandatory element containing the display text for the reference, passed
47
- * as the element's text content. This text provides the human-readable
48
- * representation of the referenced entity and is typically the name or
49
- * identifier that appears in the documentation content where the reference
50
- * is embedded.
51
- */
52
- text = ''; // The name of the reference, passed as element text.
53
- /**
54
- * The unique reference identifier for the referenced entity.
55
- *
56
- * @remarks
57
- * Mandatory attribute that provides a unique identifier for the referenced
58
- * entity within the Doxygen documentation system. This identifier enables
59
- * precise linking and cross-referencing between documentation elements,
60
- * allowing navigation to the detailed documentation of the referenced item.
61
- */
5
+ text = '';
62
6
  refid = '';
63
- /**
64
- * The kind classification of the referenced entity.
65
- *
66
- * @remarks
67
- * Mandatory attribute specifying the type of entity being referenced,
68
- * according to the DoxRefKind enumeration. This classification determines
69
- * how the reference is processed and presented, distinguishing between
70
- * compound entities (such as classes or namespaces) and member entities
71
- * (such as functions or variables).
72
- */
73
- kindref = ''; // DoxRefKind
74
- /**
75
- * The external reference location for cross-project linking.
76
- *
77
- * @remarks
78
- * Optional attribute that specifies an external location for the referenced
79
- * entity, enabling cross-project or cross-documentation linking. When
80
- * present, this attribute indicates that the referenced entity is defined
81
- * in external documentation, requiring special handling for link generation
82
- * and navigation.
83
- */
7
+ kindref = '';
84
8
  external;
85
- /**
86
- * The tooltip text for enhanced reference information.
87
- *
88
- * @remarks
89
- * Optional attribute that provides additional contextual information to be
90
- * displayed as a tooltip when interacting with the reference. This tooltip
91
- * enhances the user experience by providing immediate context about the
92
- * referenced entity without requiring navigation to the target documentation.
93
- */
94
9
  tooltip;
95
- /**
96
- * Constructs a new abstract reference text type from XML data.
97
- *
98
- * @param xml - The Doxygen XML parser instance
99
- * @param element - The XML element containing reference text data
100
- * @param elementName - The expected XML element name
101
- *
102
- * @remarks
103
- * Parses the provided XML element to construct a complete reference text
104
- * data model. The parsing process extracts the textual content from the
105
- * element and processes all defined attributes including the mandatory
106
- * refid and kindref attributes, as well as optional external and tooltip
107
- * attributes. Validation ensures that required elements and attributes are
108
- * present and conform to the expected XML schema structure.
109
- */
110
10
  constructor(xml, element, elementName) {
111
11
  super(elementName);
112
- // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
113
- // ------------------------------------------------------------------------
114
- // Process elements.
115
12
  assert(xml.isInnerElementText(element, elementName));
116
13
  this.text = xml.getInnerElementText(element, elementName);
117
14
  assert(this.text.length > 0);
118
- // ------------------------------------------------------------------------
119
- // Process attributes.
120
15
  assert(xml.hasAttributes(element));
121
16
  const attributesNames = xml.getAttributesNames(element);
122
17
  for (const attributeName of attributesNames) {
@@ -139,45 +34,11 @@ export class AbstractRefTextType extends AbstractDataModelBase {
139
34
  }
140
35
  assert(this.refid.length > 0);
141
36
  assert(this.kindref.length > 0);
142
- // ------------------------------------------------------------------------
143
- // console.log(util.inspect(this, { compact: false, depth: 999 }))
144
37
  }
145
38
  }
146
- // ----------------------------------------------------------------------------
147
- // <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="unbounded" />
148
- /**
149
- * Data model for reference text elements.
150
- *
151
- * @remarks
152
- * Represents a specific textual reference within Doxygen XML documentation,
153
- * corresponding to the ref XML element. This class manages rich textual
154
- * references that appear within documentation content, providing enhanced
155
- * linking capabilities with metadata support. Reference text elements enable
156
- * seamless navigation between related documentation entities whilst
157
- * maintaining the flow and readability of the containing text. The class
158
- * supports both internal and external references, with optional tooltip
159
- * information for improved user experience.
160
- *
161
- * @public
162
- */
163
39
  export class RefTextDataModel extends AbstractRefTextType {
164
- /**
165
- * Constructs a new reference text data model from XML.
166
- *
167
- * @param xml - The Doxygen XML parser instance
168
- * @param element - The XML element containing reference text data
169
- *
170
- * @remarks
171
- * Creates a complete reference text data model by parsing the provided XML
172
- * element. This constructor delegates to the parent class to handle all
173
- * standard parsing operations for the ref element type, establishing the
174
- * textual reference with full metadata support for enhanced linking and
175
- * navigation capabilities.
176
- */
177
40
  constructor(xml, element) {
178
- // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
179
41
  super(xml, element, 'ref');
180
42
  }
181
43
  }
182
- // ----------------------------------------------------------------------------
183
44
  //# sourceMappingURL=reftexttype-dm.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"reftexttype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftexttype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,uCAAuC;AACvC,wBAAwB;AACxB,wCAAwC;AACxC,wDAAwD;AACxD,0DAA0D;AAC1D,yEAAyE;AACzE,wEAAwE;AACxE,uBAAuB;AACvB,yBAAyB;AACzB,qBAAqB;AAErB;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAgB,mBAAoB,SAAQ,qBAAqB;IACrE;;;;;;;;;OASG;IACH,IAAI,GAAG,EAAE,CAAA,CAAC,qDAAqD;IAE/D;;;;;;;;OAQG;IACH,KAAK,GAAG,EAAE,CAAA;IAEV;;;;;;;;;OASG;IACH,OAAO,GAAG,EAAE,CAAA,CAAC,aAAa;IAE1B;;;;;;;;;OASG;IACH,QAAQ,CAAqB;IAE7B;;;;;;;;OAQG;IACH,OAAO,CAAqB;IAE5B;;;;;;;;;;;;;;OAcG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAEzD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAC3E,sBAAsB;QAEtB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAElC,MAAM,eAAe,GAAG,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACvD,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,CAAC;iBAAM,IAAI,aAAa,KAAK,YAAY,EAAE,CAAC;gBAC1C,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;YACpE,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;gBACpE,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,aAAa,EAC3B,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC7B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE/B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AA2BD,+EAA+E;AAE/E,oFAAoF;AAEpF;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,gBAAiB,SAAQ,mBAAmB;IACvD;;;;;;;;;;;;OAYG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IAC5B,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"reftexttype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftexttype-dm.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA8BnD,MAAM,OAAgB,mBAAoB,SAAQ,qBAAqB;IAWrE,IAAI,GAAG,EAAE,CAAA;IAWT,KAAK,GAAG,EAAE,CAAA;IAYV,OAAO,GAAG,EAAE,CAAA;IAYZ,QAAQ,CAAqB;IAW7B,OAAO,CAAqB;IAiB5B,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAOlB,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAEzD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAK5B,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAElC,MAAM,eAAe,GAAG,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACvD,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,CAAC;iBAAM,IAAI,aAAa,KAAK,YAAY,EAAE,CAAC;gBAC1C,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;YACpE,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;gBACpE,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,aAAa,EAC3B,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC7B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAKjC,CAAC;CACF;AA8CD,MAAM,OAAO,gBAAiB,SAAQ,mBAAmB;IAcvD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IAC5B,CAAC;CACF"}