@xpack/doxygen2docusaurus 1.0.2 → 2.0.0

package/dist/doxygen/data-model/compounds/reftype-dm.d.ts

@@ -1,55 +1,302 @@
 import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
 import { AbstractDataModelBase } from '../types.js';
 /**
+ * Abstract base class for reference type data models.
+ *
+ * @remarks
+ * Represents the foundational structure for reference elements within Doxygen
+ * XML documentation, corresponding to the refType complex type in the XML
+ * schema. This class manages references to various documented entities such
+ * as classes, namespaces, files, folders, modules, pages, and groups. Each
+ * reference includes the entity name, a unique identifier for linking, and
+ * optional protection and inline attributes. All concrete reference
+ * implementations should extend this base to ensure consistent structure
+ * and parsing behaviour across different reference types.
+ *
  * @public
  */
 export declare abstract class AbstractRefType extends AbstractDataModelBase {
+    /**
+     * The name of the referenced entity.
+     *
+     * @remarks
+     * Mandatory element containing the textual name of the referenced entity,
+     * passed as the element's text content. This name provides human-readable
+     * identification of the referenced item and is used for display and
+     * navigation purposes within the generated documentation.
+     */
     text: string;
+    /**
+     * The unique reference identifier for the referenced entity.
+     *
+     * @remarks
+     * Mandatory attribute that provides a unique identifier for the referenced
+     * entity within the Doxygen documentation system. This identifier enables
+     * precise linking and cross-referencing between documentation elements,
+     * allowing navigation to the detailed documentation of the referenced item.
+     */
     refid: string;
+    /**
+     * The protection level of the referenced entity.
+     *
+     * @remarks
+     * Optional attribute specifying the protection level according to the
+     * DoxProtectionKind enumeration. Values include 'public', 'protected',
+     * 'private', and 'package', indicating the accessibility scope of the
+     * referenced entity within its containing context.
+     */
     prot?: string | undefined;
+    /**
+     * Indicates whether the referenced entity is inline.
+     *
+     * @remarks
+     * Optional boolean attribute that specifies whether the referenced entity
+     * is defined inline within its containing context. This information affects
+     * how the entity is presented and processed in the generated documentation,
+     * particularly for inline classes, functions, or other code constructs.
+     */
     inline?: boolean | undefined;
+    /**
+     * Constructs a new abstract reference type from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing reference data
+     * @param elementName - The expected XML element name
+     *
+     * @remarks
+     * Parses the provided XML element to construct a complete reference data
+     * model. The parsing process extracts the textual content from the element
+     * and processes all defined attributes including the mandatory refid and
+     * optional protection and inline attributes. Validation ensures that both
+     * the reference name and identifier are present and non-empty, maintaining
+     * the integrity of the reference documentation.
+     */
     constructor(xml: DoxygenXmlParser, element: object, elementName: string);
 }
+/**
+ * Data model for inner module reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner module within Doxygen XML documentation,
+ * corresponding to the innermodule XML element. This class manages references
+ * to modules that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed module
+ * documentation. Inner modules typically represent modular components or
+ * subsystems within larger software projects.
+ *
+ * @public
+ */
 export declare class InnerModuleDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner module reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner module reference data
+     *
+     * @remarks
+     * Creates a complete inner module reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innermodule element type,
+     * establishing the reference to the contained module entity.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 /**
+ * Data model for inner folder reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner folder within Doxygen XML documentation,
+ * corresponding to the innerdir XML element. This class manages references
+ * to folders that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed folder
+ * documentation. Inner folders typically represent subdirectories within
+ * the project structure that contain related source files and documentation.
+ *
  * @public
  */
 export declare class InnerDirDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner folder reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner folder reference data
+     *
+     * @remarks
+     * Creates a complete inner folder reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innerdir element type,
+     * establishing the reference to the contained folder entity.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 /**
+ * Data model for inner file reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner file within Doxygen XML documentation,
+ * corresponding to the innerfile XML element. This class manages references
+ * to files that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed file
+ * documentation. Inner files typically represent source code files, headers,
+ * or other documented files within the project structure.
+ *
  * @public
  */
 export declare class InnerFileDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner file reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner file reference data
