@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,21 +1,156 @@
|
|
|
1
1
|
import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
|
|
2
2
|
import { AbstractDataModelBase } from '../types.js';
|
|
3
3
|
/**
|
|
4
|
+
* Abstract base class for member reference data models within documentation.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* Represents comprehensive references to class or namespace members as
|
|
8
|
+
* parsed from Doxygen XML elements. This class processes memberRefType
|
|
9
|
+
* schema definitions which contain scope information, member names, and
|
|
10
|
+
* essential attributes required for cross-referencing and link generation
|
|
11
|
+
* within the documentation system.
|
|
12
|
+
*
|
|
13
|
+
* The implementation handles the complete set of member reference metadata
|
|
14
|
+
* including qualified scope identification, protection levels, virtual
|
|
15
|
+
* inheritance characteristics, and ambiguity resolution information.
|
|
16
|
+
* This enables accurate cross-reference generation and navigation between
|
|
17
|
+
* different parts of the documentation.
|
|
18
|
+
*
|
|
4
19
|
* @public
|
|
5
20
|
*/
|
|
6
21
|
export declare abstract class AbstractMemberRefType extends AbstractDataModelBase {
|
|
22
|
+
/**
|
|
23
|
+
* The containing scope for the referenced member element.
|
|
24
|
+
*
|
|
25
|
+
* @remarks
|
|
26
|
+
* Specifies the namespace, class, or other containing context that
|
|
27
|
+
* houses the referenced member. This scope information provides the
|
|
28
|
+
* qualified context necessary for proper member identification and
|
|
29
|
+
* disambiguation within the documentation hierarchy.
|
|
30
|
+
*
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
7
33
|
scope: string;
|
|
34
|
+
/**
|
|
35
|
+
* The identifier name of the referenced member element.
|
|
36
|
+
*
|
|
37
|
+
* @remarks
|
|
38
|
+
* Contains the simple identifier name for the member being referenced,
|
|
39
|
+
* which serves as the primary display name and is used for link
|
|
40
|
+
* generation within the documentation system. This name is used in
|
|
41
|
+
* conjunction with the scope to provide complete member identification.
|
|
42
|
+
*
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
8
45
|
name: string;
|
|
46
|
+
/**
|
|
47
|
+
* The unique reference identifier for cross-referencing the member.
|
|
48
|
+
*
|
|
49
|
+
* @remarks
|
|
50
|
+
* Contains the Doxygen-generated unique identifier used for creating
|
|
51
|
+
* precise cross-references and hyperlinks to the member documentation.
|
|
52
|
+
* This identifier ensures unambiguous linking between documentation
|
|
53
|
+
* elements and enables accurate navigation within the generated
|
|
54
|
+
* documentation system.
|
|
55
|
+
*
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
9
58
|
refid: string;
|
|
59
|
+
/**
|
|
60
|
+
* The protection level classification of the referenced member.
|
|
61
|
+
*
|
|
62
|
+
* @remarks
|
|
63
|
+
* Specifies the access protection level such as 'public', 'private',
|
|
64
|
+
* or 'protected' based on Doxygen's DoxProtectionKind enumeration.
|
|
65
|
+
* This information determines the member's visibility and accessibility
|
|
66
|
+
* within its containing scope and affects documentation presentation.
|
|
67
|
+
*
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
10
70
|
prot: string;
|
|
71
|
+
/**
|
|
72
|
+
* The virtual inheritance classification of the referenced member.
|
|
73
|
+
*
|
|
74
|
+
* @remarks
|
|
75
|
+
* Indicates the virtual nature such as 'virtual', 'pure-virtual',
|
|
76
|
+
* or 'non-virtual' based on Doxygen's DoxVirtualKind enumeration.
|
|
77
|
+
* This classification is essential for understanding inheritance
|
|
78
|
+
* relationships and member override behaviour within class hierarchies.
|
|
79
|
+
*
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
11
82
|
virt: string;
|
|
83
|
+
/**
|
|
84
|
+
* The ambiguity resolution scope for member reference disambiguation.
|
|
85
|
+
*
|
|
86
|
+
* @remarks
|
|
87
|
+
* Provides optional scope information used to resolve ambiguous member
|
|
88
|
+
* references when multiple members with identical names exist within
|
|
89
|
+
* the documentation context. This field assists in ensuring accurate
|
|
90
|
+
* member identification when name conflicts occur.
|
|
91
|
+
*
|
|
92
|
+
* Note that this deviates from the XML Schema definition where it is
|
|
93
|
+
* marked as required, but in practice may be undefined for certain
|
|
94
|
+
* member references.
|
|
95
|
+
*
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
12
98
|
ambiguityscope?: string | undefined;
|
|
99
|
+
/**
|
|
100
|
+
* Constructs a new member reference data model from XML element data.
|
|
101
|
+
*
|
|
102
|
+
* @param xml - The XML parser instance for processing element data
|
|
103
|
+
* @param element - The XML element containing member reference information
|
|
104
|
+
* @param elementName - The name of the XML element being processed
|
|
105
|
+
*
|
|
106
|
+
* @remarks
|
|
107
|
+
* Processes the XML element representing member reference information
|
|
108
|
+
* and extracts scope identification, member names, and reference
|
|
109
|
+
* attributes required for cross-referencing functionality. The
|
|
110
|
+
* constructor validates mandatory elements and attributes whilst
|
|
111
|
+
* gracefully handling optional ambiguity scope information.
|
|
112
|
+
*
|
|
113
|
+
* The implementation ensures that essential reference data (scope, name,
|
|
114
|
+
* refid, protection, virtual kind) is properly extracted and validated
|
|
115
|
+
* according to the memberRefType schema requirements.
|
|
116
|
+
*
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
13
119
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
14
120
|
}
|
|
15
121
|
/**
|
|
122
|
+
* Concrete implementation for member reference elements within documentation.
|
|
123
|
+
*
|
|
124
|
+
* @remarks
|
|
125
|
+
* Provides specific handling for member XML elements that contain
|
|
126
|
+
* comprehensive member reference information within class and compound
|
|
127
|
+
* documentation. This implementation extends the abstract base class
|
|
128
|
+
* functionality to process member references with the specific element
|
|
129
|
+
* name 'member'.
|
|
130
|
+
*
|
|
131
|
+
* The class ensures proper instantiation of member reference data models
|
|
132
|
+
* whilst maintaining all the cross-referencing metadata required for
|
|
133
|
+
* accurate documentation linking and navigation between related members
|
|
134
|
+
* within the documentation system.
|
|
135
|
+
*
|
|
16
136
|
* @public
|
|
17
137
|
*/
|
|
18
138
|
export declare class MemberRefDataModel extends AbstractMemberRefType {
|
|
139
|
+
/**
|
|
140
|
+
* Constructs a new member reference data model instance.
|
|
141
|
+
*
|
|
142
|
+
* @param xml - The XML parser instance for processing elements
|
|
143
|
+
* @param element - The source XML element containing member reference data
|
|
144
|
+
*
|
|
145
|
+
* @remarks
|
|
146
|
+
* Initialises the data model with the specific element name 'member'
|
|
147
|
+
* and delegates processing to the abstract base class implementation.
|
|
148
|
+
* This ensures consistent handling of member reference information
|
|
149
|
+
* whilst maintaining proper element identification for cross-referencing
|
|
150
|
+
* functionality.
|
|
151
|
+
*
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
19
154
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
20
155
|
}
|
|
21
156
|
//# sourceMappingURL=memberreftype-dm.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"memberreftype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/memberreftype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAenD
|
|
1
|
+
{"version":3,"file":"memberreftype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/memberreftype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAenD;;;;;;;;;;;;;;;;;GAiBG;AACH,8BAAsB,qBAAsB,SAAQ,qBAAqB;IACvE;;;;;;;;;;OAUG;IACH,KAAK,SAAK;IAEV;;;;;;;;;;OAUG;IACH,IAAI,SAAK;IAET;;;;;;;;;;;OAWG;IACH,KAAK,SAAK;IAEV;;;;;;;;;;OAUG;IACH,IAAI,SAAK;IAET;;;;;;;;;;OAUG;IACH,IAAI,SAAK;IAET;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;OAmBG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAsExE;AAMD;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,kBAAmB,SAAQ,qBAAqB;IAC3D;;;;;;;;;;;;;;OAcG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
|
|
@@ -24,18 +24,121 @@ import { AbstractDataModelBase } from '../types.js';
|
|
|
24
24
|
// <xsd:attribute name="ambiguityscope" type="xsd:string" />
|
|
25
25
|
// </xsd:complexType>
|
|
26
26
|
/**
|
|
27
|
+
* Abstract base class for member reference data models within documentation.
|
|
28
|
+
*
|
|
29
|
+
* @remarks
|
|
30
|
+
* Represents comprehensive references to class or namespace members as
|
|
31
|
+
* parsed from Doxygen XML elements. This class processes memberRefType
|
|
32
|
+
* schema definitions which contain scope information, member names, and
|
|
33
|
+
* essential attributes required for cross-referencing and link generation
|
|
34
|
+
* within the documentation system.
|
|
35
|
+
*
|
|
36
|
+
* The implementation handles the complete set of member reference metadata
|
|
37
|
+
* including qualified scope identification, protection levels, virtual
|
|
38
|
+
* inheritance characteristics, and ambiguity resolution information.
|
|
39
|
+
* This enables accurate cross-reference generation and navigation between
|
|
40
|
+
* different parts of the documentation.
|
|
41
|
+
*
|
|
27
42
|
* @public
|
|
28
43
|
*/
|
|
29
44
|
export class AbstractMemberRefType extends AbstractDataModelBase {
|
|
30
|
-
|
|
31
|
-
|
|
45
|
+
/**
|
|
46
|
+
* The containing scope for the referenced member element.
|
|
47
|
+
*
|
|
48
|
+
* @remarks
|
|
49
|
+
* Specifies the namespace, class, or other containing context that
|
|
50
|
+
* houses the referenced member. This scope information provides the
|
|
51
|
+
* qualified context necessary for proper member identification and
|
|
52
|
+
* disambiguation within the documentation hierarchy.
|
|
53
|
+
*
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
scope = '';
|
|
57
|
+
/**
|
|
58
|
+
* The identifier name of the referenced member element.
|
|
59
|
+
*
|
|
60
|
+
* @remarks
|
|
61
|
+
* Contains the simple identifier name for the member being referenced,
|
|
62
|
+
* which serves as the primary display name and is used for link
|
|
63
|
+
* generation within the documentation system. This name is used in
|
|
64
|
+
* conjunction with the scope to provide complete member identification.
|
|
65
|
+
*
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
32
68
|
name = '';
|
|
33
|
-
|
|
69
|
+
/**
|
|
70
|
+
* The unique reference identifier for cross-referencing the member.
|
|
71
|
+
*
|
|
72
|
+
* @remarks
|
|
73
|
+
* Contains the Doxygen-generated unique identifier used for creating
|
|
74
|
+
* precise cross-references and hyperlinks to the member documentation.
|
|
75
|
+
* This identifier ensures unambiguous linking between documentation
|
|
76
|
+
* elements and enables accurate navigation within the generated
|
|
77
|
+
* documentation system.
|
|
78
|
+
*
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
34
81
|
refid = '';
|
|
82
|
+
/**
|
|
83
|
+
* The protection level classification of the referenced member.
|
|
84
|
+
*
|
|
85
|
+
* @remarks
|
|
86
|
+
* Specifies the access protection level such as 'public', 'private',
|
|
87
|
+
* or 'protected' based on Doxygen's DoxProtectionKind enumeration.
|
|
88
|
+
* This information determines the member's visibility and accessibility
|
|
89
|
+
* within its containing scope and affects documentation presentation.
|
|
90
|
+
*
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
35
93
|
prot = '';
|
|
94
|
+
/**
|
|
95
|
+
* The virtual inheritance classification of the referenced member.
|
|
96
|
+
*
|
|
97
|
+
* @remarks
|
|
98
|
+
* Indicates the virtual nature such as 'virtual', 'pure-virtual',
|
|
99
|
+
* or 'non-virtual' based on Doxygen's DoxVirtualKind enumeration.
|
|
100
|
+
* This classification is essential for understanding inheritance
|
|
101
|
+
* relationships and member override behaviour within class hierarchies.
|
|
102
|
+
*
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
36
105
|
virt = '';
|
|
37
|
-
|
|
106
|
+
/**
|
|
107
|
+
* The ambiguity resolution scope for member reference disambiguation.
|
|
108
|
+
*
|
|
109
|
+
* @remarks
|
|
110
|
+
* Provides optional scope information used to resolve ambiguous member
|
|
111
|
+
* references when multiple members with identical names exist within
|
|
112
|
+
* the documentation context. This field assists in ensuring accurate
|
|
113
|
+
* member identification when name conflicts occur.
|
|
114
|
+
*
|
|
115
|
+
* Note that this deviates from the XML Schema definition where it is
|
|
116
|
+
* marked as required, but in practice may be undefined for certain
|
|
117
|
+
* member references.
|
|
118
|
+
*
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
38
121
|
ambiguityscope;
|
|
122
|
+
/**
|
|
123
|
+
* Constructs a new member reference data model from XML element data.
|
|
124
|
+
*
|
|
125
|
+
* @param xml - The XML parser instance for processing element data
|
|
126
|
+
* @param element - The XML element containing member reference information
|
|
127
|
+
* @param elementName - The name of the XML element being processed
|
|
128
|
+
*
|
|
129
|
+
* @remarks
|
|
130
|
+
* Processes the XML element representing member reference information
|
|
131
|
+
* and extracts scope identification, member names, and reference
|
|
132
|
+
* attributes required for cross-referencing functionality. The
|
|
133
|
+
* constructor validates mandatory elements and attributes whilst
|
|
134
|
+
* gracefully handling optional ambiguity scope information.
|
|
135
|
+
*
|
|
136
|
+
* The implementation ensures that essential reference data (scope, name,
|
|
137
|
+
* refid, protection, virtual kind) is properly extracted and validated
|
|
138
|
+
* according to the memberRefType schema requirements.
|
|
139
|
+
*
|
|
140
|
+
* @public
|
|
141
|
+
*/
|
|
39
142
|
constructor(xml, element, elementName) {
|
|
40
143
|
super(elementName);
|
|
41
144
|
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
@@ -93,9 +196,38 @@ export class AbstractMemberRefType extends AbstractDataModelBase {
|
|
|
93
196
|
// ----------------------------------------------------------------------------
|
|
94
197
|
// <xsd:element name="member" type="memberRefType" minOccurs="0" maxOccurs="unbounded" />
|
|
95
198
|
/**
|
|
199
|
+
* Concrete implementation for member reference elements within documentation.
|
|
200
|
+
*
|
|
201
|
+
* @remarks
|
|
202
|
+
* Provides specific handling for member XML elements that contain
|
|
203
|
+
* comprehensive member reference information within class and compound
|
|
204
|
+
* documentation. This implementation extends the abstract base class
|
|
205
|
+
* functionality to process member references with the specific element
|
|
206
|
+
* name 'member'.
|
|
207
|
+
*
|
|
208
|
+
* The class ensures proper instantiation of member reference data models
|
|
209
|
+
* whilst maintaining all the cross-referencing metadata required for
|
|
210
|
+
* accurate documentation linking and navigation between related members
|
|
211
|
+
* within the documentation system.
|
|
212
|
+
*
|
|
96
213
|
* @public
|
|
97
214
|
*/
|
|
98
215
|
export class MemberRefDataModel extends AbstractMemberRefType {
|
|
216
|
+
/**
|
|
217
|
+
* Constructs a new member reference data model instance.
|
|
218
|
+
*
|
|
219
|
+
* @param xml - The XML parser instance for processing elements
|
|
220
|
+
* @param element - The source XML element containing member reference data
|
|
221
|
+
*
|
|
222
|
+
* @remarks
|
|
223
|
+
* Initialises the data model with the specific element name 'member'
|
|
224
|
+
* and delegates processing to the abstract base class implementation.
|
|
225
|
+
* This ensures consistent handling of member reference information
|
|
226
|
+
* whilst maintaining proper element identification for cross-referencing
|
|
227
|
+
* functionality.
|
|
228
|
+
*
|
|
229
|
+
* @public
|
|
230
|
+
*/
|
|
99
231
|
constructor(xml, element) {
|
|
100
232
|
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
101
233
|
super(xml, element, 'member');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"memberreftype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/memberreftype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAGjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,yCAAyC;AACzC,mBAAmB;AACnB,qDAAqD;AACrD,oDAAoD;AACpD,oBAAoB;AACpB,qDAAqD;AACrD,2DAA2D;AAC3D,wDAAwD;AACxD,8DAA8D;AAC9D,qBAAqB;AAErB
|
|
1
|
+
{"version":3,"file":"memberreftype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/memberreftype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAGjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,yCAAyC;AACzC,mBAAmB;AACnB,qDAAqD;AACrD,oDAAoD;AACpD,oBAAoB;AACpB,qDAAqD;AACrD,2DAA2D;AAC3D,wDAAwD;AACxD,8DAA8D;AAC9D,qBAAqB;AAErB;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAgB,qBAAsB,SAAQ,qBAAqB;IACvE;;;;;;;;;;OAUG;IACH,KAAK,GAAG,EAAE,CAAA;IAEV;;;;;;;;;;OAUG;IACH,IAAI,GAAG,EAAE,CAAA;IAET;;;;;;;;;;;OAWG;IACH,KAAK,GAAG,EAAE,CAAA;IAEV;;;;;;;;;;OAUG;IACH,IAAI,GAAG,EAAE,CAAA;IAET;;;;;;;;;;OAUG;IACH,IAAI,GAAG,EAAE,CAAA;IAET;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAqB;IAEnC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,aAAa,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAChE,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAEhC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnC,gBAAgB;YAClB,CAAC;iBAAM,IAAI,GAAG,CAAC,kBAAkB,CAAC,YAAY,EAAE,OAAO,CAAC,EAAE,CAAC;gBACzD,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;YAC7D,CAAC;iBAAM,IAAI,GAAG,CAAC,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC;gBACxD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;YAC3D,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,WAAW,EACzB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAC3E,sBAAsB;QAEtB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAElC,MAAM,eAAe,GAAG,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACvD,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;gBACtC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;YAC5D,CAAC;iBAAM,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;gBACtC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;YAC5D,CAAC;iBAAM,IAAI,aAAa,KAAK,kBAAkB,EAAE,CAAC;gBAChD,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,uBAAuB,CAC/C,OAAO,EACP,kBAAkB,CACnB,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;gBACpE,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,aAAa,EAC3B,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC5B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC5B,8BAA8B;QAE9B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,yFAAyF;AAEzF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IAC3D;;;;;;;;;;;;;;OAcG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACF;AAED,+EAA+E"}
|
|
@@ -1,17 +1,112 @@
|
|
|
1
1
|
import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
|
|
2
2
|
import { AbstractMemberBaseType } from './memberdeftype-dm.js';
|
|
3
3
|
/**
|
|
4
|
+
* Abstract base class for member type data models within documentation.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* Represents member elements as defined by the MemberType XML Schema,
|
|
8
|
+
* providing fundamental member identification and classification
|
|
9
|
+
* functionality. This class extends AbstractMemberBaseType to handle
|
|
10
|
+
* the specific requirements of member elements that contain simplified
|
|
11
|
+
* member information with reference identifiers.
|
|
12
|
+
*
|
|
13
|
+
* The implementation processes member elements that primarily serve as
|
|
14
|
+
* lightweight references to more detailed member definitions, maintaining
|
|
15
|
+
* essential identification data including names, reference identifiers,
|
|
16
|
+
* and member kind classifications for cross-referencing purposes.
|
|
17
|
+
*
|
|
4
18
|
* @public
|
|
5
19
|
*/
|
|
6
20
|
export declare abstract class AbstractMemberType extends AbstractMemberBaseType {
|
|
21
|
+
/**
|
|
22
|
+
* The unique reference identifier for the member element.
|
|
23
|
+
*
|
|
24
|
+
* @remarks
|
|
25
|
+
* Contains the Doxygen-generated unique identifier used for creating
|
|
26
|
+
* cross-references and hyperlinks to the detailed member definition.
|
|
27
|
+
* This identifier serves as the primary mechanism for linking between
|
|
28
|
+
* member references and their corresponding comprehensive definitions
|
|
29
|
+
* within the documentation system.
|
|
30
|
+
*
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
7
33
|
refid: string;
|
|
34
|
+
/**
|
|
35
|
+
* Constructs a new member type data model from XML element data.
|
|
36
|
+
*
|
|
37
|
+
* @param xml - The XML parser instance for processing element data
|
|
38
|
+
* @param element - The XML element containing member type information
|
|
39
|
+
* @param elementName - The name of the XML element being processed
|
|
40
|
+
*
|
|
41
|
+
* @remarks
|
|
42
|
+
* Processes the XML element representing simplified member information
|
|
43
|
+
* and extracts the essential identification data including name and
|
|
44
|
+
* reference identifier. The constructor handles the MemberType schema
|
|
45
|
+
* requirements whilst accommodating the practical deviation where
|
|
46
|
+
* member names may be empty in certain contexts.
|
|
47
|
+
*
|
|
48
|
+
* The implementation validates mandatory attributes (refid, kind) and
|
|
49
|
+
* ensures proper element structure according to the XML Schema
|
|
50
|
+
* definition for MemberType elements.
|
|
51
|
+
*
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
8
54
|
constructor(xml: DoxygenXmlParser, element: object, elementName: string);
|
|
9
55
|
}
|
|
56
|
+
/**
|
|
57
|
+
* Union type representing member kind classifications within Doxygen
|
|
58
|
+
* documentation.
|
|
59
|
+
*
|
|
60
|
+
* @remarks
|
|
61
|
+
* Defines the complete set of member types that can be classified within
|
|
62
|
+
* the MemberKind enumeration, covering fundamental programming constructs
|
|
63
|
+
* and framework-specific elements. This enumeration provides a focused
|
|
64
|
+
* subset of member classifications used specifically for member element
|
|
65
|
+
* identification and categorisation.
|
|
66
|
+
*
|
|
67
|
+
* The enumeration encompasses traditional programming elements (functions,
|
|
68
|
+
* variables, typedefs, enums), preprocessor constructs (defines), modern
|
|
69
|
+
* language features (properties, events), and specialised framework
|
|
70
|
+
* constructs including Qt-specific elements (signals, slots) and legacy
|
|
71
|
+
* communication mechanisms (dcop).
|
|
72
|
+
*
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
10
75
|
export type MemberKind = 'define' | 'property' | 'event' | 'variable' | 'typedef' | 'enum' | 'function' | 'signal' | 'prototype' | 'friend' | 'dcop' | 'slot';
|
|
11
76
|
/**
|
|
77
|
+
* Concrete implementation for member elements within documentation.
|
|
78
|
+
*
|
|
79
|
+
* @remarks
|
|
80
|
+
* Provides specific handling for member XML elements that contain
|
|
81
|
+
* simplified member information within various documentation contexts.
|
|
82
|
+
* This implementation extends the abstract base class functionality
|
|
83
|
+
* to process member elements with the specific element name 'member'.
|
|
84
|
+
*
|
|
85
|
+
* The class represents lightweight member references that serve as
|
|
86
|
+
* cross-reference points to more detailed member definitions, maintaining
|
|
87
|
+
* essential identification data whilst enabling efficient navigation
|
|
88
|
+
* within the documentation system. These elements are commonly used
|
|
89
|
+
* in member lists and summary sections where full member details
|
|
90
|
+
* are not required.
|
|
91
|
+
*
|
|
12
92
|
* @public
|
|
13
93
|
*/
|
|
14
94
|
export declare class MemberDataModel extends AbstractMemberType {
|
|
95
|
+
/**
|
|
96
|
+
* Constructs a new member data model instance.
|
|
97
|
+
*
|
|
98
|
+
* @param xml - The XML parser instance for processing elements
|
|
99
|
+
* @param element - The source XML element containing member data
|
|
100
|
+
*
|
|
101
|
+
* @remarks
|
|
102
|
+
* Initialises the data model with the specific element name 'member'
|
|
103
|
+
* and delegates processing to the abstract base class implementation.
|
|
104
|
+
* This ensures consistent handling of simplified member information
|
|
105
|
+
* whilst maintaining proper element identification for cross-referencing
|
|
106
|
+
* and navigation functionality.
|
|
107
|
+
*
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
15
110
|
constructor(xml: DoxygenXmlParser, element: object);
|
|
16
111
|
}
|
|
17
112
|
//# sourceMappingURL=membertype-dm.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"membertype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/membertype-dm.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAY9D
|
|
1
|
+
{"version":3,"file":"membertype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/membertype-dm.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAY9D;;;;;;;;;;;;;;;;GAgBG;AACH,8BAAsB,kBAAmB,SAAQ,sBAAsB;IACrE;;;;;;;;;;;OAWG;IACH,KAAK,SAAK;IAEV;;;;;;;;;;;;;;;;;;;OAmBG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA2DxE;AAsBD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,UAAU,GAClB,QAAQ,GACR,UAAU,GACV,OAAO,GACP,UAAU,GACV,SAAS,GACT,MAAM,GACN,UAAU,GACV,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,MAAM,GACN,MAAM,CAAA;AAMV;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,eAAgB,SAAQ,kBAAkB;IACrD;;;;;;;;;;;;;;OAcG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
|
|
@@ -21,14 +21,56 @@ import { AbstractMemberBaseType } from './memberdeftype-dm.js';
|
|
|
21
21
|
// <xsd:attribute name="kind" type="MemberKind" use="required"/>
|
|
22
22
|
// </xsd:complexType>
|
|
23
23
|
/**
|
|
24
|
+
* Abstract base class for member type data models within documentation.
|
|
25
|
+
*
|
|
26
|
+
* @remarks
|
|
27
|
+
* Represents member elements as defined by the MemberType XML Schema,
|
|
28
|
+
* providing fundamental member identification and classification
|
|
29
|
+
* functionality. This class extends AbstractMemberBaseType to handle
|
|
30
|
+
* the specific requirements of member elements that contain simplified
|
|
31
|
+
* member information with reference identifiers.
|
|
32
|
+
*
|
|
33
|
+
* The implementation processes member elements that primarily serve as
|
|
34
|
+
* lightweight references to more detailed member definitions, maintaining
|
|
35
|
+
* essential identification data including names, reference identifiers,
|
|
36
|
+
* and member kind classifications for cross-referencing purposes.
|
|
37
|
+
*
|
|
24
38
|
* @public
|
|
25
39
|
*/
|
|
26
40
|
export class AbstractMemberType extends AbstractMemberBaseType {
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
41
|
+
/**
|
|
42
|
+
* The unique reference identifier for the member element.
|
|
43
|
+
*
|
|
44
|
+
* @remarks
|
|
45
|
+
* Contains the Doxygen-generated unique identifier used for creating
|
|
46
|
+
* cross-references and hyperlinks to the detailed member definition.
|
|
47
|
+
* This identifier serves as the primary mechanism for linking between
|
|
48
|
+
* member references and their corresponding comprehensive definitions
|
|
49
|
+
* within the documentation system.
|
|
50
|
+
*
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
30
53
|
refid = '';
|
|
31
|
-
|
|
54
|
+
/**
|
|
55
|
+
* Constructs a new member type data model from XML element data.
|
|
56
|
+
*
|
|
57
|
+
* @param xml - The XML parser instance for processing element data
|
|
58
|
+
* @param element - The XML element containing member type information
|
|
59
|
+
* @param elementName - The name of the XML element being processed
|
|
60
|
+
*
|
|
61
|
+
* @remarks
|
|
62
|
+
* Processes the XML element representing simplified member information
|
|
63
|
+
* and extracts the essential identification data including name and
|
|
64
|
+
* reference identifier. The constructor handles the MemberType schema
|
|
65
|
+
* requirements whilst accommodating the practical deviation where
|
|
66
|
+
* member names may be empty in certain contexts.
|
|
67
|
+
*
|
|
68
|
+
* The implementation validates mandatory attributes (refid, kind) and
|
|
69
|
+
* ensures proper element structure according to the XML Schema
|
|
70
|
+
* definition for MemberType elements.
|
|
71
|
+
*
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
32
74
|
constructor(xml, element, elementName) {
|
|
33
75
|
super(elementName);
|
|
34
76
|
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
@@ -75,9 +117,39 @@ export class AbstractMemberType extends AbstractMemberBaseType {
|
|
|
75
117
|
// ----------------------------------------------------------------------------
|
|
76
118
|
// <xsd:element name="member" type="MemberType" minOccurs="0" maxOccurs="unbounded" />
|
|
77
119
|
/**
|
|
120
|
+
* Concrete implementation for member elements within documentation.
|
|
121
|
+
*
|
|
122
|
+
* @remarks
|
|
123
|
+
* Provides specific handling for member XML elements that contain
|
|
124
|
+
* simplified member information within various documentation contexts.
|
|
125
|
+
* This implementation extends the abstract base class functionality
|
|
126
|
+
* to process member elements with the specific element name 'member'.
|
|
127
|
+
*
|
|
128
|
+
* The class represents lightweight member references that serve as
|
|
129
|
+
* cross-reference points to more detailed member definitions, maintaining
|
|
130
|
+
* essential identification data whilst enabling efficient navigation
|
|
131
|
+
* within the documentation system. These elements are commonly used
|
|
132
|
+
* in member lists and summary sections where full member details
|
|
133
|
+
* are not required.
|
|
134
|
+
*
|
|
78
135
|
* @public
|
|
79
136
|
*/
|
|
80
137
|
export class MemberDataModel extends AbstractMemberType {
|
|
138
|
+
/**
|
|
139
|
+
* Constructs a new member data model instance.
|
|
140
|
+
*
|
|
141
|
+
* @param xml - The XML parser instance for processing elements
|
|
142
|
+
* @param element - The source XML element containing member data
|
|
143
|
+
*
|
|
144
|
+
* @remarks
|
|
145
|
+
* Initialises the data model with the specific element name 'member'
|
|
146
|
+
* and delegates processing to the abstract base class implementation.
|
|
147
|
+
* This ensures consistent handling of simplified member information
|
|
148
|
+
* whilst maintaining proper element identification for cross-referencing
|
|
149
|
+
* and navigation functionality.
|
|
150
|
+
*
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
81
153
|
constructor(xml, element) {
|
|
82
154
|
// console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
|
|
83
155
|
super(xml, element, 'member');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"membertype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/membertype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAE9D,+EAA+E;AAE/E,sCAAsC;AACtC,mBAAmB;AACnB,gFAAgF;AAChF,oBAAoB;AACpB,mEAAmE;AACnE,kEAAkE;AAClE,qBAAqB;AAErB
|
|
1
|
+
{"version":3,"file":"membertype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/membertype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAE9D,+EAA+E;AAE/E,sCAAsC;AACtC,mBAAmB;AACnB,gFAAgF;AAChF,oBAAoB;AACpB,mEAAmE;AACnE,kEAAkE;AAClE,qBAAqB;AAErB;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,sBAAsB;IACrE;;;;;;;;;;;OAWG;IACH,KAAK,GAAG,EAAE,CAAA;IAEV;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,aAAa,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAChE,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAEhC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnC,gBAAgB;YAClB,CAAC;iBAAM,IAAI,GAAG,CAAC,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC;gBACxD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;YAC3D,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,WAAW,EACzB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,+BAA+B;QAC/B,+BAA+B;QAE/B,2EAA2E;QAC3E,sBAAsB;QAEtB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAElC,MAAM,eAAe,GAAG,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACvD,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;gBACtC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;YAC5D,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;gBACpE,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,aAAa,EAC3B,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAuDD,+EAA+E;AAE/E,sFAAsF;AAEtF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,eAAgB,SAAQ,kBAAkB;IACrD;;;;;;;;;;;;;;OAcG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACF;AAED,+EAA+E"}
|