@xpack/doxygen2docusaurus 2.0.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +2 -1
- package/bin/doxygen2docusaurus.js +1 -1
- package/dist/cli/main.d.ts +0 -14
- package/dist/cli/main.d.ts.map +1 -1
- package/dist/cli/main.js +0 -34
- package/dist/cli/main.js.map +1 -1
- package/dist/docusaurus/cli-options.d.ts +3 -292
- package/dist/docusaurus/cli-options.d.ts.map +1 -1
- package/dist/docusaurus/cli-options.js +6 -290
- package/dist/docusaurus/cli-options.js.map +1 -1
- package/dist/docusaurus/generator.d.ts +0 -172
- package/dist/docusaurus/generator.d.ts.map +1 -1
- package/dist/docusaurus/generator.js +20 -280
- package/dist/docusaurus/generator.js.map +1 -1
- package/dist/docusaurus/renderers/descriptiontype.d.ts +0 -417
- package/dist/docusaurus/renderers/descriptiontype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/descriptiontype.js +11 -555
- package/dist/docusaurus/renderers/descriptiontype.js.map +1 -1
- package/dist/docusaurus/renderers/docinternalstype.d.ts +0 -132
- package/dist/docusaurus/renderers/docinternalstype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/docinternalstype.js +0 -156
- package/dist/docusaurus/renderers/docinternalstype.js.map +1 -1
- package/dist/docusaurus/renderers/doclisttype.d.ts +0 -22
- package/dist/docusaurus/renderers/doclisttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/doclisttype.js +0 -42
- package/dist/docusaurus/renderers/doclisttype.js.map +1 -1
- package/dist/docusaurus/renderers/doctabletype.d.ts +0 -88
- package/dist/docusaurus/renderers/doctabletype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/doctabletype.js +1 -113
- package/dist/docusaurus/renderers/doctabletype.js.map +1 -1
- package/dist/docusaurus/renderers/doctitletype.d.ts +0 -22
- package/dist/docusaurus/renderers/doctitletype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/doctitletype.js +0 -42
- package/dist/docusaurus/renderers/doctitletype.js.map +1 -1
- package/dist/docusaurus/renderers/docvariablelisttype.d.ts +0 -44
- package/dist/docusaurus/renderers/docvariablelisttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/docvariablelisttype.js +1 -69
- package/dist/docusaurus/renderers/docvariablelisttype.js.map +1 -1
- package/dist/docusaurus/renderers/docxrefsecttype.d.ts +0 -22
- package/dist/docusaurus/renderers/docxrefsecttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/docxrefsecttype.js +0 -38
- package/dist/docusaurus/renderers/docxrefsecttype.js.map +1 -1
- package/dist/docusaurus/renderers/element-renderer-base.d.ts +0 -74
- package/dist/docusaurus/renderers/element-renderer-base.d.ts.map +1 -1
- package/dist/docusaurus/renderers/element-renderer-base.js +0 -64
- package/dist/docusaurus/renderers/element-renderer-base.js.map +1 -1
- package/dist/docusaurus/renderers/inctype.d.ts +0 -23
- package/dist/docusaurus/renderers/inctype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/inctype.js +0 -41
- package/dist/docusaurus/renderers/inctype.js.map +1 -1
- package/dist/docusaurus/renderers/linkedtexttype.d.ts +0 -22
- package/dist/docusaurus/renderers/linkedtexttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/linkedtexttype.js +0 -45
- package/dist/docusaurus/renderers/linkedtexttype.js.map +1 -1
- package/dist/docusaurus/renderers/listingtype.d.ts +0 -52
- package/dist/docusaurus/renderers/listingtype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/listingtype.js +1 -88
- package/dist/docusaurus/renderers/listingtype.js.map +1 -1
- package/dist/docusaurus/renderers/paramtype.d.ts +0 -22
- package/dist/docusaurus/renderers/paramtype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/paramtype.js +2 -51
- package/dist/docusaurus/renderers/paramtype.js.map +1 -1
- package/dist/docusaurus/renderers/referencetype.d.ts +0 -23
- package/dist/docusaurus/renderers/referencetype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/referencetype.js +0 -38
- package/dist/docusaurus/renderers/referencetype.js.map +1 -1
- package/dist/docusaurus/renderers/reftexttype.d.ts +0 -22
- package/dist/docusaurus/renderers/reftexttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/reftexttype.js +0 -38
- package/dist/docusaurus/renderers/reftexttype.js.map +1 -1
- package/dist/docusaurus/renderers/reftype.d.ts +0 -22
- package/dist/docusaurus/renderers/reftype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/reftype.js +0 -38
- package/dist/docusaurus/renderers/reftype.js.map +1 -1
- package/dist/docusaurus/renderers/renderers.d.ts +0 -151
- package/dist/docusaurus/renderers/renderers.d.ts.map +1 -1
- package/dist/docusaurus/renderers/renderers.js +4 -184
- package/dist/docusaurus/renderers/renderers.js.map +1 -1
- package/dist/docusaurus/renderers/substringtype.d.ts +0 -22
- package/dist/docusaurus/renderers/substringtype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/substringtype.js +0 -39
- package/dist/docusaurus/renderers/substringtype.js.map +1 -1
- package/dist/docusaurus/renderers/tableofcontentstype.d.ts +0 -22
- package/dist/docusaurus/renderers/tableofcontentstype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/tableofcontentstype.js +0 -39
- package/dist/docusaurus/renderers/tableofcontentstype.js.map +1 -1
- package/dist/docusaurus/types.d.ts +0 -110
- package/dist/docusaurus/types.d.ts.map +1 -1
- package/dist/docusaurus/types.js +0 -11
- package/dist/docusaurus/types.js.map +1 -1
- package/dist/docusaurus/utils.d.ts +0 -214
- package/dist/docusaurus/utils.d.ts.map +1 -1
- package/dist/docusaurus/utils.js +0 -296
- package/dist/docusaurus/utils.js.map +1 -1
- package/dist/docusaurus/view-model/classes-vm.d.ts +0 -137
- package/dist/docusaurus/view-model/classes-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/classes-vm.js +9 -225
- package/dist/docusaurus/view-model/classes-vm.js.map +1 -1
- package/dist/docusaurus/view-model/collection-base.d.ts +0 -120
- package/dist/docusaurus/view-model/collection-base.d.ts.map +1 -1
- package/dist/docusaurus/view-model/collection-base.js +11 -101
- package/dist/docusaurus/view-model/collection-base.js.map +1 -1
- package/dist/docusaurus/view-model/compound-base-vm.d.ts +2 -147
- package/dist/docusaurus/view-model/compound-base-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/compound-base-vm.js +47 -225
- package/dist/docusaurus/view-model/compound-base-vm.js.map +1 -1
- package/dist/docusaurus/view-model/concepts-vm.d.ts +26 -0
- package/dist/docusaurus/view-model/concepts-vm.d.ts.map +1 -0
- package/dist/docusaurus/view-model/concepts-vm.js +329 -0
- package/dist/docusaurus/view-model/concepts-vm.js.map +1 -0
- package/dist/docusaurus/view-model/description-anchors.d.ts +0 -58
- package/dist/docusaurus/view-model/description-anchors.d.ts.map +1 -1
- package/dist/docusaurus/view-model/description-anchors.js +0 -71
- package/dist/docusaurus/view-model/description-anchors.js.map +1 -1
- package/dist/docusaurus/view-model/files-and-folders-vm.d.ts +0 -247
- package/dist/docusaurus/view-model/files-and-folders-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/files-and-folders-vm.js +61 -353
- package/dist/docusaurus/view-model/files-and-folders-vm.js.map +1 -1
- package/dist/docusaurus/view-model/groups-vm.d.ts +0 -148
- package/dist/docusaurus/view-model/groups-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/groups-vm.js +2 -223
- package/dist/docusaurus/view-model/groups-vm.js.map +1 -1
- package/dist/docusaurus/view-model/members-vm.d.ts +0 -552
- package/dist/docusaurus/view-model/members-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/members-vm.js +17 -702
- package/dist/docusaurus/view-model/members-vm.js.map +1 -1
- package/dist/docusaurus/view-model/namespaces-vm.d.ts +4 -199
- package/dist/docusaurus/view-model/namespaces-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/namespaces-vm.js +79 -284
- package/dist/docusaurus/view-model/namespaces-vm.js.map +1 -1
- package/dist/docusaurus/view-model/options.d.ts +0 -43
- package/dist/docusaurus/view-model/options.d.ts.map +1 -1
- package/dist/docusaurus/view-model/options.js +0 -57
- package/dist/docusaurus/view-model/options.js.map +1 -1
- package/dist/docusaurus/view-model/pages-vm.d.ts +0 -115
- package/dist/docusaurus/view-model/pages-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/pages-vm.js +0 -162
- package/dist/docusaurus/view-model/pages-vm.js.map +1 -1
- package/dist/docusaurus/view-model/tree-entries-vm.d.ts +8 -142
- package/dist/docusaurus/view-model/tree-entries-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/tree-entries-vm.js +54 -174
- package/dist/docusaurus/view-model/tree-entries-vm.js.map +1 -1
- package/dist/docusaurus/view-model/view-model.d.ts +0 -125
- package/dist/docusaurus/view-model/view-model.d.ts.map +1 -1
- package/dist/docusaurus/view-model/view-model.js +20 -182
- package/dist/docusaurus/view-model/view-model.js.map +1 -1
- package/dist/docusaurus/workspace.d.ts +1 -126
- package/dist/docusaurus/workspace.d.ts.map +1 -1
- package/dist/docusaurus/workspace.js +8 -221
- package/dist/docusaurus/workspace.js.map +1 -1
- package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts +5 -492
- package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/compounddef-dm.js +23 -672
- package/dist/doxygen/data-model/compounds/compounddef-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts +0 -129
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.js +1 -145
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts +104 -2848
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.js +73 -3975
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts +0 -165
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js +0 -229
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts +0 -70
- package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/doxygentype-dm.js +0 -105
- package/dist/doxygen/data-model/compounds/doxygentype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts +0 -84
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js +1 -122
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/inctype-dm.d.ts +0 -116
- package/dist/doxygen/data-model/compounds/inctype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/inctype-dm.js +3 -155
- package/dist/doxygen/data-model/compounds/inctype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts +3 -138
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js +5 -180
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts +0 -76
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js +0 -107
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts +0 -162
- package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/locationtype-dm.js +4 -203
- package/dist/doxygen/data-model/compounds/locationtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts +2 -443
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.js +19 -475
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts +0 -141
- package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/memberreftype-dm.js +0 -176
- package/dist/doxygen/data-model/compounds/memberreftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/membertype-dm.d.ts +0 -101
- package/dist/doxygen/data-model/compounds/membertype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/membertype-dm.js +0 -115
- package/dist/doxygen/data-model/compounds/membertype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts +0 -164
- package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/paramtype-dm.js +0 -208
- package/dist/doxygen/data-model/compounds/paramtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts +0 -139
- package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/referencetype-dm.js +2 -175
- package/dist/doxygen/data-model/compounds/referencetype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts +0 -120
- package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/reftexttype-dm.js +2 -141
- package/dist/doxygen/data-model/compounds/reftexttype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/reftype-dm.d.ts +0 -268
- package/dist/doxygen/data-model/compounds/reftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/reftype-dm.js +4 -326
- package/dist/doxygen/data-model/compounds/reftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts +0 -105
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.js +1 -139
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts +0 -168
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js +0 -209
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts +0 -267
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js +0 -354
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts +0 -66
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js +0 -97
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js.map +1 -1
- package/dist/doxygen/data-model/data-model.d.ts +0 -149
- package/dist/doxygen/data-model/data-model.d.ts.map +1 -1
- package/dist/doxygen/data-model/data-model.js +4 -197
- package/dist/doxygen/data-model/data-model.js.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts +0 -115
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js +4 -129
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts +0 -87
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js +0 -118
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js.map +1 -1
- package/dist/doxygen/data-model/doxygen-xml-parser.d.ts +0 -253
- package/dist/doxygen/data-model/doxygen-xml-parser.d.ts.map +1 -1
- package/dist/doxygen/data-model/doxygen-xml-parser.js +0 -291
- package/dist/doxygen/data-model/doxygen-xml-parser.js.map +1 -1
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts +0 -98
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.js +2 -122
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts +0 -82
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.js +0 -114
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.js.map +1 -1
- package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts +0 -85
- package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/index/indexmembertype-dm.js +1 -107
- package/dist/doxygen/data-model/index/indexmembertype-dm.js.map +1 -1
- package/dist/doxygen/data-model/types.d.ts +0 -104
- package/dist/doxygen/data-model/types.d.ts.map +1 -1
- package/dist/doxygen/data-model/types.js +0 -52
- package/dist/doxygen/data-model/types.js.map +1 -1
- package/dist/index.d.ts +4 -16
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -42
- package/dist/index.js.map +1 -1
- package/package.json +45 -51
- package/src/cli/main.ts +122 -0
- package/src/docusaurus/cli-options.ts +560 -0
- package/src/docusaurus/generator.ts +788 -0
- package/src/docusaurus/renderers/descriptiontype.ts +1299 -0
- package/src/docusaurus/renderers/docinternalstype.ts +354 -0
- package/src/docusaurus/renderers/doclisttype.ts +134 -0
- package/src/docusaurus/renderers/doctabletype.ts +220 -0
- package/src/docusaurus/renderers/doctitletype.ts +77 -0
- package/src/docusaurus/renderers/docvariablelisttype.ts +123 -0
- package/src/docusaurus/renderers/docxrefsecttype.ts +84 -0
- package/src/docusaurus/renderers/element-renderer-base.ts +112 -0
- package/src/docusaurus/renderers/inctype.ts +75 -0
- package/src/docusaurus/renderers/linkedtexttype.ts +64 -0
- package/src/docusaurus/renderers/listingtype.ts +235 -0
- package/src/docusaurus/renderers/paramtype.ts +116 -0
- package/src/docusaurus/renderers/referencetype.ts +83 -0
- package/src/docusaurus/renderers/reftexttype.ts +81 -0
- package/src/docusaurus/renderers/reftype.ts +77 -0
- package/src/docusaurus/renderers/renderers.ts +756 -0
- package/src/docusaurus/renderers/substringtype.ts +53 -0
- package/src/docusaurus/renderers/tableofcontentstype.ts +74 -0
- package/src/docusaurus/types.ts +187 -0
- package/src/docusaurus/utils.ts +409 -0
- package/src/docusaurus/view-model/README.md +12 -0
- package/src/docusaurus/view-model/classes-vm.ts +1088 -0
- package/src/docusaurus/view-model/collection-base.ts +352 -0
- package/src/docusaurus/view-model/compound-base-vm.ts +1340 -0
- package/src/docusaurus/view-model/concepts-vm.ts +719 -0
- package/src/docusaurus/view-model/description-anchors.ts +107 -0
- package/src/docusaurus/view-model/files-and-folders-vm.ts +1293 -0
- package/src/docusaurus/view-model/groups-vm.ts +548 -0
- package/src/docusaurus/view-model/members-vm.ts +1943 -0
- package/src/docusaurus/view-model/namespaces-vm.ts +1018 -0
- package/src/docusaurus/view-model/options.ts +95 -0
- package/src/docusaurus/view-model/pages-vm.ts +342 -0
- package/src/docusaurus/view-model/tree-entries-vm.ts +376 -0
- package/src/docusaurus/view-model/view-model.ts +513 -0
- package/src/docusaurus/workspace.ts +588 -0
- package/src/doxygen/data-model/README.md +13 -0
- package/src/doxygen/data-model/compounds/compounddef-dm.ts +1156 -0
- package/src/doxygen/data-model/compounds/compoundreftype-dm.ts +266 -0
- package/src/doxygen/data-model/compounds/descriptiontype-dm.ts +10107 -0
- package/src/doxygen/data-model/compounds/docvarlistentrytype-dm.ts +354 -0
- package/src/doxygen/data-model/compounds/doxygentype-dm.ts +187 -0
- package/src/doxygen/data-model/compounds/enumvaluetype-dm.ts +218 -0
- package/src/doxygen/data-model/compounds/inctype-dm.ts +217 -0
- package/src/doxygen/data-model/compounds/linkedtexttype-dm.ts +288 -0
- package/src/doxygen/data-model/compounds/listofallmemberstype-dm.ts +160 -0
- package/src/doxygen/data-model/compounds/locationtype-dm.ts +284 -0
- package/src/doxygen/data-model/compounds/memberdeftype-dm.ts +874 -0
- package/src/doxygen/data-model/compounds/memberreftype-dm.ts +270 -0
- package/src/doxygen/data-model/compounds/membertype-dm.ts +239 -0
- package/src/doxygen/data-model/compounds/paramtype-dm.ts +302 -0
- package/src/doxygen/data-model/compounds/referencetype-dm.ts +248 -0
- package/src/doxygen/data-model/compounds/reftexttype-dm.ts +234 -0
- package/src/doxygen/data-model/compounds/reftype-dm.ts +430 -0
- package/src/doxygen/data-model/compounds/reimplementtype-dm.ts +201 -0
- package/src/doxygen/data-model/compounds/sectiondeftype-dm.ts +330 -0
- package/src/doxygen/data-model/compounds/tableofcontentstype-dm.ts +563 -0
- package/src/doxygen/data-model/compounds/templateparamlisttype-dm.ts +150 -0
- package/src/doxygen/data-model/data-model.ts +377 -0
- package/src/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.ts +271 -0
- package/src/doxygen/data-model/doxyfile/doxyfiletype-dm.ts +200 -0
- package/src/doxygen/data-model/doxygen-xml-parser.ts +522 -0
- package/src/doxygen/data-model/index/indexcompoundtype-dm.ts +256 -0
- package/src/doxygen/data-model/index/indexdoxygentype-dm.ts +196 -0
- package/src/doxygen/data-model/index/indexmembertype-dm.ts +230 -0
- package/src/doxygen/data-model/types.ts +175 -0
- package/src/doxygen/data-model/xsds/README.md +6 -0
- package/src/doxygen/data-model/xsds/compound.xsd +1699 -0
- package/src/doxygen/data-model/xsds/doxyfile.xsd +355 -0
- package/src/doxygen/data-model/xsds/index.xsd +72 -0
- package/src/doxygen/data-model/xsds/xml.xsd +23 -0
- package/src/index.ts +261 -0
- package/src/tsconfig.json +10 -0
- package/dist/doxygen2docusaurus.d.ts +0 -4774
- package/dist/tsconfig.tsbuildinfo +0 -1
- package/dist/tsdoc-metadata.json +0 -11
|
@@ -1,76 +1,10 @@
|
|
|
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 { XMLParser } from 'fast-xml-parser';
|
|
15
|
-
// ----------------------------------------------------------------------------
|
|
16
|
-
/**
|
|
17
|
-
* XML parser for Doxygen-generated documentation files.
|
|
18
|
-
*
|
|
19
|
-
* @remarks
|
|
20
|
-
* This class initialises the XML parser with options that preserve the order
|
|
21
|
-
* and structure of the original XML content, ensuring accurate conversion
|
|
22
|
-
* for documentation purposes. It maintains a counter for the number of files
|
|
23
|
-
* parsed and stores the resulting data model.
|
|
24
|
-
*
|
|
25
|
-
* The parser is configured to handle Doxygen's specific XML format whilst
|
|
26
|
-
* maintaining fidelity to the source structure and content organisation.
|
|
27
|
-
*
|
|
28
|
-
* @example
|
|
29
|
-
* ```typescript
|
|
30
|
-
* const parser = new DoxygenXmlParser({ options });
|
|
31
|
-
* const dataModel = await parser.parse();
|
|
32
|
-
* ```
|
|
33
|
-
*
|
|
34
|
-
* @public
|
|
35
|
-
*/
|
|
36
4
|
export class DoxygenXmlParser {
|
|
37
|
-
/**
|
|
38
|
-
* The global configuration options for the parsing operation.
|
|
39
|
-
*
|
|
40
|
-
* @remarks
|
|
41
|
-
* Contains the command-line interface options that control the behaviour
|
|
42
|
-
* of the parser throughout the XML processing workflow.
|
|
43
|
-
*/
|
|
44
5
|
options;
|
|
45
|
-
/**
|
|
46
|
-
* The XML parser instance configured specifically for Doxygen XML format.
|
|
47
|
-
*
|
|
48
|
-
* @remarks
|
|
49
|
-
* Configured with settings that preserve element order, remove namespace
|
|
50
|
-
* prefixes, and maintain fidelity to the original XML structure for
|
|
51
|
-
* accurate data model construction.
|
|
52
|
-
*/
|
|
53
6
|
xmlParser;
|
|
54
|
-
/**
|
|
55
|
-
* Collection of image references extracted during XML parsing.
|
|
56
|
-
*
|
|
57
|
-
* @remarks
|
|
58
|
-
* Accumulates image elements found in the documentation content,
|
|
59
|
-
* allowing for centralised image processing and reference management.
|
|
60
|
-
*/
|
|
61
7
|
images = [];
|
|
62
|
-
/**
|
|
63
|
-
* Constructs a new instance of the DoxygenXmlParser class.
|
|
64
|
-
*
|
|
65
|
-
* @param options - The global configuration options
|
|
66
|
-
*
|
|
67
|
-
* @remarks
|
|
68
|
-
* This constructor initialises the XML parser with settings that preserve the
|
|
69
|
-
* order and structure of the original XML content, remove namespace prefixes,
|
|
70
|
-
* and ensure that both tag and attribute values are parsed. The values are
|
|
71
|
-
* not trimmed, maintaining fidelity to the source XML. The provided options
|
|
72
|
-
* are stored for use throughout the parsing process.
|
|
73
|
-
*/
|
|
74
8
|
constructor(options) {
|
|
75
9
|
this.options = options;
|
|
76
10
|
this.xmlParser = new XMLParser({
|
|
@@ -82,58 +16,14 @@ export class DoxygenXmlParser {
|
|
|
82
16
|
trimValues: false,
|
|
83
17
|
});
|
|
84
18
|
}
|
|
85
|
-
// --------------------------------------------------------------------------
|
|
86
|
-
/**
|
|
87
|
-
* Determines whether the specified XML element has any attributes.
|
|
88
|
-
*
|
|
89
|
-
* @param element - The XML element to inspect for attributes
|
|
90
|
-
* @returns True if the element has attributes; otherwise, false
|
|
91
|
-
*
|
|
92
|
-
* @remarks
|
|
93
|
-
* This method checks for the presence of the ':\@' property on the XML
|
|
94
|
-
* element, which is the convention used by the XML parser for storing
|
|
95
|
-
* attributes. If this property exists, the element has attributes; if not,
|
|
96
|
-
* the element has no attributes. This is a prerequisite check before calling
|
|
97
|
-
* {@link DoxygenXmlParser.getAttributesNames} or other attribute-related
|
|
98
|
-
* methods.
|
|
99
|
-
*/
|
|
100
19
|
hasAttributes(element) {
|
|
101
20
|
return Object.hasOwn(element, ':@');
|
|
102
21
|
}
|
|
103
|
-
/**
|
|
104
|
-
* Retrieves the names of all attributes present on the specified XML element.
|
|
105
|
-
*
|
|
106
|
-
* @param element - The XML element to inspect for attribute names
|
|
107
|
-
* @returns An array of strings containing the names of all attributes
|
|
108
|
-
*
|
|
109
|
-
* @remarks
|
|
110
|
-
* This method accesses the ':\@' property of the XML element, which is the
|
|
111
|
-
* convention used by the XML parser for storing attributes, and returns the
|
|
112
|
-
* keys of this object as an array of attribute names. The method assumes the
|
|
113
|
-
* element has attributes and does not perform validation - use
|
|
114
|
-
* {@link DoxygenXmlParser.hasAttributes} to check for attribute presence
|
|
115
|
-
* first.
|
|
116
|
-
*/
|
|
117
22
|
getAttributesNames(element) {
|
|
118
|
-
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
|
119
23
|
return Object.keys(element[':@']);
|
|
120
24
|
}
|
|
121
|
-
/**
|
|
122
|
-
* Determines whether the specified attribute exists on the given XML element.
|
|
123
|
-
*
|
|
124
|
-
* @param element - The XML element to inspect
|
|
125
|
-
* @param name - The name of the attribute to check for
|
|
126
|
-
* @returns True if the attribute exists; otherwise, false
|
|
127
|
-
*
|
|
128
|
-
* @remarks
|
|
129
|
-
* This method checks for the presence of an attribute within the ':\@'
|
|
130
|
-
* property of the XML element, which is the convention used by the XML
|
|
131
|
-
* parser for storing attributes. It returns true if the attribute is found,
|
|
132
|
-
* otherwise false.
|
|
133
|
-
*/
|
|
134
25
|
hasAttribute(element, name) {
|
|
135
26
|
if (Object.hasOwn(element, ':@')) {
|
|
136
|
-
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
|
137
27
|
const elementWithAttributes = element;
|
|
138
28
|
return Object.hasOwn(elementWithAttributes[':@'], name);
|
|
139
29
|
}
|
|
@@ -141,22 +31,6 @@ export class DoxygenXmlParser {
|
|
|
141
31
|
return false;
|
|
142
32
|
}
|
|
143
33
|
}
|
|
144
|
-
/**
|
|
145
|
-
* Retrieves the value of a named attribute as a string.
|
|
146
|
-
*
|
|
147
|
-
* @param element - The XML element containing the attribute
|
|
148
|
-
* @param name - The name of the attribute to retrieve
|
|
149
|
-
* @returns The attribute value as a string
|
|
150
|
-
* @throws If the attribute does not exist
|
|
151
|
-
*
|
|
152
|
-
* @remarks
|
|
153
|
-
* This method checks whether the specified attribute exists on the XML
|
|
154
|
-
* element and returns its value as a string. If the attribute value is
|
|
155
|
-
* originally a number (as the XML parser may return numeric strings as
|
|
156
|
-
* numbers), it is converted to a string to maintain consistency with the
|
|
157
|
-
* DTD specification. If the attribute is missing, an error is thrown to
|
|
158
|
-
* indicate the absence.
|
|
159
|
-
*/
|
|
160
34
|
getAttributeStringValue(element, name) {
|
|
161
35
|
if (this.hasAttribute(element, name)) {
|
|
162
36
|
const elementWithNamedAttribute = element[':@'];
|
|
@@ -165,28 +39,11 @@ export class DoxygenXmlParser {
|
|
|
165
39
|
return attributeValue;
|
|
166
40
|
}
|
|
167
41
|
else if (typeof attributeValue === 'number') {
|
|
168
|
-
// The xml parser returns attributes like `refid="21"` as numbers,
|
|
169
|
-
// but the DTD defines them as strings and the applications expects
|
|
170
|
-
// strings.
|
|
171
42
|
return String(attributeValue);
|
|
172
43
|
}
|
|
173
44
|
}
|
|
174
45
|
throw new Error(`Element ${util.inspect(element)} does not have the ${name} attribute`);
|
|
175
46
|
}
|
|
176
|
-
/**
|
|
177
|
-
* Retrieves the value of a named attribute as a number.
|
|
178
|
-
*
|
|
179
|
-
* @param element - The XML element containing the attribute
|
|
180
|
-
* @param name - The name of the attribute to retrieve
|
|
181
|
-
* @returns The attribute value as a number
|
|
182
|
-
* @throws If the attribute does not exist or is not a number
|
|
183
|
-
*
|
|
184
|
-
* @remarks
|
|
185
|
-
* This method checks whether the specified attribute exists on the XML
|
|
186
|
-
* element and returns its value as a number. If the attribute is missing
|
|
187
|
-
* or its value is not a number, an error is thrown to indicate the absence
|
|
188
|
-
* or incorrect type.
|
|
189
|
-
*/
|
|
190
47
|
getAttributeNumberValue(element, name) {
|
|
191
48
|
if (this.hasAttribute(element, name)) {
|
|
192
49
|
const elementWithNamedAttribute = element[':@'];
|
|
@@ -198,21 +55,6 @@ export class DoxygenXmlParser {
|
|
|
198
55
|
throw new Error(`Element ${util.inspect(element)} does not have the ${name} number ` +
|
|
199
56
|
'attribute');
|
|
200
57
|
}
|
|
201
|
-
/**
|
|
202
|
-
* Retrieves the value of a named attribute as a boolean.
|
|
203
|
-
*
|
|
204
|
-
* @param element - The XML element containing the attribute
|
|
205
|
-
* @param name - The name of the attribute to retrieve
|
|
206
|
-
* @returns True if the attribute value is 'yes' (case-insensitive);
|
|
207
|
-
* otherwise, false
|
|
208
|
-
* @throws If the attribute does not exist or is not a string
|
|
209
|
-
*
|
|
210
|
-
* @remarks
|
|
211
|
-
* This method checks whether the specified attribute exists on the XML
|
|
212
|
-
* element, and returns true if its value is the string 'yes'
|
|
213
|
-
* (case-insensitive). If the attribute is missing or its value is not a
|
|
214
|
-
* string, an error is thrown.
|
|
215
|
-
*/
|
|
216
58
|
getAttributeBooleanValue(element, name) {
|
|
217
59
|
if (this.hasAttribute(element, name)) {
|
|
218
60
|
const elementWithNamedAttribute = element[':@'];
|
|
@@ -224,20 +66,6 @@ export class DoxygenXmlParser {
|
|
|
224
66
|
throw new Error(`Element ${util.inspect(element)} does not have the ${name} ` +
|
|
225
67
|
'boolean attribute');
|
|
226
68
|
}
|
|
227
|
-
/**
|
|
228
|
-
* Determines whether the specified inner element exists on the given XML
|
|
229
|
-
* element.
|
|
230
|
-
*
|
|
231
|
-
* @param element - The XML element to inspect
|
|
232
|
-
* @param name - The name of the inner element to check for
|
|
233
|
-
* @returns True if the inner element exists; otherwise, false
|
|
234
|
-
*
|
|
235
|
-
* @remarks
|
|
236
|
-
* This method checks for the presence of a named property on the XML element.
|
|
237
|
-
* For text nodes ('#text'), it verifies the value is a string, number, or
|
|
238
|
-
* boolean. For other elements, it confirms the property is an array, as
|
|
239
|
-
* per the XML parser's convention.
|
|
240
|
-
*/
|
|
241
69
|
hasInnerElement(element, name) {
|
|
242
70
|
if (Object.hasOwn(element, name)) {
|
|
243
71
|
if (name === '#text') {
|
|
@@ -247,7 +75,6 @@ export class DoxygenXmlParser {
|
|
|
247
75
|
typeof value === 'boolean');
|
|
248
76
|
}
|
|
249
77
|
else {
|
|
250
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
251
78
|
return Array.isArray(element[name]);
|
|
252
79
|
}
|
|
253
80
|
}
|
|
@@ -255,27 +82,10 @@ export class DoxygenXmlParser {
|
|
|
255
82
|
return false;
|
|
256
83
|
}
|
|
257
84
|
}
|
|
258
|
-
/**
|
|
259
|
-
* Determines whether a named inner element contains text.
|
|
260
|
-
*
|
|
261
|
-
* @param element - The XML element to inspect
|
|
262
|
-
* @param name - The name of the inner element
|
|
263
|
-
* @returns True if the inner element contains text or is empty;
|
|
264
|
-
* otherwise, false
|
|
265
|
-
*
|
|
266
|
-
* @remarks
|
|
267
|
-
* This method checks if the specified inner element exists and contains a
|
|
268
|
-
* single text node, or is an empty array (representing an empty string).
|
|
269
|
-
* It asserts the expected structure and type of the value for robustness.
|
|
270
|
-
*/
|
|
271
85
|
isInnerElementText(element, name) {
|
|
272
86
|
if (Object.hasOwn(element, name)) {
|
|
273
87
|
const innerElements = element[name];
|
|
274
|
-
// console.log('isInnerElementText', util.inspect(element,
|
|
275
|
-
// { compact: false, depth: 999 })
|
|
276
|
-
// assert(innerElements !== undefined)
|
|
277
88
|
if (innerElements.length === 1) {
|
|
278
|
-
// assert(innerElements[0] !== undefined)
|
|
279
89
|
if (Object.hasOwn(innerElements[0], '#text')) {
|
|
280
90
|
const value = innerElements[0]['#text'];
|
|
281
91
|
assert(typeof value === 'string' ||
|
|
@@ -285,22 +95,11 @@ export class DoxygenXmlParser {
|
|
|
285
95
|
}
|
|
286
96
|
}
|
|
287
97
|
else if (innerElements.length === 0) {
|
|
288
|
-
// Empty string.
|
|
289
98
|
return true;
|
|
290
99
|
}
|
|
291
100
|
}
|
|
292
101
|
return false;
|
|
293
102
|
}
|
|
294
|
-
/**
|
|
295
|
-
* Determines whether the XML element contains a text node.
|
|
296
|
-
*
|
|
297
|
-
* @param element - The XML element to inspect
|
|
298
|
-
* @returns True if the element contains a text node; otherwise, false
|
|
299
|
-
*
|
|
300
|
-
* @remarks
|
|
301
|
-
* This method checks for the presence of a '#text' property on the XML
|
|
302
|
-
* element, and verifies that its value is a string, number, or boolean.
|
|
303
|
-
*/
|
|
304
103
|
hasInnerText(element) {
|
|
305
104
|
if (Object.hasOwn(element, '#text')) {
|
|
306
105
|
const value = element['#text'];
|
|
@@ -312,25 +111,7 @@ export class DoxygenXmlParser {
|
|
|
312
111
|
return false;
|
|
313
112
|
}
|
|
314
113
|
}
|
|
315
|
-
/**
|
|
316
|
-
* Retrieves an array of named child elements from the given XML element.
|
|
317
|
-
*
|
|
318
|
-
* @typeParam T - The expected type of the child elements array
|
|
319
|
-
* (defaults to XmlElement[])
|
|
320
|
-
* @param element - The XML element containing the child elements
|
|
321
|
-
* @param name - The name of the child elements to retrieve
|
|
322
|
-
* @returns The array of child elements
|
|
323
|
-
* @throws If the child elements do not exist
|
|
324
|
-
*
|
|
325
|
-
* @remarks
|
|
326
|
-
* This method accesses the specified property on the XML element and
|
|
327
|
-
* returns it as an array of child elements. If the property is undefined,
|
|
328
|
-
* an error is thrown indicating the absence of the expected child element.
|
|
329
|
-
*/
|
|
330
|
-
// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
|
|
331
114
|
getInnerElements(element, name) {
|
|
332
|
-
// assert(Object.hasOwn(element, name) === true &&
|
|
333
|
-
// Array.isArray((element as { [name]: T })[name]))
|
|
334
115
|
const innerElements = element[name];
|
|
335
116
|
if (innerElements !== undefined) {
|
|
336
117
|
return innerElements;
|
|
@@ -338,27 +119,8 @@ export class DoxygenXmlParser {
|
|
|
338
119
|
throw new Error(`Element ${util.inspect(element, { compact: false, depth: 999 })} ` +
|
|
339
120
|
`does not have the ${name} child element`);
|
|
340
121
|
}
|
|
341
|
-
/**
|
|
342
|
-
* Retrieves the text content of a named child element.
|
|
343
|
-
*
|
|
344
|
-
* @param element - The XML element containing the child element
|
|
345
|
-
* @param name - The name of the child element
|
|
346
|
-
* @returns The text content of the child element
|
|
347
|
-
* @throws If the child element does not exist or contains more than one
|
|
348
|
-
* element
|
|
349
|
-
*
|
|
350
|
-
* @remarks
|
|
351
|
-
* This method accesses the specified child element and returns its text
|
|
352
|
-
* content. If the child element is missing, an error is thrown. If the
|
|
353
|
-
* child element is empty, an empty string is returned. If there is more
|
|
354
|
-
* than one child element, an error is thrown to indicate unexpected
|
|
355
|
-
* structure.
|
|
356
|
-
*/
|
|
357
122
|
getInnerElementText(element, name) {
|
|
358
123
|
const innerElements = element[name];
|
|
359
|
-
// if (innerElements === undefined) {
|
|
360
|
-
// throw new Error('No inner elements')
|
|
361
|
-
// }
|
|
362
124
|
if (innerElements.length === 1) {
|
|
363
125
|
const value = innerElements[0]['#text'];
|
|
364
126
|
return value.toString();
|
|
@@ -370,26 +132,8 @@ export class DoxygenXmlParser {
|
|
|
370
132
|
throw new Error('Too many elements');
|
|
371
133
|
}
|
|
372
134
|
}
|
|
373
|
-
/**
|
|
374
|
-
* Retrieves the numeric value of a named child element.
|
|
375
|
-
*
|
|
376
|
-
* @param element - The XML element containing the child element
|
|
377
|
-
* @param name - The name of the child element
|
|
378
|
-
* @returns The numeric value of the child element
|
|
379
|
-
* @throws If the child element does not exist or contains more than one
|
|
380
|
-
* element
|
|
381
|
-
*
|
|
382
|
-
* @remarks
|
|
383
|
-
* This method accesses the specified child element and returns its value
|
|
384
|
-
* as a number. If the child element is missing, an error is thrown. If the
|
|
385
|
-
* child element is empty, NaN is returned. If there is more than one child
|
|
386
|
-
* element, an error is thrown to indicate unexpected structure.
|
|
387
|
-
*/
|
|
388
135
|
getInnerElementNumber(element, name) {
|
|
389
136
|
const innerElements = element[name];
|
|
390
|
-
// if (innerElements === undefined) {
|
|
391
|
-
// throw new Error('No inner elements')
|
|
392
|
-
// }
|
|
393
137
|
if (innerElements.length === 1) {
|
|
394
138
|
const value = innerElements[0]['#text'];
|
|
395
139
|
return parseInt(value.toString());
|
|
@@ -401,27 +145,8 @@ export class DoxygenXmlParser {
|
|
|
401
145
|
throw new Error('Too many elements');
|
|
402
146
|
}
|
|
403
147
|
}
|
|
404
|
-
/**
|
|
405
|
-
* Retrieves the boolean value of a named child element.
|
|
406
|
-
*
|
|
407
|
-
* @param element - The XML element containing the child element
|
|
408
|
-
* @param name - The name of the child element
|
|
409
|
-
* @returns True if the child element's text is 'true'
|
|
410
|
-
* (case-insensitive); otherwise, false
|
|
411
|
-
* @throws If the child element does not exist or contains more than one
|
|
412
|
-
* element
|
|
413
|
-
*
|
|
414
|
-
* @remarks
|
|
415
|
-
* This method accesses the specified child element and returns its value
|
|
416
|
-
* as a boolean. If the child element is missing, an error is thrown. If
|
|
417
|
-
* the child element is empty, false is returned. If there is more than one
|
|
418
|
-
* child element, an error is thrown to indicate unexpected structure.
|
|
419
|
-
*/
|
|
420
148
|
getInnerElementBoolean(element, name) {
|
|
421
149
|
const innerElements = element[name];
|
|
422
|
-
// if (innerElements === undefined) {
|
|
423
|
-
// throw new Error('No inner elements')
|
|
424
|
-
// }
|
|
425
150
|
if (innerElements.length === 1) {
|
|
426
151
|
const textValue = innerElements[0]['#text'];
|
|
427
152
|
const value = textValue.toString().trim().toLowerCase();
|
|
@@ -434,22 +159,7 @@ export class DoxygenXmlParser {
|
|
|
434
159
|
throw new Error('Too many elements');
|
|
435
160
|
}
|
|
436
161
|
}
|
|
437
|
-
/**
|
|
438
|
-
* Retrieves the text content of the XML element.
|
|
439
|
-
*
|
|
440
|
-
* @param element - The XML element to retrieve text from
|
|
441
|
-
* @returns The text content of the element
|
|
442
|
-
* @throws If the element does not contain a valid text node
|
|
443
|
-
*
|
|
444
|
-
* @remarks
|
|
445
|
-
* This method accesses the '#text' property of the XML element and
|
|
446
|
-
* returns its value as a string. It asserts that the value is of type
|
|
447
|
-
* string, number, or boolean before converting it to a string. If the
|
|
448
|
-
* property is missing or the value is of an unexpected type, an error is
|
|
449
|
-
* thrown.
|
|
450
|
-
*/
|
|
451
162
|
getInnerText(element) {
|
|
452
|
-
// assert(Object.hasOwn(element, '#text') === true)
|
|
453
163
|
const value = element['#text'];
|
|
454
164
|
assert(typeof value === 'string' ||
|
|
455
165
|
typeof value === 'number' ||
|
|
@@ -457,5 +167,4 @@ export class DoxygenXmlParser {
|
|
|
457
167
|
return value.toString();
|
|
458
168
|
}
|
|
459
169
|
}
|
|
460
|
-
// ----------------------------------------------------------------------------
|
|
461
170
|
//# sourceMappingURL=doxygen-xml-parser.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"doxygen-xml-parser.js","sourceRoot":"","sources":["../../../src/doxygen/data-model/doxygen-xml-parser.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"doxygen-xml-parser.js","sourceRoot":"","sources":["../../../src/doxygen/data-model/doxygen-xml-parser.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AA4B3C,MAAM,OAAO,gBAAgB;IAQ3B,OAAO,CAAY;IAUnB,SAAS,CAAW;IASpB,MAAM,GAA2B,EAAE,CAAA;IAcnC,YAAY,OAAmB;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QAEtB,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC;YAC7B,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,IAAI;YACpB,gBAAgB,EAAE,KAAK;YACvB,aAAa,EAAE,IAAI;YACnB,mBAAmB,EAAE,IAAI;YACzB,UAAU,EAAE,KAAK;SAClB,CAAC,CAAA;IACJ,CAAC;IAkBD,aAAa,CAAC,OAAe;QAC3B,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;IACrC,CAAC;IAgBD,kBAAkB,CAAC,OAAe;QAEhC,OAAO,MAAM,CAAC,IAAI,CAAE,OAAwB,CAAC,IAAI,CAAC,CAAC,CAAA;IACrD,CAAC;IAeD,YAAY,CAAC,OAAe,EAAE,IAAY;QACxC,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YAEjC,MAAM,qBAAqB,GAAG,OAAuB,CAAA;YACrD,OAAO,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAA;QACzD,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAkBD,uBAAuB,CAAC,OAAe,EAAE,IAAY;QACnD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAC7B,OACD,CAAC,IAAI,CAAC,CAAA;YACP,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,cAAc,CAAA;YACvB,CAAC;iBAAM,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBAI9C,OAAO,MAAM,CAAC,cAAc,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,YAAY,CACvE,CAAA;IACH,CAAC;IAgBD,uBAAuB,CAAC,OAAe,EAAE,IAAY;QACnD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAC7B,OACD,CAAC,IAAI,CAAC,CAAA;YACP,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,cAAc,CAAA;YACvB,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,UAAU;YAClE,WAAW,CACd,CAAA;IACH,CAAC;IAiBD,wBAAwB,CAAC,OAAe,EAAE,IAAY;QACpD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAC7B,OACD,CAAC,IAAI,CAAC,CAAA;YACP,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,cAAc,CAAC,WAAW,EAAE,KAAK,KAAK,CAAA;YAC/C,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,GAAG;YAC3D,mBAAmB,CACtB,CAAA;IACH,CAAC;IAgBD,eAAe,CAAC,OAAe,EAAE,IAAY;QAC3C,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,MAAM,KAAK,GAAI,OAAoD,CACjE,OAAO,CACR,CAAA;gBACD,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;oBACzB,OAAO,KAAK,KAAK,QAAQ;oBACzB,OAAO,KAAK,KAAK,SAAS,CAC3B,CAAA;YACH,CAAC;iBAAM,CAAC;gBAEN,OAAO,KAAK,CAAC,OAAO,CAAE,OAA2B,CAAC,IAAI,CAAC,CAAC,CAAA;YAC1D,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAeD,kBAAkB,CAAC,OAAe,EAAE,IAAY;QAC9C,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;YAIP,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAE/B,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,CAAC;oBAC7C,MAAM,KAAK,GACT,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;oBACV,MAAM,CACJ,OAAO,KAAK,KAAK,QAAQ;wBACvB,OAAO,KAAK,KAAK,QAAQ;wBACzB,OAAO,KAAK,KAAK,SAAS,CAC7B,CAAA;oBACD,OAAO,IAAI,CAAA;gBACb,CAAC;YACH,CAAC;iBAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAEtC,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAYD,YAAY,CAAC,OAAe;QAC1B,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;YACpC,MAAM,KAAK,GAAI,OAAoD,CACjE,OAAO,CACR,CAAA;YACD,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;gBACzB,OAAO,KAAK,KAAK,QAAQ;gBACzB,OAAO,KAAK,KAAK,SAAS,CAC3B,CAAA;QACH,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAkBD,gBAAgB,CAAmB,OAAe,EAAE,IAAY;QAG9D,MAAM,aAAa,GAAmB,OAAyB,CAAC,IAAI,CAAC,CAAA;QACrE,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,aAAa,CAAA;QACtB,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,GAAG;YACjE,qBAAqB,IAAI,gBAAgB,CAC5C,CAAA;IACH,CAAC;IAkBD,mBAAmB,CAAC,OAAe,EAAE,IAAY;QAC/C,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;QAKP,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,KAAK,GACT,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;YACV,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAA;QACzB,CAAC;aAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,EAAE,CAAA;QACX,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAiBD,qBAAqB,CAAC,OAAe,EAAE,IAAY;QACjD,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;QAKP,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,KAAK,GACT,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;YACV,OAAO,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;QACnC,CAAC;aAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,GAAG,CAAA;QACZ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAkBD,sBAAsB,CAAC,OAAe,EAAE,IAAY;QAClD,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;QAKP,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,SAAS,GACb,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;YACV,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;YACvD,OAAO,KAAK,KAAK,MAAM,CAAA;QACzB,CAAC;aAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAgBD,YAAY,CAAC,OAAe;QAE1B,MAAM,KAAK,GAAI,OAAoD,CAAC,OAAO,CAAC,CAAA;QAC5E,MAAM,CACJ,OAAO,KAAK,KAAK,QAAQ;YACvB,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,SAAS,CAC7B,CAAA;QACD,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAA;IACzB,CAAC;CACF"}
|
|
@@ -1,113 +1,15 @@
|
|
|
1
1
|
import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
|
|
2
2
|
import { IndexMemberDataModel } from './indexmembertype-dm.js';
|
|
3
3
|
import { AbstractDataModelBase } from '../types.js';
|
|
4
|
-
/**
|
|
5
|
-
* Abstract base class for index compound type data models.
|
|
6
|
-
*
|
|
7
|
-
* @remarks
|
|
8
|
-
* Represents compound elements found within Doxygen index XML structures,
|
|
9
|
-
* corresponding to the CompoundType complex type in the XML schema. This
|
|
10
|
-
* class handles the parsing of compound names, member collections, and
|
|
11
|
-
* mandatory attributes (refid and kind). All concrete compound data model
|
|
12
|
-
* classes should extend this abstract base to ensure consistent parsing
|
|
13
|
-
* and data representation.
|
|
14
|
-
*
|
|
15
|
-
* @public
|
|
16
|
-
*/
|
|
17
4
|
export declare abstract class AbstractIndexCompoundType extends AbstractDataModelBase {
|
|
18
|
-
/**
|
|
19
|
-
* The name of the compound element.
|
|
20
|
-
*
|
|
21
|
-
* @remarks
|
|
22
|
-
* Extracted from the mandatory 'name' element within the compound XML
|
|
23
|
-
* structure. Represents the identifier or name of the documented compound
|
|
24
|
-
* such as a class name, namespace, or filename.
|
|
25
|
-
*/
|
|
26
5
|
name: string;
|
|
27
|
-
/**
|
|
28
|
-
* Collection of member data models associated with this compound.
|
|
29
|
-
*
|
|
30
|
-
* @remarks
|
|
31
|
-
* Optional array containing member elements found within the compound
|
|
32
|
-
* structure. Each member represents a documented entity that belongs
|
|
33
|
-
* to this compound, such as functions, variables, or other nested
|
|
34
|
-
* constructs. The array supports zero to many members as per the XML schema.
|
|
35
|
-
*/
|
|
36
6
|
members: IndexMemberDataModel[] | undefined;
|
|
37
|
-
/**
|
|
38
|
-
* The unique reference identifier for this compound.
|
|
39
|
-
*
|
|
40
|
-
* @remarks
|
|
41
|
-
* Mandatory attribute that provides a unique identifier for referencing
|
|
42
|
-
* this compound within the Doxygen documentation structure. Used to link
|
|
43
|
-
* index entries to their detailed definitions in separate XML files.
|
|
44
|
-
*/
|
|
45
7
|
refid: string;
|
|
46
|
-
/**
|
|
47
|
-
* The kind classification of this compound.
|
|
48
|
-
*
|
|
49
|
-
* @remarks
|
|
50
|
-
* Mandatory attribute specifying the type of compound (e.g., class, struct,
|
|
51
|
-
* namespace, file). Corresponds to the CompoundKind enumeration in the
|
|
52
|
-
* XML schema, determining how the compound should be processed and presented.
|
|
53
|
-
*/
|
|
54
8
|
kind: string;
|
|
55
|
-
/**
|
|
56
|
-
* Constructs a new AbstractIndexCompoundType instance from XML data.
|
|
57
|
-
*
|
|
58
|
-
* @param xml - The Doxygen XML parser instance for processing XML elements
|
|
59
|
-
* @param element - The XML element containing the compound data
|
|
60
|
-
* @param elementName - The name of the XML element being processed
|
|
61
|
-
*
|
|
62
|
-
* @remarks
|
|
63
|
-
* Parses the provided XML element to extract compound information including
|
|
64
|
-
* the name element, member collections, and mandatory attributes (refid and
|
|
65
|
-
* kind). The constructor validates that all required data is present and
|
|
66
|
-
* properly formatted according to the XML schema specifications. Member
|
|
67
|
-
* elements are processed into IndexMemberDataModel instances when present.
|
|
68
|
-
*/
|
|
69
9
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
70
10
|
}
|
|
71
|
-
/**
|
|
72
|
-
* Union type representing the various kinds of compounds in Doxygen
|
|
73
|
-
* documentation.
|
|
74
|
-
*
|
|
75
|
-
* @remarks
|
|
76
|
-
* Corresponds to the CompoundKind simple type in the Doxygen XML schema,
|
|
77
|
-
* which defines the allowable classifications for documented compounds.
|
|
78
|
-
* Each value represents a specific type of programming construct or
|
|
79
|
-
* documentation unit that can be indexed, ranging from code structures
|
|
80
|
-
* like classes and namespaces to documentation pages and examples.
|
|
81
|
-
*
|
|
82
|
-
* @public
|
|
83
|
-
*/
|
|
84
11
|
export type IndexCompoundKind = 'class' | 'struct' | 'union' | 'interface' | 'protocol' | 'category' | 'exception' | 'file' | 'namespace' | 'group' | 'page' | 'example' | 'dir' | 'type' | 'concept' | 'module';
|
|
85
|
-
/**
|
|
86
|
-
* Concrete data model class for index compound elements.
|
|
87
|
-
*
|
|
88
|
-
* @remarks
|
|
89
|
-
* Represents individual compound elements found within Doxygen index XML
|
|
90
|
-
* structures. This class extends the abstract base to provide specific
|
|
91
|
-
* handling for 'compound' elements, which reference documented entities
|
|
92
|
-
* such as classes, namespaces, files, and other structural components
|
|
93
|
-
* within the indexed documentation. Each compound serves as an entry
|
|
94
|
-
* point for accessing detailed documentation in separate XML files.
|
|
95
|
-
*
|
|
96
|
-
* @public
|
|
97
|
-
*/
|
|
98
12
|
export declare class IndexCompoundDataModel extends AbstractIndexCompoundType {
|
|
99
|
-
/**
|
|
100
|
-
* Constructs a new IndexCompoundDataModel instance from XML data.
|
|
101
|
-
*
|
|
102
|
-
* @param xml - The Doxygen XML parser instance for processing XML elements
|
|
103
|
-
* @param element - The XML element containing the compound data
|
|
104
|
-
*
|
|
105
|
-
* @remarks
|
|
106
|
-
* Initialises the compound data model by parsing the provided XML element
|
|
107
|
-
* as a 'compound' element type. The constructor delegates to the parent
|
|
108
|
-
* class for common compound processing whilst specifying the element name
|
|
109
|
-
* for proper XML structure handling.
|
|
110
|
-
*/
|
|
111
13
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
112
14
|
}
|
|
113
15
|
//# sourceMappingURL=indexcompoundtype-dm.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"indexcompoundtype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexcompoundtype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"indexcompoundtype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexcompoundtype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA0BnD,8BAAsB,yBAA0B,SAAQ,qBAAqB;IAS3E,IAAI,SAAK;IAWT,OAAO,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAA;IAU3C,KAAK,SAAK;IAUV,IAAI,SAAK;gBAgBG,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA+DxE;AAsCD,MAAM,MAAM,iBAAiB,GACzB,OAAO,GACP,QAAQ,GACR,OAAO,GACP,WAAW,GACX,UAAU,GACV,UAAU,GACV,WAAW,GACX,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,SAAS,GACT,KAAK,GACL,MAAM,GACN,SAAS,GACT,QAAQ,CAAA;AAmBZ,qBAAa,sBAAuB,SAAQ,yBAAyB;gBAavD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
|