@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,27 +1,147 @@
1
1
  import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
2
2
  import { AbstractDataModelBase } from '../types.js';
3
3
  /**
4
+ * Abstract base class for compound reference data models.
5
+ *
6
+ * @remarks
7
+ * Represents references to other compound entities in Doxygen XML output,
8
+ * including inheritance relationships and cross-references. This class
9
+ * handles the 'compoundRefType' XML schema structure with text content
10
+ * and attributes for protection level, virtual specification, and optional
11
+ * reference identifiers.
12
+ *
4
13
  * @public
5
14
  */
6
15
  export declare abstract class AbstractCompoundRefType extends AbstractDataModelBase {
16
+ /**
17
+ * The name or identifier text of the referenced compound.
18
+ *
19
+ * @remarks
20
+ * Contains the textual content extracted from the compound reference XML
21
+ * element, typically representing the name of the referenced class,
22
+ * structure, or other compound entity. This text content serves as the
23
+ * primary identifier for the referenced compound in inheritance
24
+ * relationships and cross-references.
25
+ */
7
26
  text: string;
27
+ /**
28
+ * Protection level of the compound reference.
29
+ *
30
+ * @remarks
31
+ * Specifies the access protection level using DoxProtectionKind
32
+ * enumeration values ('public', 'protected', 'private', 'package').
33
+ * This mandatory attribute determines the visibility and accessibility
34
+ * of the referenced compound in inheritance relationships.
35
+ */
8
36
  prot: string;
37
+ /**
38
+ * Virtual specification of the compound reference.
39
+ *
40
+ * @remarks
41
+ * Specifies the virtual nature using DoxVirtualKind enumeration values
42
+ * ('non-virtual', 'virtual', 'pure-virtual'). This mandatory attribute
43
+ * indicates whether the compound reference involves virtual inheritance
44
+ * or virtual methods in object-oriented programming contexts.
45
+ */
9
46
  virt: string;
47
+ /**
48
+ * Optional reference identifier for cross-linking.
49
+ *
50
+ * @remarks
51
+ * Contains the unique identifier that can be used to create hyperlinks
52
+ * or cross-references to the referenced compound's documentation. When
53
+ * present, this identifier enables navigation between related compound
54
+ * definitions in the generated documentation.
55
+ */
10
56
  refid?: string | undefined;
57
+ /**
58
+ * Constructs a new compound reference data model instance.
59
+ *
60
+ * @remarks
61
+ * Parses compound reference elements from Doxygen XML output, extracting
62
+ * the text content representing the compound name and processing attributes
63
+ * for protection level, virtual specification, and optional reference
64
+ * identifier. This provides the foundation for inheritance and
65
+ * cross-reference relationships in the documentation structure.
66
+ *
67
+ * @param xml - The XML parser instance for processing elements
68
+ * @param element - The XML element object to parse
69
+ * @param elementName - The name of the XML element being processed
70
+ */
11
71
  constructor(xml: DoxygenXmlParser, element: object, elementName: string);
12
72
  }
73
+ /**
74
+ * Type definition for Doxygen protection levels.
75
+ *
76
+ * @remarks
77
+ * Represents the access protection levels available in object-oriented
78
+ * programming languages as recognised by Doxygen. These values correspond
79
+ * to the visibility modifiers used in class inheritance and member access
80
+ * control throughout the documentation system.
81
+ *
82
+ * @public
83
+ */
13
84
  export type DoxProtectionKind = 'public' | 'protected' | 'private' | 'package';
85
+ /**
86
+ * Type definition for Doxygen virtual function specifications.
87
+ *
88
+ * @remarks
89
+ * Represents the virtual function categories recognised by Doxygen for
90
+ * object-oriented programming languages. These values indicate the virtual
91
+ * nature of methods and functions in inheritance hierarchies, enabling
92
+ * proper documentation of polymorphic behaviour and interface contracts.
93
+ *
94
+ * @public
95
+ */
14
96
  export type DoxVirtualKind = 'non-virtual' | 'virtual' | 'pure-virtual';
