@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
@@ -0,0 +1,26 @@
1
+ import { CompoundDefDataModel } from '../../doxygen/data-model/compounds/compounddef-dm.js';
2
+ import { FrontMatter, NavbarItem, SidebarCategory } from '../types.js';
3
+ import { CollectionBase } from './collection-base.js';
4
+ import { CompoundBase } from './compound-base-vm.js';
5
+ export declare class Concepts extends CollectionBase {
6
+ topLevelConcepts: Concept[];
7
+ addChild(compoundDef: CompoundDefDataModel): CompoundBase;
8
+ createCompoundsHierarchies(): void;
9
+ addSidebarItems(sidebarCategory: SidebarCategory): void;
10
+ private createNamespaceItemRecursively;
11
+ private createConceptItem;
12
+ createNavbarItems(): NavbarItem[];
13
+ generateIndexDotMdFile(): Promise<void>;
14
+ private generateNamespacesIndexMdLinesRecursively;
15
+ private generateConceptsIndexMdFile;
16
+ generatePerInitialsIndexMdFiles(): Promise<void>;
17
+ }
18
+ export declare class Concept extends CompoundBase {
19
+ unqualifiedName: string;
20
+ templateParameters: string;
21
+ initializerString: string;
22
+ constructor(collection: Concepts, compoundDef: CompoundDefDataModel);
23
+ initializeLate(): void;
24
+ renderToLines(frontMatter: FrontMatter): string[];
25
+ }
26
+ //# sourceMappingURL=concepts-vm.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"concepts-vm.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/concepts-vm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAA;AAC3F,OAAO,EACL,WAAW,EACX,UAAU,EACV,eAAe,EAGhB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAuBpD,qBAAa,QAAS,SAAQ,cAAc;IAS1C,gBAAgB,EAAE,OAAO,EAAE,CAAK;IAgBhC,QAAQ,CAAC,WAAW,EAAE,oBAAoB,GAAG,YAAY;IAiBzD,0BAA0B,IAAI,IAAI;IAuDlC,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IAoEvD,OAAO,CAAC,8BAA8B;IAwDtC,OAAO,CAAC,iBAAiB;IA4BzB,iBAAiB,IAAI,UAAU,EAAE;IAgBlB,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IAgEtD,OAAO,CAAC,yCAAyC;IA0EjD,OAAO,CAAC,2BAA2B;IA+CpB,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC;CAwBhE;AAcD,qBAAa,OAAQ,SAAQ,YAAY;IASvC,eAAe,SAAQ;IAUvB,kBAAkB,SAAK;IASvB,iBAAiB,SAAQ;gBAeb,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB;IAyC1D,cAAc,IAAI,IAAI;IAiD/B,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE;CA+ClD"}
@@ -0,0 +1,329 @@
1
+ import assert from 'node:assert';
2
+ import { CollectionBase } from './collection-base.js';
3
+ import { CompoundBase } from './compound-base-vm.js';
4
+ import { flattenPath, sanitizeAnonymousNamespace, sanitizeHierarchicalPath, } from '../utils.js';
5
+ import { Namespace } from './namespaces-vm.js';
6
+ import { ConceptEntry } from './tree-entries-vm.js';
7
+ export class Concepts extends CollectionBase {
8
+ topLevelConcepts = [];
9
+ addChild(compoundDef) {
10
+ const concept = new Concept(this, compoundDef);
11
+ this.collectionCompoundsById.set(concept.id, concept);
12
+ return concept;
13
+ }
14
+ createCompoundsHierarchies() {
15
+ for (const concept of this.collectionCompoundsById.values()) {
16
+ assert(concept instanceof Concept);
17
+ if (concept.compoundName.includes('::')) {
18
+ const namespaceCompoundName = concept.compoundName.replace(/::[a-zA-Z0-9_]+$/, '');
19
+ const namespaces = this.workspace.viewModel.collections.get('namespaces');
20
+ assert(namespaces !== undefined);
21
+ const namespace = namespaces.findNamespaceByCompoundName(namespaceCompoundName);
22
+ if (namespace !== undefined) {
23
+ concept.parent = namespace;
24
+ namespace.concepts.push(concept);
25
+ if (this.workspace.options.debug) {
26
+ console.log('concept', concept.compoundName, 'has parent namespace', namespace.compoundName);
27
+ }
28
+ }
29
+ else {
30
+ console.log('concept', concept.compoundName, 'has no parent namespace');
31
+ }
32
+ }
33
+ else {
34
+ if (this.workspace.options.debug) {
35
+ this.topLevelConcepts.push(concept);
36
+ console.log('topLevelConceptId:', concept.id, concept.compoundName);
37
+ }
38
+ }
39
+ }
40
+ }
41
+ addSidebarItems(sidebarCategory) {
42
+ const indicesSet = this.workspace.indicesMaps.get('concepts');
43
+ if (indicesSet === undefined) {
44
+ return;
45
+ }
46
+ const conceptsCategory = {
47
+ type: 'category',
48
+ label: 'Concepts',
49
+ link: {
50
+ type: 'doc',
51
+ id: `${this.workspace.sidebarBaseId}indices/concepts/index`,
52
+ },
53
+ collapsed: true,
54
+ items: [
55
+ {
56
+ type: 'category',
57
+ label: 'Hierarchy',
58
+ link: {
59
+ type: 'doc',
60
+ id: `${this.workspace.sidebarBaseId}indices/concepts/index`,
61
+ },
62
+ collapsed: true,
63
+ items: [],
64
+ },
65
+ ],
66
+ };
67
+ const namespaces = this.workspace.viewModel.collections.get('namespaces');
68
+ if (namespaces !== undefined) {
69
+ for (const namespace of namespaces.topLevelNamespaces) {
70
+ const item = this.createNamespaceItemRecursively(namespace);
71
+ if (item !== undefined) {
72
+ ;
73
+ conceptsCategory.items[0].items.push(item);
74
+ }
75
+ }
76
+ }
77
+ for (const concept of this.topLevelConcepts) {
78
+ const item = this.createConceptItem(concept);
79
+ if (item !== undefined) {
80
+ ;
81
+ conceptsCategory.items[0].items.push(item);
82
+ }
83
+ }
84
+ if (indicesSet.has('all')) {
85
+ conceptsCategory.items.push({
86
+ type: 'doc',
87
+ label: 'All',
88
+ id: `${this.workspace.sidebarBaseId}indices/concepts/all`,
89
+ });
90
+ }
91
+ sidebarCategory.items.push(conceptsCategory);
92
+ }
93
+ createNamespaceItemRecursively(namespace) {
94
+ if (namespace.sidebarLabel === undefined ||
95
+ namespace.sidebarId === undefined) {
96
+ return undefined;
97
+ }
98
+ if (!namespace.hasConcepts()) {
99
+ return undefined;
100
+ }
101
+ const categoryItem = {
102
+ type: 'category',
103
+ label: namespace.sidebarLabel,
104
+ link: {
105
+ type: 'doc',
106
+ id: `${this.workspace.sidebarBaseId}${namespace.sidebarId}`,
107
+ },
108
+ className: 'doxyEllipsis',
109
+ collapsed: true,
110
+ items: [],
111
+ };
112
+ for (const childNamespace of namespace.children) {
113
+ if (childNamespace instanceof Namespace) {
114
+ const item = this.createNamespaceItemRecursively(childNamespace);
115
+ if (item !== undefined) {
116
+ categoryItem.items.push(item);
117
+ }
118
+ }
119
+ }
120
+ for (const concept of namespace.concepts) {
121
+ const item = this.createConceptItem(concept);
122
+ if (item !== undefined) {
123
+ categoryItem.items.push(item);
124
+ }
125
+ }
126
+ return categoryItem;
127
+ }
128
+ createConceptItem(concept) {
129
+ if (concept.sidebarId === undefined || concept.sidebarLabel === undefined) {
130
+ return undefined;
131
+ }
132
+ const item = {
133
+ type: 'category',
134
+ label: concept.sidebarLabel,
135
+ link: {
136
+ type: 'doc',
137
+ id: `${this.workspace.sidebarBaseId}${concept.sidebarId}`,
138
+ },
139
+ collapsed: true,
140
+ items: [],
141
+ };
142
+ return item;
143
+ }
144
+ createNavbarItems() {
145
+ const navbarItem = {
146
+ label: 'Concepts',
147
+ to: `${this.workspace.menuBaseUrl}concepts/`,
148
+ };
149
+ return [navbarItem];
150
+ }
151
+ async generateIndexDotMdFile() {
152
+ const filePath = this.workspace.outputFolderPath + 'indices/concepts/index.md';
153
+ const permalink = 'concepts';
154
+ const frontMatter = {
155
+ title: 'Concepts',
156
+ slug: `${this.workspace.slugBaseUrl}${permalink}`,
157
+ description: 'The C++20 concepts defined in the project',
158
+ custom_edit_url: null,
159
+ keywords: ['doxygen', 'concepts', 'reference'],
160
+ };
161
+ const contentLines = [];
162
+ const namespaces = this.workspace.viewModel.collections.get('namespaces');
163
+ if (namespaces !== undefined) {
164
+ for (const namespace of namespaces.topLevelNamespaces) {
165
+ contentLines.push(...this.generateNamespacesIndexMdLinesRecursively(namespace, 1));
166
+ }
167
+ }
168
+ contentLines.push(...this.generateConceptsIndexMdFile(this.topLevelConcepts, 1));
169
+ if (contentLines.length === 0) {
170
+ return;
171
+ }
172
+ const lines = [];
173
+ lines.push('The C++20 concepts used by this project are:');
174
+ lines.push(...this.workspace.renderTreeTableToHtmlLines({ contentLines }));
175
+ if (this.workspace.options.verbose) {
176
+ console.log(`Writing concepts index file '${filePath}'...`);
177
+ }
178
+ await this.workspace.writeOutputMdFile({
179
+ filePath,
180
+ frontMatter,
181
+ bodyLines: lines,
182
+ });
183
+ return;
184
+ }
185
+ generateNamespacesIndexMdLinesRecursively(namespace, depth) {
186
+ const lines = [];
187
+ const label = this.workspace.renderString(namespace.treeEntryName, 'html');
188
+ const permalink = this.workspace.getPagePermalink(namespace.id);
189
+ if (permalink === undefined || permalink.length === 0) {
190
+ return [];
191
+ }
192
+ if (!namespace.hasConcepts()) {
193
+ return [];
194
+ }
195
+ let description = '';
196
+ if (namespace.briefDescriptionHtmlString !== undefined &&
197
+ namespace.briefDescriptionHtmlString.length > 0) {
198
+ description = namespace.briefDescriptionHtmlString.replace(/[.]$/, '');
199
+ }
200
+ lines.push('');
201
+ lines.push(...this.workspace.renderTreeTableRowToHtmlLines({
202
+ itemIconLetter: 'N',
203
+ itemLabel: label,
204
+ itemLink: permalink,
205
+ depth,
206
+ description,
207
+ }));
208
+ lines.push('');
209
+ lines.push(...this.generateConceptsIndexMdFile(namespace.concepts, depth + 1));
210
+ if (namespace.children.length > 0) {
211
+ for (const childNamespace of namespace.children) {
212
+ if (childNamespace instanceof Namespace) {
213
+ lines.push(...this.generateNamespacesIndexMdLinesRecursively(childNamespace, depth + 1));
214
+ }
215
+ }
216
+ }
217
+ return lines;
218
+ }
219
+ generateConceptsIndexMdFile(concepts, depth) {
220
+ const lines = [];
221
+ for (const concept of concepts) {
222
+ const label = this.workspace.renderString(concept.treeEntryName, 'html');
223
+ const permalink = this.workspace.getPagePermalink(concept.id);
224
+ if (permalink === undefined || permalink.length === 0) {
225
+ continue;
226
+ }
227
+ let description = '';
228
+ if (concept.briefDescriptionHtmlString !== undefined &&
229
+ concept.briefDescriptionHtmlString.length > 0) {
230
+ description = concept.briefDescriptionHtmlString.replace(/[.]$/, '');
231
+ }
232
+ lines.push(...this.workspace.renderTreeTableRowToHtmlLines({
233
+ itemIconLetter: 'R',
234
+ itemLabel: label,
235
+ itemLink: permalink,
236
+ depth,
237
+ description,
238
+ }));
239
+ }
240
+ return lines;
241
+ }
242
+ async generatePerInitialsIndexMdFiles() {
243
+ if (this.collectionCompoundsById.size === 0) {
244
+ return;
245
+ }
246
+ const allUnorderedEntriesMap = new Map();
247
+ for (const [conceptId, concept] of this.collectionCompoundsById) {
248
+ const entry = new ConceptEntry(concept);
249
+ allUnorderedEntriesMap.set(conceptId, entry);
250
+ }
251
+ await this.generateIndexFile({
252
+ group: 'concepts',
253
+ fileKind: 'all',
254
+ title: 'Concepts Definitions Index',
255
+ description: 'The C++20 concepts defined in the project are:',
256
+ map: allUnorderedEntriesMap,
257
+ filter: (kind) => true,
258
+ });
259
+ }
260
+ }
261
+ export class Concept extends CompoundBase {
262
+ unqualifiedName = '???';
263
+ templateParameters = '';
264
+ initializerString = '???';
265
+ constructor(collection, compoundDef) {
266
+ super(collection, compoundDef);
267
+ this.unqualifiedName = sanitizeAnonymousNamespace(compoundDef.compoundName.replace(/.*::/, ''));
268
+ this.indexName = sanitizeAnonymousNamespace(this.compoundName.replace(/.*::/, ''));
269
+ this.pageTitle = `\`${this.unqualifiedName}\` Concept`;
270
+ this.templateParameters = this.renderTemplateParameterNamesToString(compoundDef.templateParamList);
271
+ const sanitizedPath = sanitizeHierarchicalPath(sanitizeAnonymousNamespace(this.compoundName.replaceAll('::', '/')));
272
+ this.relativePermalink = `concepts/${sanitizedPath}`;
273
+ this.sidebarId = `concepts/${flattenPath(sanitizedPath)}`;
274
+ const { unqualifiedName } = this;
275
+ this.sidebarLabel = unqualifiedName;
276
+ this.treeEntryName = this.indexName;
277
+ }
278
+ initializeLate() {
279
+ super.initializeLate();
280
+ const { workspace } = this.collection;
281
+ if (!this.hasAnyContent()) {
282
+ if (!workspace.options.suggestToDoDescriptions) {
283
+ console.log(this.kind, this.compoundName, 'has no content, not shown');
284
+ this.sidebarId = undefined;
285
+ this.sidebarLabel = undefined;
286
+ this.relativePermalink = undefined;
287
+ return;
288
+ }
289
+ else {
290
+ if (workspace.options.verbose) {
291
+ console.log(this.kind, this.compoundName, 'has no content, see the TODO description');
292
+ }
293
+ }
294
+ }
295
+ if (this._private._compoundDef?.initializer !== undefined) {
296
+ this.initializerString = workspace
297
+ .renderElementToLines(this._private._compoundDef.initializer, 'html')
298
+ .join('<br/>\n')
299
+ .replace(/template/, 'template ');
300
+ }
301
+ }
302
+ renderToLines(frontMatter) {
303
+ const lines = [];
304
+ const name = this.collection.workspace.renderString(this.compoundName, 'html');
305
+ const descriptionTodo = `@concept ${name}`;
306
+ const morePermalink = '#details';
307
+ lines.push(this.renderBriefDescriptionToHtmlString({
308
+ briefDescriptionHtmlString: this.briefDescriptionHtmlString,
309
+ todo: descriptionTodo,
310
+ morePermalink,
311
+ }));
312
+ lines.push('');
313
+ lines.push('## Definition');
314
+ lines.push('');
315
+ lines.push('<div class="doxyDefinition">');
316
+ lines.push(this.initializerString);
317
+ lines.push('</div>');
318
+ lines.push(...this.renderDetailedDescriptionToHtmlLines({
319
+ briefDescriptionHtmlString: this.briefDescriptionHtmlString,
320
+ detailedDescriptionHtmlLines: this.detailedDescriptionHtmlLines,
321
+ todo: descriptionTodo,
322
+ showHeader: true,
323
+ showBrief: !this.hasSect1InDescription,
324
+ }));
325
+ lines.push(...this.renderGeneratedFromToLines());
326
+ return lines;
327
+ }
328
+ }
329
+ //# sourceMappingURL=concepts-vm.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"concepts-vm.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/concepts-vm.ts"],"names":[],"mappings":"AAcA,OAAO,MAAM,MAAM,aAAa,CAAA;AAUhC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EACL,WAAW,EACX,0BAA0B,EAC1B,wBAAwB,GACzB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,SAAS,EAAc,MAAM,oBAAoB,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAiB,MAAM,sBAAsB,CAAA;AAgBlE,MAAM,OAAO,QAAS,SAAQ,cAAc;IAS1C,gBAAgB,GAAc,EAAE,CAAA;IAgBhC,QAAQ,CAAC,WAAiC;QACxC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;QAC9C,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;QAErD,OAAO,OAAO,CAAA;IAChB,CAAC;IAYD,0BAA0B;QAExB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,EAAE,CAAC;YAC5D,MAAM,CAAC,OAAO,YAAY,OAAO,CAAC,CAAA;YAElC,IAAI,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxC,MAAM,qBAAqB,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CACxD,kBAAkB,EAClB,EAAE,CACH,CAAA;gBACD,MAAM,UAAU,GACd,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;gBACxD,MAAM,CAAC,UAAU,KAAK,SAAS,CAAC,CAAA;gBAChC,MAAM,SAAS,GACb,UACD,CAAC,2BAA2B,CAAC,qBAAqB,CAAC,CAAA;gBACpD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;oBAC5B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAA;oBAC1B,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;oBAChC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;wBACjC,OAAO,CAAC,GAAG,CACT,SAAS,EACT,OAAO,CAAC,YAAY,EACpB,sBAAsB,EACtB,SAAS,CAAC,YAAY,CACvB,CAAA;oBACH,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,GAAG,CACT,SAAS,EACT,OAAO,CAAC,YAAY,EACpB,yBAAyB,CAC1B,CAAA;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;oBACjC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;oBACnC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;gBACrE,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAcD,eAAe,CAAC,eAAgC;QAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAC7D,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAM;QACR,CAAC;QAED,MAAM,gBAAgB,GAAwB;YAC5C,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE;gBACJ,IAAI,EAAE,KAAK;gBACX,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,wBAAwB;aAC5D;YACD,SAAS,EAAE,IAAI;YACf,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,UAAU;oBAChB,KAAK,EAAE,WAAW;oBAClB,IAAI,EAAE;wBACJ,IAAI,EAAE,KAAK;wBACX,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,wBAAwB;qBAC5D;oBACD,SAAS,EAAE,IAAI;oBACf,KAAK,EAAE,EAAE;iBACV;aACF;SACF,CAAA;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;QACzE,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,KAAK,MAAM,SAAS,IAAK,UAAyB,CAAC,kBAAkB,EAAE,CAAC;gBACtE,MAAM,IAAI,GAAG,IAAI,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAA;gBAC3D,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;oBACvB,CAAC;oBAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAyB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACtE,CAAC;YACH,CAAC;QACH,CAAC;QAED,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAA;YAC5C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,CAAC;gBAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAyB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACtE,CAAC;QACH,CAAC;QAED,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC1B,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,KAAK;gBACZ,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,sBAAsB;aAC1D,CAAC,CAAA;QACJ,CAAC;QAED,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;IAC9C,CAAC;IAcO,8BAA8B,CACpC,SAAoB;QAEpB,IACE,SAAS,CAAC,YAAY,KAAK,SAAS;YACpC,SAAS,CAAC,SAAS,KAAK,SAAS,EACjC,CAAC;YACD,OAAO,SAAS,CAAA;QAClB,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC;YAC7B,OAAO,SAAS,CAAA;QAClB,CAAC;QAED,MAAM,YAAY,GAAwB;YACxC,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,SAAS,CAAC,YAAY;YAC7B,IAAI,EAAE;gBACJ,IAAI,EAAE,KAAK;gBACX,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,SAAS,CAAC,SAAS,EAAE;aAC5D;YACD,SAAS,EAAE,cAAc;YACzB,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,EAAE;SACV,CAAA;QAED,KAAK,MAAM,cAAc,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;YAChD,IAAI,cAAc,YAAY,SAAS,EAAE,CAAC;gBACxC,MAAM,IAAI,GAAG,IAAI,CAAC,8BAA8B,CAAC,cAAc,CAAC,CAAA;gBAChE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;oBACvB,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBAC/B,CAAC;YACH,CAAC;QACH,CAAC;QAED,KAAK,MAAM,OAAO,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAA;YAC5C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;IAaO,iBAAiB,CAAC,OAAgB;QACxC,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YAC1E,OAAO,SAAS,CAAA;QAClB,CAAC;QAED,MAAM,IAAI,GAAwB;YAChC,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,OAAO,CAAC,YAAY;YAC3B,IAAI,EAAE;gBACJ,IAAI,EAAE,KAAK;gBACX,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,OAAO,CAAC,SAAS,EAAE;aAC1D;YACD,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,EAAE;SACV,CAAA;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAWD,iBAAiB;QACf,MAAM,UAAU,GAAe;YAC7B,KAAK,EAAE,UAAU;YACjB,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,WAAW;SAC7C,CAAA;QACD,OAAO,CAAC,UAAU,CAAC,CAAA;IACrB,CAAC;IAUQ,KAAK,CAAC,sBAAsB;QACnC,MAAM,QAAQ,GACZ,IAAI,CAAC,SAAS,CAAC,gBAAgB,GAAG,2BAA2B,CAAA;QAC/D,MAAM,SAAS,GAAG,UAAU,CAAA;QAE5B,MAAM,WAAW,GAAgB;YAC/B,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,SAAS,EAAE;YACjD,WAAW,EAAE,2CAA2C;YACxD,eAAe,EAAE,IAAI;YACrB,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC;SAC/C,CAAA;QAED,MAAM,YAAY,GAAa,EAAE,CAAA;QAEjC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;QACzE,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,KAAK,MAAM,SAAS,IAAK,UAAyB,CAAC,kBAAkB,EAAE,CAAC;gBACtE,YAAY,CAAC,IAAI,CACf,GAAG,IAAI,CAAC,yCAAyC,CAAC,SAAS,EAAE,CAAC,CAAC,CAChE,CAAA;YACH,CAAC;QACH,CAAC;QAED,YAAY,CAAC,IAAI,CACf,GAAG,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAC9D,CAAA;QAED,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,OAAM;QACR,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAA;QAE1D,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAA;QAE1E,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACnC,OAAO,CAAC,GAAG,CAAC,gCAAgC,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;QAEF,OAAM;IACR,CAAC;IAeO,yCAAyC,CAC/C,SAAoB,EACpB,KAAa;QAIb,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;QAE1E,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;QAC/D,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAEtD,OAAO,EAAE,CAAA;QACX,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC;YAC7B,OAAO,EAAE,CAAA;QACX,CAAC;QAID,IAAI,WAAW,GAAG,EAAE,CAAA;QACpB,IACE,SAAS,CAAC,0BAA0B,KAAK,SAAS;YAClD,SAAS,CAAC,0BAA0B,CAAC,MAAM,GAAG,CAAC,EAC/C,CAAC;YACD,WAAW,GAAG,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;QACxE,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAAC;YAC9C,cAAc,EAAE,GAAG;YACnB,SAAS,EAAE,KAAK;YAChB,QAAQ,EAAE,SAAS;YACnB,KAAK;YACL,WAAW;SACZ,CAAC,CACH,CAAA;QAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,2BAA2B,CAAC,SAAS,CAAC,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CACnE,CAAA;QAED,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,KAAK,MAAM,cAAc,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;gBAChD,IAAI,cAAc,YAAY,SAAS,EAAE,CAAC;oBACxC,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,yCAAyC,CAC/C,cAAc,EACd,KAAK,GAAG,CAAC,CACV,CACF,CAAA;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAcO,2BAA2B,CACjC,QAAmB,EACnB,KAAa;QAIb,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;YAExE,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAC7D,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAEtD,SAAQ;YACV,CAAC;YAED,IAAI,WAAW,GAAG,EAAE,CAAA;YACpB,IACE,OAAO,CAAC,0BAA0B,KAAK,SAAS;gBAChD,OAAO,CAAC,0BAA0B,CAAC,MAAM,GAAG,CAAC,EAC7C,CAAC;gBACD,WAAW,GAAG,OAAO,CAAC,0BAA0B,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;YACtE,CAAC;YAED,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAAC;gBAC9C,cAAc,EAAE,GAAG;gBACnB,SAAS,EAAE,KAAK;gBAChB,QAAQ,EAAE,SAAS;gBACnB,KAAK;gBACL,WAAW;aACZ,CAAC,CACH,CAAA;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAUQ,KAAK,CAAC,+BAA+B;QAC5C,IAAI,IAAI,CAAC,uBAAuB,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAC5C,OAAM;QACR,CAAC;QAED,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAyB,CAAA;QAE/D,KAAK,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAChE,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,OAAkB,CAAC,CAAA;YAClD,sBAAsB,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QAC9C,CAAC;QAID,MAAM,IAAI,CAAC,iBAAiB,CAAC;YAC3B,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,4BAA4B;YACnC,WAAW,EAAE,gDAAgD;YAC7D,GAAG,EAAE,sBAAsB;YAE3B,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI;SACvB,CAAC,CAAA;IACJ,CAAC;CACF;AAcD,MAAM,OAAO,OAAQ,SAAQ,YAAY;IASvC,eAAe,GAAG,KAAK,CAAA;IAUvB,kBAAkB,GAAG,EAAE,CAAA;IASvB,iBAAiB,GAAG,KAAK,CAAA;IAezB,YAAY,UAAoB,EAAE,WAAiC;QACjE,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;QAM9B,IAAI,CAAC,eAAe,GAAG,0BAA0B,CAC/C,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAC7C,CAAA;QACD,IAAI,CAAC,SAAS,GAAG,0BAA0B,CACzC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CACtC,CAAA;QAED,IAAI,CAAC,SAAS,GAAG,KAAK,IAAI,CAAC,eAAe,YAAY,CAAA;QAEtD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,oCAAoC,CACjE,WAAW,CAAC,iBAAiB,CAC9B,CAAA;QAED,MAAM,aAAa,GAAW,wBAAwB,CACpD,0BAA0B,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CACpE,CAAA;QAED,IAAI,CAAC,iBAAiB,GAAG,YAAY,aAAa,EAAE,CAAA;QACpD,IAAI,CAAC,SAAS,GAAG,YAAY,WAAW,CAAC,aAAa,CAAC,EAAE,CAAA;QACzD,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,CAAA;QAChC,IAAI,CAAC,YAAY,GAAG,eAAe,CAAA;QAEnC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAA;IACrC,CAAC;IAWQ,cAAc;QACrB,KAAK,CAAC,cAAc,EAAE,CAAA;QAEtB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,UAAU,CAAA;QAGrC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YAC1B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;gBAC/C,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,2BAA2B,CAAC,CAAA;gBAEtE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;gBAC1B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAA;gBAC7B,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAA;gBAElC,OAAM;YACR,CAAC;iBAAM,CAAC;gBACN,IAAI,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oBAC9B,OAAO,CAAC,GAAG,CACT,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,YAAY,EACjB,0CAA0C,CAC3C,CAAA;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAID,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,WAAW,KAAK,SAAS,EAAE,CAAC;YAC1D,IAAI,CAAC,iBAAiB,GAAG,SAAS;iBAC/B,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC;iBACpE,IAAI,CAAC,SAAS,CAAC;iBACf,OAAO,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;QACrC,CAAC;IACH,CAAC;IAeD,aAAa,CAAC,WAAwB;QACpC,MAAM,KAAK,GAAa,EAAE,CAAA;QAI1B,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CACjD,IAAI,CAAC,YAAY,EACjB,MAAM,CACP,CAAA;QACD,MAAM,eAAe,GAAG,YAAY,IAAI,EAAE,CAAA;QAG1C,MAAM,aAAa,GAAG,UAAU,CAAA;QAEhC,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,kCAAkC,CAAC;YACtC,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,IAAI,EAAE,eAAe;YACrB,aAAa;SACd,CAAC,CACH,CAAA;QAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;QAE3B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAA;QAE1C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;QAClC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAEpB,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,oCAAoC,CAAC;YAC3C,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,4BAA4B,EAAE,IAAI,CAAC,4BAA4B;YAC/D,IAAI,EAAE,eAAe;YACrB,UAAU,EAAE,IAAI;YAChB,SAAS,EAAE,CAAC,IAAI,CAAC,qBAAqB;SACvC,CAAC,CACH,CAAA;QAID,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC,CAAA;QAEhD,OAAO,KAAK,CAAA;IACd,CAAC;CACF"}
@@ -1,75 +1,17 @@
1
1
  import type { CompoundBase } from './compound-base-vm.js';
