@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
|
@@ -1,86 +1,581 @@
|
|
|
1
1
|
import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
|
|
2
2
|
import { AbstractDataModelBase } from '../types.js';
|
|
3
3
|
import { VariableListDataModel } from './docvarlistentrytype-dm.js';
|
|
4
|
+
/**
|
|
5
|
+
* Abstract base class for XML elements that contain simple string content.
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* Whilst it might appear unusual to encapsulate string values within object
|
|
9
|
+
* properties, this approach maintains consistency with format-specific
|
|
10
|
+
* elements (such as XXXonly types) and provides a unified interface for
|
|
11
|
+
* XML content processing throughout the Doxygen data model hierarchy.
|
|
12
|
+
*
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
4
15
|
export declare abstract class AbstractStringType extends AbstractDataModelBase {
|
|
16
|
+
/**
|
|
17
|
+
* The textual content extracted from the XML element.
|
|
18
|
+
*
|
|
19
|
+
* @remarks
|
|
20
|
+
* This property stores the inner text content of XML elements that follow
|
|
21
|
+
* the simple string pattern, providing a standardised mechanism for
|
|
22
|
+
* accessing textual data within the Doxygen XML structure.
|
|
23
|
+
*/
|
|
5
24
|
text: string;
|
|
25
|
+
/**
|
|
26
|
+
* Constructs an AbstractStringType instance from XML element data.
|
|
27
|
+
*
|
|
28
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
29
|
+
* @param element - The XML element object containing the string data
|
|
30
|
+
* @param elementName - The name of the XML element being processed
|
|
31
|
+
*
|
|
32
|
+
* @remarks
|
|
33
|
+
* This constructor validates that the provided element contains inner text
|
|
34
|
+
* content and extracts it into the text property. The implementation
|
|
35
|
+
* ensures that no attributes are present on simple string elements,
|
|
36
|
+
* maintaining the expected XML schema constraints.
|
|
37
|
+
*/
|
|
6
38
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
7
39
|
}
|
|
8
40
|
/**
|
|
41
|
+
* Abstract base class for Doxygen description elements containing mixed
|
|
42
|
+
* content.
|
|
43
|
+
*
|
|
44
|
+
* @remarks
|
|
45
|
+
* Implements the XML Schema definition for descriptionType elements, which
|
|
46
|
+
* support mixed content (character data between child elements). This class
|
|
47
|
+
* handles the complex structure of documentation descriptions including
|
|
48
|
+
* titles, paragraphs, internal sections, and hierarchical section elements.
|
|
49
|
+
*
|
|
50
|
+
* The implementation processes the sequence of optional title elements
|
|
51
|
+
* followed by various documentation components such as paragraphs, internal
|
|
52
|
+
* documentation, and nested section structures up to level 1.
|
|
53
|
+
*
|
|
9
54
|
* @public
|
|
10
55
|
*/
|
|
11
56
|
export declare abstract class AbstractDescriptionType extends AbstractDataModelBase {
|
|
57
|
+
/**
|
|
58
|
+
* Optional title element for the description.
|
|
59
|
+
*
|
|
60
|
+
* @remarks
|
|
61
|
+
* Contains the title text for the description section when present.
|
|
62
|
+
* According to the XML schema, only one title element is permitted
|
|
63
|
+
* per description, hence the assertion that ensures uniqueness during
|
|
64
|
+
* parsing.
|
|
65
|
+
*/
|
|
12
66
|
title?: string | undefined;
|
|
67
|
+
/**
|
|
68
|
+
* Constructs an AbstractDescriptionType instance from XML element data.
|
|
69
|
+
*
|
|
70
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
71
|
+
* @param element - The XML element object containing the description data
|
|
72
|
+
* @param elementName - The name of the XML element being processed
|
|
73
|
+
*
|
|
74
|
+
* @remarks
|
|
75
|
+
* This constructor processes mixed content descriptions by iterating through
|
|
76
|
+
* all inner elements and handling text nodes, title elements, paragraphs,
|
|
77
|
+
* internal sections, and level-1 sections. The parser maintains the
|
|
78
|
+
* original order of elements in the children array whilst extracting
|
|
79
|
+
* the title into a separate property for convenient access.
|
|
80
|
+
*/
|
|
13
81
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
14
82
|
}
|
|
15
83
|
/**
|
|
84
|
+
* Abstract base class providing properties for listing-type XML elements.
|
|
85
|
+
*
|
|
86
|
+
* @remarks
|
|
87
|
+
* Defines the common structure for elements that contain code listings
|
|
88
|
+
* with optional filename attributes. This base class establishes the
|
|
89
|
+
* foundation for both full listing implementations and filtered subsets
|
|
90
|
+
* of code lines.
|
|
91
|
+
*
|
|
16
92
|
* @public
|
|
17
93
|
*/
|
|
18
94
|
export declare abstract class AbstractListingTypeBase extends AbstractDataModelBase {
|
|
95
|
+
/**
|
|
96
|
+
* Array of code line elements within the listing.
|
|
97
|
+
*
|
|
98
|
+
* @remarks
|
|
99
|
+
* Contains the individual code lines that comprise the listing content.
|
|
100
|
+
* Each code line may include syntax highlighting information, line
|
|
101
|
+
* numbers, and cross-reference data depending on the source
|
|
102
|
+
* documentation configuration.
|
|
103
|
+
*/
|
|
19
104
|
codelines?: CodeLineDataModel[] | undefined;
|
|
105
|
+
/**
|
|
106
|
+
* Optional filename attribute for the listing source.
|
|
107
|
+
*
|
|
108
|
+
* @remarks
|
|
109
|
+
* Specifies the original filename of the source code when the listing
|
|
110
|
+
* represents content from a specific file. This attribute assists in
|
|
111
|
+
* providing context and navigation capabilities within the generated
|
|
112
|
+
* documentation.
|
|
113
|
+
*/
|
|
20
114
|
filename?: string | undefined;
|
|
21
115
|
}
|
|
22
116
|
/**
|
|
117
|
+
* Abstract base class for processing listing-type XML elements with parsing
|
|
118
|
+
* logic.
|
|
119
|
+
*
|
|
120
|
+
* @remarks
|
|
121
|
+
* Extends the base listing properties with comprehensive XML parsing
|
|
122
|
+
* capabilities. This class handles the extraction of code lines and
|
|
123
|
+
* filename attributes from Doxygen XML structures, providing the
|
|
124
|
+
* foundation for program listings and similar code-containing elements.
|
|
125
|
+
*
|
|
126
|
+
* The parser processes codeline elements whilst ignoring textual content
|
|
127
|
+
* that may appear between structured elements, maintaining compatibility
|
|
128
|
+
* with the mixed-content nature of XML listings.
|
|
129
|
+
*
|
|
23
130
|
* @public
|
|
24
131
|
*/
|
|
25
132
|
export declare abstract class AbstractListingType extends AbstractListingTypeBase {
|
|
133
|
+
/**
|
|
134
|
+
* Constructs an AbstractListingType instance from XML element data.
|
|
135
|
+
*
|
|
136
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
137
|
+
* @param element - The XML element object containing the listing data
|
|
138
|
+
* @param elementName - The name of the XML element being processed
|
|
139
|
+
*
|
|
140
|
+
* @remarks
|
|
141
|
+
* This constructor processes listing elements by extracting codeline
|
|
142
|
+
* children and filename attributes. Text content between elements is
|
|
143
|
+
* deliberately ignored to accommodate the mixed-content model of XML
|
|
144
|
+
* listings, focusing on the structured code line elements that contain
|
|
145
|
+
* the meaningful programming content.
|
|
146
|
+
*/
|
|
26
147
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
27
148
|
}
|
|
28
149
|
/**
|
|
150
|
+
* Data model for programlisting XML elements containing source code.
|
|
151
|
+
*
|
|
152
|
+
* @remarks
|
|
153
|
+
* Represents program listings that contain source code with optional
|
|
154
|
+
* syntax highlighting and line numbering. This implementation processes
|
|
155
|
+
* Doxygen's programlisting elements, which are commonly used to display
|
|
156
|
+
* code examples, function implementations, and other programming content
|
|
157
|
+
* within documentation.
|
|
158
|
+
*
|
|
29
159
|
* @public
|
|
30
160
|
*/
|
|
31
161
|
export declare class ProgramListingDataModel extends AbstractListingType {
|
|
162
|
+
/**
|
|
163
|
+
* Constructs a ProgramListingDataModel from XML element data.
|
|
164
|
+
*
|
|
165
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
166
|
+
* @param element - The XML element object containing the programlisting data
|
|
167
|
+
*
|
|
168
|
+
* @remarks
|
|
169
|
+
* This constructor delegates to the parent AbstractListingType to handle
|
|
170
|
+
* the standard listing processing whilst specifically identifying the
|
|
171
|
+
* element as a 'programlisting' type for proper XML schema compliance.
|
|
172
|
+
*/
|
|
32
173
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
33
174
|
}
|
|
175
|
+
/**
|
|
176
|
+
* Filtered data model for member-specific program listing content.
|
|
177
|
+
*
|
|
178
|
+
* @remarks
|
|
179
|
+
* Creates a subset of a program listing containing only the code lines
|
|
180
|
+
* that fall within a specified line number range. This class is particularly
|
|
181
|
+
* useful for displaying member function implementations or specific code
|
|
182
|
+
* sections within larger source files, enabling focused documentation
|
|
183
|
+
* that highlights relevant portions of the codebase.
|
|
184
|
+
*
|
|
185
|
+
* The filtering process preserves all code line attributes including
|
|
186
|
+
* syntax highlighting, cross-references, and line numbering whilst
|
|
187
|
+
* restricting the content to the specified range.
|
|
188
|
+
*
|
|
189
|
+
* @public
|
|
190
|
+
*/
|
|
34
191
|
export declare class MemberProgramListingDataModel extends AbstractListingTypeBase {
|
|
192
|
+
/**
|
|
193
|
+
* Constructs a filtered program listing for member-specific content.
|
|
194
|
+
*
|
|
195
|
+
* @param programListing - The source program listing to filter
|
|
196
|
+
* @param startLine - The first line number to include (inclusive)
|
|
197
|
+
* @param endLine - The last line number to include (inclusive)
|
|
198
|
+
*
|
|
199
|
+
* @remarks
|
|
200
|
+
* This constructor creates a new listing containing only the code lines
|
|
201
|
+
* that fall within the specified line number range. The filtering process
|
|
202
|
+
* examines each code line's line number attribute and includes only those
|
|
203
|
+
* lines where the number falls between startLine and endLine (inclusive).
|
|
204
|
+
*
|
|
205
|
+
* If no lines fall within the specified range, the codelines property
|
|
206
|
+
* remains undefined, indicating an empty filtered result.
|
|
207
|
+
*/
|
|
35
208
|
constructor(programListing: ProgramListingDataModel, startLine: number, endLine: number);
|
|
36
209
|
}
|
|
37
210
|
/**
|
|
211
|
+
* Abstract base class for code line elements with syntax highlighting support.
|
|
212
|
+
*
|
|
213
|
+
* @remarks
|
|
214
|
+
* Implements the XML Schema definition for codelineType elements, which
|
|
215
|
+
* represent individual lines of source code within program listings. Each
|
|
216
|
+
* code line may contain syntax highlighting information, line numbers,
|
|
217
|
+
* cross-references to documentation elements, and external link indicators.
|
|
218
|
+
*
|
|
219
|
+
* All attributes are optional according to the schema, allowing for flexible
|
|
220
|
+
* representation of code content ranging from simple text lines to fully
|
|
221
|
+
* annotated source code with comprehensive metadata.
|
|
222
|
+
*
|
|
38
223
|
* @public
|
|
39
224
|
*/
|
|
40
225
|
export declare abstract class AbstractCodeLineType extends AbstractDataModelBase {
|
|
226
|
+
/**
|
|
227
|
+
* Array of syntax highlighting elements within the code line.
|
|
228
|
+
*
|
|
229
|
+
* @remarks
|
|
230
|
+
* Contains highlight elements that provide syntax colouring information
|
|
231
|
+
* for different parts of the code line. Each highlight element specifies
|
|
232
|
+
* a highlight class (such as keyword, comment, or string literal) and
|
|
233
|
+
* the corresponding text content to be styled.
|
|
234
|
+
*/
|
|
41
235
|
highlights?: HighlightDataModel[] | undefined;
|
|
236
|
+
/**
|
|
237
|
+
* Optional line number for the code line.
|
|
238
|
+
*
|
|
239
|
+
* @remarks
|
|
240
|
+
* Specifies the line number of this code line within the source file.
|
|
241
|
+
* This attribute enables line-based navigation and referencing within
|
|
242
|
+
* the documentation system.
|
|
243
|
+
*/
|
|
42
244
|
lineno?: number | undefined;
|
|
245
|
+
/**
|
|
246
|
+
* Optional reference identifier for cross-linking.
|
|
247
|
+
*
|
|
248
|
+
* @remarks
|
|
249
|
+
* Contains a reference ID that can be used to create hyperlinks to
|
|
250
|
+
* related documentation elements such as function definitions, variable
|
|
251
|
+
* declarations, or other documented entities.
|
|
252
|
+
*/
|
|
43
253
|
refid?: string | undefined;
|
|
254
|
+
/**
|
|
255
|
+
* Optional reference kind classification.
|
|
256
|
+
*
|
|
257
|
+
* @remarks
|
|
258
|
+
* Specifies the type of reference represented by the refid attribute,
|
|
259
|
+
* such as compound, member, or other Doxygen reference kinds. This
|
|
260
|
+
* classification assists in determining the appropriate link target
|
|
261
|
+
* and display behaviour.
|
|
262
|
+
*/
|
|
44
263
|
refkind?: string | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* Optional flag indicating external reference status.
|
|
266
|
+
*
|
|
267
|
+
* @remarks
|
|
268
|
+
* When true, indicates that the reference points to an external
|
|
269
|
+
* documentation source rather than an element within the current
|
|
270
|
+
* documentation set. This flag influences link generation and
|
|
271
|
+
* navigation behaviour.
|
|
272
|
+
*/
|
|
45
273
|
external?: boolean | undefined;
|
|
274
|
+
/**
|
|
275
|
+
* Constructs an AbstractCodeLineType instance from XML element data.
|
|
276
|
+
*
|
|
277
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
278
|
+
* @param element - The XML element object containing the code line data
|
|
279
|
+
* @param elementName - The name of the XML element being processed
|
|
280
|
+
*
|
|
281
|
+
* @remarks
|
|
282
|
+
* This constructor processes code line elements by extracting highlight
|
|
283
|
+
* children and optional attributes including line numbers, reference IDs,
|
|
284
|
+
* reference kinds, and external flags. The parser handles empty code
|
|
285
|
+
* lines gracefully whilst ignoring textual content that may appear
|
|
286
|
+
* between structured highlight elements.
|
|
287
|
+
*/
|
|
46
288
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
47
289
|
}
|
|
48
290
|
/**
|
|
291
|
+
* Data model for individual code line elements within program listings.
|
|
292
|
+
*
|
|
293
|
+
* @remarks
|
|
294
|
+
* Represents a single line of source code with optional syntax highlighting,
|
|
295
|
+
* line numbering, and cross-reference information. This implementation
|
|
296
|
+
* processes Doxygen's codeline elements, which form the fundamental
|
|
297
|
+
* building blocks of program listings and code examples within the
|
|
298
|
+
* documentation.
|
|
299
|
+
*
|
|
49
300
|
* @public
|
|
50
301
|
*/
|
|
51
302
|
export declare class CodeLineDataModel extends AbstractCodeLineType {
|
|
303
|
+
/**
|
|
304
|
+
* Constructs a CodeLineDataModel from XML element data.
|
|
305
|
+
*
|
|
306
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
307
|
+
* @param element - The XML element object containing the codeline data
|
|
308
|
+
*
|
|
309
|
+
* @remarks
|
|
310
|
+
* This constructor delegates to the parent AbstractCodeLineType to handle
|
|
311
|
+
* the standard code line processing whilst specifically identifying the
|
|
312
|
+
* element as a 'codeline' type for proper XML schema compliance.
|
|
313
|
+
*/
|
|
52
314
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
53
315
|
}
|
|
316
|
+
/**
|
|
317
|
+
* Type definition for Doxygen highlight classification values.
|
|
318
|
+
*
|
|
319
|
+
* @remarks
|
|
320
|
+
* Defines the enumerated values used to classify syntax highlighting
|
|
321
|
+
* within source code listings. These classifications correspond to
|
|
322
|
+
* different programming language constructs and enable appropriate
|
|
323
|
+
* styling and colour coding in the generated documentation.
|
|
324
|
+
*
|
|
325
|
+
* The enumeration includes standard programming constructs such as
|
|
326
|
+
* comments, keywords, and literals, as well as specialised VHDL
|
|
327
|
+
* highlighting categories for hardware description language support.
|
|
328
|
+
*
|
|
329
|
+
* @public
|
|
330
|
+
*/
|
|
54
331
|
export type DoxHighlightClass = 'comment' | 'normal' | 'preprocessor' | 'keyword' | 'keywordtype' | 'keywordflow' | 'stringliteral' | 'xmlcdata' | 'charliteral' | 'vhdlkeyword' | 'vhdllogic' | 'vhdlchar' | 'vhdldigit';
|
|
55
332
|
/**
|
|
333
|
+
* Abstract base class for syntax highlighting elements within code listings.
|
|
334
|
+
*
|
|
335
|
+
* @remarks
|
|
336
|
+
* Implements the XML Schema definition for highlightType elements, which
|
|
337
|
+
* provide syntax highlighting information for portions of source code.
|
|
338
|
+
* Each highlight element contains a mandatory class attribute that specifies
|
|
339
|
+
* the type of syntax element (keyword, comment, etc.) and may contain
|
|
340
|
+
* mixed content including text, spacing elements, and cross-references.
|
|
341
|
+
*
|
|
342
|
+
* The implementation supports the full range of Doxygen highlight classes
|
|
343
|
+
* including standard programming language constructs and specialised
|
|
344
|
+
* VHDL categories for hardware description language documentation.
|
|
345
|
+
*
|
|
56
346
|
* @public
|
|
57
347
|
*/
|
|
58
348
|
export declare abstract class AbstractHighlightType extends AbstractDataModelBase {
|
|
349
|
+
/**
|
|
350
|
+
* Mandatory highlight classification attribute.
|
|
351
|
+
*
|
|
352
|
+
* @remarks
|
|
353
|
+
* Specifies the syntax highlighting class for this element, determining
|
|
354
|
+
* how the contained text should be styled in the generated documentation.
|
|
355
|
+
* The value must be one of the predefined DoxHighlightClass enumeration
|
|
356
|
+
* values such as 'keyword', 'comment', or 'stringliteral'.
|
|
357
|
+
*/
|
|
59
358
|
classs: string;
|
|
359
|
+
/**
|
|
360
|
+
* Constructs an AbstractHighlightType instance from XML element data.
|
|
361
|
+
*
|
|
362
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
363
|
+
* @param element - The XML element object containing the highlight data
|
|
364
|
+
* @param elementName - The name of the XML element being processed
|
|
365
|
+
*
|
|
366
|
+
* @remarks
|
|
367
|
+
* This constructor processes highlight elements by extracting the mandatory
|
|
368
|
+
* class attribute and any mixed content including text nodes, spacing
|
|
369
|
+
* elements, and cross-reference elements. The parser maintains the original
|
|
370
|
+
* order of content elements in the children array to preserve the intended
|
|
371
|
+
* layout and formatting of the highlighted code segment.
|
|
372
|
+
*/
|
|
60
373
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
61
374
|
}
|
|
62
375
|
/**
|
|
376
|
+
* Data model for syntax highlight elements within code listings.
|
|
377
|
+
*
|
|
378
|
+
* @remarks
|
|
379
|
+
* Represents individual syntax highlighting segments that specify how
|
|
380
|
+
* portions of source code should be styled in the generated documentation.
|
|
381
|
+
* This implementation processes Doxygen's highlight elements, which contain
|
|
382
|
+
* the highlight class information and associated text content for proper
|
|
383
|
+
* syntax colouring.
|
|
384
|
+
*
|
|
63
385
|
* @public
|
|
64
386
|
*/
|
|
65
387
|
export declare class HighlightDataModel extends AbstractHighlightType {
|
|
388
|
+
/**
|
|
389
|
+
* Constructs a HighlightDataModel from XML element data.
|
|
390
|
+
*
|
|
391
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
392
|
+
* @param element - The XML element object containing the highlight data
|
|
393
|
+
*
|
|
394
|
+
* @remarks
|
|
395
|
+
* This constructor delegates to the parent AbstractHighlightType to handle
|
|
396
|
+
* the standard highlight processing whilst specifically identifying the
|
|
397
|
+
* element as a 'highlight' type for proper XML schema compliance.
|
|
398
|
+
*/
|
|
66
399
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
67
400
|
}
|
|
401
|
+
/**
|
|
402
|
+
* Abstract base class for spacing elements within highlighted code.
|
|
403
|
+
*
|
|
404
|
+
* @remarks
|
|
405
|
+
* Implements the XML Schema definition for spType elements, which represent
|
|
406
|
+
* spacing or whitespace within syntax-highlighted code listings. These
|
|
407
|
+
* elements support mixed content and may include an optional numeric value
|
|
408
|
+
* attribute to specify the amount or type of spacing.
|
|
409
|
+
*
|
|
410
|
+
* Spacing elements are commonly used within highlight elements to preserve
|
|
411
|
+
* proper formatting and indentation of source code whilst maintaining
|
|
412
|
+
* the structured nature of the XML representation.
|
|
413
|
+
*
|
|
414
|
+
* @public
|
|
415
|
+
*/
|
|
68
416
|
export declare abstract class AbstractSpType extends AbstractDataModelBase {
|
|
417
|
+
/**
|
|
418
|
+
* The textual content of the spacing element.
|
|
419
|
+
*
|
|
420
|
+
* @remarks
|
|
421
|
+
* Contains any text content associated with the spacing element. For
|
|
422
|
+
* simple whitespace elements, this typically contains space characters,
|
|
423
|
+
* tabs, or other whitespace sequences that preserve the original
|
|
424
|
+
* formatting of the source code.
|
|
425
|
+
*/
|
|
69
426
|
text: string;
|
|
427
|
+
/**
|
|
428
|
+
* Optional numeric value attribute for spacing specifications.
|
|
429
|
+
*
|
|
430
|
+
* @remarks
|
|
431
|
+
* Specifies a numeric value that may indicate the amount of spacing,
|
|
432
|
+
* tab stops, or other formatting-related measurements. The interpretation
|
|
433
|
+
* of this value depends on the context and the specific spacing
|
|
434
|
+
* requirements of the documentation generator.
|
|
435
|
+
*/
|
|
70
436
|
value?: number | undefined;
|
|
437
|
+
/**
|
|
438
|
+
* Constructs an AbstractSpType instance from XML element data.
|
|
439
|
+
*
|
|
440
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
441
|
+
* @param element - The XML element object containing the spacing data
|
|
442
|
+
* @param elementName - The name of the XML element being processed
|
|
443
|
+
*
|
|
444
|
+
* @remarks
|
|
445
|
+
* This constructor processes spacing elements by validating that they
|
|
446
|
+
* contain no inner elements (only text content) and extracting any
|
|
447
|
+
* optional value attribute. The implementation ensures proper handling
|
|
448
|
+
* of whitespace preservation within syntax-highlighted code sections.
|
|
449
|
+
*/
|
|
71
450
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
72
451
|
}
|
|
452
|
+
/**
|
|
453
|
+
* Data model for spacing elements within syntax-highlighted code.
|
|
454
|
+
*
|
|
455
|
+
* @remarks
|
|
456
|
+
* Represents individual spacing elements that preserve whitespace and
|
|
457
|
+
* formatting within highlighted code segments. This implementation
|
|
458
|
+
* processes Doxygen's sp elements, which maintain proper indentation
|
|
459
|
+
* and spacing in source code listings whilst supporting the structured
|
|
460
|
+
* XML representation of the documentation.
|
|
461
|
+
*
|
|
462
|
+
* @public
|
|
463
|
+
*/
|
|
73
464
|
export declare class SpDataModel extends AbstractSpType {
|
|
465
|
+
/**
|
|
466
|
+
* Constructs a SpDataModel from XML element data.
|
|
467
|
+
*
|
|
468
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
469
|
+
* @param element - The XML element object containing the spacing data
|
|
470
|
+
*
|
|
471
|
+
* @remarks
|
|
472
|
+
* This constructor delegates to the parent AbstractSpType to handle
|
|
473
|
+
* the standard spacing processing whilst specifically identifying the
|
|
474
|
+
* element as an 'sp' type for proper XML schema compliance.
|
|
475
|
+
*/
|
|
74
476
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
75
477
|
}
|
|
478
|
+
/**
|
|
479
|
+
* Abstract base class for hierarchical documentation section elements.
|
|
480
|
+
*
|
|
481
|
+
* @remarks
|
|
482
|
+
* Provides the common structure for documentation sections at various
|
|
483
|
+
* levels of the hierarchy. All section types share the ability to have
|
|
484
|
+
* an optional title and an optional ID attribute for cross-referencing
|
|
485
|
+
* and navigation purposes.
|
|
486
|
+
*
|
|
487
|
+
* This base class establishes the foundation for the nested section
|
|
488
|
+
* structure that allows for well-organised documentation with proper
|
|
489
|
+
* hierarchical relationships between content elements.
|
|
490
|
+
*
|
|
491
|
+
* @public
|
|
492
|
+
*/
|
|
76
493
|
export declare abstract class AbstractDocSectType extends AbstractDataModelBase {
|
|
494
|
+
/**
|
|
495
|
+
* Optional title element for the section.
|
|
496
|
+
*
|
|
497
|
+
* @remarks
|
|
498
|
+
* Contains the title data model for the section when present. Section
|
|
499
|
+
* titles provide descriptive headers that help organise and navigate
|
|
500
|
+
* the documentation content within the hierarchical structure.
|
|
501
|
+
*/
|
|
77
502
|
title?: TitleDataModel | undefined;
|
|
503
|
+
/**
|
|
504
|
+
* Optional identifier attribute for cross-referencing.
|
|
505
|
+
*
|
|
506
|
+
* @remarks
|
|
507
|
+
* Specifies a unique identifier for the section that can be used for
|
|
508
|
+
* cross-references, hyperlinks, and navigation within the documentation.
|
|
509
|
+
* This ID enables direct linking to specific sections from other parts
|
|
510
|
+
* of the documentation or external sources.
|
|
511
|
+
*/
|
|
78
512
|
id: string | undefined;
|
|
79
513
|
}
|
|
514
|
+
/**
|
|
515
|
+
* Abstract base class for first-level documentation section elements.
|
|
516
|
+
*
|
|
517
|
+
* @remarks
|
|
518
|
+
* Implements the XML Schema definition for docSect1Type elements, which
|
|
519
|
+
* represent the first level of hierarchical sections within documentation
|
|
520
|
+
* descriptions. These sections support mixed content and may contain
|
|
521
|
+
* titles, paragraphs, internal documentation sections, and nested
|
|
522
|
+
* second-level sections.
|
|
523
|
+
*
|
|
524
|
+
* First-level sections form the primary organisational structure for
|
|
525
|
+
* complex documentation content, enabling authors to create well-structured
|
|
526
|
+
* and navigable documentation with clear hierarchical relationships.
|
|
527
|
+
*
|
|
528
|
+
* @public
|
|
529
|
+
*/
|
|
80
530
|
export declare abstract class AbstractDocSect1Type extends AbstractDocSectType {
|
|
531
|
+
/**
|
|
532
|
+
* Constructs an AbstractDocSect1Type instance from XML element data.
|
|
533
|
+
*
|
|
534
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
535
|
+
* @param element - The XML element object containing the section data
|
|
536
|
+
* @param elementName - The name of the XML element being processed
|
|
537
|
+
*
|
|
538
|
+
* @remarks
|
|
539
|
+
* This constructor processes first-level section elements by extracting
|
|
540
|
+
* title elements, paragraphs, internal sections, and nested second-level
|
|
541
|
+
* sections. The parser maintains the original order of content elements
|
|
542
|
+
* whilst extracting titles and ID attributes for convenient access and
|
|
543
|
+
* cross-referencing capabilities.
|
|
544
|
+
*/
|
|
81
545
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
82
546
|
}
|
|
547
|
+
/**
|
|
548
|
+
* Abstract base class for second-level documentation section elements.
|
|
549
|
+
*
|
|
550
|
+
* @remarks
|
|
551
|
+
* Implements the XML Schema definition for docSect2Type elements, which
|
|
552
|
+
* represent the second level of hierarchical sections within documentation
|
|
553
|
+
* descriptions. These sections support mixed content and may contain
|
|
554
|
+
* titles, paragraphs, internal documentation sections, and nested
|
|
555
|
+
* third-level sections.
|
|
556
|
+
*
|
|
557
|
+
* Second-level sections provide additional organisational depth for
|
|
558
|
+
* complex documentation structures, enabling detailed content organisation
|
|
559
|
+
* within first-level sections whilst maintaining clear hierarchical
|
|
560
|
+
* relationships.
|
|
561
|
+
*
|
|
562
|
+
* @public
|
|
563
|
+
*/
|
|
83
564
|
export declare abstract class AbstractDocSect2Type extends AbstractDocSectType {
|
|
565
|
+
/**
|
|
566
|
+
* Constructs an AbstractDocSect2Type instance from XML element data.
|
|
567
|
+
*
|
|
568
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
569
|
+
* @param element - The XML element object containing the section data
|
|
570
|
+
* @param elementName - The name of the XML element being processed
|
|
571
|
+
*
|
|
572
|
+
* @remarks
|
|
573
|
+
* This constructor processes second-level section elements by extracting
|
|
574
|
+
* title elements, paragraphs, internal sections, and nested third-level
|
|
575
|
+
* sections. The implementation maintains content ordering whilst providing
|
|
576
|
+
* structured access to section metadata and hierarchical content
|
|
577
|
+
* organisation.
|
|
578
|
+
*/
|
|
84
579
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
85
580
|
}
|
|
86
581
|
export declare abstract class AbstractDocSect3Type extends AbstractDocSectType {
|
|
@@ -95,7 +590,38 @@ export declare abstract class AbstractDocSect5Type extends AbstractDocSectType {
|
|
|
95
590
|
export declare abstract class AbstractDocSect6Type extends AbstractDocSectType {
|
|
96
591
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
97
592
|
}
|
|
593
|
+
/**
|
|
594
|
+
* Abstract base class for internal documentation section elements.
|
|
595
|
+
*
|
|
596
|
+
* @remarks
|
|
597
|
+
* Implements the XML Schema definition for docInternalType elements, which
|
|
598
|
+
* represent internal documentation sections containing mixed content. These
|
|
599
|
+
* sections typically contain implementation details, internal notes, or
|
|
600
|
+
* other content that may be conditionally included in the documentation
|
|
601
|
+
* output based on configuration settings.
|
|
602
|
+
*
|
|
603
|
+
* Internal sections support paragraphs and first-level sections, providing
|
|
604
|
+
* flexible content organisation for detailed technical information that
|
|
605
|
+
* may be intended for specific audiences or documentation contexts.
|
|
606
|
+
*
|
|
607
|
+
* @public
|
|
608
|
+
*/
|
|
98
609
|
export declare abstract class AbstractDocInternalType extends AbstractDataModelBase {
|
|
610
|
+
/**
|
|
611
|
+
* Constructs an AbstractDocInternalType instance from XML element data.
|
|
612
|
+
*
|
|
613
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
614
|
+
* @param element - The XML element object containing the internal section
|
|
615
|
+
* data
|
|
616
|
+
* @param elementName - The name of the XML element being processed
|
|
617
|
+
*
|
|
618
|
+
* @remarks
|
|
619
|
+
* This constructor processes internal documentation sections by extracting
|
|
620
|
+
* paragraphs and first-level sections whilst maintaining the mixed content
|
|
621
|
+
* structure. The implementation handles text nodes and structured elements
|
|
622
|
+
* in their original order to preserve the intended layout and flow of
|
|
623
|
+
* internal documentation content.
|
|
624
|
+
*/
|
|
99
625
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
100
626
|
}
|
|
101
627
|
export declare abstract class AbstractDocInternalS1Type extends AbstractDataModelBase {
|
|
@@ -116,20 +642,207 @@ export declare abstract class AbstractDocInternalS5Type extends AbstractDataMode
|
|
|
116
642
|
export declare abstract class AbstractDocInternalS6Type extends AbstractDataModelBase {
|
|
117
643
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
118
644
|
}
|
|
645
|
+
/**
|
|
646
|
+
* Union type for document title command group elements.
|
|
647
|
+
*
|
|
648
|
+
* @remarks
|
|
649
|
+
* Defines the various types of inline markup elements that can appear
|
|
650
|
+
* within document titles according to the Doxygen XML schema. This union
|
|
651
|
+
* encompasses formatting elements (bold, underline, emphasis), interactive
|
|
652
|
+
* elements (links, anchors, references), structural elements (line breaks),
|
|
653
|
+
* and special character markup elements.
|
|
654
|
+
*
|
|
655
|
+
* The type provides type safety for title parsing operations whilst
|
|
656
|
+
* supporting the full range of inline content that can appear within
|
|
657
|
+
* documentation titles, ensuring proper handling of complex formatted
|
|
658
|
+
* headings and cross-references.
|
|
659
|
+
*
|
|
660
|
+
* @public
|
|
661
|
+
*/
|
|
119
662
|
export type DocTitleCmdGroup = BoldDataModel | UnderlineDataModel | EmphasisDataModel | ComputerOutputDataModel | RefDataModel | LineBreakDataModel | UlinkDataModel | AnchorDataModel | SubstringDocMarkupType;
|
|
663
|
+
/**
|
|
664
|
+
* Parser function for processing document title command group elements.
|
|
665
|
+
*
|
|
666
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
667
|
+
* @param element - The XML element object containing the title command data
|
|
668
|
+
* @param elementName - The name of the XML element being processed
|
|
669
|
+
* @returns Array of parsed DocTitleCmdGroup elements
|
|
670
|
+
*
|
|
671
|
+
* @remarks
|
|
672
|
+
* This function processes XML elements that contain title command groups,
|
|
673
|
+
* parsing various markup elements such as bold text, emphasis, links,
|
|
674
|
+
* anchors, and special character entities. The parser recognises the
|
|
675
|
+
* different element types and creates appropriate data model instances
|
|
676
|
+
* for each command group element.
|
|
677
|
+
*
|
|
678
|
+
* The function handles the complex variety of inline markup elements
|
|
679
|
+
* that can appear within documentation titles, ensuring proper
|
|
680
|
+
* representation of formatting and cross-reference information.
|
|
681
|
+
*
|
|
682
|
+
* @public
|
|
683
|
+
*/
|
|
120
684
|
export declare function parseDocTitleCmdGroup(xml: DoxygenXmlParser, element: object, elementName: string): DocTitleCmdGroup[];
|
|
685
|
+
/**
|
|
686
|
+
* Base class for document title elements containing mixed content.
|
|
687
|
+
*
|
|
688
|
+
* @remarks
|
|
689
|
+
* Implements the XML Schema definition for docTitleType elements, which
|
|
690
|
+
* represent document titles containing mixed content including text and
|
|
691
|
+
* various title command group elements. These titles support rich formatting
|
|
692
|
+
* and interactive elements whilst maintaining proper structure for
|
|
693
|
+
* documentation headings and section titles.
|
|
694
|
+
*
|
|
695
|
+
* The implementation processes both textual content and structured markup
|
|
696
|
+
* elements, preserving their original order to maintain the intended
|
|
697
|
+
* formatting and presentation of title content within the documentation
|
|
698
|
+
* hierarchy.
|
|
699
|
+
*
|
|
700
|
+
* @public
|
|
701
|
+
*/
|
|
121
702
|
export declare class AbstractDocTitleType extends AbstractDataModelBase {
|
|
703
|
+
/**
|
|
704
|
+
* Constructs an AbstractDocTitleType instance from XML element data.
|
|
705
|
+
*
|
|
706
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
707
|
+
* @param element - The XML element object containing the title data
|
|
708
|
+
* @param elementName - The name of the XML element being processed
|
|
709
|
+
*
|
|
710
|
+
* @remarks
|
|
711
|
+
* This constructor processes title elements by extracting both textual
|
|
712
|
+
* content and title command group elements. The parser maintains the
|
|
713
|
+
* original order of content elements whilst delegating structured element
|
|
714
|
+
* processing to the parseDocTitleCmdGroup function for comprehensive
|
|
715
|
+
* title markup support.
|
|
716
|
+
*/
|
|
122
717
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
123
718
|
}
|
|
719
|
+
/**
|
|
720
|
+
* Union type for document command group elements.
|
|
721
|
+
*
|
|
722
|
+
* @remarks
|
|
723
|
+
* Defines the comprehensive set of command elements that can appear within
|
|
724
|
+
* document content according to the Doxygen XML schema. This union encompasses
|
|
725
|
+
* formatting elements (bold, underline, emphasis), structural elements
|
|
726
|
+
* (lists, tables, sections), interactive elements (links, references),
|
|
727
|
+
* specialized documentation elements (parameter lists, cross-references),
|
|
728
|
+
* and special character markup.
|
|
729
|
+
*
|
|
730
|
+
* The type supports the full richness of Doxygen documentation markup,
|
|
731
|
+
* enabling complex document structures with proper type safety for
|
|
732
|
+
* content parsing and generation operations. This includes support for
|
|
733
|
+
* code listings, mathematical formulae, images, and cross-references.
|
|
734
|
+
*
|
|
735
|
+
* @public
|
|
736
|
+
*/
|
|
124
737
|
export type DocCmdGroup = BoldDataModel | SimpleSectDataModel | UnderlineDataModel | EmphasisDataModel | ParameterListDataModel | ComputerOutputDataModel | RefDataModel | ItemizedListDataModel | LineBreakDataModel | UlinkDataModel | AnchorDataModel | XrefSectDataModel | VariableListDataModel | SubstringDocMarkupType | DocTableDataModel;
|
|
738
|
+
/**
|
|
739
|
+
* Abstract base class for document paragraph elements containing mixed content.
|
|
740
|
+
*
|
|
741
|
+
* @remarks
|
|
742
|
+
* Implements the XML Schema definition for docParaType elements, which
|
|
743
|
+
* represent paragraphs within documentation containing mixed content including
|
|
744
|
+
* text and various document command group elements. These paragraphs form
|
|
745
|
+
* the fundamental content blocks within documentation structures, supporting
|
|
746
|
+
* rich formatting, cross-references, and embedded elements.
|
|
747
|
+
*
|
|
748
|
+
* The implementation processes both textual content and structured markup
|
|
749
|
+
* elements using the document command group parser, maintaining the original
|
|
750
|
+
* order of content elements to preserve the intended layout and presentation
|
|
751
|
+
* of paragraph content.
|
|
752
|
+
*
|
|
753
|
+
* @public
|
|
754
|
+
*/
|
|
125
755
|
export declare abstract class AbstractDocParaType extends AbstractDataModelBase {
|
|
756
|
+
/**
|
|
757
|
+
* Constructs an AbstractDocParaType instance from XML element data.
|
|
758
|
+
*
|
|
759
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
760
|
+
* @param element - The XML element object containing the paragraph data
|
|
761
|
+
* @param elementName - The name of the XML element being processed
|
|
762
|
+
*
|
|
763
|
+
* @remarks
|
|
764
|
+
* This constructor processes paragraph elements by extracting both textual
|
|
765
|
+
* content and structured command group elements. The parser delegates
|
|
766
|
+
* structured element processing to the parseDocCmdGroup function to handle
|
|
767
|
+
* the full range of document markup elements whilst maintaining the
|
|
768
|
+
* original content order for proper paragraph presentation.
|
|
769
|
+
*/
|
|
126
770
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
127
771
|
}
|
|
772
|
+
/**
|
|
773
|
+
* Base class for document markup elements containing mixed content.
|
|
774
|
+
*
|
|
775
|
+
* @remarks
|
|
776
|
+
* Implements the XML Schema definition for docMarkupType elements, which
|
|
777
|
+
* represent markup containers that support mixed content including text
|
|
778
|
+
* and various document command group elements. These markup elements form
|
|
779
|
+
* the foundation for formatted content within documentation such as bold
|
|
780
|
+
* text, emphasis, and other inline formatting constructs.
|
|
781
|
+
*
|
|
782
|
+
* The implementation processes both textual content and structured markup
|
|
783
|
+
* elements, maintaining their original order to preserve the intended
|
|
784
|
+
* formatting and presentation of the documentation content.
|
|
785
|
+
*
|
|
786
|
+
* @public
|
|
787
|
+
*/
|
|
128
788
|
export declare class AbstractDocMarkupType extends AbstractDataModelBase {
|
|
789
|
+
/**
|
|
790
|
+
* Constructs an AbstractDocMarkupType instance from XML element data.
|
|
791
|
+
*
|
|
792
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
793
|
+
* @param element - The XML element object containing the markup data
|
|
794
|
+
* @param elementName - The name of the XML element being processed
|
|
795
|
+
*
|
|
796
|
+
* @remarks
|
|
797
|
+
* This constructor processes markup elements by extracting both textual
|
|
798
|
+
* content and structured command group elements. The parser maintains
|
|
799
|
+
* the original order of content elements whilst delegating structured
|
|
800
|
+
* element processing to the parseDocCmdGroup function for comprehensive
|
|
801
|
+
* markup support.
|
|
802
|
+
*/
|
|
129
803
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
130
804
|
}
|
|
805
|
+
/**
|
|
806
|
+
* Specialised markup type for substring-based special character elements.
|
|
807
|
+
*
|
|
808
|
+
* @remarks
|
|
809
|
+
* Extends the base markup functionality to include a substring property
|
|
810
|
+
* that stores the actual character or character sequence represented by
|
|
811
|
+
* the markup element. This class is particularly useful for handling
|
|
812
|
+
* special character entities and symbols that need both structural
|
|
813
|
+
* representation and their corresponding textual output.
|
|
814
|
+
*
|
|
815
|
+
* The substring property enables proper rendering of special characters
|
|
816
|
+
* whilst maintaining the XML structure and metadata associated with
|
|
817
|
+
* the markup element.
|
|
818
|
+
*
|
|
819
|
+
* @public
|
|
820
|
+
*/
|
|
131
821
|
export declare class SubstringDocMarkupType extends AbstractDocMarkupType {
|
|
822
|
+
/**
|
|
823
|
+
* The character or character sequence represented by this markup element.
|
|
824
|
+
*
|
|
825
|
+
* @remarks
|
|
826
|
+
* Contains the actual textual representation of the special character
|
|
827
|
+
* or symbol that this markup element represents. This property enables
|
|
828
|
+
* proper text generation whilst preserving the structured markup
|
|
829
|
+
* information for documentation processing.
|
|
830
|
+
*/
|
|
132
831
|
substring: string;
|
|
832
|
+
/**
|
|
833
|
+
* Constructs a SubstringDocMarkupType with associated character data.
|
|
834
|
+
*
|
|
835
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
836
|
+
* @param element - The XML element object containing the markup data
|
|
837
|
+
* @param elementName - The name of the XML element being processed
|
|
838
|
+
* @param substring - The character sequence this markup represents
|
|
839
|
+
*
|
|
840
|
+
* @remarks
|
|
841
|
+
* This constructor extends the base markup processing to associate
|
|
842
|
+
* specific character data with the markup element. This enables
|
|
843
|
+
* special character entities to maintain both their XML structure
|
|
844
|
+
* and their intended textual output for proper document generation.
|
|
845
|
+
*/
|
|
133
846
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string, substring: string);
|
|
134
847
|
}
|
|
135
848
|
export declare class CopyDocMarkupDataModel extends SubstringDocMarkupType {
|
|
@@ -879,99 +1592,824 @@ export declare class LsquoDocMarkupDataModel extends SubstringDocMarkupType {
|
|
|
879
1592
|
export declare class RsquoDocMarkupDataModel extends SubstringDocMarkupType {
|
|
880
1593
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
881
1594
|
}
|
|
1595
|
+
/**
|
|
1596
|
+
* Abstract base class for URL link elements within documentation content.
|
|
1597
|
+
*
|
|
1598
|
+
* @remarks
|
|
1599
|
+
* Represents hyperlink elements that reference external URLs or web resources
|
|
1600
|
+
* within documentation descriptions. This implementation processes Doxygen's
|
|
1601
|
+
* URL link elements, which support mixed content including text and formatting
|
|
1602
|
+
* commands within the link text, providing comprehensive support for rich
|
|
1603
|
+
* hyperlink content.
|
|
1604
|
+
*
|
|
1605
|
+
* URL links contain a mandatory URL attribute and support child elements
|
|
1606
|
+
* for formatted link text, enabling complex link presentations with styling
|
|
1607
|
+
* and embedded markup whilst maintaining proper link functionality.
|
|
1608
|
+
*
|
|
1609
|
+
* @public
|
|
1610
|
+
*/
|
|
882
1611
|
export declare class AbstractDocURLLink extends AbstractDataModelBase {
|
|
1612
|
+
/**
|
|
1613
|
+
* Target URL for the hyperlink.
|
|
1614
|
+
*
|
|
1615
|
+
* @remarks
|
|
1616
|
+
* Contains the destination URL that the hyperlink should navigate to.
|
|
1617
|
+
* This can be an absolute URL to external resources or a relative URL
|
|
1618
|
+
* for internal navigation within the documentation structure.
|
|
1619
|
+
*/
|
|
883
1620
|
url: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* Constructs an AbstractDocURLLink instance from XML element data.
|
|
1623
|
+
*
|
|
1624
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
1625
|
+
* @param element - The XML element object containing the URL link data
|
|
1626
|
+
* @param elementName - The name of the XML element being processed
|
|
1627
|
+
*
|
|
1628
|
+
* @remarks
|
|
1629
|
+
* This constructor processes URL link elements by extracting the mandatory
|
|
1630
|
+
* URL attribute and processing any mixed content including text and
|
|
1631
|
+
* formatting commands within the link. The implementation ensures that
|
|
1632
|
+
* a valid URL is present and organises child elements for proper link
|
|
1633
|
+
* text rendering.
|
|
1634
|
+
*
|
|
1635
|
+
* The URL attribute is validated to ensure proper link functionality
|
|
1636
|
+
* within the generated documentation output.
|
|
1637
|
+
*/
|
|
884
1638
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
885
1639
|
}
|
|
1640
|
+
/**
|
|
1641
|
+
* Data model for URL link elements within documentation content.
|
|
1642
|
+
*
|
|
1643
|
+
* @remarks
|
|
1644
|
+
* Represents hyperlink elements that reference external URLs or web resources
|
|
1645
|
+
* within documentation descriptions. This implementation processes Doxygen's
|
|
1646
|
+
* ulink elements, providing support for external linking with formatted
|
|
1647
|
+
* link text and proper URL handling.
|
|
1648
|
+
*
|
|
1649
|
+
* URL links enable documentation to reference external resources, websites,
|
|
1650
|
+
* specifications, and related materials whilst maintaining proper hyperlink
|
|
1651
|
+
* functionality within the generated documentation output.
|
|
1652
|
+
*
|
|
1653
|
+
* @public
|
|
1654
|
+
*/
|
|
886
1655
|
export declare class UlinkDataModel extends AbstractDocURLLink {
|
|
1656
|
+
/**
|
|
1657
|
+
* Constructs a UlinkDataModel from XML element data.
|
|
1658
|
+
*
|
|
1659
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
1660
|
+
* @param element - The XML element object containing the URL link data
|
|
1661
|
+
*
|
|
1662
|
+
* @remarks
|
|
1663
|
+
* This constructor delegates to the parent AbstractDocURLLink whilst
|
|
1664
|
+
* identifying the element as 'ulink' for proper URL link processing
|
|
1665
|
+
* and hyperlink functionality within documentation generation workflows.
|
|
1666
|
+
*/
|
|
887
1667
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
888
1668
|
}
|
|
1669
|
+
/**
|
|
1670
|
+
* Abstract base class for anchor elements within documentation content.
|
|
1671
|
+
*
|
|
1672
|
+
* @remarks
|
|
1673
|
+
* Represents anchor elements that provide navigation targets within
|
|
1674
|
+
* documentation descriptions. This implementation processes Doxygen's
|
|
1675
|
+
* anchor elements, which create bookmarks or jump targets that can be
|
|
1676
|
+
* referenced by cross-references and hyperlinks within the documentation.
|
|
1677
|
+
*
|
|
1678
|
+
* Anchor elements contain a mandatory ID attribute that serves as the
|
|
1679
|
+
* target identifier for navigation purposes. Whilst the schema allows
|
|
1680
|
+
* mixed content, anchor elements are typically empty in practice and
|
|
1681
|
+
* serve purely as navigation markers.
|
|
1682
|
+
*
|
|
1683
|
+
* @public
|
|
1684
|
+
*/
|
|
889
1685
|
export declare class AbstractDocAnchorType extends AbstractDataModelBase {
|
|
1686
|
+
/**
|
|
1687
|
+
* Unique identifier for the anchor target.
|
|
1688
|
+
*
|
|
1689
|
+
* @remarks
|
|
1690
|
+
* Contains the unique identifier that serves as the navigation target
|
|
1691
|
+
* for cross-references and hyperlinks. This ID is used to generate
|
|
1692
|
+
* HTML anchor elements and enable deep linking within documentation.
|
|
1693
|
+
*/
|
|
890
1694
|
id: string;
|
|
1695
|
+
/**
|
|
1696
|
+
* Constructs an AbstractDocAnchorType instance from XML element data.
|
|
1697
|
+
*
|
|
1698
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
1699
|
+
* @param element - The XML element object containing the anchor data
|
|
1700
|
+
* @param elementName - The name of the XML element being processed
|
|
1701
|
+
*
|
|
1702
|
+
* @remarks
|
|
1703
|
+
* This constructor processes anchor elements by extracting the mandatory
|
|
1704
|
+
* ID attribute whilst handling any unexpected content. Anchor elements
|
|
1705
|
+
* are typically empty but the implementation provides error reporting
|
|
1706
|
+
* for unexpected text content to ensure proper anchor functionality.
|
|
1707
|
+
*
|
|
1708
|
+
* The ID attribute is validated to ensure proper anchor target creation
|
|
1709
|
+
* within the generated documentation output.
|
|
1710
|
+
*/
|
|
891
1711
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
892
1712
|
}
|
|
1713
|
+
/**
|
|
1714
|
+
* Data model for anchor elements within documentation content.
|
|
1715
|
+
*
|
|
1716
|
+
* @remarks
|
|
1717
|
+
* Represents anchor elements that provide navigation targets within
|
|
1718
|
+
* documentation descriptions. This implementation processes Doxygen's
|
|
1719
|
+
* anchor elements, creating bookmarks or jump targets for cross-references
|
|
1720
|
+
* and deep linking functionality within the documentation structure.
|
|
1721
|
+
*
|
|
1722
|
+
* Anchor elements enable precise navigation within documentation pages,
|
|
1723
|
+
* allowing users to link directly to specific content sections and
|
|
1724
|
+
* providing enhanced usability for complex documentation structures.
|
|
1725
|
+
*
|
|
1726
|
+
* @public
|
|
1727
|
+
*/
|
|
893
1728
|
export declare class AnchorDataModel extends AbstractDocAnchorType {
|
|
1729
|
+
/**
|
|
1730
|
+
* Constructs an AnchorDataModel from XML element data.
|
|
1731
|
+
*
|
|
1732
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
1733
|
+
* @param element - The XML element object containing the anchor data
|
|
1734
|
+
*
|
|
1735
|
+
* @remarks
|
|
1736
|
+
* This constructor delegates to the parent AbstractDocAnchorType whilst
|
|
1737
|
+
* identifying the element as 'anchor' for proper navigation target
|
|
1738
|
+
* creation and cross-reference functionality within documentation
|
|
1739
|
+
* generation workflows.
|
|
1740
|
+
*/
|
|
894
1741
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
895
1742
|
}
|
|
1743
|
+
/**
|
|
1744
|
+
* Abstract base class for mathematical formula elements within documentation.
|
|
1745
|
+
*
|
|
1746
|
+
* @remarks
|
|
1747
|
+
* Represents mathematical formula elements that contain LaTeX expressions
|
|
1748
|
+
* or mathematical notation within documentation descriptions. This
|
|
1749
|
+
* implementation processes Doxygen's formula elements, which typically
|
|
1750
|
+
* contain LaTeX code for mathematical expressions and equations.
|
|
1751
|
+
*
|
|
1752
|
+
* Formula elements include both an ID attribute for cross-referencing
|
|
1753
|
+
* and text content containing the mathematical expression. The text
|
|
1754
|
+
* content is usually LaTeX code that can be processed by mathematical
|
|
1755
|
+
* rendering systems in the documentation output.
|
|
1756
|
+
*
|
|
1757
|
+
* @public
|
|
1758
|
+
*/
|
|
896
1759
|
export declare abstract class AbstractDocFormulaType extends AbstractDataModelBase {
|
|
1760
|
+
/**
|
|
1761
|
+
* Mathematical expression or formula content.
|
|
1762
|
+
*
|
|
1763
|
+
* @remarks
|
|
1764
|
+
* Contains the mathematical expression, typically in LaTeX format,
|
|
1765
|
+
* that represents the formula. This text is processed by mathematical
|
|
1766
|
+
* rendering systems to display properly formatted equations and
|
|
1767
|
+
* expressions within the documentation output.
|
|
1768
|
+
*/
|
|
897
1769
|
text: string;
|
|
1770
|
+
/**
|
|
1771
|
+
* Unique identifier for the formula element.
|
|
1772
|
+
*
|
|
1773
|
+
* @remarks
|
|
1774
|
+
* Contains the unique identifier for the formula that can be used for
|
|
1775
|
+
* cross-referencing and linking within the documentation. This enables
|
|
1776
|
+
* references to specific mathematical expressions from other parts of
|
|
1777
|
+
* the documentation.
|
|
1778
|
+
*/
|
|
898
1779
|
id: string;
|
|
1780
|
+
/**
|
|
1781
|
+
* Constructs an AbstractDocFormulaType instance from XML element data.
|
|
1782
|
+
*
|
|
1783
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
1784
|
+
* @param element - The XML element object containing the formula data
|
|
1785
|
+
* @param elementName - The name of the XML element being processed
|
|
1786
|
+
*
|
|
1787
|
+
* @remarks
|
|
1788
|
+
* This constructor processes formula elements by extracting the text
|
|
1789
|
+
* content containing the mathematical expression and the mandatory ID
|
|
1790
|
+
* attribute for cross-referencing. The implementation validates that
|
|
1791
|
+
* both the formula text and ID are present to ensure proper mathematical
|
|
1792
|
+
* content representation.
|
|
1793
|
+
*
|
|
1794
|
+
* The formula text is typically LaTeX code that requires appropriate
|
|
1795
|
+
* rendering support in the documentation output system.
|
|
1796
|
+
*/
|
|
899
1797
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
900
1798
|
}
|
|
1799
|
+
/**
|
|
1800
|
+
* Data model for mathematical formula elements within documentation content.
|
|
1801
|
+
*
|
|
1802
|
+
* @remarks
|
|
1803
|
+
* Represents mathematical formula elements that contain LaTeX expressions
|
|
1804
|
+
* or mathematical notation within documentation descriptions. This
|
|
1805
|
+
* implementation processes Doxygen's formula elements, providing support
|
|
1806
|
+
* for mathematical content including equations, expressions, and notation
|
|
1807
|
+
* that enhance technical documentation.
|
|
1808
|
+
*
|
|
1809
|
+
* Formula elements enable the inclusion of properly formatted mathematical
|
|
1810
|
+
* content within documentation, supporting complex technical documentation
|
|
1811
|
+
* requirements for mathematical and scientific applications.
|
|
1812
|
+
*
|
|
1813
|
+
* @public
|
|
1814
|
+
*/
|
|
901
1815
|
export declare class FormulaDataModel extends AbstractDocFormulaType {
|
|
1816
|
+
/**
|
|
1817
|
+
* Constructs a FormulaDataModel from XML element data.
|
|
1818
|
+
*
|
|
1819
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
1820
|
+
* @param element - The XML element object containing the formula data
|
|
1821
|
+
*
|
|
1822
|
+
* @remarks
|
|
1823
|
+
* This constructor delegates to the parent AbstractDocFormulaType whilst
|
|
1824
|
+
* identifying the element as 'formula' for proper mathematical content
|
|
1825
|
+
* processing and rendering within documentation generation workflows.
|
|
1826
|
+
*/
|
|
902
1827
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
903
1828
|
}
|
|
1829
|
+
/**
|
|
1830
|
+
* Abstract base class for index entry elements within documentation.
|
|
1831
|
+
*
|
|
1832
|
+
* @remarks
|
|
1833
|
+
* Represents index entry elements that define entries for documentation
|
|
1834
|
+
* indices and keyword lists. This implementation processes Doxygen's
|
|
1835
|
+
* index entry elements, which consist of primary and secondary index
|
|
1836
|
+
* terms that enable comprehensive documentation indexing and search
|
|
1837
|
+
* functionality.
|
|
1838
|
+
*
|
|
1839
|
+
* Index entries support hierarchical indexing with primary and secondary
|
|
1840
|
+
* terms, allowing for detailed organisation of documentation content
|
|
1841
|
+
* according to topics, concepts, and keywords for enhanced discoverability.
|
|
1842
|
+
*
|
|
1843
|
+
* @public
|
|
1844
|
+
*/
|
|
904
1845
|
export declare abstract class AbstractDocIndexEntryType extends AbstractDataModelBase {
|
|
1846
|
+
/**
|
|
1847
|
+
* Primary index term or keyword.
|
|
1848
|
+
*
|
|
1849
|
+
* @remarks
|
|
1850
|
+
* Contains the main index term that serves as the primary classification
|
|
1851
|
+
* for the index entry. This term appears as the top-level entry in
|
|
1852
|
+
* generated indices and search systems, providing the primary access
|
|
1853
|
+
* point for content discovery.
|
|
1854
|
+
*/
|
|
905
1855
|
primaryie: string;
|
|
1856
|
+
/**
|
|
1857
|
+
* Secondary index term or sub-keyword.
|
|
1858
|
+
*
|
|
1859
|
+
* @remarks
|
|
1860
|
+
* Contains the secondary index term that provides additional classification
|
|
1861
|
+
* beneath the primary term. This enables hierarchical index organisation
|
|
1862
|
+
* where related concepts can be grouped under broader categories for
|
|
1863
|
+
* more precise content classification.
|
|
1864
|
+
*/
|
|
906
1865
|
secondaryie: string;
|
|
1866
|
+
/**
|
|
1867
|
+
* Constructs an AbstractDocIndexEntryType instance from XML element data.
|
|
1868
|
+
*
|
|
1869
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
1870
|
+
* @param element - The XML element object containing the index entry data
|
|
1871
|
+
* @param elementName - The name of the XML element being processed
|
|
1872
|
+
*
|
|
1873
|
+
* @remarks
|
|
1874
|
+
* This constructor processes index entry elements by extracting the
|
|
1875
|
+
* primary and secondary index terms from the XML content. The
|
|
1876
|
+
* implementation handles both terms as optional to accommodate various
|
|
1877
|
+
* indexing scenarios whilst providing comprehensive index functionality.
|
|
1878
|
+
*
|
|
1879
|
+
* The index terms are used to generate searchable indices and keyword
|
|
1880
|
+
* lists that enhance documentation navigation and content discovery.
|
|
1881
|
+
*/
|
|
907
1882
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
908
1883
|
}
|
|
1884
|
+
/**
|
|
1885
|
+
* Data model for index entry elements within documentation content.
|
|
1886
|
+
*
|
|
1887
|
+
* @remarks
|
|
1888
|
+
* Represents index entry elements that define entries for documentation
|
|
1889
|
+
* indices and keyword lists. This implementation processes Doxygen's
|
|
1890
|
+
* indexentry elements, providing support for hierarchical indexing with
|
|
1891
|
+
* primary and secondary terms that enhance content organisation and
|
|
1892
|
+
* discoverability.
|
|
1893
|
+
*
|
|
1894
|
+
* Index entries enable comprehensive documentation indexing that supports
|
|
1895
|
+
* search functionality and content navigation, helping users locate
|
|
1896
|
+
* specific topics and concepts within large documentation sets.
|
|
1897
|
+
*
|
|
1898
|
+
* @public
|
|
1899
|
+
*/
|
|
909
1900
|
export declare class IndexEntryDataModel extends AbstractDocIndexEntryType {
|
|
1901
|
+
/**
|
|
1902
|
+
* Constructs an IndexEntryDataModel from XML element data.
|
|
1903
|
+
*
|
|
1904
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
1905
|
+
* @param element - The XML element object containing the index entry data
|
|
1906
|
+
*
|
|
1907
|
+
* @remarks
|
|
1908
|
+
* This constructor delegates to the parent AbstractDocIndexEntryType whilst
|
|
1909
|
+
* identifying the element as 'indexentry' for proper index term processing
|
|
1910
|
+
* and search functionality within documentation generation workflows.
|
|
1911
|
+
*/
|
|
910
1912
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
911
1913
|
}
|
|
1914
|
+
/**
|
|
1915
|
+
* Abstract base class for documentation list elements within content.
|
|
1916
|
+
*
|
|
1917
|
+
* @remarks
|
|
1918
|
+
* Provides foundational structure for ordered and unordered list elements
|
|
1919
|
+
* that organise content hierarchically within documentation. This abstract
|
|
1920
|
+
* class manages list items and common attributes such as type and starting
|
|
1921
|
+
* values, enabling consistent processing of various list formats including
|
|
1922
|
+
* bullet points, numbered lists, and custom enumeration styles.
|
|
1923
|
+
*
|
|
1924
|
+
* Lists enhance content organisation by enabling clear presentation of
|
|
1925
|
+
* structured information, supporting both simple and complex hierarchical
|
|
1926
|
+
* arrangements that improve documentation readability and user comprehension.
|
|
1927
|
+
*
|
|
1928
|
+
* @public
|
|
1929
|
+
*/
|
|
912
1930
|
export declare abstract class AbstractDocListType extends AbstractDataModelBase {
|
|
1931
|
+
/**
|
|
1932
|
+
* Array of list items contained within this list element.
|
|
1933
|
+
*
|
|
1934
|
+
* @remarks
|
|
1935
|
+
* Contains all individual list items that constitute the list content,
|
|
1936
|
+
* maintaining order and hierarchy for proper list rendering within
|
|
1937
|
+
* documentation output.
|
|
1938
|
+
*/
|
|
913
1939
|
listItems: ListItemDataModel[];
|
|
1940
|
+
/**
|
|
1941
|
+
* The list type identifier for formatting purposes.
|
|
1942
|
+
*
|
|
1943
|
+
* @remarks
|
|
1944
|
+
* Specifies the list type such as 'bullet', 'number', or custom
|
|
1945
|
+
* enumeration styles that determine the visual presentation of list items
|
|
1946
|
+
* within the rendered documentation.
|
|
1947
|
+
*/
|
|
914
1948
|
type: string;
|
|
1949
|
+
/**
|
|
1950
|
+
* Optional starting value for ordered lists.
|
|
1951
|
+
*
|
|
1952
|
+
* @remarks
|
|
1953
|
+
* Defines the initial value for numbered lists when custom starting
|
|
1954
|
+
* points are required, allowing documentation to continue numbering from
|
|
1955
|
+
* specific values or restart sequences as needed.
|
|
1956
|
+
*/
|
|
915
1957
|
start: number | undefined;
|
|
1958
|
+
/**
|
|
1959
|
+
* Constructs an AbstractDocListType from XML element data.
|
|
1960
|
+
*
|
|
1961
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
1962
|
+
* @param element - The XML element object containing the list data
|
|
1963
|
+
* @param elementName - The XML element name for identification purposes
|
|
1964
|
+
*
|
|
1965
|
+
* @remarks
|
|
1966
|
+
* This constructor processes XML list elements by extracting list items
|
|
1967
|
+
* and attributes that define list behaviour and appearance, enabling
|
|
1968
|
+
* proper list structure within documentation generation workflows.
|
|
1969
|
+
*/
|
|
916
1970
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
917
1971
|
}
|
|
1972
|
+
/**
|
|
1973
|
+
* Abstract base class for individual list item elements.
|
|
1974
|
+
*
|
|
1975
|
+
* @remarks
|
|
1976
|
+
* Represents individual items within ordered and unordered lists, providing
|
|
1977
|
+
* structure for list content including paragraphs and optional attributes
|
|
1978
|
+
* that control list item presentation. This abstract class enables flexible
|
|
1979
|
+
* list item processing whilst maintaining consistency across different list
|
|
1980
|
+
* types and documentation contexts.
|
|
1981
|
+
*
|
|
1982
|
+
* List items support complex content including multiple paragraphs and
|
|
1983
|
+
* custom numbering, allowing for rich documentation structures that enhance
|
|
1984
|
+
* content organisation and readability within generated documentation.
|
|
1985
|
+
*
|
|
1986
|
+
* @public
|
|
1987
|
+
*/
|
|
918
1988
|
export declare abstract class AbstractDocListItemType extends AbstractDataModelBase {
|
|
1989
|
+
/**
|
|
1990
|
+
* Optional array of paragraph elements within this list item.
|
|
1991
|
+
*
|
|
1992
|
+
* @remarks
|
|
1993
|
+
* Contains paragraph content that constitutes the list item body,
|
|
1994
|
+
* supporting rich content including text, formatting, and nested
|
|
1995
|
+
* elements that enhance list item presentation.
|
|
1996
|
+
*/
|
|
919
1997
|
paras?: ParaDataModel[] | undefined;
|
|
1998
|
+
/**
|
|
1999
|
+
* Optional override attribute for list item customisation.
|
|
2000
|
+
*
|
|
2001
|
+
* @remarks
|
|
2002
|
+
* Provides mechanism for overriding default list item presentation or
|
|
2003
|
+
* behaviour, enabling custom formatting or special handling of specific
|
|
2004
|
+
* list items within documentation generation.
|
|
2005
|
+
*/
|
|
920
2006
|
override: string | undefined;
|
|
2007
|
+
/**
|
|
2008
|
+
* Optional numeric value for ordered list items.
|
|
2009
|
+
*
|
|
2010
|
+
* @remarks
|
|
2011
|
+
* Specifies custom numbering for ordered list items when default
|
|
2012
|
+
* sequential numbering is insufficient, allowing for custom values and
|
|
2013
|
+
* non-sequential list numbering in documentation output.
|
|
2014
|
+
*/
|
|
921
2015
|
value: number | undefined;
|
|
2016
|
+
/**
|
|
2017
|
+
* Constructs an AbstractDocListItemType from XML element data.
|
|
2018
|
+
*
|
|
2019
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2020
|
+
* @param element - The XML element object containing the list item data
|
|
2021
|
+
* @param elementName - The XML element name for identification purposes
|
|
2022
|
+
*
|
|
2023
|
+
* @remarks
|
|
2024
|
+
* This constructor processes XML list item elements by extracting paragraph
|
|
2025
|
+
* content and optional attributes that define list item behaviour and
|
|
2026
|
+
* presentation within documentation generation workflows.
|
|
2027
|
+
*/
|
|
922
2028
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
923
2029
|
}
|
|
924
2030
|
export declare class ListItemDataModel extends AbstractDocListItemType {
|
|
925
2031
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
926
2032
|
}
|
|
2033
|
+
/**
|
|
2034
|
+
* Abstract base class for simple section elements with typed content.
|
|
2035
|
+
*
|
|
2036
|
+
* @remarks
|
|
2037
|
+
* Implements the XML Schema definition for docSimpleSectType elements, which
|
|
2038
|
+
* represent structured sections with specific semantic types such as 'note',
|
|
2039
|
+
* 'warning', 'see', 'return', 'since', and others. These sections provide
|
|
2040
|
+
* standardised content blocks for common documentation patterns and help
|
|
2041
|
+
* organise information according to its purpose and meaning.
|
|
2042
|
+
*
|
|
2043
|
+
* Simple sections contain an optional title and a sequence of paragraphs,
|
|
2044
|
+
* along with a mandatory kind attribute that specifies the semantic type
|
|
2045
|
+
* of the section content.
|
|
2046
|
+
*
|
|
2047
|
+
* @public
|
|
2048
|
+
*/
|
|
927
2049
|
export declare abstract class AbstractDocSimpleSectType extends AbstractDataModelBase {
|
|
2050
|
+
/**
|
|
2051
|
+
* Optional title for the simple section.
|
|
2052
|
+
*
|
|
2053
|
+
* @remarks
|
|
2054
|
+
* Contains the title text for the simple section when present. Simple
|
|
2055
|
+
* sections may have descriptive titles that provide additional context
|
|
2056
|
+
* beyond the semantic type indicated by the kind attribute.
|
|
2057
|
+
*/
|
|
928
2058
|
title?: string | undefined;
|
|
2059
|
+
/**
|
|
2060
|
+
* Mandatory kind attribute specifying the section type.
|
|
2061
|
+
*
|
|
2062
|
+
* @remarks
|
|
2063
|
+
* Specifies the semantic type of the simple section such as 'note',
|
|
2064
|
+
* 'warning', 'see', 'return', 'since', 'version', 'author', or other
|
|
2065
|
+
* predefined section types. This attribute determines how the section
|
|
2066
|
+
* content should be interpreted and potentially styled in the output.
|
|
2067
|
+
*/
|
|
929
2068
|
kind: string;
|
|
2069
|
+
/**
|
|
2070
|
+
* Constructs an AbstractDocSimpleSectType instance from XML element data.
|
|
2071
|
+
*
|
|
2072
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2073
|
+
* @param element - The XML element object containing the simple section data
|
|
2074
|
+
* @param elementName - The name of the XML element being processed
|
|
2075
|
+
*
|
|
2076
|
+
* @remarks
|
|
2077
|
+
* This constructor processes simple section elements by extracting the
|
|
2078
|
+
* title, paragraph content, and mandatory kind attribute. The implementation
|
|
2079
|
+
* validates the presence of the kind attribute and organises content
|
|
2080
|
+
* elements whilst maintaining their original order for proper presentation.
|
|
2081
|
+
*/
|
|
930
2082
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
931
2083
|
}
|
|
2084
|
+
/**
|
|
2085
|
+
* Abstract base class for reference text elements with links.
|
|
2086
|
+
*
|
|
2087
|
+
* @remarks
|
|
2088
|
+
* Represents textual references that link to other documentation elements,
|
|
2089
|
+
* providing cross-reference functionality within documentation content.
|
|
2090
|
+
* This abstract class handles mixed content including text and formatting
|
|
2091
|
+
* elements alongside reference attributes that specify the target and type
|
|
2092
|
+
* of the reference link.
|
|
2093
|
+
*
|
|
2094
|
+
* Reference text elements enable navigation between related documentation
|
|
2095
|
+
* sections, supporting both internal references within the documentation
|
|
2096
|
+
* set and external references to other documentation sources or websites.
|
|
2097
|
+
*
|
|
2098
|
+
* @public
|
|
2099
|
+
*/
|
|
932
2100
|
export declare abstract class AbstractDocRefTextType extends AbstractDataModelBase {
|
|
2101
|
+
/**
|
|
2102
|
+
* Mandatory reference identifier for the linked element.
|
|
2103
|
+
*
|
|
2104
|
+
* @remarks
|
|
2105
|
+
* Specifies the unique identifier of the referenced documentation element,
|
|
2106
|
+
* enabling precise linking to specific functions, classes, or other
|
|
2107
|
+
* documented entities within the documentation set.
|
|
2108
|
+
*/
|
|
933
2109
|
refid: string;
|
|
2110
|
+
/**
|
|
2111
|
+
* Mandatory reference kind specifying the type of referenced element.
|
|
2112
|
+
*
|
|
2113
|
+
* @remarks
|
|
2114
|
+
* Indicates the type of element being referenced such as 'compound',
|
|
2115
|
+
* 'member', or other entity types, helping the documentation system
|
|
2116
|
+
* resolve and format the reference appropriately.
|
|
2117
|
+
*/
|
|
934
2118
|
kindref: string;
|
|
2119
|
+
/**
|
|
2120
|
+
* Optional external reference attribute for external links.
|
|
2121
|
+
*
|
|
2122
|
+
* @remarks
|
|
2123
|
+
* Specifies external documentation sources when the reference points to
|
|
2124
|
+
* elements outside the current documentation set, enabling links to
|
|
2125
|
+
* external APIs, libraries, or documentation websites.
|
|
2126
|
+
*/
|
|
935
2127
|
external?: string | undefined;
|
|
2128
|
+
/**
|
|
2129
|
+
* Constructs an AbstractDocRefTextType from XML element data.
|
|
2130
|
+
*
|
|
2131
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2132
|
+
* @param element - The XML element object containing the reference data
|
|
2133
|
+
* @param elementName - The XML element name for identification purposes
|
|
2134
|
+
*
|
|
2135
|
+
* @remarks
|
|
2136
|
+
* This constructor processes reference text elements by extracting mixed
|
|
2137
|
+
* content and reference attributes, enabling proper cross-reference
|
|
2138
|
+
* functionality within documentation generation workflows.
|
|
2139
|
+
*/
|
|
936
2140
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
937
2141
|
}
|
|
938
2142
|
export declare class RefDataModel extends AbstractDocRefTextType {
|
|
939
2143
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
940
2144
|
}
|
|
2145
|
+
/**
|
|
2146
|
+
* Abstract base class for table elements within documentation content.
|
|
2147
|
+
*
|
|
2148
|
+
* @remarks
|
|
2149
|
+
* Represents tabular data structures that organise content into rows and
|
|
2150
|
+
* columns, providing structured presentation of information within
|
|
2151
|
+
* documentation. This abstract class manages table structure including
|
|
2152
|
+
* optional captions, table rows, and sizing attributes that control table
|
|
2153
|
+
* appearance and layout within generated documentation.
|
|
2154
|
+
*
|
|
2155
|
+
* Tables support complex content organisation enabling clear presentation
|
|
2156
|
+
* of structured data, comparison information, and technical specifications
|
|
2157
|
+
* that enhance documentation readability and user comprehension.
|
|
2158
|
+
*
|
|
2159
|
+
* @public
|
|
2160
|
+
*/
|
|
941
2161
|
export declare abstract class AbstractDocTableType extends AbstractDataModelBase {
|
|
2162
|
+
/**
|
|
2163
|
+
* Optional caption element for the table.
|
|
2164
|
+
*
|
|
2165
|
+
* @remarks
|
|
2166
|
+
* Contains descriptive text that provides context or explanation for the
|
|
2167
|
+
* table content, typically displayed above or below the table in the
|
|
2168
|
+
* rendered documentation output.
|
|
2169
|
+
*/
|
|
942
2170
|
caption?: DocCaptionDataModel;
|
|
2171
|
+
/**
|
|
2172
|
+
* Optional array of table rows containing table data.
|
|
2173
|
+
*
|
|
2174
|
+
* @remarks
|
|
2175
|
+
* Contains all row elements that constitute the table content, maintaining
|
|
2176
|
+
* order and structure for proper table rendering within documentation
|
|
2177
|
+
* generation workflows.
|
|
2178
|
+
*/
|
|
943
2179
|
rows?: DocRowDataModel[];
|
|
2180
|
+
/**
|
|
2181
|
+
* Mandatory number of rows in the table.
|
|
2182
|
+
*
|
|
2183
|
+
* @remarks
|
|
2184
|
+
* Specifies the total number of rows that the table should contain,
|
|
2185
|
+
* enabling proper table structure validation and layout calculation
|
|
2186
|
+
* during documentation generation.
|
|
2187
|
+
*/
|
|
944
2188
|
rowsCount: number;
|
|
2189
|
+
/**
|
|
2190
|
+
* Mandatory number of columns in the table.
|
|
2191
|
+
*
|
|
2192
|
+
* @remarks
|
|
2193
|
+
* Specifies the total number of columns that the table should contain,
|
|
2194
|
+
* enabling proper table structure validation and layout calculation
|
|
2195
|
+
* during documentation generation.
|
|
2196
|
+
*/
|
|
945
2197
|
colsCount: number;
|
|
2198
|
+
/**
|
|
2199
|
+
* Optional width specification for the table.
|
|
2200
|
+
*
|
|
2201
|
+
* @remarks
|
|
2202
|
+
* Defines the table width using CSS-style values such as percentages,
|
|
2203
|
+
* pixels, or other units, allowing control over table presentation and
|
|
2204
|
+
* layout within the documentation output.
|
|
2205
|
+
*/
|
|
946
2206
|
width: string | undefined;
|
|
2207
|
+
/**
|
|
2208
|
+
* Constructs an AbstractDocTableType from XML element data.
|
|
2209
|
+
*
|
|
2210
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2211
|
+
* @param element - The XML element object containing the table data
|
|
2212
|
+
* @param elementName - The XML element name for identification purposes
|
|
2213
|
+
*
|
|
2214
|
+
* @remarks
|
|
2215
|
+
* This constructor processes table elements by extracting caption, rows,
|
|
2216
|
+
* and sizing attributes that define table structure and appearance within
|
|
2217
|
+
* documentation generation workflows.
|
|
2218
|
+
*/
|
|
947
2219
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
948
2220
|
}
|
|
949
2221
|
export declare class DocTableDataModel extends AbstractDocTableType {
|
|
950
2222
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
951
2223
|
}
|
|
2224
|
+
/**
|
|
2225
|
+
* Abstract base class for table row elements within table structures.
|
|
2226
|
+
*
|
|
2227
|
+
* @remarks
|
|
2228
|
+
* Represents individual rows within table elements, containing a sequence
|
|
2229
|
+
* of entry elements that constitute the row's cell content. This abstract
|
|
2230
|
+
* class provides structure for table row processing whilst maintaining
|
|
2231
|
+
* flexibility for different row types and table configurations within
|
|
2232
|
+
* documentation content.
|
|
2233
|
+
*
|
|
2234
|
+
* Table rows organise content horizontally across table columns, enabling
|
|
2235
|
+
* structured data presentation that supports complex information layouts
|
|
2236
|
+
* and enhances documentation readability through clear data organisation.
|
|
2237
|
+
*
|
|
2238
|
+
* @public
|
|
2239
|
+
*/
|
|
952
2240
|
export declare abstract class AbstractDocRowType extends AbstractDataModelBase {
|
|
2241
|
+
/**
|
|
2242
|
+
* Optional array of entry elements constituting the row content.
|
|
2243
|
+
*
|
|
2244
|
+
* @remarks
|
|
2245
|
+
* Contains the individual cell entries that make up this table row,
|
|
2246
|
+
* maintaining order and structure for proper table rendering within
|
|
2247
|
+
* documentation generation workflows.
|
|
2248
|
+
*/
|
|
953
2249
|
entries?: DocEntryDataModel[] | undefined;
|
|
2250
|
+
/**
|
|
2251
|
+
* Constructs an AbstractDocRowType from XML element data.
|
|
2252
|
+
*
|
|
2253
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2254
|
+
* @param element - The XML element object containing the row data
|
|
2255
|
+
* @param elementName - The XML element name for identification purposes
|
|
2256
|
+
*
|
|
2257
|
+
* @remarks
|
|
2258
|
+
* This constructor processes table row elements by extracting entry
|
|
2259
|
+
* elements that define the row's cell content within documentation
|
|
2260
|
+
* generation workflows.
|
|
2261
|
+
*/
|
|
954
2262
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
955
2263
|
}
|
|
956
2264
|
export declare class DocRowDataModel extends AbstractDocRowType {
|
|
957
2265
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
958
2266
|
}
|
|
2267
|
+
/**
|
|
2268
|
+
* Abstract base class for table entry (cell) elements within table rows.
|
|
2269
|
+
*
|
|
2270
|
+
* @remarks
|
|
2271
|
+
* Represents individual cells within table rows, containing paragraph
|
|
2272
|
+
* content and various attributes that control cell presentation and layout.
|
|
2273
|
+
* This abstract class provides comprehensive support for table cell
|
|
2274
|
+
* functionality including header designation, spanning, alignment, and
|
|
2275
|
+
* styling attributes that enable rich table formatting within documentation.
|
|
2276
|
+
*
|
|
2277
|
+
* Table entries support complex content organisation through paragraph
|
|
2278
|
+
* elements and flexible presentation through layout attributes, enabling
|
|
2279
|
+
* professional table design that enhances documentation clarity and
|
|
2280
|
+
* visual appeal.
|
|
2281
|
+
*
|
|
2282
|
+
* @public
|
|
2283
|
+
*/
|
|
959
2284
|
export declare abstract class AbstractDocEntryType extends AbstractDataModelBase {
|
|
2285
|
+
/**
|
|
2286
|
+
* Optional array of paragraph elements within this table entry.
|
|
2287
|
+
*
|
|
2288
|
+
* @remarks
|
|
2289
|
+
* Contains the paragraph content that constitutes the cell content,
|
|
2290
|
+
* supporting rich text formatting and nested elements within table
|
|
2291
|
+
* cells for comprehensive documentation presentation.
|
|
2292
|
+
*/
|
|
960
2293
|
paras?: ParaDataModel[] | undefined;
|
|
2294
|
+
/**
|
|
2295
|
+
* Boolean flag indicating whether this entry is a table header.
|
|
2296
|
+
*
|
|
2297
|
+
* @remarks
|
|
2298
|
+
* Determines whether this cell should be treated as a header cell,
|
|
2299
|
+
* affecting its visual presentation and semantic meaning within the
|
|
2300
|
+
* table structure for improved accessibility and styling.
|
|
2301
|
+
*/
|
|
961
2302
|
thead: boolean;
|
|
2303
|
+
/**
|
|
2304
|
+
* Optional column span value for cell spanning.
|
|
2305
|
+
*
|
|
2306
|
+
* @remarks
|
|
2307
|
+
* Specifies the number of columns this cell should span horizontally,
|
|
2308
|
+
* enabling complex table layouts with merged cells that improve data
|
|
2309
|
+
* organisation and presentation clarity.
|
|
2310
|
+
*/
|
|
962
2311
|
colspan?: number | undefined;
|
|
2312
|
+
/**
|
|
2313
|
+
* Optional row span value for cell spanning.
|
|
2314
|
+
*
|
|
2315
|
+
* @remarks
|
|
2316
|
+
* Specifies the number of rows this cell should span vertically,
|
|
2317
|
+
* enabling complex table layouts with merged cells that improve data
|
|
2318
|
+
* organisation and presentation clarity.
|
|
2319
|
+
*/
|
|
963
2320
|
rowspan?: number | undefined;
|
|
2321
|
+
/**
|
|
2322
|
+
* Optional horizontal alignment specification for cell content.
|
|
2323
|
+
*
|
|
2324
|
+
* @remarks
|
|
2325
|
+
* Controls the horizontal alignment of content within the cell such as
|
|
2326
|
+
* 'left', 'center', 'right', or 'justify', enabling precise content
|
|
2327
|
+
* positioning for improved table presentation.
|
|
2328
|
+
*/
|
|
964
2329
|
align?: string | undefined;
|
|
2330
|
+
/**
|
|
2331
|
+
* Optional vertical alignment specification for cell content.
|
|
2332
|
+
*
|
|
2333
|
+
* @remarks
|
|
2334
|
+
* Controls the vertical alignment of content within the cell such as
|
|
2335
|
+
* 'top', 'middle', or 'bottom', enabling precise content positioning
|
|
2336
|
+
* for improved table presentation.
|
|
2337
|
+
*/
|
|
965
2338
|
valign?: string | undefined;
|
|
2339
|
+
/**
|
|
2340
|
+
* Optional width specification for the table entry.
|
|
2341
|
+
*
|
|
2342
|
+
* @remarks
|
|
2343
|
+
* Defines the cell width using CSS-style values such as percentages,
|
|
2344
|
+
* pixels, or other units, allowing precise control over table column
|
|
2345
|
+
* sizing and layout appearance.
|
|
2346
|
+
*/
|
|
966
2347
|
width?: string | undefined;
|
|
2348
|
+
/**
|
|
2349
|
+
* Optional CSS class specification for styling purposes.
|
|
2350
|
+
*
|
|
2351
|
+
* @remarks
|
|
2352
|
+
* Provides CSS class names for custom styling of table cells, enabling
|
|
2353
|
+
* enhanced visual presentation and consistent styling across
|
|
2354
|
+
* documentation output.
|
|
2355
|
+
*/
|
|
967
2356
|
classs?: string | undefined;
|
|
2357
|
+
/**
|
|
2358
|
+
* Constructs an AbstractDocEntryType from XML element data.
|
|
2359
|
+
*
|
|
2360
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2361
|
+
* @param element - The XML element object containing the entry data
|
|
2362
|
+
* @param elementName - The XML element name for identification purposes
|
|
2363
|
+
*
|
|
2364
|
+
* @remarks
|
|
2365
|
+
* This constructor processes table entry elements by extracting paragraph
|
|
2366
|
+
* content and layout attributes that define cell structure and appearance
|
|
2367
|
+
* within documentation generation workflows.
|
|
2368
|
+
*/
|
|
968
2369
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
969
2370
|
}
|
|
970
2371
|
export declare class DocEntryDataModel extends AbstractDocEntryType {
|
|
971
2372
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
972
2373
|
}
|
|
2374
|
+
/**
|
|
2375
|
+
* Abstract base class for caption elements within documentation content.
|
|
2376
|
+
*
|
|
2377
|
+
* @remarks
|
|
2378
|
+
* Represents caption elements that provide descriptive text for tables,
|
|
2379
|
+
* figures, images, and other content elements within documentation.
|
|
2380
|
+
* This abstract class handles mixed content including text and formatting
|
|
2381
|
+
* commands alongside an identifier attribute for cross-referencing and
|
|
2382
|
+
* linking purposes.
|
|
2383
|
+
*
|
|
2384
|
+
* Captions enhance content accessibility and understanding by providing
|
|
2385
|
+
* descriptive context for visual and structured elements, supporting
|
|
2386
|
+
* comprehensive documentation that improves user comprehension and
|
|
2387
|
+
* content navigation.
|
|
2388
|
+
*
|
|
2389
|
+
* @public
|
|
2390
|
+
*/
|
|
973
2391
|
export declare abstract class AbstractDocCaptionType extends AbstractDataModelBase {
|
|
2392
|
+
/**
|
|
2393
|
+
* Mandatory identifier for the caption element.
|
|
2394
|
+
*
|
|
2395
|
+
* @remarks
|
|
2396
|
+
* Specifies the unique identifier for this caption element, enabling
|
|
2397
|
+
* cross-referencing and linking within documentation generation
|
|
2398
|
+
* workflows and supporting proper caption association with content.
|
|
2399
|
+
*/
|
|
974
2400
|
id: string;
|
|
2401
|
+
/**
|
|
2402
|
+
* Constructs an AbstractDocCaptionType from XML element data.
|
|
2403
|
+
*
|
|
2404
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2405
|
+
* @param element - The XML element object containing the caption data
|
|
2406
|
+
* @param elementName - The XML element name for identification purposes
|
|
2407
|
+
*
|
|
2408
|
+
* @remarks
|
|
2409
|
+
* This constructor processes caption elements by extracting mixed content
|
|
2410
|
+
* including text and formatting commands alongside the mandatory identifier
|
|
2411
|
+
* attribute within documentation generation workflows.
|
|
2412
|
+
*/
|
|
975
2413
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
976
2414
|
}
|
|
977
2415
|
export declare class DocCaptionDataModel extends AbstractDocCaptionType {
|
|
@@ -985,24 +2423,184 @@ export declare class HeadingDataModel extends AbstractDocHeadingType {
|
|
|
985
2423
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
986
2424
|
}
|
|
987
2425
|
/**
|
|
2426
|
+
* Abstract base class for image elements within documentation content.
|
|
2427
|
+
*
|
|
2428
|
+
* @remarks
|
|
2429
|
+
* Represents image elements that can be embedded within documentation
|
|
2430
|
+
* descriptions and content blocks. This implementation processes Doxygen's
|
|
2431
|
+
* image elements, which support multiple output formats (HTML, LaTeX,
|
|
2432
|
+
* DocBook, RTF, XML) and provide comprehensive image metadata including
|
|
2433
|
+
* dimensions, captions, alternative text, and inline positioning.
|
|
2434
|
+
*
|
|
2435
|
+
* Image elements support mixed content with text and formatting commands,
|
|
2436
|
+
* allowing for rich image descriptions and captions. The class tracks HTML
|
|
2437
|
+
* images specifically for asset copying during documentation generation.
|
|
2438
|
+
*
|
|
988
2439
|
* @public
|
|
989
2440
|
*/
|
|
990
2441
|
export declare abstract class AbstractDocImageType extends AbstractDataModelBase {
|
|
2442
|
+
/**
|
|
2443
|
+
* Output format type for the image.
|
|
2444
|
+
*
|
|
2445
|
+
* @remarks
|
|
2446
|
+
* Specifies the target output format for the image, such as 'html',
|
|
2447
|
+
* 'latex', 'docbook', 'rtf', or 'xml'. This determines how the image
|
|
2448
|
+
* should be processed and rendered in different documentation outputs.
|
|
2449
|
+
*/
|
|
991
2450
|
type?: string | undefined;
|
|
2451
|
+
/**
|
|
2452
|
+
* Name or path of the image file.
|
|
2453
|
+
*
|
|
2454
|
+
* @remarks
|
|
2455
|
+
* Contains the filename or path to the image resource. For HTML images,
|
|
2456
|
+
* this typically references files that need to be copied to the output
|
|
2457
|
+
* folder during documentation generation.
|
|
2458
|
+
*/
|
|
992
2459
|
name?: string | undefined;
|
|
2460
|
+
/**
|
|
2461
|
+
* Width specification for the image.
|
|
2462
|
+
*
|
|
2463
|
+
* @remarks
|
|
2464
|
+
* Specifies the desired width for the image rendering. The format and
|
|
2465
|
+
* units depend on the target output format and may include CSS-style
|
|
2466
|
+
* dimensions or format-specific measurements.
|
|
2467
|
+
*/
|
|
993
2468
|
width?: string | undefined;
|
|
2469
|
+
/**
|
|
2470
|
+
* Height specification for the image.
|
|
2471
|
+
*
|
|
2472
|
+
* @remarks
|
|
2473
|
+
* Specifies the desired height for the image rendering. The format and
|
|
2474
|
+
* units depend on the target output format and may include CSS-style
|
|
2475
|
+
* dimensions or format-specific measurements.
|
|
2476
|
+
*/
|
|
994
2477
|
height?: string | undefined;
|
|
2478
|
+
/**
|
|
2479
|
+
* Alternative text for accessibility and fallback purposes.
|
|
2480
|
+
*
|
|
2481
|
+
* @remarks
|
|
2482
|
+
* Provides descriptive text for the image that can be used by screen
|
|
2483
|
+
* readers and displayed when the image cannot be loaded. This supports
|
|
2484
|
+
* accessibility requirements and fallback presentation.
|
|
2485
|
+
*/
|
|
995
2486
|
alt?: string | undefined;
|
|
2487
|
+
/**
|
|
2488
|
+
* Inline positioning flag for the image.
|
|
2489
|
+
*
|
|
2490
|
+
* @remarks
|
|
2491
|
+
* Determines whether the image should be rendered inline with text
|
|
2492
|
+
* content or as a block-level element. Inline images flow with text
|
|
2493
|
+
* whilst block images create separate content sections.
|
|
2494
|
+
*/
|
|
996
2495
|
inline?: boolean | undefined;
|
|
2496
|
+
/**
|
|
2497
|
+
* Caption text for the image.
|
|
2498
|
+
*
|
|
2499
|
+
* @remarks
|
|
2500
|
+
* Provides descriptive caption text that accompanies the image display.
|
|
2501
|
+
* Captions typically appear below or adjacent to the image and provide
|
|
2502
|
+
* additional context or explanation for the visual content.
|
|
2503
|
+
*/
|
|
997
2504
|
caption?: string | undefined;
|
|
2505
|
+
/**
|
|
2506
|
+
* Constructs an AbstractDocImageType instance from XML element data.
|
|
2507
|
+
*
|
|
2508
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2509
|
+
* @param element - The XML element object containing the image data
|
|
2510
|
+
* @param elementName - The name of the XML element being processed
|
|
2511
|
+
*
|
|
2512
|
+
* @remarks
|
|
2513
|
+
* This constructor processes image elements by extracting all optional
|
|
2514
|
+
* attributes including type, name, dimensions, alternative text, inline
|
|
2515
|
+
* positioning, and caption information. For HTML images with local file
|
|
2516
|
+
* references, the image is registered with the parser for asset tracking
|
|
2517
|
+
* during documentation generation.
|
|
2518
|
+
*
|
|
2519
|
+
* The implementation also processes any mixed content within the image
|
|
2520
|
+
* element, including text and formatting commands that may be part of
|
|
2521
|
+
* the image description or caption.
|
|
2522
|
+
*/
|
|
998
2523
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
999
2524
|
}
|
|
2525
|
+
/**
|
|
2526
|
+
* Data model for image elements within documentation content.
|
|
2527
|
+
*
|
|
2528
|
+
* @remarks
|
|
2529
|
+
* Represents image elements that embed visual content within documentation
|
|
2530
|
+
* descriptions and content blocks. This implementation processes Doxygen's
|
|
2531
|
+
* image elements, providing support for multiple output formats and
|
|
2532
|
+
* comprehensive image metadata management.
|
|
2533
|
+
*
|
|
2534
|
+
* Images can include formatting content, captions, and metadata attributes
|
|
2535
|
+
* that control their presentation across different documentation outputs.
|
|
2536
|
+
* The class ensures proper asset tracking for HTML images during the
|
|
2537
|
+
* documentation generation process.
|
|
2538
|
+
*
|
|
2539
|
+
* @public
|
|
2540
|
+
*/
|
|
1000
2541
|
export declare class ImageDataModel extends AbstractDocImageType {
|
|
2542
|
+
/**
|
|
2543
|
+
* Constructs an ImageDataModel from XML element data.
|
|
2544
|
+
*
|
|
2545
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2546
|
+
* @param element - The XML element object containing the image data
|
|
2547
|
+
*
|
|
2548
|
+
* @remarks
|
|
2549
|
+
* This constructor delegates to the parent AbstractDocImageType whilst
|
|
2550
|
+
* identifying the element as 'image' for proper image processing and
|
|
2551
|
+
* asset management within documentation generation workflows.
|
|
2552
|
+
*/
|
|
1001
2553
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1002
2554
|
}
|
|
2555
|
+
/**
|
|
2556
|
+
* Abstract base class for parameter list elements within documentation.
|
|
2557
|
+
*
|
|
2558
|
+
* @remarks
|
|
2559
|
+
* Represents parameter lists that document function and method parameters,
|
|
2560
|
+
* return values, exceptions, and other parameter-related information.
|
|
2561
|
+
* This abstract class manages collections of parameter items and their
|
|
2562
|
+
* associated metadata, providing structured documentation for function
|
|
2563
|
+
* signatures and parameter descriptions.
|
|
2564
|
+
*
|
|
2565
|
+
* Parameter lists support various parameter documentation types including
|
|
2566
|
+
* input parameters, output parameters, return values, and exceptions,
|
|
2567
|
+
* enabling comprehensive function documentation that enhances API
|
|
2568
|
+
* understanding and usage.
|
|
2569
|
+
*
|
|
2570
|
+
* @public
|
|
2571
|
+
*/
|
|
1003
2572
|
export declare abstract class AbstractDocParamListType extends AbstractDataModelBase {
|
|
2573
|
+
/**
|
|
2574
|
+
* Optional array of parameter items within this parameter list.
|
|
2575
|
+
*
|
|
2576
|
+
* @remarks
|
|
2577
|
+
* Contains individual parameter item elements that document specific
|
|
2578
|
+
* parameters, return values, or exceptions associated with functions
|
|
2579
|
+
* and methods within the documentation.
|
|
2580
|
+
*/
|
|
1004
2581
|
parameterItems?: ParameterItemDataModel[] | undefined;
|
|
2582
|
+
/**
|
|
2583
|
+
* Mandatory kind attribute specifying the parameter list type.
|
|
2584
|
+
*
|
|
2585
|
+
* @remarks
|
|
2586
|
+
* Specifies the type of parameter list such as 'param', 'retval',
|
|
2587
|
+
* 'exception', 'templateparam', or other parameter documentation
|
|
2588
|
+
* types that determine how the parameter list should be interpreted
|
|
2589
|
+
* and formatted in documentation output.
|
|
2590
|
+
*/
|
|
1005
2591
|
kind: string;
|
|
2592
|
+
/**
|
|
2593
|
+
* Constructs an AbstractDocParamListType from XML element data.
|
|
2594
|
+
*
|
|
2595
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2596
|
+
* @param element - The XML element object containing the parameter list data
|
|
2597
|
+
* @param elementName - The XML element name for identification purposes
|
|
2598
|
+
*
|
|
2599
|
+
* @remarks
|
|
2600
|
+
* This constructor processes parameter list elements by extracting
|
|
2601
|
+
* parameter items and the mandatory kind attribute that defines the
|
|
2602
|
+
* parameter list type within documentation generation workflows.
|
|
2603
|
+
*/
|
|
1006
2604
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
1007
2605
|
}
|
|
1008
2606
|
export declare class ParameterListDataModel extends AbstractDocParamListType {
|
|
@@ -1035,10 +2633,62 @@ export declare class AbstractDocParamName extends AbstractDataModelBase {
|
|
|
1035
2633
|
export declare class ParameterNameDataModel extends AbstractDocParamName {
|
|
1036
2634
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1037
2635
|
}
|
|
2636
|
+
/**
|
|
2637
|
+
* Abstract base class for cross-reference section elements.
|
|
2638
|
+
*
|
|
2639
|
+
* @remarks
|
|
2640
|
+
* Represents cross-reference sections that provide links and references to
|
|
2641
|
+
* related documentation elements, enabling navigation between connected
|
|
2642
|
+
* content areas. This abstract class manages cross-reference sections
|
|
2643
|
+
* including optional titles and mandatory descriptions that provide context
|
|
2644
|
+
* and detail for the referenced content.
|
|
2645
|
+
*
|
|
2646
|
+
* Cross-reference sections enhance documentation usability by establishing
|
|
2647
|
+
* clear relationships between related topics, supporting comprehensive
|
|
2648
|
+
* navigation and content discovery within large documentation sets.
|
|
2649
|
+
*
|
|
2650
|
+
* @public
|
|
2651
|
+
*/
|
|
1038
2652
|
export declare abstract class AbstractDocXRefSectType extends AbstractDataModelBase {
|
|
2653
|
+
/**
|
|
2654
|
+
* Optional title for the cross-reference section.
|
|
2655
|
+
*
|
|
2656
|
+
* @remarks
|
|
2657
|
+
* Contains the title text for the cross-reference section when present,
|
|
2658
|
+
* providing descriptive context for the referenced content and improving
|
|
2659
|
+
* section identification within documentation output.
|
|
2660
|
+
*/
|
|
1039
2661
|
xreftitle: string | undefined;
|
|
2662
|
+
/**
|
|
2663
|
+
* Mandatory description for the cross-reference section.
|
|
2664
|
+
*
|
|
2665
|
+
* @remarks
|
|
2666
|
+
* Contains detailed descriptive content for the cross-reference section,
|
|
2667
|
+
* providing comprehensive information about the referenced content and
|
|
2668
|
+
* its relationship to the current documentation context.
|
|
2669
|
+
*/
|
|
1040
2670
|
xrefdescription: XrefDescriptionDataModel | undefined;
|
|
2671
|
+
/**
|
|
2672
|
+
* Mandatory identifier for the cross-reference section.
|
|
2673
|
+
*
|
|
2674
|
+
* @remarks
|
|
2675
|
+
* Specifies the unique identifier for this cross-reference section,
|
|
2676
|
+
* enabling precise linking and referencing within documentation
|
|
2677
|
+
* generation workflows and cross-reference resolution.
|
|
2678
|
+
*/
|
|
1041
2679
|
id: string;
|
|
2680
|
+
/**
|
|
2681
|
+
* Constructs an AbstractDocXRefSectType from XML element data.
|
|
2682
|
+
*
|
|
2683
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2684
|
+
* @param element - The XML element object containing the cross-reference data
|
|
2685
|
+
* @param elementName - The XML element name for identification purposes
|
|
2686
|
+
*
|
|
2687
|
+
* @remarks
|
|
2688
|
+
* This constructor processes cross-reference section elements by extracting
|
|
2689
|
+
* title, description, and identifier information that defines cross-reference
|
|
2690
|
+
* relationships within documentation generation workflows.
|
|
2691
|
+
*/
|
|
1042
2692
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
1043
2693
|
}
|
|
1044
2694
|
export declare class XrefSectDataModel extends AbstractDocXRefSectType {
|
|
@@ -1053,162 +2703,1217 @@ export declare class BlockquoteDataModel extends AbstractDocBlockQuoteType {
|
|
|
1053
2703
|
export declare class AbstractDocEmptyType extends AbstractDataModelBase {
|
|
1054
2704
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
1055
2705
|
}
|
|
2706
|
+
/**
|
|
2707
|
+
* Abstract base class for emoji elements within documentation content.
|
|
2708
|
+
*
|
|
2709
|
+
* @remarks
|
|
2710
|
+
* Represents emoji elements that can be embedded within documentation
|
|
2711
|
+
* content to enhance visual communication and expression. This abstract
|
|
2712
|
+
* class manages emoji data including both human-readable names and
|
|
2713
|
+
* Unicode representations that enable consistent emoji rendering across
|
|
2714
|
+
* different documentation output formats and platforms.
|
|
2715
|
+
*
|
|
2716
|
+
* Emoji elements support modern documentation practices by enabling
|
|
2717
|
+
* expressive visual communication that can improve user engagement and
|
|
2718
|
+
* content accessibility in appropriate documentation contexts.
|
|
2719
|
+
*
|
|
2720
|
+
* @public
|
|
2721
|
+
*/
|
|
1056
2722
|
export declare abstract class AbstractEmojiType extends AbstractDataModelBase {
|
|
2723
|
+
/**
|
|
2724
|
+
* The human-readable name identifier for the emoji.
|
|
2725
|
+
*
|
|
2726
|
+
* @remarks
|
|
2727
|
+
* Specifies the emoji name using standard emoji naming conventions,
|
|
2728
|
+
* enabling consistent emoji identification and providing fallback
|
|
2729
|
+
* representation when Unicode rendering is not available.
|
|
2730
|
+
*/
|
|
1057
2731
|
name: string;
|
|
2732
|
+
/**
|
|
2733
|
+
* The Unicode code point representation for the emoji.
|
|
2734
|
+
*
|
|
2735
|
+
* @remarks
|
|
2736
|
+
* Contains the Unicode code point or sequence that defines the emoji
|
|
2737
|
+
* character, enabling proper emoji rendering in Unicode-capable
|
|
2738
|
+
* documentation output formats and systems.
|
|
2739
|
+
*/
|
|
1058
2740
|
unicode: string;
|
|
2741
|
+
/**
|
|
2742
|
+
* Constructs an AbstractEmojiType from XML element data.
|
|
2743
|
+
*
|
|
2744
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2745
|
+
* @param element - The XML element object containing the emoji data
|
|
2746
|
+
* @param elementName - The XML element name for identification purposes
|
|
2747
|
+
*
|
|
2748
|
+
* @remarks
|
|
2749
|
+
* This constructor processes emoji elements by extracting name and Unicode
|
|
2750
|
+
* attributes that define emoji representation within documentation
|
|
2751
|
+
* generation workflows.
|
|
2752
|
+
*/
|
|
1059
2753
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
1060
2754
|
}
|
|
1061
2755
|
export declare class EmojiDataModel extends AbstractEmojiType {
|
|
1062
2756
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1063
2757
|
}
|
|
1064
2758
|
/**
|
|
2759
|
+
* Data model for brief description elements within documentation.
|
|
2760
|
+
*
|
|
2761
|
+
* @remarks
|
|
2762
|
+
* Represents brief description elements that provide concise summary
|
|
2763
|
+
* content for entities. This implementation processes Doxygen's
|
|
2764
|
+
* briefdescription elements, which contain short descriptive content
|
|
2765
|
+
* used for entity summaries, overviews, and quick reference information
|
|
2766
|
+
* within documentation structures.
|
|
2767
|
+
*
|
|
2768
|
+
* Brief descriptions are typically displayed in listings, summaries,
|
|
2769
|
+
* and overview sections to provide immediate context about documented
|
|
2770
|
+
* entities without requiring full detailed descriptions.
|
|
2771
|
+
*
|
|
1065
2772
|
* @public
|
|
1066
2773
|
*/
|
|
1067
2774
|
export declare class BriefDescriptionDataModel extends AbstractDescriptionType {
|
|
2775
|
+
/**
|
|
2776
|
+
* Constructs a BriefDescriptionDataModel from XML element data.
|
|
2777
|
+
*
|
|
2778
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2779
|
+
* @param element - The XML element object containing the brief description
|
|
2780
|
+
* data
|
|
2781
|
+
*
|
|
2782
|
+
* @remarks
|
|
2783
|
+
* This constructor delegates to the parent AbstractDescriptionType whilst
|
|
2784
|
+
* identifying the element as 'briefdescription' for concise summary
|
|
2785
|
+
* content processing and documentation organisation.
|
|
2786
|
+
*/
|
|
1068
2787
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1069
2788
|
}
|
|
1070
2789
|
/**
|
|
1071
2790
|
* @public
|
|
1072
2791
|
*/
|
|
2792
|
+
/**
|
|
2793
|
+
* Data model for detailed description elements within documentation.
|
|
2794
|
+
*
|
|
2795
|
+
* @remarks
|
|
2796
|
+
* Represents detailed description elements that provide comprehensive
|
|
2797
|
+
* documentation content for entities. This implementation processes
|
|
2798
|
+
* Doxygen's detaileddescription elements, which contain extensive
|
|
2799
|
+
* descriptive content including paragraphs, sections, lists, and
|
|
2800
|
+
* other rich documentation structures.
|
|
2801
|
+
*
|
|
2802
|
+
* @public
|
|
2803
|
+
*/
|
|
1073
2804
|
export declare class DetailedDescriptionDataModel extends AbstractDescriptionType {
|
|
2805
|
+
/**
|
|
2806
|
+
* Constructs a DetailedDescriptionDataModel from XML element data.
|
|
2807
|
+
*
|
|
2808
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2809
|
+
* @param element - The XML element object containing the detailed
|
|
2810
|
+
* description data
|
|
2811
|
+
*
|
|
2812
|
+
* @remarks
|
|
2813
|
+
* This constructor delegates to the parent AbstractDescriptionType whilst
|
|
2814
|
+
* identifying the element as 'detaileddescription' for comprehensive
|
|
2815
|
+
* content processing and documentation organisation.
|
|
2816
|
+
*/
|
|
1074
2817
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1075
2818
|
}
|
|
1076
2819
|
/**
|
|
2820
|
+
* Data model for in-body description elements within documentation.
|
|
2821
|
+
*
|
|
2822
|
+
* @remarks
|
|
2823
|
+
* Represents in-body description elements that provide documentation
|
|
2824
|
+
* content embedded within source code bodies. This implementation
|
|
2825
|
+
* processes Doxygen's inbodydescription elements for documentation
|
|
2826
|
+
* that appears inline within code implementations.
|
|
2827
|
+
*
|
|
1077
2828
|
* @public
|
|
1078
2829
|
*/
|
|
1079
2830
|
export declare class InbodyDescriptionDataModel extends AbstractDescriptionType {
|
|
2831
|
+
/**
|
|
2832
|
+
* Constructs an InbodyDescriptionDataModel from XML element data.
|
|
2833
|
+
*
|
|
2834
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2835
|
+
* @param element - The XML element object containing the in-body
|
|
2836
|
+
* description data
|
|
2837
|
+
*
|
|
2838
|
+
* @remarks
|
|
2839
|
+
* This constructor delegates to the parent AbstractDescriptionType whilst
|
|
2840
|
+
* identifying the element as 'inbodydescription' for inline documentation
|
|
2841
|
+
* content processing within code implementations.
|
|
2842
|
+
*/
|
|
1080
2843
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1081
2844
|
}
|
|
1082
2845
|
/**
|
|
2846
|
+
* Data model for general description elements within documentation.
|
|
2847
|
+
*
|
|
2848
|
+
* @remarks
|
|
2849
|
+
* Represents general description elements that provide standard documentation
|
|
2850
|
+
* content for entities. This implementation processes Doxygen's description
|
|
2851
|
+
* elements, which contain descriptive content including paragraphs and
|
|
2852
|
+
* other documentation structures for general-purpose descriptions.
|
|
2853
|
+
*
|
|
1083
2854
|
* @public
|
|
1084
2855
|
*/
|
|
1085
2856
|
export declare class DescriptionDataModel extends AbstractDescriptionType {
|
|
2857
|
+
/**
|
|
2858
|
+
* Constructs a DescriptionDataModel from XML element data.
|
|
2859
|
+
*
|
|
2860
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2861
|
+
* @param element - The XML element object containing the description data
|
|
2862
|
+
*
|
|
2863
|
+
* @remarks
|
|
2864
|
+
* This constructor delegates to the parent AbstractDescriptionType whilst
|
|
2865
|
+
* identifying the element as 'description' for general-purpose description
|
|
2866
|
+
* content processing and documentation organisation.
|
|
2867
|
+
*/
|
|
1086
2868
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1087
2869
|
}
|
|
2870
|
+
/**
|
|
2871
|
+
* Data model for cross-reference description elements within documentation.
|
|
2872
|
+
*
|
|
2873
|
+
* @remarks
|
|
2874
|
+
* Represents cross-reference description elements that provide descriptive
|
|
2875
|
+
* content for cross-references and related sections. This implementation
|
|
2876
|
+
* processes Doxygen's xrefdescription elements for documentation content
|
|
2877
|
+
* associated with cross-reference sections and related material.
|
|
2878
|
+
*
|
|
2879
|
+
* @public
|
|
2880
|
+
*/
|
|
1088
2881
|
export declare class XrefDescriptionDataModel extends AbstractDescriptionType {
|
|
2882
|
+
/**
|
|
2883
|
+
* Constructs an XrefDescriptionDataModel from XML element data.
|
|
2884
|
+
*
|
|
2885
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2886
|
+
* @param element - The XML element object containing the cross-reference
|
|
2887
|
+
* description data
|
|
2888
|
+
*
|
|
2889
|
+
* @remarks
|
|
2890
|
+
* This constructor delegates to the parent AbstractDescriptionType whilst
|
|
2891
|
+
* identifying the element as 'xrefdescription' for cross-reference section
|
|
2892
|
+
* content processing and related documentation organisation.
|
|
2893
|
+
*/
|
|
1089
2894
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1090
2895
|
}
|
|
2896
|
+
/**
|
|
2897
|
+
* Data model for parameter description elements within documentation.
|
|
2898
|
+
*
|
|
2899
|
+
* @remarks
|
|
2900
|
+
* Represents parameter description elements that provide descriptive content
|
|
2901
|
+
* for function and method parameters. This implementation processes Doxygen's
|
|
2902
|
+
* parameterdescription elements for parameter documentation within parameter
|
|
2903
|
+
* lists and function descriptions.
|
|
2904
|
+
*
|
|
2905
|
+
* @public
|
|
2906
|
+
*/
|
|
1091
2907
|
export declare class ParameterDescriptionDataModel extends AbstractDescriptionType {
|
|
2908
|
+
/**
|
|
2909
|
+
* Constructs a ParameterDescriptionDataModel from XML element data.
|
|
2910
|
+
*
|
|
2911
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2912
|
+
* @param element - The XML element object containing the parameter
|
|
2913
|
+
* description data
|
|
2914
|
+
*
|
|
2915
|
+
* @remarks
|
|
2916
|
+
* This constructor delegates to the parent AbstractDescriptionType whilst
|
|
2917
|
+
* identifying the element as 'parameterdescription' for parameter-specific
|
|
2918
|
+
* documentation content processing within function documentation.
|
|
2919
|
+
*/
|
|
1092
2920
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1093
2921
|
}
|
|
2922
|
+
/**
|
|
2923
|
+
* Data model for internal documentation section elements.
|
|
2924
|
+
*
|
|
2925
|
+
* @remarks
|
|
2926
|
+
* Represents internal documentation sections that contain content marked
|
|
2927
|
+
* as internal or implementation-specific within documentation. This
|
|
2928
|
+
* implementation processes Doxygen's internal elements for organising
|
|
2929
|
+
* content that is typically hidden from public documentation views
|
|
2930
|
+
* but retained for developer reference.
|
|
2931
|
+
*
|
|
2932
|
+
* @public
|
|
2933
|
+
*/
|
|
1094
2934
|
export declare class InternalDataModel extends AbstractDocInternalType {
|
|
2935
|
+
/**
|
|
2936
|
+
* Constructs an InternalDataModel from XML element data.
|
|
2937
|
+
*
|
|
2938
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2939
|
+
* @param element - The XML element object containing the internal section
|
|
2940
|
+
* data
|
|
2941
|
+
*
|
|
2942
|
+
* @remarks
|
|
2943
|
+
* This constructor delegates to the parent AbstractDocInternalType to
|
|
2944
|
+
* handle internal section processing whilst identifying the element as
|
|
2945
|
+
* 'internal' for proper content organisation and visibility control.
|
|
2946
|
+
*/
|
|
1095
2947
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1096
2948
|
}
|
|
2949
|
+
/**
|
|
2950
|
+
* Data model for first-level internal documentation section elements.
|
|
2951
|
+
*
|
|
2952
|
+
* @remarks
|
|
2953
|
+
* Represents internal documentation sections at the first hierarchical level
|
|
2954
|
+
* within section structures. This implementation processes Doxygen's internal
|
|
2955
|
+
* elements that appear within first-level sections, providing organised
|
|
2956
|
+
* internal content that is typically excluded from public documentation.
|
|
2957
|
+
*
|
|
2958
|
+
* @public
|
|
2959
|
+
*/
|
|
1097
2960
|
export declare class InternalS1DataModel extends AbstractDocInternalS1Type {
|
|
2961
|
+
/**
|
|
2962
|
+
* Constructs an InternalS1DataModel from XML element data.
|
|
2963
|
+
*
|
|
2964
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2965
|
+
* @param element - The XML element object containing the internal S1
|
|
2966
|
+
* section data
|
|
2967
|
+
*
|
|
2968
|
+
* @remarks
|
|
2969
|
+
* This constructor delegates to the parent AbstractDocInternalS1Type whilst
|
|
2970
|
+
* identifying the element as 'internal' for first-level internal content.
|
|
2971
|
+
*/
|
|
1098
2972
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1099
2973
|
}
|
|
2974
|
+
/**
|
|
2975
|
+
* Data model for second-level internal documentation section elements.
|
|
2976
|
+
*
|
|
2977
|
+
* @remarks
|
|
2978
|
+
* Represents internal documentation sections at the second hierarchical level
|
|
2979
|
+
* within section structures. This implementation processes internal content
|
|
2980
|
+
* that appears within second-level sections for detailed internal documentation
|
|
2981
|
+
* organisation.
|
|
2982
|
+
*
|
|
2983
|
+
* @public
|
|
2984
|
+
*/
|
|
1100
2985
|
export declare class InternalS2DataModel extends AbstractDocInternalS2Type {
|
|
2986
|
+
/**
|
|
2987
|
+
* Constructs an InternalS2DataModel from XML element data.
|
|
2988
|
+
*
|
|
2989
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
2990
|
+
* @param element - The XML element object containing the internal S2
|
|
2991
|
+
* section data
|
|
2992
|
+
*
|
|
2993
|
+
* @remarks
|
|
2994
|
+
* This constructor delegates to the parent AbstractDocInternalS2Type whilst
|
|
2995
|
+
* identifying the element as 'internal' for second-level internal content.
|
|
2996
|
+
*/
|
|
1101
2997
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1102
2998
|
}
|
|
2999
|
+
/**
|
|
3000
|
+
* Data model for third-level internal documentation section elements.
|
|
3001
|
+
*
|
|
3002
|
+
* @remarks
|
|
3003
|
+
* Represents internal documentation sections at the third hierarchical level
|
|
3004
|
+
* for detailed internal content organisation within deeply nested section
|
|
3005
|
+
* structures.
|
|
3006
|
+
*
|
|
3007
|
+
* @public
|
|
3008
|
+
*/
|
|
1103
3009
|
export declare class InternalS3DataModel extends AbstractDocInternalS3Type {
|
|
3010
|
+
/**
|
|
3011
|
+
* Constructs an InternalS3DataModel from XML element data.
|
|
3012
|
+
*
|
|
3013
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3014
|
+
* @param element - The XML element object containing the internal S3
|
|
3015
|
+
* section data
|
|
3016
|
+
*
|
|
3017
|
+
* @remarks
|
|
3018
|
+
* This constructor delegates to the parent AbstractDocInternalS3Type whilst
|
|
3019
|
+
* identifying the element as 'internal' for third-level internal content.
|
|
3020
|
+
*/
|
|
1104
3021
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1105
3022
|
}
|
|
3023
|
+
/**
|
|
3024
|
+
* Data model for fourth-level internal documentation section elements.
|
|
3025
|
+
*
|
|
3026
|
+
* @remarks
|
|
3027
|
+
* Represents internal documentation sections at the fourth hierarchical level
|
|
3028
|
+
* for very detailed internal content organisation within deeply nested
|
|
3029
|
+
* documentation structures.
|
|
3030
|
+
*
|
|
3031
|
+
* @public
|
|
3032
|
+
*/
|
|
1106
3033
|
export declare class InternalS4DataModel extends AbstractDocInternalS4Type {
|
|
3034
|
+
/**
|
|
3035
|
+
* Constructs an InternalS4DataModel from XML element data.
|
|
3036
|
+
*
|
|
3037
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3038
|
+
* @param element - The XML element object containing the internal S4
|
|
3039
|
+
* section data
|
|
3040
|
+
*
|
|
3041
|
+
* @remarks
|
|
3042
|
+
* This constructor delegates to the parent AbstractDocInternalS4Type whilst
|
|
3043
|
+
* identifying the element as 'internal' for fourth-level internal content.
|
|
3044
|
+
*/
|
|
1107
3045
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1108
3046
|
}
|
|
3047
|
+
/**
|
|
3048
|
+
* Data model for fifth-level internal documentation section elements.
|
|
3049
|
+
*
|
|
3050
|
+
* @remarks
|
|
3051
|
+
* Represents internal documentation sections at the fifth hierarchical level
|
|
3052
|
+
* for extremely detailed internal content organisation within complex
|
|
3053
|
+
* documentation hierarchies.
|
|
3054
|
+
*
|
|
3055
|
+
* @public
|
|
3056
|
+
*/
|
|
1109
3057
|
export declare class InternalS5DataModel extends AbstractDocInternalS5Type {
|
|
3058
|
+
/**
|
|
3059
|
+
* Constructs an InternalS5DataModel from XML element data.
|
|
3060
|
+
*
|
|
3061
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3062
|
+
* @param element - The XML element object containing the internal S5
|
|
3063
|
+
* section data
|
|
3064
|
+
*
|
|
3065
|
+
* @remarks
|
|
3066
|
+
* This constructor delegates to the parent AbstractDocInternalS5Type whilst
|
|
3067
|
+
* identifying the element as 'internal' for fifth-level internal content.
|
|
3068
|
+
*/
|
|
1110
3069
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1111
3070
|
}
|
|
3071
|
+
/**
|
|
3072
|
+
* Data model for sixth-level internal documentation section elements.
|
|
3073
|
+
*
|
|
3074
|
+
* @remarks
|
|
3075
|
+
* Represents internal documentation sections at the deepest hierarchical level
|
|
3076
|
+
* supported by the schema for comprehensive internal content organisation
|
|
3077
|
+
* within complex documentation structures.
|
|
3078
|
+
*
|
|
3079
|
+
* @public
|
|
3080
|
+
*/
|
|
1112
3081
|
export declare class InternalS6DataModel extends AbstractDocInternalS6Type {
|
|
3082
|
+
/**
|
|
3083
|
+
* Constructs an InternalS6DataModel from XML element data.
|
|
3084
|
+
*
|
|
3085
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3086
|
+
* @param element - The XML element object containing the internal S6
|
|
3087
|
+
* section data
|
|
3088
|
+
*
|
|
3089
|
+
* @remarks
|
|
3090
|
+
* This constructor delegates to the parent AbstractDocInternalS6Type whilst
|
|
3091
|
+
* identifying the element as 'internal' for sixth-level internal content.
|
|
3092
|
+
*/
|
|
1113
3093
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1114
3094
|
}
|
|
3095
|
+
/**
|
|
3096
|
+
* Data model for first-level section elements within documentation.
|
|
3097
|
+
*
|
|
3098
|
+
* @remarks
|
|
3099
|
+
* Represents level-1 sections that form the primary organisational structure
|
|
3100
|
+
* within documentation descriptions. This implementation processes Doxygen's
|
|
3101
|
+
* sect1 elements, which contain titles, paragraphs, internal sections, and
|
|
3102
|
+
* nested level-2 sections, providing the foundation for hierarchical
|
|
3103
|
+
* documentation organisation.
|
|
3104
|
+
*
|
|
3105
|
+
* @public
|
|
3106
|
+
*/
|
|
1115
3107
|
export declare class Sect1DataModel extends AbstractDocSect1Type {
|
|
3108
|
+
/**
|
|
3109
|
+
* Constructs a Sect1DataModel from XML element data.
|
|
3110
|
+
*
|
|
3111
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3112
|
+
* @param element - The XML element object containing the sect1 data
|
|
3113
|
+
*
|
|
3114
|
+
* @remarks
|
|
3115
|
+
* This constructor delegates to the parent AbstractDocSect1Type to handle
|
|
3116
|
+
* the standard first-level section processing whilst specifically
|
|
3117
|
+
* identifying the element as a 'sect1' type for proper XML schema compliance.
|
|
3118
|
+
*/
|
|
1116
3119
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1117
3120
|
}
|
|
3121
|
+
/**
|
|
3122
|
+
* Data model for second-level section elements within documentation.
|
|
3123
|
+
*
|
|
3124
|
+
* @remarks
|
|
3125
|
+
* Represents level-2 sections that provide additional organisational depth
|
|
3126
|
+
* within first-level sections. This implementation processes Doxygen's
|
|
3127
|
+
* sect2 elements, which contain titles, paragraphs, internal sections, and
|
|
3128
|
+
* nested level-3 sections, enabling detailed content structuring within
|
|
3129
|
+
* the documentation hierarchy.
|
|
3130
|
+
*
|
|
3131
|
+
* @public
|
|
3132
|
+
*/
|
|
1118
3133
|
export declare class Sect2DataModel extends AbstractDocSect2Type {
|
|
3134
|
+
/**
|
|
3135
|
+
* Constructs a Sect2DataModel from XML element data.
|
|
3136
|
+
*
|
|
3137
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3138
|
+
* @param element - The XML element object containing the sect2 data
|
|
3139
|
+
*
|
|
3140
|
+
* @remarks
|
|
3141
|
+
* This constructor delegates to the parent AbstractDocSect2Type to handle
|
|
3142
|
+
* the standard second-level section processing whilst specifically
|
|
3143
|
+
* identifying the element as a 'sect2' type for proper XML schema compliance.
|
|
3144
|
+
*/
|
|
1119
3145
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1120
3146
|
}
|
|
3147
|
+
/**
|
|
3148
|
+
* Data model for third-level section elements within documentation.
|
|
3149
|
+
*
|
|
3150
|
+
* @remarks
|
|
3151
|
+
* Represents level-3 sections that provide detailed subsection organisation
|
|
3152
|
+
* within second-level sections. This implementation processes Doxygen's
|
|
3153
|
+
* sect3 elements for granular content structuring.
|
|
3154
|
+
*
|
|
3155
|
+
* @public
|
|
3156
|
+
*/
|
|
1121
3157
|
export declare class Sect3DataModel extends AbstractDocSect3Type {
|
|
3158
|
+
/**
|
|
3159
|
+
* Constructs a Sect3DataModel from XML element data.
|
|
3160
|
+
*
|
|
3161
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3162
|
+
* @param element - The XML element object containing the sect3 data
|
|
3163
|
+
*
|
|
3164
|
+
* @remarks
|
|
3165
|
+
* This constructor delegates to the parent AbstractDocSect3Type to handle
|
|
3166
|
+
* third-level section processing whilst identifying the element as 'sect3'.
|
|
3167
|
+
*/
|
|
1122
3168
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1123
3169
|
}
|
|
3170
|
+
/**
|
|
3171
|
+
* Data model for fourth-level section elements within documentation.
|
|
3172
|
+
*
|
|
3173
|
+
* @remarks
|
|
3174
|
+
* Represents level-4 sections for deep hierarchical content organisation.
|
|
3175
|
+
* This implementation processes Doxygen's sect4 elements within the
|
|
3176
|
+
* documentation structure hierarchy.
|
|
3177
|
+
*
|
|
3178
|
+
* @public
|
|
3179
|
+
*/
|
|
1124
3180
|
export declare class Sect4DataModel extends AbstractDocSect4Type {
|
|
3181
|
+
/**
|
|
3182
|
+
* Constructs a Sect4DataModel from XML element data.
|
|
3183
|
+
*
|
|
3184
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3185
|
+
* @param element - The XML element object containing the sect4 data
|
|
3186
|
+
*
|
|
3187
|
+
* @remarks
|
|
3188
|
+
* This constructor delegates to the parent AbstractDocSect4Type whilst
|
|
3189
|
+
* identifying the element as 'sect4' for schema compliance.
|
|
3190
|
+
*/
|
|
1125
3191
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1126
3192
|
}
|
|
3193
|
+
/**
|
|
3194
|
+
* Data model for fifth-level section elements within documentation.
|
|
3195
|
+
*
|
|
3196
|
+
* @remarks
|
|
3197
|
+
* Represents level-5 sections for very detailed content organisation.
|
|
3198
|
+
* This implementation processes Doxygen's sect5 elements within deeply
|
|
3199
|
+
* nested documentation structures.
|
|
3200
|
+
*
|
|
3201
|
+
* @public
|
|
3202
|
+
*/
|
|
1127
3203
|
export declare class Sect5DataModel extends AbstractDocSect5Type {
|
|
3204
|
+
/**
|
|
3205
|
+
* Constructs a Sect5DataModel from XML element data.
|
|
3206
|
+
*
|
|
3207
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3208
|
+
* @param element - The XML element object containing the sect5 data
|
|
3209
|
+
*
|
|
3210
|
+
* @remarks
|
|
3211
|
+
* This constructor delegates to the parent AbstractDocSect5Type whilst
|
|
3212
|
+
* identifying the element as 'sect5' for schema compliance.
|
|
3213
|
+
*/
|
|
1128
3214
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1129
3215
|
}
|
|
3216
|
+
/**
|
|
3217
|
+
* Data model for sixth-level section elements within documentation.
|
|
3218
|
+
*
|
|
3219
|
+
* @remarks
|
|
3220
|
+
* Represents the deepest level of section organisation supported by the
|
|
3221
|
+
* Doxygen schema. This implementation processes Doxygen's sect6 elements
|
|
3222
|
+
* for maximum hierarchical depth in documentation structures.
|
|
3223
|
+
*
|
|
3224
|
+
* @public
|
|
3225
|
+
*/
|
|
1130
3226
|
export declare class Sect6DataModel extends AbstractDocSect6Type {
|
|
3227
|
+
/**
|
|
3228
|
+
* Constructs a Sect6DataModel from XML element data.
|
|
3229
|
+
*
|
|
3230
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3231
|
+
* @param element - The XML element object containing the sect6 data
|
|
3232
|
+
*
|
|
3233
|
+
* @remarks
|
|
3234
|
+
* This constructor delegates to the parent AbstractDocSect6Type whilst
|
|
3235
|
+
* identifying the element as 'sect6' for schema compliance.
|
|
3236
|
+
*/
|
|
1131
3237
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1132
3238
|
}
|
|
3239
|
+
/**
|
|
3240
|
+
* Data model for title elements within documentation structures.
|
|
3241
|
+
*
|
|
3242
|
+
* @remarks
|
|
3243
|
+
* Represents title elements that provide descriptive headings for sections,
|
|
3244
|
+
* tables, figures, and other documentation components. This implementation
|
|
3245
|
+
* processes Doxygen's title elements, which support rich formatting and
|
|
3246
|
+
* mixed content to create informative and properly styled headings.
|
|
3247
|
+
*
|
|
3248
|
+
* @public
|
|
3249
|
+
*/
|
|
1133
3250
|
export declare class TitleDataModel extends AbstractDocTitleType {
|
|
3251
|
+
/**
|
|
3252
|
+
* Constructs a TitleDataModel from XML element data.
|
|
3253
|
+
*
|
|
3254
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3255
|
+
* @param element - The XML element object containing the title data
|
|
3256
|
+
*
|
|
3257
|
+
* @remarks
|
|
3258
|
+
* This constructor delegates to the parent AbstractDocTitleType to handle
|
|
3259
|
+
* title processing whilst identifying the element as 'title' for proper
|
|
3260
|
+
* XML schema compliance.
|
|
3261
|
+
*/
|
|
1134
3262
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1135
3263
|
}
|
|
3264
|
+
/**
|
|
3265
|
+
* Data model for term elements within definition lists.
|
|
3266
|
+
*
|
|
3267
|
+
* @remarks
|
|
3268
|
+
* Represents term elements that provide the definition term within variable
|
|
3269
|
+
* lists and definition structures. This implementation processes Doxygen's
|
|
3270
|
+
* term elements, which support formatted content for creating clear and
|
|
3271
|
+
* descriptive definition terms.
|
|
3272
|
+
*
|
|
3273
|
+
* @public
|
|
3274
|
+
*/
|
|
1136
3275
|
export declare class TermDataModel extends AbstractDocTitleType {
|
|
3276
|
+
/**
|
|
3277
|
+
* Constructs a TermDataModel from XML element data.
|
|
3278
|
+
*
|
|
3279
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3280
|
+
* @param element - The XML element object containing the term data
|
|
3281
|
+
*
|
|
3282
|
+
* @remarks
|
|
3283
|
+
* This constructor delegates to the parent AbstractDocTitleType to handle
|
|
3284
|
+
* term processing whilst identifying the element as 'term' for proper
|
|
3285
|
+
* XML schema compliance and definition list semantics.
|
|
3286
|
+
*/
|
|
1137
3287
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1138
3288
|
}
|
|
3289
|
+
/**
|
|
3290
|
+
* Data model for paragraph elements within documentation content.
|
|
3291
|
+
*
|
|
3292
|
+
* @remarks
|
|
3293
|
+
* Represents paragraph elements that form the fundamental content blocks
|
|
3294
|
+
* within documentation structures. This implementation processes Doxygen's
|
|
3295
|
+
* para elements, which contain rich mixed content including text, formatting,
|
|
3296
|
+
* cross-references, lists, tables, and other documentation elements.
|
|
3297
|
+
*
|
|
3298
|
+
* Paragraphs serve as the primary containers for narrative content within
|
|
3299
|
+
* descriptions, sections, and other documentation components.
|
|
3300
|
+
*
|
|
3301
|
+
* @public
|
|
3302
|
+
*/
|
|
1139
3303
|
export declare class ParaDataModel extends AbstractDocParaType {
|
|
3304
|
+
/**
|
|
3305
|
+
* Constructs a ParaDataModel from XML element data.
|
|
3306
|
+
*
|
|
3307
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3308
|
+
* @param element - The XML element object containing the paragraph data
|
|
3309
|
+
*
|
|
3310
|
+
* @remarks
|
|
3311
|
+
* This constructor delegates to the parent AbstractDocParaType to handle
|
|
3312
|
+
* comprehensive paragraph content processing whilst identifying the element
|
|
3313
|
+
* as 'para' for proper XML schema compliance and content organisation.
|
|
3314
|
+
*/
|
|
1140
3315
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1141
3316
|
}
|
|
3317
|
+
/**
|
|
3318
|
+
* Data model for bold text formatting within documentation content.
|
|
3319
|
+
*
|
|
3320
|
+
* @remarks
|
|
3321
|
+
* Represents bold markup elements that provide emphasis formatting for
|
|
3322
|
+
* text content within documentation. This implementation processes Doxygen's
|
|
3323
|
+
* bold elements, which can contain mixed content including text and other
|
|
3324
|
+
* inline formatting elements to create properly emphasised content.
|
|
3325
|
+
*
|
|
3326
|
+
* @public
|
|
3327
|
+
*/
|
|
1142
3328
|
export declare class BoldDataModel extends AbstractDocMarkupType {
|
|
3329
|
+
/**
|
|
3330
|
+
* Constructs a BoldDataModel from XML element data.
|
|
3331
|
+
*
|
|
3332
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3333
|
+
* @param element - The XML element object containing the bold markup data
|
|
3334
|
+
*
|
|
3335
|
+
* @remarks
|
|
3336
|
+
* This constructor delegates to the parent AbstractDocMarkupType to handle
|
|
3337
|
+
* markup processing whilst identifying the element as 'bold' for proper
|
|
3338
|
+
* XML schema compliance and text formatting.
|
|
3339
|
+
*/
|
|
1143
3340
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1144
3341
|
}
|
|
3342
|
+
/**
|
|
3343
|
+
* Data model for strikethrough text formatting within documentation content.
|
|
3344
|
+
*
|
|
3345
|
+
* @remarks
|
|
3346
|
+
* Represents strikethrough markup elements that provide strike-through
|
|
3347
|
+
* formatting for text content. This implementation processes Doxygen's
|
|
3348
|
+
* 's' elements for creating struck-through text within documentation.
|
|
3349
|
+
*
|
|
3350
|
+
* @public
|
|
3351
|
+
*/
|
|
1145
3352
|
export declare class SDataModel extends AbstractDocMarkupType {
|
|
3353
|
+
/**
|
|
3354
|
+
* Constructs an SDataModel from XML element data.
|
|
3355
|
+
*
|
|
3356
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3357
|
+
* @param element - The XML element object containing the strikethrough
|
|
3358
|
+
* markup data
|
|
3359
|
+
*
|
|
3360
|
+
* @remarks
|
|
3361
|
+
* This constructor delegates to the parent AbstractDocMarkupType whilst
|
|
3362
|
+
* identifying the element as 's' for proper strikethrough formatting.
|
|
3363
|
+
*/
|
|
1146
3364
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1147
3365
|
}
|
|
3366
|
+
/**
|
|
3367
|
+
* Data model for strike-through text formatting within documentation content.
|
|
3368
|
+
*
|
|
3369
|
+
* @remarks
|
|
3370
|
+
* Represents strike markup elements that provide explicit strike-through
|
|
3371
|
+
* formatting for text content. This implementation processes Doxygen's
|
|
3372
|
+
* strike elements for deprecated or crossed-out text within documentation.
|
|
3373
|
+
*
|
|
3374
|
+
* @public
|
|
3375
|
+
*/
|
|
1148
3376
|
export declare class StrikeDataModel extends AbstractDocMarkupType {
|
|
3377
|
+
/**
|
|
3378
|
+
* Constructs a StrikeDataModel from XML element data.
|
|
3379
|
+
*
|
|
3380
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3381
|
+
* @param element - The XML element object containing the strike markup data
|
|
3382
|
+
*
|
|
3383
|
+
* @remarks
|
|
3384
|
+
* This constructor delegates to the parent AbstractDocMarkupType whilst
|
|
3385
|
+
* identifying the element as 'strike' for explicit strike-through formatting.
|
|
3386
|
+
*/
|
|
1149
3387
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1150
3388
|
}
|
|
3389
|
+
/**
|
|
3390
|
+
* Data model for underlined text formatting within documentation content.
|
|
3391
|
+
*
|
|
3392
|
+
* @remarks
|
|
3393
|
+
* Represents underline markup elements that provide underline formatting
|
|
3394
|
+
* for text content within documentation. This implementation processes
|
|
3395
|
+
* Doxygen's underline elements for creating underlined text emphasis.
|
|
3396
|
+
*
|
|
3397
|
+
* @public
|
|
3398
|
+
*/
|
|
1151
3399
|
export declare class UnderlineDataModel extends AbstractDocMarkupType {
|
|
3400
|
+
/**
|
|
3401
|
+
* Constructs an UnderlineDataModel from XML element data.
|
|
3402
|
+
*
|
|
3403
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3404
|
+
* @param element - The XML element object containing the underline markup
|
|
3405
|
+
* data
|
|
3406
|
+
*
|
|
3407
|
+
* @remarks
|
|
3408
|
+
* This constructor delegates to the parent AbstractDocMarkupType whilst
|
|
3409
|
+
* identifying the element as 'underline' for proper underline formatting.
|
|
3410
|
+
*/
|
|
1152
3411
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1153
3412
|
}
|
|
3413
|
+
/**
|
|
3414
|
+
* Data model for emphasised text formatting within documentation content.
|
|
3415
|
+
*
|
|
3416
|
+
* @remarks
|
|
3417
|
+
* Represents emphasis markup elements that provide italicised formatting
|
|
3418
|
+
* for text content within documentation. This implementation processes
|
|
3419
|
+
* Doxygen's emphasis elements for creating emphasised text, typically
|
|
3420
|
+
* rendered in italics to provide subtle content highlighting.
|
|
3421
|
+
*
|
|
3422
|
+
* @public
|
|
3423
|
+
*/
|
|
1154
3424
|
export declare class EmphasisDataModel extends AbstractDocMarkupType {
|
|
3425
|
+
/**
|
|
3426
|
+
* Constructs an EmphasisDataModel from XML element data.
|
|
3427
|
+
*
|
|
3428
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3429
|
+
* @param element - The XML element object containing the emphasis markup data
|
|
3430
|
+
*
|
|
3431
|
+
* @remarks
|
|
3432
|
+
* This constructor delegates to the parent AbstractDocMarkupType whilst
|
|
3433
|
+
* identifying the element as 'emphasis' for proper italicised formatting.
|
|
3434
|
+
*/
|
|
1155
3435
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1156
3436
|
}
|
|
3437
|
+
/**
|
|
3438
|
+
* Data model for computer output text formatting within documentation content.
|
|
3439
|
+
*
|
|
3440
|
+
* @remarks
|
|
3441
|
+
* Represents computer output markup elements that provide monospace formatting
|
|
3442
|
+
* for code, filenames, and computer-generated text within documentation.
|
|
3443
|
+
* This implementation processes Doxygen's computeroutput elements for
|
|
3444
|
+
* displaying code fragments and technical terms in monospace font.
|
|
3445
|
+
*
|
|
3446
|
+
* @public
|
|
3447
|
+
*/
|
|
1157
3448
|
export declare class ComputerOutputDataModel extends AbstractDocMarkupType {
|
|
3449
|
+
/**
|
|
3450
|
+
* Constructs a ComputerOutputDataModel from XML element data.
|
|
3451
|
+
*
|
|
3452
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3453
|
+
* @param element - The XML element object containing the computer output
|
|
3454
|
+
* markup data
|
|
3455
|
+
*
|
|
3456
|
+
* @remarks
|
|
3457
|
+
* This constructor delegates to the parent AbstractDocMarkupType whilst
|
|
3458
|
+
* identifying the element as 'computeroutput' for monospace formatting.
|
|
3459
|
+
*/
|
|
1158
3460
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1159
3461
|
}
|
|
3462
|
+
/**
|
|
3463
|
+
* Data model for subscript text formatting within documentation content.
|
|
3464
|
+
*
|
|
3465
|
+
* @remarks
|
|
3466
|
+
* Represents subscript markup elements that provide subscript formatting
|
|
3467
|
+
* for mathematical expressions and chemical formulae within documentation.
|
|
3468
|
+
* This implementation processes Doxygen's subscript elements for proper
|
|
3469
|
+
* scientific notation display.
|
|
3470
|
+
*
|
|
3471
|
+
* @public
|
|
3472
|
+
*/
|
|
1160
3473
|
export declare class SubscriptDataModel extends AbstractDocMarkupType {
|
|
3474
|
+
/**
|
|
3475
|
+
* Constructs a SubscriptDataModel from XML element data.
|
|
3476
|
+
*
|
|
3477
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3478
|
+
* @param element - The XML element object containing the subscript markup
|
|
3479
|
+
* data
|
|
3480
|
+
*
|
|
3481
|
+
* @remarks
|
|
3482
|
+
* This constructor delegates to the parent AbstractDocMarkupType whilst
|
|
3483
|
+
* identifying the element as 'subscript' for proper subscript formatting.
|
|
3484
|
+
*/
|
|
1161
3485
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1162
3486
|
}
|
|
3487
|
+
/**
|
|
3488
|
+
* Data model for superscript text formatting within documentation content.
|
|
3489
|
+
*
|
|
3490
|
+
* @remarks
|
|
3491
|
+
* Represents superscript markup elements that provide superscript formatting
|
|
3492
|
+
* for mathematical expressions, footnotes, and ordinal numbers within
|
|
3493
|
+
* documentation. This implementation processes Doxygen's superscript elements
|
|
3494
|
+
* for proper scientific and mathematical notation display.
|
|
3495
|
+
*
|
|
3496
|
+
* @public
|
|
3497
|
+
*/
|
|
1163
3498
|
export declare class SuperscriptDataModel extends AbstractDocMarkupType {
|
|
3499
|
+
/**
|
|
3500
|
+
* Constructs a SuperscriptDataModel from XML element data.
|
|
3501
|
+
*
|
|
3502
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3503
|
+
* @param element - The XML element object containing the superscript
|
|
3504
|
+
* markup data
|
|
3505
|
+
*
|
|
3506
|
+
* @remarks
|
|
3507
|
+
* This constructor delegates to the parent AbstractDocMarkupType whilst
|
|
3508
|
+
* identifying the element as 'superscript' for proper superscript formatting.
|
|
3509
|
+
*/
|
|
1164
3510
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1165
3511
|
}
|
|
3512
|
+
/**
|
|
3513
|
+
* Data model for centred text formatting within documentation content.
|
|
3514
|
+
*
|
|
3515
|
+
* @remarks
|
|
3516
|
+
* Represents centre alignment markup elements that provide centred formatting
|
|
3517
|
+
* for text content within documentation. This implementation processes
|
|
3518
|
+
* Doxygen's center elements for creating centred text blocks and headings.
|
|
3519
|
+
*
|
|
3520
|
+
* @public
|
|
3521
|
+
*/
|
|
1166
3522
|
export declare class CenterDataModel extends AbstractDocMarkupType {
|
|
3523
|
+
/**
|
|
3524
|
+
* Constructs a CenterDataModel from XML element data.
|
|
3525
|
+
*
|
|
3526
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3527
|
+
* @param element - The XML element object containing the centre markup data
|
|
3528
|
+
*
|
|
3529
|
+
* @remarks
|
|
3530
|
+
* This constructor delegates to the parent AbstractDocMarkupType whilst
|
|
3531
|
+
* identifying the element as 'center' for proper centred alignment.
|
|
3532
|
+
*/
|
|
1167
3533
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1168
3534
|
}
|
|
3535
|
+
/**
|
|
3536
|
+
* Data model for small text formatting within documentation content.
|
|
3537
|
+
*
|
|
3538
|
+
* @remarks
|
|
3539
|
+
* Represents small text markup elements that provide reduced font size
|
|
3540
|
+
* formatting for fine print, footnotes, and secondary information within
|
|
3541
|
+
* documentation. This implementation processes Doxygen's small elements
|
|
3542
|
+
* for creating properly sized text content.
|
|
3543
|
+
*
|
|
3544
|
+
* @public
|
|
3545
|
+
*/
|
|
1169
3546
|
export declare class SmallDataModel extends AbstractDocMarkupType {
|
|
3547
|
+
/**
|
|
3548
|
+
* Constructs a SmallDataModel from XML element data.
|
|
3549
|
+
*
|
|
3550
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3551
|
+
* @param element - The XML element object containing the small text
|
|
3552
|
+
* markup data
|
|
3553
|
+
*
|
|
3554
|
+
* @remarks
|
|
3555
|
+
* This constructor delegates to the parent AbstractDocMarkupType whilst
|
|
3556
|
+
* identifying the element as 'small' for reduced font size formatting.
|
|
3557
|
+
*/
|
|
1170
3558
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1171
3559
|
}
|
|
3560
|
+
/**
|
|
3561
|
+
* Data model for citation text formatting within documentation content.
|
|
3562
|
+
*
|
|
3563
|
+
* @remarks
|
|
3564
|
+
* Represents citation markup elements that provide proper formatting for
|
|
3565
|
+
* bibliographic references and citations within documentation. This
|
|
3566
|
+
* implementation processes Doxygen's cite elements for creating properly
|
|
3567
|
+
* formatted citation references.
|
|
3568
|
+
*
|
|
3569
|
+
* @public
|
|
3570
|
+
*/
|
|
1172
3571
|
export declare class CiteDataModel extends AbstractDocMarkupType {
|
|
3572
|
+
/**
|
|
3573
|
+
* Constructs a CiteDataModel from XML element data.
|
|
3574
|
+
*
|
|
3575
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3576
|
+
* @param element - The XML element object containing the citation markup data
|
|
3577
|
+
*
|
|
3578
|
+
* @remarks
|
|
3579
|
+
* This constructor delegates to the parent AbstractDocMarkupType whilst
|
|
3580
|
+
* identifying the element as 'cite' for proper citation formatting.
|
|
3581
|
+
*/
|
|
1173
3582
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1174
3583
|
}
|
|
3584
|
+
/**
|
|
3585
|
+
* Data model for deleted text formatting within documentation content.
|
|
3586
|
+
*
|
|
3587
|
+
* @remarks
|
|
3588
|
+
* Represents deleted text markup elements that indicate content removal
|
|
3589
|
+
* or deprecation within documentation. This implementation processes
|
|
3590
|
+
* Doxygen's del elements for marking text as deleted or removed.
|
|
3591
|
+
*
|
|
3592
|
+
* @public
|
|
3593
|
+
*/
|
|
1175
3594
|
export declare class DelDataModel extends AbstractDocMarkupType {
|
|
3595
|
+
/**
|
|
3596
|
+
* Constructs a DelDataModel from XML element data.
|
|
3597
|
+
*
|
|
3598
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3599
|
+
* @param element - The XML element object containing the deleted text
|
|
3600
|
+
* markup data
|
|
3601
|
+
*
|
|
3602
|
+
* @remarks
|
|
3603
|
+
* This constructor delegates to the parent AbstractDocMarkupType whilst
|
|
3604
|
+
* identifying the element as 'del' for deleted text formatting.
|
|
3605
|
+
*/
|
|
1176
3606
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1177
3607
|
}
|
|
3608
|
+
/**
|
|
3609
|
+
* Data model for inserted text formatting within documentation content.
|
|
3610
|
+
*
|
|
3611
|
+
* @remarks
|
|
3612
|
+
* Represents inserted text markup elements that indicate content addition
|
|
3613
|
+
* or new material within documentation. This implementation processes
|
|
3614
|
+
* Doxygen's ins elements for marking text as newly inserted or added.
|
|
3615
|
+
*
|
|
3616
|
+
* @public
|
|
3617
|
+
*/
|
|
1178
3618
|
export declare class InsDataModel extends AbstractDocMarkupType {
|
|
3619
|
+
/**
|
|
3620
|
+
* Constructs an InsDataModel from XML element data.
|
|
3621
|
+
*
|
|
3622
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3623
|
+
* @param element - The XML element object containing the inserted text
|
|
3624
|
+
* markup data
|
|
3625
|
+
*
|
|
3626
|
+
* @remarks
|
|
3627
|
+
* This constructor delegates to the parent AbstractDocMarkupType whilst
|
|
3628
|
+
* identifying the element as 'ins' for inserted text formatting.
|
|
3629
|
+
*/
|
|
1179
3630
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1180
3631
|
}
|
|
3632
|
+
/**
|
|
3633
|
+
* Data model for simple section elements within documentation.
|
|
3634
|
+
*
|
|
3635
|
+
* @remarks
|
|
3636
|
+
* Represents simple sections that provide structured content organisation
|
|
3637
|
+
* with specific section types such as 'note', 'warning', 'see', 'return',
|
|
3638
|
+
* and others. This implementation processes Doxygen's simplesect elements,
|
|
3639
|
+
* which contain typed content blocks for common documentation patterns
|
|
3640
|
+
* like notes, warnings, and cross-references.
|
|
3641
|
+
*
|
|
3642
|
+
* @public
|
|
3643
|
+
*/
|
|
1181
3644
|
export declare class SimpleSectDataModel extends AbstractDocSimpleSectType {
|
|
3645
|
+
/**
|
|
3646
|
+
* Constructs a SimpleSectDataModel from XML element data.
|
|
3647
|
+
*
|
|
3648
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3649
|
+
* @param element - The XML element object containing the simplesect data
|
|
3650
|
+
*
|
|
3651
|
+
* @remarks
|
|
3652
|
+
* This constructor delegates to the parent AbstractDocSimpleSectType to
|
|
3653
|
+
* handle simple section processing whilst identifying the element as
|
|
3654
|
+
* 'simplesect' for proper XML schema compliance and section type handling.
|
|
3655
|
+
*/
|
|
1182
3656
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1183
3657
|
}
|
|
3658
|
+
/**
|
|
3659
|
+
* Data model for itemised list elements within documentation content.
|
|
3660
|
+
*
|
|
3661
|
+
* @remarks
|
|
3662
|
+
* Represents itemised (bulleted) list elements that provide unordered list
|
|
3663
|
+
* structures within documentation. This implementation processes Doxygen's
|
|
3664
|
+
* itemizedlist elements, which contain list items for creating bulleted
|
|
3665
|
+
* lists with various marker styles and nested list support.
|
|
3666
|
+
*
|
|
3667
|
+
* @public
|
|
3668
|
+
*/
|
|
1184
3669
|
export declare class ItemizedListDataModel extends AbstractDocListType {
|
|
3670
|
+
/**
|
|
3671
|
+
* Constructs an ItemizedListDataModel from XML element data.
|
|
3672
|
+
*
|
|
3673
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3674
|
+
* @param element - The XML element object containing the itemised list data
|
|
3675
|
+
*
|
|
3676
|
+
* @remarks
|
|
3677
|
+
* This constructor delegates to the parent AbstractDocListType to handle
|
|
3678
|
+
* list processing whilst identifying the element as 'itemizedlist' for
|
|
3679
|
+
* proper bulleted list formatting and structure.
|
|
3680
|
+
*/
|
|
1185
3681
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1186
3682
|
}
|
|
3683
|
+
/**
|
|
3684
|
+
* Data model for ordered list elements within documentation content.
|
|
3685
|
+
*
|
|
3686
|
+
* @remarks
|
|
3687
|
+
* Represents ordered (numbered) list elements that provide sequential list
|
|
3688
|
+
* structures within documentation. This implementation processes Doxygen's
|
|
3689
|
+
* orderedlist elements, which contain list items for creating numbered
|
|
3690
|
+
* lists with various numbering styles and nested list support.
|
|
3691
|
+
*
|
|
3692
|
+
* @public
|
|
3693
|
+
*/
|
|
1187
3694
|
export declare class OrderedListDataModel extends AbstractDocListType {
|
|
3695
|
+
/**
|
|
3696
|
+
* Constructs an OrderedListDataModel from XML element data.
|
|
3697
|
+
*
|
|
3698
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3699
|
+
* @param element - The XML element object containing the ordered list data
|
|
3700
|
+
*
|
|
3701
|
+
* @remarks
|
|
3702
|
+
* This constructor delegates to the parent AbstractDocListType to handle
|
|
3703
|
+
* list processing whilst identifying the element as 'orderedlist' for
|
|
3704
|
+
* proper numbered list formatting and structure.
|
|
3705
|
+
*/
|
|
1188
3706
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1189
3707
|
}
|
|
3708
|
+
/**
|
|
3709
|
+
* Data model for line break elements within documentation content.
|
|
3710
|
+
*
|
|
3711
|
+
* @remarks
|
|
3712
|
+
* Represents line break elements that provide explicit line breaks within
|
|
3713
|
+
* documentation text. This implementation processes Doxygen's linebreak
|
|
3714
|
+
* elements for controlling line spacing and text flow within content blocks.
|
|
3715
|
+
*
|
|
3716
|
+
* @public
|
|
3717
|
+
*/
|
|
1190
3718
|
export declare class LineBreakDataModel extends AbstractDocEmptyType {
|
|
3719
|
+
/**
|
|
3720
|
+
* Constructs a LineBreakDataModel from XML element data.
|
|
3721
|
+
*
|
|
3722
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3723
|
+
* @param element - The XML element object containing the line break data
|
|
3724
|
+
*
|
|
3725
|
+
* @remarks
|
|
3726
|
+
* This constructor delegates to the parent AbstractDocEmptyType whilst
|
|
3727
|
+
* identifying the element as 'linebreak' for proper line break handling.
|
|
3728
|
+
*/
|
|
1191
3729
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1192
3730
|
}
|
|
3731
|
+
/**
|
|
3732
|
+
* Data model for horizontal ruler elements within documentation content.
|
|
3733
|
+
*
|
|
3734
|
+
* @remarks
|
|
3735
|
+
* Represents horizontal ruler elements that provide visual separation
|
|
3736
|
+
* between content sections. This implementation processes Doxygen's
|
|
3737
|
+
* hruler elements for creating horizontal dividing lines within documentation.
|
|
3738
|
+
*
|
|
3739
|
+
* @public
|
|
3740
|
+
*/
|
|
1193
3741
|
export declare class HrulerDataModel extends AbstractDocEmptyType {
|
|
3742
|
+
/**
|
|
3743
|
+
* Constructs an HrulerDataModel from XML element data.
|
|
3744
|
+
*
|
|
3745
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3746
|
+
* @param element - The XML element object containing the horizontal ruler
|
|
3747
|
+
* data
|
|
3748
|
+
*
|
|
3749
|
+
* @remarks
|
|
3750
|
+
* This constructor delegates to the parent AbstractDocEmptyType whilst
|
|
3751
|
+
* identifying the element as 'hruler' for proper horizontal line formatting.
|
|
3752
|
+
*/
|
|
1194
3753
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1195
3754
|
}
|
|
3755
|
+
/**
|
|
3756
|
+
* Data model for non-breakable space elements within documentation content.
|
|
3757
|
+
*
|
|
3758
|
+
* @remarks
|
|
3759
|
+
* Represents non-breakable space elements that provide control over text
|
|
3760
|
+
* wrapping and spacing within documentation. This implementation processes
|
|
3761
|
+
* Doxygen's nonbreakablespace elements for maintaining text cohesion
|
|
3762
|
+
* across line breaks.
|
|
3763
|
+
*
|
|
3764
|
+
* @public
|
|
3765
|
+
*/
|
|
1196
3766
|
export declare class NonBreakableSpaceDataModel extends AbstractDocEmptyType {
|
|
3767
|
+
/**
|
|
3768
|
+
* Constructs a NonBreakableSpaceDataModel from XML element data.
|
|
3769
|
+
*
|
|
3770
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3771
|
+
* @param element - The XML element object containing the non-breakable
|
|
3772
|
+
* space data
|
|
3773
|
+
*
|
|
3774
|
+
* @remarks
|
|
3775
|
+
* This constructor delegates to the parent AbstractDocEmptyType whilst
|
|
3776
|
+
* identifying the element as 'nonbreakablespace' for proper space handling.
|
|
3777
|
+
*/
|
|
1197
3778
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1198
3779
|
}
|
|
3780
|
+
/**
|
|
3781
|
+
* Data model for empty paragraph elements within documentation content.
|
|
3782
|
+
*
|
|
3783
|
+
* @remarks
|
|
3784
|
+
* Represents empty paragraph elements used as placeholders or structural
|
|
3785
|
+
* markers within documentation. This implementation processes Doxygen's
|
|
3786
|
+
* empty para elements, which serve as document structure indicators
|
|
3787
|
+
* without containing content.
|
|
3788
|
+
*
|
|
3789
|
+
* @public
|
|
3790
|
+
*/
|
|
1199
3791
|
export declare class ParaEmptyDataModel extends AbstractDocEmptyType {
|
|
3792
|
+
/**
|
|
3793
|
+
* Constructs a ParaEmptyDataModel from XML element data.
|
|
3794
|
+
*
|
|
3795
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3796
|
+
* @param element - The XML element object containing the empty paragraph data
|
|
3797
|
+
*
|
|
3798
|
+
* @remarks
|
|
3799
|
+
* This constructor delegates to the parent AbstractDocEmptyType whilst
|
|
3800
|
+
* identifying the element as 'para' for empty paragraph structure handling.
|
|
3801
|
+
*/
|
|
1200
3802
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1201
3803
|
}
|
|
3804
|
+
/**
|
|
3805
|
+
* Abstract base class for verbatim text elements within documentation content.
|
|
3806
|
+
*
|
|
3807
|
+
* @remarks
|
|
3808
|
+
* Implements processing for verbatim content elements that preserve exact
|
|
3809
|
+
* formatting and whitespace within documentation. This class handles
|
|
3810
|
+
* elements that contain literal text content, such as code blocks and
|
|
3811
|
+
* preformatted text, whilst maintaining their original formatting and
|
|
3812
|
+
* character sequences.
|
|
3813
|
+
*
|
|
3814
|
+
* The implementation processes both textual content and structured markup
|
|
3815
|
+
* elements that may appear within verbatim contexts, ensuring proper
|
|
3816
|
+
* preservation of the intended display format.
|
|
3817
|
+
*
|
|
3818
|
+
* @public
|
|
3819
|
+
*/
|
|
1202
3820
|
export declare abstract class AbstractVerbatimType extends AbstractDataModelBase {
|
|
3821
|
+
/**
|
|
3822
|
+
* Constructs an AbstractVerbatimType instance from XML element data.
|
|
3823
|
+
*
|
|
3824
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3825
|
+
* @param element - The XML element object containing the verbatim data
|
|
3826
|
+
* @param elementName - The name of the XML element being processed
|
|
3827
|
+
*
|
|
3828
|
+
* @remarks
|
|
3829
|
+
* This constructor processes verbatim elements by extracting both textual
|
|
3830
|
+
* content and any embedded markup elements. The parser maintains proper
|
|
3831
|
+
* content order whilst preserving the original formatting and whitespace
|
|
3832
|
+
* characteristics of the verbatim content.
|
|
3833
|
+
*/
|
|
1203
3834
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
1204
3835
|
}
|
|
3836
|
+
/**
|
|
3837
|
+
* Data model for verbatim text elements within documentation content.
|
|
3838
|
+
*
|
|
3839
|
+
* @remarks
|
|
3840
|
+
* Represents verbatim text elements that preserve exact formatting and
|
|
3841
|
+
* whitespace for code blocks, examples, and literal text within documentation.
|
|
3842
|
+
* This implementation processes Doxygen's verbatim elements, which maintain
|
|
3843
|
+
* precise character sequences and formatting whilst potentially containing
|
|
3844
|
+
* cross-references and other markup elements.
|
|
3845
|
+
*
|
|
3846
|
+
* @public
|
|
3847
|
+
*/
|
|
1205
3848
|
export declare class VerbatimDataModel extends AbstractVerbatimType {
|
|
3849
|
+
/**
|
|
3850
|
+
* Constructs a VerbatimDataModel from XML element data.
|
|
3851
|
+
*
|
|
3852
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3853
|
+
* @param element - The XML element object containing the verbatim data
|
|
3854
|
+
*
|
|
3855
|
+
* @remarks
|
|
3856
|
+
* This constructor delegates to the parent AbstractVerbatimType to handle
|
|
3857
|
+
* verbatim content processing whilst identifying the element as 'verbatim'
|
|
3858
|
+
* for proper literal text preservation and formatting.
|
|
3859
|
+
*/
|
|
1206
3860
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1207
3861
|
}
|
|
3862
|
+
/**
|
|
3863
|
+
* Abstract base class for preformatted content elements within documentation.
|
|
3864
|
+
*
|
|
3865
|
+
* @remarks
|
|
3866
|
+
* Implements processing for preformatted content elements that maintain
|
|
3867
|
+
* specific formatting while supporting embedded markup elements. This class
|
|
3868
|
+
* handles elements that preserve whitespace and formatting whilst allowing
|
|
3869
|
+
* for structured content including cross-references and formatting markup.
|
|
3870
|
+
*
|
|
3871
|
+
* The implementation processes both textual content and document command
|
|
3872
|
+
* group elements that may appear within preformatted contexts, ensuring
|
|
3873
|
+
* proper content organisation and formatting preservation.
|
|
3874
|
+
*
|
|
3875
|
+
* @public
|
|
3876
|
+
*/
|
|
1208
3877
|
export declare abstract class AbstractPreformattedType extends AbstractDataModelBase {
|
|
3878
|
+
/**
|
|
3879
|
+
* Constructs an AbstractPreformattedType instance from XML element data.
|
|
3880
|
+
*
|
|
3881
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3882
|
+
* @param element - The XML element object containing the preformatted data
|
|
3883
|
+
* @param elementName - The name of the XML element being processed
|
|
3884
|
+
*
|
|
3885
|
+
* @remarks
|
|
3886
|
+
* This constructor processes preformatted elements by extracting both
|
|
3887
|
+
* textual content and structured command group elements. The parser
|
|
3888
|
+
* maintains proper content order whilst preserving formatting characteristics
|
|
3889
|
+
* and enabling embedded markup within preformatted contexts.
|
|
3890
|
+
*/
|
|
1209
3891
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
1210
3892
|
}
|
|
3893
|
+
/**
|
|
3894
|
+
* Data model for preformatted content elements within documentation.
|
|
3895
|
+
*
|
|
3896
|
+
* @remarks
|
|
3897
|
+
* Represents preformatted content elements that preserve formatting while
|
|
3898
|
+
* supporting embedded markup elements. This implementation processes
|
|
3899
|
+
* Doxygen's preformatted elements, which maintain whitespace and formatting
|
|
3900
|
+
* whilst allowing for structured content including cross-references and
|
|
3901
|
+
* other documentation markup.
|
|
3902
|
+
*
|
|
3903
|
+
* @public
|
|
3904
|
+
*/
|
|
1211
3905
|
export declare class PreformattedDataModel extends AbstractPreformattedType {
|
|
3906
|
+
/**
|
|
3907
|
+
* Constructs a PreformattedDataModel from XML element data.
|
|
3908
|
+
*
|
|
3909
|
+
* @param xml - The Doxygen XML parser instance for processing XML content
|
|
3910
|
+
* @param element - The XML element object containing the preformatted data
|
|
3911
|
+
*
|
|
3912
|
+
* @remarks
|
|
3913
|
+
* This constructor delegates to the parent AbstractPreformattedType to
|
|
3914
|
+
* handle preformatted content processing whilst identifying the element
|
|
3915
|
+
* as 'preformatted' for proper formatting preservation and markup support.
|
|
3916
|
+
*/
|
|
1212
3917
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
1213
3918
|
}
|
|
1214
3919
|
//# sourceMappingURL=descriptiontype-dm.d.ts.map
|