15
97
  /**
98
+ * Data model for base compound references in inheritance relationships.
99
+ *
100
+ * @remarks
101
+ * Represents references to base classes or parent compounds in inheritance
102
+ * hierarchies as documented by Doxygen. This class handles the
103
+ * 'basecompoundref' XML elements that establish parent-child relationships
104
+ * in object-oriented documentation structures.
105
+ *
16
106
  * @public
17
107
  */
18
108
  export declare class BaseCompoundRefDataModel extends AbstractCompoundRefType {
109
+ /**
110
+ * Constructs a new BaseCompoundRefDataModel instance.
111
+ *
112
+ * @remarks
113
+ * Creates a data model object for 'basecompoundref' XML elements,
114
+ * representing inheritance relationships where the current compound
115
+ * derives from the referenced base compound.
116
+ *
117
+ * @param xml - The XML parser instance for processing elements
118
+ * @param element - The XML element object to parse
119
+ */
19
120
  constructor(xml: DoxygenXmlParser, element: object);
20
121
  }
21
122
  /**
123
+ * Data model for derived compound references in inheritance relationships.
124
+ *
125
+ * @remarks
126
+ * Represents references to derived classes or child compounds in inheritance
127
+ * hierarchies as documented by Doxygen. This class handles the
128
+ * 'derivedcompoundref' XML elements that establish child-parent relationships
129
+ * in object-oriented documentation structures.
130
+ *
22
131
  * @public
23
132
  */
24
133
  export declare class DerivedCompoundRefDataModel extends AbstractCompoundRefType {
134
+ /**
135
+ * Constructs a new DerivedCompoundRefDataModel instance.
136
+ *
137
+ * @remarks
138
+ * Creates a data model object for 'derivedcompoundref' XML elements,
139
+ * representing inheritance relationships where other compounds derive
140
+ * from the current compound as their base.
141
+ *
142
+ * @param xml - The XML parser instance for processing elements
143
+ * @param element - The XML element object to parse
144
+ */
25
145
  constructor(xml: DoxygenXmlParser, element: object);
26
146
  }
27
147
  //# sourceMappingURL=compoundreftype-dm.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"compoundreftype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/compoundreftype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAcnD;;GAEG;AACH,8BAAsB,uBAAwB,SAAQ,qBAAqB;IAEzE,IAAI,SAAK;IAGT,IAAI,SAAK;IACT,IAAI,SAAK;IAGT,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;gBAEd,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA4CxE;AAaD,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,CAAA;AAY9E,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,SAAS,GAAG,cAAc,CAAA;AAOvE;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,uBAAuB;gBACvD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,uBAAuB;gBAC1D,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
