@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
@@ -3,139 +3,19 @@ import type { CompoundDefDataModel } from '../../doxygen/data-model/compounds/co
3
3
  import type { NavbarItem, SidebarCategory } from '../types.js';
4
4
  import type { CompoundBase } from './compound-base-vm.js';
5
5
  import type { TreeEntryBase } from './tree-entries-vm.js';
6
- /**
7
- * Base class for managing collections of documentation compounds.
8
- *
9
- * @remarks
10
- * Provides common functionality for organising and managing different
11
- * types of documentation collections such as classes, namespaces, files,
12
- * and groups. Handles hierarchy creation, sidebar generation, and index
13
- * file creation.
14
- *
15
- * @public
16
- */
17
6
  export declare abstract class CollectionBase {
18
- /** The workspace instance providing global configuration and utilities. */
19
7
  workspace: Workspace;
20
- /** Map storing compound instances indexed by their unique identifiers. */
21
8
  collectionCompoundsById: Map<string, CompoundBase>;
22
- /**
23
- * Creates a new collection base instance.
24
- *
25
- * @remarks
26
- * Initialises the workspace reference and creates an empty map for
27
- * storing compound instances indexed by their identifiers.
28
- *
29
- * @param workspace - The workspace instance containing global configuration
30
- */
31
9
  constructor(workspace: Workspace);
32
- /**
33
- * Adds a compound definition to the collection.
34
- *
35
- * @remarks
36
- * Abstract method that must be implemented by derived classes to handle
37
- * the specific compound type addition logic.
38
- *
39
- * @param compoundDef - The compound definition data model to add
40
- * @returns The created compound base instance
41
- */
42
10
  abstract addChild(compoundDef: CompoundDefDataModel): CompoundBase;
43
- /**
44
- * Creates hierarchical relationships between compounds.
45
- *
46
- * @remarks
47
- * Abstract method that organises compounds into their appropriate
48
- * hierarchical structure based on the collection type.
49
- */
50
11
  abstract createCompoundsHierarchies(): void;
51
- /**
52
- * Adds items to the sidebar category for navigation.
53
- *
54
- * @remarks
55
- * Abstract method that populates the sidebar with appropriate navigation
56
- * items for this collection type.
57
- *
58
- * @param sidebarCategory - The sidebar category to populate
59
- */
60
12
  abstract addSidebarItems(sidebarCategory: SidebarCategory): void;
61
- /**
62
- * Creates navigation bar items for the top-level menu.
63
- *
64
- * @remarks
65
- * Abstract method that generates navbar dropdown items appropriate
66
- * for this collection type.
67
- *
68
- * @returns Array of navbar items for the collection
69
- */
70
13
  abstract createNavbarItems(): NavbarItem[];
71
- /**
72
- * Generates the main index Markdown file for the collection.
73
- *
74
- * @remarks
75
- * Abstract method that creates the primary index page listing all
76
- * items in the collection with appropriate organisation.
77
- */
78
14
  abstract generateIndexDotMdFile(): Promise<void>;
79
- /**
80
- * Generates index files organised by initial letters.
81
- *
82
- * @remarks
83
- * Optional method that can be overridden to create alphabetical
84
- * index pages when the collection is large enough to warrant
85
- * subdivision by initial letters.
86
- */
87
15
  generatePerInitialsIndexMdFiles(): Promise<void>;
88
- /**
89
- * Determines whether the collection should appear in the sidebar.
90
- *
91
- * @remarks
92
- * Collections are visible in the sidebar when they contain at least
93
- * one compound. Empty collections are hidden to avoid clutter.
94
- *
95
- * @returns True if the collection has compounds and should be visible
96
- */
97
16
  isVisibleInSidebar(): boolean;
98
- /**
99
- * Organises tree entries by their initial letters for alphabetical indexing.
100
- *
101
- * @remarks
102
- * Groups collection entries by their first letter to enable creation
103
- * of alphabetical index pages. Handles special characters like tildes
104
- * and ensures consistent lowercase grouping.
105
- *
106
- * @param entriesMap - Map of tree entries to organise
107
- * @returns Map grouping entries by their initial letters
108
- */
109
17
  orderPerInitials(entriesMap: Map<string, TreeEntryBase>): Map<string, TreeEntryBase[]>;
110
- /**
111
- * Generates output entries for alphabetical index pages.
112
- *
113
- * @remarks
114
- * Creates formatted lists of entries organised by initial letters,
115
- * producing HTML markup suitable for inclusion in Markdown index
116
- * pages. Includes entry names, types, and navigation links.
117
- *
118
- * @param entriesPerInitialsMap - Map of entries grouped by initials
119
- * @returns Array of formatted output lines for the index
120
- */
121
18
  outputEntries(entriesPerInitialsMap: Map<string, TreeEntryBase[]>): string[];
122
- /**
123
- * Generates a filtered index file for a specific kind of entries.
124
- *
125
- * @remarks
126
- * Creates alphabetically organised index pages for specific entry types
127
- * within the collection. Applies filtering to include only relevant
128
- * entries, organises them by initial letters, and generates Markdown
129
- * files with proper frontmatter and navigation links.
130
- *
131
- * @param params - Object containing index file generation parameters
132
- * @param params.group - The collection group name for file organisation
133
- * @param params.fileKind - The specific kind of entries to include
134
- * @param params.title - The page title for the generated index
135
- * @param params.description - The descriptive text for the index page
136
- * @param params.map - Map of all available entries to filter from
137
- * @param params.filter - Function to determine which entries to include
138
- */
139
19
  generateIndexFile({ group, fileKind, title, description, map, filter, }: {
140
20
  group: string;
141
21
  fileKind: string;
@@ -1 +1 @@
1
- {"version":3,"file":"collection-base.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/collection-base.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAA;AAChG,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAe,MAAM,aAAa,CAAA;AAC3E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAEzD;;;;;;;;;;GAUG;AACH,8BAAsB,cAAc;IAClC,2EAA2E;IAC3E,SAAS,EAAE,SAAS,CAAA;IAEpB,0EAA0E;IAC1E,uBAAuB,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IAIlD;;;;;;;;OAQG;gBACS,SAAS,EAAE,SAAS;IAQhC;;;;;;;;;OASG;IACH,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,oBAAoB,GAAG,YAAY;IAElE;;;;;;OAMG;IACH,QAAQ,CAAC,0BAA0B,IAAI,IAAI;IAE3C;;;;;;;;OAQG;IACH,QAAQ,CAAC,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IAEhE;;;;;;;;OAQG;IACH,QAAQ,CAAC,iBAAiB,IAAI,UAAU,EAAE;IAE1C;;;;;;OAMG;IACH,QAAQ,CAAC,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEhD;;;;;;;OAOG;IACG,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC;IAItD;;;;;;;;OAQG;IACH,kBAAkB,IAAI,OAAO;IAM7B;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,GACrC,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC;IA2C/B;;;;;;;;;;OAUG;IACH,aAAa,CAAC,qBAAqB,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,GAAG,MAAM,EAAE;IAuD5E;;;;;;;;;;;;;;;;OAgBG;IACG,iBAAiB,CAAC,EACtB,KAAK,EACL,QAAQ,EACR,KAAK,EACL,WAAW,EACX,GAAG,EACH,MAAM,GACP,EAAE;QACD,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;QACb,WAAW,EAAE,MAAM,CAAA;QACnB,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;QAC/B,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAA;KAClC,GAAG,OAAO,CAAC,IAAI,CAAC;CAkDlB"}
1
+ {"version":3,"file":"collection-base.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/collection-base.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAA;AAChG,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAe,MAAM,aAAa,CAAA;AAC3E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAazD,8BAAsB,cAAc;IAElC,SAAS,EAAE,SAAS,CAAA;IAGpB,uBAAuB,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;gBAatC,SAAS,EAAE,SAAS;IAkBhC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,oBAAoB,GAAG,YAAY;IASlE,QAAQ,CAAC,0BAA0B,IAAI,IAAI;IAW3C,QAAQ,CAAC,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IAWhE,QAAQ,CAAC,iBAAiB,IAAI,UAAU,EAAE;IAS1C,QAAQ,CAAC,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IAU1C,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC;IAatD,kBAAkB,IAAI,OAAO;IAiB7B,gBAAgB,CACd,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,GACrC,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC;IAsD/B,aAAa,CAAC,qBAAqB,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,GAAG,MAAM,EAAE;IAgFtE,iBAAiB,CAAC,EACtB,KAAK,EACL,QAAQ,EACR,KAAK,EACL,WAAW,EACX,GAAG,EACH,MAAM,GACP,EAAE;QACD,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;QACb,WAAW,EAAE,MAAM,CAAA;QACnB,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;QAC/B,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAA;KAClC,GAAG,OAAO,CAAC,IAAI,CAAC;CAkDlB"}
@@ -1,81 +1,16 @@
1
- /*
2
- * This file is part of the xPack project (http://xpack.github.io).
3
- * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
4
- *
5
- * Permission to use, copy, modify, and/or distribute this software
6
- * for any purpose is hereby granted, under the terms of the MIT license.
7
- *
8
- * If a copy of the license was not distributed with this file, it can
9
- * be obtained from https://opensource.org/licenses/MIT.
10
- */
11
- // ----------------------------------------------------------------------------
12
- // import * as fs from 'node:fs/promises'
13
1
  import assert from 'node:assert';
14
- /**
15
- * Base class for managing collections of documentation compounds.
16
- *
17
- * @remarks
18
- * Provides common functionality for organising and managing different
19
- * types of documentation collections such as classes, namespaces, files,
20
- * and groups. Handles hierarchy creation, sidebar generation, and index
21
- * file creation.
22
- *
23
- * @public
24
- */
25
2
  export class CollectionBase {
26
- /** The workspace instance providing global configuration and utilities. */
27
3
  workspace;
28
- /** Map storing compound instances indexed by their unique identifiers. */
29
4
  collectionCompoundsById;
30
- // --------------------------------------------------------------------------
31
- /**
32
- * Creates a new collection base instance.
33
- *
34
- * @remarks
35
- * Initialises the workspace reference and creates an empty map for
36
- * storing compound instances indexed by their identifiers.
37
- *
38
- * @param workspace - The workspace instance containing global configuration
39
- */
40
5
  constructor(workspace) {
41
6
  this.workspace = workspace;
42
7
  this.collectionCompoundsById = new Map();
43
8
  }
44
- /**
45
- * Generates index files organised by initial letters.
46
- *
47
- * @remarks
48
- * Optional method that can be overridden to create alphabetical
49
- * index pages when the collection is large enough to warrant
50
- * subdivision by initial letters.
51
- */
52
9
  async generatePerInitialsIndexMdFiles() {
53
- // Nothing at this level. Override it where needed.
54
10
  }
55
- /**
56
- * Determines whether the collection should appear in the sidebar.
57
- *
58
- * @remarks
59
- * Collections are visible in the sidebar when they contain at least
60
- * one compound. Empty collections are hidden to avoid clutter.
61
- *
62
- * @returns True if the collection has compounds and should be visible
63
- */
64
11
  isVisibleInSidebar() {
65
12
  return this.collectionCompoundsById.size > 0;
66
13
  }
67
- // --------------------------------------------------------------------------
68
- /**
69
- * Organises tree entries by their initial letters for alphabetical indexing.
70
- *
71
- * @remarks
72
- * Groups collection entries by their first letter to enable creation
73
- * of alphabetical index pages. Handles special characters like tildes
74
- * and ensures consistent lowercase grouping.
75
- *
76
- * @param entriesMap - Map of tree entries to organise
77
- * @returns Map grouping entries by their initial letters
78
- */
79
14
  orderPerInitials(entriesMap) {
80
15
  const entriesPerInitialsMap = new Map();
81
16
  for (const [, entry] of entriesMap) {
@@ -115,17 +50,6 @@ export class CollectionBase {
115
50
  }
116
51
  return orderedMap;
117
52
  }
118
- /**
119
- * Generates output entries for alphabetical index pages.
120
- *
121
- * @remarks
122
- * Creates formatted lists of entries organised by initial letters,
123
- * producing HTML markup suitable for inclusion in Markdown index
124
- * pages. Includes entry names, types, and navigation links.
125
- *
126
- * @param entriesPerInitialsMap - Map of entries grouped by initials
127
- * @returns Array of formatted output lines for the index
128
- */
129
53
  outputEntries(entriesPerInitialsMap) {
130
54
  const lines = [];
131
55
  let totalCount = 0;
@@ -143,7 +67,13 @@ export class CollectionBase {
143
67
  .replace(/enumvalue/, 'enum value')
144
68
  .replace(/define/, 'macro definition');
145
69
  let text = '';
146
- text += `<li><b>${name}</b>: `;
70
+ text += `<li>`;
71
+ if (entry.permalink !== undefined && entry.permalink.length > 0) {
72
+ text += `<a href="${entry.permalink}"><b>${name}</b></a>: `;
73
+ }
74
+ else {
75
+ text += `<b>${name}</b>: `;
76
+ }
147
77
  text += 'as ';
148
78
  if (name !== entry.comparableLinkName) {
149
79
  text += `${kind} `;
@@ -153,8 +83,9 @@ export class CollectionBase {
153
83
  text += entry.linkKind;
154
84
  text += ' ';
155
85
  }
156
- if (entry.permalink !== undefined && entry.permalink.length > 0) {
157
- text += `<a href="${entry.permalink}">${linkName}</a>`;
86
+ if (entry.grouptPermalink !== undefined &&
87
+ entry.grouptPermalink.length > 0) {
88
+ text += `<a href="${entry.grouptPermalink}">${linkName}</a>`;
158
89
  }
159
90
  else {
160
91
  text += linkName;
@@ -172,23 +103,6 @@ export class CollectionBase {
172
103
  lines.push(`<p>Total: ${totalCount.toString()} entries.</p>`);
173
104
  return lines;
174
105
  }
175
- /**
176
- * Generates a filtered index file for a specific kind of entries.
177
- *
178
- * @remarks
179
- * Creates alphabetically organised index pages for specific entry types
180
- * within the collection. Applies filtering to include only relevant
181
- * entries, organises them by initial letters, and generates Markdown
182
- * files with proper frontmatter and navigation links.
183
- *
184
- * @param params - Object containing index file generation parameters
185
- * @param params.group - The collection group name for file organisation
186
- * @param params.fileKind - The specific kind of entries to include
187
- * @param params.title - The page title for the generated index
188
- * @param params.description - The descriptive text for the index page
189
- * @param params.map - Map of all available entries to filter from
190
- * @param params.filter - Function to determine which entries to include
191
- */
192
106
  async generateIndexFile({ group, fileKind, title, description, map, filter, }) {
193
107
  const filteredMap = new Map();
194
108
  for (const [id, entry] of map) {
@@ -197,11 +111,9 @@ export class CollectionBase {
197
111
  }
198
112
  }
199
113
  if (filteredMap.size === 0) {
200
- // There are no index entries.
201
114
  return;
202
115
  }
203
116
  if (!this.workspace.indicesMaps.has(group)) {
204
- // Add the empty set at the first usage.
205
117
  this.workspace.indicesMaps.set(group, new Set());
206
118
  }
207
119
  this.workspace.indicesMaps.get(group)?.add(fileKind);
@@ -212,7 +124,6 @@ export class CollectionBase {
212
124
  const frontMatter = {
213
125
  title,
214
126
  slug: `${this.workspace.slugBaseUrl}${permalink}`,
215
- // description: '...', // TODO
216
127
  custom_edit_url: null,
217
128
  keywords: ['doxygen', group, 'index'],
218
129
  };
@@ -220,7 +131,7 @@ export class CollectionBase {
220
131
  lines.push(`<p>${description}</p>`);
221
132
  lines.push(...this.outputEntries(orderedEntries));
222
133
  if (this.workspace.options.verbose) {
223
- console.log(`Writing ${group} index file ${filePath}...`);
134
+ console.log(`Writing ${group} index file '${filePath}'...`);
224
135
  }
225
136
  await this.workspace.writeOutputMdFile({
226
137
  filePath,
@@ -229,5 +140,4 @@ export class CollectionBase {
229
140
  });
230
141
  }
231
142
  }
232
- // ----------------------------------------------------------------------------
233
143
  //# sourceMappingURL=collection-base.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"collection-base.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/collection-base.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,yCAAyC;AACzC,OAAO,MAAM,MAAM,aAAa,CAAA;AAQhC;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,cAAc;IAClC,2EAA2E;IAC3E,SAAS,CAAW;IAEpB,0EAA0E;IAC1E,uBAAuB,CAA2B;IAElD,6EAA6E;IAE7E;;;;;;;;OAQG;IACH,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAE1B,IAAI,CAAC,uBAAuB,GAAG,IAAI,GAAG,EAAE,CAAA;IAC1C,CAAC;IAwDD;;;;;;;OAOG;IACH,KAAK,CAAC,+BAA+B;QACnC,mDAAmD;IACrD,CAAC;IAED;;;;;;;;OAQG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,uBAAuB,CAAC,IAAI,GAAG,CAAC,CAAA;IAC9C,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,UAAsC;QAEtC,MAAM,qBAAqB,GAAG,IAAI,GAAG,EAA2B,CAAA;QAEhE,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,UAAU,EAAE,CAAC;YACnC,MAAM,OAAO,GAAW,KAAK,CAAC,IAAI;iBAC/B,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;iBACnB,MAAM,CAAC,CAAC,CAAC;iBACT,WAAW,EAAE,CAAA;YAChB,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,IAAI,QAAQ,GAAG,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gBACjD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC3B,QAAQ,GAAG,EAAE,CAAA;oBACb,qBAAqB,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;gBAC9C,CAAC;gBACD,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACtB,CAAC;QACH,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,GAAG,EAA2B,CAAA;QACrD,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;QACvE,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE,CAAC;YACtC,MAAM,cAAc,GAAG,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;YACzD,MAAM,CAAC,cAAc,KAAK,SAAS,CAAC,CAAA;YACpC,MAAM,YAAY,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBAChD,IAAI,cAAc,GAAG,CAAC,CAAC,IAAI;qBACxB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;qBACnB,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,SAAS,EAAE;oBACpD,WAAW,EAAE,QAAQ;iBACtB,CAAC,CAAA;gBACJ,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,cAAc,CAAA;gBACvB,CAAC;gBACD,cAAc,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE;oBAC/D,WAAW,EAAE,QAAQ;iBACtB,CAAC,CAAA;gBACF,OAAO,cAAc,CAAA;YACvB,CAAC,CAAC,CAAA;YACF,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;QACvC,CAAC;QAED,OAAO,UAAU,CAAA;IACnB,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CAAC,qBAAmD;QAC/D,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,IAAI,UAAU,GAAG,CAAC,CAAA;QAClB,KAAK,MAAM,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAE,EAAE,CAAC;YACnD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,KAAK,CAAC,IAAI,CAAC,QAAQ,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;YAC7C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAClB,MAAM,QAAQ,GAAG,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;YACnD,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAA;YAC9B,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;gBAC7B,MAAM,QAAQ,GAAW,KAAK,CAAC,QAAQ,CAAA;gBAEvC,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;gBACtB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI;qBACpB,OAAO,CAAC,WAAW,EAAE,YAAY,CAAC;qBAClC,OAAO,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAA;gBAExC,IAAI,IAAI,GAAG,EAAE,CAAA;gBAEb,IAAI,IAAI,UAAU,IAAI,QAAQ,CAAA;gBAC9B,IAAI,IAAI,KAAK,CAAA;gBACb,IAAI,IAAI,KAAK,KAAK,CAAC,kBAAkB,EAAE,CAAC;oBACtC,IAAI,IAAI,GAAG,IAAI,GAAG,CAAA;oBAClB,IAAI,IAAI,KAAK,CAAA;gBACf,CAAC;gBAED,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC9B,IAAI,IAAI,KAAK,CAAC,QAAQ,CAAA;oBACtB,IAAI,IAAI,GAAG,CAAA;gBACb,CAAC;gBAED,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAChE,IAAI,IAAI,YAAY,KAAK,CAAC,SAAS,KAAK,QAAQ,MAAM,CAAA;gBACxD,CAAC;qBAAM,CAAC;oBACN,IAAI,IAAI,QAAQ,CAAA;gBAClB,CAAC;gBACD,IAAI,IAAI,OAAO,CAAA;gBACf,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAClB,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAEnB,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,KAAK,CAAC,IAAI,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAA;YAC5D,CAAC;YACD,UAAU,IAAI,QAAQ,CAAC,MAAM,CAAA;QAC/B,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnB,KAAK,CAAC,IAAI,CAAC,aAAa,UAAU,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;QAE7D,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,iBAAiB,CAAC,EACtB,KAAK,EACL,QAAQ,EACR,KAAK,EACL,WAAW,EACX,GAAG,EACH,MAAM,GAQP;QACC,MAAM,WAAW,GAAG,IAAI,GAAG,EAAyB,CAAA;QACpD,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC;YAC9B,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;YAC5B,CAAC;QACH,CAAC;QAED,IAAI,WAAW,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAC3B,8BAA8B;YAC9B,OAAM;QACR,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3C,wCAAwC;YACxC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,GAAG,EAAE,CAAC,CAAA;QAClD,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;QAEpD,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;QAEzD,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,SAAS,CAAA;QAE3C,MAAM,QAAQ,GAAG,GAAG,gBAAgB,WAAW,KAAK,IAAI,QAAQ,KAAK,CAAA;QACrE,MAAM,SAAS,GAAG,WAAW,KAAK,IAAI,QAAQ,EAAE,CAAA;QAEhD,MAAM,WAAW,GAAgB;YAC/B,KAAK;YACL,IAAI,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,SAAS,EAAE;YACjD,8BAA8B;YAC9B,eAAe,EAAE,IAAI;YACrB,QAAQ,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC;SACtC,CAAA;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,MAAM,WAAW,MAAM,CAAC,CAAA;QAEnC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAA;QAEjD,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACnC,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,eAAe,QAAQ,KAAK,CAAC,CAAA;QAC3D,CAAC;QAED,MAAM,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC;YACrC,QAAQ;YACR,WAAW;YACX,SAAS,EAAE,KAAK;SACjB,CAAC,CAAA;IACJ,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"collection-base.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/collection-base.ts"],"names":[],"mappings":"AAcA,OAAO,MAAM,MAAM,aAAa,CAAA;AAmBhC,MAAM,OAAgB,cAAc;IAElC,SAAS,CAAW;IAGpB,uBAAuB,CAA2B;IAalD,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAE1B,IAAI,CAAC,uBAAuB,GAAG,IAAI,GAAG,EAAE,CAAA;IAC1C,CAAC;IAgED,KAAK,CAAC,+BAA+B;IAErC,CAAC;IAWD,kBAAkB;QAChB,OAAO,IAAI,CAAC,uBAAuB,CAAC,IAAI,GAAG,CAAC,CAAA;IAC9C,CAAC;IAeD,gBAAgB,CACd,UAAsC;QAEtC,MAAM,qBAAqB,GAAG,IAAI,GAAG,EAA2B,CAAA;QAEhE,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,UAAU,EAAE,CAAC;YACnC,MAAM,OAAO,GAAW,KAAK,CAAC,IAAI;iBAC/B,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;iBACnB,MAAM,CAAC,CAAC,CAAC;iBACT,WAAW,EAAE,CAAA;YAChB,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,IAAI,QAAQ,GAAG,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gBACjD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC3B,QAAQ,GAAG,EAAE,CAAA;oBACb,qBAAqB,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;gBAC9C,CAAC;gBACD,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACtB,CAAC;QACH,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,GAAG,EAA2B,CAAA;QACrD,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;QACvE,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE,CAAC;YACtC,MAAM,cAAc,GAAG,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;YACzD,MAAM,CAAC,cAAc,KAAK,SAAS,CAAC,CAAA;YACpC,MAAM,YAAY,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBAChD,IAAI,cAAc,GAAG,CAAC,CAAC,IAAI;qBACxB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;qBACnB,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,SAAS,EAAE;oBACpD,WAAW,EAAE,QAAQ;iBACtB,CAAC,CAAA;gBACJ,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,cAAc,CAAA;gBACvB,CAAC;gBACD,cAAc,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE;oBAC/D,WAAW,EAAE,QAAQ;iBACtB,CAAC,CAAA;gBACF,OAAO,cAAc,CAAA;YACvB,CAAC,CAAC,CAAA;YACF,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;QACvC,CAAC;QAED,OAAO,UAAU,CAAA;IACnB,CAAC;IAaD,aAAa,CAAC,qBAAmD;QAC/D,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,IAAI,UAAU,GAAG,CAAC,CAAA;QAClB,KAAK,MAAM,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAE,EAAE,CAAC;YACnD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,KAAK,CAAC,IAAI,CAAC,QAAQ,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;YAC7C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAClB,MAAM,QAAQ,GAAG,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;YACnD,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAA;YAC9B,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;gBAC7B,MAAM,QAAQ,GAAW,KAAK,CAAC,QAAQ,CAAA;gBAEvC,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;gBACtB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI;qBACpB,OAAO,CAAC,WAAW,EAAE,YAAY,CAAC;qBAClC,OAAO,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAA;gBAExC,IAAI,IAAI,GAAG,EAAE,CAAA;gBAEb,IAAI,IAAI,MAAM,CAAA;gBACd,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAChE,IAAI,IAAI,YAAY,KAAK,CAAC,SAAS,QAAQ,IAAI,YAAY,CAAA;gBAC7D,CAAC;qBAAM,CAAC;oBACN,IAAI,IAAI,MAAM,IAAI,QAAQ,CAAA;gBAC5B,CAAC;gBACD,IAAI,IAAI,KAAK,CAAA;gBACb,IAAI,IAAI,KAAK,KAAK,CAAC,kBAAkB,EAAE,CAAC;oBACtC,IAAI,IAAI,GAAG,IAAI,GAAG,CAAA;oBAClB,IAAI,IAAI,KAAK,CAAA;gBACf,CAAC;gBAED,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC9B,IAAI,IAAI,KAAK,CAAC,QAAQ,CAAA;oBACtB,IAAI,IAAI,GAAG,CAAA;gBACb,CAAC;gBAED,IACE,KAAK,CAAC,eAAe,KAAK,SAAS;oBACnC,KAAK,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAChC,CAAC;oBACD,IAAI,IAAI,YAAY,KAAK,CAAC,eAAe,KAAK,QAAQ,MAAM,CAAA;gBAC9D,CAAC;qBAAM,CAAC;oBACN,IAAI,IAAI,QAAQ,CAAA;gBAClB,CAAC;gBACD,IAAI,IAAI,OAAO,CAAA;gBACf,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAClB,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAEnB,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,KAAK,CAAC,IAAI,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAA;YAC5D,CAAC;YACD,UAAU,IAAI,QAAQ,CAAC,MAAM,CAAA;QAC/B,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnB,KAAK,CAAC,IAAI,CAAC,aAAa,UAAU,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;QAE7D,OAAO,KAAK,CAAA;IACd,CAAC;IAmBD,KAAK,CAAC,iBAAiB,CAAC,EACtB,KAAK,EACL,QAAQ,EACR,KAAK,EACL,WAAW,EACX,GAAG,EACH,MAAM,GAQP;QACC,MAAM,WAAW,GAAG,IAAI,GAAG,EAAyB,CAAA;QACpD,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC;YAC9B,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;YAC5B,CAAC;QACH,CAAC;QAED,IAAI,WAAW,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAE3B,OAAM;QACR,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAE3C,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,GAAG,EAAE,CAAC,CAAA;QAClD,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;QAEpD,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;QAEzD,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,SAAS,CAAA;QAE3C,MAAM,QAAQ,GAAG,GAAG,gBAAgB,WAAW,KAAK,IAAI,QAAQ,KAAK,CAAA;QACrE,MAAM,SAAS,GAAG,WAAW,KAAK,IAAI,QAAQ,EAAE,CAAA;QAEhD,MAAM,WAAW,GAAgB;YAC/B,KAAK;YACL,IAAI,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,SAAS,EAAE;YAEjD,eAAe,EAAE,IAAI;YACrB,QAAQ,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC;SACtC,CAAA;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,MAAM,WAAW,MAAM,CAAC,CAAA;QAEnC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAA;QAEjD,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACnC,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,gBAAgB,QAAQ,MAAM,CAAC,CAAA;QAC7D,CAAC;QAED,MAAM,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC;YACrC,QAAQ;YACR,WAAW;YACX,SAAS,EAAE,KAAK;SACjB,CAAC,CAAA;IACJ,CAAC;CACF"}
@@ -6,170 +6,40 @@ import type { LocationDataModel } from '../../doxygen/data-model/compounds/locat
6
6
  import type { CompoundDefDataModel } from '../../doxygen/data-model/compounds/compounddef-dm.js';
7
7
  import type { IncludesDataModel } from '../../doxygen/data-model/compounds/inctype-dm.js';
8
8
  import type { ReferenceDataModel, ReferencedByDataModel } from '../../doxygen/data-model/compounds/referencetype-dm.js';
9
- /**
10
- * Abstract base class for all compound documentation objects.
11
- *
12
- * The CompoundBase class provides common functionality and structure for
13
- * all types of documentation compounds (classes, files, namespaces, etc.),
14
- * including rendering, navigation, and metadata management.
15
- *
16
- * @public
17
- */
9
+ import { Concept } from './concepts-vm.js';
18
10
  export declare abstract class CompoundBase {
19
- /** The Doxygen compound kind (class, file, namespace, etc.). */
20
11
  kind: string;
21
- /** The display name of the compound. */
22
12
  compoundName: string;
23
- /** Unique identifier for the compound. */
24
13
  id: string;
25
- /** The collection this compound belongs to. */
26
14
  collection: CollectionBase;
27
- /** HTML-rendered title string for display purposes. */
28
15
  titleHtmlString: string | undefined;
29
- /** File path where the compound is located in the source. */
30
16
  locationFilePath: string | undefined;
31
- /** Parent compound in the hierarchy (not used for classes). */
32
17
  parent?: CompoundBase;
33
- /**
34
- * Array of child compound identifiers for two-step initialisation.
35
- *
36
- * Set in 2 steps, first the Ids and then, when all objects are in,
37
- * the references.
38
- * Folder objects use separate arrays for files and folders children.
39
- */
40
18
  childrenIds: string[];
41
- /** Array of resolved child compound instances. */
42
19
  children: CompoundBase[];
43
- /**
44
- * Short name for sidebar display within limited space.
45
- * If undefined, the compound is excluded from the sidebar.
46
- */
47
20
  sidebarLabel: string | undefined;
48
- /**
49
- * Relative path to the output folder starting with plural kind.
50
- * If undefined, the compound is excluded from the sidebar.
51
- */
52
21
  sidebarId: string | undefined;
53
- /**
54
- * Relative permalink below outputFolderPath without leading slash.
55
- * If undefined, no Markdown file is generated for the compound.
56
- */
57
22
  relativePermalink: string | undefined;
58
- /** The name shown in the index section. */
59
23
  indexName: string;
60
- /** The name used in tree entries for top-level index pages. */
61
24
  treeEntryName: string;
62
- /** The name shown in the page title. */
63
25
  pageTitle: string;
64
- /** HTML-rendered brief description for display purposes. */
65
26
  briefDescriptionHtmlString: string | undefined;
66
- /** HTML-rendered detailed description lines for full documentation. */
67
27
  detailedDescriptionHtmlLines: string[] | undefined;
68
- /** Flag indicating if detailed description contains sect1 elements. */
69
28
  hasSect1InDescription: boolean;
70
- /** Location information lines for rendering file/line references. */
71
29
  locationLines: string[] | undefined;
72
- /** Array of member sections organised by type and visibility. */
73
30
  sections: Section[];
74
- /** Set of unique file locations for this compound. */
75
31
  locationSet: Set<string>;
76
- /** Array of include directives for this compound. */
77
32
  includes: IncludesDataModel[] | undefined;
78
- /** Map of inner compounds organised by type. */
79
33
  innerCompounds: Map<string, CompoundDefDataModel> | undefined;
80
- /** Private data storage for internal compound definition reference. */
81
34
  _private: {
82
- /** Reference to the source data model object. */
83
35
  _compoundDef?: CompoundDefDataModel | undefined;
84
36
  };
85
- /**
86
- * Creates a new compound base instance from definition data.
87
- *
88
- * @remarks
89
- * Initialises the basic compound properties including kind, name,
90
- * identifier, and optional title and location information. Sets up
91
- * the collection reference and processes HTML rendering for titles.
92
- *
93
- * @param collection - The parent collection managing this compound
94
- * @param compoundDef - The Doxygen compound definition containing source data
95
- */
96
37
  constructor(collection: CollectionBase, compoundDef: CompoundDefDataModel);
97
- /**
98
- * Creates and organises member sections for the compound.
99
- *
100
- * @remarks
101
- * Processes section definitions from the compound data model,
102
- * reorders them by type and visibility, and creates Section
103
- * instances for rendering. Sorts sections according to their
104
- * logical display order.
105
- *
106
- * @param classUnqualifiedName - Optional class name for special method
107
- * detection
108
- */
109
38
  createSections(classUnqualifiedName?: string): void;
110
- /**
111
- * Reorders section definitions by member type and adjusts section kinds.
112
- *
113
- * @remarks
114
- * Processes member definitions and groups them by adjusted section
115
- * kinds, handling user-defined sections separately. Creates new
116
- * section definitions organised by member types for consistent
117
- * display ordering.
118
- *
119
- * @param classUnqualifiedName - Optional class name for special method
120
- * detection
121
- * @returns Array of reordered section definitions or undefined if none exist
122
- */
123
39
  private reorderSectionDefs;
124
- /**
125
- * Adjusts section kind based on member type and context.
126
- *
127
- * @remarks
128
- * Maps member kinds to appropriate section categories, handling
129
- * special cases like operators, constructors, destructors, and
130
- * various member types. Preserves visibility prefixes and applies
131
- * context-specific adjustments.
132
- *
133
- * @param sectionDef - The section definition containing the member
134
- * @param memberBase - The member whose section kind needs adjustment
135
- * @param classUnqualifiedName - Optional class name for special method
136
- * detection
137
- * @returns The adjusted section kind string
138
- */
139
40
  private adjustSectionKind;
140
- /**
141
- * Performs late-stage initialisation after all compounds are loaded.
142
- *
143
- * @remarks
144
- * Processes description content, location information, member sections,
145
- * and inner compounds. Renders HTML strings and builds location sets
146
- * for comprehensive compound documentation. Called after initial
147
- * object creation phase.
148
- */
149
41
  initializeLate(): void;
150
- /**
151
- * Determines if a member name represents an operator function.
152
- *
153
- * @remarks
154
- * Checks if the name starts with 'operator' followed by operator
155
- * characters, identifying C++ operator overload functions for
156
- * proper categorisation in documentation sections.
157
- *
158
- * @param name - The member name to check
159
- * @returns True if the name represents an operator function
160
- */
161
42
  isOperator(name: string): boolean;
162
- /**
163
- * Renders the compound to an array of markdown lines.
164
- *
165
- * @remarks
166
- * Abstract method that must be implemented by derived classes to
167
- * generate the complete documentation content for the compound,
168
- * including descriptions, member listings, and navigation elements.
169
- *
170
- * @param frontMatter - The frontmatter configuration for the page
171
- * @returns Array of markdown strings representing the complete documentation
172
- */
173
43
  abstract renderToLines(frontMatter: FrontMatter): string[];
174
44
  renderBriefDescriptionToHtmlString({ briefDescriptionHtmlString, todo, morePermalink, }: {
175
45
  briefDescriptionHtmlString: string | undefined;
@@ -187,6 +57,7 @@ export declare abstract class CompoundBase {
187
57
  renderInnerIndicesToLines({ suffixes, }: {
188
58
  suffixes?: string[];
189
59
  }): string[];
60
+ renderConceptsIndexToLines(concepts: Concept[]): string[];
190
61
  hasSections(): boolean;
191
62
  renderSectionIndicesToLines(): string[];
192
63
  renderIncludesIndexToLines(): string[];
@@ -195,11 +66,6 @@ export declare abstract class CompoundBase {
195
66
  renderGeneratedFromToLines(): string[];
196
67
  renderReferencesToHtmlString(references: ReferenceDataModel[] | undefined): string;
197
68
  renderReferencedByToHtmlString(referencedBy: ReferencedByDataModel[] | undefined): string;
198
- /**
199
- * Return an array of types, like `class T`, or `class U = T`, or `N T::* MP`
200
- * @param templateParamList
201
- * @returns
202
- */
203
69
  collectTemplateParameters({ templateParamList, withDefaults, }: {
204
70
  templateParamList: TemplateParamListDataModel | undefined;
205
71
  withDefaults?: boolean;
@@ -211,17 +77,6 @@ export declare abstract class CompoundBase {
211
77
  withDefaults?: boolean;
212
78
  }): string;
213
79
  renderTemplateParameterNamesToString(templateParamList: TemplateParamListDataModel | undefined): string;
214
- /**
215
- * Determines whether the compound has any displayable content.
216
- *
217
- * @remarks
218
- * Checks for the presence of brief descriptions, detailed descriptions,
219
- * or member sections to determine if the compound documentation page
220
- * should be generated. Can be overridden by derived classes to add
221
- * additional content checks.
222
- *
223
- * @returns True if the compound has content worth displaying
224
- */
225
80
  hasAnyContent(): boolean;
226
81
  }
227
82
  //# sourceMappingURL=compound-base-vm.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"compound-base-vm.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/compound-base-vm.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAE9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAG1D,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,gEAAgE,CAAA;AAGhH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uDAAuD,CAAA;AAC9F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAA;AAChG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kDAAkD,CAAA;AAMzF,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,wDAAwD,CAAA;AAI/D;;;;;;;;GAQG;AACH,8BAAsB,YAAY;IAChC,gEAAgE;IAChE,IAAI,SAAK;IAET,wCAAwC;IACxC,YAAY,SAAK;IAEjB,0CAA0C;IAC1C,EAAE,SAAK;IAEP,+CAA+C;IAC/C,UAAU,EAAE,cAAc,CAAA;IAE1B,uDAAuD;IACvD,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;IAEnC,6DAA6D;IAC7D,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAA;IAIpC,+DAA+D;IAC/D,MAAM,CAAC,EAAE,YAAY,CAAA;IAErB;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,EAAE,CAAK;IAE1B,kDAAkD;IAClD,QAAQ,EAAE,YAAY,EAAE,CAAK;IAE7B;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,SAAS,CAAA;IAEhC;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IAE7B;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAA;IAErC,2CAA2C;IAC3C,SAAS,SAAK;IAEd,+DAA+D;IAC/D,aAAa,SAAK;IAElB,wCAAwC;IACxC,SAAS,SAAK;IAEd,4DAA4D;IAC5D,0BAA0B,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9C,uEAAuE;IACvE,4BAA4B,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAElD,uEAAuE;IACvE,qBAAqB,UAAQ;IAE7B,qEAAqE;IACrE,aAAa,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAEnC,iEAAiE;IACjE,QAAQ,EAAE,OAAO,EAAE,CAAK;IAExB,sDAAsD;IACtD,WAAW,cAAoB;IAE/B,qDAAqD;IACrD,QAAQ,EAAE,iBAAiB,EAAE,GAAG,SAAS,CAAA;IAEzC,gDAAgD;IAChD,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IAE7D,uEAAuE;IACvE,QAAQ,EAAE;QACR,iDAAiD;QACjD,YAAY,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAA;KAChD,CAAK;IAIN;;;;;;;;;;OAUG;gBACS,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE,oBAAoB;IAuBzE;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI;IAcnD;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,kBAAkB;IAgF1B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,iBAAiB;IAuEzB;;;;;;;;OAQG;IACH,cAAc,IAAI,IAAI;IA8EtB;;;;;;;;;;OAUG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAajC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE;IAI1D,kCAAkC,CAAC,EACjC,0BAA0B,EAC1B,IAAS,EACT,aAAa,GACd,EAAE;QACD,0BAA0B,EAAE,MAAM,GAAG,SAAS,CAAA;QAC9C,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KACnC,GAAG,MAAM;IA8BV,oCAAoC,CAAC,EACnC,0BAA0B,EAC1B,4BAA4B,EAC5B,IAAS,EACT,UAAU,EACV,SAAiB,GAClB,EAAE;QACD,0BAA0B,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC/C,4BAA4B,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;QAClD,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,UAAU,EAAE,OAAO,CAAA;QACnB,SAAS,CAAC,EAAE,OAAO,CAAA;KACpB,GAAG,MAAM,EAAE;IAwDZ,eAAe,IAAI,OAAO;IAI1B,yBAAyB,CAAC,EACxB,QAAa,GACd,EAAE;QACD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;KACpB,GAAG,MAAM,EAAE;IA+IZ,WAAW,IAAI,OAAO;IAItB,2BAA2B,IAAI,MAAM,EAAE;IAavC,0BAA0B,IAAI,MAAM,EAAE;IA4BtC,qBAAqB,IAAI,MAAM,EAAE;IAUjC,qBAAqB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,SAAS,GAAG,MAAM,EAAE;IAmKxE,0BAA0B,IAAI,MAAM,EAAE;IA8CtC,4BAA4B,CAC1B,UAAU,EAAE,kBAAkB,EAAE,GAAG,SAAS,GAC3C,MAAM;IA6BT,8BAA8B,CAC5B,YAAY,EAAE,qBAAqB,EAAE,GAAG,SAAS,GAChD,MAAM;IA2BT;;;;OAIG;IAEH,yBAAyB,CAAC,EACxB,iBAAiB,EACjB,YAAoB,GACrB,EAAE;QACD,iBAAiB,EAAE,0BAA0B,GAAG,SAAS,CAAA;QACzD,YAAY,CAAC,EAAE,OAAO,CAAA;KACvB,GAAG,MAAM,EAAE;IA8CZ,UAAU,CACR,iBAAiB,EAAE,0BAA0B,GAAG,SAAS,GACxD,OAAO;IAIV,6BAA6B,CAC3B,iBAAiB,EAAE,0BAA0B,GAC5C,MAAM,EAAE;IAoCX,gCAAgC,CAAC,EAC/B,iBAAiB,EACjB,YAAoB,GACrB,EAAE;QACD,iBAAiB,EAAE,0BAA0B,GAAG,SAAS,CAAA;QACzD,YAAY,CAAC,EAAE,OAAO,CAAA;KACvB,GAAG,MAAM;IAeV,oCAAoC,CAClC,iBAAiB,EAAE,0BAA0B,GAAG,SAAS,GACxD,MAAM;IAeT;;;;;;;;;;OAUG;IACH,aAAa,IAAI,OAAO;CAsBzB"}
1
+ {"version":3,"file":"compound-base-vm.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/compound-base-vm.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAE9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAG1D,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,gEAAgE,CAAA;AAGhH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uDAAuD,CAAA;AAC9F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAA;AAChG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kDAAkD,CAAA;AAMzF,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,wDAAwD,CAAA;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAa1C,8BAAsB,YAAY;IAEhC,IAAI,SAAK;IAGT,YAAY,SAAK;IAGjB,EAAE,SAAK;IAGP,UAAU,EAAE,cAAc,CAAA;IAG1B,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;IAGnC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAA;IAKpC,MAAM,CAAC,EAAE,YAAY,CAAA;IASrB,WAAW,EAAE,MAAM,EAAE,CAAK;IAG1B,QAAQ,EAAE,YAAY,EAAE,CAAK;IAM7B,YAAY,EAAE,MAAM,GAAG,SAAS,CAAA;IAMhC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IAM7B,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAA;IAGrC,SAAS,SAAK;IAGd,aAAa,SAAK;IAGlB,SAAS,SAAK;IAGd,0BAA0B,EAAE,MAAM,GAAG,SAAS,CAAA;IAE9C,4BAA4B,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAGlD,qBAAqB,UAAQ;IAG7B,aAAa,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAGnC,QAAQ,EAAE,OAAO,EAAE,CAAK;IAGxB,WAAW,cAAoB;IAG/B,QAAQ,EAAE,iBAAiB,EAAE,GAAG,SAAS,CAAA;IAGzC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC,GAAG,SAAS,CAAA;IAG7D,QAAQ,EAAE;QAER,YAAY,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAA;KAChD,CAAK;gBAeM,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE,oBAAoB;IAmCzE,cAAc,CAAC,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI;IA2BnD,OAAO,CAAC,kBAAkB;IA+F1B,OAAO,CAAC,iBAAiB;IAgFzB,cAAc,IAAI,IAAI;IAyFtB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAwBjC,QAAQ,CAAC,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE;IAI1D,kCAAkC,CAAC,EACjC,0BAA0B,EAC1B,IAAS,EACT,aAAa,GACd,EAAE;QACD,0BAA0B,EAAE,MAAM,GAAG,SAAS,CAAA;QAC9C,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KACnC,GAAG,MAAM;IA8BV,oCAAoC,CAAC,EACnC,0BAA0B,EAC1B,4BAA4B,EAC5B,IAAS,EACT,UAAU,EACV,SAAiB,GAClB,EAAE;QACD,0BAA0B,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC/C,4BAA4B,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;QAClD,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,UAAU,EAAE,OAAO,CAAA;QACnB,SAAS,CAAC,EAAE,OAAO,CAAA;KACpB,GAAG,MAAM,EAAE;IA0DZ,eAAe,IAAI,OAAO;IAI1B,yBAAyB,CAAC,EACxB,QAAa,GACd,EAAE;QACD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;KACpB,GAAG,MAAM,EAAE;IA2JZ,0BAA0B,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,EAAE;IAyDzD,WAAW,IAAI,OAAO;IAItB,2BAA2B,IAAI,MAAM,EAAE;IAavC,0BAA0B,IAAI,MAAM,EAAE;IA4BtC,qBAAqB,IAAI,MAAM,EAAE;IAUjC,qBAAqB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,SAAS,GAAG,MAAM,EAAE;IAqKxE,0BAA0B,IAAI,MAAM,EAAE;IA8CtC,4BAA4B,CAC1B,UAAU,EAAE,kBAAkB,EAAE,GAAG,SAAS,GAC3C,MAAM;IA6BT,8BAA8B,CAC5B,YAAY,EAAE,qBAAqB,EAAE,GAAG,SAAS,GAChD,MAAM;IAiCT,yBAAyB,CAAC,EACxB,iBAAiB,EACjB,YAAoB,GACrB,EAAE;QACD,iBAAiB,EAAE,0BAA0B,GAAG,SAAS,CAAA;QACzD,YAAY,CAAC,EAAE,OAAO,CAAA;KACvB,GAAG,MAAM,EAAE;IA8CZ,UAAU,CACR,iBAAiB,EAAE,0BAA0B,GAAG,SAAS,GACxD,OAAO;IAIV,6BAA6B,CAC3B,iBAAiB,EAAE,0BAA0B,GAC5C,MAAM,EAAE;IAoCX,gCAAgC,CAAC,EAC/B,iBAAiB,EACjB,YAAoB,GACrB,EAAE;QACD,iBAAiB,EAAE,0BAA0B,GAAG,SAAS,CAAA;QACzD,YAAY,CAAC,EAAE,OAAO,CAAA;KACvB,GAAG,MAAM;IAeV,oCAAoC,CAClC,iBAAiB,EAAE,0BAA0B,GAAG,SAAS,GACxD,MAAM;IA0BT,aAAa,IAAI,OAAO;CAsBzB"}