@xpack/doxygen2docusaurus 2.0.0 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +3 -1
- package/bin/doxygen2docusaurus.js +5 -5
- 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/conceptparts.d.ts +9 -0
- package/dist/docusaurus/renderers/conceptparts.d.ts.map +1 -0
- package/dist/docusaurus/renderers/conceptparts.js +21 -0
- package/dist/docusaurus/renderers/conceptparts.js.map +1 -0
- 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 +15 -186
- 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 +27 -0
- package/dist/docusaurus/view-model/concepts-vm.d.ts.map +1 -0
- package/dist/docusaurus/view-model/concepts-vm.js +337 -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 +5 -199
- package/dist/docusaurus/view-model/namespaces-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/namespaces-vm.js +85 -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 +39 -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 +7 -492
- package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/compounddef-dm.js +28 -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/concepts-dm.d.ts +23 -0
- package/dist/doxygen/data-model/compounds/concepts-dm.d.ts.map +1 -0
- package/dist/doxygen/data-model/compounds/concepts-dm.js +94 -0
- package/dist/doxygen/data-model/compounds/concepts-dm.js.map +1 -0
- 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/requirements-dm.d.ts +2 -0
- package/dist/doxygen/data-model/compounds/requirements-dm.d.ts.map +1 -0
- package/dist/doxygen/data-model/compounds/requirements-dm.js +2 -0
- package/dist/doxygen/data-model/compounds/requirements-dm.js.map +1 -0
- 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 +8 -200
- 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 +5 -16
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -42
- package/dist/index.js.map +1 -1
- package/package.json +49 -52
- 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/conceptparts.ts +119 -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 +812 -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 +749 -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 +1037 -0
- package/src/docusaurus/view-model/options.ts +95 -0
- package/src/docusaurus/view-model/pages-vm.ts +389 -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 +1230 -0
- package/src/doxygen/data-model/compounds/compoundreftype-dm.ts +266 -0
- package/src/doxygen/data-model/compounds/concepts-dm.ts +362 -0
- package/src/doxygen/data-model/compounds/descriptiontype-dm.ts +10114 -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 +881 -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/requirements-dm.ts +50 -0
- package/src/doxygen/data-model/compounds/sectiondeftype-dm.ts +330 -0
- package/src/doxygen/data-model/compounds/tableofcontentstype-dm.ts +564 -0
- package/src/doxygen/data-model/compounds/templateparamlisttype-dm.ts +150 -0
- package/src/doxygen/data-model/data-model.ts +378 -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 +1788 -0
- package/src/doxygen/data-model/xsds/doxyfile.xsd +365 -0
- package/src/doxygen/data-model/xsds/index.xsd +74 -0
- package/src/doxygen/data-model/xsds/xml.xsd +23 -0
- package/src/index.ts +267 -0
- package/src/tsconfig.json +12 -0
- package/dist/doxygen2docusaurus.d.ts +0 -4774
- package/dist/tsconfig.tsbuildinfo +0 -1
- package/dist/tsdoc-metadata.json +0 -11
|
@@ -1,187 +1,22 @@
|
|
|
1
1
|
import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
|
|
2
2
|
import { AbstractDataModelBase } from '../types.js';
|
|
3
3
|
import { ListItemDataModel, TermDataModel } from './descriptiontype-dm.js';
|
|
4
|
-
/**
|
|
5
|
-
* Abstract base class for variable list entry elements within documentation.
|
|
6
|
-
*
|
|
7
|
-
* @remarks
|
|
8
|
-
* Implements processing for variable list entry elements that contain terms
|
|
9
|
-
* within definition lists and variable list structures. This class handles
|
|
10
|
-
* the XML Schema definition for docVarListEntryType elements, which consist
|
|
11
|
-
* of a mandatory term element that provides the definition term for variable
|
|
12
|
-
* list items.
|
|
13
|
-
*
|
|
14
|
-
* The implementation processes term elements using the TermDataModel to
|
|
15
|
-
* maintain proper structure for definition lists and glossary entries within
|
|
16
|
-
* the documentation system.
|
|
17
|
-
*
|
|
18
|
-
* @public
|
|
19
|
-
*/
|
|
20
4
|
export declare abstract class AbstractDocVarListEntryType extends AbstractDataModelBase {
|
|
21
|
-
/**
|
|
22
|
-
* The term element that defines the term for this variable list entry.
|
|
23
|
-
*
|
|
24
|
-
* @remarks
|
|
25
|
-
* Contains the term data model that represents the definition term within
|
|
26
|
-
* variable lists. This mandatory element provides the term portion of
|
|
27
|
-
* term-definition pairs within definition lists and glossary structures.
|
|
28
|
-
*/
|
|
29
5
|
term: TermDataModel | undefined;
|
|
30
|
-
/**
|
|
31
|
-
* Constructs an AbstractDocVarListEntryType instance from XML element data.
|
|
32
|
-
*
|
|
33
|
-
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
34
|
-
* @param element - The XML element object containing the list entry data
|
|
35
|
-
* @param elementName - The name of the XML element being processed
|
|
36
|
-
*
|
|
37
|
-
* @remarks
|
|
38
|
-
* This constructor processes variable list entry elements by extracting
|
|
39
|
-
* the mandatory term element. The parser ensures proper validation of
|
|
40
|
-
* the term element and maintains compliance with the XML Schema definition
|
|
41
|
-
* for variable list entry structures within documentation systems.
|
|
42
|
-
*/
|
|
43
6
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
44
7
|
}
|
|
45
|
-
/**
|
|
46
|
-
* Data model for variable list entry elements within documentation content.
|
|
47
|
-
*
|
|
48
|
-
* @remarks
|
|
49
|
-
* Represents variable list entry elements that provide the term portion
|
|
50
|
-
* of definition lists and variable list structures. This implementation
|
|
51
|
-
* processes Doxygen's varlistentry elements, which contain terms that
|
|
52
|
-
* are paired with list items to form complete definition entries within
|
|
53
|
-
* variable list documentation structures.
|
|
54
|
-
*
|
|
55
|
-
* @public
|
|
56
|
-
*/
|
|
57
8
|
export declare class VarListEntryDataModel extends AbstractDocVarListEntryType {
|
|
58
|
-
/**
|
|
59
|
-
* Constructs a VarListEntryDataModel from XML element data.
|
|
60
|
-
*
|
|
61
|
-
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
62
|
-
* @param element - The XML element object containing the varlistentry data
|
|
63
|
-
*
|
|
64
|
-
* @remarks
|
|
65
|
-
* This constructor delegates to the parent AbstractDocVarListEntryType to
|
|
66
|
-
* handle variable list entry processing whilst identifying the element as
|
|
67
|
-
* 'varlistentry' for proper XML schema compliance and term extraction.
|
|
68
|
-
*/
|
|
69
9
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
70
10
|
}
|
|
71
|
-
/**
|
|
72
|
-
* Data model for variable list pair elements within documentation content.
|
|
73
|
-
*
|
|
74
|
-
* @remarks
|
|
75
|
-
* Represents the pairing of variable list entries with their corresponding
|
|
76
|
-
* list items to form complete definition pairs within variable lists. This
|
|
77
|
-
* class encapsulates the relationship between terms and their definitions,
|
|
78
|
-
* as the XML Schema defines variable lists as sequences of varlistentry
|
|
79
|
-
* and listitem pairs but does not provide an explicit container element.
|
|
80
|
-
*
|
|
81
|
-
* This implementation creates a logical pairing structure to maintain the
|
|
82
|
-
* association between terms and their corresponding definitions within
|
|
83
|
-
* variable list documentation structures.
|
|
84
|
-
*
|
|
85
|
-
* @public
|
|
86
|
-
*/
|
|
87
11
|
export declare class VariableListPairDataModel extends AbstractDataModelBase {
|
|
88
|
-
/**
|
|
89
|
-
* The variable list entry containing the term for this definition pair.
|
|
90
|
-
*
|
|
91
|
-
* @remarks
|
|
92
|
-
* Contains the term portion of the definition pair, representing the
|
|
93
|
-
* item being defined within the variable list structure.
|
|
94
|
-
*/
|
|
95
12
|
varlistentry: VarListEntryDataModel;
|
|
96
|
-
/**
|
|
97
|
-
* The list item containing the definition for this definition pair.
|
|
98
|
-
*
|
|
99
|
-
* @remarks
|
|
100
|
-
* Contains the definition portion of the definition pair, providing
|
|
101
|
-
* the explanatory content for the associated term within the variable
|
|
102
|
-
* list structure.
|
|
103
|
-
*/
|
|
104
13
|
listitem: ListItemDataModel;
|
|
105
|
-
/**
|
|
106
|
-
* Constructs a VariableListPairDataModel from entry and item components.
|
|
107
|
-
*
|
|
108
|
-
* @param varlistentry - The variable list entry containing the term
|
|
109
|
-
* @param listitem - The list item containing the definition content
|
|
110
|
-
*
|
|
111
|
-
* @remarks
|
|
112
|
-
* This constructor creates a logical pairing between a variable list
|
|
113
|
-
* entry and its corresponding list item to form a complete definition
|
|
114
|
-
* pair. This maintains the semantic relationship between terms and
|
|
115
|
-
* definitions within variable list structures.
|
|
116
|
-
*/
|
|
117
14
|
constructor(varlistentry: VarListEntryDataModel, listitem: ListItemDataModel);
|
|
118
15
|
}
|
|
119
|
-
/**
|
|
120
|
-
* Abstract base class for variable list elements within documentation content.
|
|
121
|
-
*
|
|
122
|
-
* @remarks
|
|
123
|
-
* Implements processing for variable list elements that contain sequences
|
|
124
|
-
* of term-definition pairs within documentation structures. This class
|
|
125
|
-
* handles the XML Schema definition for docVariableListType elements,
|
|
126
|
-
* which consist of repeated variable list groups containing varlistentry
|
|
127
|
-
* and listitem pairs.
|
|
128
|
-
*
|
|
129
|
-
* The implementation processes these pairs sequentially, creating
|
|
130
|
-
* VariableListPairDataModel instances to maintain the logical relationship
|
|
131
|
-
* between terms and their corresponding definitions. The parser expects
|
|
132
|
-
* alternating varlistentry and listitem elements in the correct order
|
|
133
|
-
* to form proper definition pairs.
|
|
134
|
-
*
|
|
135
|
-
* @public
|
|
136
|
-
*/
|
|
137
16
|
export declare abstract class AbstractDocVariableListType extends AbstractDataModelBase {
|
|
138
|
-
/**
|
|
139
|
-
* Constructs an AbstractDocVariableListType instance from XML element data.
|
|
140
|
-
*
|
|
141
|
-
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
142
|
-
* @param element - The XML element object containing the variable list data
|
|
143
|
-
* @param elementName - The name of the XML element being processed
|
|
144
|
-
*
|
|
145
|
-
* @remarks
|
|
146
|
-
* This constructor processes variable list elements by extracting pairs
|
|
147
|
-
* of varlistentry and listitem elements in the expected sequence order.
|
|
148
|
-
* The parser creates VariableListPairDataModel instances to maintain
|
|
149
|
-
* the semantic relationship between terms and their definitions whilst
|
|
150
|
-
* ensuring proper XML schema compliance for variable list structures.
|
|
151
|
-
*
|
|
152
|
-
* The implementation expects alternating varlistentry and listitem
|
|
153
|
-
* elements and validates this sequence to ensure proper definition
|
|
154
|
-
* pair formation within the variable list documentation structure.
|
|
155
|
-
*/
|
|
156
17
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
157
18
|
}
|
|
158
|
-
/**
|
|
159
|
-
* Data model for variable list elements within documentation content.
|
|
160
|
-
*
|
|
161
|
-
* @remarks
|
|
162
|
-
* Represents variable list elements that provide definition list structures
|
|
163
|
-
* within documentation. This implementation processes Doxygen's variablelist
|
|
164
|
-
* elements, which contain sequences of term-definition pairs for creating
|
|
165
|
-
* glossaries, definition lists, and other structured reference content.
|
|
166
|
-
*
|
|
167
|
-
* The variable list maintains proper pairing between terms and their
|
|
168
|
-
* corresponding definitions through VariableListPairDataModel instances.
|
|
169
|
-
*
|
|
170
|
-
* @public
|
|
171
|
-
*/
|
|
172
19
|
export declare class VariableListDataModel extends AbstractDocVariableListType {
|
|
173
|
-
/**
|
|
174
|
-
* Constructs a VariableListDataModel from XML element data.
|
|
175
|
-
*
|
|
176
|
-
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
177
|
-
* @param element - The XML element object containing the variablelist data
|
|
178
|
-
*
|
|
179
|
-
* @remarks
|
|
180
|
-
* This constructor delegates to the parent AbstractDocVariableListType to
|
|
181
|
-
* handle variable list processing whilst identifying the element as
|
|
182
|
-
* 'variablelist' for proper XML schema compliance and definition pair
|
|
183
|
-
* extraction within documentation structures.
|
|
184
|
-
*/
|
|
185
20
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
186
21
|
}
|
|
187
22
|
//# sourceMappingURL=docvarlistentrytype-dm.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docvarlistentrytype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/docvarlistentrytype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;
|
|
1
|
+
{"version":3,"file":"docvarlistentrytype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/docvarlistentrytype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AA2B1E,8BAAsB,2BAA4B,SAAQ,qBAAqB;IAU7E,IAAI,EAAE,aAAa,GAAG,SAAS,CAAA;gBAenB,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAwCxE;AAkBD,qBAAa,qBAAsB,SAAQ,2BAA2B;gBAYxD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AA4BD,qBAAa,yBAA0B,SAAQ,qBAAqB;IAQlE,YAAY,EAAE,qBAAqB,CAAA;IAUnC,QAAQ,EAAE,iBAAiB,CAAA;gBAezB,YAAY,EAAE,qBAAqB,EACnC,QAAQ,EAAE,iBAAiB;CAO9B;AA6BD,8BAAsB,2BAA4B,SAAQ,qBAAqB;gBAqBjE,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAmDxE;AAoBD,qBAAa,qBAAsB,SAAQ,2BAA2B;gBAaxD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
|
|
@@ -1,77 +1,15 @@
|
|
|
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
4
|
import { ListItemDataModel, TermDataModel } from './descriptiontype-dm.js';
|
|
16
|
-
// ----------------------------------------------------------------------------
|
|
17
|
-
// <xsd:complexType name="docVarListEntryType">
|
|
18
|
-
// <xsd:sequence>
|
|
19
|
-
// <xsd:element name="term" type="docTitleType" />
|
|
20
|
-
// </xsd:sequence>
|
|
21
|
-
// </xsd:complexType>
|
|
22
|
-
/**
|
|
23
|
-
* Abstract base class for variable list entry elements within documentation.
|
|
24
|
-
*
|
|
25
|
-
* @remarks
|
|
26
|
-
* Implements processing for variable list entry elements that contain terms
|
|
27
|
-
* within definition lists and variable list structures. This class handles
|
|
28
|
-
* the XML Schema definition for docVarListEntryType elements, which consist
|
|
29
|
-
* of a mandatory term element that provides the definition term for variable
|
|
30
|
-
* list items.
|
|
31
|
-
*
|
|
32
|
-
* The implementation processes term elements using the TermDataModel to
|
|
33
|
-
* maintain proper structure for definition lists and glossary entries within
|
|
34
|
-
* the documentation system.
|
|
35
|
-
*
|
|
36
|
-
* @public
|
|
37
|
-
*/
|
|
38
|
-
// eslint-disable-next-line max-len
|
|
39
5
|
export class AbstractDocVarListEntryType extends AbstractDataModelBase {
|
|
40
|
-
/**
|
|
41
|
-
* The term element that defines the term for this variable list entry.
|
|
42
|
-
*
|
|
43
|
-
* @remarks
|
|
44
|
-
* Contains the term data model that represents the definition term within
|
|
45
|
-
* variable lists. This mandatory element provides the term portion of
|
|
46
|
-
* term-definition pairs within definition lists and glossary structures.
|
|
47
|
-
*/
|
|
48
|
-
// Mandatory elements.
|
|
49
6
|
term;
|
|
50
|
-
/**
|
|
51
|
-
* Constructs an AbstractDocVarListEntryType instance from XML element data.
|
|
52
|
-
*
|
|
53
|
-
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
54
|
-
* @param element - The XML element object containing the list entry data
|
|
55
|
-
* @param elementName - The name of the XML element being processed
|
|
56
|
-
*
|
|
57
|
-
* @remarks
|
|
58
|
-
* This constructor processes variable list entry elements by extracting
|
|
59
|
-
* the mandatory term element. The parser ensures proper validation of
|
|
60
|
-
* the term element and maintains compliance with the XML Schema definition
|
|
61
|
-
* for variable list entry structures within documentation systems.
|
|
62
|
-
*/
|
|
63
7
|
constructor(xml, element, elementName) {
|
|
64
8
|
super(elementName);
|
|
65
|
-
// console.log(elementName, util.inspect(element,
|
|
66
|
-
// { compact: false, depth: 999 }))
|
|
67
|
-
// ------------------------------------------------------------------------
|
|
68
|
-
// Process elements.
|
|
69
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 })
|
|
70
9
|
const innerElements = xml.getInnerElements(element, elementName);
|
|
71
10
|
assert(innerElements.length > 0);
|
|
72
11
|
for (const innerElement of innerElements) {
|
|
73
12
|
if (xml.hasInnerText(innerElement)) {
|
|
74
|
-
// Ignore texts.
|
|
75
13
|
}
|
|
76
14
|
else if (xml.hasInnerElement(innerElement, 'term')) {
|
|
77
15
|
assert(this.term === undefined);
|
|
@@ -82,165 +20,32 @@ export class AbstractDocVarListEntryType extends AbstractDataModelBase {
|
|
|
82
20
|
}
|
|
83
21
|
}
|
|
84
22
|
assert(this.term !== undefined);
|
|
85
|
-
// ------------------------------------------------------------------------
|
|
86
|
-
// Process attributes.
|
|
87
23
|
assert(!xml.hasAttributes(element));
|
|
88
|
-
// ------------------------------------------------------------------------
|
|
89
|
-
// console.log(util.inspect(this, { compact: false, depth: 999 }))
|
|
90
24
|
}
|
|
91
25
|
}
|
|
92
|
-
// ----------------------------------------------------------------------------
|
|
93
|
-
// <xsd:element name="varlistentry" type="docVarListEntryType" />
|
|
94
|
-
/**
|
|
95
|
-
* Data model for variable list entry elements within documentation content.
|
|
96
|
-
*
|
|
97
|
-
* @remarks
|
|
98
|
-
* Represents variable list entry elements that provide the term portion
|
|
99
|
-
* of definition lists and variable list structures. This implementation
|
|
100
|
-
* processes Doxygen's varlistentry elements, which contain terms that
|
|
101
|
-
* are paired with list items to form complete definition entries within
|
|
102
|
-
* variable list documentation structures.
|
|
103
|
-
*
|
|
104
|
-
* @public
|
|
105
|
-
*/
|
|
106
26
|
export class VarListEntryDataModel extends AbstractDocVarListEntryType {
|
|
107
|
-
/**
|
|
108
|
-
* Constructs a VarListEntryDataModel from XML element data.
|
|
109
|
-
*
|
|
110
|
-
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
111
|
-
* @param element - The XML element object containing the varlistentry data
|
|
112
|
-
*
|
|
113
|
-
* @remarks
|
|
114
|
-
* This constructor delegates to the parent AbstractDocVarListEntryType to
|
|
115
|
-
* handle variable list entry processing whilst identifying the element as
|
|
116
|
-
* 'varlistentry' for proper XML schema compliance and term extraction.
|
|
117
|
-
*/
|
|
118
27
|
constructor(xml, element) {
|
|
119
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
120
28
|
super(xml, element, 'varlistentry');
|
|
121
29
|
}
|
|
122
30
|
}
|
|
123
|
-
// ----------------------------------------------------------------------------
|
|
124
|
-
// WARNING: the DTD does not define an explicit pair.
|
|
125
|
-
// <xsd:group name="docVariableListGroup">
|
|
126
|
-
// <xsd:sequence>
|
|
127
|
-
// <xsd:element name="varlistentry" type="docVarListEntryType" />
|
|
128
|
-
// <xsd:element name="listitem" type="docListItemType" />
|
|
129
|
-
// </xsd:sequence>
|
|
130
|
-
// </xsd:group>
|
|
131
|
-
/**
|
|
132
|
-
* Data model for variable list pair elements within documentation content.
|
|
133
|
-
*
|
|
134
|
-
* @remarks
|
|
135
|
-
* Represents the pairing of variable list entries with their corresponding
|
|
136
|
-
* list items to form complete definition pairs within variable lists. This
|
|
137
|
-
* class encapsulates the relationship between terms and their definitions,
|
|
138
|
-
* as the XML Schema defines variable lists as sequences of varlistentry
|
|
139
|
-
* and listitem pairs but does not provide an explicit container element.
|
|
140
|
-
*
|
|
141
|
-
* This implementation creates a logical pairing structure to maintain the
|
|
142
|
-
* association between terms and their corresponding definitions within
|
|
143
|
-
* variable list documentation structures.
|
|
144
|
-
*
|
|
145
|
-
* @public
|
|
146
|
-
*/
|
|
147
31
|
export class VariableListPairDataModel extends AbstractDataModelBase {
|
|
148
|
-
/**
|
|
149
|
-
* The variable list entry containing the term for this definition pair.
|
|
150
|
-
*
|
|
151
|
-
* @remarks
|
|
152
|
-
* Contains the term portion of the definition pair, representing the
|
|
153
|
-
* item being defined within the variable list structure.
|
|
154
|
-
*/
|
|
155
32
|
varlistentry;
|
|
156
|
-
/**
|
|
157
|
-
* The list item containing the definition for this definition pair.
|
|
158
|
-
*
|
|
159
|
-
* @remarks
|
|
160
|
-
* Contains the definition portion of the definition pair, providing
|
|
161
|
-
* the explanatory content for the associated term within the variable
|
|
162
|
-
* list structure.
|
|
163
|
-
*/
|
|
164
33
|
listitem;
|
|
165
|
-
/**
|
|
166
|
-
* Constructs a VariableListPairDataModel from entry and item components.
|
|
167
|
-
*
|
|
168
|
-
* @param varlistentry - The variable list entry containing the term
|
|
169
|
-
* @param listitem - The list item containing the definition content
|
|
170
|
-
*
|
|
171
|
-
* @remarks
|
|
172
|
-
* This constructor creates a logical pairing between a variable list
|
|
173
|
-
* entry and its corresponding list item to form a complete definition
|
|
174
|
-
* pair. This maintains the semantic relationship between terms and
|
|
175
|
-
* definitions within variable list structures.
|
|
176
|
-
*/
|
|
177
34
|
constructor(varlistentry, listitem) {
|
|
178
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
179
35
|
super('variablelistpair');
|
|
180
36
|
this.varlistentry = varlistentry;
|
|
181
37
|
this.listitem = listitem;
|
|
182
38
|
}
|
|
183
39
|
}
|
|
184
|
-
// ----------------------------------------------------------------------------
|
|
185
|
-
// <xsd:complexType name="docVariableListType">
|
|
186
|
-
// <xsd:sequence>
|
|
187
|
-
// <xsd:group ref="docVariableListGroup" maxOccurs="unbounded" />
|
|
188
|
-
// </xsd:sequence>
|
|
189
|
-
// </xsd:complexType>
|
|
190
|
-
/**
|
|
191
|
-
* Abstract base class for variable list elements within documentation content.
|
|
192
|
-
*
|
|
193
|
-
* @remarks
|
|
194
|
-
* Implements processing for variable list elements that contain sequences
|
|
195
|
-
* of term-definition pairs within documentation structures. This class
|
|
196
|
-
* handles the XML Schema definition for docVariableListType elements,
|
|
197
|
-
* which consist of repeated variable list groups containing varlistentry
|
|
198
|
-
* and listitem pairs.
|
|
199
|
-
*
|
|
200
|
-
* The implementation processes these pairs sequentially, creating
|
|
201
|
-
* VariableListPairDataModel instances to maintain the logical relationship
|
|
202
|
-
* between terms and their corresponding definitions. The parser expects
|
|
203
|
-
* alternating varlistentry and listitem elements in the correct order
|
|
204
|
-
* to form proper definition pairs.
|
|
205
|
-
*
|
|
206
|
-
* @public
|
|
207
|
-
*/
|
|
208
|
-
// eslint-disable-next-line max-len
|
|
209
40
|
export class AbstractDocVariableListType extends AbstractDataModelBase {
|
|
210
|
-
/**
|
|
211
|
-
* Constructs an AbstractDocVariableListType instance from XML element data.
|
|
212
|
-
*
|
|
213
|
-
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
214
|
-
* @param element - The XML element object containing the variable list data
|
|
215
|
-
* @param elementName - The name of the XML element being processed
|
|
216
|
-
*
|
|
217
|
-
* @remarks
|
|
218
|
-
* This constructor processes variable list elements by extracting pairs
|
|
219
|
-
* of varlistentry and listitem elements in the expected sequence order.
|
|
220
|
-
* The parser creates VariableListPairDataModel instances to maintain
|
|
221
|
-
* the semantic relationship between terms and their definitions whilst
|
|
222
|
-
* ensuring proper XML schema compliance for variable list structures.
|
|
223
|
-
*
|
|
224
|
-
* The implementation expects alternating varlistentry and listitem
|
|
225
|
-
* elements and validates this sequence to ensure proper definition
|
|
226
|
-
* pair formation within the variable list documentation structure.
|
|
227
|
-
*/
|
|
228
|
-
// children: VariableListPairDataModel[] = []
|
|
229
41
|
constructor(xml, element, elementName) {
|
|
230
42
|
super(elementName);
|
|
231
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
232
|
-
// ------------------------------------------------------------------------
|
|
233
|
-
// Process elements.
|
|
234
43
|
const innerElements = xml.getInnerElements(element, elementName);
|
|
235
44
|
assert(innerElements.length > 0);
|
|
236
45
|
this.children = [];
|
|
237
46
|
let varlistentry;
|
|
238
47
|
for (const innerElement of innerElements) {
|
|
239
|
-
// console.log('innerElement:', innerElement)
|
|
240
|
-
// WARNING: this is not ok, since it depends on the order, it expects
|
|
241
|
-
// pairs of varlistentry and listitem, in this order.
|
|
242
48
|
if (xml.hasInnerText(innerElement)) {
|
|
243
|
-
// Ignore texts.
|
|
244
49
|
}
|
|
245
50
|
else if (xml.hasInnerElement(innerElement, 'varlistentry')) {
|
|
246
51
|
varlistentry = new VarListEntryDataModel(xml, innerElement);
|
|
@@ -256,46 +61,12 @@ export class AbstractDocVariableListType extends AbstractDataModelBase {
|
|
|
256
61
|
console.error(`${elementName} element:`, Object.keys(innerElement), 'not implemented yet in', this.constructor.name);
|
|
257
62
|
}
|
|
258
63
|
}
|
|
259
|
-
// ------------------------------------------------------------------------
|
|
260
|
-
// Process attributes.
|
|
261
64
|
assert(!xml.hasAttributes(element));
|
|
262
|
-
// ------------------------------------------------------------------------
|
|
263
|
-
// console.log(util.inspect(this, { compact: false, depth: 999 }))
|
|
264
65
|
}
|
|
265
66
|
}
|
|
266
|
-
// ----------------------------------------------------------------------------
|
|
267
|
-
// <xsd:element name="variablelist" type="docVariableListType" />
|
|
268
|
-
/**
|
|
269
|
-
* Data model for variable list elements within documentation content.
|
|
270
|
-
*
|
|
271
|
-
* @remarks
|
|
272
|
-
* Represents variable list elements that provide definition list structures
|
|
273
|
-
* within documentation. This implementation processes Doxygen's variablelist
|
|
274
|
-
* elements, which contain sequences of term-definition pairs for creating
|
|
275
|
-
* glossaries, definition lists, and other structured reference content.
|
|
276
|
-
*
|
|
277
|
-
* The variable list maintains proper pairing between terms and their
|
|
278
|
-
* corresponding definitions through VariableListPairDataModel instances.
|
|
279
|
-
*
|
|
280
|
-
* @public
|
|
281
|
-
*/
|
|
282
67
|
export class VariableListDataModel extends AbstractDocVariableListType {
|
|
283
|
-
/**
|
|
284
|
-
* Constructs a VariableListDataModel from XML element data.
|
|
285
|
-
*
|
|
286
|
-
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
287
|
-
* @param element - The XML element object containing the variablelist data
|
|
288
|
-
*
|
|
289
|
-
* @remarks
|
|
290
|
-
* This constructor delegates to the parent AbstractDocVariableListType to
|
|
291
|
-
* handle variable list processing whilst identifying the element as
|
|
292
|
-
* 'variablelist' for proper XML schema compliance and definition pair
|
|
293
|
-
* extraction within documentation structures.
|
|
294
|
-
*/
|
|
295
68
|
constructor(xml, element) {
|
|
296
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
297
69
|
super(xml, element, 'variablelist');
|
|
298
70
|
}
|
|
299
71
|
}
|
|
300
|
-
// ----------------------------------------------------------------------------
|
|
301
72
|
//# sourceMappingURL=docvarlistentrytype-dm.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docvarlistentrytype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/docvarlistentrytype-dm.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"docvarlistentrytype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/docvarlistentrytype-dm.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AA2B1E,MAAM,OAAgB,2BAA4B,SAAQ,qBAAqB;IAU7E,IAAI,CAA2B;IAe/B,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QASlB,MAAM,aAAa,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAChE,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAEhC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;YAErC,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC;gBACrD,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAA;gBAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;YAClD,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,WAAW,EACzB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAA;QAK/B,MAAM,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;IAKrC,CAAC;CACF;AAkBD,MAAM,OAAO,qBAAsB,SAAQ,2BAA2B;IAYpE,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;IACrC,CAAC;CACF;AA4BD,MAAM,OAAO,yBAA0B,SAAQ,qBAAqB;IAQlE,YAAY,CAAuB;IAUnC,QAAQ,CAAmB;IAc3B,YACE,YAAmC,EACnC,QAA2B;QAG3B,KAAK,CAAC,kBAAkB,CAAC,CAAA;QACzB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;QAChC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AA6BD,MAAM,OAAgB,2BAA4B,SAAQ,qBAAqB;IAqB7E,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAOlB,MAAM,aAAa,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAChE,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAEhC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAElB,IAAI,YAA+C,CAAA;QACnD,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YAIzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;YAErC,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,cAAc,CAAC,EAAE,CAAC;gBAC7D,YAAY,GAAG,IAAI,qBAAqB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;YAC7D,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,UAAU,CAAC,EAAE,CAAC;gBACzD,MAAM,QAAQ,GAAG,IAAI,iBAAiB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;gBACzD,MAAM,CAAC,YAAY,KAAK,SAAS,CAAC,CAAA;gBAClC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChB,IAAI,yBAAyB,CAAC,YAAY,EAAE,QAAQ,CAAC,CACtD,CAAA;gBACD,YAAY,GAAG,SAAS,CAAA;YAC1B,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CACX,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAC3D,CAAA;gBACD,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,WAAW,EACzB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAKD,MAAM,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;IAKrC,CAAC;CACF;AAoBD,MAAM,OAAO,qBAAsB,SAAQ,2BAA2B;IAapE,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;IACrC,CAAC;CACF"}
|
|
@@ -1,84 +1,14 @@
|
|
|
1
1
|
import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
|
|
2
2
|
import { CompoundDefDataModel } from './compounddef-dm.js';
|
|
3
3
|
import { AbstractDataModelBase } from '../types.js';
|
|
4
|
-
/**
|
|
5
|
-
* Abstract base class for the root Doxygen document type.
|
|
6
|
-
*
|
|
7
|
-
* @remarks
|
|
8
|
-
* Represents the top-level Doxygen XML document structure containing
|
|
9
|
-
* compound definitions and document metadata. This is the root element
|
|
10
|
-
* that contains all other documentation elements parsed from Doxygen XML.
|
|
11
|
-
*
|
|
12
|
-
* @public
|
|
13
|
-
*/
|
|
14
4
|
export declare abstract class AbstractDoxygenType extends AbstractDataModelBase {
|
|
15
|
-
/**
|
|
16
|
-
* The version of Doxygen that generated the XML.
|
|
17
|
-
*
|
|
18
|
-
* @remarks
|
|
19
|
-
* Version string indicating which Doxygen version was used to
|
|
20
|
-
* generate the XML output, useful for compatibility checking.
|
|
21
|
-
*/
|
|
22
5
|
version: string;
|
|
23
|
-
/**
|
|
24
|
-
* The language code for the documentation.
|
|
25
|
-
*
|
|
26
|
-
* @remarks
|
|
27
|
-
* XML language attribute indicating the primary language used
|
|
28
|
-
* in the documentation content.
|
|
29
|
-
*/
|
|
30
6
|
lang: string;
|
|
31
|
-
/**
|
|
32
|
-
* Array of compound definition data models.
|
|
33
|
-
*
|
|
34
|
-
* @remarks
|
|
35
|
-
* Contains all the compound definitions (classes, files, namespaces, etc.)
|
|
36
|
-
* that are documented within this Doxygen XML file. This is the main
|
|
37
|
-
* content of the documentation.
|
|
38
|
-
*/
|
|
39
7
|
compoundDefs?: CompoundDefDataModel[] | undefined;
|
|
40
|
-
/**
|
|
41
|
-
* XML schema location when no namespace is specified.
|
|
42
|
-
*
|
|
43
|
-
* @remarks
|
|
44
|
-
* Optional attribute specifying the schema location for XML
|
|
45
|
-
* validation when no explicit namespace is used.
|
|
46
|
-
*/
|
|
47
8
|
noNamespaceSchemaLocation?: string | undefined;
|
|
48
|
-
/**
|
|
49
|
-
* Creates a new Doxygen document data model from XML.
|
|
50
|
-
*
|
|
51
|
-
* @remarks
|
|
52
|
-
* Parses the root XML element representing a Doxygen document and
|
|
53
|
-
* extracts all compound definitions and metadata attributes.
|
|
54
|
-
*
|
|
55
|
-
* @param xml - The XML parser instance
|
|
56
|
-
* @param element - The XML element to parse
|
|
57
|
-
* @param elementName - The name of the XML element
|
|
58
|
-
*/
|
|
59
9
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
60
10
|
}
|
|
61
|
-
/**
|
|
62
|
-
* Concrete implementation of the Doxygen document data model.
|
|
63
|
-
*
|
|
64
|
-
* @remarks
|
|
65
|
-
* Represents the root doxygen element in Doxygen XML files. Inherits
|
|
66
|
-
* all functionality from the abstract base class and provides the
|
|
67
|
-
* specific element name for parsing.
|
|
68
|
-
*
|
|
69
|
-
* @public
|
|
70
|
-
*/
|
|
71
11
|
export declare class DoxygenDataModel extends AbstractDoxygenType {
|
|
72
|
-
/**
|
|
73
|
-
* Creates a new Doxygen document data model from XML.
|
|
74
|
-
*
|
|
75
|
-
* @remarks
|
|
76
|
-
* Parses the XML element representing the root doxygen element using
|
|
77
|
-
* the inherited parsing logic with the 'doxygen' element name.
|
|
78
|
-
*
|
|
79
|
-
* @param xml - The XML parser instance
|
|
80
|
-
* @param element - The XML element to parse
|
|
81
|
-
*/
|
|
82
12
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
83
13
|
}
|
|
84
14
|
//# sourceMappingURL=doxygentype-dm.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"doxygentype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/doxygentype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"doxygentype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/doxygentype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAsBnD,8BAAsB,mBAAoB,SAAQ,qBAAqB;IASrE,OAAO,SAAK;IASZ,IAAI,SAAK;IAWT,YAAY,CAAC,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAA;IAUjD,yBAAyB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;gBAalC,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA6DxE;AAgBD,qBAAa,gBAAiB,SAAQ,mBAAmB;gBAW3C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
|