2
- /**
3
- * Represents an anchor within a description section for cross-referencing.
4
- *
5
- * @remarks
6
- * Used to create navigable links within documentation pages, allowing
7
- * users to jump to specific sections or content areas within compound
8
- * descriptions.
9
- *
10
- * @public
11
- */
12
2
  export declare class DescriptionAnchor {
13
3
  compound: CompoundBase;
14
4
  id: string;
15
- /**
16
- * Creates a new description anchor instance.
17
- *
18
- * @remarks
19
- * Associates an anchor identifier with a specific compound to enable
20
- * targeted navigation within the documentation structure.
21
- *
22
- * @param compound - The compound that contains this anchor
23
- * @param id - Unique identifier for the anchor
24
- */
25
5
  constructor(compound: CompoundBase, id: string);
26
6
  }
27
- /**
28
- * Manages a table of contents list for a compound's description.
29
- *
30
- * @remarks
31
- * Organises the hierarchical structure of content within a compound
32
- * description, providing navigation aids for users browsing complex
33
- * documentation sections.
34
- *
35
- * @public
36
- */
37
7
  export declare class DescriptionTocList {
38
8
  compound: CompoundBase;
39
9
  tocItems: DescriptionTocItem[];
40
- /**
41
- * Creates a new description table of contents list.
42
- *
43
- * @remarks
44
- * Initialises an empty collection of TOC items for the specified
45
- * compound, ready to be populated with navigational entries.
46
- *
47
- * @param compound - The compound that owns this table of contents
48
- */
49
10
  constructor(compound: CompoundBase);
50
11
  }
