@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
|
@@ -2,479 +2,62 @@ import { ElementLinesRendererBase, ElementStringRendererBase } from './element-r
|
|
|
2
2
|
import { AbstractDocAnchorType, type AbstractDocBlockQuoteType, AbstractDocEmptyType, AbstractDocFormulaType, type AbstractDocHeadingType, AbstractDocImageType, AbstractDocMarkupType, type AbstractDocParamListType, type AbstractDocParaType, AbstractDocRefTextType, type AbstractDocSimpleSectType, AbstractDocURLLink, AbstractEmojiType, type AbstractPreformattedType, type AbstractSpType, type AbstractVerbatimType, type AbstractDescriptionType } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
|
|
3
3
|
import { AbstractDocHtmlOnlyType } from '../../doxygen/data-model/compounds/compounddef-dm.js';
|
|
4
4
|
import { AbstractDataModelBase } from '../../doxygen/data-model/types.js';
|
|
5
|
-
/**
|
|
6
|
-
* Primary renderer for description type elements in documentation.
|
|
7
|
-
*
|
|
8
|
-
* @remarks
|
|
9
|
-
* Handles the rendering of Doxygen description elements that contain
|
|
10
|
-
* formatted text, converting them into appropriate output lines for
|
|
11
|
-
* documentation generation. Supports both brief and detailed descriptions.
|
|
12
|
-
*
|
|
13
|
-
* @public
|
|
14
|
-
*/
|
|
15
5
|
export declare class DescriptionTypeLinesRenderer extends ElementLinesRendererBase {
|
|
16
6
|
renderToLines(element: AbstractDescriptionType, type: string): string[];
|
|
17
7
|
}
|
|
18
|
-
/**
|
|
19
|
-
* Renderer for Doxygen paragraph elements in documentation.
|
|
20
|
-
*
|
|
21
|
-
* @remarks
|
|
22
|
-
* Handles the complex rendering of paragraph elements that can contain
|
|
23
|
-
* mixed content including text, markup, links, and block-level elements.
|
|
24
|
-
* Manages paragraph boundaries and applies appropriate HTML wrapping.
|
|
25
|
-
*
|
|
26
|
-
* @public
|
|
27
|
-
*/
|
|
28
8
|
export declare class DocParaTypeLinesRenderer extends ElementLinesRendererBase {
|
|
29
|
-
/**
|
|
30
|
-
* Renders a paragraph element to formatted output lines.
|
|
31
|
-
*
|
|
32
|
-
* @remarks
|
|
33
|
-
* Processes child elements to determine paragraph boundaries and applies
|
|
34
|
-
* appropriate HTML paragraph tags when enabled. Handles mixed content
|
|
35
|
-
* including inline elements and block-level elements with proper spacing.
|
|
36
|
-
*
|
|
37
|
-
* @param element - The paragraph element to render
|
|
38
|
-
* @param type - The rendering context type
|
|
39
|
-
* @returns Array of formatted output lines with paragraph structure
|
|
40
|
-
*/
|
|
41
9
|
renderToLines(element: AbstractDocParaType, type: string): string[];
|
|
42
|
-
/**
|
|
43
|
-
* Determines if an element should be rendered within a paragraph context.
|
|
44
|
-
*
|
|
45
|
-
* @remarks
|
|
46
|
-
* Classifies documentation elements as either inline (paragraph content)
|
|
47
|
-
* or block-level elements. This classification controls whether elements
|
|
48
|
-
* are wrapped in paragraph tags or rendered as standalone blocks.
|
|
49
|
-
*
|
|
50
|
-
* @param element - The element to classify
|
|
51
|
-
* @returns True if the element should be rendered within a paragraph
|
|
52
|
-
*/
|
|
53
10
|
isParagraph(element: string | AbstractDataModelBase): boolean;
|
|
54
11
|
}
|
|
55
|
-
/**
|
|
56
|
-
* Renderer for URL link elements in documentation.
|
|
57
|
-
*
|
|
58
|
-
* @remarks
|
|
59
|
-
* Converts Doxygen URL link elements to HTML anchor tags with proper
|
|
60
|
-
* href attributes. Processes child elements to generate the link text
|
|
61
|
-
* content while preserving formatting.
|
|
62
|
-
*
|
|
63
|
-
* @public
|
|
64
|
-
*/
|
|
65
12
|
export declare class DocURLLinkStringRenderer extends ElementStringRendererBase {
|
|
66
|
-
/**
|
|
67
|
-
* Renders a URL link element to a formatted HTML anchor string.
|
|
68
|
-
*
|
|
69
|
-
* @remarks
|
|
70
|
-
* Creates an HTML anchor element with the specified URL and renders
|
|
71
|
-
* child elements as the link text content. Maintains proper link
|
|
72
|
-
* structure for external and internal references.
|
|
73
|
-
*
|
|
74
|
-
* @param element - The URL link element to render
|
|
75
|
-
* @param type - The rendering context type
|
|
76
|
-
* @returns The formatted HTML anchor string
|
|
77
|
-
*/
|
|
78
13
|
renderToString(element: AbstractDocURLLink, type: string): string;
|
|
79
14
|
}
|
|
80
|
-
/**
|
|
81
|
-
* Renderer for text markup elements in documentation.
|
|
82
|
-
*
|
|
83
|
-
* @remarks
|
|
84
|
-
* Handles common text formatting elements such as bold, emphasis, underline,
|
|
85
|
-
* subscript, and superscript. Maps Doxygen markup types to appropriate
|
|
86
|
-
* HTML elements for consistent text formatting.
|
|
87
|
-
*
|
|
88
|
-
* @public
|
|
89
|
-
*/
|
|
90
15
|
export declare class DocMarkupTypeStringRenderer extends ElementStringRendererBase {
|
|
91
|
-
/**
|
|
92
|
-
* Renders a markup element to a formatted HTML string.
|
|
93
|
-
*
|
|
94
|
-
* @remarks
|
|
95
|
-
* Converts Doxygen markup elements to their corresponding HTML tags
|
|
96
|
-
* and processes child content. Supports standard formatting elements
|
|
97
|
-
* with error handling for unrecognised markup types.
|
|
98
|
-
*
|
|
99
|
-
* @param element - The markup element to render
|
|
100
|
-
* @param type - The rendering context type
|
|
101
|
-
* @returns The formatted HTML string with markup tags
|
|
102
|
-
*/
|
|
103
16
|
renderToString(element: AbstractDocMarkupType, type: string): string;
|
|
104
17
|
}
|
|
105
|
-
/**
|
|
106
|
-
* Renderer for computer output or code text elements.
|
|
107
|
-
*
|
|
108
|
-
* @remarks
|
|
109
|
-
* Formats text as computer output using CSS styling rather than code blocks.
|
|
110
|
-
* Handles inline code formatting that may contain HTML elements while
|
|
111
|
-
* maintaining compatibility with Docusaurus rendering.
|
|
112
|
-
*
|
|
113
|
-
* @public
|
|
114
|
-
*/
|
|
115
18
|
export declare class ComputerOutputDataModelStringRenderer extends ElementStringRendererBase {
|
|
116
|
-
/**
|
|
117
|
-
* Renders computer output text to a formatted HTML string.
|
|
118
|
-
*
|
|
119
|
-
* @remarks
|
|
120
|
-
* Wraps content in a styled span element for computer output formatting.
|
|
121
|
-
* Uses CSS classes instead of code blocks to handle mixed content
|
|
122
|
-
* including HTML elements like anchors.
|
|
123
|
-
*
|
|
124
|
-
* @param element - The computer output element to render
|
|
125
|
-
* @param type - The rendering context type
|
|
126
|
-
* @returns The formatted HTML string with computer output styling
|
|
127
|
-
*/
|
|
128
19
|
renderToString(element: AbstractDocMarkupType, type: string): string;
|
|
129
20
|
}
|
|
130
|
-
/**
|
|
131
|
-
* Renderer for reference text elements within descriptions.
|
|
132
|
-
*
|
|
133
|
-
* @remarks
|
|
134
|
-
* Handles cross-references to other documentation elements by generating
|
|
135
|
-
* appropriate links when permalinks are available. Provides fallback
|
|
136
|
-
* text rendering for unresolved references.
|
|
137
|
-
*
|
|
138
|
-
* @public
|
|
139
|
-
*/
|
|
140
21
|
export declare class DocRefTextTypeStringRenderer extends ElementStringRendererBase {
|
|
141
|
-
/**
|
|
142
|
-
* Renders a reference text element to a formatted string with linking.
|
|
143
|
-
*
|
|
144
|
-
* @remarks
|
|
145
|
-
* Creates HTML anchor tags for valid references with permalinks,
|
|
146
|
-
* otherwise renders as plain text. Logs warnings for unsupported
|
|
147
|
-
* external references that are not yet implemented.
|
|
148
|
-
*
|
|
149
|
-
* @param element - The reference text element to render
|
|
150
|
-
* @param type - The rendering context type
|
|
151
|
-
* @returns The formatted string with optional link
|
|
152
|
-
*/
|
|
153
22
|
renderToString(element: AbstractDocRefTextType, type: string): string;
|
|
154
23
|
}
|
|
155
|
-
/**
|
|
156
|
-
* Renderer for simple section elements in documentation.
|
|
157
|
-
*
|
|
158
|
-
* @remarks
|
|
159
|
-
* Handles various types of documentation sections including returns,
|
|
160
|
-
* authors, notes, warnings, and custom sections. Maps section types
|
|
161
|
-
* to appropriate HTML structures and Docusaurus admonitions.
|
|
162
|
-
*
|
|
163
|
-
* @public
|
|
164
|
-
*/
|
|
165
24
|
export declare class DocSimpleSectTypeLinesRenderer extends ElementLinesRendererBase {
|
|
166
|
-
/**
|
|
167
|
-
* Renders a simple section element to formatted output lines.
|
|
168
|
-
*
|
|
169
|
-
* @remarks
|
|
170
|
-
* Converts Doxygen simple sections to HTML definition lists or
|
|
171
|
-
* Docusaurus admonitions based on section type. Supports standard
|
|
172
|
-
* sections like returns and notes, plus custom paragraph sections.
|
|
173
|
-
*
|
|
174
|
-
* @param element - The simple section element to render
|
|
175
|
-
* @param type - The rendering context type
|
|
176
|
-
* @returns Array of formatted output lines for the section
|
|
177
|
-
*/
|
|
178
25
|
renderToLines(element: AbstractDocSimpleSectType, type: string): string[];
|
|
179
26
|
}
|
|
180
|
-
/**
|
|
181
|
-
* Renderer for space elements in documentation.
|
|
182
|
-
*
|
|
183
|
-
* @remarks
|
|
184
|
-
* Handles spacing elements that insert a specified number of space
|
|
185
|
-
* characters into the output. Supports both single spaces and
|
|
186
|
-
* multiple space sequences for formatting control.
|
|
187
|
-
*
|
|
188
|
-
* @public
|
|
189
|
-
*/
|
|
190
27
|
export declare class SpTypeStringRenderer extends ElementStringRendererBase {
|
|
191
|
-
/**
|
|
192
|
-
* Renders a space element to a string of space characters.
|
|
193
|
-
*
|
|
194
|
-
* @remarks
|
|
195
|
-
* Generates the specified number of space characters based on the
|
|
196
|
-
* element's value attribute. Defaults to a single space if no
|
|
197
|
-
* value is specified.
|
|
198
|
-
*
|
|
199
|
-
* @param element - The space element to render
|
|
200
|
-
* @param type - The rendering context type (unused in implementation)
|
|
201
|
-
* @returns String containing the specified number of spaces
|
|
202
|
-
*/
|
|
203
28
|
renderToString(element: AbstractSpType, type: string): string;
|
|
204
29
|
}
|
|
205
|
-
/**
|
|
206
|
-
* Renderer for empty or structural elements in documentation.
|
|
207
|
-
*
|
|
208
|
-
* @remarks
|
|
209
|
-
* Handles various empty elements that provide structural formatting
|
|
210
|
-
* including horizontal rules, line breaks, and non-breakable spaces.
|
|
211
|
-
* Maps element types to appropriate HTML equivalents.
|
|
212
|
-
*
|
|
213
|
-
* @public
|
|
214
|
-
*/
|
|
215
30
|
export declare class DocEmptyTypeStringRenderer extends ElementStringRendererBase {
|
|
216
|
-
/**
|
|
217
|
-
* Renders an empty element to its HTML equivalent.
|
|
218
|
-
*
|
|
219
|
-
* @remarks
|
|
220
|
-
* Converts structural elements like horizontal rules and line breaks
|
|
221
|
-
* to their corresponding HTML tags. Provides error handling for
|
|
222
|
-
* unrecognised empty element types.
|
|
223
|
-
*
|
|
224
|
-
* @param element - The empty element to render
|
|
225
|
-
* @param type - The rendering context type (unused in implementation)
|
|
226
|
-
* @returns The formatted HTML string for the structural element
|
|
227
|
-
*/
|
|
228
31
|
renderToString(element: AbstractDocEmptyType, type: string): string;
|
|
229
32
|
}
|
|
230
|
-
/**
|
|
231
|
-
* Renderer for parameter list elements in documentation.
|
|
232
|
-
*
|
|
233
|
-
* @remarks
|
|
234
|
-
* Handles complex parameter documentation including template parameters,
|
|
235
|
-
* function parameters, return values, and exceptions. Generates structured
|
|
236
|
-
* HTML tables for organised parameter presentation.
|
|
237
|
-
*
|
|
238
|
-
* @public
|
|
239
|
-
*/
|
|
240
33
|
export declare class DocParamListTypeLinesRenderer extends ElementLinesRendererBase {
|
|
241
|
-
/**
|
|
242
|
-
* Renders a parameter list element to formatted output lines.
|
|
243
|
-
*
|
|
244
|
-
* @remarks
|
|
245
|
-
* Creates HTML definition lists and tables for parameter documentation.
|
|
246
|
-
* Processes parameter names, types, directions, and descriptions to
|
|
247
|
-
* generate comprehensive parameter documentation with proper formatting.
|
|
248
|
-
*
|
|
249
|
-
* @param element - The parameter list element to render
|
|
250
|
-
* @param type - The rendering context type
|
|
251
|
-
* @returns Array of HTML strings forming the parameter documentation
|
|
252
|
-
*/
|
|
253
34
|
renderToLines(element: AbstractDocParamListType, type: string): string[];
|
|
254
35
|
}
|
|
255
|
-
/**
|
|
256
|
-
* Renderer for anchor elements in documentation.
|
|
257
|
-
*
|
|
258
|
-
* @remarks
|
|
259
|
-
* Creates HTML anchor elements for cross-referencing within documents.
|
|
260
|
-
* Generates sanitised anchor IDs that can be used for permalink
|
|
261
|
-
* navigation and internal linking.
|
|
262
|
-
*
|
|
263
|
-
* @public
|
|
264
|
-
*/
|
|
265
36
|
export declare class DocAnchorTypeLinesRenderer extends ElementLinesRendererBase {
|
|
266
|
-
/**
|
|
267
|
-
* Renders an anchor element to formatted output lines.
|
|
268
|
-
*
|
|
269
|
-
* @remarks
|
|
270
|
-
* Creates an HTML anchor element with a sanitised ID attribute
|
|
271
|
-
* for use in permalink generation and cross-referencing within
|
|
272
|
-
* the documentation.
|
|
273
|
-
*
|
|
274
|
-
* @param element - The anchor element to render
|
|
275
|
-
* @param type - The rendering context type (unused in implementation)
|
|
276
|
-
* @returns Array containing the HTML anchor element
|
|
277
|
-
*/
|
|
278
37
|
renderToLines(element: AbstractDocAnchorType, type: string): string[];
|
|
279
38
|
}
|
|
280
|
-
/**
|
|
281
|
-
* Renderer for verbatim text elements in documentation.
|
|
282
|
-
*
|
|
283
|
-
* @remarks
|
|
284
|
-
* Handles verbatim text blocks that should be displayed exactly as
|
|
285
|
-
* written without interpretation. Generates HTML pre and code elements
|
|
286
|
-
* with proper formatting for code snippets and literal text.
|
|
287
|
-
*
|
|
288
|
-
* @public
|
|
289
|
-
*/
|
|
290
39
|
export declare class VerbatimStringRenderer extends ElementStringRendererBase {
|
|
291
|
-
/**
|
|
292
|
-
* Renders a verbatim element to formatted HTML code block.
|
|
293
|
-
*
|
|
294
|
-
* @remarks
|
|
295
|
-
* Creates HTML pre and code elements for literal text display.
|
|
296
|
-
* Strips leading and trailing newlines while preserving internal
|
|
297
|
-
* formatting and enables copy functionality through Docusaurus.
|
|
298
|
-
*
|
|
299
|
-
* @param element - The verbatim element to render
|
|
300
|
-
* @param type - The rendering context type
|
|
301
|
-
* @returns The formatted HTML code block string
|
|
302
|
-
*/
|
|
303
40
|
renderToString(element: AbstractVerbatimType, type: string): string;
|
|
304
41
|
}
|
|
305
|
-
/**
|
|
306
|
-
* Renderer for preformatted text elements in documentation.
|
|
307
|
-
*
|
|
308
|
-
* @remarks
|
|
309
|
-
* Similar to verbatim rendering but specifically for preformatted content.
|
|
310
|
-
* Maintains exact spacing and formatting while providing HTML code block
|
|
311
|
-
* structure compatible with Docusaurus features.
|
|
312
|
-
*
|
|
313
|
-
* @public
|
|
314
|
-
*/
|
|
315
42
|
export declare class PreformattedStringRenderer extends ElementStringRendererBase {
|
|
316
|
-
/**
|
|
317
|
-
* Renders a preformatted element to formatted HTML code block.
|
|
318
|
-
*
|
|
319
|
-
* @remarks
|
|
320
|
-
* Creates HTML pre and code elements for preformatted text display.
|
|
321
|
-
* Preserves exact formatting while stripping unnecessary newlines
|
|
322
|
-
* and enabling Docusaurus copy button functionality.
|
|
323
|
-
*
|
|
324
|
-
* @param element - The preformatted element to render
|
|
325
|
-
* @param type - The rendering context type
|
|
326
|
-
* @returns The formatted HTML code block string
|
|
327
|
-
*/
|
|
328
43
|
renderToString(element: AbstractPreformattedType, type: string): string;
|
|
329
44
|
}
|
|
330
|
-
/**
|
|
331
|
-
* Renderer for mathematical formula elements in documentation.
|
|
332
|
-
*
|
|
333
|
-
* @remarks
|
|
334
|
-
* Handles LaTeX mathematical formulae by converting them to HTML code
|
|
335
|
-
* elements. Provides warnings for limited formula rendering capabilities
|
|
336
|
-
* and maintains formula content for basic display.
|
|
337
|
-
*
|
|
338
|
-
* @public
|
|
339
|
-
*/
|
|
340
45
|
export declare class FormulaStringRenderer extends ElementStringRendererBase {
|
|
341
|
-
/**
|
|
342
|
-
* Renders a formula element to formatted HTML code.
|
|
343
|
-
*
|
|
344
|
-
* @remarks
|
|
345
|
-
* Converts LaTeX formulae to HTML code elements with basic formatting.
|
|
346
|
-
* Logs warnings about limited rendering capabilities and ignores
|
|
347
|
-
* formula IDs while preserving mathematical content.
|
|
348
|
-
*
|
|
349
|
-
* @param element - The formula element to render
|
|
350
|
-
* @param type - The rendering context type
|
|
351
|
-
* @returns The formatted HTML code string containing the formula
|
|
352
|
-
*/
|
|
353
46
|
renderToString(element: AbstractDocFormulaType, type: string): string;
|
|
354
47
|
}
|
|
355
|
-
/**
|
|
356
|
-
* Renderer for image elements in documentation.
|
|
357
|
-
*
|
|
358
|
-
* @remarks
|
|
359
|
-
* Handles image rendering with support for various attributes including
|
|
360
|
-
* dimensions, captions, and source URLs. Generates HTML figure elements
|
|
361
|
-
* with proper image handling for both local and remote sources.
|
|
362
|
-
*
|
|
363
|
-
* @public
|
|
364
|
-
*/
|
|
365
48
|
export declare class ImageStringRenderer extends ElementStringRendererBase {
|
|
366
|
-
/**
|
|
367
|
-
* Renders an image element to formatted HTML figure.
|
|
368
|
-
*
|
|
369
|
-
* @remarks
|
|
370
|
-
* Creates HTML figure and img elements with support for width, height,
|
|
371
|
-
* alt text, captions, and inline styling. Handles both URL and local
|
|
372
|
-
* image sources while skipping LaTeX-specific images.
|
|
373
|
-
*
|
|
374
|
-
* @param element - The image element to render
|
|
375
|
-
* @param type - The rendering context type (unused in implementation)
|
|
376
|
-
* @returns The formatted HTML figure string
|
|
377
|
-
*/
|
|
378
49
|
renderToString(element: AbstractDocImageType, type: string): string;
|
|
379
50
|
}
|
|
380
|
-
/**
|
|
381
|
-
* Renderer for HTML-only content elements in documentation.
|
|
382
|
-
*
|
|
383
|
-
* @remarks
|
|
384
|
-
* Handles content that should only appear in HTML output formats.
|
|
385
|
-
* Processes HTML-specific markup while converting it to appropriate
|
|
386
|
-
* text format for cross-platform compatibility.
|
|
387
|
-
*
|
|
388
|
-
* @public
|
|
389
|
-
*/
|
|
390
51
|
export declare class HtmlOnlyStringRenderer extends ElementStringRendererBase {
|
|
391
|
-
/**
|
|
392
|
-
* Renders an HTML-only element to formatted text.
|
|
393
|
-
*
|
|
394
|
-
* @remarks
|
|
395
|
-
* Converts HTML-only content to plain text format for broader
|
|
396
|
-
* compatibility. Processes the element's text content through
|
|
397
|
-
* the workspace renderer with text formatting.
|
|
398
|
-
*
|
|
399
|
-
* @param element - The HTML-only element to render
|
|
400
|
-
* @param type - The rendering context type (unused in implementation)
|
|
401
|
-
* @returns The formatted text string
|
|
402
|
-
*/
|
|
403
52
|
renderToString(element: AbstractDocHtmlOnlyType, type: string): string;
|
|
404
53
|
}
|
|
405
|
-
/**
|
|
406
|
-
* Renderer for heading elements in documentation.
|
|
407
|
-
*
|
|
408
|
-
* @remarks
|
|
409
|
-
* Converts Doxygen heading elements to Markdown heading syntax.
|
|
410
|
-
* Supports multiple heading levels while providing warnings for
|
|
411
|
-
* potentially problematic heading configurations.
|
|
412
|
-
*
|
|
413
|
-
* @public
|
|
414
|
-
*/
|
|
415
54
|
export declare class HeadingLinesRenderer extends ElementLinesRendererBase {
|
|
416
|
-
/**
|
|
417
|
-
* Renders a heading element to formatted Markdown heading lines.
|
|
418
|
-
*
|
|
419
|
-
* @remarks
|
|
420
|
-
* Creates Markdown-style headings with appropriate hash symbols
|
|
421
|
-
* based on the heading level. Warns about level 1 headings that
|
|
422
|
-
* may interfere with Docusaurus page structure.
|
|
423
|
-
*
|
|
424
|
-
* @param element - The heading element to render
|
|
425
|
-
* @param type - The rendering context type
|
|
426
|
-
* @returns Array containing the formatted Markdown heading
|
|
427
|
-
*/
|
|
428
55
|
renderToLines(element: AbstractDocHeadingType, type: string): string[];
|
|
429
56
|
}
|
|
430
|
-
/**
|
|
431
|
-
* Renderer for emoji elements in documentation.
|
|
432
|
-
*
|
|
433
|
-
* @remarks
|
|
434
|
-
* Handles Unicode emoji characters by wrapping them in appropriate
|
|
435
|
-
* HTML span elements with CSS styling. Provides consistent emoji
|
|
436
|
-
* display across different platforms and browsers.
|
|
437
|
-
*
|
|
438
|
-
* @public
|
|
439
|
-
*/
|
|
440
57
|
export declare class EmojiStringRenderer extends ElementStringRendererBase {
|
|
441
|
-
/**
|
|
442
|
-
* Renders an emoji element to formatted HTML span.
|
|
443
|
-
*
|
|
444
|
-
* @remarks
|
|
445
|
-
* Creates an HTML span element with CSS class for emoji styling
|
|
446
|
-
* and includes the Unicode emoji character. Ensures consistent
|
|
447
|
-
* emoji presentation in documentation output.
|
|
448
|
-
*
|
|
449
|
-
* @param element - The emoji element to render
|
|
450
|
-
* @param type - The rendering context type (unused in implementation)
|
|
451
|
-
* @returns The formatted HTML span string with emoji
|
|
452
|
-
*/
|
|
453
58
|
renderToString(element: AbstractEmojiType, type: string): string;
|
|
454
59
|
}
|
|
455
|
-
/**
|
|
456
|
-
* Renderer for blockquote elements in documentation.
|
|
457
|
-
*
|
|
458
|
-
* @remarks
|
|
459
|
-
* Handles blockquote formatting by wrapping content in HTML blockquote
|
|
460
|
-
* elements with appropriate CSS styling. Processes child elements to
|
|
461
|
-
* maintain proper content structure within quotes.
|
|
462
|
-
*
|
|
463
|
-
* @public
|
|
464
|
-
*/
|
|
465
60
|
export declare class BlockquoteLinesRenderer extends ElementLinesRendererBase {
|
|
466
|
-
/**
|
|
467
|
-
* Renders a blockquote element to formatted output lines.
|
|
468
|
-
*
|
|
469
|
-
* @remarks
|
|
470
|
-
* Creates HTML blockquote elements with CSS styling and processes
|
|
471
|
-
* child elements to generate properly formatted quoted content
|
|
472
|
-
* with appropriate indentation and styling.
|
|
473
|
-
*
|
|
474
|
-
* @param element - The blockquote element to render
|
|
475
|
-
* @param type - The rendering context type
|
|
476
|
-
* @returns Array of HTML strings forming the blockquote structure
|
|
477
|
-
*/
|
|
478
61
|
renderToLines(element: AbstractDocBlockQuoteType, type: string): string[];
|
|
479
62
|
}
|
|
480
63
|
//# sourceMappingURL=descriptiontype.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"descriptiontype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/descriptiontype.ts"],"names":[],"mappings":"AAiBA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,qBAAqB,EACrB,KAAK,yBAAyB,EAC9B,oBAAoB,EACpB,sBAAsB,EACtB,KAAK,sBAAsB,EAC3B,oBAAoB,EACpB,qBAAqB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,sBAAsB,EACtB,KAAK,yBAAyB,EAC9B,kBAAkB,EAClB,iBAAiB,EACjB,KAAK,wBAAwB,EAC7B,KAAK,cAAc,EACnB,KAAK,oBAAoB,EAGzB,KAAK,uBAAuB,EAE7B,MAAM,0DAA0D,CAAA;AAOjE,OAAO,EACL,uBAAuB,EAKxB,MAAM,sDAAsD,CAAA;AAE7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;
|
|
1
|
+
{"version":3,"file":"descriptiontype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/descriptiontype.ts"],"names":[],"mappings":"AAiBA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,qBAAqB,EACrB,KAAK,yBAAyB,EAC9B,oBAAoB,EACpB,sBAAsB,EACtB,KAAK,sBAAsB,EAC3B,oBAAoB,EACpB,qBAAqB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,sBAAsB,EACtB,KAAK,yBAAyB,EAC9B,kBAAkB,EAClB,iBAAiB,EACjB,KAAK,wBAAwB,EAC7B,KAAK,cAAc,EACnB,KAAK,oBAAoB,EAGzB,KAAK,uBAAuB,EAE7B,MAAM,0DAA0D,CAAA;AAOjE,OAAO,EACL,uBAAuB,EAKxB,MAAM,sDAAsD,CAAA;AAE7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AAczE,qBAAa,4BAA6B,SAAQ,wBAAwB;IAaxE,aAAa,CAAC,OAAO,EAAE,uBAAuB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAcxE;AAcD,qBAAa,wBAAyB,SAAQ,wBAAwB;IAapE,aAAa,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;IAuEnE,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,qBAAqB,GAAG,OAAO;CA0C9D;AAcD,qBAAa,wBAAyB,SAAQ,yBAAyB;IAarE,cAAc,CAAC,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAUlE;AAsBD,qBAAa,2BAA4B,SAAQ,yBAAyB;IAaxE,cAAc,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAuBrE;AAYD,qBAAa,qCAAsC,SAAQ,yBAAyB;IAalF,cAAc,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAgBrE;AAcD,qBAAa,4BAA6B,SAAQ,yBAAyB;IAazE,cAAc,CAAC,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CA4BtE;AAqCD,qBAAa,8BAA+B,SAAQ,wBAAwB;IAa1E,aAAa,CAAC,OAAO,EAAE,yBAAyB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CA0I1E;AAcD,qBAAa,oBAAqB,SAAQ,yBAAyB;IAajE,cAAc,CAAC,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAgB9D;AAcD,qBAAa,0BAA2B,SAAQ,yBAAyB;IAavE,cAAc,CAAC,OAAO,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAgCpE;AAcD,qBAAa,6BAA8B,SAAQ,wBAAwB;IAazE,aAAa,CAAC,OAAO,EAAE,wBAAwB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CA6HzE;AAcD,qBAAa,0BAA2B,SAAQ,wBAAwB;IAatE,aAAa,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAUtE;AAcD,qBAAa,sBAAuB,SAAQ,yBAAyB;IAanE,cAAc,CAAC,OAAO,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAqBpE;AAYD,qBAAa,0BAA2B,SAAQ,yBAAyB;IAavE,cAAc,CAAC,OAAO,EAAE,wBAAwB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAqBxE;AAcD,qBAAa,qBAAsB,SAAQ,yBAAyB;IAalE,cAAc,CAAC,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAgBtE;AAcD,qBAAa,mBAAoB,SAAQ,yBAAyB;IAahE,cAAc,CAAC,OAAO,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAgEpE;AAcD,qBAAa,sBAAuB,SAAQ,yBAAyB;IAanE,cAAc,CAAC,OAAO,EAAE,uBAAuB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAQvE;AAcD,qBAAa,oBAAqB,SAAQ,wBAAwB;IAahE,aAAa,CAAC,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAuBvE;AAcD,qBAAa,mBAAoB,SAAQ,yBAAyB;IAahE,cAAc,CAAC,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CASjE;AAcD,qBAAa,uBAAwB,SAAQ,wBAAwB;IAanE,aAAa,CAAC,OAAO,EAAE,yBAAyB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAY1E"}
|