@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
@@ -2,163 +2,29 @@ import { Class } from './classes-vm.js';
2
2
  import { EnumValue, Member } from './members-vm.js';
3
3
  import { Namespace } from './namespaces-vm.js';
4
4
  import type { File } from './files-and-folders-vm.js';
5
- /**
6
- * Base class for tree entry objects used in hierarchical navigation.
7
- *
8
- * @remarks
9
- * Provides common functionality for entries that appear in tree-like
10
- * navigation structures, including index pages and hierarchical listings.
11
- * Handles name formatting, link generation, and sorting criteria.
12
- *
13
- * @public
14
- */
5
+ import { Concept } from './concepts-vm.js';
15
6
  export declare class TreeEntryBase {
16
- /**
17
- * The short name shown in the left part of index lines.
18
- *
19
- * @remarks
20
- * Brief display name used for compact listings and navigation
21
- * structures where space is limited.
22
- */
23
7
  name: string;
24
- /**
25
- * The full name used internally as the secondary sort criteria.
26
- *
27
- * @remarks
28
- * Complete qualified name used for precise sorting when multiple
29
- * entries have the same short name.
30
- */
31
8
  longName: string;
32
- /**
33
- * The internal identifier used to compute the permalink.
34
- *
35
- * @remarks
36
- * Unique identifier that corresponds to the Doxygen compound or
37
- * member ID for generating navigation links.
38
- */
39
9
  id: string;
40
- /**
41
- * The compound or member kind.
42
- *
43
- * @remarks
44
- * Indicates the type of documentation element this entry represents.
45
- * Examples include: 'class', 'struct', 'union', 'namespace', 'function',
46
- * 'variable', 'typedef', 'enum', 'enumvalue'.
47
- */
48
10
  kind: string;
49
- /**
50
- * Kind label displayed outside the link.
51
- *
52
- * @remarks
53
- * Human-readable type description shown in index listings to help
54
- * users identify the nature of the linked element.
55
- */
56
11
  linkKind: string;
57
- /**
58
- * The name of the linked target object.
59
- *
60
- * @remarks
61
- * Display name used as the clickable text in navigation links,
62
- * typically formatted for user presentation.
63
- */
64
12
  linkName: string;
65
- /**
66
- * The short name of the linked target object for comparison with name.
67
- *
68
- * @remarks
69
- * Simplified name used for determining when the entry name differs
70
- * from the link target name, enabling conditional display logic.
71
- */
72
13
  comparableLinkName: string;
73
- /**
74
- * The URL of the target object, including the anchor.
75
- *
76
- * @remarks
77
- * Complete permalink to the documentation page for this entry,
78
- * including any necessary anchor fragments for precise navigation.
79
- */
80
14
  permalink?: string | undefined;
81
- /**
82
- * Creates a new tree entry from a compound or member object.
83
- *
84
- * @remarks
85
- * Initialises the tree entry by extracting relevant information from
86
- * the provided documentation object, setting up names, kinds, and
87
- * navigation properties based on the object type.
88
- *
89
- * @param entry - The documentation object to create an entry for
90
- */
91
- constructor(entry: Class | Namespace | Member | EnumValue);
15
+ grouptPermalink?: string | undefined;
16
+ constructor(entry: Class | Namespace | Concept | Member | EnumValue);
92
17
  }
93
- /**
94
- * Tree entry specifically for class-type compounds in hierarchical views.
95
- *
96
- * @remarks
97
- * Extends the base tree entry functionality with class-specific formatting
98
- * and link generation. Handles proper display names and permalinks for
99
- * classes, structs, and unions in navigation structures.
100
- *
101
- * @public
102
- */
103
18
  export declare class ClassTreeEntry extends TreeEntryBase {
104
- /**
105
- * Creates a new class tree entry.
106
- *
107
- * @remarks
108
- * Initialises the tree entry with class-specific information including
109
- * the full class name and appropriate link formatting for display
110
- * in hierarchical navigation structures.
111
- *
112
- * @param entry - The source entry object
113
- * @param clazz - The class object providing context
114
- */
115
19
  constructor(entry: Class | Member | EnumValue, clazz: Class);
116
20
  }
117
- /**
118
- * Tree entry specifically for namespace compounds in hierarchical views.
119
- *
120
- * @remarks
121
- * Extends the base tree entry functionality with namespace-specific
122
- * formatting and link generation. Handles anonymous namespace sanitisation
123
- * and proper display in navigation structures.
124
- *
125
- * @public
126
- */
127
21
  export declare class NamespaceTreeEntry extends TreeEntryBase {
128
- /**
129
- * Creates a new namespace tree entry.
130
- *
131
- * @remarks
132
- * Initialises the tree entry with namespace-specific information,
133
- * including handling of anonymous namespaces and proper link
134
- * formatting for hierarchical display.
135
- *
136
- * @param entry - The source entry object
137
- * @param namespace - The namespace object providing context
138
- */
139
- constructor(entry: Namespace | Class | Member | EnumValue, namespace: Namespace);
22
+ constructor(entry: Namespace | Concept | Class | Member | EnumValue, namespace: Namespace);
140
23
  }