51
- /**
52
- * Represents an individual item within a description table of contents.
53
- *
54
- * @remarks
55
- * Each TOC item corresponds to a specific section or anchor within the
56
- * compound description, providing structured navigation capabilities.
57
- *
58
- * @public
59
- */
60
12
  export declare class DescriptionTocItem {
61
13
  id: string;
62
14
  tocList: DescriptionTocList;
63
- /**
64
- * Creates a new table of contents item.
65
- *
66
- * @remarks
67
- * Links a specific identifier to its parent TOC list, establishing
68
- * the hierarchical relationship between content sections.
69
- *
70
- * @param id - Unique identifier for this TOC item
71
- * @param tocList - The parent table of contents list
72
- */
73
15
  constructor(id: string, tocList: DescriptionTocList);
74
16
  }
75
17
  //# sourceMappingURL=description-anchors.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"description-anchors.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/description-anchors.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAIzD;;;;;;;;;GASG;AACH,qBAAa,iBAAiB;IAC5B,QAAQ,EAAE,YAAY,CAAA;IACtB,EAAE,EAAE,MAAM,CAAA;IAEV;;;;;;;;;OASG;gBACS,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM;CAI/C;AAID;;;;;;;;;GASG;AACH,qBAAa,kBAAkB;IAC7B,QAAQ,EAAE,YAAY,CAAA;IACtB,QAAQ,EAAE,kBAAkB,EAAE,CAAK;IAEnC;;;;;;;;OAQG;gBACS,QAAQ,EAAE,YAAY;CAGnC;AAED;;;;;;;;GAQG;AACH,qBAAa,kBAAkB;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,kBAAkB,CAAA;IAE3B;;;;;;;;;OASG;gBACS,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB;CAIpD"}
