@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,116 +1,16 @@
|
|
|
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 util from 'node:util';
|
|
14
3
|
import { AbstractDataModelBase } from '../types.js';
|
|
15
|
-
// ----------------------------------------------------------------------------
|
|
16
|
-
// <xsd:complexType name="refType">
|
|
17
|
-
// <xsd:simpleContent>
|
|
18
|
-
// <xsd:extension base="xsd:string">
|
|
19
|
-
// <xsd:attribute name="refid" type="xsd:string" />
|
|
20
|
-
// <xsd:attribute name="prot" type="DoxProtectionKind" use="optional"/>
|
|
21
|
-
// <xsd:attribute name="inline" type="DoxBool" use="optional"/>
|
|
22
|
-
// </xsd:extension>
|
|
23
|
-
// </xsd:simpleContent>
|
|
24
|
-
// </xsd:complexType>
|
|
25
|
-
// <xsd:simpleType name="DoxProtectionKind">
|
|
26
|
-
// <xsd:restriction base="xsd:string">
|
|
27
|
-
// <xsd:enumeration value="public" />
|
|
28
|
-
// <xsd:enumeration value="protected" />
|
|
29
|
-
// <xsd:enumeration value="private" />
|
|
30
|
-
// <xsd:enumeration value="package" />
|
|
31
|
-
// </xsd:restriction>
|
|
32
|
-
// </xsd:simpleType>
|
|
33
|
-
/**
|
|
34
|
-
* Abstract base class for reference type data models.
|
|
35
|
-
*
|
|
36
|
-
* @remarks
|
|
37
|
-
* Represents the foundational structure for reference elements within Doxygen
|
|
38
|
-
* XML documentation, corresponding to the refType complex type in the XML
|
|
39
|
-
* schema. This class manages references to various documented entities such
|
|
40
|
-
* as classes, namespaces, files, folders, modules, pages, and groups. Each
|
|
41
|
-
* reference includes the entity name, a unique identifier for linking, and
|
|
42
|
-
* optional protection and inline attributes. All concrete reference
|
|
43
|
-
* implementations should extend this base to ensure consistent structure
|
|
44
|
-
* and parsing behaviour across different reference types.
|
|
45
|
-
*
|
|
46
|
-
* @public
|
|
47
|
-
*/
|
|
48
4
|
export class AbstractRefType extends AbstractDataModelBase {
|
|
49
|
-
|
|
50
|
-
* The name of the referenced entity.
|
|
51
|
-
*
|
|
52
|
-
* @remarks
|
|
53
|
-
* Mandatory element containing the textual name of the referenced entity,
|
|
54
|
-
* passed as the element's text content. This name provides human-readable
|
|
55
|
-
* identification of the referenced item and is used for display and
|
|
56
|
-
* navigation purposes within the generated documentation.
|
|
57
|
-
*/
|
|
58
|
-
text = ''; // The name of the reference, passed as element text.
|
|
59
|
-
/**
|
|
60
|
-
* The unique reference identifier for the referenced entity.
|
|
61
|
-
*
|
|
62
|
-
* @remarks
|
|
63
|
-
* Mandatory attribute that provides a unique identifier for the referenced
|
|
64
|
-
* entity within the Doxygen documentation system. This identifier enables
|
|
65
|
-
* precise linking and cross-referencing between documentation elements,
|
|
66
|
-
* allowing navigation to the detailed documentation of the referenced item.
|
|
67
|
-
*/
|
|
5
|
+
text = '';
|
|
68
6
|
refid = '';
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
*
|
|
72
|
-
* @remarks
|
|
73
|
-
* Optional attribute specifying the protection level according to the
|
|
74
|
-
* DoxProtectionKind enumeration. Values include 'public', 'protected',
|
|
75
|
-
* 'private', and 'package', indicating the accessibility scope of the
|
|
76
|
-
* referenced entity within its containing context.
|
|
77
|
-
*/
|
|
78
|
-
prot; // DoxProtectionKind
|
|
79
|
-
/**
|
|
80
|
-
* Indicates whether the referenced entity is inline.
|
|
81
|
-
*
|
|
82
|
-
* @remarks
|
|
83
|
-
* Optional boolean attribute that specifies whether the referenced entity
|
|
84
|
-
* is defined inline within its containing context. This information affects
|
|
85
|
-
* how the entity is presented and processed in the generated documentation,
|
|
86
|
-
* particularly for inline classes, functions, or other code constructs.
|
|
87
|
-
*/
|
|
88
|
-
inline; // DoxBool
|
|
89
|
-
/**
|
|
90
|
-
* Constructs a new abstract reference type from XML data.
|
|
91
|
-
*
|
|
92
|
-
* @param xml - The Doxygen XML parser instance
|
|
93
|
-
* @param element - The XML element containing reference data
|
|
94
|
-
* @param elementName - The expected XML element name
|
|
95
|
-
*
|
|
96
|
-
* @remarks
|
|
97
|
-
* Parses the provided XML element to construct a complete reference data
|
|
98
|
-
* model. The parsing process extracts the textual content from the element
|
|
99
|
-
* and processes all defined attributes including the mandatory refid and
|
|
100
|
-
* optional protection and inline attributes. Validation ensures that both
|
|
101
|
-
* the reference name and identifier are present and non-empty, maintaining
|
|
102
|
-
* the integrity of the reference documentation.
|
|
103
|
-
*/
|
|
7
|
+
prot;
|
|
8
|
+
inline;
|
|
104
9
|
constructor(xml, element, elementName) {
|
|
105
10
|
super(elementName);
|
|
106
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
107
|
-
// ------------------------------------------------------------------------
|
|
108
|
-
// Process elements.
|
|
109
11
|
assert(xml.isInnerElementText(element, elementName));
|
|
110
12
|
this.text = xml.getInnerElementText(element, elementName);
|
|
111
13
|
assert(this.text.length > 0);
|
|
112
|
-
// ------------------------------------------------------------------------
|
|
113
|
-
// Process attributes.
|
|
114
14
|
assert(xml.hasAttributes(element));
|
|
115
15
|
const attributesNames = xml.getAttributesNames(element);
|
|
116
16
|
for (const attributeName of attributesNames) {
|
|
@@ -121,7 +21,7 @@ export class AbstractRefType extends AbstractDataModelBase {
|
|
|
121
21
|
this.prot = xml.getAttributeStringValue(element, '@_prot');
|
|
122
22
|
}
|
|
123
23
|
else if (attributeName === '@_inline') {
|
|
124
|
-
this.inline =
|
|
24
|
+
this.inline = xml.getAttributeBooleanValue(element, '@_inline');
|
|
125
25
|
}
|
|
126
26
|
else {
|
|
127
27
|
console.error(util.inspect(element, { compact: false, depth: 999 }));
|
|
@@ -129,268 +29,46 @@ export class AbstractRefType extends AbstractDataModelBase {
|
|
|
129
29
|
}
|
|
130
30
|
}
|
|
131
31
|
assert(this.refid.length > 0);
|
|
132
|
-
// ------------------------------------------------------------------------
|
|
133
|
-
// console.log(util.inspect(this, { compact: false, depth: 999 }))
|
|
134
32
|
}
|
|
135
33
|
}
|
|
136
|
-
// ----------------------------------------------------------------------------
|
|
137
|
-
// <xsd:element name="innermodule" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
138
|
-
// <xsd:element name="innerdir" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
139
|
-
// <xsd:element name="innerfile" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
140
|
-
// <xsd:element name="innerclass" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
141
|
-
// <xsd:element name="innerconcept" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
142
|
-
// <xsd:element name="innernamespace" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
143
|
-
// <xsd:element name="innerpage" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
144
|
-
// <xsd:element name="innergroup" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
145
|
-
/**
|
|
146
|
-
* Data model for inner module reference elements.
|
|
147
|
-
*
|
|
148
|
-
* @remarks
|
|
149
|
-
* Represents a reference to an inner module within Doxygen XML documentation,
|
|
150
|
-
* corresponding to the innermodule XML element. This class manages references
|
|
151
|
-
* to modules that are contained within the current documentation context,
|
|
152
|
-
* providing linking and navigation capabilities to detailed module
|
|
153
|
-
* documentation. Inner modules typically represent modular components or
|
|
154
|
-
* subsystems within larger software projects.
|
|
155
|
-
*
|
|
156
|
-
* @public
|
|
157
|
-
*/
|
|
158
34
|
export class InnerModuleDataModel extends AbstractRefType {
|
|
159
|
-
/**
|
|
160
|
-
* Constructs a new inner module reference data model from XML.
|
|
161
|
-
*
|
|
162
|
-
* @param xml - The Doxygen XML parser instance
|
|
163
|
-
* @param element - The XML element containing inner module reference data
|
|
164
|
-
*
|
|
165
|
-
* @remarks
|
|
166
|
-
* Creates a complete inner module reference data model by parsing the
|
|
167
|
-
* provided XML element. This constructor delegates to the parent class to
|
|
168
|
-
* handle all standard parsing operations for the innermodule element type,
|
|
169
|
-
* establishing the reference to the contained module entity.
|
|
170
|
-
*/
|
|
171
35
|
constructor(xml, element) {
|
|
172
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
173
36
|
super(xml, element, 'innermodule');
|
|
174
37
|
}
|
|
175
38
|
}
|
|
176
|
-
/**
|
|
177
|
-
* Data model for inner folder reference elements.
|
|
178
|
-
*
|
|
179
|
-
* @remarks
|
|
180
|
-
* Represents a reference to an inner folder within Doxygen XML documentation,
|
|
181
|
-
* corresponding to the innerdir XML element. This class manages references
|
|
182
|
-
* to folders that are contained within the current documentation context,
|
|
183
|
-
* providing linking and navigation capabilities to detailed folder
|
|
184
|
-
* documentation. Inner folders typically represent subdirectories within
|
|
185
|
-
* the project structure that contain related source files and documentation.
|
|
186
|
-
*
|
|
187
|
-
* @public
|
|
188
|
-
*/
|
|
189
39
|
export class InnerDirDataModel extends AbstractRefType {
|
|
190
|
-
/**
|
|
191
|
-
* Constructs a new inner folder reference data model from XML.
|
|
192
|
-
*
|
|
193
|
-
* @param xml - The Doxygen XML parser instance
|
|
194
|
-
* @param element - The XML element containing inner folder reference data
|
|
195
|
-
*
|
|
196
|
-
* @remarks
|
|
197
|
-
* Creates a complete inner folder reference data model by parsing the
|
|
198
|
-
* provided XML element. This constructor delegates to the parent class to
|
|
199
|
-
* handle all standard parsing operations for the innerdir element type,
|
|
200
|
-
* establishing the reference to the contained folder entity.
|
|
201
|
-
*/
|
|
202
40
|
constructor(xml, element) {
|
|
203
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
204
41
|
super(xml, element, 'innerdir');
|
|
205
42
|
}
|
|
206
43
|
}
|
|
207
|
-
/**
|
|
208
|
-
* Data model for inner file reference elements.
|
|
209
|
-
*
|
|
210
|
-
* @remarks
|
|
211
|
-
* Represents a reference to an inner file within Doxygen XML documentation,
|
|
212
|
-
* corresponding to the innerfile XML element. This class manages references
|
|
213
|
-
* to files that are contained within the current documentation context,
|
|
214
|
-
* providing linking and navigation capabilities to detailed file
|
|
215
|
-
* documentation. Inner files typically represent source code files, headers,
|
|
216
|
-
* or other documented files within the project structure.
|
|
217
|
-
*
|
|
218
|
-
* @public
|
|
219
|
-
*/
|
|
220
44
|
export class InnerFileDataModel extends AbstractRefType {
|
|
221
|
-
/**
|
|
222
|
-
* Constructs a new inner file reference data model from XML.
|
|
223
|
-
*
|
|
224
|
-
* @param xml - The Doxygen XML parser instance
|
|
225
|
-
* @param element - The XML element containing inner file reference data
|
|
226
|
-
*
|
|
227
|
-
* @remarks
|
|
228
|
-
* Creates a complete inner file reference data model by parsing the
|
|
229
|
-
* provided XML element. This constructor delegates to the parent class to
|
|
230
|
-
* handle all standard parsing operations for the innerfile element type,
|
|
231
|
-
* establishing the reference to the contained file entity.
|
|
232
|
-
*/
|
|
233
45
|
constructor(xml, element) {
|
|
234
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
235
46
|
super(xml, element, 'innerfile');
|
|
236
47
|
}
|
|
237
48
|
}
|
|
238
|
-
/**
|
|
239
|
-
* Data model for inner class reference elements.
|
|
240
|
-
*
|
|
241
|
-
* @remarks
|
|
242
|
-
* Represents a reference to an inner class within Doxygen XML documentation,
|
|
243
|
-
* corresponding to the innerclass XML element. This class manages references
|
|
244
|
-
* to classes that are contained within the current documentation context,
|
|
245
|
-
* providing linking and navigation capabilities to detailed class
|
|
246
|
-
* documentation. Inner classes typically represent nested classes, inner
|
|
247
|
-
* types, or classes defined within other classes or namespaces.
|
|
248
|
-
*
|
|
249
|
-
* @public
|
|
250
|
-
*/
|
|
251
49
|
export class InnerClassDataModel extends AbstractRefType {
|
|
252
|
-
/**
|
|
253
|
-
* Constructs a new inner class reference data model from XML.
|
|
254
|
-
*
|
|
255
|
-
* @param xml - The Doxygen XML parser instance
|
|
256
|
-
* @param element - The XML element containing inner class reference data
|
|
257
|
-
*
|
|
258
|
-
* @remarks
|
|
259
|
-
* Creates a complete inner class reference data model by parsing the
|
|
260
|
-
* provided XML element. This constructor delegates to the parent class to
|
|
261
|
-
* handle all standard parsing operations for the innerclass element type,
|
|
262
|
-
* establishing the reference to the contained class entity.
|
|
263
|
-
*/
|
|
264
50
|
constructor(xml, element) {
|
|
265
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
266
51
|
super(xml, element, 'innerclass');
|
|
267
52
|
}
|
|
268
53
|
}
|
|
269
|
-
/**
|
|
270
|
-
* Data model for inner concept reference elements.
|
|
271
|
-
*
|
|
272
|
-
* @remarks
|
|
273
|
-
* Represents a reference to an inner concept within Doxygen XML documentation,
|
|
274
|
-
* corresponding to the innerconcept XML element. This class manages references
|
|
275
|
-
* to concepts that are contained within the current documentation context,
|
|
276
|
-
* providing linking and navigation capabilities to detailed concept
|
|
277
|
-
* documentation. Inner concepts typically represent C++20 concepts or similar
|
|
278
|
-
* constraint-based language features defined within classes or namespaces.
|
|
279
|
-
*
|
|
280
|
-
* @public
|
|
281
|
-
*/
|
|
282
54
|
export class InnerConceptDataModel extends AbstractRefType {
|
|
283
|
-
/**
|
|
284
|
-
* Constructs a new inner concept reference data model from XML.
|
|
285
|
-
*
|
|
286
|
-
* @param xml - The Doxygen XML parser instance
|
|
287
|
-
* @param element - The XML element containing inner concept reference data
|
|
288
|
-
*
|
|
289
|
-
* @remarks
|
|
290
|
-
* Creates a complete inner concept reference data model by parsing the
|
|
291
|
-
* provided XML element. This constructor delegates to the parent class to
|
|
292
|
-
* handle all standard parsing operations for the innerconcept element type,
|
|
293
|
-
* establishing the reference to the contained concept entity.
|
|
294
|
-
*/
|
|
295
55
|
constructor(xml, element) {
|
|
296
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
297
56
|
super(xml, element, 'innerconcept');
|
|
298
57
|
}
|
|
299
58
|
}
|
|
300
|
-
/**
|
|
301
|
-
* Data model for inner namespace reference elements.
|
|
302
|
-
*
|
|
303
|
-
* @remarks
|
|
304
|
-
* Represents a reference to an inner namespace within Doxygen XML
|
|
305
|
-
* documentation, corresponding to the innernamespace XML element. This class
|
|
306
|
-
* manages references to namespaces that are contained within the current
|
|
307
|
-
* documentation context, providing linking and navigation capabilities to
|
|
308
|
-
* detailed namespace documentation. Inner namespaces typically represent
|
|
309
|
-
* nested namespaces or namespace aliases defined within other namespaces.
|
|
310
|
-
*
|
|
311
|
-
* @public
|
|
312
|
-
*/
|
|
313
59
|
export class InnerNamespaceDataModel extends AbstractRefType {
|
|
314
|
-
/**
|
|
315
|
-
* Constructs a new inner namespace reference data model from XML.
|
|
316
|
-
*
|
|
317
|
-
* @param xml - The Doxygen XML parser instance
|
|
318
|
-
* @param element - The XML element containing inner namespace reference data
|
|
319
|
-
*
|
|
320
|
-
* @remarks
|
|
321
|
-
* Creates a complete inner namespace reference data model by parsing the
|
|
322
|
-
* provided XML element. This constructor delegates to the parent class to
|
|
323
|
-
* handle all standard parsing operations for the innernamespace element
|
|
324
|
-
* type, establishing the reference to the contained namespace entity.
|
|
325
|
-
*/
|
|
326
60
|
constructor(xml, element) {
|
|
327
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
328
61
|
super(xml, element, 'innernamespace');
|
|
329
62
|
}
|
|
330
63
|
}
|
|
331
|
-
/**
|
|
332
|
-
* Data model for inner page reference elements.
|
|
333
|
-
*
|
|
334
|
-
* @remarks
|
|
335
|
-
* Represents a reference to an inner page within Doxygen XML documentation,
|
|
336
|
-
* corresponding to the innerpage XML element. This class manages references
|
|
337
|
-
* to pages that are contained within the current documentation context,
|
|
338
|
-
* providing linking and navigation capabilities to detailed page
|
|
339
|
-
* documentation. Inner pages typically represent documentation pages,
|
|
340
|
-
* tutorials, or other narrative content that is logically contained within
|
|
341
|
-
* the current documentation scope.
|
|
342
|
-
*
|
|
343
|
-
* @public
|
|
344
|
-
*/
|
|
345
64
|
export class InnerPageDataModel extends AbstractRefType {
|
|
346
|
-
/**
|
|
347
|
-
* Constructs a new inner page reference data model from XML.
|
|
348
|
-
*
|
|
349
|
-
* @param xml - The Doxygen XML parser instance
|
|
350
|
-
* @param element - The XML element containing inner page reference data
|
|
351
|
-
*
|
|
352
|
-
* @remarks
|
|
353
|
-
* Creates a complete inner page reference data model by parsing the
|
|
354
|
-
* provided XML element. This constructor delegates to the parent class to
|
|
355
|
-
* handle all standard parsing operations for the innerpage element type,
|
|
356
|
-
* establishing the reference to the contained page entity.
|
|
357
|
-
*/
|
|
358
65
|
constructor(xml, element) {
|
|
359
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
360
66
|
super(xml, element, 'innerpage');
|
|
361
67
|
}
|
|
362
68
|
}
|
|
363
|
-
/**
|
|
364
|
-
* Data model for inner group reference elements.
|
|
365
|
-
*
|
|
366
|
-
* @remarks
|
|
367
|
-
* Represents a reference to an inner group within Doxygen XML documentation,
|
|
368
|
-
* corresponding to the innergroup XML element. This class manages references
|
|
369
|
-
* to groups that are contained within the current documentation context,
|
|
370
|
-
* providing linking and navigation capabilities to detailed group
|
|
371
|
-
* documentation. Inner groups typically represent logical collections or
|
|
372
|
-
* modules of related functionality that are organised within the current
|
|
373
|
-
* documentation scope.
|
|
374
|
-
*
|
|
375
|
-
* @public
|
|
376
|
-
*/
|
|
377
69
|
export class InnerGroupDataModel extends AbstractRefType {
|
|
378
|
-
/**
|
|
379
|
-
* Constructs a new inner group reference data model from XML.
|
|
380
|
-
*
|
|
381
|
-
* @param xml - The Doxygen XML parser instance
|
|
382
|
-
* @param element - The XML element containing inner group reference data
|
|
383
|
-
*
|
|
384
|
-
* @remarks
|
|
385
|
-
* Creates a complete inner group reference data model by parsing the
|
|
386
|
-
* provided XML element. This constructor delegates to the parent class to
|
|
387
|
-
* handle all standard parsing operations for the innergroup element type,
|
|
388
|
-
* establishing the reference to the contained group entity.
|
|
389
|
-
*/
|
|
390
70
|
constructor(xml, element) {
|
|
391
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
392
71
|
super(xml, element, 'innergroup');
|
|
393
72
|
}
|
|
394
73
|
}
|
|
395
|
-
// ----------------------------------------------------------------------------
|
|
396
74
|
//# sourceMappingURL=reftype-dm.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reftype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftype-dm.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"reftype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftype-dm.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAsCnD,MAAM,OAAgB,eAAgB,SAAQ,qBAAqB;IAUjE,IAAI,GAAG,EAAE,CAAA;IAWT,KAAK,GAAG,EAAE,CAAA;IAWV,IAAI,CAAqB;IAWzB,MAAM,CAAsB;IAiB5B,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAOlB,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAEzD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;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,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,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,UAAU,EAAE,CAAC;gBACxC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,wBAAwB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;YACjE,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,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAK/B,CAAC;CACF;AA0BD,MAAM,OAAO,oBAAqB,SAAQ,eAAe;IAavD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,CAAA;IACpC,CAAC;CACF;AAeD,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IAapD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;IACjC,CAAC;CACF;AAeD,MAAM,OAAO,kBAAmB,SAAQ,eAAe;IAarD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IAClC,CAAC;CACF;AAeD,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IAatD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAeD,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IAaxD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;IACrC,CAAC;CACF;AAeD,MAAM,OAAO,uBAAwB,SAAQ,eAAe;IAa1D,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAA;IACvC,CAAC;CACF;AAgBD,MAAM,OAAO,kBAAmB,SAAQ,eAAe;IAarD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IAClC,CAAC;CACF;AAgBD,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IAatD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF"}
|
|
@@ -1,119 +1,14 @@
|
|
|
1
1
|
import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
|
|
2
2
|
import { AbstractDataModelBase } from '../types.js';
|
|
3
|
-
/**
|
|
4
|
-
* Abstract base class for reimplement type data models.
|
|
5
|
-
*
|
|
6
|
-
* @remarks
|
|
7
|
-
* Represents the foundational structure for reimplement relationship elements
|
|
8
|
-
* within Doxygen XML documentation, corresponding to the reimplementType
|
|
9
|
-
* complex type in the XML schema. This class manages relationships between
|
|
10
|
-
* methods, functions, or other documented entities that implement or override
|
|
11
|
-
* behaviour from base classes or interfaces. The reimplement relationship
|
|
12
|
-
* captures both the descriptive text and the reference identifier for the
|
|
13
|
-
* related entity, enabling comprehensive documentation of inheritance and
|
|
14
|
-
* polymorphic behaviours within the codebase.
|
|
15
|
-
*
|
|
16
|
-
* @public
|
|
17
|
-
*/
|
|
18
3
|
export declare abstract class AbstractReimplementType extends AbstractDataModelBase {
|
|
19
|
-
/**
|
|
20
|
-
* The descriptive text content for this reimplement relationship.
|
|
21
|
-
*
|
|
22
|
-
* @remarks
|
|
23
|
-
* Mandatory element containing the textual description of the reimplement
|
|
24
|
-
* relationship. This text typically includes the signature or name of the
|
|
25
|
-
* reimplemented entity, providing human-readable context about the
|
|
26
|
-
* relationship between the current entity and the referenced implementation.
|
|
27
|
-
*/
|
|
28
4
|
text: string;
|
|
29
|
-
/**
|
|
30
|
-
* The reference identifier for the reimplemented entity.
|
|
31
|
-
*
|
|
32
|
-
* @remarks
|
|
33
|
-
* Mandatory attribute that provides a unique identifier for the entity
|
|
34
|
-
* being reimplemented. This reference enables linking and cross-referencing
|
|
35
|
-
* between related documentation elements, allowing navigation between
|
|
36
|
-
* implementations and their base declarations within the generated
|
|
37
|
-
* documentation structure.
|
|
38
|
-
*/
|
|
39
5
|
refId: string;
|
|
40
|
-
/**
|
|
41
|
-
* Constructs a new abstract reimplement type from XML data.
|
|
42
|
-
*
|
|
43
|
-
* @param xml - The Doxygen XML parser instance
|
|
44
|
-
* @param element - The XML element containing reimplement relationship data
|
|
45
|
-
* @param elementName - The expected XML element name
|
|
46
|
-
*
|
|
47
|
-
* @remarks
|
|
48
|
-
* Parses the provided XML element to construct a complete reimplement
|
|
49
|
-
* relationship data model. The parsing process extracts the textual content
|
|
50
|
-
* from the element and processes the mandatory refid attribute. Validation
|
|
51
|
-
* ensures that both the descriptive text and reference identifier are
|
|
52
|
-
* present and non-empty, maintaining the integrity of the reimplement
|
|
53
|
-
* relationship documentation.
|
|
54
|
-
*/
|
|
55
6
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
56
7
|
}
|
|
57
|
-
/**
|
|
58
|
-
* Data model for reimplement relationship elements.
|
|
59
|
-
*
|
|
60
|
-
* @remarks
|
|
61
|
-
* Represents a specific reimplement relationship within Doxygen XML
|
|
62
|
-
* documentation, corresponding to the reimplements XML element. This class
|
|
63
|
-
* manages relationships where the current entity reimplements or overrides
|
|
64
|
-
* behaviour from a base class or interface. The relationship captures both
|
|
65
|
-
* the descriptive information and the reference to the original implementation,
|
|
66
|
-
* enabling comprehensive documentation of polymorphic behaviours and
|
|
67
|
-
* inheritance patterns within object-oriented codebases.
|
|
68
|
-
*
|
|
69
|
-
* @public
|
|
70
|
-
*/
|
|
71
8
|
export declare class ReimplementDataModel extends AbstractReimplementType {
|
|
72
|
-
/**
|
|
73
|
-
* Constructs a new reimplement relationship data model from XML.
|
|
74
|
-
*
|
|
75
|
-
* @param xml - The Doxygen XML parser instance
|
|
76
|
-
* @param element - The XML element containing reimplement relationship data
|
|
77
|
-
*
|
|
78
|
-
* @remarks
|
|
79
|
-
* Creates a complete reimplement relationship data model by parsing the
|
|
80
|
-
* provided XML element. This constructor delegates to the parent class to
|
|
81
|
-
* handle all standard parsing operations for the reimplements element type,
|
|
82
|
-
* establishing the relationship between the current entity and the
|
|
83
|
-
* reimplemented base implementation.
|
|
84
|
-
*/
|
|
85
9
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
86
10
|
}
|
|
87
|
-
/**
|
|
88
|
-
* Data model for reimplemented-by relationship elements.
|
|
89
|
-
*
|
|
90
|
-
* @remarks
|
|
91
|
-
* Represents the inverse reimplement relationship within Doxygen XML
|
|
92
|
-
* documentation, corresponding to the reimplementedby XML element. This class
|
|
93
|
-
* manages relationships where the current entity is reimplemented or overridden
|
|
94
|
-
* by derived classes or implementing types. The relationship provides a
|
|
95
|
-
* reverse-lookup capability, allowing documentation of which entities override
|
|
96
|
-
* or reimplement the current method or function. This bidirectional
|
|
97
|
-
* relationship documentation enables comprehensive understanding of inheritance
|
|
98
|
-
* hierarchies and polymorphic implementations.
|
|
99
|
-
*
|
|
100
|
-
* @public
|
|
101
|
-
*/
|
|
102
11
|
export declare class ReimplementedByDataModel extends AbstractReimplementType {
|
|
103
|
-
/**
|
|
104
|
-
* Constructs a new reimplemented-by relationship data model from XML.
|
|
105
|
-
*
|
|
106
|
-
* @param xml - The Doxygen XML parser instance
|
|
107
|
-
* @param element - The XML element containing reimplemented-by relationship
|
|
108
|
-
* data
|
|
109
|
-
*
|
|
110
|
-
* @remarks
|
|
111
|
-
* Creates a complete reimplemented-by relationship data model by parsing the
|
|
112
|
-
* provided XML element. This constructor delegates to the parent class to
|
|
113
|
-
* handle all standard parsing operations for the reimplementedby element
|
|
114
|
-
* type, establishing the reverse relationship between the current entity
|
|
115
|
-
* and the implementing derived classes or types.
|
|
116
|
-
*/
|
|
117
12
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
118
13
|
}
|
|
119
14
|
//# sourceMappingURL=reimplementtype-dm.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reimplementtype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reimplementtype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"reimplementtype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reimplementtype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA2BnD,8BAAsB,uBAAwB,SAAQ,qBAAqB;IAUzE,IAAI,SAAK;IAYT,KAAK,SAAK;gBAiBE,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAwCxE;AAqBD,qBAAa,oBAAqB,SAAQ,uBAAuB;gBAcnD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAiBD,qBAAa,wBAAyB,SAAQ,uBAAuB;gBAevD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
|