141
- /**
142
- * Tree entry specifically for file compounds in hierarchical views.
143
- *
144
- * @remarks
145
- * Extends the base tree entry functionality with file-specific formatting
146
- * and link generation. Uses relative file paths for display and navigation
147
- * in file-based documentation structures.
148
- *
149
- * @public
150
- */
151
24
  export declare class FileTreeEntry extends TreeEntryBase {
152
- /**
153
- * Creates a new file tree entry.
154
- *
155
- * @remarks
156
- * Initialises the tree entry with file-specific information using
157
- * the relative file path for display purposes in navigation structures.
158
- *
159
- * @param entry - The source entry object
160
- * @param file - The file object providing context
161
- */
162
- constructor(entry: Namespace | Class | Member | EnumValue, file: File);
25
+ constructor(entry: Namespace | Concept | Class | Member | EnumValue, file: File);
26
+ }
27
+ export declare class ConceptEntry extends TreeEntryBase {
28
+ constructor(entry: Concept);
163
29
  }
164
30
  //# sourceMappingURL=tree-entries-vm.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"tree-entries-vm.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/tree-entries-vm.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAA;AAKrD;;;;;;;;;GASG;AACH,qBAAa,aAAa;IACxB;;;;;;OAMG;IACH,IAAI,SAAQ;IAEZ;;;;;;OAMG;IACH,QAAQ,SAAQ;IAEhB;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;;;;OAOG;IACH,IAAI,SAAQ;IAEZ;;;;;;OAMG;IACH,QAAQ,SAAK;IAEb;;;;;;OAMG;IACH,QAAQ,SAAQ;IAEhB;;;;;;OAMG;IACH,kBAAkB,SAAK;IAEvB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE9B;;;;;;;;;OASG;gBACS,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS;CA0E1D;AAED;;;;;;;;;GASG;AACH,qBAAa,cAAe,SAAQ,aAAa;IAC/C;;;;;;;;;;OAUG;gBACS,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,KAAK;CAa5D;AAED;;;;;;;;;GASG;AACH,qBAAa,kBAAmB,SAAQ,aAAa;IACnD;;;;;;;;;;OAUG;gBAED,KAAK,EAAE,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,SAAS,EAC7C,SAAS,EAAE,SAAS;CAUvB;AAED;;;;;;;;;GASG;AACH,qBAAa,aAAc,SAAQ,aAAa;IAC9C;;;;;;;;;OASG;gBACS,KAAK,EAAE,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI;CAStE"}
1
+ {"version":3,"file":"tree-entries-vm.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/tree-entries-vm.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAA;AAErD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAc1C,qBAAa,aAAa;IAQxB,IAAI,SAAQ;IASZ,QAAQ,SAAQ;IAShB,EAAE,EAAE,MAAM,CAAA;IAUV,IAAI,SAAQ;IASZ,QAAQ,SAAK;IASb,QAAQ,SAAQ;IAShB,kBAAkB,SAAK;IASvB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAS9B,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;gBAYxB,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS;CAsFpE;AAYD,qBAAa,cAAe,SAAQ,aAAa;gBAYnC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,KAAK;CAiB5D;AAYD,qBAAa,kBAAmB,SAAQ,aAAa;gBAajD,KAAK,EAAE,SAAS,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,SAAS,EACvD,SAAS,EAAE,SAAS;CAevB;AAYD,qBAAa,aAAc,SAAQ,aAAa;gBAY5C,KAAK,EAAE,SAAS,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,SAAS,EACvD,IAAI,EAAE,IAAI;CAeb;AAYD,qBAAa,YAAa,SAAQ,aAAa;gBAWjC,KAAK,EAAE,OAAO;CAiB3B"}
@@ -1,144 +1,63 @@
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 { Class } from './classes-vm.js';
13
2
  import { EnumValue, Member } from './members-vm.js';
14
3
  import { Namespace } from './namespaces-vm.js';
15
4
  import { sanitizeAnonymousNamespace } from '../utils.js';