1
+ {"version":3,"file":"description-anchors.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/description-anchors.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAczD,qBAAa,iBAAiB;IAC5B,QAAQ,EAAE,YAAY,CAAA;IACtB,EAAE,EAAE,MAAM,CAAA;gBAYE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM;CAI/C;AAcD,qBAAa,kBAAkB;IAC7B,QAAQ,EAAE,YAAY,CAAA;IACtB,QAAQ,EAAE,kBAAkB,EAAE,CAAK;gBAWvB,QAAQ,EAAE,YAAY;CAGnC;AAWD,qBAAa,kBAAkB;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,kBAAkB,CAAA;gBAYf,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB;CAIpD"}
@@ -1,95 +1,24 @@
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
- /**
13
- * Represents an anchor within a description section for cross-referencing.
14
- *
15
- * @remarks
16
- * Used to create navigable links within documentation pages, allowing
17
- * users to jump to specific sections or content areas within compound
18
- * descriptions.
19
- *
20
- * @public
21
- */
22
1
  export class DescriptionAnchor {
23
2
  compound;
24
3
  id;
25
- /**
26
- * Creates a new description anchor instance.
27
- *
28
- * @remarks
29
- * Associates an anchor identifier with a specific compound to enable
30
- * targeted navigation within the documentation structure.
31
- *
32
- * @param compound - The compound that contains this anchor
33
- * @param id - Unique identifier for the anchor
34
- */
35
4
  constructor(compound, id) {
36
5
  this.compound = compound;
37
6
  this.id = id;
38
7
  }
39
8
  }