1
+ {"version":3,"file":"compoundreftype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/compoundreftype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAcnD;;;;;;;;;;;GAWG;AACH,8BAAsB,uBAAwB,SAAQ,qBAAqB;IAGzE;;;;;;;;;OASG;IACH,IAAI,SAAK;IAIT;;;;;;;;OAQG;IACH,IAAI,SAAK;IAET;;;;;;;;OAQG;IACH,IAAI,SAAK;IAIT;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE1B;;;;;;;;;;;;;OAaG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA4CxE;AAaD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,CAAA;AAY9E;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,SAAS,GAAG,cAAc,CAAA;AAOvE;;;;;;;;;;GAUG;AACH,qBAAa,wBAAyB,SAAQ,uBAAuB;IACnE;;;;;;;;;;OAUG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;GAUG;AACH,qBAAa,2BAA4B,SAAQ,uBAAuB;IACtE;;;;;;;;;;OAUG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
@@ -23,16 +23,76 @@ import { AbstractDataModelBase } from '../types.js';
23
23
  // </xsd:simpleContent>
24
24
  // </xsd:complexType>
25
25
  /**
26
+ * Abstract base class for compound reference data models.
27
+ *
28
+ * @remarks
29
+ * Represents references to other compound entities in Doxygen XML output,
30
+ * including inheritance relationships and cross-references. This class
31
+ * handles the 'compoundRefType' XML schema structure with text content
32
+ * and attributes for protection level, virtual specification, and optional
33
+ * reference identifiers.
34
+ *
26
35
  * @public
27
36
  */
28
37
  export class AbstractCompoundRefType extends AbstractDataModelBase {
29
38
  // Mandatory elements.
39
+ /**
40
+ * The name or identifier text of the referenced compound.
41
+ *
42
+ * @remarks
43
+ * Contains the textual content extracted from the compound reference XML
44
+ * element, typically representing the name of the referenced class,
45
+ * structure, or other compound entity. This text content serves as the
46
+ * primary identifier for the referenced compound in inheritance
47
+ * relationships and cross-references.
48
+ */
30
49
  text = ''; // Passed as element text.
31
50
  // Mandatory attributes.
51
+ /**
52
+ * Protection level of the compound reference.
53
+ *
54
+ * @remarks
55
+ * Specifies the access protection level using DoxProtectionKind
56
+ * enumeration values ('public', 'protected', 'private', 'package').
57
+ * This mandatory attribute determines the visibility and accessibility
58
+ * of the referenced compound in inheritance relationships.
59
+ */
32
60
  prot = '';
61
+ /**
62
+ * Virtual specification of the compound reference.
63
+ *
64
+ * @remarks
65
+ * Specifies the virtual nature using DoxVirtualKind enumeration values
66
+ * ('non-virtual', 'virtual', 'pure-virtual'). This mandatory attribute
67
+ * indicates whether the compound reference involves virtual inheritance
68
+ * or virtual methods in object-oriented programming contexts.
69
+ */
33
70
  virt = '';
34
71
  // Optional attributes.
72
+ /**
73
+ * Optional reference identifier for cross-linking.
74
+ *
75
+ * @remarks
76
+ * Contains the unique identifier that can be used to create hyperlinks
77
+ * or cross-references to the referenced compound's documentation. When
78
+ * present, this identifier enables navigation between related compound
79
+ * definitions in the generated documentation.
80
+ */
35
81
  refid;
82
+ /**
83
+ * Constructs a new compound reference data model instance.
84
+ *
85
+ * @remarks
86
+ * Parses compound reference elements from Doxygen XML output, extracting
87
+ * the text content representing the compound name and processing attributes
88
+ * for protection level, virtual specification, and optional reference
89
+ * identifier. This provides the foundation for inheritance and
90
+ * cross-reference relationships in the documentation structure.
91
+ *
92
+ * @param xml - The XML parser instance for processing elements
93
+ * @param element - The XML element object to parse
94
+ * @param elementName - The name of the XML element being processed
95
+ */
36
96
  constructor(xml, element, elementName) {
37
97
  super(elementName);
38
98
  // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
@@ -70,18 +130,56 @@ export class AbstractCompoundRefType extends AbstractDataModelBase {
70
130
  // <xsd:element name="basecompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
71
131
  // <xsd:element name="derivedcompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
72
132
  /**
133
+ * Data model for base compound references in inheritance relationships.
134
+ *
135
+ * @remarks
136
+ * Represents references to base classes or parent compounds in inheritance
137
+ * hierarchies as documented by Doxygen. This class handles the
138
+ * 'basecompoundref' XML elements that establish parent-child relationships
139
+ * in object-oriented documentation structures.
140
+ *
73
141
  * @public
74
142
  */
75
143
  export class BaseCompoundRefDataModel extends AbstractCompoundRefType {
144
+ /**
145
+ * Constructs a new BaseCompoundRefDataModel instance.
146
+ *
147
+ * @remarks
148
+ * Creates a data model object for 'basecompoundref' XML elements,
149
+ * representing inheritance relationships where the current compound
150
+ * derives from the referenced base compound.
151
+ *
152
+ * @param xml - The XML parser instance for processing elements
153
+ * @param element - The XML element object to parse
154
+ */
76
155
  constructor(xml, element) {
77
156
  // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
78
157
  super(xml, element, 'basecompoundref');
79
158
  }
80
159
  }
81
160
  /**
161
+ * Data model for derived compound references in inheritance relationships.
162
+ *
163
+ * @remarks
164
+ * Represents references to derived classes or child compounds in inheritance
165
+ * hierarchies as documented by Doxygen. This class handles the
166
+ * 'derivedcompoundref' XML elements that establish child-parent relationships
167
+ * in object-oriented documentation structures.
168
+ *
82
169
  * @public
83
170
  */
84
171
  export class DerivedCompoundRefDataModel extends AbstractCompoundRefType {
172
+ /**
173
+ * Constructs a new DerivedCompoundRefDataModel instance.
174
+ *
175
+ * @remarks
176
+ * Creates a data model object for 'derivedcompoundref' XML elements,
177
+ * representing inheritance relationships where other compounds derive
178
+ * from the current compound as their base.
179
+ *
180
+ * @param xml - The XML parser instance for processing elements
181
+ * @param element - The XML element object to parse
182
+ */
85
183
  constructor(xml, element) {
86
184
  // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
87
185
  super(xml, element, 'derivedcompoundref');
@@ -1 +1 @@
1
- {"version":3,"file":"compoundreftype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/compoundreftype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAGjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,2CAA2C;AAC3C,wBAAwB;AACxB,wCAAwC;AACxC,wEAAwE;AACxE,+DAA+D;AAC/D,4DAA4D;AAC5D,uBAAuB;AACvB,yBAAyB;AACzB,qBAAqB;AAErB;;GAEG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,qBAAqB;IACzE,sBAAsB;IACtB,IAAI,GAAG,EAAE,CAAA,CAAC,0BAA0B;IAEpC,wBAAwB;IACxB,IAAI,GAAG,EAAE,CAAA;IACT,IAAI,GAAG,EAAE,CAAA;IAET,uBAAuB;IACvB,KAAK,CAAqB;IAE1B,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAEzD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAC3E,sBAAsB;QAEtB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAElC,MAAM,eAAe,GAAG,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACvD,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;gBAC/B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;YAC5D,CAAC;iBAAM,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;gBACtC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;YAC5D,CAAC;iBAAM,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBACvC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;gBACpE,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,aAAa,EAC3B,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC5B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AA2BD,+EAA+E;AAE/E,oGAAoG;AACpG,uGAAuG;AAEvG;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,uBAAuB;IACnE,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAA;IACxC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,uBAAuB;IACtE,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAA;IAC3C,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"compoundreftype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/compoundreftype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAGjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,2CAA2C;AAC3C,wBAAwB;AACxB,wCAAwC;AACxC,wEAAwE;AACxE,+DAA+D;AAC/D,4DAA4D;AAC5D,uBAAuB;AACvB,yBAAyB;AACzB,qBAAqB;AAErB;;;;;;;;;;;GAWG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,qBAAqB;IACzE,sBAAsB;IAEtB;;;;;;;;;OASG;IACH,IAAI,GAAG,EAAE,CAAA,CAAC,0BAA0B;IAEpC,wBAAwB;IAExB;;;;;;;;OAQG;IACH,IAAI,GAAG,EAAE,CAAA;IAET;;;;;;;;OAQG;IACH,IAAI,GAAG,EAAE,CAAA;IAET,uBAAuB;IAEvB;;;;;;;;OAQG;IACH,KAAK,CAAqB;IAE1B;;;;;;;;;;;;;OAaG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAEzD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAC3E,sBAAsB;QAEtB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAElC,MAAM,eAAe,GAAG,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACvD,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;gBAC/B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;YAC5D,CAAC;iBAAM,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;gBACtC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;YAC5D,CAAC;iBAAM,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBACvC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;gBACpE,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,aAAa,EAC3B,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC5B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAiDD,+EAA+E;AAE/E,oGAAoG;AACpG,uGAAuG;AAEvG;;;;;;;;;;GAUG;AACH,MAAM,OAAO,wBAAyB,SAAQ,uBAAuB;IACnE;;;;;;;;;;OAUG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAA;IACxC,CAAC;CACF;AAED;;;;;;;;;;GAUG;AACH,MAAM,OAAO,2BAA4B,SAAQ,uBAAuB;IACtE;;;;;;;;;;OAUG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAA;IAC3C,CAAC;CACF;AAED,+EAA+E"}