@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,86 +1,12 @@
|
|
|
1
1
|
import type { Workspace } from '../workspace.js';
|
|
2
|
-
/**
|
|
3
|
-
* Abstract base class for renderers that output string content.
|
|
4
|
-
*
|
|
5
|
-
* @remarks
|
|
6
|
-
* Provides common functionality for element renderers that convert
|
|
7
|
-
* Doxygen XML elements into formatted string output. Maintains a
|
|
8
|
-
* reference to the workspace for accessing configuration and utilities.
|
|
9
|
-
*
|
|
10
|
-
* @public
|
|
11
|
-
*/
|
|
12
2
|
export declare abstract class ElementStringRendererBase {
|
|
13
|
-
/**
|
|
14
|
-
* The workspace containing global configuration and utilities.
|
|
15
|
-
*
|
|
16
|
-
* @remarks
|
|
17
|
-
* Provides access to rendering utilities, permalink generation,
|
|
18
|
-
* and global configuration options needed for element processing.
|
|
19
|
-
*/
|
|
20
3
|
workspace: Workspace;
|
|
21
|
-
/**
|
|
22
|
-
* Creates a new string element renderer.
|
|
23
|
-
*
|
|
24
|
-
* @remarks
|
|
25
|
-
* Initialises the renderer with the workspace reference for accessing
|
|
26
|
-
* global configuration and rendering utilities.
|
|
27
|
-
*
|
|
28
|
-
* @param workspace - The workspace instance
|
|
29
|
-
*/
|
|
30
4
|
constructor(workspace: Workspace);
|
|
31
|
-
/**
|
|
32
|
-
* Renders an element to a formatted string.
|
|
33
|
-
*
|
|
34
|
-
* @remarks
|
|
35
|
-
* Abstract method that must be implemented by derived classes to
|
|
36
|
-
* convert specific element types into their string representation.
|
|
37
|
-
*
|
|
38
|
-
* @param element - The element to render
|
|
39
|
-
* @param type - The rendering context type
|
|
40
|
-
* @returns Formatted string output
|
|
41
|
-
*/
|
|
42
5
|
abstract renderToString(element: object, type: string): string;
|
|
43
6
|
}
|
|
44
|
-
/**
|
|
45
|
-
* Abstract base class for renderers that output multiple lines.
|
|
46
|
-
*
|
|
47
|
-
* @remarks
|
|
48
|
-
* Provides common functionality for element renderers that convert
|
|
49
|
-
* Doxygen XML elements into formatted multi-line output. Maintains
|
|
50
|
-
* a reference to the workspace for accessing configuration and utilities.
|
|
51
|
-
*
|
|
52
|
-
* @public
|
|
53
|
-
*/
|
|
54
7
|
export declare abstract class ElementLinesRendererBase {
|
|
55
|
-
/**
|
|
56
|
-
* The workspace containing global configuration and utilities.
|
|
57
|
-
*
|
|
58
|
-
* @remarks
|
|
59
|
-
* Provides access to rendering utilities, permalink generation,
|
|
60
|
-
* and global configuration options needed for element processing.
|
|
61
|
-
*/
|
|
62
8
|
workspace: Workspace;
|
|
63
|
-
/**
|
|
64
|
-
* Creates a new lines element renderer.
|
|
65
|
-
*
|
|
66
|
-
* @remarks
|
|
67
|
-
* Initialises the renderer with the workspace reference for accessing
|
|
68
|
-
* global configuration and rendering utilities.
|
|
69
|
-
*
|
|
70
|
-
* @param workspace - The workspace instance
|
|
71
|
-
*/
|
|
72
9
|
constructor(workspace: Workspace);
|
|
73
|
-
/**
|
|
74
|
-
* Renders an element to an array of formatted lines.
|
|
75
|
-
*
|
|
76
|
-
* @remarks
|
|
77
|
-
* Abstract method that must be implemented by derived classes to
|
|
78
|
-
* convert specific element types into their multi-line representation.
|
|
79
|
-
*
|
|
80
|
-
* @param element - The element to render
|
|
81
|
-
* @param type - The rendering context type
|
|
82
|
-
* @returns Array of formatted output lines
|
|
83
|
-
*/
|
|
84
10
|
abstract renderToLines(element: object, type: string): string[];
|
|
85
11
|
}
|
|
86
12
|
//# sourceMappingURL=element-renderer-base.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"element-renderer-base.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/element-renderer-base.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;
|
|
1
|
+
{"version":3,"file":"element-renderer-base.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/element-renderer-base.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAchD,8BAAsB,yBAAyB;IAQ7C,SAAS,EAAE,SAAS,CAAA;gBAWR,SAAS,EAAE,SAAS;IAehC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAC/D;AAYD,8BAAsB,wBAAwB;IAQ5C,SAAS,EAAE,SAAS,CAAA;gBAWR,SAAS,EAAE,SAAS;IAehC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAChE"}
|
|
@@ -1,77 +1,13 @@
|
|
|
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
|
-
/**
|
|
13
|
-
* Abstract base class for renderers that output string content.
|
|
14
|
-
*
|
|
15
|
-
* @remarks
|
|
16
|
-
* Provides common functionality for element renderers that convert
|
|
17
|
-
* Doxygen XML elements into formatted string output. Maintains a
|
|
18
|
-
* reference to the workspace for accessing configuration and utilities.
|
|
19
|
-
*
|
|
20
|
-
* @public
|
|
21
|
-
*/
|
|
22
1
|
export class ElementStringRendererBase {
|
|
23
|
-
/**
|
|
24
|
-
* The workspace containing global configuration and utilities.
|
|
25
|
-
*
|
|
26
|
-
* @remarks
|
|
27
|
-
* Provides access to rendering utilities, permalink generation,
|
|
28
|
-
* and global configuration options needed for element processing.
|
|
29
|
-
*/
|
|
30
2
|
workspace;
|
|
31
|
-
/**
|
|
32
|
-
* Creates a new string element renderer.
|
|
33
|
-
*
|
|
34
|
-
* @remarks
|
|
35
|
-
* Initialises the renderer with the workspace reference for accessing
|
|
36
|
-
* global configuration and rendering utilities.
|
|
37
|
-
*
|
|
38
|
-
* @param workspace - The workspace instance
|
|
39
|
-
*/
|
|
40
3
|
constructor(workspace) {
|
|
41
4
|
this.workspace = workspace;
|
|
42
5
|
}
|
|
43
6
|
}
|
|
44
|
-
/**
|
|
45
|
-
* Abstract base class for renderers that output multiple lines.
|
|
46
|
-
*
|
|
47
|
-
* @remarks
|
|
48
|
-
* Provides common functionality for element renderers that convert
|
|
49
|
-
* Doxygen XML elements into formatted multi-line output. Maintains
|
|
50
|
-
* a reference to the workspace for accessing configuration and utilities.
|
|
51
|
-
*
|
|
52
|
-
* @public
|
|
53
|
-
*/
|
|
54
7
|
export class ElementLinesRendererBase {
|
|
55
|
-
/**
|
|
56
|
-
* The workspace containing global configuration and utilities.
|
|
57
|
-
*
|
|
58
|
-
* @remarks
|
|
59
|
-
* Provides access to rendering utilities, permalink generation,
|
|
60
|
-
* and global configuration options needed for element processing.
|
|
61
|
-
*/
|
|
62
8
|
workspace;
|
|
63
|
-
/**
|
|
64
|
-
* Creates a new lines element renderer.
|
|
65
|
-
*
|
|
66
|
-
* @remarks
|
|
67
|
-
* Initialises the renderer with the workspace reference for accessing
|
|
68
|
-
* global configuration and rendering utilities.
|
|
69
|
-
*
|
|
70
|
-
* @param workspace - The workspace instance
|
|
71
|
-
*/
|
|
72
9
|
constructor(workspace) {
|
|
73
10
|
this.workspace = workspace;
|
|
74
11
|
}
|
|
75
12
|
}
|
|
76
|
-
// ----------------------------------------------------------------------------
|
|
77
13
|
//# sourceMappingURL=element-renderer-base.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"element-renderer-base.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/element-renderer-base.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"element-renderer-base.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/element-renderer-base.ts"],"names":[],"mappings":"AA2BA,MAAM,OAAgB,yBAAyB;IAQ7C,SAAS,CAAW;IAWpB,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CAcF;AAYD,MAAM,OAAgB,wBAAwB;IAQ5C,SAAS,CAAW;IAWpB,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CAcF"}
|
|
@@ -1,29 +1,6 @@
|
|
|
1
1
|
import { ElementLinesRendererBase } from './element-renderer-base.js';
|
|
2
2
|
import type { AbstractIncType } from '../../doxygen/data-model/compounds/inctype-dm.js';
|
|
3
|
-
/**
|
|
4
|
-
* Renderer for include directive elements in documentation.
|
|
5
|
-
*
|
|
6
|
-
* @remarks
|
|
7
|
-
* Handles the rendering of #include statements found in source code,
|
|
8
|
-
* converting them to appropriate HTML output with proper link generation
|
|
9
|
-
* when the included file is documented.
|
|
10
|
-
*
|
|
11
|
-
* @public
|
|
12
|
-
*/
|
|
13
3
|
export declare class IncTypeLinesRenderer extends ElementLinesRendererBase {
|
|
14
|
-
/**
|
|
15
|
-
* Renders an include element to formatted output lines.
|
|
16
|
-
*
|
|
17
|
-
* @remarks
|
|
18
|
-
* Converts Doxygen include elements into HTML format with appropriate
|
|
19
|
-
* angle brackets or quotes, and creates links to documented files
|
|
20
|
-
* when available. Handles both local includes (quotes) and system
|
|
21
|
-
* includes (angle brackets).
|
|
22
|
-
*
|
|
23
|
-
* @param element - The include element to render
|
|
24
|
-
* @param type - The rendering context type
|
|
25
|
-
* @returns Array of formatted output lines
|
|
26
|
-
*/
|
|
27
4
|
renderToLines(element: AbstractIncType, type: string): string[];
|
|
28
5
|
}
|
|
29
6
|
//# sourceMappingURL=inctype.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"inctype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/inctype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kDAAkD,CAAA;
|
|
1
|
+
{"version":3,"file":"inctype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/inctype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kDAAkD,CAAA;AAcvF,qBAAa,oBAAqB,SAAQ,wBAAwB;IAcvD,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CA2BzE"}
|
|
@@ -1,49 +1,10 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* This file is part of the xPack project (http://xpack.github.io).
|
|
3
|
-
* Copyright (c) 2025 Liviu Ionescu. All rights reserved.
|
|
4
|
-
*
|
|
5
|
-
* Permission to use, copy, modify, and/or distribute this software
|
|
6
|
-
* for any purpose is hereby granted, under the terms of the MIT license.
|
|
7
|
-
*
|
|
8
|
-
* If a copy of the license was not distributed with this file, it can
|
|
9
|
-
* be obtained from https://opensource.org/licenses/MIT.
|
|
10
|
-
*/
|
|
11
|
-
// ----------------------------------------------------------------------------
|
|
12
|
-
// import assert from 'node:assert'
|
|
13
|
-
// import * as util from 'node:util'
|
|
14
1
|
import { ElementLinesRendererBase } from './element-renderer-base.js';
|
|
15
|
-
// ----------------------------------------------------------------------------
|
|
16
|
-
/**
|
|
17
|
-
* Renderer for include directive elements in documentation.
|
|
18
|
-
*
|
|
19
|
-
* @remarks
|
|
20
|
-
* Handles the rendering of #include statements found in source code,
|
|
21
|
-
* converting them to appropriate HTML output with proper link generation
|
|
22
|
-
* when the included file is documented.
|
|
23
|
-
*
|
|
24
|
-
* @public
|
|
25
|
-
*/
|
|
26
2
|
export class IncTypeLinesRenderer extends ElementLinesRendererBase {
|
|
27
|
-
/**
|
|
28
|
-
* Renders an include element to formatted output lines.
|
|
29
|
-
*
|
|
30
|
-
* @remarks
|
|
31
|
-
* Converts Doxygen include elements into HTML format with appropriate
|
|
32
|
-
* angle brackets or quotes, and creates links to documented files
|
|
33
|
-
* when available. Handles both local includes (quotes) and system
|
|
34
|
-
* includes (angle brackets).
|
|
35
|
-
*
|
|
36
|
-
* @param element - The include element to render
|
|
37
|
-
* @param type - The rendering context type
|
|
38
|
-
* @returns Array of formatted output lines
|
|
39
|
-
*/
|
|
40
3
|
renderToLines(element, type) {
|
|
41
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
42
4
|
const lines = [];
|
|
43
5
|
let permalink = '';
|
|
44
6
|
if (element.refId !== undefined) {
|
|
45
7
|
permalink = this.workspace.getPagePermalink(element.refId);
|
|
46
|
-
// May be undefined.
|
|
47
8
|
}
|
|
48
9
|
const content = this.workspace.renderString(element.text.trim(), type);
|
|
49
10
|
let text = '';
|
|
@@ -56,10 +17,8 @@ export class IncTypeLinesRenderer extends ElementLinesRendererBase {
|
|
|
56
17
|
text += content;
|
|
57
18
|
}
|
|
58
19
|
text += element.local ? '"' : '>';
|
|
59
|
-
// text += '</code>'
|
|
60
20
|
lines.push(text);
|
|
61
21
|
return lines;
|
|
62
22
|
}
|
|
63
23
|
}
|
|
64
|
-
// ----------------------------------------------------------------------------
|
|
65
24
|
//# sourceMappingURL=inctype.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"inctype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/inctype.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"inctype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/inctype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAerE,MAAM,OAAO,oBAAqB,SAAQ,wBAAwB;IAcvD,aAAa,CAAC,OAAwB,EAAE,IAAY;QAG3D,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,IAAI,SAAS,GAAuB,EAAE,CAAA;QACtC,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAE5D,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;QACtE,IAAI,IAAI,GAAG,EAAE,CAAA;QACb,IAAI,IAAI,WAAW,CAAA;QACnB,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAA;QACpC,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,IAAI,IAAI,YAAY,SAAS,KAAK,OAAO,MAAM,CAAA;QACjD,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,OAAO,CAAA;QACjB,CAAC;QACD,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAA;QAGpC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEhB,OAAO,KAAK,CAAA;IACd,CAAC;CACF"}
|
|
@@ -1,28 +1,6 @@
|
|
|
1
1
|
import { ElementStringRendererBase } from './element-renderer-base.js';
|
|
2
2
|
import type { AbstractLinkedTextType } from '../../doxygen/data-model/compounds/linkedtexttype-dm.js';
|
|
3
|
-
/**
|
|
4
|
-
* Renderer for Doxygen linked text elements containing mixed content.
|
|
5
|
-
*
|
|
6
|
-
* @remarks
|
|
7
|
-
* Handles complex text structures that contain both character data and
|
|
8
|
-
* reference elements. Renders child elements recursively to build the
|
|
9
|
-
* complete text output with embedded links.
|
|
10
|
-
*
|
|
11
|
-
* @public
|
|
12
|
-
*/
|
|
13
3
|
export declare class LinkedTextTypeStringRenderer extends ElementStringRendererBase {
|
|
14
|
-
/**
|
|
15
|
-
* Renders a linked text element to a formatted string.
|
|
16
|
-
*
|
|
17
|
-
* @remarks
|
|
18
|
-
* Processes all child elements in sequence to generate the complete
|
|
19
|
-
* text output with embedded references and mixed content. Maintains
|
|
20
|
-
* the original order of text and reference elements.
|
|
21
|
-
*
|
|
22
|
-
* @param element - The linked text element to render
|
|
23
|
-
* @param type - The rendering context type
|
|
24
|
-
* @returns The formatted string with mixed content
|
|
25
|
-
*/
|
|
26
4
|
renderToString(element: AbstractLinkedTextType, type: string): string;
|
|
27
5
|
}
|
|
28
6
|
//# sourceMappingURL=linkedtexttype.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"linkedtexttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/linkedtexttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yDAAyD,CAAA;
|
|
1
|
+
{"version":3,"file":"linkedtexttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/linkedtexttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yDAAyD,CAAA;AAsBrG,qBAAa,4BAA6B,SAAQ,yBAAyB;IAazE,cAAc,CAAC,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAStE"}
|
|
@@ -1,54 +1,9 @@
|
|
|
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
|
-
// import assert from 'node:assert'
|
|
13
|
-
// import * as util from 'node:util'
|
|
14
1
|
import { ElementStringRendererBase } from './element-renderer-base.js';
|
|
15
|
-
// ----------------------------------------------------------------------------
|
|
16
|
-
// <xsd:complexType name="linkedTextType" mixed="true"> <-- Character data
|
|
17
|
-
// is allowed to appear between the child elements!
|
|
18
|
-
// <xsd:sequence>
|
|
19
|
-
// <xsd:element name="ref" type="refTextType" minOccurs="0"
|
|
20
|
-
// maxOccurs="unbounded" />
|
|
21
|
-
// </xsd:sequence>
|
|
22
|
-
// </xsd:complexType>
|
|
23
|
-
/**
|
|
24
|
-
* Renderer for Doxygen linked text elements containing mixed content.
|
|
25
|
-
*
|
|
26
|
-
* @remarks
|
|
27
|
-
* Handles complex text structures that contain both character data and
|
|
28
|
-
* reference elements. Renders child elements recursively to build the
|
|
29
|
-
* complete text output with embedded links.
|
|
30
|
-
*
|
|
31
|
-
* @public
|
|
32
|
-
*/
|
|
33
2
|
export class LinkedTextTypeStringRenderer extends ElementStringRendererBase {
|
|
34
|
-
/**
|
|
35
|
-
* Renders a linked text element to a formatted string.
|
|
36
|
-
*
|
|
37
|
-
* @remarks
|
|
38
|
-
* Processes all child elements in sequence to generate the complete
|
|
39
|
-
* text output with embedded references and mixed content. Maintains
|
|
40
|
-
* the original order of text and reference elements.
|
|
41
|
-
*
|
|
42
|
-
* @param element - The linked text element to render
|
|
43
|
-
* @param type - The rendering context type
|
|
44
|
-
* @returns The formatted string with mixed content
|
|
45
|
-
*/
|
|
46
3
|
renderToString(element, type) {
|
|
47
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
48
4
|
let text = '';
|
|
49
5
|
text += this.workspace.renderElementsArrayToString(element.children, type);
|
|
50
6
|
return text;
|
|
51
7
|
}
|
|
52
8
|
}
|
|
53
|
-
// ----------------------------------------------------------------------------
|
|
54
9
|
//# sourceMappingURL=linkedtexttype.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"linkedtexttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/linkedtexttype.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"linkedtexttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/linkedtexttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AAuBtE,MAAM,OAAO,4BAA6B,SAAQ,yBAAyB;IAazE,cAAc,CAAC,OAA+B,EAAE,IAAY;QAG1D,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAE1E,OAAO,IAAI,CAAA;IACb,CAAC;CACF"}
|
|
@@ -1,62 +1,10 @@
|
|
|
1
1
|
import { type AbstractHighlightType, type AbstractListingTypeBase } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
|
|
2
2
|
import { ElementLinesRendererBase } from './element-renderer-base.js';
|
|
3
|
-
/**
|
|
4
|
-
* Renderer for program listing elements in documentation.
|
|
5
|
-
*
|
|
6
|
-
* @remarks
|
|
7
|
-
* Handles the rendering of source code listings as parsed from Doxygen XML,
|
|
8
|
-
* converting them into formatted HTML output with syntax highlighting and
|
|
9
|
-
* line numbering. Supports both full program listings and member-specific
|
|
10
|
-
* code segments.
|
|
11
|
-
*
|
|
12
|
-
* @public
|
|
13
|
-
*/
|
|
14
3
|
export declare class ListingTypeLinesRenderer extends ElementLinesRendererBase {
|
|
15
|
-
/**
|
|
16
|
-
* Renders a program listing element to formatted output lines.
|
|
17
|
-
*
|
|
18
|
-
* @remarks
|
|
19
|
-
* Converts Doxygen program listing elements into HTML with appropriate
|
|
20
|
-
* CSS classes, line numbers, and syntax highlighting. Handles anchor
|
|
21
|
-
* generation for navigation and cross-referencing.
|
|
22
|
-
*
|
|
23
|
-
* @param element - The listing element to render
|
|
24
|
-
* @param type - The rendering context type
|
|
25
|
-
* @returns Array of formatted output lines
|
|
26
|
-
*/
|
|
27
4
|
renderToLines(element: AbstractListingTypeBase, type: string): string[];
|
|
28
5
|
}
|
|
29
|
-
/**
|
|
30
|
-
* Renderer for syntax highlighting elements in code listings.
|
|
31
|
-
*
|
|
32
|
-
* @remarks
|
|
33
|
-
* Handles the rendering of syntax-highlighted code segments by converting
|
|
34
|
-
* Doxygen highlight elements into HTML spans with appropriate CSS classes.
|
|
35
|
-
* Optimised for direct HTML generation to improve build performance.
|
|
36
|
-
*
|
|
37
|
-
* @public
|
|
38
|
-
*/
|
|
39
6
|
export declare class HighlightTypeLinesRenderer extends ElementLinesRendererBase {
|
|
40
|
-
/**
|
|
41
|
-
* Mapping of Doxygen highlight classes to CSS class names.
|
|
42
|
-
*
|
|
43
|
-
* @remarks
|
|
44
|
-
* Maps Doxygen's built-in highlight types to corresponding CSS classes
|
|
45
|
-
* for consistent syntax highlighting across different code elements.
|
|
46
|
-
*/
|
|
47
7
|
knownClasses: Record<string, string>;
|
|
48
|
-
/**
|
|
49
|
-
* Renders a syntax highlight element to formatted output lines.
|
|
50
|
-
*
|
|
51
|
-
* @remarks
|
|
52
|
-
* Converts Doxygen highlight elements into HTML span elements with
|
|
53
|
-
* appropriate CSS classes for syntax highlighting. Handles unknown
|
|
54
|
-
* highlight types by falling back to a default class.
|
|
55
|
-
*
|
|
56
|
-
* @param element - The highlight element to render
|
|
57
|
-
* @param type - The rendering context type
|
|
58
|
-
* @returns Array containing the formatted HTML span
|
|
59
|
-
*/
|
|
60
8
|
renderToLines(element: AbstractHighlightType, type: string): string[];
|
|
61
9
|
}
|
|
62
10
|
//# sourceMappingURL=listingtype.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"listingtype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/listingtype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAGL,KAAK,qBAAqB,EAE1B,KAAK,uBAAuB,EAE7B,MAAM,0DAA0D,CAAA;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;
|
|
1
|
+
{"version":3,"file":"listingtype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/listingtype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAGL,KAAK,qBAAqB,EAE1B,KAAK,uBAAuB,EAE7B,MAAM,0DAA0D,CAAA;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAgBrE,qBAAa,wBAAyB,SAAQ,wBAAwB;IAa3D,aAAa,CACpB,OAAO,EAAE,uBAAuB,EAEhC,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAgCZ;AA8ED,qBAAa,0BAA2B,SAAQ,wBAAwB;IAQtE,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAanC;IAcQ,aAAa,CACpB,OAAO,EAAE,qBAAqB,EAC9B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CA2BZ"}
|
|
@@ -1,47 +1,9 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* This file is part of the xPack project (http://xpack.github.io).
|
|
3
|
-
* Copyright (c) 2025 Liviu Ionescu. All rights reserved.
|
|
4
|
-
*
|
|
5
|
-
* Permission to use, copy, modify, and/or distribute this software
|
|
6
|
-
* for any purpose is hereby granted, under the terms of the MIT license.
|
|
7
|
-
*
|
|
8
|
-
* If a copy of the license was not distributed with this file, it can
|
|
9
|
-
* be obtained from https://opensource.org/licenses/MIT.
|
|
10
|
-
*/
|
|
11
|
-
// ----------------------------------------------------------------------------
|
|
12
1
|
import assert from 'node:assert';
|
|
13
2
|
import util from 'node:util';
|
|
14
3
|
import { CodeLineDataModel, HighlightDataModel, MemberProgramListingDataModel, } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
|
|
15
4
|
import { ElementLinesRendererBase } from './element-renderer-base.js';
|
|
16
|
-
// ----------------------------------------------------------------------------
|
|
17
|
-
/**
|
|
18
|
-
* Renderer for program listing elements in documentation.
|
|
19
|
-
*
|
|
20
|
-
* @remarks
|
|
21
|
-
* Handles the rendering of source code listings as parsed from Doxygen XML,
|
|
22
|
-
* converting them into formatted HTML output with syntax highlighting and
|
|
23
|
-
* line numbering. Supports both full program listings and member-specific
|
|
24
|
-
* code segments.
|
|
25
|
-
*
|
|
26
|
-
* @public
|
|
27
|
-
*/
|
|
28
5
|
export class ListingTypeLinesRenderer extends ElementLinesRendererBase {
|
|
29
|
-
|
|
30
|
-
* Renders a program listing element to formatted output lines.
|
|
31
|
-
*
|
|
32
|
-
* @remarks
|
|
33
|
-
* Converts Doxygen program listing elements into HTML with appropriate
|
|
34
|
-
* CSS classes, line numbers, and syntax highlighting. Handles anchor
|
|
35
|
-
* generation for navigation and cross-referencing.
|
|
36
|
-
*
|
|
37
|
-
* @param element - The listing element to render
|
|
38
|
-
* @param type - The rendering context type
|
|
39
|
-
* @returns Array of formatted output lines
|
|
40
|
-
*/
|
|
41
|
-
renderToLines(element,
|
|
42
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
43
|
-
type) {
|
|
44
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
6
|
+
renderToLines(element, type) {
|
|
45
7
|
if (element.codelines === undefined) {
|
|
46
8
|
return [];
|
|
47
9
|
}
|
|
@@ -54,8 +16,6 @@ export class ListingTypeLinesRenderer extends ElementLinesRendererBase {
|
|
|
54
16
|
lines.push('<div class="doxyProgramListing">');
|
|
55
17
|
lines.push('');
|
|
56
18
|
for (const codeline of element.codelines) {
|
|
57
|
-
// Explicit type, since it may come from a markdown environment,
|
|
58
|
-
// like in the Doxygen docblocks page.
|
|
59
19
|
lines.push(renderCodeLinesToString(this.workspace, codeline, 'html', showAnchor));
|
|
60
20
|
}
|
|
61
21
|
lines.push('');
|
|
@@ -64,22 +24,7 @@ export class ListingTypeLinesRenderer extends ElementLinesRendererBase {
|
|
|
64
24
|
return lines;
|
|
65
25
|
}
|
|
66
26
|
}
|
|
67
|
-
/**
|
|
68
|
-
* Renders individual code lines with syntax highlighting and line numbers.
|
|
69
|
-
*
|
|
70
|
-
* @remarks
|
|
71
|
-
* Converts a single code line element into HTML format with appropriate
|
|
72
|
-
* line numbering, anchors for navigation, and syntax highlighting support.
|
|
73
|
-
* Handles permalink generation for cross-references when available.
|
|
74
|
-
*
|
|
75
|
-
* @param workspace - The workspace instance for rendering utilities
|
|
76
|
-
* @param element - The code line element to render
|
|
77
|
-
* @param type - The rendering context type
|
|
78
|
-
* @param showAnchor - Whether to include anchor elements for navigation
|
|
79
|
-
* @returns Formatted HTML string for the code line
|
|
80
|
-
*/
|
|
81
27
|
function renderCodeLinesToString(workspace, element, type, showAnchor) {
|
|
82
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
83
28
|
assert(element instanceof CodeLineDataModel);
|
|
84
29
|
if (element.external !== undefined) {
|
|
85
30
|
console.error('external ignored in', element.constructor.name);
|
|
@@ -117,24 +62,7 @@ function renderCodeLinesToString(workspace, element, type, showAnchor) {
|
|
|
117
62
|
text += '</div>';
|
|
118
63
|
return text;
|
|
119
64
|
}
|
|
120
|
-
/**
|
|
121
|
-
* Renderer for syntax highlighting elements in code listings.
|
|
122
|
-
*
|
|
123
|
-
* @remarks
|
|
124
|
-
* Handles the rendering of syntax-highlighted code segments by converting
|
|
125
|
-
* Doxygen highlight elements into HTML spans with appropriate CSS classes.
|
|
126
|
-
* Optimised for direct HTML generation to improve build performance.
|
|
127
|
-
*
|
|
128
|
-
* @public
|
|
129
|
-
*/
|
|
130
65
|
export class HighlightTypeLinesRenderer extends ElementLinesRendererBase {
|
|
131
|
-
/**
|
|
132
|
-
* Mapping of Doxygen highlight classes to CSS class names.
|
|
133
|
-
*
|
|
134
|
-
* @remarks
|
|
135
|
-
* Maps Doxygen's built-in highlight types to corresponding CSS classes
|
|
136
|
-
* for consistent syntax highlighting across different code elements.
|
|
137
|
-
*/
|
|
138
66
|
knownClasses = {
|
|
139
67
|
normal: 'doxyHighlight',
|
|
140
68
|
charliteral: 'doxyHighlightCharLiteral',
|
|
@@ -149,23 +77,9 @@ export class HighlightTypeLinesRenderer extends ElementLinesRendererBase {
|
|
|
149
77
|
vhdlkeyword: 'doxyHighlightVhdlKeyword',
|
|
150
78
|
vhdllogic: 'doxyHighlightVhdlLogic',
|
|
151
79
|
};
|
|
152
|
-
/**
|
|
153
|
-
* Renders a syntax highlight element to formatted output lines.
|
|
154
|
-
*
|
|
155
|
-
* @remarks
|
|
156
|
-
* Converts Doxygen highlight elements into HTML span elements with
|
|
157
|
-
* appropriate CSS classes for syntax highlighting. Handles unknown
|
|
158
|
-
* highlight types by falling back to a default class.
|
|
159
|
-
*
|
|
160
|
-
* @param element - The highlight element to render
|
|
161
|
-
* @param type - The rendering context type
|
|
162
|
-
* @returns Array containing the formatted HTML span
|
|
163
|
-
*/
|
|
164
80
|
renderToLines(element, type) {
|
|
165
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
166
81
|
assert(element instanceof HighlightDataModel);
|
|
167
82
|
let spanClass = this.knownClasses[element.classs];
|
|
168
|
-
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
169
83
|
if (spanClass === undefined) {
|
|
170
84
|
console.error(util.inspect(element, { compact: false, depth: 999 }));
|
|
171
85
|
console.error(element.classs, 'not implemented yet in', this.constructor.name);
|
|
@@ -181,5 +95,4 @@ export class HighlightTypeLinesRenderer extends ElementLinesRendererBase {
|
|
|
181
95
|
return [text];
|
|
182
96
|
}
|
|
183
97
|
}
|
|
184
|
-
// ----------------------------------------------------------------------------
|
|
185
98
|
//# sourceMappingURL=listingtype.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"listingtype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/listingtype.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"listingtype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/listingtype.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAE5B,OAAO,EAEL,iBAAiB,EAEjB,kBAAkB,EAElB,6BAA6B,GAC9B,MAAM,0DAA0D,CAAA;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAgBrE,MAAM,OAAO,wBAAyB,SAAQ,wBAAwB;IAa3D,aAAa,CACpB,OAAgC,EAEhC,IAAY;QAIZ,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACpC,OAAO,EAAE,CAAA;QACX,CAAC;QAED,IAAI,UAAU,GAAG,IAAI,CAAA;QACrB,IAAI,OAAO,YAAY,6BAA6B,EAAE,CAAC;YACrD,UAAU,GAAG,KAAK,CAAA;QACpB,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAA;QAE9C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YAGzC,KAAK,CAAC,IAAI,CACR,uBAAuB,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CACtE,CAAA;QACH,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACpB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAEd,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAgBD,SAAS,uBAAuB,CAC9B,SAAoB,EACpB,OAA6B,EAC7B,IAAY,EACZ,UAAmB;IAGnB,MAAM,CAAC,OAAO,YAAY,iBAAiB,CAAC,CAAA;IAE5C,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IAChE,CAAC;IAED,IAAI,SAAS,GAAuB,SAAS,CAAA;IAC7C,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjE,SAAS,GAAG,SAAS,CAAC,YAAY,CAAC;YACjC,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,IAAI,GAAG,EAAE,CAAA;IAEb,IAAI,IAAI,4BAA4B,CAAA;IACpC,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACjC,IAAI,IAAI,+BAA+B,CAAA;QACvC,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAA;QAC/D,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,IAAI,UAAU,MAAM,QAAQ,CAAA;QAClC,CAAC;QACD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,IAAI,YAAY,SAAS,KAAK,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAA;QACnE,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAA;QACnC,CAAC;QACD,IAAI,IAAI,SAAS,CAAA;IACnB,CAAC;SAAM,CAAC;QACN,IAAI,IAAI,8CAA8C,CAAA;IACxD,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,2BAA2B,CACnD,OAAO,CAAC,UAAU,EAClB,IAAI,CACL,CAAA;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,IAAI,IAAI,iCAAiC,OAAO,SAAS,CAAA;IAC3D,CAAC;IACD,IAAI,IAAI,QAAQ,CAAA;IAEhB,OAAO,IAAI,CAAA;AACb,CAAC;AAYD,MAAM,OAAO,0BAA2B,SAAQ,wBAAwB;IAQtE,YAAY,GAA2B;QACrC,MAAM,EAAE,eAAe;QACvB,WAAW,EAAE,0BAA0B;QACvC,OAAO,EAAE,sBAAsB;QAC/B,YAAY,EAAE,2BAA2B;QACzC,OAAO,EAAE,sBAAsB;QAC/B,WAAW,EAAE,0BAA0B;QACvC,WAAW,EAAE,0BAA0B;QACvC,KAAK,EAAE,oBAAoB;QAC3B,aAAa,EAAE,4BAA4B;QAC3C,QAAQ,EAAE,uBAAuB;QACjC,WAAW,EAAE,0BAA0B;QACvC,SAAS,EAAE,wBAAwB;KACpC,CAAA;IAcQ,aAAa,CACpB,OAA8B,EAC9B,IAAY;QAGZ,MAAM,CAAC,OAAO,YAAY,kBAAkB,CAAC,CAAA;QAE7C,IAAI,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QAEjD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,MAAM,EACd,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACD,SAAS,GAAG,eAAe,CAAA;QAC7B,CAAC;QAED,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,MAAM,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAA;QACtC,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,IAAI,IAAI,gBAAgB,SAAS,IAAI,CAAA;YACrC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;YAC1E,IAAI,IAAI,SAAS,CAAA;QACnB,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF"}
|
|
@@ -1,28 +1,6 @@
|
|
|
1
1
|
import { ElementLinesRendererBase } from './element-renderer-base.js';
|
|
2
2
|
import type { AbstractParamType } from '../../doxygen/data-model/compounds/paramtype-dm.js';
|
|
3
|
-
/**
|
|
4
|
-
* Renderer for parameter type elements in function documentation.
|
|
5
|
-
*
|
|
6
|
-
* @remarks
|
|
7
|
-
* Handles the rendering of function and method parameters as parsed from
|
|
8
|
-
* Doxygen XML, converting them into formatted output that includes type
|
|
9
|
-
* information, parameter names, and default values when available.
|
|
10
|
-
*
|
|
11
|
-
* @public
|
|
12
|
-
*/
|
|
13
3
|
export declare class ParamTypeLinesRenderer extends ElementLinesRendererBase {
|
|
14
|
-
/**
|
|
15
|
-
* Renders a parameter element to formatted output lines.
|
|
16
|
-
*
|
|
17
|
-
* @remarks
|
|
18
|
-
* Converts Doxygen parameter elements into formatted text including
|
|
19
|
-
* type information, parameter names, array specifications, and default
|
|
20
|
-
* values. Handles both declaration and definition name variants.
|
|
21
|
-
*
|
|
22
|
-
* @param element - The parameter element to render
|
|
23
|
-
* @param type - The rendering context type
|
|
24
|
-
* @returns Array of formatted output lines
|
|
25
|
-
*/
|
|
26
4
|
renderToLines(element: AbstractParamType, type: string): string[];
|
|
27
5
|
}
|
|
28
6
|
//# sourceMappingURL=paramtype.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"paramtype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/paramtype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oDAAoD,CAAA;
|
|
1
|
+
{"version":3,"file":"paramtype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/paramtype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oDAAoD,CAAA;AA4B3F,qBAAa,sBAAuB,SAAQ,wBAAwB;IAazD,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAuD3E"}
|