@xpack/doxygen2docusaurus 2.0.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +2 -1
- package/bin/doxygen2docusaurus.js +1 -1
- package/dist/cli/main.d.ts +0 -14
- package/dist/cli/main.d.ts.map +1 -1
- package/dist/cli/main.js +0 -34
- package/dist/cli/main.js.map +1 -1
- package/dist/docusaurus/cli-options.d.ts +3 -292
- package/dist/docusaurus/cli-options.d.ts.map +1 -1
- package/dist/docusaurus/cli-options.js +6 -290
- package/dist/docusaurus/cli-options.js.map +1 -1
- package/dist/docusaurus/generator.d.ts +0 -172
- package/dist/docusaurus/generator.d.ts.map +1 -1
- package/dist/docusaurus/generator.js +20 -280
- package/dist/docusaurus/generator.js.map +1 -1
- package/dist/docusaurus/renderers/descriptiontype.d.ts +0 -417
- package/dist/docusaurus/renderers/descriptiontype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/descriptiontype.js +11 -555
- package/dist/docusaurus/renderers/descriptiontype.js.map +1 -1
- package/dist/docusaurus/renderers/docinternalstype.d.ts +0 -132
- package/dist/docusaurus/renderers/docinternalstype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/docinternalstype.js +0 -156
- package/dist/docusaurus/renderers/docinternalstype.js.map +1 -1
- package/dist/docusaurus/renderers/doclisttype.d.ts +0 -22
- package/dist/docusaurus/renderers/doclisttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/doclisttype.js +0 -42
- package/dist/docusaurus/renderers/doclisttype.js.map +1 -1
- package/dist/docusaurus/renderers/doctabletype.d.ts +0 -88
- package/dist/docusaurus/renderers/doctabletype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/doctabletype.js +1 -113
- package/dist/docusaurus/renderers/doctabletype.js.map +1 -1
- package/dist/docusaurus/renderers/doctitletype.d.ts +0 -22
- package/dist/docusaurus/renderers/doctitletype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/doctitletype.js +0 -42
- package/dist/docusaurus/renderers/doctitletype.js.map +1 -1
- package/dist/docusaurus/renderers/docvariablelisttype.d.ts +0 -44
- package/dist/docusaurus/renderers/docvariablelisttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/docvariablelisttype.js +1 -69
- package/dist/docusaurus/renderers/docvariablelisttype.js.map +1 -1
- package/dist/docusaurus/renderers/docxrefsecttype.d.ts +0 -22
- package/dist/docusaurus/renderers/docxrefsecttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/docxrefsecttype.js +0 -38
- package/dist/docusaurus/renderers/docxrefsecttype.js.map +1 -1
- package/dist/docusaurus/renderers/element-renderer-base.d.ts +0 -74
- package/dist/docusaurus/renderers/element-renderer-base.d.ts.map +1 -1
- package/dist/docusaurus/renderers/element-renderer-base.js +0 -64
- package/dist/docusaurus/renderers/element-renderer-base.js.map +1 -1
- package/dist/docusaurus/renderers/inctype.d.ts +0 -23
- package/dist/docusaurus/renderers/inctype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/inctype.js +0 -41
- package/dist/docusaurus/renderers/inctype.js.map +1 -1
- package/dist/docusaurus/renderers/linkedtexttype.d.ts +0 -22
- package/dist/docusaurus/renderers/linkedtexttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/linkedtexttype.js +0 -45
- package/dist/docusaurus/renderers/linkedtexttype.js.map +1 -1
- package/dist/docusaurus/renderers/listingtype.d.ts +0 -52
- package/dist/docusaurus/renderers/listingtype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/listingtype.js +1 -88
- package/dist/docusaurus/renderers/listingtype.js.map +1 -1
- package/dist/docusaurus/renderers/paramtype.d.ts +0 -22
- package/dist/docusaurus/renderers/paramtype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/paramtype.js +2 -51
- package/dist/docusaurus/renderers/paramtype.js.map +1 -1
- package/dist/docusaurus/renderers/referencetype.d.ts +0 -23
- package/dist/docusaurus/renderers/referencetype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/referencetype.js +0 -38
- package/dist/docusaurus/renderers/referencetype.js.map +1 -1
- package/dist/docusaurus/renderers/reftexttype.d.ts +0 -22
- package/dist/docusaurus/renderers/reftexttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/reftexttype.js +0 -38
- package/dist/docusaurus/renderers/reftexttype.js.map +1 -1
- package/dist/docusaurus/renderers/reftype.d.ts +0 -22
- package/dist/docusaurus/renderers/reftype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/reftype.js +0 -38
- package/dist/docusaurus/renderers/reftype.js.map +1 -1
- package/dist/docusaurus/renderers/renderers.d.ts +0 -151
- package/dist/docusaurus/renderers/renderers.d.ts.map +1 -1
- package/dist/docusaurus/renderers/renderers.js +4 -184
- package/dist/docusaurus/renderers/renderers.js.map +1 -1
- package/dist/docusaurus/renderers/substringtype.d.ts +0 -22
- package/dist/docusaurus/renderers/substringtype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/substringtype.js +0 -39
- package/dist/docusaurus/renderers/substringtype.js.map +1 -1
- package/dist/docusaurus/renderers/tableofcontentstype.d.ts +0 -22
- package/dist/docusaurus/renderers/tableofcontentstype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/tableofcontentstype.js +0 -39
- package/dist/docusaurus/renderers/tableofcontentstype.js.map +1 -1
- package/dist/docusaurus/types.d.ts +0 -110
- package/dist/docusaurus/types.d.ts.map +1 -1
- package/dist/docusaurus/types.js +0 -11
- package/dist/docusaurus/types.js.map +1 -1
- package/dist/docusaurus/utils.d.ts +0 -214
- package/dist/docusaurus/utils.d.ts.map +1 -1
- package/dist/docusaurus/utils.js +0 -296
- package/dist/docusaurus/utils.js.map +1 -1
- package/dist/docusaurus/view-model/classes-vm.d.ts +0 -137
- package/dist/docusaurus/view-model/classes-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/classes-vm.js +9 -225
- package/dist/docusaurus/view-model/classes-vm.js.map +1 -1
- package/dist/docusaurus/view-model/collection-base.d.ts +0 -120
- package/dist/docusaurus/view-model/collection-base.d.ts.map +1 -1
- package/dist/docusaurus/view-model/collection-base.js +11 -101
- package/dist/docusaurus/view-model/collection-base.js.map +1 -1
- package/dist/docusaurus/view-model/compound-base-vm.d.ts +2 -147
- package/dist/docusaurus/view-model/compound-base-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/compound-base-vm.js +47 -225
- package/dist/docusaurus/view-model/compound-base-vm.js.map +1 -1
- package/dist/docusaurus/view-model/concepts-vm.d.ts +26 -0
- package/dist/docusaurus/view-model/concepts-vm.d.ts.map +1 -0
- package/dist/docusaurus/view-model/concepts-vm.js +329 -0
- package/dist/docusaurus/view-model/concepts-vm.js.map +1 -0
- package/dist/docusaurus/view-model/description-anchors.d.ts +0 -58
- package/dist/docusaurus/view-model/description-anchors.d.ts.map +1 -1
- package/dist/docusaurus/view-model/description-anchors.js +0 -71
- package/dist/docusaurus/view-model/description-anchors.js.map +1 -1
- package/dist/docusaurus/view-model/files-and-folders-vm.d.ts +0 -247
- package/dist/docusaurus/view-model/files-and-folders-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/files-and-folders-vm.js +61 -353
- package/dist/docusaurus/view-model/files-and-folders-vm.js.map +1 -1
- package/dist/docusaurus/view-model/groups-vm.d.ts +0 -148
- package/dist/docusaurus/view-model/groups-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/groups-vm.js +2 -223
- package/dist/docusaurus/view-model/groups-vm.js.map +1 -1
- package/dist/docusaurus/view-model/members-vm.d.ts +0 -552
- package/dist/docusaurus/view-model/members-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/members-vm.js +17 -702
- package/dist/docusaurus/view-model/members-vm.js.map +1 -1
- package/dist/docusaurus/view-model/namespaces-vm.d.ts +4 -199
- package/dist/docusaurus/view-model/namespaces-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/namespaces-vm.js +79 -284
- package/dist/docusaurus/view-model/namespaces-vm.js.map +1 -1
- package/dist/docusaurus/view-model/options.d.ts +0 -43
- package/dist/docusaurus/view-model/options.d.ts.map +1 -1
- package/dist/docusaurus/view-model/options.js +0 -57
- package/dist/docusaurus/view-model/options.js.map +1 -1
- package/dist/docusaurus/view-model/pages-vm.d.ts +0 -115
- package/dist/docusaurus/view-model/pages-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/pages-vm.js +0 -162
- package/dist/docusaurus/view-model/pages-vm.js.map +1 -1
- package/dist/docusaurus/view-model/tree-entries-vm.d.ts +8 -142
- package/dist/docusaurus/view-model/tree-entries-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/tree-entries-vm.js +54 -174
- package/dist/docusaurus/view-model/tree-entries-vm.js.map +1 -1
- package/dist/docusaurus/view-model/view-model.d.ts +0 -125
- package/dist/docusaurus/view-model/view-model.d.ts.map +1 -1
- package/dist/docusaurus/view-model/view-model.js +20 -182
- package/dist/docusaurus/view-model/view-model.js.map +1 -1
- package/dist/docusaurus/workspace.d.ts +1 -126
- package/dist/docusaurus/workspace.d.ts.map +1 -1
- package/dist/docusaurus/workspace.js +8 -221
- package/dist/docusaurus/workspace.js.map +1 -1
- package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts +5 -492
- package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/compounddef-dm.js +23 -672
- package/dist/doxygen/data-model/compounds/compounddef-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts +0 -129
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.js +1 -145
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts +104 -2848
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.js +73 -3975
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts +0 -165
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js +0 -229
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts +0 -70
- package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/doxygentype-dm.js +0 -105
- package/dist/doxygen/data-model/compounds/doxygentype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts +0 -84
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js +1 -122
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/inctype-dm.d.ts +0 -116
- package/dist/doxygen/data-model/compounds/inctype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/inctype-dm.js +3 -155
- package/dist/doxygen/data-model/compounds/inctype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts +3 -138
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js +5 -180
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts +0 -76
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js +0 -107
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts +0 -162
- package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/locationtype-dm.js +4 -203
- package/dist/doxygen/data-model/compounds/locationtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts +2 -443
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.js +19 -475
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts +0 -141
- package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/memberreftype-dm.js +0 -176
- package/dist/doxygen/data-model/compounds/memberreftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/membertype-dm.d.ts +0 -101
- package/dist/doxygen/data-model/compounds/membertype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/membertype-dm.js +0 -115
- package/dist/doxygen/data-model/compounds/membertype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts +0 -164
- package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/paramtype-dm.js +0 -208
- package/dist/doxygen/data-model/compounds/paramtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts +0 -139
- package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/referencetype-dm.js +2 -175
- package/dist/doxygen/data-model/compounds/referencetype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts +0 -120
- package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/reftexttype-dm.js +2 -141
- package/dist/doxygen/data-model/compounds/reftexttype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/reftype-dm.d.ts +0 -268
- package/dist/doxygen/data-model/compounds/reftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/reftype-dm.js +4 -326
- package/dist/doxygen/data-model/compounds/reftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts +0 -105
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.js +1 -139
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts +0 -168
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js +0 -209
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts +0 -267
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js +0 -354
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts +0 -66
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js +0 -97
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js.map +1 -1
- package/dist/doxygen/data-model/data-model.d.ts +0 -149
- package/dist/doxygen/data-model/data-model.d.ts.map +1 -1
- package/dist/doxygen/data-model/data-model.js +4 -197
- package/dist/doxygen/data-model/data-model.js.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts +0 -115
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js +4 -129
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts +0 -87
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js +0 -118
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js.map +1 -1
- package/dist/doxygen/data-model/doxygen-xml-parser.d.ts +0 -253
- package/dist/doxygen/data-model/doxygen-xml-parser.d.ts.map +1 -1
- package/dist/doxygen/data-model/doxygen-xml-parser.js +0 -291
- package/dist/doxygen/data-model/doxygen-xml-parser.js.map +1 -1
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts +0 -98
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.js +2 -122
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts +0 -82
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.js +0 -114
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.js.map +1 -1
- package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts +0 -85
- package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/index/indexmembertype-dm.js +1 -107
- package/dist/doxygen/data-model/index/indexmembertype-dm.js.map +1 -1
- package/dist/doxygen/data-model/types.d.ts +0 -104
- package/dist/doxygen/data-model/types.d.ts.map +1 -1
- package/dist/doxygen/data-model/types.js +0 -52
- package/dist/doxygen/data-model/types.js.map +1 -1
- package/dist/index.d.ts +4 -16
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -42
- package/dist/index.js.map +1 -1
- package/package.json +45 -51
- package/src/cli/main.ts +122 -0
- package/src/docusaurus/cli-options.ts +560 -0
- package/src/docusaurus/generator.ts +788 -0
- package/src/docusaurus/renderers/descriptiontype.ts +1299 -0
- package/src/docusaurus/renderers/docinternalstype.ts +354 -0
- package/src/docusaurus/renderers/doclisttype.ts +134 -0
- package/src/docusaurus/renderers/doctabletype.ts +220 -0
- package/src/docusaurus/renderers/doctitletype.ts +77 -0
- package/src/docusaurus/renderers/docvariablelisttype.ts +123 -0
- package/src/docusaurus/renderers/docxrefsecttype.ts +84 -0
- package/src/docusaurus/renderers/element-renderer-base.ts +112 -0
- package/src/docusaurus/renderers/inctype.ts +75 -0
- package/src/docusaurus/renderers/linkedtexttype.ts +64 -0
- package/src/docusaurus/renderers/listingtype.ts +235 -0
- package/src/docusaurus/renderers/paramtype.ts +116 -0
- package/src/docusaurus/renderers/referencetype.ts +83 -0
- package/src/docusaurus/renderers/reftexttype.ts +81 -0
- package/src/docusaurus/renderers/reftype.ts +77 -0
- package/src/docusaurus/renderers/renderers.ts +756 -0
- package/src/docusaurus/renderers/substringtype.ts +53 -0
- package/src/docusaurus/renderers/tableofcontentstype.ts +74 -0
- package/src/docusaurus/types.ts +187 -0
- package/src/docusaurus/utils.ts +409 -0
- package/src/docusaurus/view-model/README.md +12 -0
- package/src/docusaurus/view-model/classes-vm.ts +1088 -0
- package/src/docusaurus/view-model/collection-base.ts +352 -0
- package/src/docusaurus/view-model/compound-base-vm.ts +1340 -0
- package/src/docusaurus/view-model/concepts-vm.ts +719 -0
- package/src/docusaurus/view-model/description-anchors.ts +107 -0
- package/src/docusaurus/view-model/files-and-folders-vm.ts +1293 -0
- package/src/docusaurus/view-model/groups-vm.ts +548 -0
- package/src/docusaurus/view-model/members-vm.ts +1943 -0
- package/src/docusaurus/view-model/namespaces-vm.ts +1018 -0
- package/src/docusaurus/view-model/options.ts +95 -0
- package/src/docusaurus/view-model/pages-vm.ts +342 -0
- package/src/docusaurus/view-model/tree-entries-vm.ts +376 -0
- package/src/docusaurus/view-model/view-model.ts +513 -0
- package/src/docusaurus/workspace.ts +588 -0
- package/src/doxygen/data-model/README.md +13 -0
- package/src/doxygen/data-model/compounds/compounddef-dm.ts +1156 -0
- package/src/doxygen/data-model/compounds/compoundreftype-dm.ts +266 -0
- package/src/doxygen/data-model/compounds/descriptiontype-dm.ts +10107 -0
- package/src/doxygen/data-model/compounds/docvarlistentrytype-dm.ts +354 -0
- package/src/doxygen/data-model/compounds/doxygentype-dm.ts +187 -0
- package/src/doxygen/data-model/compounds/enumvaluetype-dm.ts +218 -0
- package/src/doxygen/data-model/compounds/inctype-dm.ts +217 -0
- package/src/doxygen/data-model/compounds/linkedtexttype-dm.ts +288 -0
- package/src/doxygen/data-model/compounds/listofallmemberstype-dm.ts +160 -0
- package/src/doxygen/data-model/compounds/locationtype-dm.ts +284 -0
- package/src/doxygen/data-model/compounds/memberdeftype-dm.ts +874 -0
- package/src/doxygen/data-model/compounds/memberreftype-dm.ts +270 -0
- package/src/doxygen/data-model/compounds/membertype-dm.ts +239 -0
- package/src/doxygen/data-model/compounds/paramtype-dm.ts +302 -0
- package/src/doxygen/data-model/compounds/referencetype-dm.ts +248 -0
- package/src/doxygen/data-model/compounds/reftexttype-dm.ts +234 -0
- package/src/doxygen/data-model/compounds/reftype-dm.ts +430 -0
- package/src/doxygen/data-model/compounds/reimplementtype-dm.ts +201 -0
- package/src/doxygen/data-model/compounds/sectiondeftype-dm.ts +330 -0
- package/src/doxygen/data-model/compounds/tableofcontentstype-dm.ts +563 -0
- package/src/doxygen/data-model/compounds/templateparamlisttype-dm.ts +150 -0
- package/src/doxygen/data-model/data-model.ts +377 -0
- package/src/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.ts +271 -0
- package/src/doxygen/data-model/doxyfile/doxyfiletype-dm.ts +200 -0
- package/src/doxygen/data-model/doxygen-xml-parser.ts +522 -0
- package/src/doxygen/data-model/index/indexcompoundtype-dm.ts +256 -0
- package/src/doxygen/data-model/index/indexdoxygentype-dm.ts +196 -0
- package/src/doxygen/data-model/index/indexmembertype-dm.ts +230 -0
- package/src/doxygen/data-model/types.ts +175 -0
- package/src/doxygen/data-model/xsds/README.md +6 -0
- package/src/doxygen/data-model/xsds/compound.xsd +1699 -0
- package/src/doxygen/data-model/xsds/doxyfile.xsd +355 -0
- package/src/doxygen/data-model/xsds/index.xsd +72 -0
- package/src/doxygen/data-model/xsds/xml.xsd +23 -0
- package/src/index.ts +261 -0
- package/src/tsconfig.json +10 -0
- package/dist/doxygen2docusaurus.d.ts +0 -4774
- package/dist/tsconfig.tsbuildinfo +0 -1
- package/dist/tsdoc-metadata.json +0 -11
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
|
|
2
2
|
import { BriefDescriptionDataModel, DetailedDescriptionDataModel, InbodyDescriptionDataModel } from './descriptiontype-dm.js';
|
|
3
|
-
import { InitializerDataModel, TypeDataModel } from './linkedtexttype-dm.js';
|
|
3
|
+
import { InitializerDataModel, RequiresClauseDataModel, TypeDataModel } from './linkedtexttype-dm.js';
|
|
4
4
|
import { LocationDataModel } from './locationtype-dm.js';
|
|
5
5
|
import { ParamDataModel } from './paramtype-dm.js';
|
|
6
6
|
import { AbstractDataModelBase } from '../types.js';
|
|
@@ -8,493 +8,52 @@ import { TemplateParamListDataModel } from './templateparamlisttype-dm.js';
|
|
|
8
8
|
import { EnumValueDataModel } from './enumvaluetype-dm.js';
|
|
9
9
|
import { ReimplementDataModel } from './reimplementtype-dm.js';
|
|
10
10
|
import { ReferenceDataModel, ReferencedByDataModel } from './referencetype-dm.js';
|
|
11
|
-
/**
|
|
12
|
-
* Union type representing all possible member kinds within Doxygen
|
|
13
|
-
* documentation.
|
|
14
|
-
*
|
|
15
|
-
* @remarks
|
|
16
|
-
* Defines the complete set of member types that can be documented by Doxygen,
|
|
17
|
-
* encompassing various programming language constructs including C/C++
|
|
18
|
-
* elements, Qt-specific constructs, and language-specific features from
|
|
19
|
-
* multiple programming paradigms.
|
|
20
|
-
*
|
|
21
|
-
* The enumeration covers traditional programming constructs (functions,
|
|
22
|
-
* variables, typedefs), modern C++ features, Qt framework elements (signals,
|
|
23
|
-
* slots), and specialised constructs from various development environments.
|
|
24
|
-
*
|
|
25
|
-
* @public
|
|
26
|
-
*/
|
|
27
11
|
export type DoxMemberKind = 'define' | 'property' | 'event' | 'variable' | 'typedef' | 'enum' | 'function' | 'signal' | 'prototype' | 'friend' | 'dcop' | 'slot' | 'interface' | 'service';
|
|
28
|
-
/**
|
|
29
|
-
* Abstract base class for member-related data models within documentation.
|
|
30
|
-
*
|
|
31
|
-
* @remarks
|
|
32
|
-
* Provides foundational functionality for all member-related elements within
|
|
33
|
-
* the Doxygen documentation system. This class establishes the basic
|
|
34
|
-
* structure for member identification and classification, serving as the
|
|
35
|
-
* foundation for more specific member definition processing.
|
|
36
|
-
*
|
|
37
|
-
* The class maintains essential member information including name and kind
|
|
38
|
-
* identification, which are fundamental properties required by all member
|
|
39
|
-
* types within the documentation hierarchy.
|
|
40
|
-
*
|
|
41
|
-
* @public
|
|
42
|
-
*/
|
|
43
12
|
export declare abstract class AbstractMemberBaseType extends AbstractDataModelBase {
|
|
44
|
-
/**
|
|
45
|
-
* The name of the member element.
|
|
46
|
-
*
|
|
47
|
-
* @remarks
|
|
48
|
-
* Contains the identifier name for the member as extracted from the
|
|
49
|
-
* documentation source. This represents the primary identification
|
|
50
|
-
* mechanism for the member within its containing scope.
|
|
51
|
-
*
|
|
52
|
-
* @public
|
|
53
|
-
*/
|
|
54
13
|
name: string;
|
|
55
|
-
/**
|
|
56
|
-
* The kind classification of the member element.
|
|
57
|
-
*
|
|
58
|
-
* @remarks
|
|
59
|
-
* Specifies the type category of the member, corresponding to the
|
|
60
|
-
* DoxMemberKind enumeration values. This classification determines
|
|
61
|
-
* how the member is processed and presented within the documentation
|
|
62
|
-
* generation workflow.
|
|
63
|
-
*
|
|
64
|
-
* @public
|
|
65
|
-
*/
|
|
66
14
|
kind: string;
|
|
67
15
|
}
|
|
68
|
-
/**
|
|
69
|
-
* Abstract base class for comprehensive member definition data models.
|
|
70
|
-
*
|
|
71
|
-
* @remarks
|
|
72
|
-
* Extends the basic member functionality to provide complete member
|
|
73
|
-
* definition processing capabilities. This class handles the complex XML
|
|
74
|
-
* Schema definition for memberdefType elements, which represent detailed
|
|
75
|
-
* member information including location data, type information, parameters,
|
|
76
|
-
* descriptions, and various language-specific attributes.
|
|
77
|
-
*
|
|
78
|
-
* The implementation processes extensive member metadata including template
|
|
79
|
-
* parameters, function signatures, initialization values, documentation
|
|
80
|
-
* descriptions, and cross-reference information. It also manages a
|
|
81
|
-
* comprehensive set of language-specific attributes covering C++, Qt,
|
|
82
|
-
* C++/CLI, C#, Objective-C, and UNO IDL constructs.
|
|
83
|
-
*
|
|
84
|
-
* @public
|
|
85
|
-
*/
|
|
86
16
|
export declare abstract class AbstractMemberDefType extends AbstractMemberBaseType {
|
|
87
|
-
/**
|
|
88
|
-
* The location information for the member definition.
|
|
89
|
-
*
|
|
90
|
-
* @remarks
|
|
91
|
-
* Contains comprehensive source code location data including file paths,
|
|
92
|
-
* line numbers, and column positions for both declarations and
|
|
93
|
-
* implementations. This enables precise navigation between documentation
|
|
94
|
-
* and source code.
|
|
95
|
-
*
|
|
96
|
-
* @public
|
|
97
|
-
*/
|
|
98
17
|
location: LocationDataModel | undefined;
|
|
99
|
-
/**
|
|
100
|
-
* The unique identifier for the member element.
|
|
101
|
-
*
|
|
102
|
-
* @remarks
|
|
103
|
-
* Provides a unique identification string for the member within the
|
|
104
|
-
* documentation system. This identifier is used for cross-referencing
|
|
105
|
-
* and linking between different parts of the documentation.
|
|
106
|
-
*
|
|
107
|
-
* @public
|
|
108
|
-
*/
|
|
109
18
|
id: string;
|
|
110
|
-
/**
|
|
111
|
-
* The protection level of the member element.
|
|
112
|
-
*
|
|
113
|
-
* @remarks
|
|
114
|
-
* Specifies the access protection level (public, protected, private)
|
|
115
|
-
* for the member, determining its visibility and accessibility within
|
|
116
|
-
* the containing class or namespace scope.
|
|
117
|
-
*
|
|
118
|
-
* @public
|
|
119
|
-
*/
|
|
120
19
|
prot: string;
|
|
121
|
-
/**
|
|
122
|
-
* Indicates whether the member is declared as static.
|
|
123
|
-
*
|
|
124
|
-
* @remarks
|
|
125
|
-
* Boolean flag indicating static member declaration, affecting the
|
|
126
|
-
* member's association with class instances versus the class itself.
|
|
127
|
-
* This information is crucial for understanding member accessibility
|
|
128
|
-
* and usage patterns.
|
|
129
|
-
*
|
|
130
|
-
* @public
|
|
131
|
-
*/
|
|
132
20
|
staticc: boolean | undefined;
|
|
133
|
-
/**
|
|
134
|
-
* Template parameter list information for templated members.
|
|
135
|
-
*
|
|
136
|
-
* @remarks
|
|
137
|
-
* Contains detailed information about template parameters when the member
|
|
138
|
-
* is part of a template declaration. This includes parameter names, types,
|
|
139
|
-
* and default values essential for template documentation.
|
|
140
|
-
*
|
|
141
|
-
* @public
|
|
142
|
-
*/
|
|
143
21
|
templateparamlist?: TemplateParamListDataModel | undefined;
|
|
144
|
-
/**
|
|
145
|
-
* Type information for the member element.
|
|
146
|
-
*
|
|
147
|
-
* @remarks
|
|
148
|
-
* Provides comprehensive type data including linked text with embedded
|
|
149
|
-
* cross-references. This information describes the member's data type,
|
|
150
|
-
* return type for functions, or variable type for data members.
|
|
151
|
-
*
|
|
152
|
-
* @public
|
|
153
|
-
*/
|
|
154
22
|
type?: TypeDataModel | undefined;
|
|
155
|
-
/**
|
|
156
|
-
* The complete definition string for the member.
|
|
157
|
-
*
|
|
158
|
-
* @remarks
|
|
159
|
-
* Contains the full member definition as it appears in the source code,
|
|
160
|
-
* including type information, qualifiers, and parameter lists. This
|
|
161
|
-
* provides the complete syntactic representation of the member.
|
|
162
|
-
*
|
|
163
|
-
* @public
|
|
164
|
-
*/
|
|
165
23
|
definition?: string | undefined;
|
|
166
|
-
/**
|
|
167
|
-
* The argument string for function members.
|
|
168
|
-
*
|
|
169
|
-
* @remarks
|
|
170
|
-
* Contains the parameter list specification for function-like members,
|
|
171
|
-
* including parameter types, names, and default values. This information
|
|
172
|
-
* is essential for understanding function signatures and usage.
|
|
173
|
-
*
|
|
174
|
-
* @public
|
|
175
|
-
*/
|
|
176
24
|
argsstring?: string | undefined;
|
|
177
|
-
/**
|
|
178
|
-
* The fully qualified name of the member element.
|
|
179
|
-
*
|
|
180
|
-
* @remarks
|
|
181
|
-
* Provides the complete qualified name including namespace and class
|
|
182
|
-
* prefixes, enabling unambiguous identification of the member within
|
|
183
|
-
* the entire codebase context.
|
|
184
|
-
*
|
|
185
|
-
* @public
|
|
186
|
-
*/
|
|
187
25
|
qualifiedName?: string | undefined;
|
|
188
|
-
/**
|
|
189
|
-
* Bitfield specification for member variables.
|
|
190
|
-
*
|
|
191
|
-
* @remarks
|
|
192
|
-
* Contains the bitfield width specification for member variables that
|
|
193
|
-
* are declared as bitfields in C/C++ structures or classes. This string
|
|
194
|
-
* represents the number of bits allocated to the member within the
|
|
195
|
-
* containing structure's memory layout.
|
|
196
|
-
*/
|
|
197
26
|
bitfield?: string | undefined;
|
|
198
|
-
/**
|
|
199
|
-
* List of reimplemented member references.
|
|
200
|
-
*
|
|
201
|
-
* @remarks
|
|
202
|
-
* Contains references to members that this member reimplements or
|
|
203
|
-
* overrides from base classes. This property captures inheritance
|
|
204
|
-
* relationships where the current member provides a new implementation
|
|
205
|
-
* of a virtual method from a parent class.
|
|
206
|
-
*/
|
|
207
27
|
reimplements?: ReimplementDataModel[] | undefined;
|
|
208
|
-
/**
|
|
209
|
-
* List of members that reimplement this member.
|
|
210
|
-
*
|
|
211
|
-
* @remarks
|
|
212
|
-
* Contains references to derived class members that reimplement or
|
|
213
|
-
* override this member. This property provides reverse inheritance
|
|
214
|
-
* relationship information, showing which child classes provide
|
|
215
|
-
* alternative implementations of this member.
|
|
216
|
-
*/
|
|
217
28
|
reimplementedBys?: ReimplementDataModel[] | undefined;
|
|
218
|
-
/**
|
|
219
|
-
* Parameter list for function or method members.
|
|
220
|
-
*
|
|
221
|
-
* @remarks
|
|
222
|
-
* Contains detailed parameter information for function-like members,
|
|
223
|
-
* including parameter names, types, descriptions, and default values.
|
|
224
|
-
* This comprehensive parameter data enables complete function signature
|
|
225
|
-
* documentation and API reference generation.
|
|
226
|
-
*/
|
|
227
29
|
params?: ParamDataModel[] | undefined;
|
|
228
|
-
/**
|
|
229
|
-
* Enumeration values for enum members.
|
|
230
|
-
*
|
|
231
|
-
* @remarks
|
|
232
|
-
* Contains the list of enumeration constants when the member is an enum
|
|
233
|
-
* type. Each enumeration value includes its name, numeric value, and
|
|
234
|
-
* associated documentation, providing complete enum documentation
|
|
235
|
-
* for API references.
|
|
236
|
-
*/
|
|
237
30
|
enumvalues?: EnumValueDataModel[] | undefined;
|
|
238
|
-
|
|
239
|
-
* Initializer expression for the member.
|
|
240
|
-
*
|
|
241
|
-
* @remarks
|
|
242
|
-
* Contains the initialization expression or default value assigned to
|
|
243
|
-
* the member in its declaration. This linked text may include
|
|
244
|
-
* cross-references to other documented entities and provides insight
|
|
245
|
-
* into the member's default behaviour or initial state.
|
|
246
|
-
*/
|
|
31
|
+
requiresClause?: RequiresClauseDataModel | undefined;
|
|
247
32
|
initializer?: InitializerDataModel | undefined;
|
|
248
|
-
/**
|
|
249
|
-
* Brief description of the member.
|
|
250
|
-
*
|
|
251
|
-
* @remarks
|
|
252
|
-
* Contains a concise summary description of the member extracted from
|
|
253
|
-
* documentation comments. This brief description is typically used in
|
|
254
|
-
* member listings and summary views to provide quick understanding
|
|
255
|
-
* of the member's purpose.
|
|
256
|
-
*/
|
|
257
33
|
briefDescription?: BriefDescriptionDataModel | undefined;
|
|
258
|
-
/**
|
|
259
|
-
* Detailed description of the member.
|
|
260
|
-
*
|
|
261
|
-
* @remarks
|
|
262
|
-
* Contains comprehensive documentation for the member including detailed
|
|
263
|
-
* explanations, usage examples, parameter descriptions, and return value
|
|
264
|
-
* information. This forms the primary documentation content for the
|
|
265
|
-
* member in generated API documentation.
|
|
266
|
-
*/
|
|
267
34
|
detailedDescription?: DetailedDescriptionDataModel | undefined;
|
|
268
|
-
/**
|
|
269
|
-
* In-body description of the member.
|
|
270
|
-
*
|
|
271
|
-
* @remarks
|
|
272
|
-
* Contains documentation that appears within the member's implementation
|
|
273
|
-
* body, typically used for additional implementation notes or internal
|
|
274
|
-
* documentation that supplements the main member description.
|
|
275
|
-
*/
|
|
276
35
|
inbodyDescription?: InbodyDescriptionDataModel | undefined;
|
|
277
|
-
/**
|
|
278
|
-
* References made by this member to other entities.
|
|
279
|
-
*
|
|
280
|
-
* @remarks
|
|
281
|
-
* Contains a list of references to other documented entities that this
|
|
282
|
-
* member uses or calls. This information enables dependency analysis
|
|
283
|
-
* and cross-reference navigation in the generated documentation.
|
|
284
|
-
*/
|
|
285
36
|
references?: ReferenceDataModel[] | undefined;
|
|
286
|
-
/**
|
|
287
|
-
* References to this member from other entities.
|
|
288
|
-
*
|
|
289
|
-
* @remarks
|
|
290
|
-
* Contains a list of other documented entities that reference or use
|
|
291
|
-
* this member. This reverse reference information helps understand
|
|
292
|
-
* the member's usage throughout the codebase and enables comprehensive
|
|
293
|
-
* cross-reference navigation.
|
|
294
|
-
*/
|
|
295
37
|
referencedBy?: ReferencedByDataModel[] | undefined;
|
|
296
|
-
/**
|
|
297
|
-
* Indicates whether the member has external linkage.
|
|
298
|
-
*
|
|
299
|
-
* @remarks
|
|
300
|
-
* Boolean flag indicating that the member is declared with external
|
|
301
|
-
* linkage, typically using the 'extern' keyword in C/C++. This affects
|
|
302
|
-
* the member's visibility and linkage across translation units.
|
|
303
|
-
*/
|
|
304
38
|
extern?: boolean | undefined;
|
|
305
|
-
/**
|
|
306
|
-
* Indicates whether the member has strong typing.
|
|
307
|
-
*
|
|
308
|
-
* @remarks
|
|
309
|
-
* Boolean flag indicating strong type enforcement for the member,
|
|
310
|
-
* typically used in languages or contexts where type strength can
|
|
311
|
-
* be explicitly specified to prevent implicit conversions.
|
|
312
|
-
*/
|
|
313
39
|
strong?: boolean | undefined;
|
|
314
|
-
/**
|
|
315
|
-
* Indicates whether the member is declared as const.
|
|
316
|
-
*
|
|
317
|
-
* @remarks
|
|
318
|
-
* Boolean flag indicating that the member is declared with the const
|
|
319
|
-
* qualifier, making it immutable after initialization. This affects
|
|
320
|
-
* the member's usage patterns and compiler optimizations.
|
|
321
|
-
*/
|
|
322
40
|
constt?: boolean | undefined;
|
|
323
|
-
/**
|
|
324
|
-
* Indicates whether the member is declared as explicit.
|
|
325
|
-
*
|
|
326
|
-
* @remarks
|
|
327
|
-
* Boolean flag indicating that constructors or conversion operators
|
|
328
|
-
* are marked as explicit, preventing implicit conversions. This is
|
|
329
|
-
* particularly important for type safety in C++ class design.
|
|
330
|
-
*/
|
|
331
41
|
explicit?: boolean | undefined;
|
|
332
|
-
/**
|
|
333
|
-
* Indicates whether the member is declared as inline.
|
|
334
|
-
*
|
|
335
|
-
* @remarks
|
|
336
|
-
* Boolean flag indicating that the member is defined inline, suggesting
|
|
337
|
-
* to the compiler that calls should be expanded in place rather than
|
|
338
|
-
* using function call mechanisms. This affects performance and linking.
|
|
339
|
-
*/
|
|
340
42
|
inline?: boolean | undefined;
|
|
341
|
-
/**
|
|
342
|
-
* Indicates the reference qualifier for the member.
|
|
343
|
-
*
|
|
344
|
-
* @remarks
|
|
345
|
-
* Boolean flag related to C++11 reference qualifiers (&, &&) that
|
|
346
|
-
* specify whether member functions can be called on lvalue or rvalue
|
|
347
|
-
* objects. This affects method overload resolution and move semantics.
|
|
348
|
-
*/
|
|
349
43
|
refqual?: boolean | undefined;
|
|
350
|
-
/**
|
|
351
|
-
* Virtual specification for the member.
|
|
352
|
-
*
|
|
353
|
-
* @remarks
|
|
354
|
-
* String indicating the virtual nature of the member using DoxVirtualKind
|
|
355
|
-
* values ('non-virtual', 'virtual', 'pure-virtual'). This determines
|
|
356
|
-
* the member's behaviour in inheritance hierarchies and polymorphism.
|
|
357
|
-
*/
|
|
358
44
|
virt?: string | undefined;
|
|
359
|
-
/**
|
|
360
|
-
* Indicates whether the member is declared as volatile.
|
|
361
|
-
*
|
|
362
|
-
* @remarks
|
|
363
|
-
* Boolean flag indicating that the member is declared with the volatile
|
|
364
|
-
* qualifier, preventing compiler optimizations that assume the value
|
|
365
|
-
* doesn't change unexpectedly. This is important for hardware registers
|
|
366
|
-
* and multi-threaded contexts.
|
|
367
|
-
*/
|
|
368
45
|
volatile?: boolean | undefined;
|
|
369
|
-
/**
|
|
370
|
-
* Indicates whether the member is declared as mutable.
|
|
371
|
-
*
|
|
372
|
-
* @remarks
|
|
373
|
-
* Boolean flag indicating that the member can be modified even in const
|
|
374
|
-
* objects. This is typically used for caching, lazy evaluation, or
|
|
375
|
-
* other implementation details that don't affect the logical state.
|
|
376
|
-
*/
|
|
377
46
|
mutable?: boolean | undefined;
|
|
378
|
-
/**
|
|
379
|
-
* Indicates whether the member is declared as noexcept.
|
|
380
|
-
*
|
|
381
|
-
* @remarks
|
|
382
|
-
* Boolean flag indicating that the member promises not to throw
|
|
383
|
-
* exceptions. This C++11 feature enables compiler optimizations and
|
|
384
|
-
* affects exception safety guarantees in the API design.
|
|
385
|
-
*/
|
|
386
47
|
noexcept?: boolean | undefined;
|
|
387
|
-
/**
|
|
388
|
-
* Indicates whether the member has a noexcept expression.
|
|
389
|
-
*
|
|
390
|
-
* @remarks
|
|
391
|
-
* Boolean flag indicating that the member's noexcept specification
|
|
392
|
-
* includes a conditional expression that determines exception safety
|
|
393
|
-
* at compile time based on template parameters or other conditions.
|
|
394
|
-
*/
|
|
395
48
|
noexceptexpression?: boolean | undefined;
|
|
396
|
-
/**
|
|
397
|
-
* Indicates whether the member is declared as nodiscard.
|
|
398
|
-
*
|
|
399
|
-
* @remarks
|
|
400
|
-
* Boolean flag indicating that the member's return value should not
|
|
401
|
-
* be ignored by callers. This C++17 attribute helps prevent common
|
|
402
|
-
* programming errors where important return values are discarded.
|
|
403
|
-
*/
|
|
404
49
|
nodiscard?: boolean | undefined;
|
|
405
|
-
/**
|
|
406
|
-
* Indicates whether the member is declared as constexpr.
|
|
407
|
-
*
|
|
408
|
-
* @remarks
|
|
409
|
-
* Boolean flag indicating that the member can be evaluated at compile
|
|
410
|
-
* time when given constant expressions as arguments. This C++11 feature
|
|
411
|
-
* enables compile-time computation and optimization.
|
|
412
|
-
*/
|
|
413
50
|
constexpr?: boolean | undefined;
|
|
414
|
-
/**
|
|
415
|
-
* Indicates whether the member is declared as consteval.
|
|
416
|
-
*
|
|
417
|
-
* @remarks
|
|
418
|
-
* Boolean flag indicating that the member must be evaluated at compile
|
|
419
|
-
* time. This C++20 feature is stronger than constexpr, requiring
|
|
420
|
-
* immediate evaluation during compilation.
|
|
421
|
-
*/
|
|
422
51
|
consteval?: boolean | undefined;
|
|
423
|
-
/**
|
|
424
|
-
* Indicates whether the member is declared as constinit.
|
|
425
|
-
*
|
|
426
|
-
* @remarks
|
|
427
|
-
* Boolean flag indicating that the member must be initialized with
|
|
428
|
-
* a constant expression during static initialization. This C++20
|
|
429
|
-
* feature helps prevent initialization order issues.
|
|
430
|
-
*/
|
|
431
52
|
constinit?: boolean | undefined;
|
|
432
|
-
/**
|
|
433
|
-
* Indicates whether the member is declared as final.
|
|
434
|
-
*
|
|
435
|
-
* @remarks
|
|
436
|
-
* Boolean flag indicating that virtual members cannot be overridden
|
|
437
|
-
* in derived classes. This provides explicit control over inheritance
|
|
438
|
-
* hierarchies and enables compiler optimizations.
|
|
439
|
-
*/
|
|
440
53
|
final?: boolean | undefined;
|
|
441
|
-
/**
|
|
442
|
-
* Constructs a new member definition data model from XML element data.
|
|
443
|
-
*
|
|
444
|
-
* @param xml - The XML parser instance for processing element data
|
|
445
|
-
* @param element - The XML element containing member definition information
|
|
446
|
-
* @param elementName - The name of the XML element being processed
|
|
447
|
-
*
|
|
448
|
-
* @remarks
|
|
449
|
-
* Processes the comprehensive XML element representing member definition
|
|
450
|
-
* information and extracts all available metadata including location data,
|
|
451
|
-
* type information, parameters, descriptions, and language-specific
|
|
452
|
-
* attributes. The constructor handles the complex memberdefType schema
|
|
453
|
-
* with its extensive set of optional elements and attributes.
|
|
454
|
-
*
|
|
455
|
-
* The implementation validates mandatory elements (name, location, kind,
|
|
456
|
-
* id, protection) whilst gracefully handling optional elements and
|
|
457
|
-
* attributes. It processes various member types including functions,
|
|
458
|
-
* variables, typedefs, enums, and specialised constructs from multiple
|
|
459
|
-
* programming languages and frameworks.
|
|
460
|
-
*
|
|
461
|
-
* @public
|
|
462
|
-
*/
|
|
463
54
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
464
55
|
}
|
|
465
|
-
/**
|
|
466
|
-
* Concrete implementation for memberdef elements within compound documentation.
|
|
467
|
-
*
|
|
468
|
-
* @remarks
|
|
469
|
-
* Provides specific handling for memberdef XML elements that contain
|
|
470
|
-
* comprehensive member definition information within classes, structures,
|
|
471
|
-
* namespaces, and other compound types. This implementation extends the
|
|
472
|
-
* abstract base class functionality to process the complete range of
|
|
473
|
-
* member definitions including functions, variables, typedefs, enums,
|
|
474
|
-
* and specialised language constructs.
|
|
475
|
-
*
|
|
476
|
-
* The class ensures proper instantiation of member definition data models
|
|
477
|
-
* whilst maintaining all the detailed metadata required for accurate
|
|
478
|
-
* documentation generation including cross-references, location information,
|
|
479
|
-
* and language-specific attributes.
|
|
480
|
-
*
|
|
481
|
-
* @public
|
|
482
|
-
*/
|
|
483
56
|
export declare class MemberDefDataModel extends AbstractMemberDefType {
|
|
484
|
-
/**
|
|
485
|
-
* Constructs a new memberdef data model instance.
|
|
486
|
-
*
|
|
487
|
-
* @param xml - The XML parser instance for processing elements
|
|
488
|
-
* @param element - The source XML element containing memberdef data
|
|
489
|
-
*
|
|
490
|
-
* @remarks
|
|
491
|
-
* Initialises the data model with the specific element name 'memberdef'
|
|
492
|
-
* and delegates processing to the abstract base class implementation.
|
|
493
|
-
* This ensures consistent handling of member definition information
|
|
494
|
-
* whilst maintaining proper element identification.
|
|
495
|
-
*
|
|
496
|
-
* @public
|
|
497
|
-
*/
|
|
498
57
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
499
58
|
}
|
|
500
59
|
//# sourceMappingURL=memberdeftype-dm.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"memberdeftype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/memberdeftype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EACL,yBAAyB,EACzB,4BAA4B,EAC5B,0BAA0B,EAC3B,MAAM,yBAAyB,CAAA;AAChC,OAAO,
|
|
1
|
+
{"version":3,"file":"memberdeftype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/memberdeftype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EACL,yBAAyB,EACzB,4BAA4B,EAC5B,0BAA0B,EAC3B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,aAAa,EACd,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAA;AAC1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EACL,oBAAoB,EAErB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,uBAAuB,CAAA;AA4H9B,MAAM,MAAM,aAAa,GACrB,QAAQ,GACR,UAAU,GACV,OAAO,GACP,UAAU,GACV,SAAS,GACT,MAAM,GACN,UAAU,GACV,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,MAAM,GACN,MAAM,GACN,WAAW,GACX,SAAS,CAAA;AAiBb,8BAAsB,sBAAuB,SAAQ,qBAAqB;IAWxE,IAAI,SAAK;IAaT,IAAI,SAAK;CACV;AAoBD,8BAAsB,qBAAsB,SAAQ,sBAAsB;IAYxE,QAAQ,EAAE,iBAAiB,GAAG,SAAS,CAAA;IAYvC,EAAE,SAAK;IAYP,IAAI,SAAK;IAaT,OAAO,EAAE,OAAO,GAAG,SAAS,CAAA;IAY5B,iBAAiB,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAA;IAY1D,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS,CAAA;IAYhC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAY/B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAY/B,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAalC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAW7B,YAAY,CAAC,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAA;IAWjD,gBAAgB,CAAC,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAA;IAYrD,MAAM,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAA;IAWrC,UAAU,CAAC,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAA;IAW7C,cAAc,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAA;IAWpD,WAAW,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAA;IAY9C,gBAAgB,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAA;IAWxD,mBAAmB,CAAC,EAAE,4BAA4B,GAAG,SAAS,CAAA;IAU9D,iBAAiB,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAA;IAU1D,UAAU,CAAC,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAA;IAW7C,YAAY,CAAC,EAAE,qBAAqB,EAAE,GAAG,SAAS,CAAA;IAYlD,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU5B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU5B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU5B,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU9B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU5B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU7B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAWzB,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU9B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU7B,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU9B,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAUxC,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU/B,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU/B,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU/B,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAU/B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;gBAyBf,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA8JxE;AAwBD,qBAAa,kBAAmB,SAAQ,qBAAqB;gBAe/C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
|