+     *
+     * @remarks
+     * Creates a complete inner file reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innerfile element type,
+     * establishing the reference to the contained file entity.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 /**
+ * Data model for inner class reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner class within Doxygen XML documentation,
+ * corresponding to the innerclass XML element. This class manages references
+ * to classes that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed class
+ * documentation. Inner classes typically represent nested classes, inner
+ * types, or classes defined within other classes or namespaces.
+ *
  * @public
  */
 export declare class InnerClassDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner class reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner class reference data
+     *
+     * @remarks
+     * Creates a complete inner class reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innerclass element type,
+     * establishing the reference to the contained class entity.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
+/**
+ * Data model for inner concept reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner concept within Doxygen XML documentation,
+ * corresponding to the innerconcept XML element. This class manages references
+ * to concepts that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed concept
+ * documentation. Inner concepts typically represent C++20 concepts or similar
+ * constraint-based language features defined within classes or namespaces.
+ *
+ * @public
+ */
 export declare class InnerConceptDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner concept reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner concept reference data
+     *
+     * @remarks
+     * Creates a complete inner concept reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innerconcept element type,
+     * establishing the reference to the contained concept entity.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 /**
+ * Data model for inner namespace reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner namespace within Doxygen XML
+ * documentation, corresponding to the innernamespace XML element. This class
+ * manages references to namespaces that are contained within the current
+ * documentation context, providing linking and navigation capabilities to
+ * detailed namespace documentation. Inner namespaces typically represent
+ * nested namespaces or namespace aliases defined within other namespaces.
+ *
  * @public
  */
 export declare class InnerNamespaceDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner namespace reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner namespace reference data
+     *
+     * @remarks
+     * Creates a complete inner namespace reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innernamespace element
+     * type, establishing the reference to the contained namespace entity.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 /**
+ * Data model for inner page reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner page within Doxygen XML documentation,
+ * corresponding to the innerpage XML element. This class manages references
+ * to pages that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed page
+ * documentation. Inner pages typically represent documentation pages,
+ * tutorials, or other narrative content that is logically contained within
+ * the current documentation scope.
+ *
  * @public
  */
 export declare class InnerPageDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner page reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner page reference data
+     *
+     * @remarks
+     * Creates a complete inner page reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innerpage element type,
+     * establishing the reference to the contained page entity.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 /**
+ * Data model for inner group reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner group within Doxygen XML documentation,
+ * corresponding to the innergroup XML element. This class manages references
+ * to groups that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed group
+ * documentation. Inner groups typically represent logical collections or
+ * modules of related functionality that are organised within the current
+ * documentation scope.
+ *
  * @public
  */
 export declare class InnerGroupDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner group reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner group reference data
+     *
+     * @remarks
+     * Creates a complete inner group reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innergroup element type,
+     * establishing the reference to the contained group entity.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 //# sourceMappingURL=reftype-dm.d.ts.map

