@xpack/doxygen2docusaurus 2.0.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +2 -1
- package/bin/doxygen2docusaurus.js +1 -1
- package/dist/cli/main.d.ts +0 -14
- package/dist/cli/main.d.ts.map +1 -1
- package/dist/cli/main.js +0 -34
- package/dist/cli/main.js.map +1 -1
- package/dist/docusaurus/cli-options.d.ts +3 -292
- package/dist/docusaurus/cli-options.d.ts.map +1 -1
- package/dist/docusaurus/cli-options.js +6 -290
- package/dist/docusaurus/cli-options.js.map +1 -1
- package/dist/docusaurus/generator.d.ts +0 -172
- package/dist/docusaurus/generator.d.ts.map +1 -1
- package/dist/docusaurus/generator.js +20 -280
- package/dist/docusaurus/generator.js.map +1 -1
- package/dist/docusaurus/renderers/descriptiontype.d.ts +0 -417
- package/dist/docusaurus/renderers/descriptiontype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/descriptiontype.js +11 -555
- package/dist/docusaurus/renderers/descriptiontype.js.map +1 -1
- package/dist/docusaurus/renderers/docinternalstype.d.ts +0 -132
- package/dist/docusaurus/renderers/docinternalstype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/docinternalstype.js +0 -156
- package/dist/docusaurus/renderers/docinternalstype.js.map +1 -1
- package/dist/docusaurus/renderers/doclisttype.d.ts +0 -22
- package/dist/docusaurus/renderers/doclisttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/doclisttype.js +0 -42
- package/dist/docusaurus/renderers/doclisttype.js.map +1 -1
- package/dist/docusaurus/renderers/doctabletype.d.ts +0 -88
- package/dist/docusaurus/renderers/doctabletype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/doctabletype.js +1 -113
- package/dist/docusaurus/renderers/doctabletype.js.map +1 -1
- package/dist/docusaurus/renderers/doctitletype.d.ts +0 -22
- package/dist/docusaurus/renderers/doctitletype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/doctitletype.js +0 -42
- package/dist/docusaurus/renderers/doctitletype.js.map +1 -1
- package/dist/docusaurus/renderers/docvariablelisttype.d.ts +0 -44
- package/dist/docusaurus/renderers/docvariablelisttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/docvariablelisttype.js +1 -69
- package/dist/docusaurus/renderers/docvariablelisttype.js.map +1 -1
- package/dist/docusaurus/renderers/docxrefsecttype.d.ts +0 -22
- package/dist/docusaurus/renderers/docxrefsecttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/docxrefsecttype.js +0 -38
- package/dist/docusaurus/renderers/docxrefsecttype.js.map +1 -1
- package/dist/docusaurus/renderers/element-renderer-base.d.ts +0 -74
- package/dist/docusaurus/renderers/element-renderer-base.d.ts.map +1 -1
- package/dist/docusaurus/renderers/element-renderer-base.js +0 -64
- package/dist/docusaurus/renderers/element-renderer-base.js.map +1 -1
- package/dist/docusaurus/renderers/inctype.d.ts +0 -23
- package/dist/docusaurus/renderers/inctype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/inctype.js +0 -41
- package/dist/docusaurus/renderers/inctype.js.map +1 -1
- package/dist/docusaurus/renderers/linkedtexttype.d.ts +0 -22
- package/dist/docusaurus/renderers/linkedtexttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/linkedtexttype.js +0 -45
- package/dist/docusaurus/renderers/linkedtexttype.js.map +1 -1
- package/dist/docusaurus/renderers/listingtype.d.ts +0 -52
- package/dist/docusaurus/renderers/listingtype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/listingtype.js +1 -88
- package/dist/docusaurus/renderers/listingtype.js.map +1 -1
- package/dist/docusaurus/renderers/paramtype.d.ts +0 -22
- package/dist/docusaurus/renderers/paramtype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/paramtype.js +2 -51
- package/dist/docusaurus/renderers/paramtype.js.map +1 -1
- package/dist/docusaurus/renderers/referencetype.d.ts +0 -23
- package/dist/docusaurus/renderers/referencetype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/referencetype.js +0 -38
- package/dist/docusaurus/renderers/referencetype.js.map +1 -1
- package/dist/docusaurus/renderers/reftexttype.d.ts +0 -22
- package/dist/docusaurus/renderers/reftexttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/reftexttype.js +0 -38
- package/dist/docusaurus/renderers/reftexttype.js.map +1 -1
- package/dist/docusaurus/renderers/reftype.d.ts +0 -22
- package/dist/docusaurus/renderers/reftype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/reftype.js +0 -38
- package/dist/docusaurus/renderers/reftype.js.map +1 -1
- package/dist/docusaurus/renderers/renderers.d.ts +0 -151
- package/dist/docusaurus/renderers/renderers.d.ts.map +1 -1
- package/dist/docusaurus/renderers/renderers.js +4 -184
- package/dist/docusaurus/renderers/renderers.js.map +1 -1
- package/dist/docusaurus/renderers/substringtype.d.ts +0 -22
- package/dist/docusaurus/renderers/substringtype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/substringtype.js +0 -39
- package/dist/docusaurus/renderers/substringtype.js.map +1 -1
- package/dist/docusaurus/renderers/tableofcontentstype.d.ts +0 -22
- package/dist/docusaurus/renderers/tableofcontentstype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/tableofcontentstype.js +0 -39
- package/dist/docusaurus/renderers/tableofcontentstype.js.map +1 -1
- package/dist/docusaurus/types.d.ts +0 -110
- package/dist/docusaurus/types.d.ts.map +1 -1
- package/dist/docusaurus/types.js +0 -11
- package/dist/docusaurus/types.js.map +1 -1
- package/dist/docusaurus/utils.d.ts +0 -214
- package/dist/docusaurus/utils.d.ts.map +1 -1
- package/dist/docusaurus/utils.js +0 -296
- package/dist/docusaurus/utils.js.map +1 -1
- package/dist/docusaurus/view-model/classes-vm.d.ts +0 -137
- package/dist/docusaurus/view-model/classes-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/classes-vm.js +9 -225
- package/dist/docusaurus/view-model/classes-vm.js.map +1 -1
- package/dist/docusaurus/view-model/collection-base.d.ts +0 -120
- package/dist/docusaurus/view-model/collection-base.d.ts.map +1 -1
- package/dist/docusaurus/view-model/collection-base.js +11 -101
- package/dist/docusaurus/view-model/collection-base.js.map +1 -1
- package/dist/docusaurus/view-model/compound-base-vm.d.ts +2 -147
- package/dist/docusaurus/view-model/compound-base-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/compound-base-vm.js +47 -225
- package/dist/docusaurus/view-model/compound-base-vm.js.map +1 -1
- package/dist/docusaurus/view-model/concepts-vm.d.ts +26 -0
- package/dist/docusaurus/view-model/concepts-vm.d.ts.map +1 -0
- package/dist/docusaurus/view-model/concepts-vm.js +329 -0
- package/dist/docusaurus/view-model/concepts-vm.js.map +1 -0
- package/dist/docusaurus/view-model/description-anchors.d.ts +0 -58
- package/dist/docusaurus/view-model/description-anchors.d.ts.map +1 -1
- package/dist/docusaurus/view-model/description-anchors.js +0 -71
- package/dist/docusaurus/view-model/description-anchors.js.map +1 -1
- package/dist/docusaurus/view-model/files-and-folders-vm.d.ts +0 -247
- package/dist/docusaurus/view-model/files-and-folders-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/files-and-folders-vm.js +61 -353
- package/dist/docusaurus/view-model/files-and-folders-vm.js.map +1 -1
- package/dist/docusaurus/view-model/groups-vm.d.ts +0 -148
- package/dist/docusaurus/view-model/groups-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/groups-vm.js +2 -223
- package/dist/docusaurus/view-model/groups-vm.js.map +1 -1
- package/dist/docusaurus/view-model/members-vm.d.ts +0 -552
- package/dist/docusaurus/view-model/members-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/members-vm.js +17 -702
- package/dist/docusaurus/view-model/members-vm.js.map +1 -1
- package/dist/docusaurus/view-model/namespaces-vm.d.ts +4 -199
- package/dist/docusaurus/view-model/namespaces-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/namespaces-vm.js +79 -284
- package/dist/docusaurus/view-model/namespaces-vm.js.map +1 -1
- package/dist/docusaurus/view-model/options.d.ts +0 -43
- package/dist/docusaurus/view-model/options.d.ts.map +1 -1
- package/dist/docusaurus/view-model/options.js +0 -57
- package/dist/docusaurus/view-model/options.js.map +1 -1
- package/dist/docusaurus/view-model/pages-vm.d.ts +0 -115
- package/dist/docusaurus/view-model/pages-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/pages-vm.js +0 -162
- package/dist/docusaurus/view-model/pages-vm.js.map +1 -1
- package/dist/docusaurus/view-model/tree-entries-vm.d.ts +8 -142
- package/dist/docusaurus/view-model/tree-entries-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/tree-entries-vm.js +54 -174
- package/dist/docusaurus/view-model/tree-entries-vm.js.map +1 -1
- package/dist/docusaurus/view-model/view-model.d.ts +0 -125
- package/dist/docusaurus/view-model/view-model.d.ts.map +1 -1
- package/dist/docusaurus/view-model/view-model.js +20 -182
- package/dist/docusaurus/view-model/view-model.js.map +1 -1
- package/dist/docusaurus/workspace.d.ts +1 -126
- package/dist/docusaurus/workspace.d.ts.map +1 -1
- package/dist/docusaurus/workspace.js +8 -221
- package/dist/docusaurus/workspace.js.map +1 -1
- package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts +5 -492
- package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/compounddef-dm.js +23 -672
- package/dist/doxygen/data-model/compounds/compounddef-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts +0 -129
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.js +1 -145
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts +104 -2848
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.js +73 -3975
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts +0 -165
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js +0 -229
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts +0 -70
- package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/doxygentype-dm.js +0 -105
- package/dist/doxygen/data-model/compounds/doxygentype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts +0 -84
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js +1 -122
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/inctype-dm.d.ts +0 -116
- package/dist/doxygen/data-model/compounds/inctype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/inctype-dm.js +3 -155
- package/dist/doxygen/data-model/compounds/inctype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts +3 -138
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js +5 -180
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts +0 -76
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js +0 -107
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts +0 -162
- package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/locationtype-dm.js +4 -203
- package/dist/doxygen/data-model/compounds/locationtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts +2 -443
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.js +19 -475
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts +0 -141
- package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/memberreftype-dm.js +0 -176
- package/dist/doxygen/data-model/compounds/memberreftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/membertype-dm.d.ts +0 -101
- package/dist/doxygen/data-model/compounds/membertype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/membertype-dm.js +0 -115
- package/dist/doxygen/data-model/compounds/membertype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts +0 -164
- package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/paramtype-dm.js +0 -208
- package/dist/doxygen/data-model/compounds/paramtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts +0 -139
- package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/referencetype-dm.js +2 -175
- package/dist/doxygen/data-model/compounds/referencetype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts +0 -120
- package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/reftexttype-dm.js +2 -141
- package/dist/doxygen/data-model/compounds/reftexttype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/reftype-dm.d.ts +0 -268
- package/dist/doxygen/data-model/compounds/reftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/reftype-dm.js +4 -326
- package/dist/doxygen/data-model/compounds/reftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts +0 -105
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.js +1 -139
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts +0 -168
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js +0 -209
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts +0 -267
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js +0 -354
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts +0 -66
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js +0 -97
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js.map +1 -1
- package/dist/doxygen/data-model/data-model.d.ts +0 -149
- package/dist/doxygen/data-model/data-model.d.ts.map +1 -1
- package/dist/doxygen/data-model/data-model.js +4 -197
- package/dist/doxygen/data-model/data-model.js.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts +0 -115
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js +4 -129
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts +0 -87
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js +0 -118
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js.map +1 -1
- package/dist/doxygen/data-model/doxygen-xml-parser.d.ts +0 -253
- package/dist/doxygen/data-model/doxygen-xml-parser.d.ts.map +1 -1
- package/dist/doxygen/data-model/doxygen-xml-parser.js +0 -291
- package/dist/doxygen/data-model/doxygen-xml-parser.js.map +1 -1
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts +0 -98
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.js +2 -122
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts +0 -82
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.js +0 -114
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.js.map +1 -1
- package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts +0 -85
- package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/index/indexmembertype-dm.js +1 -107
- package/dist/doxygen/data-model/index/indexmembertype-dm.js.map +1 -1
- package/dist/doxygen/data-model/types.d.ts +0 -104
- package/dist/doxygen/data-model/types.d.ts.map +1 -1
- package/dist/doxygen/data-model/types.js +0 -52
- package/dist/doxygen/data-model/types.js.map +1 -1
- package/dist/index.d.ts +4 -16
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -42
- package/dist/index.js.map +1 -1
- package/package.json +45 -51
- package/src/cli/main.ts +122 -0
- package/src/docusaurus/cli-options.ts +560 -0
- package/src/docusaurus/generator.ts +788 -0
- package/src/docusaurus/renderers/descriptiontype.ts +1299 -0
- package/src/docusaurus/renderers/docinternalstype.ts +354 -0
- package/src/docusaurus/renderers/doclisttype.ts +134 -0
- package/src/docusaurus/renderers/doctabletype.ts +220 -0
- package/src/docusaurus/renderers/doctitletype.ts +77 -0
- package/src/docusaurus/renderers/docvariablelisttype.ts +123 -0
- package/src/docusaurus/renderers/docxrefsecttype.ts +84 -0
- package/src/docusaurus/renderers/element-renderer-base.ts +112 -0
- package/src/docusaurus/renderers/inctype.ts +75 -0
- package/src/docusaurus/renderers/linkedtexttype.ts +64 -0
- package/src/docusaurus/renderers/listingtype.ts +235 -0
- package/src/docusaurus/renderers/paramtype.ts +116 -0
- package/src/docusaurus/renderers/referencetype.ts +83 -0
- package/src/docusaurus/renderers/reftexttype.ts +81 -0
- package/src/docusaurus/renderers/reftype.ts +77 -0
- package/src/docusaurus/renderers/renderers.ts +756 -0
- package/src/docusaurus/renderers/substringtype.ts +53 -0
- package/src/docusaurus/renderers/tableofcontentstype.ts +74 -0
- package/src/docusaurus/types.ts +187 -0
- package/src/docusaurus/utils.ts +409 -0
- package/src/docusaurus/view-model/README.md +12 -0
- package/src/docusaurus/view-model/classes-vm.ts +1088 -0
- package/src/docusaurus/view-model/collection-base.ts +352 -0
- package/src/docusaurus/view-model/compound-base-vm.ts +1340 -0
- package/src/docusaurus/view-model/concepts-vm.ts +719 -0
- package/src/docusaurus/view-model/description-anchors.ts +107 -0
- package/src/docusaurus/view-model/files-and-folders-vm.ts +1293 -0
- package/src/docusaurus/view-model/groups-vm.ts +548 -0
- package/src/docusaurus/view-model/members-vm.ts +1943 -0
- package/src/docusaurus/view-model/namespaces-vm.ts +1018 -0
- package/src/docusaurus/view-model/options.ts +95 -0
- package/src/docusaurus/view-model/pages-vm.ts +342 -0
- package/src/docusaurus/view-model/tree-entries-vm.ts +376 -0
- package/src/docusaurus/view-model/view-model.ts +513 -0
- package/src/docusaurus/workspace.ts +588 -0
- package/src/doxygen/data-model/README.md +13 -0
- package/src/doxygen/data-model/compounds/compounddef-dm.ts +1156 -0
- package/src/doxygen/data-model/compounds/compoundreftype-dm.ts +266 -0
- package/src/doxygen/data-model/compounds/descriptiontype-dm.ts +10107 -0
- package/src/doxygen/data-model/compounds/docvarlistentrytype-dm.ts +354 -0
- package/src/doxygen/data-model/compounds/doxygentype-dm.ts +187 -0
- package/src/doxygen/data-model/compounds/enumvaluetype-dm.ts +218 -0
- package/src/doxygen/data-model/compounds/inctype-dm.ts +217 -0
- package/src/doxygen/data-model/compounds/linkedtexttype-dm.ts +288 -0
- package/src/doxygen/data-model/compounds/listofallmemberstype-dm.ts +160 -0
- package/src/doxygen/data-model/compounds/locationtype-dm.ts +284 -0
- package/src/doxygen/data-model/compounds/memberdeftype-dm.ts +874 -0
- package/src/doxygen/data-model/compounds/memberreftype-dm.ts +270 -0
- package/src/doxygen/data-model/compounds/membertype-dm.ts +239 -0
- package/src/doxygen/data-model/compounds/paramtype-dm.ts +302 -0
- package/src/doxygen/data-model/compounds/referencetype-dm.ts +248 -0
- package/src/doxygen/data-model/compounds/reftexttype-dm.ts +234 -0
- package/src/doxygen/data-model/compounds/reftype-dm.ts +430 -0
- package/src/doxygen/data-model/compounds/reimplementtype-dm.ts +201 -0
- package/src/doxygen/data-model/compounds/sectiondeftype-dm.ts +330 -0
- package/src/doxygen/data-model/compounds/tableofcontentstype-dm.ts +563 -0
- package/src/doxygen/data-model/compounds/templateparamlisttype-dm.ts +150 -0
- package/src/doxygen/data-model/data-model.ts +377 -0
- package/src/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.ts +271 -0
- package/src/doxygen/data-model/doxyfile/doxyfiletype-dm.ts +200 -0
- package/src/doxygen/data-model/doxygen-xml-parser.ts +522 -0
- package/src/doxygen/data-model/index/indexcompoundtype-dm.ts +256 -0
- package/src/doxygen/data-model/index/indexdoxygentype-dm.ts +196 -0
- package/src/doxygen/data-model/index/indexmembertype-dm.ts +230 -0
- package/src/doxygen/data-model/types.ts +175 -0
- package/src/doxygen/data-model/xsds/README.md +6 -0
- package/src/doxygen/data-model/xsds/compound.xsd +1699 -0
- package/src/doxygen/data-model/xsds/doxyfile.xsd +355 -0
- package/src/doxygen/data-model/xsds/index.xsd +72 -0
- package/src/doxygen/data-model/xsds/xml.xsd +23 -0
- package/src/index.ts +261 -0
- package/src/tsconfig.json +10 -0
- package/dist/doxygen2docusaurus.d.ts +0 -4774
- package/dist/tsconfig.tsbuildinfo +0 -1
- package/dist/tsdoc-metadata.json +0 -11
|
@@ -1,103 +1,15 @@
|
|
|
1
1
|
import { ElementLinesRendererBase, ElementStringRendererBase } from './element-renderer-base.js';
|
|
2
2
|
import type { AbstractDocCaptionType, AbstractDocEntryType, AbstractDocRowType, AbstractDocTableType } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
|
|
3
|
-
/**
|
|
4
|
-
* Renderer for Doxygen document table elements.
|
|
5
|
-
*
|
|
6
|
-
* @remarks
|
|
7
|
-
* Converts Doxygen table structures to HTML table format with optional
|
|
8
|
-
* captions. Processes table rows and maintains styling through CSS
|
|
9
|
-
* classes for consistent documentation presentation.
|
|
10
|
-
*
|
|
11
|
-
* @public
|
|
12
|
-
*/
|
|
13
3
|
export declare class DocTableTypeLinesRenderer extends ElementLinesRendererBase {
|
|
14
|
-
/**
|
|
15
|
-
* Renders a document table element to formatted output lines.
|
|
16
|
-
*
|
|
17
|
-
* @remarks
|
|
18
|
-
* Creates HTML table structure with optional caption and processes
|
|
19
|
-
* all table rows. Applies CSS classes for styling and maintains
|
|
20
|
-
* proper table markup for documentation display.
|
|
21
|
-
*
|
|
22
|
-
* @param element - The document table element to render
|
|
23
|
-
* @param type - The rendering context type (unused in implementation)
|
|
24
|
-
* @returns Array of HTML strings forming the table structure
|
|
25
|
-
*/
|
|
26
4
|
renderToLines(element: AbstractDocTableType, type: string): string[];
|
|
27
5
|
}
|
|
28
|
-
/**
|
|
29
|
-
* Renderer for Doxygen document table caption elements.
|
|
30
|
-
*
|
|
31
|
-
* @remarks
|
|
32
|
-
* Generates HTML caption elements for table titles and descriptions.
|
|
33
|
-
* Processes caption content to provide contextual information about
|
|
34
|
-
* table contents and purpose within documentation.
|
|
35
|
-
*
|
|
36
|
-
* @public
|
|
37
|
-
*/
|
|
38
6
|
export declare class DocCaptionLinesRenderer extends ElementLinesRendererBase {
|
|
39
|
-
/**
|
|
40
|
-
* Renders a document caption element to formatted output lines.
|
|
41
|
-
*
|
|
42
|
-
* @remarks
|
|
43
|
-
* Creates HTML caption element containing the processed caption content.
|
|
44
|
-
* Renders child elements to build complete caption text with proper
|
|
45
|
-
* markup and formatting preservation.
|
|
46
|
-
*
|
|
47
|
-
* @param element - The document caption element to render
|
|
48
|
-
* @param type - The rendering context type (unused in implementation)
|
|
49
|
-
* @returns Array containing the HTML caption element
|
|
50
|
-
*/
|
|
51
7
|
renderToLines(element: AbstractDocCaptionType, type: string): string[];
|
|
52
8
|
}
|
|
53
|
-
/**
|
|
54
|
-
* Renderer for Doxygen document table row elements.
|
|
55
|
-
*
|
|
56
|
-
* @remarks
|
|
57
|
-
* Generates HTML table row structure containing table entries.
|
|
58
|
-
* Processes all entry elements within the row to build complete
|
|
59
|
-
* table row markup for documentation display.
|
|
60
|
-
*
|
|
61
|
-
* @public
|
|
62
|
-
*/
|
|
63
9
|
export declare class DocRowTypeLinesRenderer extends ElementLinesRendererBase {
|
|
64
|
-
/**
|
|
65
|
-
* Renders a document table row element to formatted output lines.
|
|
66
|
-
*
|
|
67
|
-
* @remarks
|
|
68
|
-
* Creates HTML table row tags around rendered table entries.
|
|
69
|
-
* Processes entry elements to generate the complete row structure
|
|
70
|
-
* with proper table markup.
|
|
71
|
-
*
|
|
72
|
-
* @param element - The document table row element to render
|
|
73
|
-
* @param type - The rendering context type (unused in implementation)
|
|
74
|
-
* @returns Array of HTML strings forming the table row
|
|
75
|
-
*/
|
|
76
10
|
renderToLines(element: AbstractDocRowType, type: string): string[];
|
|
77
11
|
}
|
|
78
|
-
/**
|
|
79
|
-
* Renderer for Doxygen document table entry elements.
|
|
80
|
-
*
|
|
81
|
-
* @remarks
|
|
82
|
-
* Converts table cell elements to HTML table data or header cells
|
|
83
|
-
* with appropriate attributes. Handles cell spanning, alignment,
|
|
84
|
-
* and styling attributes for flexible table presentation.
|
|
85
|
-
*
|
|
86
|
-
* @public
|
|
87
|
-
*/
|
|
88
12
|
export declare class DocEntryTypeStringRenderer extends ElementStringRendererBase {
|
|
89
|
-
/**
|
|
90
|
-
* Renders a document table entry element to a formatted string.
|
|
91
|
-
*
|
|
92
|
-
* @remarks
|
|
93
|
-
* Creates HTML table cell (td or th) with attributes including
|
|
94
|
-
* colspan, rowspan, alignment, and styling. Processes cell content
|
|
95
|
-
* and applies appropriate markup based on header status.
|
|
96
|
-
*
|
|
97
|
-
* @param element - The document table entry element to render
|
|
98
|
-
* @param type - The rendering context type (unused in implementation)
|
|
99
|
-
* @returns The formatted HTML table cell string
|
|
100
|
-
*/
|
|
101
13
|
renderToString(element: AbstractDocEntryType, type: string): string;
|
|
102
14
|
}
|
|
103
15
|
//# sourceMappingURL=doctabletype.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"doctabletype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctabletype.ts"],"names":[],"mappings":"AAgBA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EACV,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,0DAA0D,CAAA;
|
|
1
|
+
{"version":3,"file":"doctabletype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctabletype.ts"],"names":[],"mappings":"AAgBA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EACV,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,0DAA0D,CAAA;AAcjE,qBAAa,yBAA0B,SAAQ,wBAAwB;IAa5D,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAE7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAiBZ;AAYD,qBAAa,uBAAwB,SAAQ,wBAAwB;IAcnE,aAAa,CAAC,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAiBvE;AAYD,qBAAa,uBAAwB,SAAQ,wBAAwB;IAc1D,aAAa,CAAC,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAa5E;AAYD,qBAAa,0BAA2B,SAAQ,yBAAyB;IAcvE,cAAc,CAAC,OAAO,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAoCpE"}
|
|
@@ -1,45 +1,6 @@
|
|
|
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, ElementStringRendererBase, } from './element-renderer-base.js';
|
|
15
|
-
// ----------------------------------------------------------------------------
|
|
16
|
-
/**
|
|
17
|
-
* Renderer for Doxygen document table elements.
|
|
18
|
-
*
|
|
19
|
-
* @remarks
|
|
20
|
-
* Converts Doxygen table structures to HTML table format with optional
|
|
21
|
-
* captions. Processes table rows and maintains styling through CSS
|
|
22
|
-
* classes for consistent documentation presentation.
|
|
23
|
-
*
|
|
24
|
-
* @public
|
|
25
|
-
*/
|
|
26
2
|
export class DocTableTypeLinesRenderer extends ElementLinesRendererBase {
|
|
27
|
-
|
|
28
|
-
* Renders a document table element to formatted output lines.
|
|
29
|
-
*
|
|
30
|
-
* @remarks
|
|
31
|
-
* Creates HTML table structure with optional caption and processes
|
|
32
|
-
* all table rows. Applies CSS classes for styling and maintains
|
|
33
|
-
* proper table markup for documentation display.
|
|
34
|
-
*
|
|
35
|
-
* @param element - The document table element to render
|
|
36
|
-
* @param type - The rendering context type (unused in implementation)
|
|
37
|
-
* @returns Array of HTML strings forming the table structure
|
|
38
|
-
*/
|
|
39
|
-
renderToLines(element,
|
|
40
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
41
|
-
type) {
|
|
42
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
3
|
+
renderToLines(element, type) {
|
|
43
4
|
const lines = [];
|
|
44
5
|
lines.push('');
|
|
45
6
|
lines.push('<table class="doxyTable">');
|
|
@@ -51,32 +12,8 @@ export class DocTableTypeLinesRenderer extends ElementLinesRendererBase {
|
|
|
51
12
|
return lines;
|
|
52
13
|
}
|
|
53
14
|
}
|
|
54
|
-
/**
|
|
55
|
-
* Renderer for Doxygen document table caption elements.
|
|
56
|
-
*
|
|
57
|
-
* @remarks
|
|
58
|
-
* Generates HTML caption elements for table titles and descriptions.
|
|
59
|
-
* Processes caption content to provide contextual information about
|
|
60
|
-
* table contents and purpose within documentation.
|
|
61
|
-
*
|
|
62
|
-
* @public
|
|
63
|
-
*/
|
|
64
15
|
export class DocCaptionLinesRenderer extends ElementLinesRendererBase {
|
|
65
|
-
/**
|
|
66
|
-
* Renders a document caption element to formatted output lines.
|
|
67
|
-
*
|
|
68
|
-
* @remarks
|
|
69
|
-
* Creates HTML caption element containing the processed caption content.
|
|
70
|
-
* Renders child elements to build complete caption text with proper
|
|
71
|
-
* markup and formatting preservation.
|
|
72
|
-
*
|
|
73
|
-
* @param element - The document caption element to render
|
|
74
|
-
* @param type - The rendering context type (unused in implementation)
|
|
75
|
-
* @returns Array containing the HTML caption element
|
|
76
|
-
*/
|
|
77
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
78
16
|
renderToLines(element, type) {
|
|
79
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
80
17
|
let text = '';
|
|
81
18
|
let attributes = '';
|
|
82
19
|
if (element.id.length > 0) {
|
|
@@ -90,32 +27,8 @@ export class DocCaptionLinesRenderer extends ElementLinesRendererBase {
|
|
|
90
27
|
return [text];
|
|
91
28
|
}
|
|
92
29
|
}
|
|
93
|
-
/**
|
|
94
|
-
* Renderer for Doxygen document table row elements.
|
|
95
|
-
*
|
|
96
|
-
* @remarks
|
|
97
|
-
* Generates HTML table row structure containing table entries.
|
|
98
|
-
* Processes all entry elements within the row to build complete
|
|
99
|
-
* table row markup for documentation display.
|
|
100
|
-
*
|
|
101
|
-
* @public
|
|
102
|
-
*/
|
|
103
30
|
export class DocRowTypeLinesRenderer extends ElementLinesRendererBase {
|
|
104
|
-
/**
|
|
105
|
-
* Renders a document table row element to formatted output lines.
|
|
106
|
-
*
|
|
107
|
-
* @remarks
|
|
108
|
-
* Creates HTML table row tags around rendered table entries.
|
|
109
|
-
* Processes entry elements to generate the complete row structure
|
|
110
|
-
* with proper table markup.
|
|
111
|
-
*
|
|
112
|
-
* @param element - The document table row element to render
|
|
113
|
-
* @param type - The rendering context type (unused in implementation)
|
|
114
|
-
* @returns Array of HTML strings forming the table row
|
|
115
|
-
*/
|
|
116
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
117
31
|
renderToLines(element, type) {
|
|
118
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
119
32
|
const lines = [];
|
|
120
33
|
lines.push('<tr>');
|
|
121
34
|
lines.push(...this.workspace.renderElementsArrayToLines(element.entries, 'html'));
|
|
@@ -123,32 +36,8 @@ export class DocRowTypeLinesRenderer extends ElementLinesRendererBase {
|
|
|
123
36
|
return lines;
|
|
124
37
|
}
|
|
125
38
|
}
|
|
126
|
-
/**
|
|
127
|
-
* Renderer for Doxygen document table entry elements.
|
|
128
|
-
*
|
|
129
|
-
* @remarks
|
|
130
|
-
* Converts table cell elements to HTML table data or header cells
|
|
131
|
-
* with appropriate attributes. Handles cell spanning, alignment,
|
|
132
|
-
* and styling attributes for flexible table presentation.
|
|
133
|
-
*
|
|
134
|
-
* @public
|
|
135
|
-
*/
|
|
136
39
|
export class DocEntryTypeStringRenderer extends ElementStringRendererBase {
|
|
137
|
-
/**
|
|
138
|
-
* Renders a document table entry element to a formatted string.
|
|
139
|
-
*
|
|
140
|
-
* @remarks
|
|
141
|
-
* Creates HTML table cell (td or th) with attributes including
|
|
142
|
-
* colspan, rowspan, alignment, and styling. Processes cell content
|
|
143
|
-
* and applies appropriate markup based on header status.
|
|
144
|
-
*
|
|
145
|
-
* @param element - The document table entry element to render
|
|
146
|
-
* @param type - The rendering context type (unused in implementation)
|
|
147
|
-
* @returns The formatted HTML table cell string
|
|
148
|
-
*/
|
|
149
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
150
40
|
renderToString(element, type) {
|
|
151
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
152
41
|
let text = '';
|
|
153
42
|
let attributes = '';
|
|
154
43
|
if (element.colspan !== undefined) {
|
|
@@ -182,5 +71,4 @@ export class DocEntryTypeStringRenderer extends ElementStringRendererBase {
|
|
|
182
71
|
return text;
|
|
183
72
|
}
|
|
184
73
|
}
|
|
185
|
-
// ----------------------------------------------------------------------------
|
|
186
74
|
//# sourceMappingURL=doctabletype.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"doctabletype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctabletype.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"doctabletype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctabletype.ts"],"names":[],"mappings":"AAgBA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,GAC1B,MAAM,4BAA4B,CAAA;AAoBnC,MAAM,OAAO,yBAA0B,SAAQ,wBAAwB;IAa5D,aAAa,CACpB,OAA6B,EAE7B,IAAY;QAIZ,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAA;QACvC,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;QAC3E,CAAC;QACD,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CACnE,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAEtB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAYD,MAAM,OAAO,uBAAwB,SAAQ,wBAAwB;IAcnE,aAAa,CAAC,OAA+B,EAAE,IAAY;QAGzD,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,UAAU,GAAG,EAAE,CAAA;QACnB,IAAI,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,UAAU,IAAI,QAAQ,OAAO,CAAC,EAAE,GAAG,CAAA;QACrC,CAAC;QACD,IAAI,IAAI,WAAW,UAAU,GAAG,CAAA;QAChC,IAAI,IAAI,IAAI,CAAC,SAAS;aACnB,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC;aACrD,IAAI,EAAE,CAAA;QACT,IAAI,IAAI,YAAY,CAAA;QAEpB,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF;AAYD,MAAM,OAAO,uBAAwB,SAAQ,wBAAwB;IAc1D,aAAa,CAAC,OAA2B,EAAE,IAAY;QAG9D,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAClB,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CACtE,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEnB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAYD,MAAM,OAAO,0BAA2B,SAAQ,yBAAyB;IAcvE,cAAc,CAAC,OAA6B,EAAE,IAAY;QAGxD,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,UAAU,GAAG,EAAE,CAAA;QACnB,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,UAAU,IAAI,aAAa,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAA;QAC1D,CAAC;QACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,UAAU,IAAI,aAAa,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAA;QAC1D,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,UAAU,IAAI,WAAW,OAAO,CAAC,KAAK,GAAG,CAAA;QAC3C,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,UAAU,IAAI,YAAY,OAAO,CAAC,MAAM,GAAG,CAAA;QAC7C,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,UAAU,IAAI,WAAW,OAAO,CAAC,KAAK,GAAG,CAAA;QAC3C,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,UAAU,IAAI,WAAW,OAAO,CAAC,MAAM,GAAG,CAAA;QAC5C,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,2BAA2B,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC;aAClD,IAAI,EAAE,CAAA;QACT,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,IAAI,IAAI,MAAM,UAAU,IAAI,KAAK,OAAO,CAAA;QAC1C,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,MAAM,UAAU,IAAI,KAAK,OAAO,CAAA;QAC1C,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF"}
|
|
@@ -1,28 +1,6 @@
|
|
|
1
1
|
import { ElementLinesRendererBase } from './element-renderer-base.js';
|
|
2
2
|
import { type AbstractDocTitleType } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
|
|
3
|
-
/**
|
|
4
|
-
* Renderer for Doxygen document title elements.
|
|
5
|
-
*
|
|
6
|
-
* @remarks
|
|
7
|
-
* Handles title and term elements within documentation structures.
|
|
8
|
-
* Supports polymorphic rendering for different title types while
|
|
9
|
-
* providing error handling for unrecognised element variations.
|
|
10
|
-
*
|
|
11
|
-
* @public
|
|
12
|
-
*/
|
|
13
3
|
export declare class DocTitleTypeLinesRenderer extends ElementLinesRendererBase {
|
|
14
|
-
/**
|
|
15
|
-
* Renders a document title element to formatted output lines.
|
|
16
|
-
*
|
|
17
|
-
* @remarks
|
|
18
|
-
* Processes title and term data models by rendering their child elements.
|
|
19
|
-
* Logs errors for unrecognised title types that require implementation
|
|
20
|
-
* support for complete documentation coverage.
|
|
21
|
-
*
|
|
22
|
-
* @param element - The document title element to render
|
|
23
|
-
* @param type - The rendering context type
|
|
24
|
-
* @returns Array containing the rendered title text
|
|
25
|
-
*/
|
|
26
4
|
renderToLines(element: AbstractDocTitleType, type: string): string[];
|
|
27
5
|
}
|
|
28
6
|
//# sourceMappingURL=doctitletype.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"doctitletype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctitletype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EACL,KAAK,oBAAoB,EAG1B,MAAM,0DAA0D,CAAA;
|
|
1
|
+
{"version":3,"file":"doctitletype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctitletype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EACL,KAAK,oBAAoB,EAG1B,MAAM,0DAA0D,CAAA;AAcjE,qBAAa,yBAA0B,SAAQ,wBAAwB;IAa5D,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAuBZ"}
|
|
@@ -1,44 +1,7 @@
|
|
|
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
2
|
import { TermDataModel, TitleDataModel, } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
|
|
16
|
-
// ----------------------------------------------------------------------------
|
|
17
|
-
/**
|
|
18
|
-
* Renderer for Doxygen document title elements.
|
|
19
|
-
*
|
|
20
|
-
* @remarks
|
|
21
|
-
* Handles title and term elements within documentation structures.
|
|
22
|
-
* Supports polymorphic rendering for different title types while
|
|
23
|
-
* providing error handling for unrecognised element variations.
|
|
24
|
-
*
|
|
25
|
-
* @public
|
|
26
|
-
*/
|
|
27
3
|
export class DocTitleTypeLinesRenderer extends ElementLinesRendererBase {
|
|
28
|
-
/**
|
|
29
|
-
* Renders a document title element to formatted output lines.
|
|
30
|
-
*
|
|
31
|
-
* @remarks
|
|
32
|
-
* Processes title and term data models by rendering their child elements.
|
|
33
|
-
* Logs errors for unrecognised title types that require implementation
|
|
34
|
-
* support for complete documentation coverage.
|
|
35
|
-
*
|
|
36
|
-
* @param element - The document title element to render
|
|
37
|
-
* @param type - The rendering context type
|
|
38
|
-
* @returns Array containing the rendered title text
|
|
39
|
-
*/
|
|
40
4
|
renderToLines(element, type) {
|
|
41
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
42
5
|
let text = '';
|
|
43
6
|
if (element instanceof TitleDataModel) {
|
|
44
7
|
text += this.workspace.renderElementsArrayToString(element.children, type);
|
|
@@ -48,13 +11,8 @@ export class DocTitleTypeLinesRenderer extends ElementLinesRendererBase {
|
|
|
48
11
|
}
|
|
49
12
|
else {
|
|
50
13
|
console.error(element.constructor.name, 'not rendered in', this.constructor.name);
|
|
51
|
-
// text += '<b>'
|
|
52
|
-
// text +=
|
|
53
|
-
// this.workspace.renderElementsArrayToString(element.children, type)
|
|
54
|
-
// text += '</b>'
|
|
55
14
|
}
|
|
56
15
|
return [text];
|
|
57
16
|
}
|
|
58
17
|
}
|
|
59
|
-
// ----------------------------------------------------------------------------
|
|
60
18
|
//# sourceMappingURL=doctitletype.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"doctitletype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctitletype.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"doctitletype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctitletype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAEL,aAAa,EACb,cAAc,GACf,MAAM,0DAA0D,CAAA;AAcjE,MAAM,OAAO,yBAA0B,SAAQ,wBAAwB;IAa5D,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAIZ,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,OAAO,YAAY,cAAc,EAAE,CAAC;YACtC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAC5E,CAAC;aAAM,IAAI,OAAO,YAAY,aAAa,EAAE,CAAC;YAC5C,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAC5E,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,CAAC,IAAI,EACxB,iBAAiB,EACjB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QAKH,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF"}
|
|
@@ -1,53 +1,9 @@
|
|
|
1
1
|
import { ElementLinesRendererBase } from './element-renderer-base.js';
|
|
2
2
|
import type { AbstractDocVariableListType, VariableListPairDataModel } from '../../doxygen/data-model/compounds/docvarlistentrytype-dm.js';
|
|
3
|
-
/**
|
|
4
|
-
* Renderer for Doxygen variable list container elements.
|
|
5
|
-
*
|
|
6
|
-
* @remarks
|
|
7
|
-
* Creates HTML definition list structure for variable lists containing
|
|
8
|
-
* term-description pairs. Provides the outer container for organised
|
|
9
|
-
* presentation of variable documentation.
|
|
10
|
-
*
|
|
11
|
-
* @public
|
|
12
|
-
*/
|
|
13
3
|
export declare class DocVariableListTypeLinesRenderer extends ElementLinesRendererBase {
|
|
14
|
-
/**
|
|
15
|
-
* Renders a variable list container to formatted output lines.
|
|
16
|
-
*
|
|
17
|
-
* @remarks
|
|
18
|
-
* Creates an HTML definition list wrapper around variable list entries.
|
|
19
|
-
* Each child element represents a term-description pair within the
|
|
20
|
-
* structured list format.
|
|
21
|
-
*
|
|
22
|
-
* @param element - The variable list container element to render
|
|
23
|
-
* @param type - The rendering context type (unused in implementation)
|
|
24
|
-
* @returns Array of HTML strings forming the definition list structure
|
|
25
|
-
*/
|
|
26
4
|
renderToLines(element: AbstractDocVariableListType, type: string): string[];
|
|
27
5
|
}
|
|
28
|
-
/**
|
|
29
|
-
* Renderer for individual variable list entry pairs.
|
|
30
|
-
*
|
|
31
|
-
* @remarks
|
|
32
|
-
* Converts term-description pairs into HTML definition list items.
|
|
33
|
-
* Handles both single-line and multi-line descriptions with appropriate
|
|
34
|
-
* formatting for readable documentation output.
|
|
35
|
-
*
|
|
36
|
-
* @public
|
|
37
|
-
*/
|
|
38
6
|
export declare class VariableListPairLinesRenderer extends ElementLinesRendererBase {
|
|
39
|
-
/**
|
|
40
|
-
* Renders a variable list entry pair to formatted output lines.
|
|
41
|
-
*
|
|
42
|
-
* @remarks
|
|
43
|
-
* Creates HTML definition term and description elements from the
|
|
44
|
-
* variable list entry. Handles multi-line descriptions by splitting
|
|
45
|
-
* content across multiple lines within the definition element.
|
|
46
|
-
*
|
|
47
|
-
* @param element - The variable list pair element to render
|
|
48
|
-
* @param type - The rendering context type (unused in implementation)
|
|
49
|
-
* @returns Array of HTML strings for the term-description pair
|
|
50
|
-
*/
|
|
51
7
|
renderToLines(element: VariableListPairDataModel, type: string): string[];
|
|
52
8
|
}
|
|
53
9
|
//# sourceMappingURL=docvariablelisttype.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docvariablelisttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docvariablelisttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EACV,2BAA2B,EAC3B,yBAAyB,EAC1B,MAAM,8DAA8D,CAAA;
|
|
1
|
+
{"version":3,"file":"docvariablelisttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docvariablelisttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EACV,2BAA2B,EAC3B,yBAAyB,EAC1B,MAAM,8DAA8D,CAAA;AAcrE,qBAAa,gCAAiC,SAAQ,wBAAwB;IAc5E,aAAa,CAAC,OAAO,EAAE,2BAA2B,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAc5E;AAYD,qBAAa,6BAA8B,SAAQ,wBAAwB;IAahE,aAAa,CACpB,OAAO,EAAE,yBAAyB,EAElC,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CA6BZ"}
|
|
@@ -1,44 +1,6 @@
|
|
|
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 Doxygen variable list container elements.
|
|
18
|
-
*
|
|
19
|
-
* @remarks
|
|
20
|
-
* Creates HTML definition list structure for variable lists containing
|
|
21
|
-
* term-description pairs. Provides the outer container for organised
|
|
22
|
-
* presentation of variable documentation.
|
|
23
|
-
*
|
|
24
|
-
* @public
|
|
25
|
-
*/
|
|
26
2
|
export class DocVariableListTypeLinesRenderer extends ElementLinesRendererBase {
|
|
27
|
-
/**
|
|
28
|
-
* Renders a variable list container to formatted output lines.
|
|
29
|
-
*
|
|
30
|
-
* @remarks
|
|
31
|
-
* Creates an HTML definition list wrapper around variable list entries.
|
|
32
|
-
* Each child element represents a term-description pair within the
|
|
33
|
-
* structured list format.
|
|
34
|
-
*
|
|
35
|
-
* @param element - The variable list container element to render
|
|
36
|
-
* @param type - The rendering context type (unused in implementation)
|
|
37
|
-
* @returns Array of HTML strings forming the definition list structure
|
|
38
|
-
*/
|
|
39
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
40
3
|
renderToLines(element, type) {
|
|
41
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
42
4
|
const lines = [];
|
|
43
5
|
lines.push('');
|
|
44
6
|
lines.push('<dl class="doxyVariableList">');
|
|
@@ -47,41 +9,12 @@ export class DocVariableListTypeLinesRenderer extends ElementLinesRendererBase {
|
|
|
47
9
|
return lines;
|
|
48
10
|
}
|
|
49
11
|
}
|
|
50
|
-
/**
|
|
51
|
-
* Renderer for individual variable list entry pairs.
|
|
52
|
-
*
|
|
53
|
-
* @remarks
|
|
54
|
-
* Converts term-description pairs into HTML definition list items.
|
|
55
|
-
* Handles both single-line and multi-line descriptions with appropriate
|
|
56
|
-
* formatting for readable documentation output.
|
|
57
|
-
*
|
|
58
|
-
* @public
|
|
59
|
-
*/
|
|
60
12
|
export class VariableListPairLinesRenderer extends ElementLinesRendererBase {
|
|
61
|
-
|
|
62
|
-
* Renders a variable list entry pair to formatted output lines.
|
|
63
|
-
*
|
|
64
|
-
* @remarks
|
|
65
|
-
* Creates HTML definition term and description elements from the
|
|
66
|
-
* variable list entry. Handles multi-line descriptions by splitting
|
|
67
|
-
* content across multiple lines within the definition element.
|
|
68
|
-
*
|
|
69
|
-
* @param element - The variable list pair element to render
|
|
70
|
-
* @param type - The rendering context type (unused in implementation)
|
|
71
|
-
* @returns Array of HTML strings for the term-description pair
|
|
72
|
-
*/
|
|
73
|
-
renderToLines(element,
|
|
74
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
75
|
-
type) {
|
|
76
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
13
|
+
renderToLines(element, type) {
|
|
77
14
|
const lines = [];
|
|
78
|
-
// console.log(element.varlistentry.term)
|
|
79
|
-
// console.log(element.listitem.paras)
|
|
80
|
-
// WARNING: the title includes <b></b>
|
|
81
15
|
const title = this.workspace
|
|
82
16
|
.renderElementToString(element.varlistentry.term, 'html')
|
|
83
17
|
.trim();
|
|
84
|
-
// this.workspace.skipElementsPara(element.listitem.paras)
|
|
85
18
|
const description = this.workspace
|
|
86
19
|
.renderElementsArrayToString(element.listitem.paras, 'html')
|
|
87
20
|
.trim();
|
|
@@ -97,5 +30,4 @@ export class VariableListPairLinesRenderer extends ElementLinesRendererBase {
|
|
|
97
30
|
return lines;
|
|
98
31
|
}
|
|
99
32
|
}
|
|
100
|
-
// ----------------------------------------------------------------------------
|
|
101
33
|
//# sourceMappingURL=docvariablelisttype.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docvariablelisttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docvariablelisttype.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"docvariablelisttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docvariablelisttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAkBrE,MAAM,OAAO,gCAAiC,SAAQ,wBAAwB;IAc5E,aAAa,CAAC,OAAoC,EAAE,IAAY;QAG9D,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAA;QAC3C,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CACvE,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEnB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAYD,MAAM,OAAO,6BAA8B,SAAQ,wBAAwB;IAahE,aAAa,CACpB,OAAkC,EAElC,IAAY;QAIZ,MAAM,KAAK,GAAa,EAAE,CAAA;QAM1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC;aACxD,IAAI,EAAE,CAAA;QAGT,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS;aAC/B,2BAA2B,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;aAC3D,IAAI,EAAE,CAAA;QAET,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,CAAA;QAC/B,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,OAAO,WAAW,OAAO,CAAC,CAAA;QACvC,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAClB,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;YACtC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrB,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF"}
|
|
@@ -1,28 +1,6 @@
|
|
|
1
1
|
import { ElementLinesRendererBase } from './element-renderer-base.js';
|
|
2
2
|
import type { AbstractDocXRefSectType } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
|
|
3
|
-
/**
|
|
4
|
-
* Renderer for Doxygen cross-reference section elements.
|
|
5
|
-
*
|
|
6
|
-
* @remarks
|
|
7
|
-
* Generates HTML structure for cross-reference sections with titles and
|
|
8
|
-
* descriptions. Creates definition lists with linked titles and detailed
|
|
9
|
-
* content for documentation cross-references.
|
|
10
|
-
*
|
|
11
|
-
* @public
|
|
12
|
-
*/
|
|
13
3
|
export declare class DocXRefSectLinesRenderer extends ElementLinesRendererBase {
|
|
14
|
-
/**
|
|
15
|
-
* Renders a cross-reference section to formatted output lines.
|
|
16
|
-
*
|
|
17
|
-
* @remarks
|
|
18
|
-
* Creates an HTML definition list structure with the cross-reference
|
|
19
|
-
* title as a linked term and the description as the definition content.
|
|
20
|
-
* Generates a permalink for the cross-reference section.
|
|
21
|
-
*
|
|
22
|
-
* @param element - The cross-reference section element to render
|
|
23
|
-
* @param type - The rendering context type (unused in implementation)
|
|
24
|
-
* @returns Array of HTML strings forming the cross-reference section
|
|
25
|
-
*/
|
|
26
4
|
renderToLines(element: AbstractDocXRefSectType, type: string): string[];
|
|
27
5
|
}
|
|
28
6
|
//# sourceMappingURL=docxrefsecttype.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docxrefsecttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docxrefsecttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0DAA0D,CAAA;
|
|
1
|
+
{"version":3,"file":"docxrefsecttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docxrefsecttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0DAA0D,CAAA;AAcvG,qBAAa,wBAAyB,SAAQ,wBAAwB;IAcpE,aAAa,CAAC,OAAO,EAAE,uBAAuB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAoCxE"}
|
|
@@ -1,44 +1,7 @@
|
|
|
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
|
-
// import * as util from 'node:util'
|
|
14
2
|
import { ElementLinesRendererBase } from './element-renderer-base.js';
|
|
15
|
-
// ----------------------------------------------------------------------------
|
|
16
|
-
/**
|
|
17
|
-
* Renderer for Doxygen cross-reference section elements.
|
|
18
|
-
*
|
|
19
|
-
* @remarks
|
|
20
|
-
* Generates HTML structure for cross-reference sections with titles and
|
|
21
|
-
* descriptions. Creates definition lists with linked titles and detailed
|
|
22
|
-
* content for documentation cross-references.
|
|
23
|
-
*
|
|
24
|
-
* @public
|
|
25
|
-
*/
|
|
26
3
|
export class DocXRefSectLinesRenderer extends ElementLinesRendererBase {
|
|
27
|
-
/**
|
|
28
|
-
* Renders a cross-reference section to formatted output lines.
|
|
29
|
-
*
|
|
30
|
-
* @remarks
|
|
31
|
-
* Creates an HTML definition list structure with the cross-reference
|
|
32
|
-
* title as a linked term and the description as the definition content.
|
|
33
|
-
* Generates a permalink for the cross-reference section.
|
|
34
|
-
*
|
|
35
|
-
* @param element - The cross-reference section element to render
|
|
36
|
-
* @param type - The rendering context type (unused in implementation)
|
|
37
|
-
* @returns Array of HTML strings forming the cross-reference section
|
|
38
|
-
*/
|
|
39
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
40
4
|
renderToLines(element, type) {
|
|
41
|
-
// console.log(util.inspect(element, { compact: false, depth: 999 }))
|
|
42
5
|
const lines = [];
|
|
43
6
|
const title = this.workspace.renderString(element.xreftitle ?? '???', 'html');
|
|
44
7
|
const permalink = this.workspace.getPermalink({
|
|
@@ -62,5 +25,4 @@ export class DocXRefSectLinesRenderer extends ElementLinesRendererBase {
|
|
|
62
25
|
return lines;
|
|
63
26
|
}
|
|
64
27
|
}
|
|
65
|
-
// ----------------------------------------------------------------------------
|
|
66
28
|
//# sourceMappingURL=docxrefsecttype.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docxrefsecttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docxrefsecttype.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"docxrefsecttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docxrefsecttype.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAGhC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAerE,MAAM,OAAO,wBAAyB,SAAQ,wBAAwB;IAcpE,aAAa,CAAC,OAAgC,EAAE,IAAY;QAG1D,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CACvC,OAAO,CAAC,SAAS,IAAI,KAAK,EAC1B,MAAM,CACP,CAAA;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;YAC5C,KAAK,EAAE,OAAO,CAAC,EAAE;YACjB,OAAO,EAAE,UAAU;SACpB,CAAC,CAAA;QACF,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,CAAA;QAE/B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;QACxC,KAAK,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAA;QAC3C,KAAK,CAAC,IAAI,CACR,yCAAyC,SAAS,IAAI,KAAK,WAAW,CACvE,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAA;QAElD,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAC1C,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,SAAS;iBACX,qBAAqB,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC;iBACtD,IAAI,EAAE,CACV,CAAA;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAEpB,OAAO,KAAK,CAAA;IACd,CAAC;CACF"}
|