@xpack/doxygen2docusaurus 2.0.0 → 2.2.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 (365) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +3 -1
  3. package/bin/doxygen2docusaurus.js +5 -5
  4. package/dist/cli/main.d.ts +0 -14
  5. package/dist/cli/main.d.ts.map +1 -1
  6. package/dist/cli/main.js +0 -34
  7. package/dist/cli/main.js.map +1 -1
  8. package/dist/docusaurus/cli-options.d.ts +3 -292
  9. package/dist/docusaurus/cli-options.d.ts.map +1 -1
  10. package/dist/docusaurus/cli-options.js +6 -290
  11. package/dist/docusaurus/cli-options.js.map +1 -1
  12. package/dist/docusaurus/generator.d.ts +0 -172
  13. package/dist/docusaurus/generator.d.ts.map +1 -1
  14. package/dist/docusaurus/generator.js +20 -280
  15. package/dist/docusaurus/generator.js.map +1 -1
  16. package/dist/docusaurus/renderers/conceptparts.d.ts +9 -0
  17. package/dist/docusaurus/renderers/conceptparts.d.ts.map +1 -0
  18. package/dist/docusaurus/renderers/conceptparts.js +21 -0
  19. package/dist/docusaurus/renderers/conceptparts.js.map +1 -0
  20. package/dist/docusaurus/renderers/descriptiontype.d.ts +0 -417
  21. package/dist/docusaurus/renderers/descriptiontype.d.ts.map +1 -1
  22. package/dist/docusaurus/renderers/descriptiontype.js +11 -555
  23. package/dist/docusaurus/renderers/descriptiontype.js.map +1 -1
  24. package/dist/docusaurus/renderers/docinternalstype.d.ts +0 -132
  25. package/dist/docusaurus/renderers/docinternalstype.d.ts.map +1 -1
  26. package/dist/docusaurus/renderers/docinternalstype.js +0 -156
  27. package/dist/docusaurus/renderers/docinternalstype.js.map +1 -1
  28. package/dist/docusaurus/renderers/doclisttype.d.ts +0 -22
  29. package/dist/docusaurus/renderers/doclisttype.d.ts.map +1 -1
  30. package/dist/docusaurus/renderers/doclisttype.js +0 -42
  31. package/dist/docusaurus/renderers/doclisttype.js.map +1 -1
  32. package/dist/docusaurus/renderers/doctabletype.d.ts +0 -88
  33. package/dist/docusaurus/renderers/doctabletype.d.ts.map +1 -1
  34. package/dist/docusaurus/renderers/doctabletype.js +1 -113
  35. package/dist/docusaurus/renderers/doctabletype.js.map +1 -1
  36. package/dist/docusaurus/renderers/doctitletype.d.ts +0 -22
  37. package/dist/docusaurus/renderers/doctitletype.d.ts.map +1 -1
  38. package/dist/docusaurus/renderers/doctitletype.js +0 -42
  39. package/dist/docusaurus/renderers/doctitletype.js.map +1 -1
  40. package/dist/docusaurus/renderers/docvariablelisttype.d.ts +0 -44
  41. package/dist/docusaurus/renderers/docvariablelisttype.d.ts.map +1 -1
  42. package/dist/docusaurus/renderers/docvariablelisttype.js +1 -69
  43. package/dist/docusaurus/renderers/docvariablelisttype.js.map +1 -1
  44. package/dist/docusaurus/renderers/docxrefsecttype.d.ts +0 -22
  45. package/dist/docusaurus/renderers/docxrefsecttype.d.ts.map +1 -1
  46. package/dist/docusaurus/renderers/docxrefsecttype.js +0 -38
  47. package/dist/docusaurus/renderers/docxrefsecttype.js.map +1 -1
  48. package/dist/docusaurus/renderers/element-renderer-base.d.ts +0 -74
  49. package/dist/docusaurus/renderers/element-renderer-base.d.ts.map +1 -1
  50. package/dist/docusaurus/renderers/element-renderer-base.js +0 -64
  51. package/dist/docusaurus/renderers/element-renderer-base.js.map +1 -1
  52. package/dist/docusaurus/renderers/inctype.d.ts +0 -23
  53. package/dist/docusaurus/renderers/inctype.d.ts.map +1 -1
  54. package/dist/docusaurus/renderers/inctype.js +0 -41
  55. package/dist/docusaurus/renderers/inctype.js.map +1 -1
  56. package/dist/docusaurus/renderers/linkedtexttype.d.ts +0 -22
  57. package/dist/docusaurus/renderers/linkedtexttype.d.ts.map +1 -1
  58. package/dist/docusaurus/renderers/linkedtexttype.js +0 -45
  59. package/dist/docusaurus/renderers/linkedtexttype.js.map +1 -1
  60. package/dist/docusaurus/renderers/listingtype.d.ts +0 -52
  61. package/dist/docusaurus/renderers/listingtype.d.ts.map +1 -1
  62. package/dist/docusaurus/renderers/listingtype.js +1 -88
  63. package/dist/docusaurus/renderers/listingtype.js.map +1 -1
  64. package/dist/docusaurus/renderers/paramtype.d.ts +0 -22
  65. package/dist/docusaurus/renderers/paramtype.d.ts.map +1 -1
  66. package/dist/docusaurus/renderers/paramtype.js +2 -51
  67. package/dist/docusaurus/renderers/paramtype.js.map +1 -1
  68. package/dist/docusaurus/renderers/referencetype.d.ts +0 -23
  69. package/dist/docusaurus/renderers/referencetype.d.ts.map +1 -1
  70. package/dist/docusaurus/renderers/referencetype.js +0 -38
  71. package/dist/docusaurus/renderers/referencetype.js.map +1 -1
  72. package/dist/docusaurus/renderers/reftexttype.d.ts +0 -22
  73. package/dist/docusaurus/renderers/reftexttype.d.ts.map +1 -1
  74. package/dist/docusaurus/renderers/reftexttype.js +0 -38
  75. package/dist/docusaurus/renderers/reftexttype.js.map +1 -1
  76. package/dist/docusaurus/renderers/reftype.d.ts +0 -22
  77. package/dist/docusaurus/renderers/reftype.d.ts.map +1 -1
  78. package/dist/docusaurus/renderers/reftype.js +0 -38
  79. package/dist/docusaurus/renderers/reftype.js.map +1 -1
  80. package/dist/docusaurus/renderers/renderers.d.ts +0 -151
  81. package/dist/docusaurus/renderers/renderers.d.ts.map +1 -1
  82. package/dist/docusaurus/renderers/renderers.js +15 -186
  83. package/dist/docusaurus/renderers/renderers.js.map +1 -1
  84. package/dist/docusaurus/renderers/substringtype.d.ts +0 -22
  85. package/dist/docusaurus/renderers/substringtype.d.ts.map +1 -1
  86. package/dist/docusaurus/renderers/substringtype.js +0 -39
  87. package/dist/docusaurus/renderers/substringtype.js.map +1 -1
  88. package/dist/docusaurus/renderers/tableofcontentstype.d.ts +0 -22
  89. package/dist/docusaurus/renderers/tableofcontentstype.d.ts.map +1 -1
  90. package/dist/docusaurus/renderers/tableofcontentstype.js +0 -39
  91. package/dist/docusaurus/renderers/tableofcontentstype.js.map +1 -1
  92. package/dist/docusaurus/types.d.ts +0 -110
  93. package/dist/docusaurus/types.d.ts.map +1 -1
  94. package/dist/docusaurus/types.js +0 -11
  95. package/dist/docusaurus/types.js.map +1 -1
  96. package/dist/docusaurus/utils.d.ts +0 -214
  97. package/dist/docusaurus/utils.d.ts.map +1 -1
  98. package/dist/docusaurus/utils.js +0 -296
  99. package/dist/docusaurus/utils.js.map +1 -1
  100. package/dist/docusaurus/view-model/classes-vm.d.ts +0 -137
  101. package/dist/docusaurus/view-model/classes-vm.d.ts.map +1 -1
  102. package/dist/docusaurus/view-model/classes-vm.js +9 -225
  103. package/dist/docusaurus/view-model/classes-vm.js.map +1 -1
  104. package/dist/docusaurus/view-model/collection-base.d.ts +0 -120
  105. package/dist/docusaurus/view-model/collection-base.d.ts.map +1 -1
  106. package/dist/docusaurus/view-model/collection-base.js +11 -101
  107. package/dist/docusaurus/view-model/collection-base.js.map +1 -1
  108. package/dist/docusaurus/view-model/compound-base-vm.d.ts +2 -147
  109. package/dist/docusaurus/view-model/compound-base-vm.d.ts.map +1 -1
  110. package/dist/docusaurus/view-model/compound-base-vm.js +47 -225
  111. package/dist/docusaurus/view-model/compound-base-vm.js.map +1 -1
  112. package/dist/docusaurus/view-model/concepts-vm.d.ts +27 -0
  113. package/dist/docusaurus/view-model/concepts-vm.d.ts.map +1 -0
  114. package/dist/docusaurus/view-model/concepts-vm.js +337 -0
  115. package/dist/docusaurus/view-model/concepts-vm.js.map +1 -0
  116. package/dist/docusaurus/view-model/description-anchors.d.ts +0 -58
  117. package/dist/docusaurus/view-model/description-anchors.d.ts.map +1 -1
  118. package/dist/docusaurus/view-model/description-anchors.js +0 -71
  119. package/dist/docusaurus/view-model/description-anchors.js.map +1 -1
  120. package/dist/docusaurus/view-model/files-and-folders-vm.d.ts +0 -247
  121. package/dist/docusaurus/view-model/files-and-folders-vm.d.ts.map +1 -1
  122. package/dist/docusaurus/view-model/files-and-folders-vm.js +61 -353
  123. package/dist/docusaurus/view-model/files-and-folders-vm.js.map +1 -1
  124. package/dist/docusaurus/view-model/groups-vm.d.ts +0 -148
  125. package/dist/docusaurus/view-model/groups-vm.d.ts.map +1 -1
  126. package/dist/docusaurus/view-model/groups-vm.js +2 -223
  127. package/dist/docusaurus/view-model/groups-vm.js.map +1 -1
  128. package/dist/docusaurus/view-model/members-vm.d.ts +0 -552
  129. package/dist/docusaurus/view-model/members-vm.d.ts.map +1 -1
  130. package/dist/docusaurus/view-model/members-vm.js +17 -702
  131. package/dist/docusaurus/view-model/members-vm.js.map +1 -1
  132. package/dist/docusaurus/view-model/namespaces-vm.d.ts +5 -199
  133. package/dist/docusaurus/view-model/namespaces-vm.d.ts.map +1 -1
  134. package/dist/docusaurus/view-model/namespaces-vm.js +85 -284
  135. package/dist/docusaurus/view-model/namespaces-vm.js.map +1 -1
  136. package/dist/docusaurus/view-model/options.d.ts +0 -43
  137. package/dist/docusaurus/view-model/options.d.ts.map +1 -1
  138. package/dist/docusaurus/view-model/options.js +0 -57
  139. package/dist/docusaurus/view-model/options.js.map +1 -1
  140. package/dist/docusaurus/view-model/pages-vm.d.ts +0 -115
  141. package/dist/docusaurus/view-model/pages-vm.d.ts.map +1 -1
  142. package/dist/docusaurus/view-model/pages-vm.js +39 -162
  143. package/dist/docusaurus/view-model/pages-vm.js.map +1 -1
  144. package/dist/docusaurus/view-model/tree-entries-vm.d.ts +8 -142
  145. package/dist/docusaurus/view-model/tree-entries-vm.d.ts.map +1 -1
  146. package/dist/docusaurus/view-model/tree-entries-vm.js +54 -174
  147. package/dist/docusaurus/view-model/tree-entries-vm.js.map +1 -1
  148. package/dist/docusaurus/view-model/view-model.d.ts +0 -125
  149. package/dist/docusaurus/view-model/view-model.d.ts.map +1 -1
  150. package/dist/docusaurus/view-model/view-model.js +20 -182
  151. package/dist/docusaurus/view-model/view-model.js.map +1 -1
  152. package/dist/docusaurus/workspace.d.ts +1 -126
  153. package/dist/docusaurus/workspace.d.ts.map +1 -1
  154. package/dist/docusaurus/workspace.js +8 -221
  155. package/dist/docusaurus/workspace.js.map +1 -1
  156. package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts +7 -492
  157. package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts.map +1 -1
  158. package/dist/doxygen/data-model/compounds/compounddef-dm.js +28 -672
  159. package/dist/doxygen/data-model/compounds/compounddef-dm.js.map +1 -1
  160. package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts +0 -129
  161. package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts.map +1 -1
  162. package/dist/doxygen/data-model/compounds/compoundreftype-dm.js +1 -145
  163. package/dist/doxygen/data-model/compounds/compoundreftype-dm.js.map +1 -1
  164. package/dist/doxygen/data-model/compounds/concepts-dm.d.ts +23 -0
  165. package/dist/doxygen/data-model/compounds/concepts-dm.d.ts.map +1 -0
  166. package/dist/doxygen/data-model/compounds/concepts-dm.js +94 -0
  167. package/dist/doxygen/data-model/compounds/concepts-dm.js.map +1 -0
  168. package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts +104 -2848
  169. package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts.map +1 -1
  170. package/dist/doxygen/data-model/compounds/descriptiontype-dm.js +73 -3975
  171. package/dist/doxygen/data-model/compounds/descriptiontype-dm.js.map +1 -1
  172. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts +0 -165
  173. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts.map +1 -1
  174. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js +0 -229
  175. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js.map +1 -1
  176. package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts +0 -70
  177. package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts.map +1 -1
  178. package/dist/doxygen/data-model/compounds/doxygentype-dm.js +0 -105
  179. package/dist/doxygen/data-model/compounds/doxygentype-dm.js.map +1 -1
  180. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts +0 -84
  181. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts.map +1 -1
  182. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js +1 -122
  183. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js.map +1 -1
  184. package/dist/doxygen/data-model/compounds/inctype-dm.d.ts +0 -116
  185. package/dist/doxygen/data-model/compounds/inctype-dm.d.ts.map +1 -1
  186. package/dist/doxygen/data-model/compounds/inctype-dm.js +3 -155
  187. package/dist/doxygen/data-model/compounds/inctype-dm.js.map +1 -1
  188. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts +3 -138
  189. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts.map +1 -1
  190. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js +5 -180
  191. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js.map +1 -1
  192. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts +0 -76
  193. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts.map +1 -1
  194. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js +0 -107
  195. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js.map +1 -1
  196. package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts +0 -162
  197. package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts.map +1 -1
  198. package/dist/doxygen/data-model/compounds/locationtype-dm.js +4 -203
  199. package/dist/doxygen/data-model/compounds/locationtype-dm.js.map +1 -1
  200. package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts +2 -443
  201. package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts.map +1 -1
  202. package/dist/doxygen/data-model/compounds/memberdeftype-dm.js +19 -475
  203. package/dist/doxygen/data-model/compounds/memberdeftype-dm.js.map +1 -1
  204. package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts +0 -141
  205. package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts.map +1 -1
  206. package/dist/doxygen/data-model/compounds/memberreftype-dm.js +0 -176
  207. package/dist/doxygen/data-model/compounds/memberreftype-dm.js.map +1 -1
  208. package/dist/doxygen/data-model/compounds/membertype-dm.d.ts +0 -101
  209. package/dist/doxygen/data-model/compounds/membertype-dm.d.ts.map +1 -1
  210. package/dist/doxygen/data-model/compounds/membertype-dm.js +0 -115
  211. package/dist/doxygen/data-model/compounds/membertype-dm.js.map +1 -1
  212. package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts +0 -164
  213. package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts.map +1 -1
  214. package/dist/doxygen/data-model/compounds/paramtype-dm.js +0 -208
  215. package/dist/doxygen/data-model/compounds/paramtype-dm.js.map +1 -1
  216. package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts +0 -139
  217. package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts.map +1 -1
  218. package/dist/doxygen/data-model/compounds/referencetype-dm.js +2 -175
  219. package/dist/doxygen/data-model/compounds/referencetype-dm.js.map +1 -1
  220. package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts +0 -120
  221. package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts.map +1 -1
  222. package/dist/doxygen/data-model/compounds/reftexttype-dm.js +2 -141
  223. package/dist/doxygen/data-model/compounds/reftexttype-dm.js.map +1 -1
  224. package/dist/doxygen/data-model/compounds/reftype-dm.d.ts +0 -268
  225. package/dist/doxygen/data-model/compounds/reftype-dm.d.ts.map +1 -1
  226. package/dist/doxygen/data-model/compounds/reftype-dm.js +4 -326
  227. package/dist/doxygen/data-model/compounds/reftype-dm.js.map +1 -1
  228. package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts +0 -105
  229. package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts.map +1 -1
  230. package/dist/doxygen/data-model/compounds/reimplementtype-dm.js +1 -139
  231. package/dist/doxygen/data-model/compounds/reimplementtype-dm.js.map +1 -1
  232. package/dist/doxygen/data-model/compounds/requirements-dm.d.ts +2 -0
  233. package/dist/doxygen/data-model/compounds/requirements-dm.d.ts.map +1 -0
  234. package/dist/doxygen/data-model/compounds/requirements-dm.js +2 -0
  235. package/dist/doxygen/data-model/compounds/requirements-dm.js.map +1 -0
  236. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts +0 -168
  237. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts.map +1 -1
  238. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js +0 -209
  239. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js.map +1 -1
  240. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts +0 -267
  241. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts.map +1 -1
  242. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js +0 -354
  243. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js.map +1 -1
  244. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts +0 -66
  245. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts.map +1 -1
  246. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js +0 -97
  247. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js.map +1 -1
  248. package/dist/doxygen/data-model/data-model.d.ts +0 -149
  249. package/dist/doxygen/data-model/data-model.d.ts.map +1 -1
  250. package/dist/doxygen/data-model/data-model.js +8 -200
  251. package/dist/doxygen/data-model/data-model.js.map +1 -1
  252. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts +0 -115
  253. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts.map +1 -1
  254. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js +4 -129
  255. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js.map +1 -1
  256. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts +0 -87
  257. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts.map +1 -1
  258. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js +0 -118
  259. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js.map +1 -1
  260. package/dist/doxygen/data-model/doxygen-xml-parser.d.ts +0 -253
  261. package/dist/doxygen/data-model/doxygen-xml-parser.d.ts.map +1 -1
  262. package/dist/doxygen/data-model/doxygen-xml-parser.js +0 -291
  263. package/dist/doxygen/data-model/doxygen-xml-parser.js.map +1 -1
  264. package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts +0 -98
  265. package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts.map +1 -1
  266. package/dist/doxygen/data-model/index/indexcompoundtype-dm.js +2 -122
  267. package/dist/doxygen/data-model/index/indexcompoundtype-dm.js.map +1 -1
  268. package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts +0 -82
  269. package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts.map +1 -1
  270. package/dist/doxygen/data-model/index/indexdoxygentype-dm.js +0 -114
  271. package/dist/doxygen/data-model/index/indexdoxygentype-dm.js.map +1 -1
  272. package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts +0 -85
  273. package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts.map +1 -1
  274. package/dist/doxygen/data-model/index/indexmembertype-dm.js +1 -107
  275. package/dist/doxygen/data-model/index/indexmembertype-dm.js.map +1 -1
  276. package/dist/doxygen/data-model/types.d.ts +0 -104
  277. package/dist/doxygen/data-model/types.d.ts.map +1 -1
  278. package/dist/doxygen/data-model/types.js +0 -52
  279. package/dist/doxygen/data-model/types.js.map +1 -1
  280. package/dist/index.d.ts +5 -16
  281. package/dist/index.d.ts.map +1 -1
  282. package/dist/index.js +5 -42
  283. package/dist/index.js.map +1 -1
  284. package/package.json +49 -52
  285. package/src/cli/main.ts +122 -0
  286. package/src/docusaurus/cli-options.ts +560 -0
  287. package/src/docusaurus/generator.ts +788 -0
  288. package/src/docusaurus/renderers/conceptparts.ts +119 -0
  289. package/src/docusaurus/renderers/descriptiontype.ts +1299 -0
  290. package/src/docusaurus/renderers/docinternalstype.ts +354 -0
  291. package/src/docusaurus/renderers/doclisttype.ts +134 -0
  292. package/src/docusaurus/renderers/doctabletype.ts +220 -0
  293. package/src/docusaurus/renderers/doctitletype.ts +77 -0
  294. package/src/docusaurus/renderers/docvariablelisttype.ts +123 -0
  295. package/src/docusaurus/renderers/docxrefsecttype.ts +84 -0
  296. package/src/docusaurus/renderers/element-renderer-base.ts +112 -0
  297. package/src/docusaurus/renderers/inctype.ts +75 -0
  298. package/src/docusaurus/renderers/linkedtexttype.ts +64 -0
  299. package/src/docusaurus/renderers/listingtype.ts +235 -0
  300. package/src/docusaurus/renderers/paramtype.ts +116 -0
  301. package/src/docusaurus/renderers/referencetype.ts +83 -0
  302. package/src/docusaurus/renderers/reftexttype.ts +81 -0
  303. package/src/docusaurus/renderers/reftype.ts +77 -0
  304. package/src/docusaurus/renderers/renderers.ts +812 -0
  305. package/src/docusaurus/renderers/substringtype.ts +53 -0
  306. package/src/docusaurus/renderers/tableofcontentstype.ts +74 -0
  307. package/src/docusaurus/types.ts +187 -0
  308. package/src/docusaurus/utils.ts +409 -0
  309. package/src/docusaurus/view-model/README.md +12 -0
  310. package/src/docusaurus/view-model/classes-vm.ts +1088 -0
  311. package/src/docusaurus/view-model/collection-base.ts +352 -0
  312. package/src/docusaurus/view-model/compound-base-vm.ts +1340 -0
  313. package/src/docusaurus/view-model/concepts-vm.ts +749 -0
  314. package/src/docusaurus/view-model/description-anchors.ts +107 -0
  315. package/src/docusaurus/view-model/files-and-folders-vm.ts +1293 -0
  316. package/src/docusaurus/view-model/groups-vm.ts +548 -0
  317. package/src/docusaurus/view-model/members-vm.ts +1943 -0
  318. package/src/docusaurus/view-model/namespaces-vm.ts +1037 -0
  319. package/src/docusaurus/view-model/options.ts +95 -0
  320. package/src/docusaurus/view-model/pages-vm.ts +389 -0
  321. package/src/docusaurus/view-model/tree-entries-vm.ts +376 -0
  322. package/src/docusaurus/view-model/view-model.ts +513 -0
  323. package/src/docusaurus/workspace.ts +588 -0
  324. package/src/doxygen/data-model/README.md +13 -0
  325. package/src/doxygen/data-model/compounds/compounddef-dm.ts +1230 -0
  326. package/src/doxygen/data-model/compounds/compoundreftype-dm.ts +266 -0
  327. package/src/doxygen/data-model/compounds/concepts-dm.ts +362 -0
  328. package/src/doxygen/data-model/compounds/descriptiontype-dm.ts +10114 -0
  329. package/src/doxygen/data-model/compounds/docvarlistentrytype-dm.ts +354 -0
  330. package/src/doxygen/data-model/compounds/doxygentype-dm.ts +187 -0
  331. package/src/doxygen/data-model/compounds/enumvaluetype-dm.ts +218 -0
  332. package/src/doxygen/data-model/compounds/inctype-dm.ts +217 -0
  333. package/src/doxygen/data-model/compounds/linkedtexttype-dm.ts +288 -0
  334. package/src/doxygen/data-model/compounds/listofallmemberstype-dm.ts +160 -0
  335. package/src/doxygen/data-model/compounds/locationtype-dm.ts +284 -0
  336. package/src/doxygen/data-model/compounds/memberdeftype-dm.ts +881 -0
  337. package/src/doxygen/data-model/compounds/memberreftype-dm.ts +270 -0
  338. package/src/doxygen/data-model/compounds/membertype-dm.ts +239 -0
  339. package/src/doxygen/data-model/compounds/paramtype-dm.ts +302 -0
  340. package/src/doxygen/data-model/compounds/referencetype-dm.ts +248 -0
  341. package/src/doxygen/data-model/compounds/reftexttype-dm.ts +234 -0
  342. package/src/doxygen/data-model/compounds/reftype-dm.ts +430 -0
  343. package/src/doxygen/data-model/compounds/reimplementtype-dm.ts +201 -0
  344. package/src/doxygen/data-model/compounds/requirements-dm.ts +50 -0
  345. package/src/doxygen/data-model/compounds/sectiondeftype-dm.ts +330 -0
  346. package/src/doxygen/data-model/compounds/tableofcontentstype-dm.ts +564 -0
  347. package/src/doxygen/data-model/compounds/templateparamlisttype-dm.ts +150 -0
  348. package/src/doxygen/data-model/data-model.ts +378 -0
  349. package/src/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.ts +271 -0
  350. package/src/doxygen/data-model/doxyfile/doxyfiletype-dm.ts +200 -0
  351. package/src/doxygen/data-model/doxygen-xml-parser.ts +522 -0
  352. package/src/doxygen/data-model/index/indexcompoundtype-dm.ts +256 -0
  353. package/src/doxygen/data-model/index/indexdoxygentype-dm.ts +196 -0
  354. package/src/doxygen/data-model/index/indexmembertype-dm.ts +230 -0
  355. package/src/doxygen/data-model/types.ts +175 -0
  356. package/src/doxygen/data-model/xsds/README.md +6 -0
  357. package/src/doxygen/data-model/xsds/compound.xsd +1788 -0
  358. package/src/doxygen/data-model/xsds/doxyfile.xsd +365 -0
  359. package/src/doxygen/data-model/xsds/index.xsd +74 -0
  360. package/src/doxygen/data-model/xsds/xml.xsd +23 -0
  361. package/src/index.ts +267 -0
  362. package/src/tsconfig.json +12 -0
  363. package/dist/doxygen2docusaurus.d.ts +0 -4774
  364. package/dist/tsconfig.tsbuildinfo +0 -1
  365. package/dist/tsdoc-metadata.json +0 -11
