@xpack/doxygen2docusaurus 1.0.2 → 2.0.0

package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"indexcompoundtype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexcompoundtype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAanD;;GAEG;AACH,8BAAsB,yBAA0B,SAAQ,qBAAqB;IAE3E,IAAI,SAAK;IACT,OAAO,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAA;IAG3C,KAAK,SAAK;IACV,IAAI,SAAK;gBAEG,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA+DxE;AAyBD,MAAM,MAAM,iBAAiB,GACzB,OAAO,GACP,QAAQ,GACR,OAAO,GACP,WAAW,GACX,UAAU,GACV,UAAU,GACV,WAAW,GACX,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,SAAS,GACT,KAAK,GACL,MAAM,GACN,SAAS,GACT,QAAQ,CAAA;AAMZ;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,yBAAyB;gBACvD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
+{"version":3,"file":"indexcompoundtype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexcompoundtype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAanD;;;;;;;;;;;;GAYG;AACH,8BAAsB,yBAA0B,SAAQ,qBAAqB;IAC3E;;;;;;;OAOG;IACH,IAAI,SAAK;IAET;;;;;;;;OAQG;IACH,OAAO,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAA;IAE3C;;;;;;;OAOG;IACH,KAAK,SAAK;IAEV;;;;;;;OAOG;IACH,IAAI,SAAK;IAET;;;;;;;;;;;;;OAaG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA+DxE;AAyBD;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,iBAAiB,GACzB,OAAO,GACP,QAAQ,GACR,OAAO,GACP,WAAW,GACX,UAAU,GACV,UAAU,GACV,WAAW,GACX,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,SAAS,GACT,KAAK,GACL,MAAM,GACN,SAAS,GACT,QAAQ,CAAA;AAMZ;;;;;;;;;;;;GAYG;AACH,qBAAa,sBAAuB,SAAQ,yBAAyB;IACnE;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

package/dist/doxygen/data-model/index/indexcompoundtype-dm.js

@@ -23,15 +23,70 @@ import { AbstractDataModelBase } from '../types.js';
 //   <xsd:attribute name="kind" type="CompoundKind" use="required"/>
 // </xsd:complexType>
 /**
+ * Abstract base class for index compound type data models.
+ *
+ * @remarks
+ * Represents compound elements found within Doxygen index XML structures,
+ * corresponding to the CompoundType complex type in the XML schema. This
+ * class handles the parsing of compound names, member collections, and
+ * mandatory attributes (refid and kind). All concrete compound data model
+ * classes should extend this abstract base to ensure consistent parsing
+ * and data representation.
+ *
  * @public
  */
 export class AbstractIndexCompoundType extends AbstractDataModelBase {
-    // Mandatory elements.
+    /**
+     * The name of the compound element.
+     *
+     * @remarks
+     * Extracted from the mandatory 'name' element within the compound XML
+     * structure. Represents the identifier or name of the documented compound
+     * such as a class name, namespace, or filename.
+     */
     name = '';
+    /**
+     * Collection of member data models associated with this compound.
+     *
+     * @remarks
+     * Optional array containing member elements found within the compound
+     * structure. Each member represents a documented entity that belongs
+     * to this compound, such as functions, variables, or other nested
+     * constructs. The array supports zero to many members as per the XML schema.
+     */
     members; // [0-n]
-    // Mandatory attributes.
+    /**
+     * The unique reference identifier for this compound.
+     *
+     * @remarks
+     * Mandatory attribute that provides a unique identifier for referencing
+     * this compound within the Doxygen documentation structure. Used to link
+     * index entries to their detailed definitions in separate XML files.
+     */
     refid = '';
+    /**
+     * The kind classification of this compound.
+     *
+     * @remarks
+     * Mandatory attribute specifying the type of compound (e.g., class, struct,
+     * namespace, file). Corresponds to the CompoundKind enumeration in the
+     * XML schema, determining how the compound should be processed and presented.
+     */
     kind = ''; // CompoundKind
+    /**
+     * Constructs a new AbstractIndexCompoundType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the compound data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract compound information including
+     * the name element, member collections, and mandatory attributes (refid and
+     * kind). The constructor validates that all required data is present and
+     * properly formatted according to the XML schema specifications. Member
+     * elements are processed into IndexMemberDataModel instances when present.
+     */
     constructor(xml, element, elementName) {
         super(elementName);
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
@@ -84,9 +139,31 @@ export class AbstractIndexCompoundType extends AbstractDataModelBase {
 // ----------------------------------------------------------------------------
 // <xsd:element name="compound" type="CompoundType" minOccurs="0" maxOccurs="unbounded"/>
 /**
+ * Concrete data model class for index compound elements.
+ *
+ * @remarks
+ * Represents individual compound elements found within Doxygen index XML
+ * structures. This class extends the abstract base to provide specific
+ * handling for 'compound' elements, which reference documented entities
+ * such as classes, namespaces, files, and other structural components
+ * within the indexed documentation. Each compound serves as an entry
+ * point for accessing detailed documentation in separate XML files.
+ *
  * @public
  */
 export class IndexCompoundDataModel extends AbstractIndexCompoundType {
+    /**
+     * Constructs a new IndexCompoundDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the compound data
+     *
+     * @remarks
+     * Initialises the compound data model by parsing the provided XML element
+     * as a 'compound' element type. The constructor delegates to the parent
+     * class for common compound processing whilst specifying the element name
+     * for proper XML structure handling.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'compound');

package/dist/doxygen/data-model/index/indexcompoundtype-dm.js.map

@@ -1 +1 @@
-{"version":3,"file":"indexcompoundtype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexcompoundtype-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,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,wCAAwC;AACxC,mBAAmB;AACnB,mDAAmD;AACnD,yFAAyF;AACzF,oBAAoB;AACpB,mEAAmE;AACnE,oEAAoE;AACpE,qBAAqB;AAErB;;GAEG;AACH,MAAM,OAAgB,yBAA0B,SAAQ,qBAAqB;IAC3E,sBAAsB;IACtB,IAAI,GAAG,EAAE,CAAA;IACT,OAAO,CAAoC,CAAC,QAAQ;IAEpD,wBAAwB;IACxB,KAAK,GAAG,EAAE,CAAA;IACV,IAAI,GAAG,EAAE,CAAA,CAAC,eAAe;IAEzB,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,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;gBAC9B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;YAC3D,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;gBACvD,IAAI,CAAC,OAAO,KAAK,EAAE,CAAA;gBACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAChE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,SAAS,WAAW,WAAW,EAC/B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,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,+BAA+B;QAC/B,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,6BAA6B;YAC7B,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,SAAS,WAAW,aAAa,EACjC,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;QAClE,wCAAwC;IAC1C,CAAC;CACF;AA2CD,+EAA+E;AAE/E,yFAAyF;AAEzF;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,yBAAyB;IACnE,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;IACjC,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"indexcompoundtype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexcompoundtype-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,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,wCAAwC;AACxC,mBAAmB;AACnB,mDAAmD;AACnD,yFAAyF;AACzF,oBAAoB;AACpB,mEAAmE;AACnE,oEAAoE;AACpE,qBAAqB;AAErB;;;;;;;;;;;;GAYG;AACH,MAAM,OAAgB,yBAA0B,SAAQ,qBAAqB;IAC3E;;;;;;;OAOG;IACH,IAAI,GAAG,EAAE,CAAA;IAET;;;;;;;;OAQG;IACH,OAAO,CAAoC,CAAC,QAAQ;IAEpD;;;;;;;OAOG;IACH,KAAK,GAAG,EAAE,CAAA;IAEV;;;;;;;OAOG;IACH,IAAI,GAAG,EAAE,CAAA,CAAC,eAAe;IAEzB;;;;;;;;;;;;;OAaG;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,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;gBAC9B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;YAC3D,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;gBACvD,IAAI,CAAC,OAAO,KAAK,EAAE,CAAA;gBACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAChE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,SAAS,WAAW,WAAW,EAC/B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,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,+BAA+B;QAC/B,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,6BAA6B;YAC7B,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,SAAS,WAAW,aAAa,EACjC,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;QAClE,wCAAwC;IAC1C,CAAC;CACF;AAwDD,+EAA+E;AAE/E,yFAAyF;AAEzF;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,sBAAuB,SAAQ,yBAAyB;IACnE;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;IACjC,CAAC;CACF;AAED,+EAA+E"}

package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts

@@ -2,19 +2,95 @@ import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
 import { IndexCompoundDataModel } from './indexcompoundtype-dm.js';
 import { AbstractDataModelBase } from '../types.js';
 /**
+ * Abstract base class for Doxygen index type data models.
+ *
+ * @remarks
+ * Represents the top-level structure of Doxygen index XML files, corresponding
+ * to the DoxygenType complex type in the XML schema. This class handles the
+ * parsing of version and language attributes, along with compound element
+ * collections. Note that this definition may clash with similar types in
+ * compound.xsd, requiring careful namespace management.
+ *
  * @public
  */
 export declare abstract class AbstractIndexDoxygenType extends AbstractDataModelBase {
+    /**
+     * The version of the Doxygen tool that generated the XML.
+     *
+     * @remarks
+     * Mandatory attribute extracted from the XML structure that identifies
+     * the version of Doxygen used to generate the documentation. This
+     * information is crucial for compatibility and parsing decisions.
+     */
     version: string;
+    /**
+     * The language specification for the documentation content.
+     *
+     * @remarks
+     * Mandatory attribute corresponding to the xml:lang attribute in the
+     * XML structure. Specifies the primary language used in the documented
+     * content for internationalisation purposes.
+     */
     lang: string;
+    /**
+     * Collection of compound data models referenced in the index.
+     *
+     * @remarks
+     * Optional array containing compound elements found within the index
+     * structure. Each compound represents a documented entity such as
+     * classes, namespaces, or files that are catalogued in the index.
+     */
     compounds?: IndexCompoundDataModel[] | undefined;
+    /**
+     * The XML schema location reference for validation.
+     *
+     * @remarks
+     * Optional attribute that specifies the location of the XML schema
+     * definition used for validating the structure of the index XML file.
+     * This provides schema validation capabilities for the parsed content.
+     */
     noNamespaceSchemaLocation?: string | undefined;
+    /**
+     * Constructs a new AbstractIndexDoxygenType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the Doxygen index data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract Doxygen index information
+     * including compound collections and mandatory attributes (version and
+     * language). The constructor validates that all required attributes are
+     * present and processes compound elements into the appropriate data models.
+     * Optional schema location attributes are also extracted when present.
+     */
     constructor(xml: DoxygenXmlParser, element: object, elementName: string);
 }
 /**
+ * Concrete data model class for doxygenindex elements.
+ *
+ * @remarks
+ * Represents the root element of Doxygen index XML files, extending the
+ * abstract base class to provide specific handling for 'doxygenindex'
+ * elements. This class serves as the primary entry point for parsing
+ * index files and provides access to all compound definitions and
+ * metadata contained within the index structure.
+ *
  * @public
  */
 export declare class DoxygenIndexDataModel extends AbstractIndexDoxygenType {
+    /**
+     * Constructs a new DoxygenIndexDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the doxygenindex data
+     *
+     * @remarks
+     * Initialises the Doxygen index data model by parsing the provided XML
+     * element as a 'doxygenindex' element type. The constructor delegates
+     * to the parent class for common processing whilst specifying the
+     * element name for proper XML structure handling.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 //# sourceMappingURL=indexdoxygentype-dm.d.ts.map

package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"indexdoxygentype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexdoxygentype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAanD;;GAEG;AACH,8BAAsB,wBAAyB,SAAQ,qBAAqB;IAE1E,OAAO,SAAK;IACZ,IAAI,SAAK;IAGT,SAAS,CAAC,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAGhD,yBAAyB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;gBAElC,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA4DxE;AAMD;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,wBAAwB;gBACrD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
+{"version":3,"file":"indexdoxygentype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexdoxygentype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAanD;;;;;;;;;;;GAWG;AACH,8BAAsB,wBAAyB,SAAQ,qBAAqB;IAC1E;;;;;;;OAOG;IACH,OAAO,SAAK;IAEZ;;;;;;;OAOG;IACH,IAAI,SAAK;IAET;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAEhD;;;;;;;OAOG;IACH,yBAAyB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE9C;;;;;;;;;;;;;OAaG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA4DxE;AAMD;;;;;;;;;;;GAWG;AACH,qBAAa,qBAAsB,SAAQ,wBAAwB;IACjE;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

package/dist/doxygen/data-model/index/indexdoxygentype-dm.js

@@ -23,16 +23,68 @@ import { AbstractDataModelBase } from '../types.js';
 //   <xsd:attribute ref="xml:lang" use="required"/>
 // </xsd:complexType>
 /**
+ * Abstract base class for Doxygen index type data models.
+ *
+ * @remarks
+ * Represents the top-level structure of Doxygen index XML files, corresponding
+ * to the DoxygenType complex type in the XML schema. This class handles the
+ * parsing of version and language attributes, along with compound element
+ * collections. Note that this definition may clash with similar types in
+ * compound.xsd, requiring careful namespace management.
+ *
  * @public
  */
 export class AbstractIndexDoxygenType extends AbstractDataModelBase {
-    // Mandatory attributes.
+    /**
+     * The version of the Doxygen tool that generated the XML.
+     *
+     * @remarks
+     * Mandatory attribute extracted from the XML structure that identifies
+     * the version of Doxygen used to generate the documentation. This
+     * information is crucial for compatibility and parsing decisions.
+     */
     version = '';
+    /**
+     * The language specification for the documentation content.
+     *
+     * @remarks
+     * Mandatory attribute corresponding to the xml:lang attribute in the
+     * XML structure. Specifies the primary language used in the documented
+     * content for internationalisation purposes.
+     */
     lang = '';
-    // Optional elements.
+    /**
+     * Collection of compound data models referenced in the index.
+     *
+     * @remarks
+     * Optional array containing compound elements found within the index
+     * structure. Each compound represents a documented entity such as
+     * classes, namespaces, or files that are catalogued in the index.
+     */
     compounds;
-    // Optional attributes.
+    /**
+     * The XML schema location reference for validation.
+     *
+     * @remarks
+     * Optional attribute that specifies the location of the XML schema
+     * definition used for validating the structure of the index XML file.
+     * This provides schema validation capabilities for the parsed content.
+     */
     noNamespaceSchemaLocation;
+    /**
+     * Constructs a new AbstractIndexDoxygenType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the Doxygen index data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract Doxygen index information
+     * including compound collections and mandatory attributes (version and
+     * language). The constructor validates that all required attributes are
+     * present and processes compound elements into the appropriate data models.
+     * Optional schema location attributes are also extracted when present.
+     */
     constructor(xml, element, elementName) {
         super(elementName);
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
@@ -81,9 +133,30 @@ export class AbstractIndexDoxygenType extends AbstractDataModelBase {
 // ----------------------------------------------------------------------------
 // <xsd:element name="doxygenindex" type="DoxygenType"/>
 /**
+ * Concrete data model class for doxygenindex elements.
+ *
+ * @remarks
+ * Represents the root element of Doxygen index XML files, extending the
+ * abstract base class to provide specific handling for 'doxygenindex'
+ * elements. This class serves as the primary entry point for parsing
+ * index files and provides access to all compound definitions and
+ * metadata contained within the index structure.
+ *
  * @public
  */
 export class DoxygenIndexDataModel extends AbstractIndexDoxygenType {
+    /**
+     * Constructs a new DoxygenIndexDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the doxygenindex data
+     *
+     * @remarks
+     * Initialises the Doxygen index data model by parsing the provided XML
+     * element as a 'doxygenindex' element type. The constructor delegates
+     * to the parent class for common processing whilst specifying the
+     * element name for proper XML structure handling.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'doxygenindex');

package/dist/doxygen/data-model/index/indexdoxygentype-dm.js.map

@@ -1 +1 @@
-{"version":3,"file":"indexdoxygentype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexdoxygentype-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,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,2DAA2D;AAC3D,uCAAuC;AACvC,mBAAmB;AACnB,6FAA6F;AAC7F,oBAAoB;AACpB,qEAAqE;AACrE,mDAAmD;AACnD,qBAAqB;AAErB;;GAEG;AACH,MAAM,OAAgB,wBAAyB,SAAQ,qBAAqB;IAC1E,wBAAwB;IACxB,OAAO,GAAG,EAAE,CAAA;IACZ,IAAI,GAAG,EAAE,CAAA;IAET,qBAAqB;IACrB,SAAS,CAAuC;IAEhD,uBAAuB;IACvB,yBAAyB,CAAqB;IAE9C,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,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,eAAe,CAAC,YAAY,EAAE,UAAU,CAAC,EAAE,CAAC;gBACzD,IAAI,CAAC,SAAS,KAAK,EAAE,CAAA;gBACrB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YACpE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,SAAS,WAAW,WAAW,EAC/B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,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,+BAA+B;QAC/B,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,6BAA6B;YAC7B,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBAClC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,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,6BAA6B,EAAE,CAAC;gBAC3D,IAAI,CAAC,yBAAyB,GAAG,GAAG,CAAC,uBAAuB,CAC1D,OAAO,EACP,6BAA6B,CAC9B,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,SAAS,WAAW,aAAa,EACjC,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,wDAAwD;AAExD;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,wBAAwB;IACjE,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;IACrC,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"indexdoxygentype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexdoxygentype-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,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,2DAA2D;AAC3D,uCAAuC;AACvC,mBAAmB;AACnB,6FAA6F;AAC7F,oBAAoB;AACpB,qEAAqE;AACrE,mDAAmD;AACnD,qBAAqB;AAErB;;;;;;;;;;;GAWG;AACH,MAAM,OAAgB,wBAAyB,SAAQ,qBAAqB;IAC1E;;;;;;;OAOG;IACH,OAAO,GAAG,EAAE,CAAA;IAEZ;;;;;;;OAOG;IACH,IAAI,GAAG,EAAE,CAAA;IAET;;;;;;;OAOG;IACH,SAAS,CAAuC;IAEhD;;;;;;;OAOG;IACH,yBAAyB,CAAqB;IAE9C;;;;;;;;;;;;;OAaG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,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,eAAe,CAAC,YAAY,EAAE,UAAU,CAAC,EAAE,CAAC;gBACzD,IAAI,CAAC,SAAS,KAAK,EAAE,CAAA;gBACrB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YACpE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,SAAS,WAAW,WAAW,EAC/B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,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,+BAA+B;QAC/B,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,6BAA6B;YAC7B,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBAClC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,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,6BAA6B,EAAE,CAAC;gBAC3D,IAAI,CAAC,yBAAyB,GAAG,GAAG,CAAC,uBAAuB,CAC1D,OAAO,EACP,6BAA6B,CAC9B,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,SAAS,WAAW,aAAa,EACjC,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,wDAAwD;AAExD;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,qBAAsB,SAAQ,wBAAwB;IACjE;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;IACrC,CAAC;CACF;AAED,+EAA+E"}

package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts

@@ -1,19 +1,98 @@
 import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
 import { AbstractDataModelBase } from '../types.js';
 /**
+ * Abstract base class for index member type data models.
+ *
+ * @remarks
+ * Represents member elements found within Doxygen index XML structures,
+ * corresponding to the MemberType complex type in the XML schema. This
+ * class handles the parsing of member names, reference identifiers, and
+ * member kinds from the XML structure. All concrete member data model
+ * classes should extend this abstract base to ensure consistent parsing
+ * and data representation.
+ *
  * @public
  */
 export declare abstract class AbstractIndexMemberType extends AbstractDataModelBase {
+    /**
+     * The name of the member element.
+     *
+     * @remarks
+     * Extracted from the mandatory 'name' element within the member XML
+     * structure. Represents the identifier or name of the documented member.
+     */
     name: string;
+    /**
+     * The reference identifier for the member.
+     *
+     * @remarks
+     * Mandatory attribute that provides a unique identifier for referencing
+     * this member within the Doxygen documentation structure. Used to link
+     * index entries to their detailed definitions.
+     */
     refid: string;
+    /**
+     * The kind classification of the member.
+     *
+     * @remarks
+     * Mandatory attribute specifying the type of member (e.g., function,
+     * variable, typedef). Corresponds to the MemberKind enumeration in the
+     * XML schema.
+     */
     kind: string;
+    /**
+     * Constructs a new AbstractIndexMemberType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the member data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract member information including
+     * the name element and mandatory attributes (refid and kind). The constructor
+     * validates that all required data is present and properly formatted
+     * according to the XML schema specifications.
+     */
     constructor(xml: DoxygenXmlParser, element: object, elementName: string);
 }
+/**
+ * Union type representing the various kinds of members in Doxygen
+ * documentation.
+ *
+ * @remarks
+ * Corresponds to the MemberKind simple type in the Doxygen XML schema,
+ * which defines the allowable classifications for documented members.
+ * Each value represents a specific type of programming construct that
+ * can be documented, ranging from preprocessor definitions to class
+ * methods and properties.
+ *
+ * @public
+ */
 export type IndexMemberKind = 'define' | 'property' | 'event' | 'variable' | 'typedef' | 'enum' | 'enumvalue' | 'function' | 'signal' | 'prototype' | 'friend' | 'dcop' | 'slot';
 /**
+ * Concrete data model class for index member elements.
+ *
+ * @remarks
+ * Represents individual member elements found within Doxygen index XML
+ * structures. This class extends the abstract base to provide specific
+ * handling for 'member' elements, which reference documented members
+ * such as functions, variables, and other programming constructs within
+ * the indexed documentation.
+ *
  * @public
  */
 export declare class IndexMemberDataModel extends AbstractIndexMemberType {
+    /**
+     * Constructs a new IndexMemberDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the member data
+     *
+     * @remarks
+     * Initialises the member data model by parsing the provided XML element
+     * as a 'member' element type. The constructor delegates to the parent
+     * class for common member processing whilst specifying the element name.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 //# sourceMappingURL=indexmembertype-dm.d.ts.map

package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"indexmembertype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexmembertype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAYnD;;GAEG;AACH,8BAAsB,uBAAwB,SAAQ,qBAAqB;IAEzE,IAAI,SAAK;IAGT,KAAK,SAAK;IACV,IAAI,SAAK;gBAEG,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA2DxE;AAsBD,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,UAAU,GACV,OAAO,GACP,UAAU,GACV,SAAS,GACT,MAAM,GACN,WAAW,GACX,UAAU,GACV,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,MAAM,GACN,MAAM,CAAA;AAOV;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,uBAAuB;gBACnD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
+{"version":3,"file":"indexmembertype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexmembertype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAYnD;;;;;;;;;;;;GAYG;AACH,8BAAsB,uBAAwB,SAAQ,qBAAqB;IACzE;;;;;;OAMG;IACH,IAAI,SAAK;IAET;;;;;;;OAOG;IACH,KAAK,SAAK;IAEV;;;;;;;OAOG;IACH,IAAI,SAAK;IAET;;;;;;;;;;;;OAYG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA2DxE;AAsBD;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,UAAU,GACV,OAAO,GACP,UAAU,GACV,SAAS,GACT,MAAM,GACN,WAAW,GACX,UAAU,GACV,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,MAAM,GACN,MAAM,CAAA;AAOV;;;;;;;;;;;GAWG;AACH,qBAAa,oBAAqB,SAAQ,uBAAuB;IAC/D;;;;;;;;;;OAUG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

package/dist/doxygen/data-model/index/indexmembertype-dm.js

@@ -21,14 +21,58 @@ import { AbstractDataModelBase } from '../types.js';
 //   <xsd:attribute name="kind" type="MemberKind" use="required"/>
 // </xsd:complexType>
 /**
+ * Abstract base class for index member type data models.
+ *
+ * @remarks
+ * Represents member elements found within Doxygen index XML structures,
+ * corresponding to the MemberType complex type in the XML schema. This
+ * class handles the parsing of member names, reference identifiers, and
+ * member kinds from the XML structure. All concrete member data model
+ * classes should extend this abstract base to ensure consistent parsing
+ * and data representation.
+ *
  * @public
  */
 export class AbstractIndexMemberType extends AbstractDataModelBase {
-    // Mandatory elements.
+    /**
+     * The name of the member element.
+     *
+     * @remarks
+     * Extracted from the mandatory 'name' element within the member XML
+     * structure. Represents the identifier or name of the documented member.
+     */
     name = '';
-    // Mandatory attributes.
+    /**
+     * The reference identifier for the member.
+     *
+     * @remarks
+     * Mandatory attribute that provides a unique identifier for referencing
+     * this member within the Doxygen documentation structure. Used to link
+     * index entries to their detailed definitions.
+     */
     refid = '';
+    /**
+     * The kind classification of the member.
+     *
+     * @remarks
+     * Mandatory attribute specifying the type of member (e.g., function,
+     * variable, typedef). Corresponds to the MemberKind enumeration in the
+     * XML schema.
+     */
     kind = ''; // MemberKind
+    /**
+     * Constructs a new AbstractIndexMemberType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the member data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract member information including
+     * the name element and mandatory attributes (refid and kind). The constructor
+     * validates that all required data is present and properly formatted
+     * according to the XML schema specifications.
+     */
     constructor(xml, element, elementName) {
         super(elementName);
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
@@ -77,9 +121,29 @@ export class AbstractIndexMemberType extends AbstractDataModelBase {
 // The name clashes with a similar definition in compound.xsd.
 // <xsd:element name="member" type="MemberType" minOccurs="0" maxOccurs="unbounded" />
 /**
+ * Concrete data model class for index member elements.
+ *
+ * @remarks
+ * Represents individual member elements found within Doxygen index XML
+ * structures. This class extends the abstract base to provide specific
+ * handling for 'member' elements, which reference documented members
+ * such as functions, variables, and other programming constructs within
+ * the indexed documentation.
+ *
  * @public
  */
 export class IndexMemberDataModel extends AbstractIndexMemberType {
+    /**
+     * Constructs a new IndexMemberDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the member data
+     *
+     * @remarks
+     * Initialises the member data model by parsing the provided XML element
+     * as a 'member' element type. The constructor delegates to the parent
+     * class for common member processing whilst specifying the element name.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'member');

package/dist/doxygen/data-model/index/indexmembertype-dm.js.map

@@ -1 +1 @@
-{"version":3,"file":"indexmembertype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexmembertype-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,sCAAsC;AACtC,mBAAmB;AACnB,mDAAmD;AACnD,oBAAoB;AACpB,mEAAmE;AACnE,kEAAkE;AAClE,qBAAqB;AAErB;;GAEG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,qBAAqB;IACzE,sBAAsB;IACtB,IAAI,GAAG,EAAE,CAAA;IAET,wBAAwB;IACxB,KAAK,GAAG,EAAE,CAAA;IACV,IAAI,GAAG,EAAE,CAAA,CAAC,aAAa;IAEvB,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,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;gBAC9B,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,SAAS,WAAW,WAAW,EAC/B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,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,+BAA+B;QAC/B,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,6BAA6B;YAC7B,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,SAAS,WAAW,aAAa,EACjC,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;AAqCD,+EAA+E;AAE/E,8DAA8D;AAC9D,sFAAsF;AAEtF;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,uBAAuB;IAC/D,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"indexmembertype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/index/indexmembertype-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,sCAAsC;AACtC,mBAAmB;AACnB,mDAAmD;AACnD,oBAAoB;AACpB,mEAAmE;AACnE,kEAAkE;AAClE,qBAAqB;AAErB;;;;;;;;;;;;GAYG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,qBAAqB;IACzE;;;;;;OAMG;IACH,IAAI,GAAG,EAAE,CAAA;IAET;;;;;;;OAOG;IACH,KAAK,GAAG,EAAE,CAAA;IAEV;;;;;;;OAOG;IACH,IAAI,GAAG,EAAE,CAAA,CAAC,aAAa;IAEvB;;;;;;;;;;;;OAYG;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,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;gBAC9B,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,SAAS,WAAW,WAAW,EAC/B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,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,+BAA+B;QAC/B,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,6BAA6B;YAC7B,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,SAAS,WAAW,aAAa,EACjC,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;AAkDD,+EAA+E;AAE/E,8DAA8D;AAC9D,sFAAsF;AAEtF;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,oBAAqB,SAAQ,uBAAuB;IAC/D;;;;;;;;;;OAUG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACF;AAED,+EAA+E"}