16
- // ----------------------------------------------------------------------------
17
- /**
18
- * Base class for tree entry objects used in hierarchical navigation.
19
- *
20
- * @remarks
21
- * Provides common functionality for entries that appear in tree-like
22
- * navigation structures, including index pages and hierarchical listings.
23
- * Handles name formatting, link generation, and sorting criteria.
24
- *
25
- * @public
26
- */
5
+ import { Concept } from './concepts-vm.js';
27
6
  export class TreeEntryBase {
28
- /**
29
- * The short name shown in the left part of index lines.
30
- *
31
- * @remarks
32
- * Brief display name used for compact listings and navigation
33
- * structures where space is limited.
34
- */
35
7
  name = '???';
36
- /**
37
- * The full name used internally as the secondary sort criteria.
38
- *
39
- * @remarks
40
- * Complete qualified name used for precise sorting when multiple
41
- * entries have the same short name.
42
- */
43
8
  longName = '???';
44
- /**
45
- * The internal identifier used to compute the permalink.
46
- *
47
- * @remarks
48
- * Unique identifier that corresponds to the Doxygen compound or
49
- * member ID for generating navigation links.
50
- */
51
9
  id;
52
- /**
53
- * The compound or member kind.
54
- *
55
- * @remarks
56
- * Indicates the type of documentation element this entry represents.
57
- * Examples include: 'class', 'struct', 'union', 'namespace', 'function',
58
- * 'variable', 'typedef', 'enum', 'enumvalue'.
59
- */
60
10
  kind = '???';
61
- /**
62
- * Kind label displayed outside the link.
63
- *
64
- * @remarks
65
- * Human-readable type description shown in index listings to help
66
- * users identify the nature of the linked element.
67
- */
68
11
  linkKind = '';
69
- /**
70
- * The name of the linked target object.
71
- *
72
- * @remarks
73
- * Display name used as the clickable text in navigation links,
74
- * typically formatted for user presentation.
75
- */
76
12
  linkName = '???';
77
- /**
78
- * The short name of the linked target object for comparison with name.
79
- *
80
- * @remarks
81
- * Simplified name used for determining when the entry name differs
82
- * from the link target name, enabling conditional display logic.
83
- */
84
13
  comparableLinkName = '';
85
- /**
86
- * The URL of the target object, including the anchor.
87
- *
88
- * @remarks
89
- * Complete permalink to the documentation page for this entry,
90
- * including any necessary anchor fragments for precise navigation.
91
- */
92
14
  permalink;
93
- /**
94
- * Creates a new tree entry from a compound or member object.
95
- *
96
- * @remarks
97
- * Initialises the tree entry by extracting relevant information from
98
- * the provided documentation object, setting up names, kinds, and
99
- * navigation properties based on the object type.
100
- *
101
- * @param entry - The documentation object to create an entry for
102
- */
15
+ grouptPermalink;
103
16
  constructor(entry) {
17
+ this.id = entry.id;
104
18
  if (entry instanceof Class) {
105
- const { id, collection, treeEntryName, fullyQualifiedName, kind } = entry;
106
- this.id = id;
107
- // this.name = entry.unqualifiedName
19
+ const { collection, treeEntryName, fullyQualifiedName, kind } = entry;
108
20
  this.name = collection.workspace.renderString(treeEntryName, 'html');
109
21
  this.longName = fullyQualifiedName;
110
- // console.log(this.name, ' | ', entry.indexName,
111
- // entry.unqualifiedName, entry.fullyQualifiedName, entry.compoundName,
112
- // entry.classFullName)
113
- this.kind = kind; // class, struct, union
22
+ this.kind = kind;
114
23
  this.linkKind = kind;
115
24
  this.linkName = fullyQualifiedName;
116
25
  this.permalink = collection.workspace.getPermalink({
117
- refid: id,
26
+ refid: this.id,
118
27
  kindref: 'compound',
119
28
  });
120
29
  }
121
30
  else if (entry instanceof Namespace) {
122
- const { id, treeEntryName, unqualifiedName, kind, collection } = entry;
123
- this.id = id;
31
+ const { treeEntryName, unqualifiedName, kind, collection } = entry;
32
+ this.name = treeEntryName;
33
+ this.longName = unqualifiedName;
34
+ this.kind = kind;
35
+ this.linkKind = kind;
36
+ this.linkName = treeEntryName;
37
+ this.permalink = collection.workspace.getPermalink({
38
+ refid: this.id,
39
+ kindref: 'compound',
40
+ });
41
+ }
42
+ else if (entry instanceof Concept) {
43
+ const { treeEntryName, unqualifiedName, kind, collection } = entry;
124
44
  this.name = treeEntryName;
125
45
  this.longName = unqualifiedName;
126
- this.kind = kind; // namespace
46
+ this.kind = kind;
127
47
  this.linkKind = kind;
128
48
  this.linkName = treeEntryName;
129
49
  this.permalink = collection.workspace.getPermalink({
130
- refid: id,
50
+ refid: this.id,
131
51
  kindref: 'compound',
132
52
  });
133
53
  }
134
54
  else if (entry instanceof Member) {
135
- const { id, name, qualifiedName, kind, section } = entry;
136
- this.id = id;
55
+ const { name, qualifiedName, kind, section } = entry;
137
56
  this.name = name;
138
57
  this.longName = qualifiedName ?? '???';
139
58
  this.kind = kind;
140
59
  this.permalink = section.compound.collection.workspace.getPermalink({
141
- refid: id,
60
+ refid: this.id,
142
61
  kindref: 'member',
143
62
  });
144
63
  if (this.kind === 'function') {
@@ -146,114 +65,75 @@ export class TreeEntryBase {
146
65
  }
147
66
  }
148
67
  else if (entry instanceof EnumValue) {
149
- const { id, name, member } = entry;
150
- this.id = id;
68
+ const { name, member } = entry;
151
69
  this.name = name;
152
70
  this.longName = name;
153
71
  this.kind = 'enumvalue';
154
72
  this.permalink =
155
73
  member.section.compound.collection.workspace.getPermalink({
156
- refid: id,
74
+ refid: this.id,
157
75
  kindref: 'member',
158
76
  });
159
77
  }
160
78
  else {
161
79
  this.id = '???';
162
- // Fallback for unknown object types.
163
80
  console.error('object type', typeof entry, 'not supported in', this.constructor.name);
164
81
  }
165
82
  }
166
83
  }
167
- /**
168
- * Tree entry specifically for class-type compounds in hierarchical views.
169
- *
170
- * @remarks
171
- * Extends the base tree entry functionality with class-specific formatting
172
- * and link generation. Handles proper display names and permalinks for
173
- * classes, structs, and unions in navigation structures.
174
- *
175
- * @public
176
- */
177
84
  export class ClassTreeEntry extends TreeEntryBase {
178
- /**
179
- * Creates a new class tree entry.
180
- *
181
- * @remarks
182
- * Initialises the tree entry with class-specific information including
183
- * the full class name and appropriate link formatting for display
184
- * in hierarchical navigation structures.
185
- *
186
- * @param entry - The source entry object
187
- * @param clazz - The class object providing context
188
- */
189
85
  constructor(entry, clazz) {
190
86
  super(entry);
191
87
  const { kind, classFullName, collection, treeEntryName } = clazz;
192
88
  this.linkKind = kind;
193
89
  this.linkName = classFullName;
194
90
  this.comparableLinkName = collection.workspace.renderString(treeEntryName, 'html');
195
- // console.log(this)
91
+ this.grouptPermalink = collection.workspace.getPermalink({
92
+ refid: clazz.id,
93
+ kindref: 'compound',
94
+ });
196
95
  }
197
96
  }
198
- /**
199
- * Tree entry specifically for namespace compounds in hierarchical views.
200
- *
201
- * @remarks
202
- * Extends the base tree entry functionality with namespace-specific
203
- * formatting and link generation. Handles anonymous namespace sanitisation
204
- * and proper display in navigation structures.
205
- *
206
- * @public
207
- */
208
97
  export class NamespaceTreeEntry extends TreeEntryBase {
209
- /**
210
- * Creates a new namespace tree entry.
211
- *
212
- * @remarks
213
- * Initialises the tree entry with namespace-specific information,
214
- * including handling of anonymous namespaces and proper link
215
- * formatting for hierarchical display.
216
- *
217
- * @param entry - The source entry object
218
- * @param namespace - The namespace object providing context
219
- */
220
98
  constructor(entry, namespace) {
221
99
  super(entry);
222
100
  this.linkKind = 'namespace';
223
101
  this.linkName = sanitizeAnonymousNamespace(namespace.compoundName);
224
102
  const { treeEntryName } = namespace;
225
103
  this.comparableLinkName = treeEntryName;
226
- // console.log(this)
104
+ this.grouptPermalink = namespace.collection.workspace.getPermalink({
105
+ refid: namespace.id,
106
+ kindref: 'compound',
107
+ });
227
108
  }
228
109
  }
229
- /**
230
- * Tree entry specifically for file compounds in hierarchical views.
231
- *
232
- * @remarks
233
- * Extends the base tree entry functionality with file-specific formatting
234
- * and link generation. Uses relative file paths for display and navigation
235
- * in file-based documentation structures.
236
- *
237
- * @public
238
- */
239
110
  export class FileTreeEntry extends TreeEntryBase {
240
- /**
241
- * Creates a new file tree entry.
242
- *
243
- * @remarks
244
- * Initialises the tree entry with file-specific information using
245
- * the relative file path for display purposes in navigation structures.
246
- *
247
- * @param entry - The source entry object
248
- * @param file - The file object providing context
249
- */
250
111
  constructor(entry, file) {
251
112
  super(entry);
252
113
  this.linkKind = 'file';
253
114
  const { relativePath } = file;
254
115
  this.linkName = relativePath;
255
- // console.log(this)
116
+ this.grouptPermalink = file.collection.workspace.getPermalink({
117
+ refid: file.id,
118
+ kindref: 'compound',
119
+ });
120
+ }
121
+ }
122
+ export class ConceptEntry extends TreeEntryBase {
123
+ constructor(entry) {
124
+ super(entry);
125
+ if (entry.parent !== undefined) {
126
+ this.linkKind = 'namespace';
127
+ this.linkName = entry.parent.compoundName;
128
+ this.grouptPermalink = entry.collection.workspace.getPermalink({
129
+ refid: entry.parent.id,
130
+ kindref: 'compound',
131
+ });
132
+ }
133
+ else {
134
+ this.linkKind = 'top';
135
+ this.linkName = 'namespace';
136
+ }
256
137
  }
257
138
  }
258
- // ----------------------------------------------------------------------------
259
139
  //# sourceMappingURL=tree-entries-vm.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"tree-entries-vm.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/tree-entries-vm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AAExD,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,aAAa;IACxB;;;;;;OAMG;IACH,IAAI,GAAG,KAAK,CAAA;IAEZ;;;;;;OAMG;IACH,QAAQ,GAAG,KAAK,CAAA;IAEhB;;;;;;OAMG;IACH,EAAE,CAAQ;IAEV;;;;;;;OAOG;IACH,IAAI,GAAG,KAAK,CAAA;IAEZ;;;;;;OAMG;IACH,QAAQ,GAAG,EAAE,CAAA;IAEb;;;;;;OAMG;IACH,QAAQ,GAAG,KAAK,CAAA;IAEhB;;;;;;OAMG;IACH,kBAAkB,GAAG,EAAE,CAAA;IAEvB;;;;;;OAMG;IACH,SAAS,CAAqB;IAE9B;;;;;;;;;OASG;IACH,YAAY,KAA6C;QACvD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,aAAa,EAAE,kBAAkB,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;YACzE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;YAEZ,oCAAoC;YACpC,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;YACpE,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAA;YAClC,sDAAsD;YACtD,uEAAuE;YACvE,uBAAuB;YAEvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA,CAAC,uBAAuB;YAExC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YACpB,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAA;YAElC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBACjD,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,UAAU;aACpB,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YACtC,MAAM,EAAE,EAAE,EAAE,aAAa,EAAE,eAAe,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAK,CAAA;YACtE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;YACZ,IAAI,CAAC,IAAI,GAAG,aAAa,CAAA;YACzB,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAA;YAE/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA,CAAC,YAAY;YAE7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YACpB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAA;YAC7B,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBACjD,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,UAAU;aACpB,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,KAAK,YAAY,MAAM,EAAE,CAAC;YACnC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;YACxD,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;YACZ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,CAAC,QAAQ,GAAG,aAAa,IAAI,KAAK,CAAA;YAEtC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAEhB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBAClE,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,QAAQ;aAClB,CAAC,CAAA;YACF,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBAC7B,IAAI,CAAC,IAAI,IAAI,IAAI,CAAA;YACnB,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YACtC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;YAClC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;YACZ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YAEpB,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;YAEvB,IAAI,CAAC,SAAS;gBACZ,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;oBACxD,KAAK,EAAE,EAAE;oBACT,OAAO,EAAE,QAAQ;iBAClB,CAAC,CAAA;QACN,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,EAAE,GAAG,KAAK,CAAA;YACf,qCAAqC;YACrC,OAAO,CAAC,KAAK,CACX,aAAa,EACb,OAAO,KAAK,EACZ,kBAAkB,EAClB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;IACH,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,cAAe,SAAQ,aAAa;IAC/C;;;;;;;;;;OAUG;IACH,YAAY,KAAiC,EAAE,KAAY;QACzD,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,KAAK,CAAA;QAChE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAA;QAC7B,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CACzD,aAAa,EACb,MAAM,CACP,CAAA;QAED,oBAAoB;IACtB,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,kBAAmB,SAAQ,aAAa;IACnD;;;;;;;;;;OAUG;IACH,YACE,KAA6C,EAC7C,SAAoB;QAEpB,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAA;QAC3B,IAAI,CAAC,QAAQ,GAAG,0BAA0B,CAAC,SAAS,CAAC,YAAY,CAAC,CAAA;QAClE,MAAM,EAAE,aAAa,EAAE,GAAG,SAAS,CAAA;QACnC,IAAI,CAAC,kBAAkB,GAAG,aAAa,CAAA;QACvC,oBAAoB;IACtB,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C;;;;;;;;;OASG;IACH,YAAY,KAA6C,EAAE,IAAU;QACnE,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAA;QACtB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;QAC7B,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAA;QAE5B,oBAAoB;IACtB,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"tree-entries-vm.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/tree-entries-vm.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAc1C,MAAM,OAAO,aAAa;IAQxB,IAAI,GAAG,KAAK,CAAA;IASZ,QAAQ,GAAG,KAAK,CAAA;IAShB,EAAE,CAAQ;IAUV,IAAI,GAAG,KAAK,CAAA;IASZ,QAAQ,GAAG,EAAE,CAAA;IASb,QAAQ,GAAG,KAAK,CAAA;IAShB,kBAAkB,GAAG,EAAE,CAAA;IASvB,SAAS,CAAqB;IAS9B,eAAe,CAAqB;IAYpC,YAAY,KAAuD;QACjE,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAA;QAElB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,kBAAkB,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;YAGrE,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;YACpE,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAA;YAKlC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAEhB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YACpB,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAA;YAElC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBACjD,KAAK,EAAE,IAAI,CAAC,EAAE;gBACd,OAAO,EAAE,UAAU;aACpB,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YACtC,MAAM,EAAE,aAAa,EAAE,eAAe,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAK,CAAA;YAElE,IAAI,CAAC,IAAI,GAAG,aAAa,CAAA;YACzB,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAA;YAE/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAEhB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YACpB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAA;YAC7B,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBACjD,KAAK,EAAE,IAAI,CAAC,EAAE;gBACd,OAAO,EAAE,UAAU;aACpB,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,KAAK,YAAY,OAAO,EAAE,CAAC;YACpC,MAAM,EAAE,aAAa,EAAE,eAAe,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAK,CAAA;YAClE,IAAI,CAAC,IAAI,GAAG,aAAa,CAAA;YACzB,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAA;YAE/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAEhB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YACpB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAA;YAC7B,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBACjD,KAAK,EAAE,IAAI,CAAC,EAAE;gBACd,OAAO,EAAE,UAAU;aACpB,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,KAAK,YAAY,MAAM,EAAE,CAAC;YACnC,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;YACpD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,CAAC,QAAQ,GAAG,aAAa,IAAI,KAAK,CAAA;YAEtC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAEhB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBAClE,KAAK,EAAE,IAAI,CAAC,EAAE;gBACd,OAAO,EAAE,QAAQ;aAClB,CAAC,CAAA;YACF,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBAC7B,IAAI,CAAC,IAAI,IAAI,IAAI,CAAA;YACnB,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YACtC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;YAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YAEpB,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;YAEvB,IAAI,CAAC,SAAS;gBACZ,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;oBACxD,KAAK,EAAE,IAAI,CAAC,EAAE;oBACd,OAAO,EAAE,QAAQ;iBAClB,CAAC,CAAA;QACN,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,EAAE,GAAG,KAAK,CAAA;YAEf,OAAO,CAAC,KAAK,CACX,aAAa,EACb,OAAO,KAAK,EACZ,kBAAkB,EAClB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;IACH,CAAC;CACF;AAYD,MAAM,OAAO,cAAe,SAAQ,aAAa;IAY/C,YAAY,KAAiC,EAAE,KAAY;QACzD,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,KAAK,CAAA;QAChE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAA;QAC7B,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CACzD,aAAa,EACb,MAAM,CACP,CAAA;QAED,IAAI,CAAC,eAAe,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;YACvD,KAAK,EAAE,KAAK,CAAC,EAAE;YACf,OAAO,EAAE,UAAU;SACpB,CAAC,CAAA;IAEJ,CAAC;CACF;AAYD,MAAM,OAAO,kBAAmB,SAAQ,aAAa;IAYnD,YACE,KAAuD,EACvD,SAAoB;QAEpB,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAA;QAC3B,IAAI,CAAC,QAAQ,GAAG,0BAA0B,CAAC,SAAS,CAAC,YAAY,CAAC,CAAA;QAClE,MAAM,EAAE,aAAa,EAAE,GAAG,SAAS,CAAA;QACnC,IAAI,CAAC,kBAAkB,GAAG,aAAa,CAAA;QAEvC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;YACjE,KAAK,EAAE,SAAS,CAAC,EAAE;YACnB,OAAO,EAAE,UAAU;SACpB,CAAC,CAAA;IAEJ,CAAC;CACF;AAYD,MAAM,OAAO,aAAc,SAAQ,aAAa;IAW9C,YACE,KAAuD,EACvD,IAAU;QAEV,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAA;QACtB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;QAC7B,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAA;QAE5B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;YAC5D,KAAK,EAAE,IAAI,CAAC,EAAE;YACd,OAAO,EAAE,UAAU;SACpB,CAAC,CAAA;IAGJ,CAAC;CACF;AAYD,MAAM,OAAO,YAAa,SAAQ,aAAa;IAW7C,YAAY,KAAc;QACxB,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAA;YAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,YAAY,CAAA;YACzC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBAC7D,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE;gBACtB,OAAO,EAAE,UAAU;aACpB,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAA;YACrB,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAA;QAC7B,CAAC;IAGH,CAAC;CACF"}
@@ -5,149 +5,24 @@ import { CompoundBase } from './compound-base-vm.js';
5
5
  import { DescriptionAnchor, DescriptionTocItem, DescriptionTocList } from './description-anchors.js';
6
6
  import { Member } from './members-vm.js';
7
7
  import { CliOptions } from '../cli-options.js';
8
- /**
9
- * View model that organises data for documentation generation.
10
- *
11
- * @remarks
12
- * The ViewModel class transforms the raw Doxygen data model into structured
13
- * collections suitable for generating Docusaurus documentation, including
14
- * classes, files, namespaces, and other compound types. It coordinates the
15
- * entire view model creation process, from object instantiation through
16
- * hierarchy establishment to cross-reference resolution.
17
- *
18
- * @public
19
- */
20
8
  export declare class ViewModel {
21
- /** Configuration options controlling the view model behaviour. */
22
9
  options: CliOptions;
23
- /** Reference to the parent workspace containing the data model. */
24
10
  workspace: Workspace;
25
- /** Map of collection names to their corresponding collection objects. */
26
11
  collections: Map<string, CollectionBase>;
27
- /** Map of compound identifiers to their view model objects. */
28
12
  compoundsById: Map<string, CompoundBase>;
29
- /** Map of member identifiers to their view model objects. */
30
13
  membersById: Map<string, Member>;
31
- /** Array of description table of contents lists for navigation. */
32
14
  descriptionTocLists: DescriptionTocList[];
33
- /** Map of TOC item identifiers to their corresponding objects. */
34
15
  descriptionTocItemsById: Map<string, DescriptionTocItem>;
35
- /** Map of description anchor identifiers to their objects. */
36
16
  descriptionAnchorsById: Map<string, DescriptionAnchor>;
37
- /**
38
- * Constructs a new ViewModel instance.
39
- *
40
- * @remarks
41
- * Initialises the view model with a reference to the parent workspace
42
- * and sets up the collection mapping structure. This constructor prepares
43
- * the foundation for transforming raw Doxygen data into organised
44
- * documentation structures suitable for Docusaurus generation.
45
- *
46
- * @param workspace - The parent workspace containing the data model.
47
- */
48
17
  constructor(workspace: Workspace);
49
- /**
50
- * Creates and populates all view model collections and objects.
51
- *
52
- * @remarks
53
- * Orchestrates the complete view model creation process including
54
- * collection instantiation, object creation, and hierarchy establishment.
55
- * This method coordinates all phases of view model construction to ensure
56
- * proper dependencies and cross-references are established between
57
- * documentation elements.
58
- */
59
18
  create(): void;
60
- /**
61
- * Creates view model objects from the parsed Doxygen compound definitions.
62
- *
63
- * @remarks
64
- * Iterates through all compound definitions from the data model and creates
65
- * corresponding view model objects, organising them into appropriate
66
- * collections and establishing identifier mappings. This method also
67
- * processes detailed descriptions to extract navigation elements and
68
- * cross-reference anchors for comprehensive documentation structure.
69
- */
70
19
  createVieModelObjects(): void;
71
- /**
72
- * Recursively finds and processes description identifiers within elements.
73
- *
74
- * @remarks
75
- * Traverses the element hierarchy to locate table of contents items,
76
- * document sections, and anchors, creating appropriate view model
77
- * structures for navigation and cross-referencing. This recursive processing
78
- * ensures comprehensive extraction of all navigational elements from
79
- * complex documentation structures.
80
- *
81
- * @param compound - The compound containing the description elements.
82
- * @param element - The data model element to process recursively.
83
- */
84
20
  findDescriptionIdsRecursively(compound: CompoundBase, element: AbstractDataModelBase): void;
85
- /**
86
- * Establishes hierarchical relationships between compound objects.
87
- *
88
- * @remarks
89
- * Delegates to each collection to create parent-child relationships
90
- * and other hierarchical structures within the compound objects. This
91
- * phase is essential for building proper navigation trees and inheritance
92
- * relationships that reflect the original code structure.
93
- */
94
21
  createCompoundsHierarchies(): void;
95
- /**
96
- * Performs late initialisation of compound objects.
97
- *
98
- * @remarks
99
- * Executes initialisation tasks that require all objects to be created
100
- * first, allowing for proper cross-reference resolution and relationship
101
- * establishment between compounds. This phase ensures that complex
102
- * inter-compound dependencies are properly resolved after the initial
103
- * object creation phase.
104
- */
105
22
  initializeCompoundsLate(): void;
106
- /**
107
- * Creates a comprehensive map of all member definitions.
108
- *
109
- * @remarks
110
- * Iterates through all compounds and their sections to build a complete
111
- * mapping of member identifiers to their objects, enabling efficient
112
- * member lookup and cross-referencing. This method handles member
113
- * deduplication and ensures that members are properly associated with
114
- * their containing compounds.
115
- */
116
23
  createMembersMap(): void;
117
- /**
118
- * Performs late initialisation of member objects.
119
- *
120
- * @remarks
121
- * Executes member initialisation tasks that depend on all objects being
122
- * created, ensuring proper cross-references and relationships are
123
- * established between members and their containing compounds. This phase
124
- * completes the member setup process after all structural relationships
125
- * have been established.
126
- */
127
24
  initializeMemberLate(): void;
128
- /**
129
- * Validates and resolves permalink uniqueness across all compounds.
130
- *
131
- * @remarks
132
- * Ensures that all generated permalinks are unique by detecting conflicts
133
- * and automatically appending suffixes to duplicate permalinks, maintaining
134
- * proper navigation and linking functionality. This validation process is
135
- * crucial for preventing URL conflicts in the generated documentation site.
136
- */
137
- /**
138
- * @brief Validate the uniqueness of permalinks.
139
- */
140
25
  validatePermalinks(): void;
141
- /**
142
- * Performs cleanup operations on view model objects.
143
- *
144
- * @remarks
145
- * Removes references to the original compound definition data models
146
- * to free memory and prevent potential circular references after
147
- * the view model creation is complete. This cleanup phase optimises
148
- * memory usage by removing unnecessary data model references that
149
- * are no longer needed for documentation generation.
150
- */
151
26
  cleanups(): void;
152
27
  }
153
28
  //# sourceMappingURL=view-model.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"view-model.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/view-model.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE3C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAQxC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAI9C;;;;;;;;;;;GAWG;AACH,qBAAa,SAAS;IACpB,kEAAkE;IAClE,OAAO,EAAE,UAAU,CAAA;IAEnB,mEAAmE;IACnE,SAAS,EAAE,SAAS,CAAA;IAEpB,yEAAyE;IAGzE,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAExC,+DAA+D;IAE/D,aAAa,4BAAkC;IAE/C,6DAA6D;IAC7D,WAAW,sBAA4B;IAEvC,mEAAmE;IACnE,mBAAmB,EAAE,kBAAkB,EAAE,CAAK;IAE9C,kEAAkE;IAClE,uBAAuB,kCAAwC;IAE/D,8DAA8D;IAC9D,sBAAsB,iCAAuC;IAE7D;;;;;;;;;;OAUG;gBACS,SAAS,EAAE,SAAS;IAOhC;;;;;;;;;OASG;IACH,MAAM;IAsBN;;;;;;;;;OASG;IACH,qBAAqB,IAAI,IAAI;IAiD7B;;;;;;;;;;;;OAYG;IACH,6BAA6B,CAC3B,QAAQ,EAAE,YAAY,EACtB,OAAO,EAAE,qBAAqB,GAC7B,IAAI;IA0CP;;;;;;;;OAQG;IACH,0BAA0B,IAAI,IAAI;IAYlC;;;;;;;;;OASG;IAEH,uBAAuB,IAAI,IAAI;IAiB/B;;;;;;;;;OASG;IACH,gBAAgB,IAAI,IAAI;IA0CxB;;;;;;;;;OASG;IAEH,oBAAoB,IAAI,IAAI;IA0B5B;;;;;;;;OAQG;IACH;;OAEG;IACH,kBAAkB,IAAI,IAAI;IAwE1B;;;;;;;;;OASG;IACH,QAAQ,IAAI,IAAI;CAKjB"}
1
+ {"version":3,"file":"view-model.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/view-model.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE3C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAQxC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAiB9C,qBAAa,SAAS;IAEpB,OAAO,EAAE,UAAU,CAAA;IAGnB,SAAS,EAAE,SAAS,CAAA;IAKpB,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAIxC,aAAa,4BAAkC;IAG/C,WAAW,sBAA4B;IAGvC,mBAAmB,EAAE,kBAAkB,EAAE,CAAK;IAG9C,uBAAuB,kCAAwC;IAG/D,sBAAsB,iCAAuC;gBAajD,SAAS,EAAE,SAAS;IAiBhC,MAAM;IAiCN,qBAAqB,IAAI,IAAI;IAmE7B,6BAA6B,CAC3B,QAAQ,EAAE,YAAY,EACtB,OAAO,EAAE,qBAAqB,GAC7B,IAAI;IAmDP,0BAA0B,IAAI,IAAI;IA0BlC,uBAAuB,IAAI,IAAI;IA8B/B,gBAAgB,IAAI,IAAI;IAwDxB,oBAAoB,IAAI,IAAI;IAyC5B,kBAAkB,IAAI,IAAI;IAqF1B,QAAQ,IAAI,IAAI;CAKjB"}