@xpack/doxygen2docusaurus 1.0.2 → 2.0.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/README.md +3 -4
- package/dist/cli/main.d.ts +6 -0
- package/dist/cli/main.d.ts.map +1 -1
- package/dist/cli/main.js +29 -2
- package/dist/cli/main.js.map +1 -1
- package/dist/docusaurus/cli-options.d.ts +268 -39
- package/dist/docusaurus/cli-options.d.ts.map +1 -1
- package/dist/docusaurus/cli-options.js +267 -53
- package/dist/docusaurus/cli-options.js.map +1 -1
- package/dist/docusaurus/generator.d.ts +179 -4
- package/dist/docusaurus/generator.d.ts.map +1 -1
- package/dist/docusaurus/generator.js +215 -45
- package/dist/docusaurus/generator.js.map +1 -1
- package/dist/docusaurus/renderers/descriptiontype.d.ts +417 -0
- package/dist/docusaurus/renderers/descriptiontype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/descriptiontype.js +417 -0
- package/dist/docusaurus/renderers/descriptiontype.js.map +1 -1
- package/dist/docusaurus/renderers/docinternalstype.d.ts +132 -0
- package/dist/docusaurus/renderers/docinternalstype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/docinternalstype.js +132 -0
- package/dist/docusaurus/renderers/docinternalstype.js.map +1 -1
- package/dist/docusaurus/renderers/doclisttype.d.ts +22 -0
- package/dist/docusaurus/renderers/doclisttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/doclisttype.js +22 -2
- package/dist/docusaurus/renderers/doclisttype.js.map +1 -1
- package/dist/docusaurus/renderers/doctabletype.d.ts +88 -0
- package/dist/docusaurus/renderers/doctabletype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/doctabletype.js +88 -0
- package/dist/docusaurus/renderers/doctabletype.js.map +1 -1
- package/dist/docusaurus/renderers/doctitletype.d.ts +22 -0
- package/dist/docusaurus/renderers/doctitletype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/doctitletype.js +22 -0
- package/dist/docusaurus/renderers/doctitletype.js.map +1 -1
- package/dist/docusaurus/renderers/docvariablelisttype.d.ts +44 -0
- package/dist/docusaurus/renderers/docvariablelisttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/docvariablelisttype.js +44 -0
- package/dist/docusaurus/renderers/docvariablelisttype.js.map +1 -1
- package/dist/docusaurus/renderers/docxrefsecttype.d.ts +22 -0
- package/dist/docusaurus/renderers/docxrefsecttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/docxrefsecttype.js +22 -0
- package/dist/docusaurus/renderers/docxrefsecttype.js.map +1 -1
- package/dist/docusaurus/renderers/element-renderer-base.d.ts +74 -0
- package/dist/docusaurus/renderers/element-renderer-base.d.ts.map +1 -1
- package/dist/docusaurus/renderers/element-renderer-base.js +52 -0
- package/dist/docusaurus/renderers/element-renderer-base.js.map +1 -1
- package/dist/docusaurus/renderers/inctype.d.ts +23 -0
- package/dist/docusaurus/renderers/inctype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/inctype.js +23 -0
- package/dist/docusaurus/renderers/inctype.js.map +1 -1
- package/dist/docusaurus/renderers/linkedtexttype.d.ts +22 -0
- package/dist/docusaurus/renderers/linkedtexttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/linkedtexttype.js +22 -0
- package/dist/docusaurus/renderers/linkedtexttype.js.map +1 -1
- package/dist/docusaurus/renderers/listingtype.d.ts +52 -0
- package/dist/docusaurus/renderers/listingtype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/listingtype.js +66 -2
- package/dist/docusaurus/renderers/listingtype.js.map +1 -1
- package/dist/docusaurus/renderers/paramtype.d.ts +22 -0
- package/dist/docusaurus/renderers/paramtype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/paramtype.js +22 -0
- package/dist/docusaurus/renderers/paramtype.js.map +1 -1
- package/dist/docusaurus/renderers/referencetype.d.ts +23 -0
- package/dist/docusaurus/renderers/referencetype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/referencetype.js +23 -2
- package/dist/docusaurus/renderers/referencetype.js.map +1 -1
- package/dist/docusaurus/renderers/reftexttype.d.ts +22 -0
- package/dist/docusaurus/renderers/reftexttype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/reftexttype.js +22 -0
- package/dist/docusaurus/renderers/reftexttype.js.map +1 -1
- package/dist/docusaurus/renderers/reftype.d.ts +22 -0
- package/dist/docusaurus/renderers/reftype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/reftype.js +22 -0
- package/dist/docusaurus/renderers/reftype.js.map +1 -1
- package/dist/docusaurus/renderers/renderers.d.ts +151 -0
- package/dist/docusaurus/renderers/renderers.d.ts.map +1 -1
- package/dist/docusaurus/renderers/renderers.js +151 -0
- package/dist/docusaurus/renderers/renderers.js.map +1 -1
- package/dist/docusaurus/renderers/substringtype.d.ts +22 -0
- package/dist/docusaurus/renderers/substringtype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/substringtype.js +22 -0
- package/dist/docusaurus/renderers/substringtype.js.map +1 -1
- package/dist/docusaurus/renderers/tableofcontentstype.d.ts +22 -0
- package/dist/docusaurus/renderers/tableofcontentstype.d.ts.map +1 -1
- package/dist/docusaurus/renderers/tableofcontentstype.js +22 -0
- package/dist/docusaurus/renderers/tableofcontentstype.js.map +1 -1
- package/dist/docusaurus/types.d.ts +114 -8
- package/dist/docusaurus/types.d.ts.map +1 -1
- package/dist/docusaurus/types.js.map +1 -1
- package/dist/docusaurus/utils.d.ts +214 -0
- package/dist/docusaurus/utils.d.ts.map +1 -1
- package/dist/docusaurus/utils.js +214 -0
- package/dist/docusaurus/utils.js.map +1 -1
- package/dist/docusaurus/view-model/classes-vm.d.ts +139 -2
- package/dist/docusaurus/view-model/classes-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/classes-vm.js +147 -6
- package/dist/docusaurus/view-model/classes-vm.js.map +1 -1
- package/dist/docusaurus/view-model/collection-base.d.ts +122 -2
- package/dist/docusaurus/view-model/collection-base.d.ts.map +1 -1
- package/dist/docusaurus/view-model/collection-base.js +78 -0
- package/dist/docusaurus/view-model/collection-base.js.map +1 -1
- package/dist/docusaurus/view-model/compound-base-vm.d.ts +134 -19
- package/dist/docusaurus/view-model/compound-base-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/compound-base-vm.js +122 -26
- package/dist/docusaurus/view-model/compound-base-vm.js.map +1 -1
- package/dist/docusaurus/view-model/description-anchors.d.ts +58 -0
- package/dist/docusaurus/view-model/description-anchors.d.ts.map +1 -1
- package/dist/docusaurus/view-model/description-anchors.js +58 -0
- package/dist/docusaurus/view-model/description-anchors.js.map +1 -1
- package/dist/docusaurus/view-model/files-and-folders-vm.d.ts +249 -2
- package/dist/docusaurus/view-model/files-and-folders-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/files-and-folders-vm.js +250 -4
- package/dist/docusaurus/view-model/files-and-folders-vm.js.map +1 -1
- package/dist/docusaurus/view-model/groups-vm.d.ts +150 -2
- package/dist/docusaurus/view-model/groups-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/groups-vm.js +153 -5
- package/dist/docusaurus/view-model/groups-vm.js.map +1 -1
- package/dist/docusaurus/view-model/members-vm.d.ts +552 -0
- package/dist/docusaurus/view-model/members-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/members-vm.js +552 -4
- package/dist/docusaurus/view-model/members-vm.js.map +1 -1
- package/dist/docusaurus/view-model/namespaces-vm.d.ts +201 -2
- package/dist/docusaurus/view-model/namespaces-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/namespaces-vm.js +202 -4
- package/dist/docusaurus/view-model/namespaces-vm.js.map +1 -1
- package/dist/docusaurus/view-model/options.d.ts +43 -0
- package/dist/docusaurus/view-model/options.d.ts.map +1 -1
- package/dist/docusaurus/view-model/options.js +43 -0
- package/dist/docusaurus/view-model/options.js.map +1 -1
- package/dist/docusaurus/view-model/pages-vm.d.ts +117 -2
- package/dist/docusaurus/view-model/pages-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/pages-vm.js +119 -4
- package/dist/docusaurus/view-model/pages-vm.js.map +1 -1
- package/dist/docusaurus/view-model/tree-entries-vm.d.ts +135 -15
- package/dist/docusaurus/view-model/tree-entries-vm.d.ts.map +1 -1
- package/dist/docusaurus/view-model/tree-entries-vm.js +136 -16
- package/dist/docusaurus/view-model/tree-entries-vm.js.map +1 -1
- package/dist/docusaurus/view-model/view-model.d.ts +119 -0
- package/dist/docusaurus/view-model/view-model.d.ts.map +1 -1
- package/dist/docusaurus/view-model/view-model.js +119 -0
- package/dist/docusaurus/view-model/view-model.js.map +1 -1
- package/dist/docusaurus/workspace.d.ts +106 -0
- package/dist/docusaurus/workspace.d.ts.map +1 -1
- package/dist/docusaurus/workspace.js +107 -1
- package/dist/docusaurus/workspace.js.map +1 -1
- package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts +485 -0
- package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/compounddef-dm.js +485 -0
- package/dist/doxygen/data-model/compounds/compounddef-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts +120 -0
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.js +98 -0
- package/dist/doxygen/data-model/compounds/compoundreftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts +2705 -0
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.js +2677 -47
- package/dist/doxygen/data-model/compounds/descriptiontype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts +165 -0
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js +165 -0
- package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts +70 -0
- package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/doxygentype-dm.js +70 -0
- package/dist/doxygen/data-model/compounds/doxygentype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts +78 -0
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js +78 -0
- package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/inctype-dm.d.ts +107 -0
- package/dist/doxygen/data-model/compounds/inctype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/inctype-dm.js +107 -0
- package/dist/doxygen/data-model/compounds/inctype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts +123 -0
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js +123 -0
- package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts +70 -0
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js +70 -1
- package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts +156 -0
- package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/locationtype-dm.js +156 -5
- package/dist/doxygen/data-model/compounds/locationtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts +433 -0
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.js +417 -6
- package/dist/doxygen/data-model/compounds/memberdeftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts +135 -0
- package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/memberreftype-dm.js +136 -4
- package/dist/doxygen/data-model/compounds/memberreftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/membertype-dm.d.ts +95 -0
- package/dist/doxygen/data-model/compounds/membertype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/membertype-dm.js +76 -4
- package/dist/doxygen/data-model/compounds/membertype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts +158 -0
- package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/paramtype-dm.js +158 -1
- package/dist/doxygen/data-model/compounds/paramtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts +130 -0
- package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/referencetype-dm.js +130 -2
- package/dist/doxygen/data-model/compounds/referencetype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts +120 -0
- package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/reftexttype-dm.js +106 -3
- package/dist/doxygen/data-model/compounds/reftexttype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/reftype-dm.d.ts +247 -0
- package/dist/doxygen/data-model/compounds/reftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/reftype-dm.js +247 -3
- package/dist/doxygen/data-model/compounds/reftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts +99 -0
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.js +99 -2
- package/dist/doxygen/data-model/compounds/reimplementtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts +159 -0
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js +159 -3
- package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts +255 -0
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js +255 -6
- package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js.map +1 -1
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts +60 -0
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js +60 -1
- package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js.map +1 -1
- package/dist/doxygen/data-model/data-model.d.ts +86 -2
- package/dist/doxygen/data-model/data-model.d.ts.map +1 -1
- package/dist/doxygen/data-model/data-model.js +86 -4
- package/dist/doxygen/data-model/data-model.js.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts +109 -0
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js +84 -2
- package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts +81 -0
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js +81 -3
- package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js.map +1 -1
- package/dist/doxygen/data-model/doxygen-xml-parser.d.ts +24 -7
- package/dist/doxygen/data-model/doxygen-xml-parser.d.ts.map +1 -1
- package/dist/doxygen/data-model/doxygen-xml-parser.js +24 -22
- package/dist/doxygen/data-model/doxygen-xml-parser.js.map +1 -1
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts +92 -0
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.js +79 -2
- package/dist/doxygen/data-model/index/indexcompoundtype-dm.js.map +1 -1
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts +76 -0
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.js +76 -3
- package/dist/doxygen/data-model/index/indexdoxygentype-dm.js.map +1 -1
- package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts +79 -0
- package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts.map +1 -1
- package/dist/doxygen/data-model/index/indexmembertype-dm.js +66 -2
- package/dist/doxygen/data-model/index/indexmembertype-dm.js.map +1 -1
- package/dist/doxygen/data-model/types.d.ts +96 -1
- package/dist/doxygen/data-model/types.d.ts.map +1 -1
- package/dist/doxygen/data-model/types.js +37 -0
- package/dist/doxygen/data-model/types.js.map +1 -1
- package/dist/doxygen2docusaurus.d.ts +4774 -0
- package/dist/tsdoc-metadata.json +11 -0
- package/package.json +11 -7
- /package/{template → templates}/css/custom.css +0 -0
- /package/{template → templates}/img/README.md +0 -0
- /package/{template → templates}/img/document-svgrepo-com.svg +0 -0
- /package/{template → templates}/img/folder-svgrepo-com.svg +0 -0
|
@@ -6,29 +6,148 @@ import { DescriptionAnchor, DescriptionTocItem, DescriptionTocList } from './des
|
|
|
6
6
|
import { Member } from './members-vm.js';
|
|
7
7
|
import { CliOptions } from '../cli-options.js';
|
|
8
8
|
/**
|
|
9
|
+
* View model that organises data for documentation generation.
|
|
10
|
+
*
|
|
11
|
+
* @remarks
|
|
12
|
+
* The ViewModel class transforms the raw Doxygen data model into structured
|
|
13
|
+
* collections suitable for generating Docusaurus documentation, including
|
|
14
|
+
* classes, files, namespaces, and other compound types. It coordinates the
|
|
15
|
+
* entire view model creation process, from object instantiation through
|
|
16
|
+
* hierarchy establishment to cross-reference resolution.
|
|
17
|
+
*
|
|
9
18
|
* @public
|
|
10
19
|
*/
|
|
11
20
|
export declare class ViewModel {
|
|
21
|
+
/** Configuration options controlling the view model behaviour. */
|
|
12
22
|
options: CliOptions;
|
|
23
|
+
/** Reference to the parent workspace containing the data model. */
|
|
13
24
|
workspace: Workspace;
|
|
25
|
+
/** Map of collection names to their corresponding collection objects. */
|
|
14
26
|
collections: Map<string, CollectionBase>;
|
|
27
|
+
/** Map of compound identifiers to their view model objects. */
|
|
15
28
|
compoundsById: Map<string, CompoundBase>;
|
|
29
|
+
/** Map of member identifiers to their view model objects. */
|
|
16
30
|
membersById: Map<string, Member>;
|
|
31
|
+
/** Array of description table of contents lists for navigation. */
|
|
17
32
|
descriptionTocLists: DescriptionTocList[];
|
|
33
|
+
/** Map of TOC item identifiers to their corresponding objects. */
|
|
18
34
|
descriptionTocItemsById: Map<string, DescriptionTocItem>;
|
|
35
|
+
/** Map of description anchor identifiers to their objects. */
|
|
19
36
|
descriptionAnchorsById: Map<string, DescriptionAnchor>;
|
|
37
|
+
/**
|
|
38
|
+
* Constructs a new ViewModel instance.
|
|
39
|
+
*
|
|
40
|
+
* @remarks
|
|
41
|
+
* Initialises the view model with a reference to the parent workspace
|
|
42
|
+
* and sets up the collection mapping structure. This constructor prepares
|
|
43
|
+
* the foundation for transforming raw Doxygen data into organised
|
|
44
|
+
* documentation structures suitable for Docusaurus generation.
|
|
45
|
+
*
|
|
46
|
+
* @param workspace - The parent workspace containing the data model.
|
|
47
|
+
*/
|
|
20
48
|
constructor(workspace: Workspace);
|
|
49
|
+
/**
|
|
50
|
+
* Creates and populates all view model collections and objects.
|
|
51
|
+
*
|
|
52
|
+
* @remarks
|
|
53
|
+
* Orchestrates the complete view model creation process including
|
|
54
|
+
* collection instantiation, object creation, and hierarchy establishment.
|
|
55
|
+
* This method coordinates all phases of view model construction to ensure
|
|
56
|
+
* proper dependencies and cross-references are established between
|
|
57
|
+
* documentation elements.
|
|
58
|
+
*/
|
|
21
59
|
create(): void;
|
|
60
|
+
/**
|
|
61
|
+
* Creates view model objects from the parsed Doxygen compound definitions.
|
|
62
|
+
*
|
|
63
|
+
* @remarks
|
|
64
|
+
* Iterates through all compound definitions from the data model and creates
|
|
65
|
+
* corresponding view model objects, organising them into appropriate
|
|
66
|
+
* collections and establishing identifier mappings. This method also
|
|
67
|
+
* processes detailed descriptions to extract navigation elements and
|
|
68
|
+
* cross-reference anchors for comprehensive documentation structure.
|
|
69
|
+
*/
|
|
22
70
|
createVieModelObjects(): void;
|
|
71
|
+
/**
|
|
72
|
+
* Recursively finds and processes description identifiers within elements.
|
|
73
|
+
*
|
|
74
|
+
* @remarks
|
|
75
|
+
* Traverses the element hierarchy to locate table of contents items,
|
|
76
|
+
* document sections, and anchors, creating appropriate view model
|
|
77
|
+
* structures for navigation and cross-referencing. This recursive processing
|
|
78
|
+
* ensures comprehensive extraction of all navigational elements from
|
|
79
|
+
* complex documentation structures.
|
|
80
|
+
*
|
|
81
|
+
* @param compound - The compound containing the description elements.
|
|
82
|
+
* @param element - The data model element to process recursively.
|
|
83
|
+
*/
|
|
23
84
|
findDescriptionIdsRecursively(compound: CompoundBase, element: AbstractDataModelBase): void;
|
|
85
|
+
/**
|
|
86
|
+
* Establishes hierarchical relationships between compound objects.
|
|
87
|
+
*
|
|
88
|
+
* @remarks
|
|
89
|
+
* Delegates to each collection to create parent-child relationships
|
|
90
|
+
* and other hierarchical structures within the compound objects. This
|
|
91
|
+
* phase is essential for building proper navigation trees and inheritance
|
|
92
|
+
* relationships that reflect the original code structure.
|
|
93
|
+
*/
|
|
24
94
|
createCompoundsHierarchies(): void;
|
|
95
|
+
/**
|
|
96
|
+
* Performs late initialisation of compound objects.
|
|
97
|
+
*
|
|
98
|
+
* @remarks
|
|
99
|
+
* Executes initialisation tasks that require all objects to be created
|
|
100
|
+
* first, allowing for proper cross-reference resolution and relationship
|
|
101
|
+
* establishment between compounds. This phase ensures that complex
|
|
102
|
+
* inter-compound dependencies are properly resolved after the initial
|
|
103
|
+
* object creation phase.
|
|
104
|
+
*/
|
|
25
105
|
initializeCompoundsLate(): void;
|
|
106
|
+
/**
|
|
107
|
+
* Creates a comprehensive map of all member definitions.
|
|
108
|
+
*
|
|
109
|
+
* @remarks
|
|
110
|
+
* Iterates through all compounds and their sections to build a complete
|
|
111
|
+
* mapping of member identifiers to their objects, enabling efficient
|
|
112
|
+
* member lookup and cross-referencing. This method handles member
|
|
113
|
+
* deduplication and ensures that members are properly associated with
|
|
114
|
+
* their containing compounds.
|
|
115
|
+
*/
|
|
26
116
|
createMembersMap(): void;
|
|
117
|
+
/**
|
|
118
|
+
* Performs late initialisation of member objects.
|
|
119
|
+
*
|
|
120
|
+
* @remarks
|
|
121
|
+
* Executes member initialisation tasks that depend on all objects being
|
|
122
|
+
* created, ensuring proper cross-references and relationships are
|
|
123
|
+
* established between members and their containing compounds. This phase
|
|
124
|
+
* completes the member setup process after all structural relationships
|
|
125
|
+
* have been established.
|
|
126
|
+
*/
|
|
27
127
|
initializeMemberLate(): void;
|
|
128
|
+
/**
|
|
129
|
+
* Validates and resolves permalink uniqueness across all compounds.
|
|
130
|
+
*
|
|
131
|
+
* @remarks
|
|
132
|
+
* Ensures that all generated permalinks are unique by detecting conflicts
|
|
133
|
+
* and automatically appending suffixes to duplicate permalinks, maintaining
|
|
134
|
+
* proper navigation and linking functionality. This validation process is
|
|
135
|
+
* crucial for preventing URL conflicts in the generated documentation site.
|
|
136
|
+
*/
|
|
28
137
|
/**
|
|
29
138
|
* @brief Validate the uniqueness of permalinks.
|
|
30
139
|
*/
|
|
31
140
|
validatePermalinks(): void;
|
|
141
|
+
/**
|
|
142
|
+
* Performs cleanup operations on view model objects.
|
|
143
|
+
*
|
|
144
|
+
* @remarks
|
|
145
|
+
* Removes references to the original compound definition data models
|
|
146
|
+
* to free memory and prevent potential circular references after
|
|
147
|
+
* the view model creation is complete. This cleanup phase optimises
|
|
148
|
+
* memory usage by removing unnecessary data model references that
|
|
149
|
+
* are no longer needed for documentation generation.
|
|
150
|
+
*/
|
|
32
151
|
cleanups(): void;
|
|
33
152
|
}
|
|
34
153
|
//# sourceMappingURL=view-model.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"view-model.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/view-model.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE3C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAQxC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAI9C
|
|
1
|
+
{"version":3,"file":"view-model.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/view-model.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE3C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAQxC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAI9C;;;;;;;;;;;GAWG;AACH,qBAAa,SAAS;IACpB,kEAAkE;IAClE,OAAO,EAAE,UAAU,CAAA;IAEnB,mEAAmE;IACnE,SAAS,EAAE,SAAS,CAAA;IAEpB,yEAAyE;IAGzE,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAExC,+DAA+D;IAE/D,aAAa,4BAAkC;IAE/C,6DAA6D;IAC7D,WAAW,sBAA4B;IAEvC,mEAAmE;IACnE,mBAAmB,EAAE,kBAAkB,EAAE,CAAK;IAE9C,kEAAkE;IAClE,uBAAuB,kCAAwC;IAE/D,8DAA8D;IAC9D,sBAAsB,iCAAuC;IAE7D;;;;;;;;;;OAUG;gBACS,SAAS,EAAE,SAAS;IAOhC;;;;;;;;;OASG;IACH,MAAM;IAsBN;;;;;;;;;OASG;IACH,qBAAqB,IAAI,IAAI;IAiD7B;;;;;;;;;;;;OAYG;IACH,6BAA6B,CAC3B,QAAQ,EAAE,YAAY,EACtB,OAAO,EAAE,qBAAqB,GAC7B,IAAI;IA0CP;;;;;;;;OAQG;IACH,0BAA0B,IAAI,IAAI;IAYlC;;;;;;;;;OASG;IAEH,uBAAuB,IAAI,IAAI;IAiB/B;;;;;;;;;OASG;IACH,gBAAgB,IAAI,IAAI;IA0CxB;;;;;;;;;OASG;IAEH,oBAAoB,IAAI,IAAI;IA0B5B;;;;;;;;OAQG;IACH;;OAEG;IACH,kBAAkB,IAAI,IAAI;IAwE1B;;;;;;;;;OASG;IACH,QAAQ,IAAI,IAAI;CAKjB"}
|
|
@@ -24,25 +24,63 @@ import { AbstractDocAnchorType, AbstractDocSectType, } from '../../doxygen/data-
|
|
|
24
24
|
import { stripPermalinkHexAnchor } from '../utils.js';
|
|
25
25
|
// ----------------------------------------------------------------------------
|
|
26
26
|
/**
|
|
27
|
+
* View model that organises data for documentation generation.
|
|
28
|
+
*
|
|
29
|
+
* @remarks
|
|
30
|
+
* The ViewModel class transforms the raw Doxygen data model into structured
|
|
31
|
+
* collections suitable for generating Docusaurus documentation, including
|
|
32
|
+
* classes, files, namespaces, and other compound types. It coordinates the
|
|
33
|
+
* entire view model creation process, from object instantiation through
|
|
34
|
+
* hierarchy establishment to cross-reference resolution.
|
|
35
|
+
*
|
|
27
36
|
* @public
|
|
28
37
|
*/
|
|
29
38
|
export class ViewModel {
|
|
39
|
+
/** Configuration options controlling the view model behaviour. */
|
|
30
40
|
options;
|
|
41
|
+
/** Reference to the parent workspace containing the data model. */
|
|
31
42
|
workspace;
|
|
43
|
+
/** Map of collection names to their corresponding collection objects. */
|
|
32
44
|
// The key is one of the above collection names.
|
|
33
45
|
// groups, classes, namespaces, files, pages.
|
|
34
46
|
collections;
|
|
47
|
+
/** Map of compound identifiers to their view model objects. */
|
|
35
48
|
// View model objects.
|
|
36
49
|
compoundsById = new Map();
|
|
50
|
+
/** Map of member identifiers to their view model objects. */
|
|
37
51
|
membersById = new Map();
|
|
52
|
+
/** Array of description table of contents lists for navigation. */
|
|
38
53
|
descriptionTocLists = [];
|
|
54
|
+
/** Map of TOC item identifiers to their corresponding objects. */
|
|
39
55
|
descriptionTocItemsById = new Map();
|
|
56
|
+
/** Map of description anchor identifiers to their objects. */
|
|
40
57
|
descriptionAnchorsById = new Map();
|
|
58
|
+
/**
|
|
59
|
+
* Constructs a new ViewModel instance.
|
|
60
|
+
*
|
|
61
|
+
* @remarks
|
|
62
|
+
* Initialises the view model with a reference to the parent workspace
|
|
63
|
+
* and sets up the collection mapping structure. This constructor prepares
|
|
64
|
+
* the foundation for transforming raw Doxygen data into organised
|
|
65
|
+
* documentation structures suitable for Docusaurus generation.
|
|
66
|
+
*
|
|
67
|
+
* @param workspace - The parent workspace containing the data model.
|
|
68
|
+
*/
|
|
41
69
|
constructor(workspace) {
|
|
42
70
|
this.workspace = workspace;
|
|
43
71
|
this.options = workspace.options;
|
|
44
72
|
this.collections = new Map();
|
|
45
73
|
}
|
|
74
|
+
/**
|
|
75
|
+
* Creates and populates all view model collections and objects.
|
|
76
|
+
*
|
|
77
|
+
* @remarks
|
|
78
|
+
* Orchestrates the complete view model creation process including
|
|
79
|
+
* collection instantiation, object creation, and hierarchy establishment.
|
|
80
|
+
* This method coordinates all phases of view model construction to ensure
|
|
81
|
+
* proper dependencies and cross-references are established between
|
|
82
|
+
* documentation elements.
|
|
83
|
+
*/
|
|
46
84
|
create() {
|
|
47
85
|
this.collections.set('groups', new Groups(this.workspace));
|
|
48
86
|
this.collections.set('namespaces', new Namespaces(this.workspace));
|
|
@@ -58,6 +96,16 @@ export class ViewModel {
|
|
|
58
96
|
this.cleanups();
|
|
59
97
|
}
|
|
60
98
|
// --------------------------------------------------------------------------
|
|
99
|
+
/**
|
|
100
|
+
* Creates view model objects from the parsed Doxygen compound definitions.
|
|
101
|
+
*
|
|
102
|
+
* @remarks
|
|
103
|
+
* Iterates through all compound definitions from the data model and creates
|
|
104
|
+
* corresponding view model objects, organising them into appropriate
|
|
105
|
+
* collections and establishing identifier mappings. This method also
|
|
106
|
+
* processes detailed descriptions to extract navigation elements and
|
|
107
|
+
* cross-reference anchors for comprehensive documentation structure.
|
|
108
|
+
*/
|
|
61
109
|
createVieModelObjects() {
|
|
62
110
|
console.log('Creating view model objects...');
|
|
63
111
|
for (const compoundDefDataModel of this.workspace.dataModel.compoundDefs) {
|
|
@@ -93,6 +141,19 @@ export class ViewModel {
|
|
|
93
141
|
}
|
|
94
142
|
// console.log(this.descriptionTocLists)
|
|
95
143
|
}
|
|
144
|
+
/**
|
|
145
|
+
* Recursively finds and processes description identifiers within elements.
|
|
146
|
+
*
|
|
147
|
+
* @remarks
|
|
148
|
+
* Traverses the element hierarchy to locate table of contents items,
|
|
149
|
+
* document sections, and anchors, creating appropriate view model
|
|
150
|
+
* structures for navigation and cross-referencing. This recursive processing
|
|
151
|
+
* ensures comprehensive extraction of all navigational elements from
|
|
152
|
+
* complex documentation structures.
|
|
153
|
+
*
|
|
154
|
+
* @param compound - The compound containing the description elements.
|
|
155
|
+
* @param element - The data model element to process recursively.
|
|
156
|
+
*/
|
|
96
157
|
findDescriptionIdsRecursively(compound, element) {
|
|
97
158
|
// console.log(compound.id, typeof element)
|
|
98
159
|
if (element.children === undefined) {
|
|
@@ -135,6 +196,15 @@ export class ViewModel {
|
|
|
135
196
|
}
|
|
136
197
|
}
|
|
137
198
|
// --------------------------------------------------------------------------
|
|
199
|
+
/**
|
|
200
|
+
* Establishes hierarchical relationships between compound objects.
|
|
201
|
+
*
|
|
202
|
+
* @remarks
|
|
203
|
+
* Delegates to each collection to create parent-child relationships
|
|
204
|
+
* and other hierarchical structures within the compound objects. This
|
|
205
|
+
* phase is essential for building proper navigation trees and inheritance
|
|
206
|
+
* relationships that reflect the original code structure.
|
|
207
|
+
*/
|
|
138
208
|
createCompoundsHierarchies() {
|
|
139
209
|
console.log('Creating compounds hierarchies...');
|
|
140
210
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
@@ -144,6 +214,16 @@ export class ViewModel {
|
|
|
144
214
|
}
|
|
145
215
|
}
|
|
146
216
|
// --------------------------------------------------------------------------
|
|
217
|
+
/**
|
|
218
|
+
* Performs late initialisation of compound objects.
|
|
219
|
+
*
|
|
220
|
+
* @remarks
|
|
221
|
+
* Executes initialisation tasks that require all objects to be created
|
|
222
|
+
* first, allowing for proper cross-reference resolution and relationship
|
|
223
|
+
* establishment between compounds. This phase ensures that complex
|
|
224
|
+
* inter-compound dependencies are properly resolved after the initial
|
|
225
|
+
* object creation phase.
|
|
226
|
+
*/
|
|
147
227
|
// Required since references can be resolved only after all objects are in.
|
|
148
228
|
initializeCompoundsLate() {
|
|
149
229
|
console.log('Performing compounds late initializations...');
|
|
@@ -159,6 +239,16 @@ export class ViewModel {
|
|
|
159
239
|
}
|
|
160
240
|
}
|
|
161
241
|
// --------------------------------------------------------------------------
|
|
242
|
+
/**
|
|
243
|
+
* Creates a comprehensive map of all member definitions.
|
|
244
|
+
*
|
|
245
|
+
* @remarks
|
|
246
|
+
* Iterates through all compounds and their sections to build a complete
|
|
247
|
+
* mapping of member identifiers to their objects, enabling efficient
|
|
248
|
+
* member lookup and cross-referencing. This method handles member
|
|
249
|
+
* deduplication and ensures that members are properly associated with
|
|
250
|
+
* their containing compounds.
|
|
251
|
+
*/
|
|
162
252
|
createMembersMap() {
|
|
163
253
|
console.log('Creating member definitions map...');
|
|
164
254
|
for (const [, compound] of this.compoundsById) {
|
|
@@ -195,6 +285,16 @@ export class ViewModel {
|
|
|
195
285
|
}
|
|
196
286
|
}
|
|
197
287
|
// --------------------------------------------------------------------------
|
|
288
|
+
/**
|
|
289
|
+
* Performs late initialisation of member objects.
|
|
290
|
+
*
|
|
291
|
+
* @remarks
|
|
292
|
+
* Executes member initialisation tasks that depend on all objects being
|
|
293
|
+
* created, ensuring proper cross-references and relationships are
|
|
294
|
+
* established between members and their containing compounds. This phase
|
|
295
|
+
* completes the member setup process after all structural relationships
|
|
296
|
+
* have been established.
|
|
297
|
+
*/
|
|
198
298
|
// Required since references can be resolved only after all objects are in.
|
|
199
299
|
initializeMemberLate() {
|
|
200
300
|
console.log('Performing members late initializations...');
|
|
@@ -219,6 +319,15 @@ export class ViewModel {
|
|
|
219
319
|
}
|
|
220
320
|
}
|
|
221
321
|
// --------------------------------------------------------------------------
|
|
322
|
+
/**
|
|
323
|
+
* Validates and resolves permalink uniqueness across all compounds.
|
|
324
|
+
*
|
|
325
|
+
* @remarks
|
|
326
|
+
* Ensures that all generated permalinks are unique by detecting conflicts
|
|
327
|
+
* and automatically appending suffixes to duplicate permalinks, maintaining
|
|
328
|
+
* proper navigation and linking functionality. This validation process is
|
|
329
|
+
* crucial for preventing URL conflicts in the generated documentation site.
|
|
330
|
+
*/
|
|
222
331
|
/**
|
|
223
332
|
* @brief Validate the uniqueness of permalinks.
|
|
224
333
|
*/
|
|
@@ -274,6 +383,16 @@ export class ViewModel {
|
|
|
274
383
|
}
|
|
275
384
|
}
|
|
276
385
|
// --------------------------------------------------------------------------
|
|
386
|
+
/**
|
|
387
|
+
* Performs cleanup operations on view model objects.
|
|
388
|
+
*
|
|
389
|
+
* @remarks
|
|
390
|
+
* Removes references to the original compound definition data models
|
|
391
|
+
* to free memory and prevent potential circular references after
|
|
392
|
+
* the view model creation is complete. This cleanup phase optimises
|
|
393
|
+
* memory usage by removing unnecessary data model references that
|
|
394
|
+
* are no longer needed for documentation generation.
|
|
395
|
+
*/
|
|
277
396
|
cleanups() {
|
|
278
397
|
for (const [, compound] of this.compoundsById) {
|
|
279
398
|
compound._private._compoundDef = undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"view-model.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/view-model.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAEhC,OAAO,EAAE,uBAAuB,EAAE,MAAM,sDAAsD,CAAA;AAC9F,OAAO,EACL,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,8DAA8D,CAAA;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AAEzE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAGzC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AACrC,OAAO,EACL,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,0DAA0D,CAAA;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAGrD,+EAA+E;AAE/E
|
|
1
|
+
{"version":3,"file":"view-model.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/view-model.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAEhC,OAAO,EAAE,uBAAuB,EAAE,MAAM,sDAAsD,CAAA;AAC9F,OAAO,EACL,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,8DAA8D,CAAA;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AAEzE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAGzC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AACrC,OAAO,EACL,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,0DAA0D,CAAA;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAGrD,+EAA+E;AAE/E;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,SAAS;IACpB,kEAAkE;IAClE,OAAO,CAAY;IAEnB,mEAAmE;IACnE,SAAS,CAAW;IAEpB,yEAAyE;IACzE,gDAAgD;IAChD,6CAA6C;IAC7C,WAAW,CAA6B;IAExC,+DAA+D;IAC/D,sBAAsB;IACtB,aAAa,GAAG,IAAI,GAAG,EAAwB,CAAA;IAE/C,6DAA6D;IAC7D,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAA;IAEvC,mEAAmE;IACnE,mBAAmB,GAAyB,EAAE,CAAA;IAE9C,kEAAkE;IAClE,uBAAuB,GAAG,IAAI,GAAG,EAA8B,CAAA;IAE/D,8DAA8D;IAC9D,sBAAsB,GAAG,IAAI,GAAG,EAA6B,CAAA;IAE7D;;;;;;;;;;OAUG;IACH,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO,CAAA;QAEhC,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAA;IAC9B,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM;QACJ,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QAC1D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QAClE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QAC5D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QAClE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QAExD,IAAI,CAAC,qBAAqB,EAAE,CAAA;QAC5B,IAAI,CAAC,0BAA0B,EAAE,CAAA;QAEjC,IAAI,CAAC,gBAAgB,EAAE,CAAA;QAEvB,IAAI,CAAC,uBAAuB,EAAE,CAAA;QAC9B,IAAI,CAAC,oBAAoB,EAAE,CAAA;QAE3B,IAAI,CAAC,kBAAkB,EAAE,CAAA;QAEzB,IAAI,CAAC,QAAQ,EAAE,CAAA;IACjB,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACH,qBAAqB;QACnB,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAA;QAC7C,KAAK,MAAM,oBAAoB,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;YACzE,IAAI,QAAQ,GAA6B,SAAS,CAAA;YAClD,MAAM,EAAE,IAAI,EAAE,GAAG,oBAAoB,CAAA;YAErC,MAAM,cAAc,GAClB,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;YAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;YACvD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC7B,kEAAkE;gBAClE,eAAe;gBACf,iEAAiE;gBACjE,IAAI;gBACJ,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAA;gBACpD,2CAA2C;gBAC3C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;gBAC7C,+DAA+D;YACjE,CAAC;YAED,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,IACE,oBAAoB,YAAY,uBAAuB;oBACvD,oBAAoB,CAAC,mBAAmB,KAAK,SAAS,EACtD,CAAC;oBACD,IAAI,CAAC,6BAA6B,CAChC,QAAQ,EACR,oBAAoB,CAAC,mBAAmB,CACzC,CAAA;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,iBAAiB;gBACjB,uEAAuE;gBACvE,IAAI;gBACJ,OAAO,CAAC,KAAK,CACX,sBAAsB,EACtB,oBAAoB,CAAC,IAAI,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,EACrB,uBAAuB,CACxB,CAAA;YACH,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAA;QAC9D,CAAC;QACD,wCAAwC;IAC1C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,6BAA6B,CAC3B,QAAsB,EACtB,OAA8B;QAE9B,2CAA2C;QAC3C,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,OAAM;QACR,CAAC;QAED,KAAK,MAAM,cAAc,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC9C,IAAI,cAAc,YAAY,gBAAgB,EAAE,CAAC;gBAC/C,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAAA;gBAChD,4BAA4B;gBAC5B,MAAM,CAAC,cAAc,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAA;gBAC7C,KAAK,MAAM,gBAAgB,IAAI,cAAc,CAAC,QAAQ,EAAE,CAAC;oBACvD,IAAI,gBAAgB,YAAY,gBAAgB,EAAE,CAAC;wBACjD,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;wBACpE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;wBAC9B,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;oBACvD,CAAC;gBACH,CAAC;gBACD,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACxC,CAAC;iBAAM,IAAI,cAAc,YAAY,mBAAmB,EAAE,CAAC;gBACzD,IAAI,cAAc,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;oBACpC,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,CAAC,CAAA;oBACjE,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;gBACpD,CAAC;gBACD,IAAI,CAAC,6BAA6B,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,cAAc,YAAY,qBAAqB,EAAE,CAAC;gBAC3D,8BAA8B;gBAC9B,IAAI,cAAc,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACjC,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,CAAC,CAAA;oBAClE,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;gBACtD,CAAC;YACH,CAAC;iBAAM,IAAI,cAAc,YAAY,qBAAqB,EAAE,CAAC;gBAC3D,wDAAwD;gBACxD,gCAAgC;gBAChC,IAAI;gBACJ,IAAI,CAAC,6BAA6B,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAA;YAC9D,CAAC;QACH,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;OAQG;IACH,0BAA0B;QACxB,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAA;QAEhD,6DAA6D;QAC7D,KAAK,MAAM,CAAC,cAAc,EAAE,UAAU,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5D,oDAAoD;YACpD,UAAU,CAAC,0BAA0B,EAAE,CAAA;QACzC,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACH,2EAA2E;IAC3E,uBAAuB;QACrB,OAAO,CAAC,GAAG,CAAC,8CAA8C,CAAC,CAAA;QAE3D,6DAA6D;QAC7D,KAAK,MAAM,CAAC,cAAc,EAAE,UAAU,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5D,oDAAoD;YACpD,KAAK,MAAM,CAAC,EAAE,QAAQ,CAAC,IAAI,UAAU,CAAC,uBAAuB,EAAE,CAAC;gBAC9D,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;oBACvB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAA;gBACnD,CAAC;gBACD,QAAQ,CAAC,cAAc,EAAE,CAAA;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACH,gBAAgB;QACd,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAA;QACjD,KAAK,MAAM,CAAC,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9C,iEAAiE;YACjE,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACxC,qCAAqC;gBACrC,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;oBAC1C,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;wBAC7B,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;wBAC3D,IAAI,gBAAgB,KAAK,QAAQ,CAAC,EAAE,EAAE,CAAC;4BACrC,oDAAoD;4BACpD,6CAA6C;4BAC7C,eAAe;4BACf,0DAA0D;4BAC1D,IAAI;wBACN,CAAC;6BAAM,CAAC;4BACN,oDAAoD;4BAEpD,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;gCACpC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oCACzB,OAAO,CAAC,IAAI,CACV,uBAAuB,EACvB,MAAM,CAAC,EAAE,EACT,IAAI,EACJ,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,CACtC,CAAA;gCACH,CAAC;4BACH,CAAC;iCAAM,CAAC;gCACN,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;4BACzC,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAA;QAC1D,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACH,2EAA2E;IAC3E,oBAAoB;QAClB,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAA;QACzD,KAAK,MAAM,CAAC,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9C,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACvB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAA;YAChE,CAAC;YACD,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACxC,OAAO,CAAC,cAAc,EAAE,CAAA;gBAExB,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;oBACvB,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;gBACjC,CAAC;gBACD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;oBAC1C,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;wBAC7B,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;4BACvB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,CAAA;wBAC7C,CAAC;wBACD,MAAM,CAAC,cAAc,EAAE,CAAA;oBACzB,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;OAQG;IACH;;OAEG;IACH,kBAAkB;QAChB,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;QAEvC,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAkB,CAAA;QACpD,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAAqC,CAAA;QAEzE,KAAK,MAAM,oBAAoB,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;YACzE,eAAe;YACf,iEAAiE;YACjE,IAAI;YACJ,MAAM,EAAE,EAAE,EAAE,GAAG,oBAAoB,CAAA;YACnC,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC/B,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;YAClC,CAAC;YAED,MAAM,QAAQ,GAA6B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YACrE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,OAAO,CAAC,KAAK,CACX,sBAAsB,EACtB,EAAE,EACF,sBAAsB,EACtB,IAAI,CAAC,WAAW,CAAC,IAAI,EACrB,oBAAoB,CACrB,CAAA;gBACD,SAAQ;YACV,CAAC;YAED,MAAM,SAAS,GAAG,QAAQ,CAAC,iBAAiB,CAAA;YAC5C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,uCAAuC;gBACvC,IAAI,YAAY,GAAG,oBAAoB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;gBACtD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;oBAC/B,YAAY,GAAG,IAAI,GAAG,EAAE,CAAA;oBACxB,oBAAoB,CAAC,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;gBACnD,CAAC;gBACD,kBAAkB,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,CAAA;gBACrC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;oBACnC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;gBACzC,CAAC;YACH,CAAC;QACH,CAAC;QAED,KAAK,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,IAAI,oBAAoB,EAAE,CAAC;YAC7D,IAAI,YAAY,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBAC1B,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oBACzB,OAAO,CAAC,IAAI,CACV,WAAW,EACX,SAAS,EACT,KAAK,EACL,YAAY,CAAC,IAAI,EACjB,cAAc,CACf,CAAA;gBACH,CAAC;gBACD,IAAI,KAAK,GAAG,CAAC,CAAA;gBACb,KAAK,MAAM,CAAC,EAAE,QAAQ,CAAC,IAAI,YAAY,EAAE,CAAC;oBACxC,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAA;oBACrC,KAAK,IAAI,CAAC,CAAA;oBACV,MAAM,CAAC,QAAQ,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAA;oBAChD,QAAQ,CAAC,iBAAiB,IAAI,MAAM,CAAA;oBACpC,MAAM,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS,CAAC,CAAA;oBACxC,QAAQ,CAAC,SAAS,IAAI,MAAM,CAAA;oBAE5B,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;wBACzB,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,iBAAiB,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAA;oBAC5D,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACH,QAAQ;QACN,KAAK,MAAM,CAAC,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9C,QAAQ,CAAC,QAAQ,CAAC,YAAY,GAAG,SAAS,CAAA;QAC5C,CAAC;IACH,CAAC;CACF;AAED,+EAA+E"}
|
|
@@ -7,19 +7,44 @@ import { type File } from './view-model/files-and-folders-vm.js';
|
|
|
7
7
|
import { DoxygenFileOptions } from './view-model/options.js';
|
|
8
8
|
import { type Page } from './view-model/pages-vm.js';
|
|
9
9
|
import { ViewModel } from './view-model/view-model.js';
|
|
10
|
+
/**
|
|
11
|
+
* Central workspace that coordinates the conversion process.
|
|
12
|
+
*
|
|
13
|
+
* @remarks
|
|
14
|
+
* The Workspace class serves as the primary orchestrator for transforming
|
|
15
|
+
* Doxygen XML data into Docusaurus-compatible documentation. It manages
|
|
16
|
+
* the data model, view model, rendering system, and output generation whilst
|
|
17
|
+
* providing centralised configuration and URL management for consistent
|
|
18
|
+
* documentation structure across all generated content.
|
|
19
|
+
*
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
10
22
|
export declare class Workspace extends Renderers {
|
|
23
|
+
/** Configuration options controlling the conversion process. */
|
|
11
24
|
options: CliOptions;
|
|
25
|
+
/** The parsed Doxygen data model containing all source information. */
|
|
12
26
|
dataModel: DataModel;
|
|
27
|
+
/** The view model that structures data for documentation generation. */
|
|
13
28
|
viewModel: ViewModel;
|
|
29
|
+
/** The absolute path to the doxygen2docusaurus project directory. */
|
|
14
30
|
projectPath: string;
|
|
31
|
+
/** Doxygen configuration options from the original build process. */
|
|
15
32
|
doxygenOptions: DoxygenFileOptions;
|
|
33
|
+
/** The absolute base URL for the generated documentation site. */
|
|
16
34
|
absoluteBaseUrl: string;
|
|
35
|
+
/** The page base URL for individual documentation pages. */
|
|
17
36
|
pageBaseUrl: string;
|
|
37
|
+
/** The slug base URL for Docusaurus routing. */
|
|
18
38
|
slugBaseUrl: string;
|
|
39
|
+
/** The menu base URL for navigation elements. */
|
|
19
40
|
menuBaseUrl: string;
|
|
41
|
+
/** The output folder path for generated Markdown files. */
|
|
20
42
|
outputFolderPath: string;
|
|
43
|
+
/** The sidebar base identifier for navigation structure. */
|
|
21
44
|
sidebarBaseId: string;
|
|
45
|
+
/** The main page compound, if one exists in the documentation. */
|
|
22
46
|
mainPage: Page | undefined;
|
|
47
|
+
/** Map of file paths to their corresponding File objects. */
|
|
23
48
|
filesByPath: Map<string, File>;
|
|
24
49
|
/**
|
|
25
50
|
* @brief Map to keep track of indices that have content.
|
|
@@ -41,11 +66,42 @@ export declare class Workspace extends Renderers {
|
|
|
41
66
|
* - enumvalues
|
|
42
67
|
*/
|
|
43
68
|
indicesMaps: Map<string, Set<string>>;
|
|
69
|
+
/** Counter for the total number of Markdown files written. */
|
|
44
70
|
writtenMdFilesCounter: number;
|
|
71
|
+
/** Counter for the total number of HTML redirect files written. */
|
|
45
72
|
writtenHtmlFilesCounter: number;
|
|
73
|
+
/** Mapping of Doxygen compound kinds to collection names. */
|
|
46
74
|
collectionNamesByKind: Record<string, string>;
|
|
75
|
+
/** Defines the order of entries in the sidebar and top menu dropdown. */
|
|
47
76
|
sidebarCollectionNames: string[];
|
|
77
|
+
/**
|
|
78
|
+
* Constructs a new Workspace instance.
|
|
79
|
+
*
|
|
80
|
+
* @remarks
|
|
81
|
+
* Initialises the workspace with the provided data model and sets up
|
|
82
|
+
* the necessary paths, URLs, and configuration for documentation generation.
|
|
83
|
+
* This includes configuring base URLs, output paths, sidebar identifiers,
|
|
84
|
+
* and establishing the view model for structured documentation creation.
|
|
85
|
+
*
|
|
86
|
+
* @param dataModel - The parsed Doxygen data model.
|
|
87
|
+
*/
|
|
48
88
|
constructor(dataModel: DataModel);
|
|
89
|
+
/**
|
|
90
|
+
* Writes a Markdown output file with proper front matter and formatting.
|
|
91
|
+
*
|
|
92
|
+
* @remarks
|
|
93
|
+
* Creates a complete Docusaurus-compatible Markdown file including YAML
|
|
94
|
+
* front matter, content body, and generated footer information. The method
|
|
95
|
+
* handles permalink processing, emoji prevention, and proper file structure
|
|
96
|
+
* to ensure optimal integration with Docusaurus documentation sites.
|
|
97
|
+
*
|
|
98
|
+
* @param filePath - The output file path for the Markdown file.
|
|
99
|
+
* @param bodyLines - Array of content lines for the file body.
|
|
100
|
+
* @param frontMatter - YAML front matter configuration object.
|
|
101
|
+
* @param frontMatterCodeLines - Optional additional front matter code.
|
|
102
|
+
* @param title - Optional page title if not specified in front matter.
|
|
103
|
+
* @param pagePermalink - Optional page permalink for anchor processing.
|
|
104
|
+
*/
|
|
49
105
|
writeOutputMdFile({ filePath, bodyLines, frontMatter, frontMatterCodeLines, title, pagePermalink, }: {
|
|
50
106
|
filePath: string;
|
|
51
107
|
bodyLines: string[];
|
|
@@ -54,12 +110,62 @@ export declare class Workspace extends Renderers {
|
|
|
54
110
|
title?: string;
|
|
55
111
|
pagePermalink?: string;
|
|
56
112
|
}): Promise<void>;
|
|
113
|
+
/**
|
|
114
|
+
* Marks paragraph elements to be skipped during rendering.
|
|
115
|
+
*
|
|
116
|
+
* @remarks
|
|
117
|
+
* Processes an array of elements and sets the skipPara flag on any
|
|
118
|
+
* ParaDataModel instances to prevent them from being rendered. This
|
|
119
|
+
* functionality is essential for controlling paragraph output in contexts
|
|
120
|
+
* where specific formatting requirements must be maintained.
|
|
121
|
+
*
|
|
122
|
+
* @param elements - Array of elements to process for paragraph skipping.
|
|
123
|
+
*/
|
|
57
124
|
skipElementsPara(elements: (AbstractDataModelBase | string)[] | undefined): void;
|
|
125
|
+
/**
|
|
126
|
+
* Resolves a reference identifier to its corresponding permalink URL.
|
|
127
|
+
*
|
|
128
|
+
* @remarks
|
|
129
|
+
* Determines the appropriate permalink for a given reference based on
|
|
130
|
+
* the reference type (compound, member, or xrefsect) and constructs
|
|
131
|
+
* the full URL including anchors where applicable. This method handles
|
|
132
|
+
* complex reference resolution including table of contents items and
|
|
133
|
+
* description sections for comprehensive cross-referencing capabilities.
|
|
134
|
+
*
|
|
135
|
+
* @param refid - The reference identifier to resolve.
|
|
136
|
+
* @param kindref - The kind of reference ('compound', 'member', 'xrefsect').
|
|
137
|
+
* @returns The resolved permalink URL, or undefined if not found.
|
|
138
|
+
*/
|
|
58
139
|
getPermalink({ refid, kindref, }: {
|
|
59
140
|
refid: string;
|
|
60
141
|
kindref: string;
|
|
61
142
|
}): string | undefined;
|
|
143
|
+
/**
|
|
144
|
+
* Retrieves the permalink URL for a specific page by reference identifier.
|
|
145
|
+
*
|
|
146
|
+
* @remarks
|
|
147
|
+
* Looks up a compound by its reference identifier and constructs the
|
|
148
|
+
* complete page permalink URL for linking purposes. The method includes
|
|
149
|
+
* comprehensive error handling and optional warning suppression for
|
|
150
|
+
* cases where references may not be resolvable during processing.
|
|
151
|
+
*
|
|
152
|
+
* @param refid - The reference identifier of the compound.
|
|
153
|
+
* @param noWarn - Whether to suppress warning messages for missing compounds.
|
|
154
|
+
* @returns The complete page permalink URL, or undefined if not found.
|
|
155
|
+
*/
|
|
62
156
|
getPagePermalink(refid: string, noWarn?: boolean): string | undefined;
|
|
157
|
+
/**
|
|
158
|
+
* Constructs a cross-reference permalink for documentation pages.
|
|
159
|
+
*
|
|
160
|
+
* @remarks
|
|
161
|
+
* Generates a permalink URL for cross-references by extracting the page
|
|
162
|
+
* and anchor components from the identifier and constructing the
|
|
163
|
+
* appropriate URL structure. This method specifically handles the pages
|
|
164
|
+
* collection format for cross-reference navigation within the documentation.
|
|
165
|
+
*
|
|
166
|
+
* @param id - The cross-reference identifier to process.
|
|
167
|
+
* @returns The constructed cross-reference permalink URL.
|
|
168
|
+
*/
|
|
63
169
|
getXrefPermalink(id: string): string;
|
|
64
170
|
}
|
|
65
171
|
//# sourceMappingURL=workspace.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workspace.d.ts","sourceRoot":"","sources":["../../src/docusaurus/workspace.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AACtE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,qCAAqC,CAAA;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAE7C,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,sCAAsC,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,0BAA0B,CAAA;AAMpD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AA2BtD,qBAAa,SAAU,SAAQ,SAAS;
|
|
1
|
+
{"version":3,"file":"workspace.d.ts","sourceRoot":"","sources":["../../src/docusaurus/workspace.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AACtE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,qCAAqC,CAAA;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAE7C,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,sCAAsC,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,0BAA0B,CAAA;AAMpD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AA2BtD;;;;;;;;;;;GAWG;AACH,qBAAa,SAAU,SAAQ,SAAS;IACtC,gEAAgE;IAEhE,OAAO,EAAE,UAAU,CAAA;IAEnB,uEAAuE;IAEvE,SAAS,EAAE,SAAS,CAAA;IAEpB,wEAAwE;IACxE,SAAS,EAAE,SAAS,CAAA;IAEpB,qEAAqE;IAErE,WAAW,EAAE,MAAM,CAAA;IAEnB,qEAAqE;IAErE,cAAc,EAAE,kBAAkB,CAAA;IAElC,kEAAkE;IAElE,eAAe,EAAE,MAAM,CAAA;IAEvB,4DAA4D;IAE5D,WAAW,EAAE,MAAM,CAAA;IAEnB,gDAAgD;IAEhD,WAAW,EAAE,MAAM,CAAA;IAEnB,iDAAiD;IAEjD,WAAW,EAAE,MAAM,CAAA;IAEnB,2DAA2D;IAE3D,gBAAgB,EAAE,MAAM,CAAA;IAExB,4DAA4D;IAE5D,aAAa,EAAE,MAAM,CAAA;IAErB,kEAAkE;IAClE,QAAQ,EAAE,IAAI,GAAG,SAAS,CAAA;IAE1B,6DAA6D;IAC7D,WAAW,oBAA0B;IAErC;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,2BAAiC;IAE5C,8DAA8D;IAC9D,qBAAqB,SAAI;IAEzB,mEAAmE;IACnE,uBAAuB,SAAI;IAE3B,6DAA6D;IAC7D,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAmB5C;IAED,yEAAyE;IAEzE,sBAAsB,EAAE,MAAM,EAAE,CAM/B;IAID;;;;;;;;;;OAUG;gBACS,SAAS,EAAE,SAAS;IAoDhC;;;;;;;;;;;;;;;OAeG;IACG,iBAAiB,CAAC,EACtB,QAAQ,EACR,SAAS,EACT,WAAW,EACX,oBAAoB,EACpB,KAAK,EACL,aAAa,GACd,EAAE;QACD,QAAQ,EAAE,MAAM,CAAA;QAChB,SAAS,EAAE,MAAM,EAAE,CAAA;QACnB,WAAW,EAAE,WAAW,CAAA;QACxB,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAA;QAC/B,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgGjB;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,QAAQ,EAAE,CAAC,qBAAqB,GAAG,MAAM,CAAC,EAAE,GAAG,SAAS,GACvD,IAAI;IAcP;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EACX,KAAK,EACL,OAAO,GACR,EAAE;QACD,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,EAAE,MAAM,CAAA;KAChB,GAAG,MAAM,GAAG,SAAS;IAkGtB;;;;;;;;;;;;OAYG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,UAAQ,GAAG,MAAM,GAAG,SAAS;IAqBnE;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;CAcrC"}
|