@xpack/doxygen2docusaurus 1.0.2 → 2.0.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 (267) hide show
  1. package/README.md +3 -4
  2. package/dist/cli/main.d.ts +6 -0
  3. package/dist/cli/main.d.ts.map +1 -1
  4. package/dist/cli/main.js +29 -2
  5. package/dist/cli/main.js.map +1 -1
  6. package/dist/docusaurus/cli-options.d.ts +268 -39
  7. package/dist/docusaurus/cli-options.d.ts.map +1 -1
  8. package/dist/docusaurus/cli-options.js +267 -53
  9. package/dist/docusaurus/cli-options.js.map +1 -1
  10. package/dist/docusaurus/generator.d.ts +179 -4
  11. package/dist/docusaurus/generator.d.ts.map +1 -1
  12. package/dist/docusaurus/generator.js +215 -45
  13. package/dist/docusaurus/generator.js.map +1 -1
  14. package/dist/docusaurus/renderers/descriptiontype.d.ts +417 -0
  15. package/dist/docusaurus/renderers/descriptiontype.d.ts.map +1 -1
  16. package/dist/docusaurus/renderers/descriptiontype.js +417 -0
  17. package/dist/docusaurus/renderers/descriptiontype.js.map +1 -1
  18. package/dist/docusaurus/renderers/docinternalstype.d.ts +132 -0
  19. package/dist/docusaurus/renderers/docinternalstype.d.ts.map +1 -1
  20. package/dist/docusaurus/renderers/docinternalstype.js +132 -0
  21. package/dist/docusaurus/renderers/docinternalstype.js.map +1 -1
  22. package/dist/docusaurus/renderers/doclisttype.d.ts +22 -0
  23. package/dist/docusaurus/renderers/doclisttype.d.ts.map +1 -1
  24. package/dist/docusaurus/renderers/doclisttype.js +22 -2
  25. package/dist/docusaurus/renderers/doclisttype.js.map +1 -1
  26. package/dist/docusaurus/renderers/doctabletype.d.ts +88 -0
  27. package/dist/docusaurus/renderers/doctabletype.d.ts.map +1 -1
  28. package/dist/docusaurus/renderers/doctabletype.js +88 -0
  29. package/dist/docusaurus/renderers/doctabletype.js.map +1 -1
  30. package/dist/docusaurus/renderers/doctitletype.d.ts +22 -0
  31. package/dist/docusaurus/renderers/doctitletype.d.ts.map +1 -1
  32. package/dist/docusaurus/renderers/doctitletype.js +22 -0
  33. package/dist/docusaurus/renderers/doctitletype.js.map +1 -1
  34. package/dist/docusaurus/renderers/docvariablelisttype.d.ts +44 -0
  35. package/dist/docusaurus/renderers/docvariablelisttype.d.ts.map +1 -1
  36. package/dist/docusaurus/renderers/docvariablelisttype.js +44 -0
  37. package/dist/docusaurus/renderers/docvariablelisttype.js.map +1 -1
  38. package/dist/docusaurus/renderers/docxrefsecttype.d.ts +22 -0
  39. package/dist/docusaurus/renderers/docxrefsecttype.d.ts.map +1 -1
  40. package/dist/docusaurus/renderers/docxrefsecttype.js +22 -0
  41. package/dist/docusaurus/renderers/docxrefsecttype.js.map +1 -1
  42. package/dist/docusaurus/renderers/element-renderer-base.d.ts +74 -0
  43. package/dist/docusaurus/renderers/element-renderer-base.d.ts.map +1 -1
  44. package/dist/docusaurus/renderers/element-renderer-base.js +52 -0
  45. package/dist/docusaurus/renderers/element-renderer-base.js.map +1 -1
  46. package/dist/docusaurus/renderers/inctype.d.ts +23 -0
  47. package/dist/docusaurus/renderers/inctype.d.ts.map +1 -1
  48. package/dist/docusaurus/renderers/inctype.js +23 -0
  49. package/dist/docusaurus/renderers/inctype.js.map +1 -1
  50. package/dist/docusaurus/renderers/linkedtexttype.d.ts +22 -0
  51. package/dist/docusaurus/renderers/linkedtexttype.d.ts.map +1 -1
  52. package/dist/docusaurus/renderers/linkedtexttype.js +22 -0
  53. package/dist/docusaurus/renderers/linkedtexttype.js.map +1 -1
  54. package/dist/docusaurus/renderers/listingtype.d.ts +52 -0
  55. package/dist/docusaurus/renderers/listingtype.d.ts.map +1 -1
  56. package/dist/docusaurus/renderers/listingtype.js +66 -2
  57. package/dist/docusaurus/renderers/listingtype.js.map +1 -1
  58. package/dist/docusaurus/renderers/paramtype.d.ts +22 -0
  59. package/dist/docusaurus/renderers/paramtype.d.ts.map +1 -1
  60. package/dist/docusaurus/renderers/paramtype.js +22 -0
  61. package/dist/docusaurus/renderers/paramtype.js.map +1 -1
  62. package/dist/docusaurus/renderers/referencetype.d.ts +23 -0
  63. package/dist/docusaurus/renderers/referencetype.d.ts.map +1 -1
  64. package/dist/docusaurus/renderers/referencetype.js +23 -2
  65. package/dist/docusaurus/renderers/referencetype.js.map +1 -1
  66. package/dist/docusaurus/renderers/reftexttype.d.ts +22 -0
  67. package/dist/docusaurus/renderers/reftexttype.d.ts.map +1 -1
  68. package/dist/docusaurus/renderers/reftexttype.js +22 -0
  69. package/dist/docusaurus/renderers/reftexttype.js.map +1 -1
  70. package/dist/docusaurus/renderers/reftype.d.ts +22 -0
  71. package/dist/docusaurus/renderers/reftype.d.ts.map +1 -1
  72. package/dist/docusaurus/renderers/reftype.js +22 -0
  73. package/dist/docusaurus/renderers/reftype.js.map +1 -1
  74. package/dist/docusaurus/renderers/renderers.d.ts +151 -0
  75. package/dist/docusaurus/renderers/renderers.d.ts.map +1 -1
  76. package/dist/docusaurus/renderers/renderers.js +151 -0
  77. package/dist/docusaurus/renderers/renderers.js.map +1 -1
  78. package/dist/docusaurus/renderers/substringtype.d.ts +22 -0
  79. package/dist/docusaurus/renderers/substringtype.d.ts.map +1 -1
  80. package/dist/docusaurus/renderers/substringtype.js +22 -0
  81. package/dist/docusaurus/renderers/substringtype.js.map +1 -1
  82. package/dist/docusaurus/renderers/tableofcontentstype.d.ts +22 -0
  83. package/dist/docusaurus/renderers/tableofcontentstype.d.ts.map +1 -1
  84. package/dist/docusaurus/renderers/tableofcontentstype.js +22 -0
  85. package/dist/docusaurus/renderers/tableofcontentstype.js.map +1 -1
  86. package/dist/docusaurus/types.d.ts +114 -8
  87. package/dist/docusaurus/types.d.ts.map +1 -1
  88. package/dist/docusaurus/types.js.map +1 -1
  89. package/dist/docusaurus/utils.d.ts +214 -0
  90. package/dist/docusaurus/utils.d.ts.map +1 -1
  91. package/dist/docusaurus/utils.js +214 -0
  92. package/dist/docusaurus/utils.js.map +1 -1
  93. package/dist/docusaurus/view-model/classes-vm.d.ts +139 -2
  94. package/dist/docusaurus/view-model/classes-vm.d.ts.map +1 -1
  95. package/dist/docusaurus/view-model/classes-vm.js +147 -6
  96. package/dist/docusaurus/view-model/classes-vm.js.map +1 -1
  97. package/dist/docusaurus/view-model/collection-base.d.ts +122 -2
  98. package/dist/docusaurus/view-model/collection-base.d.ts.map +1 -1
  99. package/dist/docusaurus/view-model/collection-base.js +78 -0
  100. package/dist/docusaurus/view-model/collection-base.js.map +1 -1
  101. package/dist/docusaurus/view-model/compound-base-vm.d.ts +134 -19
  102. package/dist/docusaurus/view-model/compound-base-vm.d.ts.map +1 -1
  103. package/dist/docusaurus/view-model/compound-base-vm.js +122 -26
  104. package/dist/docusaurus/view-model/compound-base-vm.js.map +1 -1
  105. package/dist/docusaurus/view-model/description-anchors.d.ts +58 -0
  106. package/dist/docusaurus/view-model/description-anchors.d.ts.map +1 -1
  107. package/dist/docusaurus/view-model/description-anchors.js +58 -0
  108. package/dist/docusaurus/view-model/description-anchors.js.map +1 -1
  109. package/dist/docusaurus/view-model/files-and-folders-vm.d.ts +249 -2
  110. package/dist/docusaurus/view-model/files-and-folders-vm.d.ts.map +1 -1
  111. package/dist/docusaurus/view-model/files-and-folders-vm.js +250 -4
  112. package/dist/docusaurus/view-model/files-and-folders-vm.js.map +1 -1
  113. package/dist/docusaurus/view-model/groups-vm.d.ts +150 -2
  114. package/dist/docusaurus/view-model/groups-vm.d.ts.map +1 -1
  115. package/dist/docusaurus/view-model/groups-vm.js +153 -5
  116. package/dist/docusaurus/view-model/groups-vm.js.map +1 -1
  117. package/dist/docusaurus/view-model/members-vm.d.ts +552 -0
  118. package/dist/docusaurus/view-model/members-vm.d.ts.map +1 -1
  119. package/dist/docusaurus/view-model/members-vm.js +552 -4
  120. package/dist/docusaurus/view-model/members-vm.js.map +1 -1
  121. package/dist/docusaurus/view-model/namespaces-vm.d.ts +201 -2
  122. package/dist/docusaurus/view-model/namespaces-vm.d.ts.map +1 -1
  123. package/dist/docusaurus/view-model/namespaces-vm.js +202 -4
  124. package/dist/docusaurus/view-model/namespaces-vm.js.map +1 -1
  125. package/dist/docusaurus/view-model/options.d.ts +43 -0
  126. package/dist/docusaurus/view-model/options.d.ts.map +1 -1
  127. package/dist/docusaurus/view-model/options.js +43 -0
  128. package/dist/docusaurus/view-model/options.js.map +1 -1
  129. package/dist/docusaurus/view-model/pages-vm.d.ts +117 -2
  130. package/dist/docusaurus/view-model/pages-vm.d.ts.map +1 -1
  131. package/dist/docusaurus/view-model/pages-vm.js +119 -4
  132. package/dist/docusaurus/view-model/pages-vm.js.map +1 -1
  133. package/dist/docusaurus/view-model/tree-entries-vm.d.ts +135 -15
  134. package/dist/docusaurus/view-model/tree-entries-vm.d.ts.map +1 -1
  135. package/dist/docusaurus/view-model/tree-entries-vm.js +136 -16
  136. package/dist/docusaurus/view-model/tree-entries-vm.js.map +1 -1
  137. package/dist/docusaurus/view-model/view-model.d.ts +119 -0
  138. package/dist/docusaurus/view-model/view-model.d.ts.map +1 -1
  139. package/dist/docusaurus/view-model/view-model.js +119 -0
  140. package/dist/docusaurus/view-model/view-model.js.map +1 -1
  141. package/dist/docusaurus/workspace.d.ts +106 -0
  142. package/dist/docusaurus/workspace.d.ts.map +1 -1
  143. package/dist/docusaurus/workspace.js +107 -1
  144. package/dist/docusaurus/workspace.js.map +1 -1
  145. package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts +485 -0
  146. package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts.map +1 -1
  147. package/dist/doxygen/data-model/compounds/compounddef-dm.js +485 -0
  148. package/dist/doxygen/data-model/compounds/compounddef-dm.js.map +1 -1
  149. package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts +120 -0
  150. package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts.map +1 -1
  151. package/dist/doxygen/data-model/compounds/compoundreftype-dm.js +98 -0
  152. package/dist/doxygen/data-model/compounds/compoundreftype-dm.js.map +1 -1
  153. package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts +2705 -0
  154. package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts.map +1 -1
  155. package/dist/doxygen/data-model/compounds/descriptiontype-dm.js +2677 -47
  156. package/dist/doxygen/data-model/compounds/descriptiontype-dm.js.map +1 -1
  157. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts +165 -0
  158. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts.map +1 -1
  159. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js +165 -0
  160. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js.map +1 -1
  161. package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts +70 -0
  162. package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts.map +1 -1
  163. package/dist/doxygen/data-model/compounds/doxygentype-dm.js +70 -0
  164. package/dist/doxygen/data-model/compounds/doxygentype-dm.js.map +1 -1
  165. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts +78 -0
  166. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts.map +1 -1
  167. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js +78 -0
  168. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js.map +1 -1
  169. package/dist/doxygen/data-model/compounds/inctype-dm.d.ts +107 -0
  170. package/dist/doxygen/data-model/compounds/inctype-dm.d.ts.map +1 -1
  171. package/dist/doxygen/data-model/compounds/inctype-dm.js +107 -0
  172. package/dist/doxygen/data-model/compounds/inctype-dm.js.map +1 -1
  173. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts +123 -0
  174. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts.map +1 -1
  175. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js +123 -0
  176. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js.map +1 -1
  177. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts +70 -0
  178. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts.map +1 -1
  179. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js +70 -1
  180. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js.map +1 -1
  181. package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts +156 -0
  182. package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts.map +1 -1
  183. package/dist/doxygen/data-model/compounds/locationtype-dm.js +156 -5
  184. package/dist/doxygen/data-model/compounds/locationtype-dm.js.map +1 -1
  185. package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts +433 -0
  186. package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts.map +1 -1
  187. package/dist/doxygen/data-model/compounds/memberdeftype-dm.js +417 -6
  188. package/dist/doxygen/data-model/compounds/memberdeftype-dm.js.map +1 -1
  189. package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts +135 -0
  190. package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts.map +1 -1
  191. package/dist/doxygen/data-model/compounds/memberreftype-dm.js +136 -4
  192. package/dist/doxygen/data-model/compounds/memberreftype-dm.js.map +1 -1
  193. package/dist/doxygen/data-model/compounds/membertype-dm.d.ts +95 -0
  194. package/dist/doxygen/data-model/compounds/membertype-dm.d.ts.map +1 -1
  195. package/dist/doxygen/data-model/compounds/membertype-dm.js +76 -4
  196. package/dist/doxygen/data-model/compounds/membertype-dm.js.map +1 -1
  197. package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts +158 -0
  198. package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts.map +1 -1
  199. package/dist/doxygen/data-model/compounds/paramtype-dm.js +158 -1
  200. package/dist/doxygen/data-model/compounds/paramtype-dm.js.map +1 -1
  201. package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts +130 -0
  202. package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts.map +1 -1
  203. package/dist/doxygen/data-model/compounds/referencetype-dm.js +130 -2
  204. package/dist/doxygen/data-model/compounds/referencetype-dm.js.map +1 -1
  205. package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts +120 -0
  206. package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts.map +1 -1
  207. package/dist/doxygen/data-model/compounds/reftexttype-dm.js +106 -3
  208. package/dist/doxygen/data-model/compounds/reftexttype-dm.js.map +1 -1
  209. package/dist/doxygen/data-model/compounds/reftype-dm.d.ts +247 -0
  210. package/dist/doxygen/data-model/compounds/reftype-dm.d.ts.map +1 -1
  211. package/dist/doxygen/data-model/compounds/reftype-dm.js +247 -3
  212. package/dist/doxygen/data-model/compounds/reftype-dm.js.map +1 -1
  213. package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts +99 -0
  214. package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts.map +1 -1
  215. package/dist/doxygen/data-model/compounds/reimplementtype-dm.js +99 -2
  216. package/dist/doxygen/data-model/compounds/reimplementtype-dm.js.map +1 -1
  217. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts +159 -0
  218. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts.map +1 -1
  219. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js +159 -3
  220. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js.map +1 -1
  221. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts +255 -0
  222. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts.map +1 -1
  223. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js +255 -6
  224. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js.map +1 -1
  225. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts +60 -0
  226. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts.map +1 -1
  227. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js +60 -1
  228. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js.map +1 -1
  229. package/dist/doxygen/data-model/data-model.d.ts +86 -2
  230. package/dist/doxygen/data-model/data-model.d.ts.map +1 -1
  231. package/dist/doxygen/data-model/data-model.js +86 -4
  232. package/dist/doxygen/data-model/data-model.js.map +1 -1
  233. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts +109 -0
  234. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts.map +1 -1
  235. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js +84 -2
  236. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js.map +1 -1
  237. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts +81 -0
  238. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts.map +1 -1
  239. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js +81 -3
  240. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js.map +1 -1
  241. package/dist/doxygen/data-model/doxygen-xml-parser.d.ts +24 -7
  242. package/dist/doxygen/data-model/doxygen-xml-parser.d.ts.map +1 -1
  243. package/dist/doxygen/data-model/doxygen-xml-parser.js +24 -22
  244. package/dist/doxygen/data-model/doxygen-xml-parser.js.map +1 -1
  245. package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts +92 -0
  246. package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts.map +1 -1
  247. package/dist/doxygen/data-model/index/indexcompoundtype-dm.js +79 -2
  248. package/dist/doxygen/data-model/index/indexcompoundtype-dm.js.map +1 -1
  249. package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts +76 -0
  250. package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts.map +1 -1
  251. package/dist/doxygen/data-model/index/indexdoxygentype-dm.js +76 -3
  252. package/dist/doxygen/data-model/index/indexdoxygentype-dm.js.map +1 -1
  253. package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts +79 -0
  254. package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts.map +1 -1
  255. package/dist/doxygen/data-model/index/indexmembertype-dm.js +66 -2
  256. package/dist/doxygen/data-model/index/indexmembertype-dm.js.map +1 -1
  257. package/dist/doxygen/data-model/types.d.ts +96 -1
  258. package/dist/doxygen/data-model/types.d.ts.map +1 -1
  259. package/dist/doxygen/data-model/types.js +37 -0
  260. package/dist/doxygen/data-model/types.js.map +1 -1
  261. package/dist/doxygen2docusaurus.d.ts +4774 -0
  262. package/dist/tsdoc-metadata.json +11 -0
  263. package/package.json +11 -7
  264. /package/{template → templates}/css/custom.css +0 -0
  265. /package/{template → templates}/img/README.md +0 -0
  266. /package/{template → templates}/img/document-svgrepo-com.svg +0 -0
  267. /package/{template → templates}/img/folder-svgrepo-com.svg +0 -0