@@ -1,93 +1,18 @@
1
- /*
2
- * This file is part of the xPack project (http://xpack.github.io).
3
- * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
4
- *
5
- * Permission to use, copy, modify, and/or distribute this software
6
- * for any purpose is hereby granted, under the terms of the MIT license.
7
- *
8
- * If a copy of the license was not distributed with this file, it can
9
- * be obtained from https://opensource.org/licenses/MIT.
10
- */
11
- // ----------------------------------------------------------------------------
12
1
  import assert from 'node:assert';
13
2
  import * as util from 'node:util';
14
3
  import { CompoundDefDataModel } from './compounddef-dm.js';
15
4
  import { AbstractDataModelBase } from '../types.js';
16
- // ----------------------------------------------------------------------------
17
- // <xsd:complexType name="DoxygenType">
18
- // <xsd:sequence maxOccurs="unbounded">
19
- // <xsd:element name="compounddef" type="compounddefType" minOccurs="0" />
20
- // </xsd:sequence>
21
- // <xsd:attribute name="version" type="DoxVersionNumber" use="required" />
22
- // <xsd:attribute ref="xml:lang" use="required"/>
23
- // </xsd:complexType>
24
- /**
25
- * Abstract base class for the root Doxygen document type.
26
- *
27
- * @remarks
28
- * Represents the top-level Doxygen XML document structure containing
29
- * compound definitions and document metadata. This is the root element
30
- * that contains all other documentation elements parsed from Doxygen XML.
31
- *
32
- * @public
33
- */
34
5
  export class AbstractDoxygenType extends AbstractDataModelBase {
35
- // Mandatory attributes.
36
- /**
37
- * The version of Doxygen that generated the XML.
38
- *
39
- * @remarks
40
- * Version string indicating which Doxygen version was used to
41
- * generate the XML output, useful for compatibility checking.
42
- */
43
6
  version = '';
44
- /**
45
- * The language code for the documentation.
46
- *
47
- * @remarks
48
- * XML language attribute indicating the primary language used
49
- * in the documentation content.
50
- */
51
7
  lang = '';
52
- // Optional elements.
53
- /**
54
- * Array of compound definition data models.
55
- *
56
- * @remarks
57
- * Contains all the compound definitions (classes, files, namespaces, etc.)
58
- * that are documented within this Doxygen XML file. This is the main
59
- * content of the documentation.
60
- */
61
8
  compoundDefs;
62
- // Optional attributes.
63
- /**
64
- * XML schema location when no namespace is specified.
65
- *
66
- * @remarks
67
- * Optional attribute specifying the schema location for XML
68
- * validation when no explicit namespace is used.
69
- */
70
9
  noNamespaceSchemaLocation;
71
- /**
72
- * Creates a new Doxygen document data model from XML.
73
- *
74
- * @remarks
75
- * Parses the root XML element representing a Doxygen document and
76
- * extracts all compound definitions and metadata attributes.
77
- *
78
- * @param xml - The XML parser instance
79
- * @param element - The XML element to parse
80
- * @param elementName - The name of the XML element
81
- */
82
10
  constructor(xml, element, elementName) {
83
11
  super(elementName);
84
- // console.log(elementName, util.inspect(element,
85
- // { compact: false, depth: 999 }))
86
12
  const innerElements = xml.getInnerElements(element, elementName);
87
13
  assert(innerElements.length > 0);
88
14
  for (const innerElement of innerElements) {
89
15
  if (xml.hasInnerText(innerElement)) {
90
- // Ignore texts.
91
16
  }
92
17
  else if (xml.hasInnerElement(innerElement, 'compounddef')) {
93
18
  this.compoundDefs ??= [];
@@ -98,13 +23,9 @@ export class AbstractDoxygenType extends AbstractDataModelBase {
98
23
  console.error(`${elementName} element:`, Object.keys(innerElement), 'not implemented yet in', this.constructor.name);
99
24
  }
100
25
  }
101
- // ------------------------------------------------------------------------
102
- // Process attributes.
103
26
  assert(xml.hasAttributes(element));
104
27
  const attributesNames = xml.getAttributesNames(element);
105
- // console.log(attributesNames)
106
28
  for (const attributeName of attributesNames) {
107
- // console.log(attributeName)
108
29
  if (attributeName === '@_version') {
109
30
  this.version = xml.getAttributeStringValue(element, '@_version');
110
31
  }
@@ -121,37 +42,11 @@ export class AbstractDoxygenType extends AbstractDataModelBase {
121
42
  }
122
43
  assert(this.version.length > 0);
123
44
  assert(this.lang.length > 0);
124
- // ------------------------------------------------------------------------
125
- // console.log(util.inspect(this, { compact: false, depth: 999 }))
126
45
  }
127
46
  }
128
- // ----------------------------------------------------------------------------
129
- // <xsd:element name="doxygen" type="DoxygenType"/>
130
- /**
131
- * Concrete implementation of the Doxygen document data model.
132
- *
133
- * @remarks
134
- * Represents the root doxygen element in Doxygen XML files. Inherits
135
- * all functionality from the abstract base class and provides the
136
- * specific element name for parsing.
137
- *
138
- * @public
139
- */
140
47
  export class DoxygenDataModel extends AbstractDoxygenType {
141
- /**
142
- * Creates a new Doxygen document data model from XML.
143
- *
144
- * @remarks
145
- * Parses the XML element representing the root doxygen element using
146
- * the inherited parsing logic with the 'doxygen' element name.
147
- *
148
- * @param xml - The XML parser instance
149
- * @param element - The XML element to parse
150
- */
151
48
  constructor(xml, element) {
152
- // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
153
49
  super(xml, element, 'doxygen');
154
50
  }
155
51
  }
156
- // ----------------------------------------------------------------------------
157
52
  //# sourceMappingURL=doxygentype-dm.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"doxygentype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/doxygentype-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,oBAAoB,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,uCAAuC;AACvC,yCAAyC;AACzC,8EAA8E;AAC9E,oBAAoB;AACpB,4EAA4E;AAC5E,mDAAmD;AACnD,qBAAqB;AAErB;;;;;;;;;GASG;AACH,MAAM,OAAgB,mBAAoB,SAAQ,qBAAqB;IACrE,wBAAwB;IACxB;;;;;;OAMG;IACH,OAAO,GAAG,EAAE,CAAA;IAEZ;;;;;;OAMG;IACH,IAAI,GAAG,EAAE,CAAA;IAET,qBAAqB;IACrB;;;;;;;OAOG;IACH,YAAY,CAAqC;IAEjD,uBAAuB;IACvB;;;;;;OAMG;IACH,yBAAyB,CAAqB;IAE9C;;;;;;;;;;OAUG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,iDAAiD;QACjD,qCAAqC;QAErC,MAAM,aAAa,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAChE,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAEhC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnC,gBAAgB;YAClB,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,CAAC;gBAC5D,IAAI,CAAC,YAAY,KAAK,EAAE,CAAA;gBACxB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YACrE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,WAAW,EACzB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,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,+BAA+B;QAC/B,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,6BAA6B;YAC7B,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBAClC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,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,6BAA6B,EAAE,CAAC;gBAC3D,IAAI,CAAC,yBAAyB,GAAG,GAAG,CAAC,uBAAuB,CAC1D,OAAO,EACP,6BAA6B,CAC9B,CAAA;YACH,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;QACD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,mDAAmD;AAEnD;;;;;;;;;GASG;AACH,MAAM,OAAO,gBAAiB,SAAQ,mBAAmB;IACvD;;;;;;;;;OASG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,CAAA;IAChC,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"doxygentype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/doxygentype-dm.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAGjC,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAsBnD,MAAM,OAAgB,mBAAoB,SAAQ,qBAAqB;IASrE,OAAO,GAAG,EAAE,CAAA;IASZ,IAAI,GAAG,EAAE,CAAA;IAWT,YAAY,CAAqC;IAUjD,yBAAyB,CAAqB;IAa9C,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAKlB,MAAM,aAAa,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAChE,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAEhC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;YAErC,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,CAAC;gBAC5D,IAAI,CAAC,YAAY,KAAK,EAAE,CAAA;gBACxB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YACrE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,WAAW,EACzB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAKD,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAElC,MAAM,eAAe,GAAG,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QAEvD,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAE5C,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBAClC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,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,6BAA6B,EAAE,CAAC;gBAC3D,IAAI,CAAC,yBAAyB,GAAG,GAAG,CAAC,uBAAuB,CAC1D,OAAO,EACP,6BAA6B,CAC9B,CAAA;YACH,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;QACD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAK9B,CAAC;CACF;AAgBD,MAAM,OAAO,gBAAiB,SAAQ,mBAAmB;IAWvD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,CAAA;IAChC,CAAC;CACF"}
@@ -2,100 +2,16 @@ import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
2
2
  import { AbstractDataModelBase } from '../types.js';
3
3
  import { BriefDescriptionDataModel, DetailedDescriptionDataModel } from './descriptiontype-dm.js';
4
4
  import { InitializerDataModel } from './linkedtexttype-dm.js';
5
- /**
6
- * Abstract base class for enumeration value data models.
7
- *
8
- * @remarks
9
- * Represents individual values within enumeration types as parsed from
10
- * Doxygen XML. Contains the value name, optional initialiser expression,
11
- * and documentation descriptions with protection level information.
12
- *
13
- * @public
14
- */
15
5
  export declare abstract class AbstractEnumValueType extends AbstractDataModelBase {
16
- /**
17
- * The name of the enumeration value.
18
- *
19
- * @remarks
20
- * Simple identifier for the enumeration constant as it appears
21
- * in the source code.
22
- */
23
6
  name: string;
24
- /**
25
- * Optional initialiser expression for the enumeration value.
26
- *
27
- * @remarks
28
- * Contains the explicit value assignment expression when the
29
- * enumeration value is explicitly initialised in the source code.
30
- */
31
7
  initializer?: InitializerDataModel | undefined;
32
- /**
33
- * Brief description of the enumeration value.
34
- *
35
- * @remarks
36
- * Short documentation comment providing a concise explanation
37
- * of the enumeration value's purpose or meaning.
38
- */
39
8
  briefDescription?: BriefDescriptionDataModel | undefined;
40
- /**
41
- * Detailed description of the enumeration value.
42
- *
43
- * @remarks
44
- * Comprehensive documentation comment providing full details
45
- * about the enumeration value's purpose, usage, and behaviour.
46
- */
47
9
  detailedDescription?: DetailedDescriptionDataModel | undefined;
48
- /**
49
- * Unique identifier for the enumeration value.
50
- *
51
- * @remarks
52
- * Doxygen-generated identifier used for cross-referencing
53
- * and creating links to this enumeration value.
54
- */
55
10
  id: string;
56
- /**
57
- * Protection level of the enumeration value.
58
- *
59
- * @remarks
60
- * Indicates the visibility scope such as 'public', 'private',
61
- * or 'protected' based on Doxygen's protection kind enumeration.
62
- */
63
11
  prot: string;
64
- /**
65
- * Creates a new enumeration value data model.
66
- *
67
- * @remarks
68
- * Parses the XML element representing an enumeration value and
69
- * extracts all relevant information including name, initialiser,
70
- * descriptions, and attributes.
71
- *
72
- * @param xml - The XML parser instance
73
- * @param element - The XML element to parse
74
- * @param elementName - The name of the XML element
75
- */
76
12
  constructor(xml: DoxygenXmlParser, element: object, elementName: string);
77
13
  }
78
- /**
79
- * Concrete implementation of enumeration value data model.
80
- *
81
- * @remarks
82
- * Represents a single enumeration value as parsed from Doxygen XML
83
- * output. Inherits all functionality from the abstract base class
84
- * and provides the specific element name for parsing.
85
- *
86
- * @public
87
- */
88
14
  export declare class EnumValueDataModel extends AbstractEnumValueType {
89
- /**
90
- * Creates a new enumeration value data model from XML.
91
- *
92
- * @remarks
93
- * Parses the XML element representing an enumeration value using
94
- * the inherited parsing logic with the 'enumvalue' element name.
95
- *
96
- * @param xml - The XML parser instance
97
- * @param element - The XML element to parse
98
- */
99
15
  constructor(xml: DoxygenXmlParser, element: object);
100
16
  }
101
17
  //# sourceMappingURL=enumvaluetype-dm.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"enumvaluetype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/enumvaluetype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EACL,yBAAyB,EACzB,4BAA4B,EAC7B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAe7D;;;;;;;;;GASG;AACH,8BAAsB,qBAAsB,SAAQ,qBAAqB;IAEvE;;;;;;OAMG;IACH,IAAI,SAAK;IAGT;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAA;IAE9C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAA;IAExD;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,4BAA4B,GAAG,SAAS,CAAA;IAG9D;;;;;;OAMG;IACH,EAAE,SAAK;IAEP;;;;;;OAMG;IACH,IAAI,SAAK;IAET;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAmExE;AAMD;;;;;;;;;GASG;AACH,qBAAa,kBAAmB,SAAQ,qBAAqB;IAC3D;;;;;;;;;OASG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
1
+ {"version":3,"file":"enumvaluetype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/enumvaluetype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EACL,yBAAyB,EACzB,4BAA4B,EAC7B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAyB7D,8BAAsB,qBAAsB,SAAQ,qBAAqB;IASvE,IAAI,SAAK;IAUT,WAAW,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAA;IAS9C,gBAAgB,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAA;IASxD,mBAAmB,CAAC,EAAE,4BAA4B,GAAG,SAAS,CAAA;IAU9D,EAAE,SAAK;IASP,IAAI,SAAK;gBAcG,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAmExE;AAgBD,qBAAa,kBAAmB,SAAQ,qBAAqB;gBAW/C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
@@ -1,114 +1,21 @@
1
- /*
2
- * This file is part of the xPack project (http://xpack.github.io).
3
- * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
4
- *
5
- * Permission to use, copy, modify, and/or distribute this software
6
- * for any purpose is hereby granted, under the terms of the MIT license.
7
- *
8
- * If a copy of the license was not distributed with this file, it can
9
- * be obtained from https://opensource.org/licenses/MIT.
10
- */
11
- // ----------------------------------------------------------------------------
12
1
  import assert from 'node:assert';
13
2
  import * as util from 'node:util';
14
3
  import { AbstractDataModelBase } from '../types.js';
15
4
  import { BriefDescriptionDataModel, DetailedDescriptionDataModel, } from './descriptiontype-dm.js';
16
5
  import { InitializerDataModel } from './linkedtexttype-dm.js';
17
- // ----------------------------------------------------------------------------
18
- // <xsd:complexType name="enumvalueType">
19
- // <xsd:sequence>
20
- // <xsd:element name="name" type="xsd:string" />
21
- // <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
22
- // <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
23
- // <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
24
- // </xsd:sequence>
25
- // <xsd:attribute name="id" type="xsd:string" />
26
- // <xsd:attribute name="prot" type="DoxProtectionKind" />
27
- // </xsd:complexType>
28
- /**
29
- * Abstract base class for enumeration value data models.
30
- *
31
- * @remarks
32
- * Represents individual values within enumeration types as parsed from
33
- * Doxygen XML. Contains the value name, optional initialiser expression,
34
- * and documentation descriptions with protection level information.
35
- *
36
- * @public
37
- */
38
6
  export class AbstractEnumValueType extends AbstractDataModelBase {
39
- // Mandatory elements.
40
- /**
41
- * The name of the enumeration value.
42
- *
43
- * @remarks
44
- * Simple identifier for the enumeration constant as it appears
45
- * in the source code.
46
- */
47
7
  name = '';
48
- // Optional elements.
49
- /**
50
- * Optional initialiser expression for the enumeration value.
51
- *
52
- * @remarks
53
- * Contains the explicit value assignment expression when the
54
- * enumeration value is explicitly initialised in the source code.
55
- */
56
8
  initializer;
57
- /**
58
- * Brief description of the enumeration value.
59
- *
60
- * @remarks
61
- * Short documentation comment providing a concise explanation
62
- * of the enumeration value's purpose or meaning.
63
- */
64
9
  briefDescription;
65
- /**
66
- * Detailed description of the enumeration value.
67
- *
68
- * @remarks
69
- * Comprehensive documentation comment providing full details
70
- * about the enumeration value's purpose, usage, and behaviour.
71
- */
72
10
  detailedDescription;
73
- // Mandatory attributes.
74
- /**
75
- * Unique identifier for the enumeration value.
76
- *
77
- * @remarks
78
- * Doxygen-generated identifier used for cross-referencing
79
- * and creating links to this enumeration value.
80
- */
81
11
  id = '';
82
- /**
83
- * Protection level of the enumeration value.
84
- *
85
- * @remarks
86
- * Indicates the visibility scope such as 'public', 'private',
87
- * or 'protected' based on Doxygen's protection kind enumeration.
88
- */
89
- prot = ''; // DoxProtectionKind
90
- /**
91
- * Creates a new enumeration value data model.
92
- *
93
- * @remarks
94
- * Parses the XML element representing an enumeration value and
95
- * extracts all relevant information including name, initialiser,
96
- * descriptions, and attributes.
97
- *
98
- * @param xml - The XML parser instance
99
- * @param element - The XML element to parse
100
- * @param elementName - The name of the XML element
101
- */
12
+ prot = '';
102
13
  constructor(xml, element, elementName) {
103
14
  super(elementName);
104
- // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
105
- // ------------------------------------------------------------------------
106
- // Process elements.
107
15
  const innerElements = xml.getInnerElements(element, elementName);
108
16
  assert(innerElements.length > 0);
109
17
  for (const innerElement of innerElements) {
110
18
  if (xml.hasInnerText(innerElement)) {
111
- // Ignore texts.
112
19
  }
113
20
  else if (xml.isInnerElementText(innerElement, 'name')) {
114
21
  this.name = xml.getInnerElementText(innerElement, 'name');
@@ -128,8 +35,6 @@ export class AbstractEnumValueType extends AbstractDataModelBase {
128
35
  }
129
36
  }
130
37
  assert(this.name.length > 0);
131
- // ------------------------------------------------------------------------
132
- // Process attributes.
133
38
  assert(xml.hasAttributes(element));
134
39
  const attributesNames = xml.getAttributesNames(element);
135
40
  for (const attributeName of attributesNames) {
@@ -146,37 +51,11 @@ export class AbstractEnumValueType extends AbstractDataModelBase {
146
51
  }
147
52
  assert(this.id.length > 0);
148
53
  assert(this.prot.length > 0);
149
- // ------------------------------------------------------------------------
150
- // console.log(util.inspect(this, { compact: false, depth: 999 }))
151
54
  }
152
55
  }
153
- // ----------------------------------------------------------------------------
154
- // <xsd:element name="enumvalue" type="enumvalueType" minOccurs="0" maxOccurs="unbounded" />
155
- /**
156
- * Concrete implementation of enumeration value data model.
157
- *
158
- * @remarks
159
- * Represents a single enumeration value as parsed from Doxygen XML
160
- * output. Inherits all functionality from the abstract base class
161
- * and provides the specific element name for parsing.
162
- *
163
- * @public
164
- */
165
56
  export class EnumValueDataModel extends AbstractEnumValueType {
166
- /**
167
- * Creates a new enumeration value data model from XML.
168
- *
169
- * @remarks
170
- * Parses the XML element representing an enumeration value using
171
- * the inherited parsing logic with the 'enumvalue' element name.
172
- *
173
- * @param xml - The XML parser instance
174
- * @param element - The XML element to parse
175
- */
176
57
  constructor(xml, element) {
177
- // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
178
58
  super(xml, element, 'enumvalue');
179
59
  }
180
60
  }
181
- // ----------------------------------------------------------------------------
182
61
  //# sourceMappingURL=enumvaluetype-dm.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"enumvaluetype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/enumvaluetype-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;AACnD,OAAO,EACL,yBAAyB,EACzB,4BAA4B,GAC7B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D,+EAA+E;AAE/E,yCAAyC;AACzC,mBAAmB;AACnB,oDAAoD;AACpD,6EAA6E;AAC7E,mFAAmF;AACnF,sFAAsF;AACtF,oBAAoB;AACpB,kDAAkD;AAClD,2DAA2D;AAC3D,qBAAqB;AAErB;;;;;;;;;GASG;AACH,MAAM,OAAgB,qBAAsB,SAAQ,qBAAqB;IACvE,sBAAsB;IACtB;;;;;;OAMG;IACH,IAAI,GAAG,EAAE,CAAA;IAET,qBAAqB;IACrB;;;;;;OAMG;IACH,WAAW,CAAmC;IAE9C;;;;;;OAMG;IACH,gBAAgB,CAAwC;IAExD;;;;;;OAMG;IACH,mBAAmB,CAA2C;IAE9D,wBAAwB;IACxB;;;;;;OAMG;IACH,EAAE,GAAG,EAAE,CAAA;IAEP;;;;;;OAMG;IACH,IAAI,GAAG,EAAE,CAAA,CAAC,oBAAoB;IAE9B;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,aAAa,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAChE,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAEhC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnC,gBAAgB;YAClB,CAAC;iBAAM,IAAI,GAAG,CAAC,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC;gBACxD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;YAC3D,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,CAAC;gBAC5D,IAAI,CAAC,WAAW,GAAG,IAAI,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;YAChE,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,EAAE,CAAC;gBACjE,IAAI,CAAC,gBAAgB,GAAG,IAAI,yBAAyB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;YAC1E,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,qBAAqB,CAAC,EAAE,CAAC;gBACpE,IAAI,CAAC,mBAAmB,GAAG,IAAI,4BAA4B,CACzD,GAAG,EACH,YAAY,CACb,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,WAAW,EACzB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,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;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,MAAM,EAAE,CAAC;gBAC7B,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;YACxD,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,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,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC1B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,gGAAgG;AAEhG;;;;;;;;;GASG;AACH,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IAC3D;;;;;;;;;OASG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IAClC,CAAC;CACF;AAED,+EAA+E"}
1
+ {"version":3,"file":"enumvaluetype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/enumvaluetype-dm.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAGjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EACL,yBAAyB,EACzB,4BAA4B,GAC7B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAyB7D,MAAM,OAAgB,qBAAsB,SAAQ,qBAAqB;IASvE,IAAI,GAAG,EAAE,CAAA;IAUT,WAAW,CAAmC;IAS9C,gBAAgB,CAAwC;IASxD,mBAAmB,CAA2C;IAU9D,EAAE,GAAG,EAAE,CAAA;IASP,IAAI,GAAG,EAAE,CAAA;IAcT,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAOlB,MAAM,aAAa,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAChE,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAEhC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;YAErC,CAAC;iBAAM,IAAI,GAAG,CAAC,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC;gBACxD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;YAC3D,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,CAAC;gBAC5D,IAAI,CAAC,WAAW,GAAG,IAAI,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;YAChE,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,EAAE,CAAC;gBACjE,IAAI,CAAC,gBAAgB,GAAG,IAAI,yBAAyB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;YAC1E,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,qBAAqB,CAAC,EAAE,CAAC;gBACpE,IAAI,CAAC,mBAAmB,GAAG,IAAI,4BAA4B,CACzD,GAAG,EACH,YAAY,CACb,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,WAAW,EACzB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,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;QAK5B,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,MAAM,EAAE,CAAC;gBAC7B,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;YACxD,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,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,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC1B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAK9B,CAAC;CACF;AAgBD,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IAW3D,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IAClC,CAAC;CACF"}
@@ -1,131 +1,15 @@
1
1
  import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
2
2
  import { AbstractDataModelBase } from '../types.js';
3
- /**
4
- * Abstract base class for include-type elements within documentation.
5
- *
6
- * @remarks
7
- * Implements processing for include-type elements that represent file inclusion
8
- * relationships within source code documentation. This class handles the XML
9
- * Schema definition for incType elements, which contain textual content
10
- * representing file paths or names along with attributes that specify inclusion
11
- * behaviour and reference relationships.
12
- *
13
- * The implementation processes both local and system includes, distinguishing
14
- * between quoted includes ("filename") and angle-bracket includes (<filename>)
15
- * through the local attribute. Optional reference identifiers enable
16
- * cross-referencing to the included file's documentation.
17
- *
18
- * @public
19
- */
20
3
  export declare abstract class AbstractIncType extends AbstractDataModelBase {
21
- /**
22
- * The textual content representing the file path or name being included.
23
- *
24
- * @remarks
25
- * Contains the file path or filename as specified in the include directive.
26
- * This text content represents the actual filename that appears within
27
- * the include statement in the source code, providing the reference to
28
- * the included file within the documentation structure.
29
- */
30
4
  text: string;
31
- /**
32
- * Indicates whether the include uses local or system include syntax.
33
- *
34
- * @remarks
35
- * Determines the include syntax style: when true, indicates a local include
36
- * using quotation marks ("filename"), when false, indicates a system include
37
- * using angle brackets (<filename>). This distinction affects how the
38
- * preprocessor searches for the included file.
39
- */
40
5
  local: boolean;
41
- /**
42
- * Optional reference identifier for cross-linking to the included file.
43
- *
44
- * @remarks
45
- * Contains the reference identifier that links to the documentation of
46
- * the included file. This enables navigation from include statements to
47
- * the actual file documentation within the generated documentation system.
48
- */
49
6
  refId?: string | undefined;
50
- /**
51
- * Constructs an AbstractIncType instance from XML element data.
52
- *
53
- * @param xml - The Doxygen XML parser instance for processing XML content
54
- * @param element - The XML element object containing the include data
55
- * @param elementName - The name of the XML element being processed
56
- *
57
- * @remarks
58
- * This constructor processes include-type elements by extracting the
59
- * textual content representing the filename and processing attributes
60
- * that specify inclusion behaviour. The parser validates the presence
61
- * of required content and attributes whilst maintaining compliance with
62
- * the XML Schema definition for include elements.
63
- *
64
- * The implementation distinguishes between local and system includes
65
- * through the local attribute and optionally associates reference
66
- * identifiers for cross-linking to included file documentation.
67
- */
68
7
  constructor(xml: DoxygenXmlParser, element: object, elementName: string);
69
8
  }
70
- /**
71
- * Data model for includes elements within documentation content.
72
- *
73
- * @remarks
74
- * Represents includes elements that document files included by the current
75
- * source file. This implementation processes Doxygen's includes elements,
76
- * which contain information about files that are included through preprocessor
77
- * directives such as #include statements within the documented source code.
78
- *
79
- * The includes relationship indicates a dependency where the current file
80
- * incorporates content from the referenced file during compilation.
81
- *
82
- * @public
83
- */
84
9
  export declare class IncludesDataModel extends AbstractIncType {
85
- /**
86
- * Constructs an IncludesDataModel from XML element data.
87
- *
88
- * @param xml - The Doxygen XML parser instance for processing XML content
89
- * @param element - The XML element object containing the includes data
90
- *
91
- * @remarks
92
- * This constructor delegates to the parent AbstractIncType to handle
93
- * include processing whilst identifying the element as 'includes' for
94
- * proper XML schema compliance and include relationship documentation.
95
- * The processed data represents files that are included by the current
96
- * source file through preprocessor directives.
97
- */
98
10
  constructor(xml: DoxygenXmlParser, element: object);
99
11
  }
100
- /**
101
- * Data model for includedby elements within documentation content.
102
- *
103
- * @remarks
104
- * Represents includedby elements that document files which include the
105
- * current source file. This implementation processes Doxygen's includedby
106
- * elements, which contain information about files that incorporate the
107
- * current file through preprocessor directives, establishing reverse
108
- * inclusion relationships within the documentation system.
109
- *
110
- * The includedby relationship indicates a dependency where other files
111
- * incorporate content from the current file during compilation.
112
- *
113
- * @public
114
- */
115
12
  export declare class IncludedByDataModel extends AbstractIncType {
116
- /**
117
- * Constructs an IncludedByDataModel from XML element data.
118
- *
119
- * @param xml - The Doxygen XML parser instance for processing XML content
120
- * @param element - The XML element object containing the includedby data
121
- *
122
- * @remarks
123
- * This constructor delegates to the parent AbstractIncType to handle
124
- * include processing whilst identifying the element as 'includedby' for
125
- * proper XML schema compliance and reverse include relationship handling.
126
- * The processed data represents files that include the current source file
127
- * through preprocessor directives, establishing dependency relationships.
128
- */
129
13
  constructor(xml: DoxygenXmlParser, element: object);
130
14
  }
131
15
  //# sourceMappingURL=inctype-dm.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"inctype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/inctype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAanD;;;;;;;;;;;;;;;;GAgBG;AACH,8BAAsB,eAAgB,SAAQ,qBAAqB;IACjE;;;;;;;;OAQG;IAEH,IAAI,SAAK;IAET;;;;;;;;OAQG;IAEH,KAAK,UAAQ;IAEb;;;;;;;OAOG;IAEH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE1B;;;;;;;;;;;;;;;;;OAiBG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAuCxE;AAOD;;;;;;;;;;;;;GAaG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;IACpD;;;;;;;;;;;;OAYG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,mBAAoB,SAAQ,eAAe;IACtD;;;;;;;;;;;;OAYG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
1
+ {"version":3,"file":"inctype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/inctype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA8BnD,8BAAsB,eAAgB,SAAQ,qBAAqB;IAWjE,IAAI,SAAK;IAYT,KAAK,UAAQ;IAWb,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;gBAoBd,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAuCxE;AAqBD,qBAAa,iBAAkB,SAAQ,eAAe;gBAcxC,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAiBD,qBAAa,mBAAoB,SAAQ,eAAe;gBAc1C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}