package/dist/doxygen/data-model/compounds/reftype-dm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reftype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAuBnD;;GAEG;AACH,8BAAsB,eAAgB,SAAQ,qBAAqB;IAEjE,IAAI,SAAK;IAGT,KAAK,SAAK;IAGV,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;gBAEhB,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA2CxE;AAaD,qBAAa,oBAAqB,SAAQ,eAAe;gBAC3C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;gBACxC,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,eAAe;gBACzC,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,eAAe;gBAC1C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED,qBAAa,qBAAsB,SAAQ,eAAe;gBAC5C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,eAAe;gBAC9C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,eAAe;gBACzC,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,eAAe;gBAC1C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
+{"version":3,"file":"reftype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAuBnD;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,eAAgB,SAAQ,qBAAqB;IACjE;;;;;;;;OAQG;IACH,IAAI,SAAK;IAET;;;;;;;;OAQG;IACH,KAAK,SAAK;IAEV;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAEzB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAE5B;;;;;;;;;;;;;;OAcG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA2CxE;AAaD;;;;;;;;;;;;GAYG;AACH,qBAAa,oBAAqB,SAAQ,eAAe;IACvD;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;IACpD;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,kBAAmB,SAAQ,eAAe;IACrD;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,mBAAoB,SAAQ,eAAe;IACtD;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,qBAAsB,SAAQ,eAAe;IACxD;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,uBAAwB,SAAQ,eAAe;IAC1D;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,kBAAmB,SAAQ,eAAe;IACrD;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,mBAAoB,SAAQ,eAAe;IACtD;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

package/dist/doxygen/data-model/compounds/reftype-dm.js

@@ -31,16 +31,76 @@ import { AbstractDataModelBase } from '../types.js';
 // </xsd:restriction>
 // </xsd:simpleType>
 /**
+ * Abstract base class for reference type data models.
+ *
+ * @remarks
+ * Represents the foundational structure for reference elements within Doxygen
+ * XML documentation, corresponding to the refType complex type in the XML
+ * schema. This class manages references to various documented entities such
+ * as classes, namespaces, files, folders, modules, pages, and groups. Each
+ * reference includes the entity name, a unique identifier for linking, and
+ * optional protection and inline attributes. All concrete reference
+ * implementations should extend this base to ensure consistent structure
+ * and parsing behaviour across different reference types.
+ *
  * @public
  */
 export class AbstractRefType extends AbstractDataModelBase {
-    // Mandatory elements.
+    /**
+     * The name of the referenced entity.
+     *
+     * @remarks
+     * Mandatory element containing the textual name of the referenced entity,
+     * passed as the element's text content. This name provides human-readable
+     * identification of the referenced item and is used for display and
+     * navigation purposes within the generated documentation.
+     */
     text = ''; // The name of the reference, passed as element text.
-    // Mandatory attributes.
+    /**
+     * The unique reference identifier for the referenced entity.
+     *
+     * @remarks
+     * Mandatory attribute that provides a unique identifier for the referenced
+     * entity within the Doxygen documentation system. This identifier enables
+     * precise linking and cross-referencing between documentation elements,
+     * allowing navigation to the detailed documentation of the referenced item.
+     */
     refid = '';
-    // Optional attributes.
+    /**
+     * The protection level of the referenced entity.
+     *
+     * @remarks
+     * Optional attribute specifying the protection level according to the
+     * DoxProtectionKind enumeration. Values include 'public', 'protected',
+     * 'private', and 'package', indicating the accessibility scope of the
+     * referenced entity within its containing context.
+     */
     prot; // DoxProtectionKind
+    /**
+     * Indicates whether the referenced entity is inline.
+     *
+     * @remarks
+     * Optional boolean attribute that specifies whether the referenced entity
+     * is defined inline within its containing context. This information affects
+     * how the entity is presented and processed in the generated documentation,
+     * particularly for inline classes, functions, or other code constructs.
+     */
     inline; // DoxBool
+    /**
+     * Constructs a new abstract reference type from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing reference data
+     * @param elementName - The expected XML element name
+     *
+     * @remarks
+     * Parses the provided XML element to construct a complete reference data
+     * model. The parsing process extracts the textual content from the element
+     * and processes all defined attributes including the mandatory refid and
+     * optional protection and inline attributes. Validation ensures that both
+     * the reference name and identifier are present and non-empty, maintaining
+     * the integrity of the reference documentation.
+     */
     constructor(xml, element, elementName) {
         super(elementName);
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
@@ -82,67 +142,251 @@ export class AbstractRefType extends AbstractDataModelBase {
 // <xsd:element name="innernamespace" type="refType" minOccurs="0" maxOccurs="unbounded" />
 // <xsd:element name="innerpage" type="refType" minOccurs="0" maxOccurs="unbounded" />
 // <xsd:element name="innergroup" type="refType" minOccurs="0" maxOccurs="unbounded" />
+/**
+ * Data model for inner module reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner module within Doxygen XML documentation,
+ * corresponding to the innermodule XML element. This class manages references
+ * to modules that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed module
+ * documentation. Inner modules typically represent modular components or
+ * subsystems within larger software projects.
+ *
+ * @public
+ */
 export class InnerModuleDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner module reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner module reference data
+     *
+     * @remarks
+     * Creates a complete inner module reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innermodule element type,
+     * establishing the reference to the contained module entity.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'innermodule');
     }
 }
 /**
+ * Data model for inner folder reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner folder within Doxygen XML documentation,
+ * corresponding to the innerdir XML element. This class manages references
+ * to folders that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed folder
+ * documentation. Inner folders typically represent subdirectories within
+ * the project structure that contain related source files and documentation.
+ *
  * @public
  */
 export class InnerDirDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner folder reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner folder reference data
+     *
+     * @remarks
+     * Creates a complete inner folder reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innerdir element type,
+     * establishing the reference to the contained folder entity.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'innerdir');
     }
 }
 /**
+ * Data model for inner file reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner file within Doxygen XML documentation,
+ * corresponding to the innerfile XML element. This class manages references
+ * to files that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed file
+ * documentation. Inner files typically represent source code files, headers,
+ * or other documented files within the project structure.
+ *
  * @public
  */
 export class InnerFileDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner file reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner file reference data
