@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,87 +1,11 @@
|
|
|
1
1
|
import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
|
|
2
2
|
import { MemberRefDataModel } from './memberreftype-dm.js';
|
|
3
3
|
import { AbstractDataModelBase } from '../types.js';
|
|
4
|
-
/**
|
|
5
|
-
* Abstract base class for list-of-all-members elements within documentation.
|
|
6
|
-
*
|
|
7
|
-
* @remarks
|
|
8
|
-
* Implements processing for list-of-all-members elements that contain
|
|
9
|
-
* comprehensive member reference collections within class and compound
|
|
10
|
-
* documentation. This class handles the XML Schema definition for
|
|
11
|
-
* listofallmembersType elements, which provide complete inventories of
|
|
12
|
-
* all members (including inherited members) associated with classes,
|
|
13
|
-
* structures, and other compound types.
|
|
14
|
-
*
|
|
15
|
-
* The implementation processes sequences of member reference elements,
|
|
16
|
-
* creating MemberRefDataModel instances to maintain detailed information
|
|
17
|
-
* about each member's identity, scope, and accessibility within the
|
|
18
|
-
* compound's complete member hierarchy.
|
|
19
|
-
*
|
|
20
|
-
* @public
|
|
21
|
-
*/
|
|
22
4
|
export declare abstract class AbstractListOfAllMembersType extends AbstractDataModelBase {
|
|
23
|
-
/**
|
|
24
|
-
* Collection of member reference elements within the list-of-all-members.
|
|
25
|
-
*
|
|
26
|
-
* @remarks
|
|
27
|
-
* Contains processed member reference data models representing all members
|
|
28
|
-
* associated with the compound, including both directly declared and
|
|
29
|
-
* inherited members. Each reference provides comprehensive identification
|
|
30
|
-
* and scope information for the corresponding member element.
|
|
31
|
-
*
|
|
32
|
-
* @public
|
|
33
|
-
*/
|
|
34
5
|
memberRefs?: MemberRefDataModel[] | undefined;
|
|
35
|
-
/**
|
|
36
|
-
* Constructs a new list-of-all-members data model instance.
|
|
37
|
-
*
|
|
38
|
-
* @param xml - The XML parser instance for processing elements
|
|
39
|
-
* @param element - The source XML element containing list-of-all-members data
|
|
40
|
-
* @param elementName - The name of the XML element being processed
|
|
41
|
-
*
|
|
42
|
-
* @remarks
|
|
43
|
-
* Processes the XML element to extract and organise member reference
|
|
44
|
-
* information, creating appropriate data model instances for each
|
|
45
|
-
* member entry found within the comprehensive member listing.
|
|
46
|
-
* The constructor validates the element structure and ensures
|
|
47
|
-
* all member references are properly instantiated.
|
|
48
|
-
*
|
|
49
|
-
* @public
|
|
50
|
-
*/
|
|
51
6
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
52
7
|
}
|
|
53
|
-
/**
|
|
54
|
-
* Concrete implementation for listofallmembers elements within compound
|
|
55
|
-
* documentation.
|
|
56
|
-
*
|
|
57
|
-
* @remarks
|
|
58
|
-
* Provides specific handling for listofallmembers XML elements that contain
|
|
59
|
-
* comprehensive member inventories within class and compound documentation.
|
|
60
|
-
* This implementation extends the abstract base class functionality to
|
|
61
|
-
* process the complete collection of member references, including both
|
|
62
|
-
* directly declared and inherited members.
|
|
63
|
-
*
|
|
64
|
-
* The class ensures proper instantiation of member reference data models
|
|
65
|
-
* whilst maintaining the hierarchical structure and accessibility information
|
|
66
|
-
* required for comprehensive documentation generation.
|
|
67
|
-
*
|
|
68
|
-
* @public
|
|
69
|
-
*/
|
|
70
8
|
export declare class ListOfAllMembersDataModel extends AbstractListOfAllMembersType {
|
|
71
|
-
/**
|
|
72
|
-
* Constructs a new listofallmembers data model instance.
|
|
73
|
-
*
|
|
74
|
-
* @param xml - The XML parser instance for processing elements
|
|
75
|
-
* @param element - The source XML element containing listofallmembers data
|
|
76
|
-
*
|
|
77
|
-
* @remarks
|
|
78
|
-
* Initialises the data model with the specific element name
|
|
79
|
-
* 'listofallmembers' and delegates processing to the abstract base class
|
|
80
|
-
* implementation. This ensures consistent handling of member reference
|
|
81
|
-
* collections whilst maintaining proper element identification.
|
|
82
|
-
*
|
|
83
|
-
* @public
|
|
84
|
-
*/
|
|
85
9
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
86
10
|
}
|
|
87
11
|
//# sourceMappingURL=listofallmemberstype-dm.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"listofallmemberstype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/listofallmemberstype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"listofallmemberstype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/listofallmemberstype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA6BnD,8BAAsB,4BAA6B,SAAQ,qBAAqB;IAY9E,UAAU,CAAC,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAA;gBAkBjC,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAsCxE;AAuBD,qBAAa,yBAA0B,SAAQ,4BAA4B;gBAe7D,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
|
|
@@ -1,83 +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 * as util from 'node:util';
|
|
14
3
|
import { MemberRefDataModel } from './memberreftype-dm.js';
|
|
15
4
|
import { AbstractDataModelBase } from '../types.js';
|
|
16
|
-
// ----------------------------------------------------------------------------
|
|
17
|
-
// <xsd:complexType name="listofallmembersType">
|
|
18
|
-
// <xsd:sequence>
|
|
19
|
-
// <xsd:element name="member" type="memberRefType" minOccurs="0" maxOccurs="unbounded" />
|
|
20
|
-
// </xsd:sequence>
|
|
21
|
-
// </xsd:complexType>
|
|
22
|
-
/**
|
|
23
|
-
* Abstract base class for list-of-all-members elements within documentation.
|
|
24
|
-
*
|
|
25
|
-
* @remarks
|
|
26
|
-
* Implements processing for list-of-all-members elements that contain
|
|
27
|
-
* comprehensive member reference collections within class and compound
|
|
28
|
-
* documentation. This class handles the XML Schema definition for
|
|
29
|
-
* listofallmembersType elements, which provide complete inventories of
|
|
30
|
-
* all members (including inherited members) associated with classes,
|
|
31
|
-
* structures, and other compound types.
|
|
32
|
-
*
|
|
33
|
-
* The implementation processes sequences of member reference elements,
|
|
34
|
-
* creating MemberRefDataModel instances to maintain detailed information
|
|
35
|
-
* about each member's identity, scope, and accessibility within the
|
|
36
|
-
* compound's complete member hierarchy.
|
|
37
|
-
*
|
|
38
|
-
* @public
|
|
39
|
-
*/
|
|
40
|
-
// eslint-disable-next-line max-len
|
|
41
5
|
export class AbstractListOfAllMembersType extends AbstractDataModelBase {
|
|
42
|
-
/**
|
|
43
|
-
* Collection of member reference elements within the list-of-all-members.
|
|
44
|
-
*
|
|
45
|
-
* @remarks
|
|
46
|
-
* Contains processed member reference data models representing all members
|
|
47
|
-
* associated with the compound, including both directly declared and
|
|
48
|
-
* inherited members. Each reference provides comprehensive identification
|
|
49
|
-
* and scope information for the corresponding member element.
|
|
50
|
-
*
|
|
51
|
-
* @public
|
|
52
|
-
*/
|
|
53
6
|
memberRefs;
|
|
54
|
-
/**
|
|
55
|
-
* Constructs a new list-of-all-members data model instance.
|
|
56
|
-
*
|
|
57
|
-
* @param xml - The XML parser instance for processing elements
|
|
58
|
-
* @param element - The source XML element containing list-of-all-members data
|
|
59
|
-
* @param elementName - The name of the XML element being processed
|
|
60
|
-
*
|
|
61
|
-
* @remarks
|
|
62
|
-
* Processes the XML element to extract and organise member reference
|
|
63
|
-
* information, creating appropriate data model instances for each
|
|
64
|
-
* member entry found within the comprehensive member listing.
|
|
65
|
-
* The constructor validates the element structure and ensures
|
|
66
|
-
* all member references are properly instantiated.
|
|
67
|
-
*
|
|
68
|
-
* @public
|
|
69
|
-
*/
|
|
70
7
|
constructor(xml, element, elementName) {
|
|
71
8
|
super(elementName);
|
|
72
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
73
|
-
// ------------------------------------------------------------------------
|
|
74
|
-
// Process elements.
|
|
75
9
|
const innerElements = xml.getInnerElements(element, elementName);
|
|
76
10
|
assert(innerElements.length > 0);
|
|
77
|
-
// console.log(util.inspect(item))
|
|
78
11
|
for (const innerElement of innerElements) {
|
|
79
12
|
if (xml.hasInnerText(innerElement)) {
|
|
80
|
-
// Ignore texts
|
|
81
13
|
}
|
|
82
14
|
else if (xml.hasInnerElement(innerElement, 'member')) {
|
|
83
15
|
this.memberRefs ??= [];
|
|
@@ -88,51 +20,12 @@ export class AbstractListOfAllMembersType extends AbstractDataModelBase {
|
|
|
88
20
|
console.error(`${elementName} element:`, Object.keys(innerElement), 'not implemented yet in', this.constructor.name);
|
|
89
21
|
}
|
|
90
22
|
}
|
|
91
|
-
// ------------------------------------------------------------------------
|
|
92
|
-
// Process attributes.
|
|
93
23
|
assert(!xml.hasAttributes(element));
|
|
94
|
-
// ------------------------------------------------------------------------
|
|
95
|
-
// console.log(util.inspect(this, { compact: false, depth: 999 }))
|
|
96
24
|
}
|
|
97
25
|
}
|
|
98
|
-
// ----------------------------------------------------------------------------
|
|
99
|
-
// <xsd:element name="listofallmembers" type="listofallmembersType" minOccurs="0" />
|
|
100
|
-
/**
|
|
101
|
-
* Concrete implementation for listofallmembers elements within compound
|
|
102
|
-
* documentation.
|
|
103
|
-
*
|
|
104
|
-
* @remarks
|
|
105
|
-
* Provides specific handling for listofallmembers XML elements that contain
|
|
106
|
-
* comprehensive member inventories within class and compound documentation.
|
|
107
|
-
* This implementation extends the abstract base class functionality to
|
|
108
|
-
* process the complete collection of member references, including both
|
|
109
|
-
* directly declared and inherited members.
|
|
110
|
-
*
|
|
111
|
-
* The class ensures proper instantiation of member reference data models
|
|
112
|
-
* whilst maintaining the hierarchical structure and accessibility information
|
|
113
|
-
* required for comprehensive documentation generation.
|
|
114
|
-
*
|
|
115
|
-
* @public
|
|
116
|
-
*/
|
|
117
26
|
export class ListOfAllMembersDataModel extends AbstractListOfAllMembersType {
|
|
118
|
-
/**
|
|
119
|
-
* Constructs a new listofallmembers data model instance.
|
|
120
|
-
*
|
|
121
|
-
* @param xml - The XML parser instance for processing elements
|
|
122
|
-
* @param element - The source XML element containing listofallmembers data
|
|
123
|
-
*
|
|
124
|
-
* @remarks
|
|
125
|
-
* Initialises the data model with the specific element name
|
|
126
|
-
* 'listofallmembers' and delegates processing to the abstract base class
|
|
127
|
-
* implementation. This ensures consistent handling of member reference
|
|
128
|
-
* collections whilst maintaining proper element identification.
|
|
129
|
-
*
|
|
130
|
-
* @public
|
|
131
|
-
*/
|
|
132
27
|
constructor(xml, element) {
|
|
133
|
-
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
134
28
|
super(xml, element, 'listofallmembers');
|
|
135
29
|
}
|
|
136
30
|
}
|
|
137
|
-
// ----------------------------------------------------------------------------
|
|
138
31
|
//# sourceMappingURL=listofallmemberstype-dm.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"listofallmemberstype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/listofallmemberstype-dm.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"listofallmemberstype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/listofallmemberstype-dm.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAGjC,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA6BnD,MAAM,OAAgB,4BAA6B,SAAQ,qBAAqB;IAY9E,UAAU,CAAmC;IAkB7C,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;QAGhC,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,QAAQ,CAAC,EAAE,CAAC;gBACvD,IAAI,CAAC,UAAU,KAAK,EAAE,CAAA;gBACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YACjE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,WAAW,EACzB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAKD,MAAM,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;IAKrC,CAAC;CACF;AAuBD,MAAM,OAAO,yBAA0B,SAAQ,4BAA4B;IAezE,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAA;IACzC,CAAC;CACF"}
|
|
@@ -1,180 +1,18 @@
|
|
|
1
1
|
import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
|
|
2
2
|
import { AbstractDataModelBase } from '../types.js';
|
|
3
|
-
/**
|
|
4
|
-
* Abstract base class for location information data models.
|
|
5
|
-
*
|
|
6
|
-
* @remarks
|
|
7
|
-
* Represents comprehensive source code location information as parsed from
|
|
8
|
-
* Doxygen XML elements, including file paths, line numbers, and column
|
|
9
|
-
* positions for both declarations and implementations. This class provides
|
|
10
|
-
* the foundation for tracking source location references within the
|
|
11
|
-
* documentation system, enabling precise navigation between documentation
|
|
12
|
-
* and source code.
|
|
13
|
-
*
|
|
14
|
-
* The implementation handles the XML Schema definition for locationType
|
|
15
|
-
* elements, which contain detailed positioning information for code elements
|
|
16
|
-
* including separate tracking of declaration and implementation locations
|
|
17
|
-
* when they differ (such as header/source file pairs).
|
|
18
|
-
*
|
|
19
|
-
* @public
|
|
20
|
-
*/
|
|
21
3
|
export declare abstract class AbstractLocationType extends AbstractDataModelBase {
|
|
22
|
-
/**
|
|
23
|
-
* The source file path containing the primary declaration or definition.
|
|
24
|
-
*
|
|
25
|
-
* @remarks
|
|
26
|
-
* File path as recorded by Doxygen, typically relative to the source tree
|
|
27
|
-
* root or absolute depending on configuration settings. This represents
|
|
28
|
-
* the primary file location where the documented element is defined.
|
|
29
|
-
*
|
|
30
|
-
* @public
|
|
31
|
-
*/
|
|
32
4
|
file: string;
|
|
33
|
-
/**
|
|
34
|
-
* The line number in the primary source file.
|
|
35
|
-
*
|
|
36
|
-
* @remarks
|
|
37
|
-
* Line number where the declaration or definition appears within the
|
|
38
|
-
* primary source file. Note that whilst the XSD specification indicates
|
|
39
|
-
* this as mandatory, in practice it may be undefined for certain elements
|
|
40
|
-
* where precise line information is not available or applicable.
|
|
41
|
-
*
|
|
42
|
-
* @public
|
|
43
|
-
*/
|
|
44
5
|
line?: number | undefined;
|
|
45
|
-
/**
|
|
46
|
-
* The column number in the primary source file.
|
|
47
|
-
*
|
|
48
|
-
* @remarks
|
|
49
|
-
* Column position where the declaration or definition begins, providing
|
|
50
|
-
* precise horizontal location information when available. This enables
|
|
51
|
-
* accurate source code navigation and positioning within development
|
|
52
|
-
* environments.
|
|
53
|
-
*
|
|
54
|
-
* @public
|
|
55
|
-
*/
|
|
56
6
|
column?: number | undefined;
|
|
57
|
-
/**
|
|
58
|
-
* The file path containing the declaration when separate from implementation.
|
|
59
|
-
*
|
|
60
|
-
* @remarks
|
|
61
|
-
* File path for the declaration when it differs from the implementation
|
|
62
|
-
* file, typically occurring in header/source file pairs where declarations
|
|
63
|
-
* are placed in header files whilst implementations reside in source files.
|
|
64
|
-
* This separation is common in C/C++ development patterns.
|
|
65
|
-
*
|
|
66
|
-
* @public
|
|
67
|
-
*/
|
|
68
7
|
declfile?: string | undefined;
|
|
69
|
-
/**
|
|
70
|
-
* The line number of the declaration within the declaration file.
|
|
71
|
-
*
|
|
72
|
-
* @remarks
|
|
73
|
-
* Line number where the declaration appears, separate from the
|
|
74
|
-
* implementation location when they differ. This provides precise
|
|
75
|
-
* positioning within the declaration file for accurate source navigation.
|
|
76
|
-
*
|
|
77
|
-
* @public
|
|
78
|
-
*/
|
|
79
8
|
declline?: number | undefined;
|
|
80
|
-
/**
|
|
81
|
-
* The column number of the declaration within the declaration file.
|
|
82
|
-
*
|
|
83
|
-
* @remarks
|
|
84
|
-
* Column position where the declaration begins, providing precise
|
|
85
|
-
* horizontal location information for the declaration. This enables
|
|
86
|
-
* accurate positioning within development environments when navigating
|
|
87
|
-
* to declaration locations.
|
|
88
|
-
*
|
|
89
|
-
* @public
|
|
90
|
-
*/
|
|
91
9
|
declcolumn?: number | undefined;
|
|
92
|
-
/**
|
|
93
|
-
* The file path containing the implementation body.
|
|
94
|
-
*
|
|
95
|
-
* @remarks
|
|
96
|
-
* File path where the function or method body is implemented, separate
|
|
97
|
-
* from the declaration when they differ. This is particularly relevant
|
|
98
|
-
* for languages that support separate declaration and implementation
|
|
99
|
-
* files, enabling precise navigation to implementation code.
|
|
100
|
-
*
|
|
101
|
-
* @public
|
|
102
|
-
*/
|
|
103
10
|
bodyfile?: string | undefined;
|
|
104
|
-
/**
|
|
105
|
-
* The starting line number of the implementation body.
|
|
106
|
-
*
|
|
107
|
-
* @remarks
|
|
108
|
-
* Line number where the implementation body begins, providing the starting
|
|
109
|
-
* boundary for locating function or method implementations. This is useful
|
|
110
|
-
* for identifying the complete scope of implementation code.
|
|
111
|
-
*
|
|
112
|
-
* @public
|
|
113
|
-
*/
|
|
114
11
|
bodystart?: number | undefined;
|
|
115
|
-
/**
|
|
116
|
-
* The ending line number of the implementation body.
|
|
117
|
-
*
|
|
118
|
-
* @remarks
|
|
119
|
-
* Line number where the implementation body ends, providing the complete
|
|
120
|
-
* range of the implementation. Together with bodystart, this defines the
|
|
121
|
-
* full extent of the implementation code within the source file.
|
|
122
|
-
*
|
|
123
|
-
* @public
|
|
124
|
-
*/
|
|
125
12
|
bodyend?: number | undefined;
|
|
126
|
-
/**
|
|
127
|
-
* Constructs a new location data model from XML element data.
|
|
128
|
-
*
|
|
129
|
-
* @param xml - The XML parser instance for processing element data
|
|
130
|
-
* @param element - The XML element containing location information
|
|
131
|
-
* @param elementName - The name of the XML element being processed
|
|
132
|
-
*
|
|
133
|
-
* @remarks
|
|
134
|
-
* Parses the XML element representing location information and extracts
|
|
135
|
-
* file paths, line numbers, and column positions for declarations and
|
|
136
|
-
* implementations. The constructor processes all available location
|
|
137
|
-
* attributes whilst handling the distinction between declaration and
|
|
138
|
-
* implementation locations when they differ.
|
|
139
|
-
*
|
|
140
|
-
* The implementation ensures that mandatory file information is present
|
|
141
|
-
* and validates the element structure according to the XML Schema
|
|
142
|
-
* definition for locationType elements.
|
|
143
|
-
*
|
|
144
|
-
* @public
|
|
145
|
-
*/
|
|
146
13
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
147
14
|
}
|
|
148
|
-
/**
|
|
149
|
-
* Concrete implementation for location elements within documentation.
|
|
150
|
-
*
|
|
151
|
-
* @remarks
|
|
152
|
-
* Provides specific handling for location XML elements that contain
|
|
153
|
-
* comprehensive source code positioning information. This implementation
|
|
154
|
-
* extends the abstract base class functionality to process location
|
|
155
|
-
* elements with the specific element name 'location'.
|
|
156
|
-
*
|
|
157
|
-
* The class ensures proper instantiation of location data models whilst
|
|
158
|
-
* maintaining all the detailed positioning information required for
|
|
159
|
-
* accurate source code navigation and reference generation.
|
|
160
|
-
*
|
|
161
|
-
* @public
|
|
162
|
-
*/
|
|
163
15
|
export declare class LocationDataModel extends AbstractLocationType {
|
|
164
|
-
/**
|
|
165
|
-
* Constructs a new location data model instance.
|
|
166
|
-
*
|
|
167
|
-
* @param xml - The XML parser instance for processing elements
|
|
168
|
-
* @param element - The source XML element containing location data
|
|
169
|
-
*
|
|
170
|
-
* @remarks
|
|
171
|
-
* Initialises the data model with the specific element name 'location'
|
|
172
|
-
* and delegates processing to the abstract base class implementation.
|
|
173
|
-
* This ensures consistent handling of location information whilst
|
|
174
|
-
* maintaining proper element identification.
|
|
175
|
-
*
|
|
176
|
-
* @public
|
|
177
|
-
*/
|
|
178
16
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
179
17
|
}
|
|
180
18
|
//# sourceMappingURL=locationtype-dm.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"locationtype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/locationtype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"locationtype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/locationtype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAkCnD,8BAAsB,oBAAqB,SAAQ,qBAAqB;IAWtE,IAAI,SAAK;IAaT,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAazB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAa3B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAY7B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAa7B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAa/B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAY7B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAY9B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;gBAsBhB,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAwDxE;AAqBD,qBAAa,iBAAkB,SAAQ,oBAAoB;gBAe7C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
|