@xpack/doxygen2docusaurus 1.1.0 → 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 -3
- package/dist/cli/main.d.ts +6 -0
- package/dist/cli/main.d.ts.map +1 -1
- package/dist/cli/main.js +7 -1
- package/dist/cli/main.js.map +1 -1
- package/dist/docusaurus/cli-options.d.ts +266 -38
- package/dist/docusaurus/cli-options.d.ts.map +1 -1
- package/dist/docusaurus/cli-options.js +252 -43
- 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 +3675 -48
- package/package.json +9 -6
- /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
|
@@ -9,6 +9,18 @@ import { LocationDataModel } from './locationtype-dm.js';
|
|
|
9
9
|
import { AbstractDataModelBase } from '../types.js';
|
|
10
10
|
import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
|
|
11
11
|
import { TableOfContentsDataModel } from './tableofcontentstype-dm.js';
|
|
12
|
+
/**
|
|
13
|
+
* Abstract template class for creating new data model objects.
|
|
14
|
+
*
|
|
15
|
+
* @remarks
|
|
16
|
+
* This template provides a standardised structure for implementing new
|
|
17
|
+
* data model types with common properties and processing patterns. It
|
|
18
|
+
* demonstrates the typical XML parsing approach used throughout the
|
|
19
|
+
* Doxygen data model implementation, including element and attribute
|
|
20
|
+
* processing workflows.
|
|
21
|
+
*
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
12
24
|
export declare abstract class AbstractXyzType extends AbstractDataModelBase {
|
|
13
25
|
text: string;
|
|
14
26
|
compoundName: string;
|
|
@@ -26,72 +38,545 @@ export declare abstract class AbstractXyzType extends AbstractDataModelBase {
|
|
|
26
38
|
final?: boolean | undefined;
|
|
27
39
|
lineno?: number | undefined;
|
|
28
40
|
attr23?: string[] | undefined;
|
|
41
|
+
/**
|
|
42
|
+
* Constructs a new template data model instance.
|
|
43
|
+
*
|
|
44
|
+
* @remarks
|
|
45
|
+
* Demonstrates the standard XML parsing workflow used throughout the
|
|
46
|
+
* data model implementation. This includes processing inner elements,
|
|
47
|
+
* handling mixed content with ordered children, and extracting attributes
|
|
48
|
+
* with appropriate type conversion and validation.
|
|
49
|
+
*
|
|
50
|
+
* @param xml - The XML parser instance for processing elements
|
|
51
|
+
* @param element - The XML element object to parse
|
|
52
|
+
* @param elementName - The name of the XML element being processed
|
|
53
|
+
*/
|
|
29
54
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
30
55
|
}
|
|
56
|
+
/**
|
|
57
|
+
* Concrete implementation of the template data model.
|
|
58
|
+
*
|
|
59
|
+
* @remarks
|
|
60
|
+
* Provides a specific implementation of the abstract template class,
|
|
61
|
+
* demonstrating how to create concrete data model objects for particular
|
|
62
|
+
* XML element types. This pattern is used throughout the data model
|
|
63
|
+
* for creating type-specific implementations.
|
|
64
|
+
*
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
31
67
|
export declare class XyzDataModel extends AbstractXyzType {
|
|
68
|
+
/**
|
|
69
|
+
* Constructs a new XyzDataModel instance.
|
|
70
|
+
*
|
|
71
|
+
* @remarks
|
|
72
|
+
* Creates a data model object for 'xyz' XML elements by delegating
|
|
73
|
+
* to the parent constructor with the appropriate element name.
|
|
74
|
+
*
|
|
75
|
+
* @param xml - The XML parser instance for processing elements
|
|
76
|
+
* @param element - The XML element object to parse
|
|
77
|
+
*/
|
|
32
78
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
33
79
|
}
|
|
34
80
|
/**
|
|
81
|
+
* Abstract base class for Doxygen compound definition data models.
|
|
82
|
+
*
|
|
83
|
+
* @remarks
|
|
84
|
+
* Represents the core structure of compound definitions in Doxygen XML output,
|
|
85
|
+
* including classes, structures, files, namespaces, and other compound types.
|
|
86
|
+
* This class handles the complete XML schema for compound definitions with
|
|
87
|
+
* comprehensive element and attribute processing to capture all aspects of
|
|
88
|
+
* the documented code structures.
|
|
89
|
+
*
|
|
35
90
|
* @public
|
|
36
91
|
*/
|
|
37
92
|
export declare abstract class AbstractCompoundDefType extends AbstractDataModelBase {
|
|
93
|
+
/**
|
|
94
|
+
* The name of the compound element.
|
|
95
|
+
*
|
|
96
|
+
* @remarks
|
|
97
|
+
* Contains the fully qualified name of the compound (class, namespace,
|
|
98
|
+
* file, etc.) as extracted from the 'compoundname' XML element. This
|
|
99
|
+
* represents the primary identifier for the compound in the documentation
|
|
100
|
+
* hierarchy and is mandatory for all compound types except namespaces.
|
|
101
|
+
*/
|
|
38
102
|
compoundName: string;
|
|
103
|
+
/**
|
|
104
|
+
* Optional title for the compound.
|
|
105
|
+
*
|
|
106
|
+
* @remarks
|
|
107
|
+
* Provides a human-readable title for the compound that may differ from
|
|
108
|
+
* the compound name. This is typically used for pages and groups where
|
|
109
|
+
* a descriptive title is more appropriate than the technical identifier.
|
|
110
|
+
*/
|
|
39
111
|
title?: string | undefined;
|
|
112
|
+
/**
|
|
113
|
+
* Brief description of the compound.
|
|
114
|
+
*
|
|
115
|
+
* @remarks
|
|
116
|
+
* Contains a concise summary description of the compound extracted from
|
|
117
|
+
* the 'briefdescription' XML element. This provides a short overview
|
|
118
|
+
* suitable for listings and summary views of the documented entity.
|
|
119
|
+
*/
|
|
40
120
|
briefDescription?: BriefDescriptionDataModel | undefined;
|
|
121
|
+
/**
|
|
122
|
+
* Detailed description of the compound.
|
|
123
|
+
*
|
|
124
|
+
* @remarks
|
|
125
|
+
* Contains comprehensive documentation for the compound extracted from
|
|
126
|
+
* the 'detaileddescription' XML element. This includes full description
|
|
127
|
+
* text with formatting, examples, and other detailed documentation
|
|
128
|
+
* content.
|
|
129
|
+
*/
|
|
41
130
|
detailedDescription?: DetailedDescriptionDataModel | undefined;
|
|
131
|
+
/**
|
|
132
|
+
* Base compound references for inheritance relationships.
|
|
133
|
+
*
|
|
134
|
+
* @remarks
|
|
135
|
+
* Contains references to base classes or parent compounds from which
|
|
136
|
+
* this compound inherits. This property captures the inheritance
|
|
137
|
+
* hierarchy information extracted from 'basecompoundref' XML elements
|
|
138
|
+
* for object-oriented documentation structures.
|
|
139
|
+
*/
|
|
42
140
|
baseCompoundRefs?: BaseCompoundRefDataModel[] | undefined;
|
|
141
|
+
/**
|
|
142
|
+
* Derived compound references for inheritance relationships.
|
|
143
|
+
*
|
|
144
|
+
* @remarks
|
|
145
|
+
* Contains references to derived classes or child compounds that inherit
|
|
146
|
+
* from this compound. This property captures the inheritance hierarchy
|
|
147
|
+
* information extracted from 'derivedcompoundref' XML elements for
|
|
148
|
+
* complete inheritance documentation.
|
|
149
|
+
*/
|
|
43
150
|
derivedCompoundRefs?: DerivedCompoundRefDataModel[] | undefined;
|
|
151
|
+
/**
|
|
152
|
+
* Include file references for this compound.
|
|
153
|
+
*
|
|
154
|
+
* @remarks
|
|
155
|
+
* Contains information about header files or modules that this compound
|
|
156
|
+
* includes or depends upon. This property captures dependency
|
|
157
|
+
* relationships extracted from 'includes' XML elements, providing
|
|
158
|
+
* visibility into the file inclusion structure.
|
|
159
|
+
*/
|
|
44
160
|
includes?: IncludesDataModel[] | undefined;
|
|
161
|
+
/**
|
|
162
|
+
* Reverse include file references for this compound.
|
|
163
|
+
*
|
|
164
|
+
* @remarks
|
|
165
|
+
* Contains information about other files or compounds that include this
|
|
166
|
+
* compound. This property captures reverse dependency relationships
|
|
167
|
+
* extracted from 'includedby' XML elements, showing which entities
|
|
168
|
+
* depend on this compound.
|
|
169
|
+
*/
|
|
45
170
|
includedBy?: IncludedByDataModel[] | undefined;
|
|
171
|
+
/**
|
|
172
|
+
* Template parameter list for templated compounds.
|
|
173
|
+
*
|
|
174
|
+
* @remarks
|
|
175
|
+
* Contains the template parameter definitions for templated classes,
|
|
176
|
+
* functions, or other templated entities. This property captures
|
|
177
|
+
* template information extracted from 'templateparamlist' XML elements,
|
|
178
|
+
* providing details about generic programming constructs.
|
|
179
|
+
*/
|
|
46
180
|
templateParamList?: TemplateParamListDataModel | undefined;
|
|
181
|
+
/**
|
|
182
|
+
* Section definitions within the compound.
|
|
183
|
+
*
|
|
184
|
+
* @remarks
|
|
185
|
+
* Contains organised sections of members and documentation within the
|
|
186
|
+
* compound. This property captures structured content extracted from
|
|
187
|
+
* 'sectiondef' XML elements, providing hierarchical organisation of
|
|
188
|
+
* compound members by type and visibility.
|
|
189
|
+
*/
|
|
47
190
|
sectionDefs?: SectionDefDataModel[] | undefined;
|
|
191
|
+
/**
|
|
192
|
+
* Table of contents for the compound documentation.
|
|
193
|
+
*
|
|
194
|
+
* @remarks
|
|
195
|
+
* Contains the navigation structure for complex compound documentation.
|
|
196
|
+
* This property captures hierarchical content organisation extracted
|
|
197
|
+
* from 'tableofcontents' XML elements, providing structured navigation
|
|
198
|
+
* for large documentation entities.
|
|
199
|
+
*/
|
|
48
200
|
tableOfContents?: TableOfContentsDataModel | undefined;
|
|
201
|
+
/**
|
|
202
|
+
* Inner folder references contained within this compound.
|
|
203
|
+
*
|
|
204
|
+
* @remarks
|
|
205
|
+
* Contains references to subdirectories or folders that are logically
|
|
206
|
+
* contained within this compound. This property captures hierarchical
|
|
207
|
+
* folder structure extracted from 'innerdir' XML elements, typically
|
|
208
|
+
* used for directory-based documentation organisation.
|
|
209
|
+
*/
|
|
49
210
|
innerDirs?: InnerDirDataModel[] | undefined;
|
|
211
|
+
/**
|
|
212
|
+
* Inner file references contained within this compound.
|
|
213
|
+
*
|
|
214
|
+
* @remarks
|
|
215
|
+
* Contains references to files that are logically contained within this
|
|
216
|
+
* compound. This property captures file relationships extracted from
|
|
217
|
+
* 'innerfile' XML elements, providing visibility into compound-to-file
|
|
218
|
+
* associations in the documentation structure.
|
|
219
|
+
*/
|
|
50
220
|
innerFiles?: InnerFileDataModel[] | undefined;
|
|
221
|
+
/**
|
|
222
|
+
* Inner class references contained within this compound.
|
|
223
|
+
*
|
|
224
|
+
* @remarks
|
|
225
|
+
* Contains references to classes, structures, or other class-like
|
|
226
|
+
* entities that are defined within this compound. This property captures
|
|
227
|
+
* nested type relationships extracted from 'innerclass' XML elements,
|
|
228
|
+
* supporting hierarchical type documentation.
|
|
229
|
+
*/
|
|
51
230
|
innerClasses?: InnerClassDataModel[] | undefined;
|
|
231
|
+
/**
|
|
232
|
+
* Inner namespace references contained within this compound.
|
|
233
|
+
*
|
|
234
|
+
* @remarks
|
|
235
|
+
* Contains references to namespaces that are nested within this compound.
|
|
236
|
+
* This property captures namespace hierarchy relationships extracted from
|
|
237
|
+
* 'innernamespace' XML elements, supporting multi-level namespace
|
|
238
|
+
* documentation organisation.
|
|
239
|
+
*/
|
|
52
240
|
innerNamespaces?: InnerNamespaceDataModel[] | undefined;
|
|
241
|
+
/**
|
|
242
|
+
* Inner page references contained within this compound.
|
|
243
|
+
*
|
|
244
|
+
* @remarks
|
|
245
|
+
* Contains references to documentation pages that are logically
|
|
246
|
+
* associated with this compound. This property captures page
|
|
247
|
+
* relationships extracted from 'innerpage' XML elements, supporting
|
|
248
|
+
* structured documentation navigation.
|
|
249
|
+
*/
|
|
53
250
|
innerPages?: InnerPageDataModel[] | undefined;
|
|
251
|
+
/**
|
|
252
|
+
* Inner group references contained within this compound.
|
|
253
|
+
*
|
|
254
|
+
* @remarks
|
|
255
|
+
* Contains references to documentation groups that are associated with
|
|
256
|
+
* this compound. This property captures group relationships extracted
|
|
257
|
+
* from 'innergroup' XML elements, supporting thematic organisation of
|
|
258
|
+
* related documentation elements.
|
|
259
|
+
*/
|
|
54
260
|
innerGroups?: InnerGroupDataModel[] | undefined;
|
|
261
|
+
/**
|
|
262
|
+
* Program listing or source code for the compound.
|
|
263
|
+
*
|
|
264
|
+
* @remarks
|
|
265
|
+
* Contains the actual source code implementation or listing for the
|
|
266
|
+
* compound when available. This property captures code content extracted
|
|
267
|
+
* from 'programlisting' XML elements, providing syntax-highlighted
|
|
268
|
+
* source code display in the documentation.
|
|
269
|
+
*/
|
|
55
270
|
programListing?: ProgramListingDataModel | undefined;
|
|
271
|
+
/**
|
|
272
|
+
* Location information for the compound definition.
|
|
273
|
+
*
|
|
274
|
+
* @remarks
|
|
275
|
+
* Contains file path, line number, and other location details for where
|
|
276
|
+
* the compound is defined in the source code. This property captures
|
|
277
|
+
* location metadata extracted from 'location' XML elements, enabling
|
|
278
|
+
* source code navigation and reference linking.
|
|
279
|
+
*/
|
|
56
280
|
location?: LocationDataModel | undefined;
|
|
281
|
+
/**
|
|
282
|
+
* Complete list of all members contained in the compound.
|
|
283
|
+
*
|
|
284
|
+
* @remarks
|
|
285
|
+
* Contains a comprehensive list of all members (methods, properties,
|
|
286
|
+
* etc.) that belong to this compound, including inherited members.
|
|
287
|
+
* This property captures member information extracted from
|
|
288
|
+
* 'listofallmembers' XML elements for complete API documentation.
|
|
289
|
+
*/
|
|
57
290
|
listOfAllMembers?: ListOfAllMembersDataModel | undefined;
|
|
291
|
+
/**
|
|
292
|
+
* Unique identifier for the compound.
|
|
293
|
+
*
|
|
294
|
+
* @remarks
|
|
295
|
+
* Contains the unique ID assigned to this compound by Doxygen for
|
|
296
|
+
* cross-referencing and linking purposes. This identifier is mandatory
|
|
297
|
+
* and serves as the primary key for compound identification throughout
|
|
298
|
+
* the documentation system.
|
|
299
|
+
*/
|
|
58
300
|
id: string;
|
|
301
|
+
/**
|
|
302
|
+
* The kind or type of compound.
|
|
303
|
+
*
|
|
304
|
+
* @remarks
|
|
305
|
+
* Specifies the compound type using DoxCompoundKind enumeration values
|
|
306
|
+
* such as 'class', 'struct', 'file', 'namespace', 'page', etc. This
|
|
307
|
+
* mandatory attribute determines how the compound should be processed
|
|
308
|
+
* and displayed in the documentation output.
|
|
309
|
+
*/
|
|
59
310
|
kind: string;
|
|
311
|
+
/**
|
|
312
|
+
* Programming language of the compound.
|
|
313
|
+
*
|
|
314
|
+
* @remarks
|
|
315
|
+
* Specifies the programming language using DoxLanguage enumeration
|
|
316
|
+
* values when the compound is language-specific. This optional attribute
|
|
317
|
+
* enables language-aware processing and appropriate syntax highlighting
|
|
318
|
+
* in the generated documentation.
|
|
319
|
+
*/
|
|
60
320
|
language?: string | undefined;
|
|
321
|
+
/**
|
|
322
|
+
* Protection level of the compound.
|
|
323
|
+
*
|
|
324
|
+
* @remarks
|
|
325
|
+
* Specifies the access protection level (public, private, protected)
|
|
326
|
+
* for the compound using DoxProtectionKind enumeration values. Note
|
|
327
|
+
* that whilst this attribute is not marked as optional in the XML
|
|
328
|
+
* schema, it may not be present in all compound definitions.
|
|
329
|
+
*/
|
|
61
330
|
prot?: string | undefined;
|
|
331
|
+
/**
|
|
332
|
+
* Indicates whether the compound is marked as final.
|
|
333
|
+
*
|
|
334
|
+
* @remarks
|
|
335
|
+
* Specifies that the compound cannot be inherited from or extended,
|
|
336
|
+
* typically used in object-oriented programming languages that support
|
|
337
|
+
* final classes or sealed types. This boolean attribute reflects the
|
|
338
|
+
* final modifier in the source code.
|
|
339
|
+
*/
|
|
62
340
|
final?: boolean | undefined;
|
|
341
|
+
/**
|
|
342
|
+
* Indicates whether the compound is inline.
|
|
343
|
+
*
|
|
344
|
+
* @remarks
|
|
345
|
+
* Specifies that the compound is defined inline, typically used for
|
|
346
|
+
* functions, methods, or other constructs that are implemented directly
|
|
347
|
+
* in header files. This boolean attribute reflects inline declarations
|
|
348
|
+
* in the source code.
|
|
349
|
+
*/
|
|
63
350
|
inline?: boolean | undefined;
|
|
351
|
+
/**
|
|
352
|
+
* Indicates whether the compound is sealed.
|
|
353
|
+
*
|
|
354
|
+
* @remarks
|
|
355
|
+
* Specifies that the compound is sealed and cannot be inherited from,
|
|
356
|
+
* similar to final but using different language-specific terminology.
|
|
357
|
+
* This boolean attribute reflects sealed modifiers found in languages
|
|
358
|
+
* like C# or other object-oriented programming environments.
|
|
359
|
+
*/
|
|
64
360
|
sealed?: boolean | undefined;
|
|
361
|
+
/**
|
|
362
|
+
* Indicates whether the compound is abstract.
|
|
363
|
+
*
|
|
364
|
+
* @remarks
|
|
365
|
+
* Specifies that the compound is abstract and cannot be instantiated
|
|
366
|
+
* directly, typically requiring concrete implementations of abstract
|
|
367
|
+
* methods or properties. This boolean attribute reflects abstract
|
|
368
|
+
* modifiers in object-oriented programming languages.
|
|
369
|
+
*/
|
|
65
370
|
abstract?: boolean | undefined;
|
|
371
|
+
/**
|
|
372
|
+
* Constructs a new compound definition data model instance.
|
|
373
|
+
*
|
|
374
|
+
* @remarks
|
|
375
|
+
* Parses the complete XML structure for compound definitions, processing
|
|
376
|
+
* all elements and attributes according to the Doxygen XML schema. This
|
|
377
|
+
* includes handling optional and mandatory elements, complex nested
|
|
378
|
+
* structures, and comprehensive attribute validation to ensure data
|
|
379
|
+
* integrity throughout the parsing process.
|
|
380
|
+
*
|
|
381
|
+
* @param xml - The XML parser instance for processing elements
|
|
382
|
+
* @param element - The XML element object to parse
|
|
383
|
+
* @param elementName - The name of the XML element being processed
|
|
384
|
+
*/
|
|
66
385
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
67
386
|
}
|
|
68
387
|
/**
|
|
388
|
+
* Concrete implementation of compound definition data model.
|
|
389
|
+
*
|
|
390
|
+
* @remarks
|
|
391
|
+
* Provides the primary data model implementation for Doxygen compound
|
|
392
|
+
* definitions, handling all types of compounds including classes, structures,
|
|
393
|
+
* files, namespaces, and pages. This class serves as the main entry point
|
|
394
|
+
* for processing compound definition XML elements in the Doxygen output.
|
|
395
|
+
*
|
|
69
396
|
* @public
|
|
70
397
|
*/
|
|
71
398
|
export declare class CompoundDefDataModel extends AbstractCompoundDefType {
|
|
399
|
+
/**
|
|
400
|
+
* Constructs a new CompoundDefDataModel instance.
|
|
401
|
+
*
|
|
402
|
+
* @remarks
|
|
403
|
+
* Creates a data model object for 'compounddef' XML elements by delegating
|
|
404
|
+
* to the parent constructor with the appropriate element name. This
|
|
405
|
+
* represents the root element for all compound definitions in Doxygen XML
|
|
406
|
+
* output.
|
|
407
|
+
*
|
|
408
|
+
* @param xml - The XML parser instance for processing elements
|
|
409
|
+
* @param element - The XML element object to parse
|
|
410
|
+
*/
|
|
72
411
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
73
412
|
}
|
|
413
|
+
/**
|
|
414
|
+
* Abstract base class for HTML-only documentation content.
|
|
415
|
+
*
|
|
416
|
+
* @remarks
|
|
417
|
+
* Represents content that should only be rendered in HTML output formats,
|
|
418
|
+
* providing a mechanism for format-specific content inclusion in Doxygen
|
|
419
|
+
* documentation. This class handles the 'docHtmlOnlyType' XML schema
|
|
420
|
+
* structure with text content and optional block attributes.
|
|
421
|
+
*
|
|
422
|
+
* @public
|
|
423
|
+
*/
|
|
74
424
|
export declare abstract class AbstractDocHtmlOnlyType extends AbstractDataModelBase {
|
|
75
425
|
text: string;
|
|
76
426
|
block?: string | undefined;
|
|
427
|
+
/**
|
|
428
|
+
* Constructs a new HTML-only content data model instance.
|
|
429
|
+
*
|
|
430
|
+
* @remarks
|
|
431
|
+
* Parses HTML-only content elements from Doxygen XML output, extracting
|
|
432
|
+
* the text content and any optional block attributes. This content is
|
|
433
|
+
* intended for rendering only in HTML-based output formats whilst being
|
|
434
|
+
* excluded from other documentation formats.
|
|
435
|
+
*
|
|
436
|
+
* @param xml - The XML parser instance for processing elements
|
|
437
|
+
* @param element - The XML element object to parse
|
|
438
|
+
* @param elementName - The name of the XML element being processed
|
|
439
|
+
*/
|
|
77
440
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
78
441
|
}
|
|
442
|
+
/**
|
|
443
|
+
* Data model for HTML-only content elements.
|
|
444
|
+
*
|
|
445
|
+
* @remarks
|
|
446
|
+
* Represents content that should only be included in HTML output formats,
|
|
447
|
+
* typically used for web-specific markup or styling that is not appropriate
|
|
448
|
+
* for other documentation formats. This implementation handles the 'htmlonly'
|
|
449
|
+
* XML element from Doxygen output.
|
|
450
|
+
*
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
79
453
|
export declare class HtmlOnlyDataModel extends AbstractDocHtmlOnlyType {
|
|
454
|
+
/**
|
|
455
|
+
* Constructs a new HtmlOnlyDataModel instance.
|
|
456
|
+
*
|
|
457
|
+
* @remarks
|
|
458
|
+
* Creates a data model object for 'htmlonly' XML elements, which contain
|
|
459
|
+
* content specifically intended for HTML output rendering only.
|
|
460
|
+
*
|
|
461
|
+
* @param xml - The XML parser instance for processing elements
|
|
462
|
+
* @param element - The XML element object to parse
|
|
463
|
+
*/
|
|
80
464
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
81
465
|
}
|
|
466
|
+
/**
|
|
467
|
+
* Data model for manual-only content elements.
|
|
468
|
+
*
|
|
469
|
+
* @remarks
|
|
470
|
+
* Represents content that should only be included in manual page output
|
|
471
|
+
* formats. This class handles string content specifically intended for
|
|
472
|
+
* Unix manual page generation whilst excluding it from other documentation
|
|
473
|
+
* formats.
|
|
474
|
+
*
|
|
475
|
+
* @public
|
|
476
|
+
*/
|
|
82
477
|
export declare class ManOnlyDataModel extends AbstractStringType {
|
|
478
|
+
/**
|
|
479
|
+
* Constructs a new ManOnlyDataModel instance.
|
|
480
|
+
*
|
|
481
|
+
* @remarks
|
|
482
|
+
* Creates a data model object for 'manonly' XML elements containing
|
|
483
|
+
* content specifically intended for manual page output rendering.
|
|
484
|
+
*
|
|
485
|
+
* @param xml - The XML parser instance for processing elements
|
|
486
|
+
* @param element - The XML element object to parse
|
|
487
|
+
*/
|
|
83
488
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
84
489
|
}
|
|
490
|
+
/**
|
|
491
|
+
* Data model for XML-only content elements.
|
|
492
|
+
*
|
|
493
|
+
* @remarks
|
|
494
|
+
* Represents content that should only be included in XML output formats.
|
|
495
|
+
* This class handles string content specifically intended for XML-based
|
|
496
|
+
* documentation generation whilst excluding it from other output formats.
|
|
497
|
+
*
|
|
498
|
+
* @public
|
|
499
|
+
*/
|
|
85
500
|
export declare class XmlOnlyDataModel extends AbstractStringType {
|
|
501
|
+
/**
|
|
502
|
+
* Constructs a new XmlOnlyDataModel instance.
|
|
503
|
+
*
|
|
504
|
+
* @remarks
|
|
505
|
+
* Creates a data model object for 'xmlonly' XML elements containing
|
|
506
|
+
* content specifically intended for XML output rendering.
|
|
507
|
+
*
|
|
508
|
+
* @param xml - The XML parser instance for processing elements
|
|
509
|
+
* @param element - The XML element object to parse
|
|
510
|
+
*/
|
|
86
511
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
87
512
|
}
|
|
513
|
+
/**
|
|
514
|
+
* Data model for RTF-only content elements.
|
|
515
|
+
*
|
|
516
|
+
* @remarks
|
|
517
|
+
* Represents content that should only be included in Rich Text Format (RTF)
|
|
518
|
+
* output. This class handles string content specifically intended for RTF
|
|
519
|
+
* document generation whilst excluding it from other documentation formats.
|
|
520
|
+
*
|
|
521
|
+
* @public
|
|
522
|
+
*/
|
|
88
523
|
export declare class RtfOnlyDataModel extends AbstractStringType {
|
|
524
|
+
/**
|
|
525
|
+
* Constructs a new RtfOnlyDataModel instance.
|
|
526
|
+
*
|
|
527
|
+
* @remarks
|
|
528
|
+
* Creates a data model object for 'rtfonly' XML elements containing
|
|
529
|
+
* content specifically intended for RTF output rendering.
|
|
530
|
+
*
|
|
531
|
+
* @param xml - The XML parser instance for processing elements
|
|
532
|
+
* @param element - The XML element object to parse
|
|
533
|
+
*/
|
|
89
534
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
90
535
|
}
|
|
536
|
+
/**
|
|
537
|
+
* Data model for LaTeX-only content elements.
|
|
538
|
+
*
|
|
539
|
+
* @remarks
|
|
540
|
+
* Represents content that should only be included in LaTeX output formats.
|
|
541
|
+
* This class handles string content specifically intended for LaTeX document
|
|
542
|
+
* generation whilst excluding it from other documentation formats.
|
|
543
|
+
*
|
|
544
|
+
* @public
|
|
545
|
+
*/
|
|
91
546
|
export declare class LatexOnlyDataModel extends AbstractStringType {
|
|
547
|
+
/**
|
|
548
|
+
* Constructs a new LatexOnlyDataModel instance.
|
|
549
|
+
*
|
|
550
|
+
* @remarks
|
|
551
|
+
* Creates a data model object for 'latexonly' XML elements containing
|
|
552
|
+
* content specifically intended for LaTeX output rendering.
|
|
553
|
+
*
|
|
554
|
+
* @param xml - The XML parser instance for processing elements
|
|
555
|
+
* @param element - The XML element object to parse
|
|
556
|
+
*/
|
|
92
557
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
93
558
|
}
|
|
559
|
+
/**
|
|
560
|
+
* Data model for DocBook-only content elements.
|
|
561
|
+
*
|
|
562
|
+
* @remarks
|
|
563
|
+
* Represents content that should only be included in DocBook output formats.
|
|
564
|
+
* This class handles string content specifically intended for DocBook XML
|
|
565
|
+
* document generation whilst excluding it from other documentation formats.
|
|
566
|
+
*
|
|
567
|
+
* @public
|
|
568
|
+
*/
|
|
94
569
|
export declare class DocBookOnlyDataModel extends AbstractStringType {
|
|
570
|
+
/**
|
|
571
|
+
* Constructs a new DocBookOnlyDataModel instance.
|
|
572
|
+
*
|
|
573
|
+
* @remarks
|
|
574
|
+
* Creates a data model object for 'docbookonly' XML elements containing
|
|
575
|
+
* content specifically intended for DocBook output rendering.
|
|
576
|
+
*
|
|
577
|
+
* @param xml - The XML parser instance for processing elements
|
|
578
|
+
* @param element - The XML element object to parse
|
|
579
|
+
*/
|
|
95
580
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
96
581
|
}
|
|
97
582
|
//# sourceMappingURL=compounddef-dm.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"compounddef-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/compounddef-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACxE,OAAO,EACL,wBAAwB,EACxB,2BAA2B,EAC5B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAA;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAA;AACxE,OAAO,EACL,kBAAkB,EAClB,yBAAyB,EACzB,4BAA4B,EAE5B,uBAAuB,EAExB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EACnB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;
|
|
1
|
+
{"version":3,"file":"compounddef-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/compounddef-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACxE,OAAO,EACL,wBAAwB,EACxB,2BAA2B,EAC5B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAA;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAA;AACxE,OAAO,EACL,kBAAkB,EAClB,yBAAyB,EACzB,4BAA4B,EAE5B,uBAAuB,EAExB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EACnB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAItE;;;;;;;;;;;GAWG;AAEH,8BAAsB,eAAgB,SAAQ,qBAAqB;IAEjE,IAAI,SAAK;IAGT,YAAY,SAAK;IACjB,SAAS,SAAM;IACf,KAAK,UAAQ;IAIb,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,gBAAgB,EAAE,yBAAyB,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,EAAE,iBAAiB,EAAE,GAAG,SAAS,CAAA;IAG1C,EAAE,SAAK;IACP,SAAS,SAAM;IACf,KAAK,UAAQ;IAGb,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAM7B;;;;;;;;;;;;OAYG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAgHxE;AAED;;;;;;;;;;GAUG;AACH,qBAAa,YAAa,SAAQ,eAAe;IAC/C;;;;;;;;;OASG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AA4ED;;;;;;;;;;;GAWG;AACH,8BAAsB,uBAAwB,SAAQ,qBAAqB;IAGzE;;;;;;;;OAQG;IACH,YAAY,SAAK;IAIjB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE1B;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAA;IAExD;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,4BAA4B,GAAG,SAAS,CAAA;IAE9D;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,EAAE,GAAG,SAAS,CAAA;IAEzD;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,2BAA2B,EAAE,GAAG,SAAS,CAAA;IAE/D;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,iBAAiB,EAAE,GAAG,SAAS,CAAA;IAE1C;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,mBAAmB,EAAE,GAAG,SAAS,CAAA;IAE9C;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAA;IAE1D;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,mBAAmB,EAAE,GAAG,SAAS,CAAA;IAE/C;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAA;IAGtD;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,iBAAiB,EAAE,GAAG,SAAS,CAAA;IAE3C;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAA;IAE7C;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,mBAAmB,EAAE,GAAG,SAAS,CAAA;IAGhD;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,uBAAuB,EAAE,GAAG,SAAS,CAAA;IAEvD;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAA;IAE7C;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,mBAAmB,EAAE,GAAG,SAAS,CAAA;IAE/C;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAA;IAEpD;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAA;IAExC;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAA;IAIxD;;;;;;;;OAQG;IACH,EAAE,SAAK;IAEP;;;;;;;;OAQG;IACH,IAAI,SAAK;IAIT;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAG7B;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAEzB;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAE3B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAE5B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAE5B;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAM9B;;;;;;;;;;;;;OAaG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA6JxE;AAMD;;;;;;;;;;GAUG;AACH,qBAAa,oBAAqB,SAAQ,uBAAuB;IAC/D;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAYD;;;;;;;;;;GAUG;AACH,8BAAsB,uBAAwB,SAAQ,qBAAqB;IACzE,IAAI,SAAK;IAET,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE1B;;;;;;;;;;;;OAYG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAmCxE;AAMD;;;;;;;;;;GAUG;AACH,qBAAa,iBAAkB,SAAQ,uBAAuB;IAC5D;;;;;;;;;OASG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAUD;;;;;;;;;;GAUG;AACH,qBAAa,gBAAiB,SAAQ,kBAAkB;IACtD;;;;;;;;;OASG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;GASG;AACH,qBAAa,gBAAiB,SAAQ,kBAAkB;IACtD;;;;;;;;;OASG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;GASG;AACH,qBAAa,gBAAiB,SAAQ,kBAAkB;IACtD;;;;;;;;;OASG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;GASG;AACH,qBAAa,kBAAmB,SAAQ,kBAAkB;IACxD;;;;;;;;;OASG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;GASG;AACH,qBAAa,oBAAqB,SAAQ,kBAAkB;IAC1D;;;;;;;;;OASG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
|