+     *
+     * @remarks
+     * Creates a complete inner file reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innerfile element type,
+     * establishing the reference to the contained file entity.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'innerfile');
     }
 }
 /**
+ * Data model for inner class reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner class within Doxygen XML documentation,
+ * corresponding to the innerclass XML element. This class manages references
+ * to classes that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed class
+ * documentation. Inner classes typically represent nested classes, inner
+ * types, or classes defined within other classes or namespaces.
+ *
  * @public
  */
 export class InnerClassDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner class reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner class reference data
+     *
+     * @remarks
+     * Creates a complete inner class reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innerclass element type,
+     * establishing the reference to the contained class entity.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'innerclass');
     }
 }
+/**
+ * Data model for inner concept reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner concept within Doxygen XML documentation,
+ * corresponding to the innerconcept XML element. This class manages references
+ * to concepts that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed concept
+ * documentation. Inner concepts typically represent C++20 concepts or similar
+ * constraint-based language features defined within classes or namespaces.
+ *
+ * @public
+ */
 export class InnerConceptDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner concept reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner concept reference data
+     *
+     * @remarks
+     * Creates a complete inner concept reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innerconcept element type,
+     * establishing the reference to the contained concept entity.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'innerconcept');
     }
 }
 /**
+ * Data model for inner namespace reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner namespace within Doxygen XML
+ * documentation, corresponding to the innernamespace XML element. This class
+ * manages references to namespaces that are contained within the current
+ * documentation context, providing linking and navigation capabilities to
+ * detailed namespace documentation. Inner namespaces typically represent
+ * nested namespaces or namespace aliases defined within other namespaces.
+ *
  * @public
  */
 export class InnerNamespaceDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner namespace reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner namespace reference data
+     *
+     * @remarks
+     * Creates a complete inner namespace reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innernamespace element
+     * type, establishing the reference to the contained namespace entity.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'innernamespace');
     }
 }
 /**
+ * Data model for inner page reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner page within Doxygen XML documentation,
+ * corresponding to the innerpage XML element. This class manages references
+ * to pages that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed page
+ * documentation. Inner pages typically represent documentation pages,
+ * tutorials, or other narrative content that is logically contained within
+ * the current documentation scope.
+ *
  * @public
  */
 export class InnerPageDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner page reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner page reference data
