@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
@@ -1,21 +1,153 @@
1
1
  import { ElementLinesRendererBase } from './element-renderer-base.js';
2
2
  import type { AbstractDocSect1Type, AbstractDocSect2Type, AbstractDocSect3Type, AbstractDocSect4Type, AbstractDocSect5Type, AbstractDocSect6Type } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
3
+ /**
4
+ * Renderer for Doxygen level-1 section elements.
5
+ *
6
+ * @remarks
7
+ * Converts Doxygen section elements to Docusaurus markdown format.
8
+ * Generates H2 headings with optional anchor IDs for table of contents
9
+ * integration and cross-referencing within documentation.
10
+ *
11
+ * @public
12
+ */
3
13
  export declare class DocS1TypeLinesRenderer extends ElementLinesRendererBase {
14
+ /**
15
+ * Renders a level-1 section element to formatted output lines.
16
+ *
17
+ * @remarks
18
+ * Creates markdown H2 heading with optional anchor for the section title
19
+ * and renders child elements. Removes trailing periods from titles and
20
+ * includes anchor links when section IDs are available.
21
+ *
22
+ * @param element - The level-1 section element to render
23
+ * @param type - The rendering context type
24
+ * @returns Array of markdown lines for the section
25
+ */
4
26
  renderToLines(element: AbstractDocSect1Type, type: string): string[];
5
27
  }
28
+ /**
29
+ * Renderer for Doxygen level-2 section elements.
30
+ *
31
+ * @remarks
32
+ * Converts Doxygen subsection elements to Docusaurus markdown format.
33
+ * Generates H3 headings with optional anchor IDs for hierarchical
34
+ * documentation structure and navigation support.
35
+ *
36
+ * @public
37
+ */
6
38
  export declare class DocS2TypeLinesRenderer extends ElementLinesRendererBase {
39
+ /**
40
+ * Renders a level-2 section element to formatted output lines.
41
+ *
42
+ * @remarks
43
+ * Creates markdown H3 heading with optional anchor for the subsection
44
+ * title and renders child elements. Maintains consistent formatting
45
+ * with parent section renderer patterns.
46
+ *
47
+ * @param element - The level-2 section element to render
48
+ * @param type - The rendering context type
49
+ * @returns Array of markdown lines for the subsection
50
+ */
7
51
  renderToLines(element: AbstractDocSect2Type, type: string): string[];
8
52
  }
53
+ /**
54
+ * Renderer for Doxygen level-3 section elements.
55
+ *
56
+ * @remarks
57
+ * Converts Doxygen sub-subsection elements to Docusaurus markdown format.
58
+ * Generates H4 headings with optional anchor IDs for deep hierarchical
59
+ * documentation structure and comprehensive navigation.
60
+ *
61
+ * @public
62
+ */
9
63
  export declare class DocS3TypeLinesRenderer extends ElementLinesRendererBase {
64
+ /**
65
+ * Renders a level-3 section element to formatted output lines.
66
+ *
67
+ * @remarks
68
+ * Creates markdown H4 heading with optional anchor for the sub-subsection
69
+ * title and renders child elements. Follows established patterns for
70
+ * consistent documentation hierarchy.
71
+ *
72
+ * @param element - The level-3 section element to render
73
+ * @param type - The rendering context type
74
+ * @returns Array of markdown lines for the sub-subsection
75
+ */
10
76
  renderToLines(element: AbstractDocSect3Type, type: string): string[];
11
77
  }
78
+ /**
79
+ * Renderer for Doxygen level-4 section elements.
80
+ *
81
+ * @remarks
82
+ * Converts deep Doxygen section elements to Docusaurus markdown format.
83
+ * Generates H5 headings with optional anchor IDs for detailed documentation
84
+ * hierarchies and fine-grained content organisation.
85
+ *
86
+ * @public
87
+ */
12
88
  export declare class DocS4TypeLinesRenderer extends ElementLinesRendererBase {
89
+ /**
90
+ * Renders a level-4 section element to formatted output lines.
91
+ *
92
+ * @remarks
93
+ * Creates markdown H5 heading with optional anchor for deep section
94
+ * titles and renders child elements. Maintains hierarchy consistency
95
+ * for complex documentation structures.
96
+ *
97
+ * @param element - The level-4 section element to render
98
+ * @param type - The rendering context type
99
+ * @returns Array of markdown lines for the deep section
100
+ */
13
101
  renderToLines(element: AbstractDocSect4Type, type: string): string[];
14
102
  }