@@ -15,6 +15,16 @@ import { CompoundBase } from './compound-base-vm.js';
15
15
  import { flattenPath, sanitizeHierarchicalPath } from '../utils.js';
16
16
  import { CollectionBase } from './collection-base.js';
17
17
  // ----------------------------------------------------------------------------
18
+ /**
19
+ * Manages documentation pages collection for the generated site.
20
+ *
21
+ * @remarks
22
+ * Handles the organisation and generation of standalone documentation
23
+ * pages that are not part of the main API reference, such as the
24
+ * main project page and custom documentation pages.
25
+ *
26
+ * @public
27
+ */
18
28
  export class Pages extends CollectionBase {
19
29
  // compoundsById: Map<string, Page>
20
30
  // --------------------------------------------------------------------------
@@ -23,6 +33,17 @@ export class Pages extends CollectionBase {
23
33
  // // this.compoundsById = new Map()
24
34
  // }
25
35
  // --------------------------------------------------------------------------
36
+ /**
37
+ * Adds a page compound to the collection.
38
+ *
39
+ * @remarks
40
+ * Creates a new Page instance from the compound definition and registers
41
+ * it in the collection. Special handling is provided for the main index
42
+ * page which becomes the workspace's main page.
43
+ *
44
+ * @param compoundDef - The compound definition for the page
45
+ * @returns The created Page instance
46
+ */
26
47
  addChild(compoundDef) {
27
48
  const page = new Page(this, compoundDef);
28
49
  this.collectionCompoundsById.set(page.id, page);
@@ -32,10 +53,27 @@ export class Pages extends CollectionBase {
32
53
  return page;
33
54
  }
34
55
  // --------------------------------------------------------------------------
56
+ /**
57
+ * Creates hierarchical relationships between page compounds.
58
+ *
59
+ * @remarks
60
+ * Pages do not have hierarchical relationships, so this method
61
+ * performs no operations. Pages are organised as a flat collection.
62
+ */
35
63
  createCompoundsHierarchies() {
36
64
  // There are no pages hierarchies.
37
65
  }
38
66
  // --------------------------------------------------------------------------
67
+ /**
68
+ * Adds page items to the sidebar navigation structure.
69
+ *
70
+ * @remarks
71
+ * Creates a "Pages" category in the sidebar and populates it with
72
+ * page entries. Top-level pages may be excluded based on configuration
73
+ * settings when they are displayed at the top of the sidebar.
74
+ *
75
+ * @param sidebarCategory - The main sidebar category to populate
76
+ */
39
77
  addSidebarItems(sidebarCategory) {
40
78
  // Add pages to the sidebar.
41
79
  // They are organised as a flat list, no hierarchies.
@@ -47,7 +85,7 @@ export class Pages extends CollectionBase {
47
85
  items: [],
48
86
  };
49
87
  for (const [pageId, page] of this.collectionCompoundsById) {
50
- if (this.workspace.options.renderPagesAtTop &&
88
+ if (this.workspace.options.listPagesAtTop &&
51
89
  page instanceof Page &&
52
90
  page.isTopPage()) {
53
91
  continue;
@@ -71,10 +109,21 @@ export class Pages extends CollectionBase {
71
109
  sidebarCategory.items.push(pagesCategory);
72
110
  }
73
111
  }
112
+ /**
113
+ * Creates sidebar items for top-level pages at the root level.
114
+ *
115
+ * @remarks
116
+ * Conditionally adds page items directly to the main sidebar category
117
+ * when the configuration option to display pages at the top is enabled.
118
+ * This provides prominent placement for important pages outside the
119
+ * standard pages category.
120
+ *
121
+ * @param sidebarCategory - The main sidebar category to populate
122
+ */
74
123
  createTopPagesSidebarItems(sidebarCategory) {
75
124
  // Add pages to the sidebar.
76
- if (!this.workspace.options.renderPagesAtTop) {
77
- // Do not show pages to the top.
125
+ if (!this.workspace.options.listPagesAtTop) {
126
+ // Do not list pages at the top of the sidebar.
78
127
  return;
79
128
  }
80
129
  for (const [pageId, page] of this.collectionCompoundsById) {
@@ -95,18 +144,62 @@ export class Pages extends CollectionBase {
95
144
  }
96
145
  }
97
146
  // --------------------------------------------------------------------------
98
- createMenuItems() {
147
+ /**
148
+ * Creates navigation bar items for pages.
149
+ *
150
+ * @remarks
151
+ * Pages do not appear in the navigation bar by design, so this method
152
+ * returns an empty array. The workspace's main navigation is handled
153
+ * by other compound types such as namespaces and classes.
154
+ *
155
+ * @returns An empty array as pages are not included in navigation
156
+ */
157
+ createNavbarItems() {
99
158
  // Pages do not show on the menu.
100
159
  // Reference 'this' to satisfy the linter.
101
160
  return [];
102
161
  }
103
162
  // --------------------------------------------------------------------------
163
+ /**
164
+ * Generates index file for pages collection.
165
+ *
166
+ * @remarks
167
+ * Pages do not have a dedicated index file as they are organised
168
+ * as individual standalone documents. This method performs no
169
+ * operations to maintain interface consistency.
170
+ *
171
+ * @returns Promise that resolves immediately
172
+ */
104
173
  async generateIndexDotMdFile() {
105
174
  // There is no pages index.
106
175
  }
107
176
  }
108
177
  // ----------------------------------------------------------------------------
178
+ /**
179
+ * Represents an individual documentation page in the generated site.
180
+ *
181
+ * @remarks
182
+ * Handles standalone documentation pages that are not part of the main
183
+ * API reference structure. Pages can include special content such as
184
+ * the main project page, deprecated items, and custom documentation.
185
+ * The class manages permalink generation, sidebar positioning, and
186
+ * content rendering for these standalone documents.
187
+ *
188
+ * @public
189
+ */
109
190
  export class Page extends CompoundBase {
191
+ /**
192
+ * Initialises a new Page instance.
193
+ *
194
+ * @remarks
195
+ * Constructs the page with appropriate labels, permalinks, and identifiers
196
+ * based on the compound definition. The page title is derived from the
197
+ * compound's title, and relative permalinks are generated using sanitised
198
+ * paths to ensure valid URLs.
199
+ *
200
+ * @param collection - The parent pages collection
201
+ * @param compoundDef - The compound definition containing page data
202
+ */
110
203
  constructor(collection, compoundDef) {
111
204
  super(collection, compoundDef);
112
205
  const { title } = compoundDef;
@@ -130,6 +223,16 @@ export class Page extends CompoundBase {
130
223
  // console.log()
131
224
  }
132
225
  // --------------------------------------------------------------------------
226
+ /**
227
+ * Determines whether the page should be displayed at the top level.
228
+ *
229
+ * @remarks
230
+ * Special pages such as 'deprecated' and 'todo' are excluded from
231
+ * top-level display as they are considered auxiliary content.
232
+ * All other pages are eligible for prominent placement.
233
+ *
234
+ * @returns True if the page should appear at the top level
235
+ */
133
236
  isTopPage() {
134
237
  if (this.id === 'deprecated' || this.id === 'todo') {
135
238
  return false;
@@ -137,6 +240,18 @@ export class Page extends CompoundBase {
137
240
  return true;
138
241
  }
139
242
  // --------------------------------------------------------------------------
243
+ /**
244
+ * Renders the page content to markdown lines.
245
+ *
246
+ * @remarks
247
+ * Generates the complete page content including brief descriptions,
248
+ * inner indices, section indices, detailed descriptions, and sections.
249
+ * A 'more' permalink is provided when detailed descriptions are available
250
+ * to enable navigation to the detailed content section.
251
+ *
252
+ * @param frontMatter - The front matter configuration for the page
253
+ * @returns Array of markdown lines representing the complete page content
254
+ */
140
255
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
141
256
  renderToLines(frontMatter) {
142
257
  const lines = [];
@@ -1 +1 @@
1
- {"version":3,"file":"pages-vm.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/pages-vm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,oCAAoC;AACpC,OAAO,MAAM,MAAM,aAAa,CAAA;AAEhC,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEpD,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AASrD,+EAA+E;AAE/E,MAAM,OAAO,KAAM,SAAQ,cAAc;IACvC,mCAAmC;IAEnC,6EAA6E;IAE7E,uCAAuC;IACvC,qBAAqB;IAErB,sCAAsC;IACtC,IAAI;IAEJ,6EAA6E;IAEpE,QAAQ,CAAC,WAAiC;QACjD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;QACxC,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;QAE/C,IAAI,IAAI,CAAC,EAAE,KAAK,WAAW,EAAE,CAAC;YAC5B,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAA;QAChC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,6EAA6E;IAEpE,0BAA0B;QACjC,kCAAkC;IACpC,CAAC;IAED,6EAA6E;IAEpE,eAAe,CAAC,eAAgC;QACvD,4BAA4B;QAC5B,qDAAqD;QACrD,MAAM,aAAa,GAAwB;YACzC,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,OAAO;YACd,0BAA0B;YAC1B,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,EAAE;SACV,CAAA;QAED,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC1D,IACE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,gBAAgB;gBACvC,IAAI,YAAY,IAAI;gBACpB,IAAI,CAAC,SAAS,EAAE,EAChB,CAAC;gBACD,SAAQ;YACV,CAAC;YAED,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;gBAC3B,SAAQ;YACV,CAAC;YAED,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;YAC7B,IAAI,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC/D,SAAQ;YACV,CAAC;YAED,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAA;YACxD,MAAM,OAAO,GAAmB;gBAC9B,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,YAAY;gBACnB,EAAE;aACH,CAAA;YAED,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnC,CAAC;QAED,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IAED,0BAA0B,CAAC,eAAgC;QACzD,4BAA4B;QAC5B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC7C,gCAAgC;YAChC,OAAM;QACR,CAAC;QAED,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC1D,sBAAsB;YACtB,IACE,MAAM,KAAK,WAAW;gBACtB,CAAC,CAAC,IAAI,YAAY,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,EAC3C,CAAC;gBACD,SAAQ;YACV,CAAC;YAED,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBACpE,SAAQ;YACV,CAAC;YAED,MAAM,OAAO,GAAmB;gBAC9B,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,IAAI,CAAC,YAAY;gBACxB,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,EAAE;aACvD,CAAA;YAED,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrC,CAAC;IACH,CAAC;IAED,6EAA6E;IAEpE,eAAe;QACtB,iCAAiC;QACjC,0CAA0C;QAC1C,OAAO,EAAE,CAAA;IACX,CAAC;IAED,6EAA6E;IAEpE,KAAK,CAAC,sBAAsB;QACnC,2BAA2B;IAC7B,CAAC;CACF;AAED,+EAA+E;AAE/E,MAAM,OAAO,IAAK,SAAQ,YAAY;IACpC,YAAY,UAAiB,EAAE,WAAiC;QAC9D,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;QAE9B,MAAM,EAAE,KAAK,EAAE,GAAG,WAAW,CAAA;QAC7B,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAA;QAC3B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QAEnD,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;QAC7B,IAAI,CAAC,SAAS,GAAG,YAAY,CAAA;QAC7B,IAAI,CAAC,aAAa,GAAG,YAAY,CAAA;QAEjC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAA;QAE7B,MAAM,aAAa,GAAW,wBAAwB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACzE,IAAI,CAAC,iBAAiB,GAAG,SAAS,aAAa,EAAE,CAAA;QAEjD,IAAI,CAAC,SAAS,GAAG,SAAS,WAAW,CAAC,aAAa,CAAC,EAAE,CAAA;QAEtD,yBAAyB;QACzB,MAAM,CAAC,WAAW,CAAC,WAAW,KAAK,SAAS,CAAC,CAAA;QAE7C,4BAA4B;QAC5B,sCAAsC;QACtC,2CAA2C;QAC3C,sCAAsC;QACtC,sCAAsC;QACtC,mCAAmC;QACnC,gBAAgB;IAClB,CAAC;IAED,6EAA6E;IAE7E,SAAS;QACP,IAAI,IAAI,CAAC,EAAE,KAAK,YAAY,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;YACnD,OAAO,KAAK,CAAA;QACd,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,6EAA6E;IAE7E,6DAA6D;IACpD,aAAa,CAAC,WAAwB;QAC7C,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,aAAa,GACjB,IAAI,CAAC,4BAA4B,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAA;QAE1E,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,kCAAkC,CAAC;YACtC,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,aAAa;SACd,CAAC,CACH,CAAA;QAED,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC,CAAA;QAEjD,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,2BAA2B,EAAE,CAAC,CAAA;QAEjD,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,oCAAoC,CAAC;YAC3C,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,4BAA4B,EAAE,IAAI,CAAC,4BAA4B;YAC/D,UAAU,EAAE,KAAK;SAClB,CAAC,CACH,CAAA;QAED,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA;QAE3C,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"pages-vm.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/pages-vm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,oCAAoC;AACpC,OAAO,MAAM,MAAM,aAAa,CAAA;AAEhC,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEpD,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AASrD,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,KAAM,SAAQ,cAAc;IACvC,mCAAmC;IAEnC,6EAA6E;IAE7E,uCAAuC;IACvC,qBAAqB;IAErB,sCAAsC;IACtC,IAAI;IAEJ,6EAA6E;IAE7E;;;;;;;;;;OAUG;IACM,QAAQ,CAAC,WAAiC;QACjD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;QACxC,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;QAE/C,IAAI,IAAI,CAAC,EAAE,KAAK,WAAW,EAAE,CAAC;YAC5B,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAA;QAChC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,6EAA6E;IAE7E;;;;;;OAMG;IACM,0BAA0B;QACjC,kCAAkC;IACpC,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACM,eAAe,CAAC,eAAgC;QACvD,4BAA4B;QAC5B,qDAAqD;QACrD,MAAM,aAAa,GAAwB;YACzC,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,OAAO;YACd,0BAA0B;YAC1B,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,EAAE;SACV,CAAA;QAED,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC1D,IACE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc;gBACrC,IAAI,YAAY,IAAI;gBACpB,IAAI,CAAC,SAAS,EAAE,EAChB,CAAC;gBACD,SAAQ;YACV,CAAC;YAED,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;gBAC3B,SAAQ;YACV,CAAC;YAED,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;YAC7B,IAAI,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC/D,SAAQ;YACV,CAAC;YAED,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAA;YACxD,MAAM,OAAO,GAAmB;gBAC9B,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,YAAY;gBACnB,EAAE;aACH,CAAA;YAED,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnC,CAAC;QAED,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,0BAA0B,CAAC,eAAgC;QACzD,4BAA4B;QAC5B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3C,+CAA+C;YAC/C,OAAM;QACR,CAAC;QAED,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC1D,sBAAsB;YACtB,IACE,MAAM,KAAK,WAAW;gBACtB,CAAC,CAAC,IAAI,YAAY,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,EAC3C,CAAC;gBACD,SAAQ;YACV,CAAC;YAED,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBACpE,SAAQ;YACV,CAAC;YAED,MAAM,OAAO,GAAmB;gBAC9B,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,IAAI,CAAC,YAAY;gBACxB,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,EAAE;aACvD,CAAA;YAED,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrC,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACM,iBAAiB;QACxB,iCAAiC;QACjC,0CAA0C;QAC1C,OAAO,EAAE,CAAA;IACX,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACM,KAAK,CAAC,sBAAsB;QACnC,2BAA2B;IAC7B,CAAC;CACF;AAED,+EAA+E;AAE/E;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,IAAK,SAAQ,YAAY;IACpC;;;;;;;;;;;OAWG;IACH,YAAY,UAAiB,EAAE,WAAiC;QAC9D,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;QAE9B,MAAM,EAAE,KAAK,EAAE,GAAG,WAAW,CAAA;QAC7B,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAA;QAC3B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QAEnD,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;QAC7B,IAAI,CAAC,SAAS,GAAG,YAAY,CAAA;QAC7B,IAAI,CAAC,aAAa,GAAG,YAAY,CAAA;QAEjC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAA;QAE7B,MAAM,aAAa,GAAW,wBAAwB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACzE,IAAI,CAAC,iBAAiB,GAAG,SAAS,aAAa,EAAE,CAAA;QAEjD,IAAI,CAAC,SAAS,GAAG,SAAS,WAAW,CAAC,aAAa,CAAC,EAAE,CAAA;QAEtD,yBAAyB;QACzB,MAAM,CAAC,WAAW,CAAC,WAAW,KAAK,SAAS,CAAC,CAAA;QAE7C,4BAA4B;QAC5B,sCAAsC;QACtC,2CAA2C;QAC3C,sCAAsC;QACtC,sCAAsC;QACtC,mCAAmC;QACnC,gBAAgB;IAClB,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACH,SAAS;QACP,IAAI,IAAI,CAAC,EAAE,KAAK,YAAY,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;YACnD,OAAO,KAAK,CAAA;QACd,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;;;OAWG;IACH,6DAA6D;IACpD,aAAa,CAAC,WAAwB;QAC7C,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,aAAa,GACjB,IAAI,CAAC,4BAA4B,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAA;QAE1E,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,kCAAkC,CAAC;YACtC,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,aAAa;SACd,CAAC,CACH,CAAA;QAED,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC,CAAA;QAEjD,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,2BAA2B,EAAE,CAAC,CAAA;QAEjD,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,oCAAoC,CAAC;YAC3C,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,4BAA4B,EAAE,IAAI,CAAC,4BAA4B;YAC/D,UAAU,EAAE,KAAK;SAClB,CAAC,CACH,CAAA;QAED,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA;QAE3C,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}
@@ -2,43 +2,163 @@ import { Class } from './classes-vm.js';
2
2
  import { EnumValue, Member } from './members-vm.js';
3
3
  import { Namespace } from './namespaces-vm.js';
4
4
  import type { File } from './files-and-folders-vm.js';
5
+ /**
6
+ * Base class for tree entry objects used in hierarchical navigation.
7
+ *
8
+ * @remarks
9
+ * Provides common functionality for entries that appear in tree-like
10
+ * navigation structures, including index pages and hierarchical listings.
11
+ * Handles name formatting, link generation, and sorting criteria.
12
+ *
13
+ * @public
14
+ */
5
15
  export declare class TreeEntryBase {
6
- /** @brief The short name shown in the left part of the index lines. */
16
+ /**
17
+ * The short name shown in the left part of index lines.
18
+ *
19
+ * @remarks
20
+ * Brief display name used for compact listings and navigation
21
+ * structures where space is limited.
22
+ */
7
23
  name: string;
8
- /** @brief The full name, used internally as the second sort criteria. */
24
+ /**
25
+ * The full name used internally as the secondary sort criteria.
26
+ *
27
+ * @remarks
28
+ * Complete qualified name used for precise sorting when multiple
29
+ * entries have the same short name.
30
+ */
9
31
  longName: string;
10
- /** @brief The internal id, used to compute the permalink. */
32
+ /**
33
+ * The internal identifier used to compute the permalink.
34
+ *
35
+ * @remarks
36
+ * Unique identifier that corresponds to the Doxygen compound or
37
+ * member ID for generating navigation links.
38
+ */
11
39
  id: string;
12
40
  /**
13
- * @brief The compound or member kind.
41
+ * The compound or member kind.
14
42
  *
15
- * @details
16
- * classes: `class`, `struct`, `union`
17
- * namespaces: `namespace`
18
- * members: `function`, `variable`, `typedef`, `enum`, ...
19
- * enumvalue: `enumvalue`
20
- * */
43
+ * @remarks
44
+ * Indicates the type of documentation element this entry represents.
45
+ * Examples include: 'class', 'struct', 'union', 'namespace', 'function',
46
+ * 'variable', 'typedef', 'enum', 'enumvalue'.
47
+ */
21
48
  kind: string;
22
- /** @brief displayed outside the link */
49
+ /**
50
+ * Kind label displayed outside the link.
51
+ *
52
+ * @remarks
53
+ * Human-readable type description shown in index listings to help
54
+ * users identify the nature of the linked element.
55
+ */
23
56
  linkKind: string;
24
- /** @brief The name of the linked target object. */
57
+ /**
58
+ * The name of the linked target object.
59
+ *
60
+ * @remarks
61
+ * Display name used as the clickable text in navigation links,
62
+ * typically formatted for user presentation.
63
+ */
25
64
  linkName: string;
26
65
  /**
27
- * @brief The short name of the linked target object,
28
- * to be compared with name.
66
+ * The short name of the linked target object for comparison with name.
67
+ *
68
+ * @remarks
69
+ * Simplified name used for determining when the entry name differs
70
+ * from the link target name, enabling conditional display logic.
29
71
  */
30
72
  comparableLinkName: string;
31
- /** @brief The URL of the target object, including the anchor. */
73
+ /**
74
+ * The URL of the target object, including the anchor.
75
+ *
76
+ * @remarks
77
+ * Complete permalink to the documentation page for this entry,
78
+ * including any necessary anchor fragments for precise navigation.
79
+ */
32
80
  permalink?: string | undefined;
81
+ /**
82
+ * Creates a new tree entry from a compound or member object.
83
+ *
84
+ * @remarks
85
+ * Initialises the tree entry by extracting relevant information from
86
+ * the provided documentation object, setting up names, kinds, and
87
+ * navigation properties based on the object type.
88
+ *
89
+ * @param entry - The documentation object to create an entry for
90
+ */
33
91
  constructor(entry: Class | Namespace | Member | EnumValue);
34
92
  }
93
+ /**
94
+ * Tree entry specifically for class-type compounds in hierarchical views.
95
+ *
96
+ * @remarks
97
+ * Extends the base tree entry functionality with class-specific formatting
98
+ * and link generation. Handles proper display names and permalinks for
99
+ * classes, structs, and unions in navigation structures.
100
+ *
101
+ * @public
102
+ */
35
103
  export declare class ClassTreeEntry extends TreeEntryBase {
104
+ /**
105
+ * Creates a new class tree entry.
106
+ *
107
+ * @remarks
108
+ * Initialises the tree entry with class-specific information including
109
+ * the full class name and appropriate link formatting for display
110
+ * in hierarchical navigation structures.
111
+ *
112
+ * @param entry - The source entry object
113
+ * @param clazz - The class object providing context
114
+ */
36
115
  constructor(entry: Class | Member | EnumValue, clazz: Class);
37
116
  }
117
+ /**
118
+ * Tree entry specifically for namespace compounds in hierarchical views.
119
+ *
120
+ * @remarks
121
+ * Extends the base tree entry functionality with namespace-specific
122
+ * formatting and link generation. Handles anonymous namespace sanitisation
123
+ * and proper display in navigation structures.
124
+ *
125
+ * @public
126
+ */
38
127
  export declare class NamespaceTreeEntry extends TreeEntryBase {
128
+ /**
129
+ * Creates a new namespace tree entry.
130
+ *
131
+ * @remarks
132
+ * Initialises the tree entry with namespace-specific information,
133
+ * including handling of anonymous namespaces and proper link
134
+ * formatting for hierarchical display.
135
+ *
136
+ * @param entry - The source entry object
137
+ * @param namespace - The namespace object providing context
138
+ */
39
139
  constructor(entry: Namespace | Class | Member | EnumValue, namespace: Namespace);
40
140
  }
141
+ /**
142
+ * Tree entry specifically for file compounds in hierarchical views.
143
+ *
144
+ * @remarks
145
+ * Extends the base tree entry functionality with file-specific formatting
146
+ * and link generation. Uses relative file paths for display and navigation
147
+ * in file-based documentation structures.
148
+ *
149
+ * @public
150
+ */
41
151
  export declare class FileTreeEntry extends TreeEntryBase {
152
+ /**
153
+ * Creates a new file tree entry.
154
+ *
155
+ * @remarks
156
+ * Initialises the tree entry with file-specific information using
157
+ * the relative file path for display purposes in navigation structures.
158
+ *
159
+ * @param entry - The source entry object
160
+ * @param file - The file object providing context
161
+ */
42
162
  constructor(entry: Namespace | Class | Member | EnumValue, file: File);
43
163
  }
44
164
  //# sourceMappingURL=tree-entries-vm.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"tree-entries-vm.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/tree-entries-vm.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAA;AAKrD,qBAAa,aAAa;IACxB,uEAAuE;IACvE,IAAI,SAAQ;IACZ,yEAAyE;IACzE,QAAQ,SAAQ;IAEhB,6DAA6D;IAC7D,EAAE,EAAE,MAAM,CAAA;IAEV;;;;;;;;SAQK;IACL,IAAI,SAAQ;IAEZ,wCAAwC;IACxC,QAAQ,SAAK;IAEb,mDAAmD;IACnD,QAAQ,SAAQ;IAEhB;;;OAGG;IACH,kBAAkB,SAAK;IAEvB,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;gBAElB,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS;CA0E1D;AAED,qBAAa,cAAe,SAAQ,aAAa;gBACnC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,KAAK;CAa5D;AAED,qBAAa,kBAAmB,SAAQ,aAAa;gBAEjD,KAAK,EAAE,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,SAAS,EAC7C,SAAS,EAAE,SAAS;CAUvB;AAED,qBAAa,aAAc,SAAQ,aAAa;gBAClC,KAAK,EAAE,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI;CAStE"}
1
+ {"version":3,"file":"tree-entries-vm.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/tree-entries-vm.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAA;AAKrD;;;;;;;;;GASG;AACH,qBAAa,aAAa;IACxB;;;;;;OAMG;IACH,IAAI,SAAQ;IAEZ;;;;;;OAMG;IACH,QAAQ,SAAQ;IAEhB;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;;;;OAOG;IACH,IAAI,SAAQ;IAEZ;;;;;;OAMG;IACH,QAAQ,SAAK;IAEb;;;;;;OAMG;IACH,QAAQ,SAAQ;IAEhB;;;;;;OAMG;IACH,kBAAkB,SAAK;IAEvB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE9B;;;;;;;;;OASG;gBACS,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS;CA0E1D;AAED;;;;;;;;;GASG;AACH,qBAAa,cAAe,SAAQ,aAAa;IAC/C;;;;;;;;;;OAUG;gBACS,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,KAAK;CAa5D;AAED;;;;;;;;;GASG;AACH,qBAAa,kBAAmB,SAAQ,aAAa;IACnD;;;;;;;;;;OAUG;gBAED,KAAK,EAAE,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,SAAS,EAC7C,SAAS,EAAE,SAAS;CAUvB;AAED;;;;;;;;;GASG;AACH,qBAAa,aAAc,SAAQ,aAAa;IAC9C;;;;;;;;;OASG;gBACS,KAAK,EAAE,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI;CAStE"}
@@ -14,34 +14,92 @@ import { EnumValue, Member } from './members-vm.js';
14
14
  import { Namespace } from './namespaces-vm.js';
15
15
  import { sanitizeAnonymousNamespace } from '../utils.js';
16
16
  // ----------------------------------------------------------------------------
17
+ /**
18
+ * Base class for tree entry objects used in hierarchical navigation.
19
+ *
20
+ * @remarks
21
+ * Provides common functionality for entries that appear in tree-like
22
+ * navigation structures, including index pages and hierarchical listings.
23
+ * Handles name formatting, link generation, and sorting criteria.
24
+ *
25
+ * @public
26
+ */
17
27
  export class TreeEntryBase {
18
- /** @brief The short name shown in the left part of the index lines. */
28
+ /**
29
+ * The short name shown in the left part of index lines.
30
+ *
31
+ * @remarks
32
+ * Brief display name used for compact listings and navigation
33
+ * structures where space is limited.
34
+ */
19
35
  name = '???';
20
- /** @brief The full name, used internally as the second sort criteria. */
36
+ /**
37
+ * The full name used internally as the secondary sort criteria.
38
+ *
39
+ * @remarks
40
+ * Complete qualified name used for precise sorting when multiple
41
+ * entries have the same short name.
42
+ */
21
43
  longName = '???';
22
- /** @brief The internal id, used to compute the permalink. */
44
+ /**
45
+ * The internal identifier used to compute the permalink.
46
+ *
47
+ * @remarks
48
+ * Unique identifier that corresponds to the Doxygen compound or
49
+ * member ID for generating navigation links.
50
+ */
23
51
  id;
24
52
  /**
25
- * @brief The compound or member kind.
26
- *
27
- * @details
28
- * classes: `class`, `struct`, `union`
29
- * namespaces: `namespace`
30
- * members: `function`, `variable`, `typedef`, `enum`, ...
31
- * enumvalue: `enumvalue`
32
- * */
53
+ * The compound or member kind.
54
+ *
55
+ * @remarks
56
+ * Indicates the type of documentation element this entry represents.
57
+ * Examples include: 'class', 'struct', 'union', 'namespace', 'function',
58
+ * 'variable', 'typedef', 'enum', 'enumvalue'.
59
+ */
33
60
  kind = '???';
34
- /** @brief displayed outside the link */
61
+ /**
62
+ * Kind label displayed outside the link.
63
+ *
64
+ * @remarks
65
+ * Human-readable type description shown in index listings to help
66
+ * users identify the nature of the linked element.
67
+ */
35
68
  linkKind = '';
36
- /** @brief The name of the linked target object. */
69
+ /**
70
+ * The name of the linked target object.
71
+ *
72
+ * @remarks
73
+ * Display name used as the clickable text in navigation links,
74
+ * typically formatted for user presentation.
75
+ */
37
76
  linkName = '???';
38
77
  /**
39
- * @brief The short name of the linked target object,
40
- * to be compared with name.
78
+ * The short name of the linked target object for comparison with name.
79
+ *
80
+ * @remarks
81
+ * Simplified name used for determining when the entry name differs
82
+ * from the link target name, enabling conditional display logic.
41
83
  */
42
84
  comparableLinkName = '';
43
- /** @brief The URL of the target object, including the anchor. */
85
+ /**
86
+ * The URL of the target object, including the anchor.
87
+ *
88
+ * @remarks
89
+ * Complete permalink to the documentation page for this entry,
90
+ * including any necessary anchor fragments for precise navigation.
91
+ */
44
92
  permalink;
93
+ /**
94
+ * Creates a new tree entry from a compound or member object.
95
+ *
96
+ * @remarks
97
+ * Initialises the tree entry by extracting relevant information from
98
+ * the provided documentation object, setting up names, kinds, and
99
+ * navigation properties based on the object type.
100
+ *
101
+ * @param entry - The documentation object to create an entry for
102
+ */
45
103
  constructor(entry) {
46
104
  if (entry instanceof Class) {
47
105
  const { id, collection, treeEntryName, fullyQualifiedName, kind } = entry;
@@ -106,7 +164,28 @@ export class TreeEntryBase {
106
164
  }
107
165
  }
108
166
  }
167
+ /**
168
+ * Tree entry specifically for class-type compounds in hierarchical views.
169
+ *
170
+ * @remarks
171
+ * Extends the base tree entry functionality with class-specific formatting
172
+ * and link generation. Handles proper display names and permalinks for
173
+ * classes, structs, and unions in navigation structures.
174
+ *
175
+ * @public
176
+ */
109
177
  export class ClassTreeEntry extends TreeEntryBase {
178
+ /**
179
+ * Creates a new class tree entry.
180
+ *
181
+ * @remarks
182
+ * Initialises the tree entry with class-specific information including
183
+ * the full class name and appropriate link formatting for display
184
+ * in hierarchical navigation structures.
185
+ *
186
+ * @param entry - The source entry object
187
+ * @param clazz - The class object providing context
188
+ */
110
189
  constructor(entry, clazz) {
111
190
  super(entry);
112
191
  const { kind, classFullName, collection, treeEntryName } = clazz;
@@ -116,7 +195,28 @@ export class ClassTreeEntry extends TreeEntryBase {
116
195
  // console.log(this)
117
196
  }
118
197
  }
198
+ /**
199
+ * Tree entry specifically for namespace compounds in hierarchical views.
200
+ *
201
+ * @remarks
202
+ * Extends the base tree entry functionality with namespace-specific
203
+ * formatting and link generation. Handles anonymous namespace sanitisation
204
+ * and proper display in navigation structures.
205
+ *
206
+ * @public
207
+ */
119
208
  export class NamespaceTreeEntry extends TreeEntryBase {
209
+ /**
210
+ * Creates a new namespace tree entry.
211
+ *
212
+ * @remarks
213
+ * Initialises the tree entry with namespace-specific information,
214
+ * including handling of anonymous namespaces and proper link
215
+ * formatting for hierarchical display.
216
+ *
217
+ * @param entry - The source entry object
218
+ * @param namespace - The namespace object providing context
219
+ */
120
220
  constructor(entry, namespace) {
121
221
  super(entry);
122
222
  this.linkKind = 'namespace';
@@ -126,7 +226,27 @@ export class NamespaceTreeEntry extends TreeEntryBase {
126
226
  // console.log(this)
127
227
  }
128
228
  }
229
+ /**
230
+ * Tree entry specifically for file compounds in hierarchical views.
231
+ *
232
+ * @remarks
233
+ * Extends the base tree entry functionality with file-specific formatting
234
+ * and link generation. Uses relative file paths for display and navigation
235
+ * in file-based documentation structures.
236
+ *
237
+ * @public
238
+ */
129
239
  export class FileTreeEntry extends TreeEntryBase {
240
+ /**
241
+ * Creates a new file tree entry.
242
+ *
243
+ * @remarks
244
+ * Initialises the tree entry with file-specific information using
245
+ * the relative file path for display purposes in navigation structures.
246
+ *
247
+ * @param entry - The source entry object
248
+ * @param file - The file object providing context
249
+ */
130
250
  constructor(entry, file) {
131
251
  super(entry);
132
252
  this.linkKind = 'file';
@@ -1 +1 @@
1
- {"version":3,"file":"tree-entries-vm.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/tree-entries-vm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AAExD,+EAA+E;AAE/E,MAAM,OAAO,aAAa;IACxB,uEAAuE;IACvE,IAAI,GAAG,KAAK,CAAA;IACZ,yEAAyE;IACzE,QAAQ,GAAG,KAAK,CAAA;IAEhB,6DAA6D;IAC7D,EAAE,CAAQ;IAEV;;;;;;;;SAQK;IACL,IAAI,GAAG,KAAK,CAAA;IAEZ,wCAAwC;IACxC,QAAQ,GAAG,EAAE,CAAA;IAEb,mDAAmD;IACnD,QAAQ,GAAG,KAAK,CAAA;IAEhB;;;OAGG;IACH,kBAAkB,GAAG,EAAE,CAAA;IAEvB,iEAAiE;IACjE,SAAS,CAAqB;IAE9B,YAAY,KAA6C;QACvD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,aAAa,EAAE,kBAAkB,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;YACzE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;YAEZ,oCAAoC;YACpC,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;YACpE,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAA;YAClC,sDAAsD;YACtD,uEAAuE;YACvE,uBAAuB;YAEvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA,CAAC,uBAAuB;YAExC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YACpB,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAA;YAElC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBACjD,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,UAAU;aACpB,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YACtC,MAAM,EAAE,EAAE,EAAE,aAAa,EAAE,eAAe,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAK,CAAA;YACtE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;YACZ,IAAI,CAAC,IAAI,GAAG,aAAa,CAAA;YACzB,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAA;YAE/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA,CAAC,YAAY;YAE7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YACpB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAA;YAC7B,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBACjD,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,UAAU;aACpB,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,KAAK,YAAY,MAAM,EAAE,CAAC;YACnC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;YACxD,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;YACZ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,CAAC,QAAQ,GAAG,aAAa,IAAI,KAAK,CAAA;YAEtC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAEhB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBAClE,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,QAAQ;aAClB,CAAC,CAAA;YACF,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBAC7B,IAAI,CAAC,IAAI,IAAI,IAAI,CAAA;YACnB,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YACtC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;YAClC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;YACZ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YAEpB,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;YAEvB,IAAI,CAAC,SAAS;gBACZ,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;oBACxD,KAAK,EAAE,EAAE;oBACT,OAAO,EAAE,QAAQ;iBAClB,CAAC,CAAA;QACN,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,EAAE,GAAG,KAAK,CAAA;YACf,qCAAqC;YACrC,OAAO,CAAC,KAAK,CACX,aAAa,EACb,OAAO,KAAK,EACZ,kBAAkB,EAClB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;IACH,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,aAAa;IAC/C,YAAY,KAAiC,EAAE,KAAY;QACzD,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,KAAK,CAAA;QAChE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAA;QAC7B,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CACzD,aAAa,EACb,MAAM,CACP,CAAA;QAED,oBAAoB;IACtB,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,aAAa;IACnD,YACE,KAA6C,EAC7C,SAAoB;QAEpB,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAA;QAC3B,IAAI,CAAC,QAAQ,GAAG,0BAA0B,CAAC,SAAS,CAAC,YAAY,CAAC,CAAA;QAClE,MAAM,EAAE,aAAa,EAAE,GAAG,SAAS,CAAA;QACnC,IAAI,CAAC,kBAAkB,GAAG,aAAa,CAAA;QACvC,oBAAoB;IACtB,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C,YAAY,KAA6C,EAAE,IAAU;QACnE,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAA;QACtB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;QAC7B,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAA;QAE5B,oBAAoB;IACtB,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"tree-entries-vm.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/tree-entries-vm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AAExD,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,aAAa;IACxB;;;;;;OAMG;IACH,IAAI,GAAG,KAAK,CAAA;IAEZ;;;;;;OAMG;IACH,QAAQ,GAAG,KAAK,CAAA;IAEhB;;;;;;OAMG;IACH,EAAE,CAAQ;IAEV;;;;;;;OAOG;IACH,IAAI,GAAG,KAAK,CAAA;IAEZ;;;;;;OAMG;IACH,QAAQ,GAAG,EAAE,CAAA;IAEb;;;;;;OAMG;IACH,QAAQ,GAAG,KAAK,CAAA;IAEhB;;;;;;OAMG;IACH,kBAAkB,GAAG,EAAE,CAAA;IAEvB;;;;;;OAMG;IACH,SAAS,CAAqB;IAE9B;;;;;;;;;OASG;IACH,YAAY,KAA6C;QACvD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,aAAa,EAAE,kBAAkB,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;YACzE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;YAEZ,oCAAoC;YACpC,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;YACpE,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAA;YAClC,sDAAsD;YACtD,uEAAuE;YACvE,uBAAuB;YAEvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA,CAAC,uBAAuB;YAExC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YACpB,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAA;YAElC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBACjD,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,UAAU;aACpB,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YACtC,MAAM,EAAE,EAAE,EAAE,aAAa,EAAE,eAAe,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAK,CAAA;YACtE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;YACZ,IAAI,CAAC,IAAI,GAAG,aAAa,CAAA;YACzB,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAA;YAE/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA,CAAC,YAAY;YAE7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YACpB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAA;YAC7B,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBACjD,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,UAAU;aACpB,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,KAAK,YAAY,MAAM,EAAE,CAAC;YACnC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;YACxD,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;YACZ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,CAAC,QAAQ,GAAG,aAAa,IAAI,KAAK,CAAA;YAEtC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAEhB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;gBAClE,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,QAAQ;aAClB,CAAC,CAAA;YACF,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBAC7B,IAAI,CAAC,IAAI,IAAI,IAAI,CAAA;YACnB,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YACtC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;YAClC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;YACZ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YAEpB,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;YAEvB,IAAI,CAAC,SAAS;gBACZ,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;oBACxD,KAAK,EAAE,EAAE;oBACT,OAAO,EAAE,QAAQ;iBAClB,CAAC,CAAA;QACN,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,EAAE,GAAG,KAAK,CAAA;YACf,qCAAqC;YACrC,OAAO,CAAC,KAAK,CACX,aAAa,EACb,OAAO,KAAK,EACZ,kBAAkB,EAClB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;IACH,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,cAAe,SAAQ,aAAa;IAC/C;;;;;;;;;;OAUG;IACH,YAAY,KAAiC,EAAE,KAAY;QACzD,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,KAAK,CAAA;QAChE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAA;QAC7B,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CACzD,aAAa,EACb,MAAM,CACP,CAAA;QAED,oBAAoB;IACtB,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,kBAAmB,SAAQ,aAAa;IACnD;;;;;;;;;;OAUG;IACH,YACE,KAA6C,EAC7C,SAAoB;QAEpB,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAA;QAC3B,IAAI,CAAC,QAAQ,GAAG,0BAA0B,CAAC,SAAS,CAAC,YAAY,CAAC,CAAA;QAClE,MAAM,EAAE,aAAa,EAAE,GAAG,SAAS,CAAA;QACnC,IAAI,CAAC,kBAAkB,GAAG,aAAa,CAAA;QACvC,oBAAoB;IACtB,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C;;;;;;;;;OASG;IACH,YAAY,KAA6C,EAAE,IAAU;QACnE,KAAK,CAAC,KAAK,CAAC,CAAA;QAEZ,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAA;QACtB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;QAC7B,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAA;QAE5B,oBAAoB;IACtB,CAAC;CACF;AAED,+EAA+E"}