+     *
+     * @remarks
+     * Creates a complete inner page reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innerpage element type,
+     * establishing the reference to the contained page entity.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'innerpage');
     }
 }
 /**
+ * Data model for inner group reference elements.
+ *
+ * @remarks
+ * Represents a reference to an inner group within Doxygen XML documentation,
+ * corresponding to the innergroup XML element. This class manages references
+ * to groups that are contained within the current documentation context,
+ * providing linking and navigation capabilities to detailed group
+ * documentation. Inner groups typically represent logical collections or
+ * modules of related functionality that are organised within the current
+ * documentation scope.
+ *
  * @public
  */
 export class InnerGroupDataModel extends AbstractRefType {
+    /**
+     * Constructs a new inner group reference data model from XML.
+     *
+     * @param xml - The Doxygen XML parser instance
+     * @param element - The XML element containing inner group reference data
+     *
+     * @remarks
+     * Creates a complete inner group reference data model by parsing the
+     * provided XML element. This constructor delegates to the parent class to
+     * handle all standard parsing operations for the innergroup element type,
+     * establishing the reference to the contained group entity.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'innergroup');

package/dist/doxygen/data-model/compounds/reftype-dm.js.map

@@ -1 +1 @@
-{"version":3,"file":"reftype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,mCAAmC;AACnC,sBAAsB;AACtB,sCAAsC;AACtC,uDAAuD;AACvD,2EAA2E;AAC3E,mEAAmE;AACnE,qBAAqB;AACrB,uBAAuB;AACvB,qBAAqB;AAErB,4CAA4C;AAC5C,sCAAsC;AACtC,uCAAuC;AACvC,0CAA0C;AAC1C,wCAAwC;AACxC,wCAAwC;AACxC,qBAAqB;AACrB,oBAAoB;AAEpB;;GAEG;AACH,MAAM,OAAgB,eAAgB,SAAQ,qBAAqB;IACjE,sBAAsB;IACtB,IAAI,GAAG,EAAE,CAAA,CAAC,qDAAqD;IAE/D,wBAAwB;IACxB,KAAK,GAAG,EAAE,CAAA;IAEV,uBAAuB;IACvB,IAAI,CAAqB,CAAC,oBAAoB;IAC9C,MAAM,CAAsB,CAAC,UAAU;IAEvC,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAEzD,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,UAAU,EAAE,CAAC;gBACxC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAA;YAC1E,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;QAE7B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,wFAAwF;AACxF,qFAAqF;AACrF,sFAAsF;AACtF,uFAAuF;AACvF,yFAAyF;AACzF,2FAA2F;AAC3F,sFAAsF;AACtF,uFAAuF;AAEvF,MAAM,OAAO,oBAAqB,SAAQ,eAAe;IACvD,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,CAAA;IACpC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IACpD,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;IACjC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,eAAe;IACrD,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IAClC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACtD,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IACxD,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;IACrC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,eAAe;IAC1D,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAA;IACvC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,eAAe;IACrD,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IAClC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACtD,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"reftype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,mCAAmC;AACnC,sBAAsB;AACtB,sCAAsC;AACtC,uDAAuD;AACvD,2EAA2E;AAC3E,mEAAmE;AACnE,qBAAqB;AACrB,uBAAuB;AACvB,qBAAqB;AAErB,4CAA4C;AAC5C,sCAAsC;AACtC,uCAAuC;AACvC,0CAA0C;AAC1C,wCAAwC;AACxC,wCAAwC;AACxC,qBAAqB;AACrB,oBAAoB;AAEpB;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAgB,eAAgB,SAAQ,qBAAqB;IACjE;;;;;;;;OAQG;IACH,IAAI,GAAG,EAAE,CAAA,CAAC,qDAAqD;IAE/D;;;;;;;;OAQG;IACH,KAAK,GAAG,EAAE,CAAA;IAEV;;;;;;;;OAQG;IACH,IAAI,CAAqB,CAAC,oBAAoB;IAE9C;;;;;;;;OAQG;IACH,MAAM,CAAsB,CAAC,UAAU;IAEvC;;;;;;;;;;;;;;OAcG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAEzD,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,UAAU,EAAE,CAAC;gBACxC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAA;YAC1E,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;QAE7B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,wFAAwF;AACxF,qFAAqF;AACrF,sFAAsF;AACtF,uFAAuF;AACvF,yFAAyF;AACzF,2FAA2F;AAC3F,sFAAsF;AACtF,uFAAuF;AAEvF;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,oBAAqB,SAAQ,eAAe;IACvD;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,CAAA;IACpC,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IACpD;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;IACjC,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,kBAAmB,SAAQ,eAAe;IACrD;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IAClC,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACtD;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IACxD;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;IACrC,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,uBAAwB,SAAQ,eAAe;IAC1D;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAA;IACvC,CAAC;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,kBAAmB,SAAQ,eAAe;IACrD;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IAClC,CAAC;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACtD;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAED,+EAA+E"}