103
+ /**
104
+ * Renderer for Doxygen level-5 section elements.
105
+ *
106
+ * @remarks
107
+ * Converts very deep Doxygen section elements to Docusaurus markdown format.
108
+ * Generates H6 headings with optional anchor IDs for extremely detailed
109
+ * documentation hierarchies and comprehensive content structuring.
110
+ *
111
+ * @public
112
+ */
15
113
  export declare class DocS5TypeLinesRenderer extends ElementLinesRendererBase {
114
+ /**
115
+ * Renders a level-5 section element to formatted output lines.
116
+ *
117
+ * @remarks
118
+ * Creates markdown H6 heading with optional anchor for very deep section
119
+ * titles and renders child elements. Supports maximum depth documentation
120
+ * organisation for complex technical content.
121
+ *
122
+ * @param element - The level-5 section element to render
123
+ * @param type - The rendering context type
124
+ * @returns Array of markdown lines for the very deep section
125
+ */
16
126
  renderToLines(element: AbstractDocSect5Type, type: string): string[];
17
127
  }
128
+ /**
129
+ * Renderer for Doxygen level-6 section elements.
130
+ *
131
+ * @remarks
132
+ * Converts the deepest Doxygen section elements to Docusaurus format.
133
+ * Uses bold text formatting instead of headers due to markdown limitations
134
+ * at this depth level while maintaining anchor functionality.
135
+ *
136
+ * @public
137
+ */
18
138
  export declare class DocS6TypeLinesRenderer extends ElementLinesRendererBase {
139
+ /**
140
+ * Renders a level-6 section element to formatted output lines.
141
+ *
142
+ * @remarks
143
+ * Creates bold text with optional anchor for maximum depth sections
144
+ * and renders child elements. Uses alternative formatting since
145
+ * markdown heading levels are exhausted at this depth.
146
+ *
147
+ * @param element - The level-6 section element to render
148
+ * @param type - The rendering context type
149
+ * @returns Array of formatted lines for the deepest section
150
+ */
19
151
  renderToLines(element: AbstractDocSect6Type, type: string): string[];
20
152
  }
21
153
  //# sourceMappingURL=docinternalstype.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"docinternalstype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docinternalstype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EACV,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,0DAA0D,CAAA;AASjE,qBAAa,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CA0BZ;AAED,qBAAa,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAyBZ;AAED,qBAAa,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAyBZ;AAED,qBAAa,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAyBZ;AAED,qBAAa,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAyBZ;AAED,qBAAa,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CA0BZ"}
1
+ {"version":3,"file":"docinternalstype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docinternalstype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EACV,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,0DAA0D,CAAA;AASjE;;;;;;;;;GASG;AACH,qBAAa,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CA0BZ;AAED;;;;;;;;;GASG;AACH,qBAAa,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAyBZ;AAED;;;;;;;;;GASG;AACH,qBAAa,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAyBZ;AAED;;;;;;;;;GASG;AACH,qBAAa,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAyBZ;AAED;;;;;;;;;GASG;AACH,qBAAa,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAyBZ;AAED;;;;;;;;;GASG;AACH,qBAAa,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CA0BZ"}
@@ -17,7 +17,29 @@ import { getPermalinkAnchor } from '../utils.js';
17
17
  // Sections are entered with @sect, @subsect, etc and in Docusaurus
18
18
  // start wih H2. The markdown syntax is used to make the titles appear
19
19
  // in the table of contents.