40
- // ----------------------------------------------------------------------------
41
- /**
42
- * Manages a table of contents list for a compound's description.
43
- *
44
- * @remarks
45
- * Organises the hierarchical structure of content within a compound
46
- * description, providing navigation aids for users browsing complex
47
- * documentation sections.
48
- *
49
- * @public
50
- */
51
9
  export class DescriptionTocList {
52
10
  compound;
53
11
  tocItems = [];
54
- /**
55
- * Creates a new description table of contents list.
56
- *
57
- * @remarks
58
- * Initialises an empty collection of TOC items for the specified
59
- * compound, ready to be populated with navigational entries.
60
- *
61
- * @param compound - The compound that owns this table of contents
62
- */
63
12
  constructor(compound) {
64
13
  this.compound = compound;
65
14
  }
66
15
  }
67
- /**
68
- * Represents an individual item within a description table of contents.
69
- *
70
- * @remarks
71
- * Each TOC item corresponds to a specific section or anchor within the
72
- * compound description, providing structured navigation capabilities.
73
- *
74
- * @public
75
- */
76
16
  export class DescriptionTocItem {
77
17
  id;
78
18
  tocList;
79
- /**
80
- * Creates a new table of contents item.
81
- *
82
- * @remarks
83
- * Links a specific identifier to its parent TOC list, establishing
84
- * the hierarchical relationship between content sections.
85
- *
86
- * @param id - Unique identifier for this TOC item
87
- * @param tocList - The parent table of contents list
88
- */
89
19
  constructor(id, tocList) {
90
20
  this.id = id;
91
21
  this.tocList = tocList;
92
22
  }
93
23
  }
