@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,159 +1,49 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Front matter configuration for Docusaurus Markdown files.
|
|
3
|
-
*
|
|
4
|
-
* @remarks
|
|
5
|
-
* Defines the YAML front matter structure used in generated Markdown files
|
|
6
|
-
* to control Docusaurus page behaviour and metadata. This interface supports
|
|
7
|
-
* flexible property addition whilst maintaining type safety for common
|
|
8
|
-
* front matter fields used throughout the documentation generation process.
|
|
9
|
-
*
|
|
10
|
-
* @public
|
|
11
|
-
*/
|
|
12
1
|
export interface FrontMatter {
|
|
13
|
-
/** Array of keywords associated with the page for SEO purposes. */
|
|
14
2
|
keywords: string[];
|
|
15
|
-
/** Additional front matter properties with flexible typing. */
|
|
16
3
|
[key: string]: string | string[] | null | boolean | number | undefined;
|
|
17
4
|
}
|
|
18
|
-
/**
|
|
19
|
-
* Structure for collapsible table rows in documentation displays.
|
|
20
|
-
*
|
|
21
|
-
* @remarks
|
|
22
|
-
* Represents hierarchical data that can be rendered as expandable table
|
|
23
|
-
* rows with nested children and associated metadata. This structure supports
|
|
24
|
-
* tree-like navigation interfaces where users can explore documentation
|
|
25
|
-
* hierarchies in an organised and intuitive manner.
|
|
26
|
-
*
|
|
27
|
-
* @public
|
|
28
|
-
*/
|
|
29
5
|
export interface collapsibleTableRow {
|
|
30
|
-
/** Unique identifier for the table row. */
|
|
31
6
|
id: string;
|
|
32
|
-
/** Optional single letter icon representation. */
|
|
33
7
|
iconLetter?: string;
|
|
34
|
-
/** Optional CSS class for icon styling. */
|
|
35
8
|
iconClass?: string;
|
|
36
|
-
/** Display label for the row. */
|
|
37
9
|
label: string;
|
|
38
|
-
/** URL link associated with the row. */
|
|
39
10
|
link: string;
|
|
40
|
-
/** Descriptive text for the row content. */
|
|
41
11
|
description: string;
|
|
42
|
-
/** Optional nested child rows for hierarchical display. */
|
|
43
12
|
children?: collapsibleTableRow[];
|
|
44
13
|
}
|
|
45
|
-
/**
|
|
46
|
-
* Docusaurus sidebar category configuration.
|
|
47
|
-
*
|
|
48
|
-
* @remarks
|
|
49
|
-
* Defines a collapsible category in the Docusaurus sidebar that can contain
|
|
50
|
-
* multiple items and has an associated documentation link. This represents
|
|
51
|
-
* the top-level navigation structure with a fixed collapsed state and
|
|
52
|
-
* mandatory link configuration for consistent navigation behaviour.
|
|
53
|
-
*
|
|
54
|
-
* @public
|
|
55
|
-
*/
|
|
56
14
|
export interface SidebarCategory {
|
|
57
|
-
/** The type identifier for sidebar categories. */
|
|
58
15
|
type: 'category';
|
|
59
|
-
/** Display label for the category. */
|
|
60
16
|
label: string;
|
|
61
|
-
/** Link configuration for the category header. */
|
|
62
17
|
link: {
|
|
63
|
-
/** The type of link (always 'doc' for documentation links). */
|
|
64
18
|
type: 'doc';
|
|
65
|
-
/** The document identifier for the category link. */
|
|
66
19
|
id: string;
|
|
67
20
|
};
|
|
68
|
-
/** Whether the category should be collapsed by default. */
|
|
69
21
|
collapsed: false;
|
|
70
|
-
/** Array of sidebar items contained within this category. */
|
|
71
22
|
items: SidebarItem[];
|
|
72
23
|
}
|
|
73
|
-
/**
|
|
74
|
-
* Individual documentation item in the Docusaurus sidebar.
|
|
75
|
-
*
|
|
76
|
-
* @remarks
|
|
77
|
-
* Represents a single documentation page entry within the sidebar
|
|
78
|
-
* navigation structure. This interface provides the essential properties
|
|
79
|
-
* for creating clickable navigation links with optional styling support
|
|
80
|
-
* for consistent visual presentation across the documentation site.
|
|
81
|
-
*
|
|
82
|
-
* @public
|
|
83
|
-
*/
|
|
84
24
|
export interface SidebarDocItem {
|
|
85
|
-
/** The type identifier for document items. */
|
|
86
25
|
type: 'doc';
|
|
87
|
-
/** Display label for the sidebar item. */
|
|
88
26
|
label: string;
|
|
89
|
-
/** Optional CSS class name for styling. */
|
|
90
27
|
className?: string;
|
|
91
|
-
/** The document identifier for linking. */
|
|
92
28
|
id: string;
|
|
93
29
|
}
|
|
94
|
-
/**
|
|
95
|
-
* Nested category item within the Docusaurus sidebar.
|
|
96
|
-
*
|
|
97
|
-
* @remarks
|
|
98
|
-
* Represents a hierarchical category that can contain other sidebar items
|
|
99
|
-
* and may optionally have its own documentation link. This interface
|
|
100
|
-
* enables the creation of multi-level navigation structures with flexible
|
|
101
|
-
* collapse behaviour and optional styling for enhanced user experience.
|
|
102
|
-
*
|
|
103
|
-
* @public
|
|
104
|
-
*/
|
|
105
30
|
export interface SidebarCategoryItem {
|
|
106
|
-
/** The type identifier for category items. */
|
|
107
31
|
type: 'category';
|
|
108
|
-
/** Display label for the category. */
|
|
109
32
|
label: string;
|
|
110
|
-
/** Optional link configuration for the category. */
|
|
111
33
|
link?: {
|
|
112
|
-
/** The type of link (always 'doc' for documentation links). */
|
|
113
34
|
type: 'doc';
|
|
114
|
-
/** The document identifier for the category link. */
|
|
115
35
|
id: string;
|
|
116
36
|
};
|
|
117
|
-
/** Optional CSS class name for styling. */
|
|
118
37
|
className?: string;
|
|
119
|
-
/** Whether the category should be collapsed by default. */
|
|
120
38
|
collapsed: boolean;
|
|
121
|
-
/** Array of nested sidebar items within this category. */
|
|
122
39
|
items: SidebarItem[];
|
|
123
40
|
}
|
|
124
|
-
/**
|
|
125
|
-
* Union type for all possible sidebar item types.
|
|
126
|
-
*
|
|
127
|
-
* @remarks
|
|
128
|
-
* Represents any item that can appear in the Docusaurus sidebar,
|
|
129
|
-
* including documents and nested categories. This union type provides
|
|
130
|
-
* type safety when working with heterogeneous sidebar structures whilst
|
|
131
|
-
* maintaining flexibility for different navigation patterns.
|
|
132
|
-
*
|
|
133
|
-
* @public
|
|
134
|
-
*/
|
|
135
41
|
export type SidebarItem = SidebarDocItem | SidebarCategoryItem;
|
|
136
|
-
/**
|
|
137
|
-
* Docusaurus navigation bar item configuration.
|
|
138
|
-
*
|
|
139
|
-
* @remarks
|
|
140
|
-
* Defines items that appear in the top navigation bar, including
|
|
141
|
-
* dropdown menus and direct links. This interface supports both simple
|
|
142
|
-
* navigation links and complex dropdown structures with nested items
|
|
143
|
-
* for comprehensive site navigation capabilities.
|
|
144
|
-
*
|
|
145
|
-
* @public
|
|
146
|
-
*/
|
|
147
42
|
export interface NavbarItem {
|
|
148
|
-
/** Optional type specification for the navbar item. */
|
|
149
43
|
type?: string;
|
|
150
|
-
/** Display label for the navbar item. */
|
|
151
44
|
label: string;
|
|
152
|
-
/** Target URL or path for the navbar item. */
|
|
153
45
|
to: string;
|
|
154
|
-
/** Optional positioning within the navbar. */
|
|
155
46
|
position?: 'left' | 'right';
|
|
156
|
-
/** Optional array of nested items for dropdown menus. */
|
|
157
47
|
items?: NavbarItem[];
|
|
158
48
|
}
|
|
159
49
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/docusaurus/types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/docusaurus/types.ts"],"names":[],"mappings":"AAyBA,MAAM,WAAW,WAAW;IAE1B,QAAQ,EAAE,MAAM,EAAE,CAAA;IAElB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAA;CACvE;AAaD,MAAM,WAAW,mBAAmB;IAElC,EAAE,EAAE,MAAM,CAAA;IAEV,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,KAAK,EAAE,MAAM,CAAA;IAEb,IAAI,EAAE,MAAM,CAAA;IAEZ,WAAW,EAAE,MAAM,CAAA;IAEnB,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAA;CACjC;AAgBD,MAAM,WAAW,eAAe;IAE9B,IAAI,EAAE,UAAU,CAAA;IAEhB,KAAK,EAAE,MAAM,CAAA;IAEb,IAAI,EAAE;QAEJ,IAAI,EAAE,KAAK,CAAA;QAEX,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IAED,SAAS,EAAE,KAAK,CAAA;IAEhB,KAAK,EAAE,WAAW,EAAE,CAAA;CACrB;AAaD,MAAM,WAAW,cAAc;IAE7B,IAAI,EAAE,KAAK,CAAA;IAEX,KAAK,EAAE,MAAM,CAAA;IAEb,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,EAAE,EAAE,MAAM,CAAA;CACX;AAaD,MAAM,WAAW,mBAAmB;IAElC,IAAI,EAAE,UAAU,CAAA;IAEhB,KAAK,EAAE,MAAM,CAAA;IAEb,IAAI,CAAC,EAAE;QAEL,IAAI,EAAE,KAAK,CAAA;QAEX,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IAED,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,SAAS,EAAE,OAAO,CAAA;IAElB,KAAK,EAAE,WAAW,EAAE,CAAA;CACrB;AAaD,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,mBAAmB,CAAA;AAiB9D,MAAM,WAAW,UAAU;IAEzB,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,KAAK,EAAE,MAAM,CAAA;IAEb,EAAE,EAAE,MAAM,CAAA;IAEV,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAE3B,KAAK,CAAC,EAAE,UAAU,EAAE,CAAA;CACrB"}
|
package/dist/docusaurus/types.js
CHANGED
|
@@ -1,13 +1,2 @@
|
|
|
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
1
|
export {};
|
|
12
|
-
// ----------------------------------------------------------------------------
|
|
13
2
|
//# sourceMappingURL=types.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/docusaurus/types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/docusaurus/types.ts"],"names":[],"mappings":""}
|
|
@@ -1,230 +1,16 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Formats a Date object into a standardised UTC string representation.
|
|
3
|
-
*
|
|
4
|
-
* @remarks
|
|
5
|
-
* Produces a timestamp in the format "YYYY-MM-DD HH:mm:ss +0000" using
|
|
6
|
-
* UTC timezone for consistent date formatting across different environments.
|
|
7
|
-
* This format ensures reproducible timestamps regardless of the local
|
|
8
|
-
* system timezone, which is essential for documentation generation consistency.
|
|
9
|
-
*
|
|
10
|
-
* @param date - The Date object to format.
|
|
11
|
-
* @returns A formatted date string in UTC with timezone offset.
|
|
12
|
-
*
|
|
13
|
-
* @public
|
|
14
|
-
*/
|
|
15
1
|
export declare function formatDate(date: Date): string;
|
|
16
|
-
/**
|
|
17
|
-
* Formats a duration value into a human-readable string representation.
|
|
18
|
-
*
|
|
19
|
-
* @remarks
|
|
20
|
-
* Converts millisecond values into appropriate units (milliseconds, seconds,
|
|
21
|
-
* or minutes) with appropriate precision for display purposes. The function
|
|
22
|
-
* automatically selects the most suitable unit based on the magnitude of
|
|
23
|
-
* the duration value to ensure optimal readability for performance reporting.
|
|
24
|
-
*
|
|
25
|
-
* @param n - The duration in milliseconds.
|
|
26
|
-
* @returns A formatted duration string with appropriate units.
|
|
27
|
-
*
|
|
28
|
-
* @public
|
|
29
|
-
*/
|
|
30
2
|
export declare function formatDuration(n: number): string;
|
|
31
|
-
/**
|
|
32
|
-
* Removes empty lines from a text string.
|
|
33
|
-
*
|
|
34
|
-
* @remarks
|
|
35
|
-
* Eliminates lines that contain only whitespace characters, helping to
|
|
36
|
-
* clean up text content for documentation processing. This function is
|
|
37
|
-
* particularly useful for normalising content extracted from XML sources
|
|
38
|
-
* where formatting artefacts may introduce unwanted empty lines.
|
|
39
|
-
*
|
|
40
|
-
* @param text - The input text to process.
|
|
41
|
-
* @returns The text with empty lines removed.
|
|
42
|
-
*
|
|
43
|
-
* @public
|
|
44
|
-
*/
|
|
45
3
|
export declare function removeEmptyLines(text: string): string;
|
|
46
|
-
/**
|
|
47
|
-
* Sanitises text for use in hierarchical URL paths.
|
|
48
|
-
*
|
|
49
|
-
* @remarks
|
|
50
|
-
* Transforms text into a URL-safe format suitable for hierarchical paths
|
|
51
|
-
* by converting to lowercase, removing spaces, encoding special characters,
|
|
52
|
-
* and preserving forward slashes for path structure. This function ensures
|
|
53
|
-
* that generated URLs are compatible with web standards whilst maintaining
|
|
54
|
-
* the hierarchical nature of documentation structures.
|
|
55
|
-
*
|
|
56
|
-
* @param text - The input text to sanitise.
|
|
57
|
-
* @returns A URL-safe hierarchical path string.
|
|
58
|
-
*
|
|
59
|
-
* @public
|
|
60
|
-
*/
|
|
61
4
|
export declare function sanitizeHierarchicalPath(text: string): string;
|
|
62
|
-
/**
|
|
63
|
-
* Sanitises anonymous namespace identifiers for better readability.
|
|
64
|
-
*
|
|
65
|
-
* @remarks
|
|
66
|
-
* Simplifies the representation of anonymous namespaces by removing
|
|
67
|
-
* redundant text whilst preserving the essential identifying information.
|
|
68
|
-
* This transformation improves the readability of documentation by reducing
|
|
69
|
-
* verbose namespace representations commonly generated by Doxygen.
|
|
70
|
-
*
|
|
71
|
-
* @param text - The namespace identifier to sanitise.
|
|
72
|
-
* @returns A cleaner namespace identifier.
|
|
73
|
-
*
|
|
74
|
-
* @public
|
|
75
|
-
*/
|
|
76
5
|
export declare function sanitizeAnonymousNamespace(text: string): string;
|
|
77
|
-
/**
|
|
78
|
-
* Flattens a hierarchical path by replacing separators with hyphens.
|
|
79
|
-
*
|
|
80
|
-
* @remarks
|
|
81
|
-
* Converts forward slashes to hyphens to create a flat string suitable
|
|
82
|
-
* for use in contexts where hierarchical separators are not appropriate.
|
|
83
|
-
* This is particularly useful for creating file names or identifiers
|
|
84
|
-
* that must not contain path separators whilst preserving readability.
|
|
85
|
-
*
|
|
86
|
-
* @param text - The hierarchical path to flatten.
|
|
87
|
-
* @returns A flattened path string with hyphens instead of slashes.
|
|
88
|
-
*
|
|
89
|
-
* @public
|
|
90
|
-
*/
|
|
91
6
|
export declare function flattenPath(text: string): string;
|
|
92
|
-
/**
|
|
93
|
-
* Removes hexadecimal anchor suffixes from reference identifiers.
|
|
94
|
-
*
|
|
95
|
-
* @remarks
|
|
96
|
-
* Strips trailing hexadecimal anchor patterns from Doxygen reference
|
|
97
|
-
* identifiers to obtain the base reference without anchor information.
|
|
98
|
-
* This is essential for creating clean reference links whilst preserving
|
|
99
|
-
* the ability to extract anchor information separately when needed.
|
|
100
|
-
*
|
|
101
|
-
* @param refid - The reference identifier to process.
|
|
102
|
-
* @returns The reference identifier with hexadecimal anchor removed.
|
|
103
|
-
*
|
|
104
|
-
* @public
|
|
105
|
-
*/
|
|
106
7
|
export declare function stripPermalinkHexAnchor(refid: string): string;
|
|
107
|
-
/**
|
|
108
|
-
* Removes text anchor suffixes from reference identifiers.
|
|
109
|
-
*
|
|
110
|
-
* @remarks
|
|
111
|
-
* Strips trailing text-based anchor patterns from Doxygen reference
|
|
112
|
-
* identifiers to obtain the base reference without anchor information.
|
|
113
|
-
* This complements the hexadecimal anchor removal function by handling
|
|
114
|
-
* text-based anchor patterns that may appear in certain Doxygen outputs.
|
|
115
|
-
*
|
|
116
|
-
* @param refid - The reference identifier to process.
|
|
117
|
-
* @returns The reference identifier with text anchor removed.
|
|
118
|
-
*
|
|
119
|
-
* @public
|
|
120
|
-
*/
|
|
121
8
|
export declare function stripPermalinkTextAnchor(refid: string): string;
|
|
122
|
-
/**
|
|
123
|
-
* Removes leading newline characters from text.
|
|
124
|
-
*
|
|
125
|
-
* @remarks
|
|
126
|
-
* Strips newline characters from the beginning of a text string whilst
|
|
127
|
-
* preserving the remainder of the content. This function is useful for
|
|
128
|
-
* cleaning up text content that may have unwanted leading whitespace
|
|
129
|
-
* from XML parsing or template processing operations.
|
|
130
|
-
*
|
|
131
|
-
* @param text - The input text to process.
|
|
132
|
-
* @returns The text with leading newlines removed.
|
|
133
|
-
*
|
|
134
|
-
* @public
|
|
135
|
-
*/
|
|
136
9
|
export declare function stripLeadingNewLines(text: string): string;
|
|
137
|
-
/**
|
|
138
|
-
* Removes trailing whitespace and newline characters from text.
|
|
139
|
-
*
|
|
140
|
-
* @remarks
|
|
141
|
-
* Strips trailing spaces, carriage returns, and newlines from the end
|
|
142
|
-
* of a text string whilst preserving the main content. This function
|
|
143
|
-
* ensures clean text output by removing formatting artefacts that may
|
|
144
|
-
* interfere with proper Markdown rendering or display.
|
|
145
|
-
*
|
|
146
|
-
* @param text - The input text to process.
|
|
147
|
-
* @returns The text with trailing whitespace and newlines removed.
|
|
148
|
-
*
|
|
149
|
-
* @public
|
|
150
|
-
*/
|
|
151
10
|
export declare function stripTrailingNewLines(text: string): string;
|
|
152
|
-
/**
|
|
153
|
-
* Removes both leading and trailing newline characters from text.
|
|
154
|
-
*
|
|
155
|
-
* @remarks
|
|
156
|
-
* Combines the functionality of stripping both leading and trailing
|
|
157
|
-
* newlines to clean up text content for processing. This comprehensive
|
|
158
|
-
* cleaning function is particularly useful for normalising content
|
|
159
|
-
* extracted from various sources that may have inconsistent whitespace.
|
|
160
|
-
*
|
|
161
|
-
* @param text - The input text to process.
|
|
162
|
-
* @returns The text with leading and trailing newlines removed.
|
|
163
|
-
*
|
|
164
|
-
* @public
|
|
165
|
-
*/
|
|
166
11
|
export declare function stripLeadingAndTrailingNewLines(text: string): string;
|
|
167
|
-
/**
|
|
168
|
-
* Extracts the anchor portion from a reference identifier.
|
|
169
|
-
*
|
|
170
|
-
* @remarks
|
|
171
|
-
* Retrieves the anchor part of a Doxygen reference identifier by removing
|
|
172
|
-
* the base reference portion and returning only the anchor suffix. This
|
|
173
|
-
* function is essential for creating proper internal links within
|
|
174
|
-
* documentation pages where anchor-based navigation is required.
|
|
175
|
-
*
|
|
176
|
-
* @param refid - The reference identifier to process.
|
|
177
|
-
* @returns The anchor portion of the reference identifier.
|
|
178
|
-
*
|
|
179
|
-
* @public
|
|
180
|
-
*/
|
|
181
12
|
export declare function getPermalinkAnchor(refid: string): string;
|
|
182
|
-
/**
|
|
183
|
-
* Checks whether a folder exists at the specified path.
|
|
184
|
-
*
|
|
185
|
-
* @remarks
|
|
186
|
-
* Asynchronously verifies the existence of a directory at the given path
|
|
187
|
-
* and confirms that it is indeed a directory rather than a file. This
|
|
188
|
-
* function provides safe filesystem access with proper error handling
|
|
189
|
-
* for cases where the path does not exist or is inaccessible.
|
|
190
|
-
*
|
|
191
|
-
* @param folderPath - The path to check for folder existence.
|
|
192
|
-
* @returns A promise that resolves to true if the folder exists.
|
|
193
|
-
*
|
|
194
|
-
* @public
|
|
195
|
-
*/
|
|
196
13
|
export declare function folderExists(folderPath: string): Promise<boolean>;
|
|
197
|
-
/**
|
|
198
|
-
* Joins an array of strings with different delimiters for the final item.
|
|
199
|
-
*
|
|
200
|
-
* @remarks
|
|
201
|
-
* Concatenates array elements using a standard delimiter between most items
|
|
202
|
-
* and a special delimiter before the last item, useful for creating
|
|
203
|
-
* grammatically correct lists (e.g., "A, B, and C"). This function ensures
|
|
204
|
-
* proper English grammar in generated text whilst handling edge cases
|
|
205
|
-
* such as empty arrays and single-item arrays appropriately.
|
|
206
|
-
*
|
|
207
|
-
* @param arr - The array of strings to join.
|
|
208
|
-
* @param delimiter - The standard delimiter between items.
|
|
209
|
-
* @param lastDelimiter - The special delimiter before the last item.
|
|
210
|
-
* @returns The joined string with appropriate delimiters.
|
|
211
|
-
*
|
|
212
|
-
* @public
|
|
213
|
-
*/
|
|
214
14
|
export declare function joinWithLast(arr: string[], delimiter: string, lastDelimiter: string): string;
|
|
215
|
-
/**
|
|
216
|
-
* Validates whether a string represents a valid URL.
|
|
217
|
-
*
|
|
218
|
-
* @remarks
|
|
219
|
-
* Attempts to construct a URL object from the input string to determine
|
|
220
|
-
* if it represents a valid, well-formed URL. This validation method
|
|
221
|
-
* leverages the native URL constructor's built-in validation capabilities
|
|
222
|
-
* to provide robust URL checking without implementing custom parsing logic.
|
|
223
|
-
*
|
|
224
|
-
* @param str - The string to validate as a URL.
|
|
225
|
-
* @returns True if the string is a valid URL, false otherwise.
|
|
226
|
-
*
|
|
227
|
-
* @public
|
|
228
|
-
*/
|
|
229
15
|
export declare function isUrl(str: string): boolean;
|
|
230
16
|
//# sourceMappingURL=utils.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/docusaurus/utils.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/docusaurus/utils.ts"],"names":[],"mappings":"AA+BA,wBAAgB,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAc7C;AAgBD,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAQhD;AAyFD,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAErD;AAkBD,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAW7D;AAgBD,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE/D;AAgBD,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEhD;AAgBD,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7D;AAgBD,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE9D;AAgBD,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEzD;AAgBD,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE1D;AAgBD,wBAAgB,+BAA+B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEpE;AAgBD,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAExD;AAgBD,wBAAsB,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAOvE;AAmBD,wBAAgB,YAAY,CAC1B,GAAG,EAAE,MAAM,EAAE,EACb,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,GACpB,MAAM,CAIR;AAgBD,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAO1C"}
|