20
+ /**
21
+ * Renderer for Doxygen level-1 section elements.
22
+ *
23
+ * @remarks
24
+ * Converts Doxygen section elements to Docusaurus markdown format.
25
+ * Generates H2 headings with optional anchor IDs for table of contents
26
+ * integration and cross-referencing within documentation.
27
+ *
28
+ * @public
29
+ */
20
30
  export class DocS1TypeLinesRenderer extends ElementLinesRendererBase {
31
+ /**
32
+ * Renders a level-1 section element to formatted output lines.
33
+ *
34
+ * @remarks
35
+ * Creates markdown H2 heading with optional anchor for the section title
36
+ * and renders child elements. Removes trailing periods from titles and
37
+ * includes anchor links when section IDs are available.
38
+ *
39
+ * @param element - The level-1 section element to render
40
+ * @param type - The rendering context type
41
+ * @returns Array of markdown lines for the section
42
+ */
21
43
  renderToLines(element, type) {
22
44
  // console.log(util.inspect(element, { compact: false, depth: 999 }))
23
45
  const lines = [];
@@ -40,7 +62,29 @@ export class DocS1TypeLinesRenderer extends ElementLinesRendererBase {
40
62
  return lines;
41
63
  }
42
64
  }
65
+ /**
66
+ * Renderer for Doxygen level-2 section elements.
67
+ *
68
+ * @remarks
69
+ * Converts Doxygen subsection elements to Docusaurus markdown format.
70
+ * Generates H3 headings with optional anchor IDs for hierarchical
71
+ * documentation structure and navigation support.
72
+ *
73
+ * @public
74
+ */
43
75
  export class DocS2TypeLinesRenderer extends ElementLinesRendererBase {
76
+ /**
77
+ * Renders a level-2 section element to formatted output lines.
78
+ *
79
+ * @remarks
80
+ * Creates markdown H3 heading with optional anchor for the subsection
81
+ * title and renders child elements. Maintains consistent formatting
82
+ * with parent section renderer patterns.
83
+ *
84
+ * @param element - The level-2 section element to render
85
+ * @param type - The rendering context type
86
+ * @returns Array of markdown lines for the subsection
87
+ */
44
88
  renderToLines(element, type) {
45
89
  // console.log(util.inspect(element, { compact: false, depth: 999 }))
46
90
  const lines = [];
@@ -63,7 +107,29 @@ export class DocS2TypeLinesRenderer extends ElementLinesRendererBase {
63
107
  return lines;
64
108
  }
65
109
  }
110
+ /**
111
+ * Renderer for Doxygen level-3 section elements.
112
+ *
113
+ * @remarks
114
+ * Converts Doxygen sub-subsection elements to Docusaurus markdown format.
115
+ * Generates H4 headings with optional anchor IDs for deep hierarchical
116
+ * documentation structure and comprehensive navigation.
117
+ *
118
+ * @public
119
+ */
66
120
  export class DocS3TypeLinesRenderer extends ElementLinesRendererBase {
121
+ /**
122
+ * Renders a level-3 section element to formatted output lines.
123
+ *
124
+ * @remarks
125
+ * Creates markdown H4 heading with optional anchor for the sub-subsection
126
+ * title and renders child elements. Follows established patterns for
127
+ * consistent documentation hierarchy.
128
+ *
129
+ * @param element - The level-3 section element to render
130
+ * @param type - The rendering context type
131
+ * @returns Array of markdown lines for the sub-subsection
132
+ */
67
133
  renderToLines(element, type) {
68
134
  // console.log(util.inspect(element, { compact: false, depth: 999 }))
69
135
  const lines = [];
@@ -86,7 +152,29 @@ export class DocS3TypeLinesRenderer extends ElementLinesRendererBase {
86
152
  return lines;
87
153
  }
88
154
  }
155
+ /**
156
+ * Renderer for Doxygen level-4 section elements.
157
+ *
158
+ * @remarks
159
+ * Converts deep Doxygen section elements to Docusaurus markdown format.
160
+ * Generates H5 headings with optional anchor IDs for detailed documentation
161
+ * hierarchies and fine-grained content organisation.
162
+ *
163
+ * @public
164
+ */
89
165
  export class DocS4TypeLinesRenderer extends ElementLinesRendererBase {
166
+ /**
167
+ * Renders a level-4 section element to formatted output lines.
168
+ *
169
+ * @remarks
170
+ * Creates markdown H5 heading with optional anchor for deep section
171
+ * titles and renders child elements. Maintains hierarchy consistency
172
+ * for complex documentation structures.
173
+ *
174
+ * @param element - The level-4 section element to render
175
+ * @param type - The rendering context type
176
+ * @returns Array of markdown lines for the deep section
177
+ */
90
178
  renderToLines(element, type) {
91
179
  // console.log(util.inspect(element, { compact: false, depth: 999 }))
92
180
  const lines = [];
@@ -109,7 +197,29 @@ export class DocS4TypeLinesRenderer extends ElementLinesRendererBase {
109
197
  return lines;
110
198
  }
111
199
  }
200
+ /**
201
+ * Renderer for Doxygen level-5 section elements.
202
+ *
203
+ * @remarks
204
+ * Converts very deep Doxygen section elements to Docusaurus markdown format.
205
+ * Generates H6 headings with optional anchor IDs for extremely detailed
206
+ * documentation hierarchies and comprehensive content structuring.
207
+ *
208
+ * @public
209
+ */
112
210
  export class DocS5TypeLinesRenderer extends ElementLinesRendererBase {
211
+ /**
212
+ * Renders a level-5 section element to formatted output lines.
213
+ *
214
+ * @remarks
215
+ * Creates markdown H6 heading with optional anchor for very deep section
216
+ * titles and renders child elements. Supports maximum depth documentation
217
+ * organisation for complex technical content.
218
+ *
219
+ * @param element - The level-5 section element to render
220
+ * @param type - The rendering context type
221
+ * @returns Array of markdown lines for the very deep section
222
+ */
113
223
  renderToLines(element, type) {
114
224
  // console.log(util.inspect(element, { compact: false, depth: 999 }))
115
225
  const lines = [];
@@ -132,7 +242,29 @@ export class DocS5TypeLinesRenderer extends ElementLinesRendererBase {
132
242
  return lines;
133
243
  }
134
244
  }
245
+ /**
246
+ * Renderer for Doxygen level-6 section elements.
247
+ *
248
+ * @remarks
249
+ * Converts the deepest Doxygen section elements to Docusaurus format.
250
+ * Uses bold text formatting instead of headers due to markdown limitations
251
+ * at this depth level while maintaining anchor functionality.
252
+ *
253
+ * @public
254
+ */
135
255
  export class DocS6TypeLinesRenderer extends ElementLinesRendererBase {
256
+ /**
257
+ * Renders a level-6 section element to formatted output lines.
258
+ *
259
+ * @remarks
260
+ * Creates bold text with optional anchor for maximum depth sections
261
+ * and renders child elements. Uses alternative formatting since
262
+ * markdown heading levels are exhausted at this depth.
263
+ *
264
+ * @param element - The level-6 section element to render
265
+ * @param type - The rendering context type
266
+ * @returns Array of formatted lines for the deepest section
267
+ */
136
268
  renderToLines(element, type) {
137
269
  // console.log(util.inspect(element, { compact: false, depth: 999 }))
138
270
  const lines = [];
@@ -1 +1 @@
1
- {"version":3,"file":"docinternalstype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docinternalstype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AASrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAEhD,+EAA+E;AAE/E,mEAAmE;AACnE,sEAAsE;AACtE,4BAA4B;AAE5B,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC;aAChD,IAAI,EAAE;aACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7C,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,MAAM,MAAM,GAAG,CAAC,CAAA;YACxC,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,GAAG,CAAC,CAAA;YAC5B,CAAC;QACH,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACrE,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC;aAChD,IAAI,EAAE;aACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7C,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,MAAM,MAAM,GAAG,CAAC,CAAA;YACzC,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,GAAG,CAAC,CAAA;YAC7B,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACrE,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC;aAChD,IAAI,EAAE;aACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7C,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,MAAM,MAAM,GAAG,CAAC,CAAA;YAC1C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,GAAG,CAAC,CAAA;YAC9B,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACrE,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC;aAChD,IAAI,EAAE;aACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7C,KAAK,CAAC,IAAI,CAAC,SAAS,KAAK,MAAM,MAAM,GAAG,CAAC,CAAA;YAC3C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,SAAS,KAAK,GAAG,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACrE,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC;aAChD,IAAI,EAAE;aACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7C,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,MAAM,MAAM,GAAG,CAAC,CAAA;YAC5C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,GAAG,CAAC,CAAA;YAChC,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACrE,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC;aAChD,IAAI,EAAE;aACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7C,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,MAAM,MAAM,GAAG,CAAC,CAAA;YAC7C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,GAAG,CAAC,CAAA;YACjC,CAAC;QACH,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACrE,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"docinternalstype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docinternalstype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AASrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAEhD,+EAA+E;AAE/E,mEAAmE;AACnE,sEAAsE;AACtE,4BAA4B;AAE5B;;;;;;;;;GASG;AACH,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC;aAChD,IAAI,EAAE;aACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7C,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,MAAM,MAAM,GAAG,CAAC,CAAA;YACxC,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,GAAG,CAAC,CAAA;YAC5B,CAAC;QACH,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACrE,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC;aAChD,IAAI,EAAE;aACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7C,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,MAAM,MAAM,GAAG,CAAC,CAAA;YACzC,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,GAAG,CAAC,CAAA;YAC7B,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACrE,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC;aAChD,IAAI,EAAE;aACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7C,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,MAAM,MAAM,GAAG,CAAC,CAAA;YAC1C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,GAAG,CAAC,CAAA;YAC9B,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACrE,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC;aAChD,IAAI,EAAE;aACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7C,KAAK,CAAC,IAAI,CAAC,SAAS,KAAK,MAAM,MAAM,GAAG,CAAC,CAAA;YAC3C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,SAAS,KAAK,GAAG,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACrE,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC;aAChD,IAAI,EAAE;aACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7C,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,MAAM,MAAM,GAAG,CAAC,CAAA;YAC5C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,GAAG,CAAC,CAAA;YAChC,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACrE,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC;aAChD,IAAI,EAAE;aACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;gBAC7C,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,MAAM,MAAM,GAAG,CAAC,CAAA;YAC7C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,GAAG,CAAC,CAAA;YACjC,CAAC;QACH,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACrE,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}
@@ -1,6 +1,28 @@
1
1
  import { ElementLinesRendererBase } from './element-renderer-base.js';
2
2
  import { type AbstractDocListType } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
3
+ /**
4
+ * Renderer for list type elements in documentation.
5
+ *
6
+ * @remarks
7
+ * Handles the rendering of both ordered and unordered lists as parsed from
8
+ * Doxygen XML, converting them into appropriate HTML markup with proper
9
+ * styling classes and list type attributes.
10
+ *
11
+ * @public
12
+ */
3
13
  export declare class DocListTypeLinesRenderer extends ElementLinesRendererBase {
14
+ /**
15
+ * Renders a list element to formatted output lines.
16
+ *
17
+ * @remarks
18
+ * Converts Doxygen list elements into HTML lists (ul/ol) with appropriate
19
+ * CSS classes and type attributes. Handles both itemised (unordered) and
20
+ * ordered lists, including special check-style formatting when needed.
21
+ *
22
+ * @param element - The list element to render
23
+ * @param type - The rendering context type
24
+ * @returns Array of formatted output lines
25
+ */
4
26
  renderToLines(element: AbstractDocListType, type: string): string[];
5
27
  }
6
28
  //# sourceMappingURL=doclisttype.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"doclisttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doclisttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EACL,KAAK,mBAAmB,EAGzB,MAAM,0DAA0D,CAAA;AAMjE,qBAAa,wBAAyB,SAAQ,wBAAwB;IAE3D,aAAa,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAkF7E"}
1
+ {"version":3,"file":"doclisttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doclisttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EACL,KAAK,mBAAmB,EAGzB,MAAM,0DAA0D,CAAA;AAIjE;;;;;;;;;GASG;AACH,qBAAa,wBAAyB,SAAQ,wBAAwB;IACpE;;;;;;;;;;;OAWG;IAEM,aAAa,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAkF7E"}
@@ -14,9 +14,29 @@
14
14
  import { ElementLinesRendererBase } from './element-renderer-base.js';
15
15
  import { ItemizedListDataModel, OrderedListDataModel, } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
16
16
  // ----------------------------------------------------------------------------
17
- // ItemizedListDataModel - regular unordered
18
- // OrderedListDataModel - regular ordered
17
+ /**
18
+ * Renderer for list type elements in documentation.
19
+ *
20
+ * @remarks
21
+ * Handles the rendering of both ordered and unordered lists as parsed from
22
+ * Doxygen XML, converting them into appropriate HTML markup with proper
23
+ * styling classes and list type attributes.
24
+ *
25
+ * @public
26
+ */
19
27
  export class DocListTypeLinesRenderer extends ElementLinesRendererBase {
28
+ /**
29
+ * Renders a list element to formatted output lines.
30
+ *
31
+ * @remarks
32
+ * Converts Doxygen list elements into HTML lists (ul/ol) with appropriate
33
+ * CSS classes and type attributes. Handles both itemised (unordered) and
34
+ * ordered lists, including special check-style formatting when needed.
35
+ *
36
+ * @param element - The list element to render
37
+ * @param type - The rendering context type
38
+ * @returns Array of formatted output lines
39
+ */
20
40
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
21
41
  renderToLines(element, type) {
22
42
  // console.log(util.inspect(element, { compact: false, depth: 999 }))
@@ -1 +1 @@
1
- {"version":3,"file":"doclisttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doclisttype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAEL,qBAAqB,EACrB,oBAAoB,GACrB,MAAM,0DAA0D,CAAA;AAEjE,+EAA+E;AAE/E,4CAA4C;AAC5C,yCAAyC;AACzC,MAAM,OAAO,wBAAyB,SAAQ,wBAAwB;IACpE,6DAA6D;IACpD,aAAa,CAAC,OAA4B,EAAE,IAAY;QAC/D,qEAAqE;QACrE,uBAAuB;QAEvB,IAAI,UAAU,GAAG,EAAE,CAAA;QACnB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACzC,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBACpC,UAAU,GAAG,QAAQ,CAAA;gBACrB,MAAK;YACP,CAAC;QACH,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,IAAI,OAAO,YAAY,qBAAqB,EAAE,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC,uBAAuB,UAAU,IAAI,CAAC,CAAA;QACnD,CAAC;aAAM,IAAI,OAAO,YAAY,oBAAoB,EAAE,CAAC;YACnD,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,KAAK,CAAC,IAAI,CAAC,8BAA8B,OAAO,CAAC,IAAI,IAAI,CAAC,CAAA;YAC5D,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAA;YAC9C,CAAC;QACH,CAAC;QAED,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACzC,IAAI,YAAY,GAAG,EAAE,CAAA;YACrB,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBACpC,YAAY,GAAG,WAAW,QAAQ,CAAC,QAAQ,GAAG,CAAA;YAChD,CAAC;YAED,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACjC,8BAA8B;gBAC9B,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;gBAE/C,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC9B,IAAI,IAAI,GAAG,EAAE,CAAA;oBACb,IAAI,IAAI,MAAM,YAAY,GAAG,CAAA;oBAE7B,MAAM,SAAS,GAAa,EAAE,CAAA;oBAC9B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;wBAClC,SAAS,CAAC,IAAI,CACZ,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAC1D,CAAA;oBACH,CAAC;oBACD,sDAAsD;oBACtD,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;oBAC9B,IAAI,IAAI,OAAO,CAAA;oBACf,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBAClB,CAAC;YACH,CAAC;YACD,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACjC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oBACnC,OAAO,CAAC,IAAI,CACV,OAAO,EACP,QAAQ,CAAC,KAAK,EACd,YAAY,EACZ,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,OAAO,YAAY,qBAAqB,EAAE,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrB,CAAC;aAAM,IAAI,OAAO,YAAY,oBAAoB,EAAE,CAAC;YACnD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrB,CAAC;QAED,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gBACnC,OAAO,CAAC,IAAI,CACV,OAAO,EACP,OAAO,CAAC,KAAK,EACb,YAAY,EACZ,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"doclisttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doclisttype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAEL,qBAAqB,EACrB,oBAAoB,GACrB,MAAM,0DAA0D,CAAA;AAEjE,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,wBAAyB,SAAQ,wBAAwB;IACpE;;;;;;;;;;;OAWG;IACH,6DAA6D;IACpD,aAAa,CAAC,OAA4B,EAAE,IAAY;QAC/D,qEAAqE;QACrE,uBAAuB;QAEvB,IAAI,UAAU,GAAG,EAAE,CAAA;QACnB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACzC,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBACpC,UAAU,GAAG,QAAQ,CAAA;gBACrB,MAAK;YACP,CAAC;QACH,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,IAAI,OAAO,YAAY,qBAAqB,EAAE,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC,uBAAuB,UAAU,IAAI,CAAC,CAAA;QACnD,CAAC;aAAM,IAAI,OAAO,YAAY,oBAAoB,EAAE,CAAC;YACnD,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,KAAK,CAAC,IAAI,CAAC,8BAA8B,OAAO,CAAC,IAAI,IAAI,CAAC,CAAA;YAC5D,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAA;YAC9C,CAAC;QACH,CAAC;QAED,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACzC,IAAI,YAAY,GAAG,EAAE,CAAA;YACrB,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;gBACpC,YAAY,GAAG,WAAW,QAAQ,CAAC,QAAQ,GAAG,CAAA;YAChD,CAAC;YAED,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACjC,8BAA8B;gBAC9B,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;gBAE/C,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC9B,IAAI,IAAI,GAAG,EAAE,CAAA;oBACb,IAAI,IAAI,MAAM,YAAY,GAAG,CAAA;oBAE7B,MAAM,SAAS,GAAa,EAAE,CAAA;oBAC9B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;wBAClC,SAAS,CAAC,IAAI,CACZ,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAC1D,CAAA;oBACH,CAAC;oBACD,sDAAsD;oBACtD,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;oBAC9B,IAAI,IAAI,OAAO,CAAA;oBACf,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBAClB,CAAC;YACH,CAAC;YACD,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACjC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oBACnC,OAAO,CAAC,IAAI,CACV,OAAO,EACP,QAAQ,CAAC,KAAK,EACd,YAAY,EACZ,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,OAAO,YAAY,qBAAqB,EAAE,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrB,CAAC;aAAM,IAAI,OAAO,YAAY,oBAAoB,EAAE,CAAC;YACnD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrB,CAAC;QAED,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gBACnC,OAAO,CAAC,IAAI,CACV,OAAO,EACP,OAAO,CAAC,KAAK,EACb,YAAY,EACZ,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}
@@ -1,15 +1,103 @@
1
1
  import { ElementLinesRendererBase, ElementStringRendererBase } from './element-renderer-base.js';
2
2
  import type { AbstractDocCaptionType, AbstractDocEntryType, AbstractDocRowType, AbstractDocTableType } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
3
+ /**
4
+ * Renderer for Doxygen document table elements.
5
+ *
6
+ * @remarks
7
+ * Converts Doxygen table structures to HTML table format with optional
8
+ * captions. Processes table rows and maintains styling through CSS
9
+ * classes for consistent documentation presentation.
10
+ *
11
+ * @public
12
+ */
3
13
  export declare class DocTableTypeLinesRenderer extends ElementLinesRendererBase {
14
+ /**
15
+ * Renders a document table element to formatted output lines.
16
+ *
17
+ * @remarks
18
+ * Creates HTML table structure with optional caption and processes
19
+ * all table rows. Applies CSS classes for styling and maintains
20
+ * proper table markup for documentation display.
21
+ *
22
+ * @param element - The document table element to render
23
+ * @param type - The rendering context type (unused in implementation)
24
+ * @returns Array of HTML strings forming the table structure
25
+ */
4
26
  renderToLines(element: AbstractDocTableType, type: string): string[];
5
27
  }
28
+ /**
29
+ * Renderer for Doxygen document table caption elements.
30
+ *
31
+ * @remarks
32
+ * Generates HTML caption elements for table titles and descriptions.
33
+ * Processes caption content to provide contextual information about
34
+ * table contents and purpose within documentation.
35
+ *
36
+ * @public
37
+ */
6
38
  export declare class DocCaptionLinesRenderer extends ElementLinesRendererBase {
39
+ /**
40
+ * Renders a document caption element to formatted output lines.
41
+ *
42
+ * @remarks
43
+ * Creates HTML caption element containing the processed caption content.
44
+ * Renders child elements to build complete caption text with proper
45
+ * markup and formatting preservation.
46
+ *
47
+ * @param element - The document caption element to render
48
+ * @param type - The rendering context type (unused in implementation)
49
+ * @returns Array containing the HTML caption element
50
+ */
7
51
  renderToLines(element: AbstractDocCaptionType, type: string): string[];
8
52
  }
53
+ /**
54
+ * Renderer for Doxygen document table row elements.
55
+ *
56
+ * @remarks
57
+ * Generates HTML table row structure containing table entries.
58
+ * Processes all entry elements within the row to build complete
59
+ * table row markup for documentation display.
60
+ *
61
+ * @public
62
+ */
9
63
  export declare class DocRowTypeLinesRenderer extends ElementLinesRendererBase {
64
+ /**
65
+ * Renders a document table row element to formatted output lines.
66
+ *
67
+ * @remarks
68
+ * Creates HTML table row tags around rendered table entries.
69
+ * Processes entry elements to generate the complete row structure
70
+ * with proper table markup.
71
+ *
72
+ * @param element - The document table row element to render
73
+ * @param type - The rendering context type (unused in implementation)
74
+ * @returns Array of HTML strings forming the table row
75
+ */
10
76
  renderToLines(element: AbstractDocRowType, type: string): string[];
11
77
  }
78
+ /**
79
+ * Renderer for Doxygen document table entry elements.
80
+ *
81
+ * @remarks
82
+ * Converts table cell elements to HTML table data or header cells
83
+ * with appropriate attributes. Handles cell spanning, alignment,
84
+ * and styling attributes for flexible table presentation.
85
+ *
86
+ * @public
87
+ */
12
88
  export declare class DocEntryTypeStringRenderer extends ElementStringRendererBase {
89
+ /**
90
+ * Renders a document table entry element to a formatted string.
91
+ *
92
+ * @remarks
93
+ * Creates HTML table cell (td or th) with attributes including
94
+ * colspan, rowspan, alignment, and styling. Processes cell content
95
+ * and applies appropriate markup based on header status.
96
+ *
97
+ * @param element - The document table entry element to render
98
+ * @param type - The rendering context type (unused in implementation)
99
+ * @returns The formatted HTML table cell string
100
+ */
13
101
  renderToString(element: AbstractDocEntryType, type: string): string;
14
102
  }
15
103
  //# sourceMappingURL=doctabletype.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"doctabletype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctabletype.ts"],"names":[],"mappings":"AAgBA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EACV,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,0DAA0D,CAAA;AAIjE,qBAAa,yBAA0B,SAAQ,wBAAwB;IAC5D,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAE7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAiBZ;AAED,qBAAa,uBAAwB,SAAQ,wBAAwB;IAEnE,aAAa,CAAC,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAiBvE;AAED,qBAAa,uBAAwB,SAAQ,wBAAwB;IAE1D,aAAa,CAAC,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAa5E;AAED,qBAAa,0BAA2B,SAAQ,yBAAyB;IAEvE,cAAc,CAAC,OAAO,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAoCpE"}
1
+ {"version":3,"file":"doctabletype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctabletype.ts"],"names":[],"mappings":"AAgBA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EACV,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,0DAA0D,CAAA;AAIjE;;;;;;;;;GASG;AACH,qBAAa,yBAA0B,SAAQ,wBAAwB;IACrE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAE7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAiBZ;AAED;;;;;;;;;GASG;AACH,qBAAa,uBAAwB,SAAQ,wBAAwB;IACnE;;;;;;;;;;;OAWG;IAEH,aAAa,CAAC,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAiBvE;AAED;;;;;;;;;GASG;AACH,qBAAa,uBAAwB,SAAQ,wBAAwB;IACnE;;;;;;;;;;;OAWG;IAEM,aAAa,CAAC,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAa5E;AAED;;;;;;;;;GASG;AACH,qBAAa,0BAA2B,SAAQ,yBAAyB;IACvE;;;;;;;;;;;OAWG;IAEH,cAAc,CAAC,OAAO,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAoCpE"}