94
- // ----------------------------------------------------------------------------
95
24
  //# sourceMappingURL=description-anchors.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"description-anchors.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/description-anchors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAMH,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,iBAAiB;IAC5B,QAAQ,CAAc;IACtB,EAAE,CAAQ;IAEV;;;;;;;;;OASG;IACH,YAAY,QAAsB,EAAE,EAAU;QAC5C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACd,CAAC;CACF;AAED,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,kBAAkB;IAC7B,QAAQ,CAAc;IACtB,QAAQ,GAAyB,EAAE,CAAA;IAEnC;;;;;;;;OAQG;IACH,YAAY,QAAsB;QAChC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,OAAO,kBAAkB;IAC7B,EAAE,CAAQ;IACV,OAAO,CAAoB;IAE3B;;;;;;;;;OASG;IACH,YAAY,EAAU,EAAE,OAA2B;QACjD,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;QACZ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"description-anchors.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/description-anchors.ts"],"names":[],"mappings":"AA2BA,MAAM,OAAO,iBAAiB;IAC5B,QAAQ,CAAc;IACtB,EAAE,CAAQ;IAYV,YAAY,QAAsB,EAAE,EAAU;QAC5C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACd,CAAC;CACF;AAcD,MAAM,OAAO,kBAAkB;IAC7B,QAAQ,CAAc;IACtB,QAAQ,GAAyB,EAAE,CAAA;IAWnC,YAAY,QAAsB;QAChC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AAWD,MAAM,OAAO,kBAAkB;IAC7B,EAAE,CAAQ;IACV,OAAO,CAAoB;IAY3B,YAAY,EAAU,EAAE,OAA2B;QACjD,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;QACZ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF"}