@xpack/doxygen2docusaurus 1.0.2 → 2.0.0

package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js

@@ -22,16 +22,75 @@ import { AbstractDataModelBase } from '../types.js';
 //   <xsd:attribute name="type" type="typeType" use="required"/>
 // </xsd:complexType>
 /**
+ * Abstract base class for Doxygen file option type data models.
+ *
+ * @remarks
+ * Represents configuration option elements within Doxyfile XML structures,
+ * corresponding to the OptionType complex type in the XML schema. This
+ * class handles the parsing of option values and mandatory attributes
+ * (id, default, and type). All concrete option data model classes should
+ * extend this abstract base to ensure consistent parsing and data
+ * representation of Doxygen configuration settings.
+ *
  * @public
  */
 // eslint-disable-next-line max-len
 export class AbstractDoxygenFileOptionType extends AbstractDataModelBase {
-    // Optional elements.
+    /**
+     * Collection of value strings associated with this configuration option.
+     *
+     * @remarks
+     * Optional array containing value elements found within the option
+     * structure. Each value represents a specific setting or parameter
+     * for the configuration option. The array supports zero to many values
+     * as per the XML schema, allowing for both single and multi-value
+     * configuration settings.
+     */
     values; // [0-n] valueType
-    // Mandatory attributes.
+    /**
+     * The unique identifier for this configuration option.
+     *
+     * @remarks
+     * Mandatory attribute that specifies the name or identifier of the
+     * Doxygen configuration option. This corresponds to the actual
+     * configuration parameter name used in Doxygen configuration files
+     * and determines the specific setting being configured.
+     */
     id = ''; // idType
+    /**
+     * The default value indicator for this configuration option.
+     *
+     * @remarks
+     * Mandatory attribute that indicates whether this option is set to
+     * its default value. Corresponds to the defaultType enumeration in
+     * the XML schema, typically having values of 'yes' or 'no'.
+     */
     default = ''; // defaultType
+    /**
+     * The data type classification for this configuration option.
+     *
+     * @remarks
+     * Mandatory attribute that specifies the expected data type for the
+     * option's values. Corresponds to the typeType enumeration in the
+     * XML schema, indicating whether the option expects integer, boolean,
+     * string, or string list values.
+     */
     type = ''; // typeType
+    /**
+     * Constructs a new AbstractDoxygenFileOptionType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the option data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract configuration option
+     * information including value collections and mandatory attributes
+     * (id, default, and type). The constructor validates that all required
+     * attributes are present and processes value elements into a string
+     * array when present. The parsing ensures compliance with the OptionType
+     * schema definition.
+     */
     constructor(xml, element, elementName) {
         super(elementName);
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
@@ -83,9 +142,32 @@ export class AbstractDoxygenFileOptionType extends AbstractDataModelBase {
 // ----------------------------------------------------------------------------
 // <xsd:element name="option" type="OptionType" minOccurs="0" maxOccurs="unbounded"/>
 /**
+ * Concrete data model class for Doxyfile option elements.
+ *
+ * @remarks
+ * Represents individual configuration option elements found within
+ * Doxyfile XML structures. This class extends the abstract base to
+ * provide specific handling for 'option' elements, which define
+ * individual Doxygen configuration settings including their identifiers,
+ * types, default status, and associated values. Each option corresponds
+ * to a specific configuration parameter that controls Doxygen's
+ * documentation generation behaviour.
+ *
  * @public
  */
 export class DoxygenFileOptionDataModel extends AbstractDoxygenFileOptionType {
+    /**
+     * Constructs a new DoxygenFileOptionDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the option data
+     *
+     * @remarks
+     * Initialises the option data model by parsing the provided XML element
+     * as an 'option' element type. The constructor delegates to the parent
+     * class for common option 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, 'option');

package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js.map

@@ -1 +1 @@
-{"version":3,"file":"doxyfileoptiontype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/doxyfile/doxyfileoptiontype-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,uFAAuF;AACvF,oBAAoB;AACpB,4DAA4D;AAC5D,sEAAsE;AACtE,gEAAgE;AAChE,qBAAqB;AAErB;;GAEG;AACH,mCAAmC;AACnC,MAAM,OAAgB,6BAA8B,SAAQ,qBAAqB;IAC/E,qBAAqB;IACrB,MAAM,CAAsB,CAAC,kBAAkB;IAE/C,wBAAwB;IACxB,EAAE,GAAG,EAAE,CAAA,CAAC,SAAS;IACjB,OAAO,GAAG,EAAE,CAAA,CAAC,cAAc;IAC3B,IAAI,GAAG,EAAE,CAAA,CAAC,WAAW;IAErB,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,MAAM,KAAK,EAAE,CAAA;gBAClB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAA;YAClE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,YAAY,WAAW,WAAW,EAClC,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,MAAM,EAAE,CAAC;gBAC7B,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;YACxD,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,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,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,YAAY,WAAW,aAAa,EACpC,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC1B,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;AA0CD,+EAA+E;AAE/E,qFAAqF;AAErF;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,6BAA6B;IAC3E,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":"doxyfileoptiontype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/doxyfile/doxyfileoptiontype-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,uFAAuF;AACvF,oBAAoB;AACpB,4DAA4D;AAC5D,sEAAsE;AACtE,gEAAgE;AAChE,qBAAqB;AAErB;;;;;;;;;;;;GAYG;AACH,mCAAmC;AACnC,MAAM,OAAgB,6BAA8B,SAAQ,qBAAqB;IAC/E;;;;;;;;;OASG;IACH,MAAM,CAAsB,CAAC,kBAAkB;IAE/C;;;;;;;;OAQG;IACH,EAAE,GAAG,EAAE,CAAA,CAAC,SAAS;IAEjB;;;;;;;OAOG;IACH,OAAO,GAAG,EAAE,CAAA,CAAC,cAAc;IAE3B;;;;;;;;OAQG;IACH,IAAI,GAAG,EAAE,CAAA,CAAC,WAAW;IAErB;;;;;;;;;;;;;;OAcG;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,MAAM,KAAK,EAAE,CAAA;gBAClB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAA;YAClE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,YAAY,WAAW,WAAW,EAClC,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,MAAM,EAAE,CAAC;gBAC7B,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;YACxD,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,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,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,YAAY,WAAW,aAAa,EACpC,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC1B,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;AAmED,+EAA+E;AAE/E,qFAAqF;AAErF;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,0BAA2B,SAAQ,6BAA6B;IAC3E;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACF;AAED,+EAA+E"}

package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts

@@ -2,19 +2,100 @@ import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
 import { DoxygenFileOptionDataModel } from './doxyfileoptiontype-dm.js';
 import { AbstractDataModelBase } from '../types.js';
 /**
+ * Abstract base class for Doxygen file type data models.
+ *
+ * @remarks
+ * Represents the structure of Doxyfile XML configurations, corresponding
+ * to the DoxygenFileType complex type in the XML schema. This class handles
+ * the parsing of Doxygen configuration options and mandatory attributes
+ * (version and language). All concrete Doxyfile data model classes should
+ * extend this abstract base to ensure consistent parsing and data
+ * representation of configuration settings.
+ *
  * @public
  */
 export declare abstract class AbstractDoxygenFileType extends AbstractDataModelBase {
+    /**
+     * The version of the Doxygen tool that generated the configuration.
+     *
+     * @remarks
+     * Mandatory attribute extracted from the XML structure that identifies
+     * the version of Doxygen used to generate the configuration file. This
+     * information is essential for compatibility and configuration parsing
+     * decisions.
+     */
     version: string;
+    /**
+     * The language specification for the documentation configuration.
+     *
+     * @remarks
+     * Mandatory attribute corresponding to the xml:lang attribute in the
+     * XML structure. Specifies the primary language used in the configuration
+     * and documentation generation process for internationalisation purposes.
+     */
     lang: string;
+    /**
+     * Collection of configuration option data models.
+     *
+     * @remarks
+     * Optional array containing option elements found within the Doxyfile
+     * structure. Each option represents a specific configuration setting
+     * that controls the behaviour of Doxygen during documentation generation.
+     * The array supports zero to many options as per the XML schema.
+     */
     options?: DoxygenFileOptionDataModel[] | 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 Doxyfile XML.
+     * This provides schema validation capabilities for the parsed
+     * configuration content.
+     */
     noNamespaceSchemaLocation?: string | undefined;
+    /**
+     * Constructs a new AbstractDoxygenFileType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the Doxyfile data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract Doxyfile configuration
+     * information including option collections and mandatory attributes
+     * (version and language). The constructor validates that all required
+     * attributes are present and processes option 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 doxyfile elements.
+ *
+ * @remarks
+ * Represents the root element of Doxyfile XML configuration files,
+ * extending the abstract base class to provide specific handling for
+ * 'doxyfile' elements. This class serves as the primary entry point
+ * for parsing Doxygen configuration files and provides access to all
+ * configuration options and metadata contained within the file structure.
+ *
  * @public
  */
 export declare class DoxygenFileDataModel extends AbstractDoxygenFileType {
+    /**
+     * Constructs a new DoxygenFileDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the doxyfile data
+     *
+     * @remarks
+     * Initialises the Doxyfile data model by parsing the provided XML element
+     * as a 'doxyfile' element type. The constructor delegates to the parent
+     * class for common configuration processing whilst specifying the element
+     * name for proper XML structure handling.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 //# sourceMappingURL=doxyfiletype-dm.d.ts.map

package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"doxyfiletype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/doxyfile/doxyfiletype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAA;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAYnD;;GAEG;AACH,8BAAsB,uBAAwB,SAAQ,qBAAqB;IAEzE,OAAO,SAAK;IACZ,IAAI,SAAK;IAGT,OAAO,CAAC,EAAE,0BAA0B,EAAE,GAAG,SAAS,CAAA;IAGlD,yBAAyB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;gBAElC,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA4DxE;AAMD;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,uBAAuB;gBACnD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
+{"version":3,"file":"doxyfiletype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/doxyfile/doxyfiletype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAA;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAYnD;;;;;;;;;;;;GAYG;AACH,8BAAsB,uBAAwB,SAAQ,qBAAqB;IACzE;;;;;;;;OAQG;IACH,OAAO,SAAK;IAEZ;;;;;;;OAOG;IACH,IAAI,SAAK;IAET;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,0BAA0B,EAAE,GAAG,SAAS,CAAA;IAElD;;;;;;;;OAQG;IACH,yBAAyB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE9C;;;;;;;;;;;;;;OAcG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA4DxE;AAMD;;;;;;;;;;;GAWG;AACH,qBAAa,oBAAqB,SAAQ,uBAAuB;IAC/D;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js

@@ -22,16 +22,73 @@ import { AbstractDataModelBase } from '../types.js';
 //   <xsd:attribute ref="xml:lang" use="required"/>
 // </xsd:complexType>
 /**
+ * Abstract base class for Doxygen file type data models.
+ *
+ * @remarks
+ * Represents the structure of Doxyfile XML configurations, corresponding
+ * to the DoxygenFileType complex type in the XML schema. This class handles
+ * the parsing of Doxygen configuration options and mandatory attributes
+ * (version and language). All concrete Doxyfile data model classes should
+ * extend this abstract base to ensure consistent parsing and data
+ * representation of configuration settings.
+ *
  * @public
  */
 export class AbstractDoxygenFileType extends AbstractDataModelBase {
-    // Mandatory attributes.
+    /**
+     * The version of the Doxygen tool that generated the configuration.
+     *
+     * @remarks
+     * Mandatory attribute extracted from the XML structure that identifies
+     * the version of Doxygen used to generate the configuration file. This
+     * information is essential for compatibility and configuration parsing
+     * decisions.
+     */
     version = '';
+    /**
+     * The language specification for the documentation configuration.
+     *
+     * @remarks
+     * Mandatory attribute corresponding to the xml:lang attribute in the
+     * XML structure. Specifies the primary language used in the configuration
+     * and documentation generation process for internationalisation purposes.
+     */
     lang = '';
-    // Optional elements.
+    /**
+     * Collection of configuration option data models.
+     *
+     * @remarks
+     * Optional array containing option elements found within the Doxyfile
+     * structure. Each option represents a specific configuration setting
+     * that controls the behaviour of Doxygen during documentation generation.
+     * The array supports zero to many options as per the XML schema.
+     */
     options;
-    // 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 Doxyfile XML.
+     * This provides schema validation capabilities for the parsed
+     * configuration content.
+     */
     noNamespaceSchemaLocation;
+    /**
+     * Constructs a new AbstractDoxygenFileType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the Doxyfile data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract Doxyfile configuration
+     * information including option collections and mandatory attributes
+     * (version and language). The constructor validates that all required
+     * attributes are present and processes option 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 }))
@@ -80,9 +137,30 @@ export class AbstractDoxygenFileType extends AbstractDataModelBase {
 // ----------------------------------------------------------------------------
 // <xsd:element name="doxyfile" type="DoxygenFileType"/>
 /**
+ * Concrete data model class for doxyfile elements.
+ *
+ * @remarks
+ * Represents the root element of Doxyfile XML configuration files,
+ * extending the abstract base class to provide specific handling for
+ * 'doxyfile' elements. This class serves as the primary entry point
+ * for parsing Doxygen configuration files and provides access to all
+ * configuration options and metadata contained within the file structure.
+ *
  * @public
  */
 export class DoxygenFileDataModel extends AbstractDoxygenFileType {
+    /**
+     * Constructs a new DoxygenFileDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the doxyfile data
+     *
+     * @remarks
+     * Initialises the Doxyfile data model by parsing the provided XML element
+     * as a 'doxyfile' element type. The constructor delegates to the parent
+     * class for common configuration 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, 'doxyfile');

package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js.map

@@ -1 +1 @@
-{"version":3,"file":"doxyfiletype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/doxyfile/doxyfiletype-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,0BAA0B,EAAE,MAAM,4BAA4B,CAAA;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,2CAA2C;AAC3C,mBAAmB;AACnB,yFAAyF;AACzF,oBAAoB;AACpB,qEAAqE;AACrE,mDAAmD;AACnD,qBAAqB;AAErB;;GAEG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,qBAAqB;IACzE,wBAAwB;IACxB,OAAO,GAAG,EAAE,CAAA;IACZ,IAAI,GAAG,EAAE,CAAA;IAET,qBAAqB;IACrB,OAAO,CAA2C;IAElD,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,QAAQ,CAAC,EAAE,CAAC;gBACvD,IAAI,CAAC,OAAO,KAAK,EAAE,CAAA;gBACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,0BAA0B,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YACtE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,YAAY,WAAW,WAAW,EAClC,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,YAAY,WAAW,aAAa,EACpC,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,oBAAqB,SAAQ,uBAAuB;IAC/D,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":"doxyfiletype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/doxyfile/doxyfiletype-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,0BAA0B,EAAE,MAAM,4BAA4B,CAAA;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,2CAA2C;AAC3C,mBAAmB;AACnB,yFAAyF;AACzF,oBAAoB;AACpB,qEAAqE;AACrE,mDAAmD;AACnD,qBAAqB;AAErB;;;;;;;;;;;;GAYG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,qBAAqB;IACzE;;;;;;;;OAQG;IACH,OAAO,GAAG,EAAE,CAAA;IAEZ;;;;;;;OAOG;IACH,IAAI,GAAG,EAAE,CAAA;IAET;;;;;;;;OAQG;IACH,OAAO,CAA2C;IAElD;;;;;;;;OAQG;IACH,yBAAyB,CAAqB;IAE9C;;;;;;;;;;;;;;OAcG;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,QAAQ,CAAC,EAAE,CAAC;gBACvD,IAAI,CAAC,OAAO,KAAK,EAAE,CAAA;gBACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,0BAA0B,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YACtE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,YAAY,WAAW,WAAW,EAClC,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,YAAY,WAAW,aAAa,EACpC,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,oBAAqB,SAAQ,uBAAuB;IAC/D;;;;;;;;;;;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/doxygen-xml-parser.d.ts

@@ -3,8 +3,7 @@ import { XmlElement } from './types.js';
 import { CliOptions } from '../../docusaurus/cli-options.js';
 import { AbstractDocImageType } from './compounds/descriptiontype-dm.js';
 /**
- * The DoxygenXmlParser class is responsible for parsing
- * Doxygen-generated XML files and constructing the internal data model.
+ * XML parser for Doxygen-generated documentation files.
  *
  * @remarks
  * This class initialises the XML parser with options that preserve the order
@@ -12,6 +11,9 @@ import { AbstractDocImageType } from './compounds/descriptiontype-dm.js';
  * for documentation purposes. It maintains a counter for the number of files
  * parsed and stores the resulting data model.
  *
+ * The parser is configured to handle Doxygen's specific XML format whilst
+ * maintaining fidelity to the source structure and content organisation.
+ *
  * @example
  * ```typescript
  * const parser = new DoxygenXmlParser({ options });
@@ -22,13 +24,29 @@ import { AbstractDocImageType } from './compounds/descriptiontype-dm.js';
  */
 export declare class DoxygenXmlParser {
     /**
-     * The global configuration options.
+     * The global configuration options for the parsing operation.
+     *
+     * @remarks
+     * Contains the command-line interface options that control the behaviour
+     * of the parser throughout the XML processing workflow.
      */
     options: CliOptions;
     /**
-     * The XML parser instance configured for Doxygen XML.
+     * The XML parser instance configured specifically for Doxygen XML format.
+     *
+     * @remarks
+     * Configured with settings that preserve element order, remove namespace
+     * prefixes, and maintain fidelity to the original XML structure for
+     * accurate data model construction.
      */
     xmlParser: XMLParser;
+    /**
+     * Collection of image references extracted during XML parsing.
+     *
+     * @remarks
+     * Accumulates image elements found in the documentation content,
+     * allowing for centralised image processing and reference management.
+     */
     images: AbstractDocImageType[];
     /**
      * Constructs a new instance of the DoxygenXmlParser class.
@@ -39,9 +57,8 @@ export declare class DoxygenXmlParser {
      * This constructor initialises the XML parser with settings that preserve the
      * order and structure of the original XML content, remove namespace prefixes,
      * and ensure that both tag and attribute values are parsed. The values are
-     * not
-     * trimmed, maintaining fidelity to the source XML. The provided options are
-     * stored for use throughout the parsing process.
+     * not trimmed, maintaining fidelity to the source XML. The provided options
+     * are stored for use throughout the parsing process.
      */
     constructor(options: CliOptions);
     /**

package/dist/doxygen/data-model/doxygen-xml-parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"doxygen-xml-parser.d.ts","sourceRoot":"","sources":["../../../src/doxygen/data-model/doxygen-xml-parser.ts"],"names":[],"mappings":"AAgCA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AAIxE;;;;;;;;;;;;;;;;;GAiBG;AAEH,qBAAa,gBAAgB;IAC3B;;OAEG;IACH,OAAO,EAAE,UAAU,CAAA;IAEnB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB,MAAM,EAAE,oBAAoB,EAAE,CAAK;IAEnC;;;;;;;;;;;;OAYG;gBACS,OAAO,EAAE,UAAU;IAe/B;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIvC;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE;IAK7C;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAUpD;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAoB9D;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAgB9D;;;;;;;;;;;;;;OAcG;IACH,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAgBhE;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAoBvD;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IA6B1D;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAetC;;;;;;;;;;;;;;OAcG;IAEH,gBAAgB,CAAC,CAAC,GAAG,UAAU,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;IAapE;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAoB1D;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAoB5D;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAqB9D;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;CAUtC"}
+{"version":3,"file":"doxygen-xml-parser.d.ts","sourceRoot":"","sources":["../../../src/doxygen/data-model/doxygen-xml-parser.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AAIxE;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,qBAAa,gBAAgB;IAC3B;;;;;;OAMG;IACH,OAAO,EAAE,UAAU,CAAA;IAEnB;;;;;;;OAOG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;;;;;OAMG;IACH,MAAM,EAAE,oBAAoB,EAAE,CAAK;IAEnC;;;;;;;;;;;OAWG;gBACS,OAAO,EAAE,UAAU;IAe/B;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAIvC;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE;IAK7C;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAUpD;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAoB9D;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAgB9D;;;;;;;;;;;;;;OAcG;IACH,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAgBhE;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAoBvD;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IA6B1D;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAetC;;;;;;;;;;;;;;OAcG;IAEH,gBAAgB,CAAC,CAAC,GAAG,UAAU,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;IAapE;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAoB1D;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAoB5D;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAqB9D;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;CAUtC"}

package/dist/doxygen/data-model/doxygen-xml-parser.js

@@ -9,28 +9,12 @@
  * be obtained from https://opensource.org/licenses/MIT.
  */
 // ----------------------------------------------------------------------------
-/**
- * @file doxygen-xml-parser.ts
- * @brief Provides the DoxygenXmlParser class for parsing Doxygen-generated
- * XML files.
- *
- * This module defines the {@link DoxygenXmlParser} class, which is responsible
- * for parsing XML output produced by Doxygen and constructing the internal
- * data model used by doxygen2docusaurus. It supports parsing the main index,
- * compound files, and configuration files, and provides utility methods for
- * extracting attributes and inner elements from the XML structure.
- *
- * The parser is designed to preserve the original XML content and element
- * order, ensuring accurate conversion to the documentation model. It is
- * intended for use within the xPack doxygen2docusaurus CLI tool.
- */
 import assert from 'node:assert';
 import * as util from 'node:util';
 import { XMLParser } from 'fast-xml-parser';
 // ----------------------------------------------------------------------------
 /**
- * The DoxygenXmlParser class is responsible for parsing
- * Doxygen-generated XML files and constructing the internal data model.
+ * XML parser for Doxygen-generated documentation files.
  *
  * @remarks
  * This class initialises the XML parser with options that preserve the order
@@ -38,6 +22,9 @@ import { XMLParser } from 'fast-xml-parser';
  * for documentation purposes. It maintains a counter for the number of files
  * parsed and stores the resulting data model.
  *
+ * The parser is configured to handle Doxygen's specific XML format whilst
+ * maintaining fidelity to the source structure and content organisation.
+ *
  * @example
  * ```typescript
  * const parser = new DoxygenXmlParser({ options });
@@ -48,13 +35,29 @@ import { XMLParser } from 'fast-xml-parser';
  */
 export class DoxygenXmlParser {
     /**
-     * The global configuration options.
+     * The global configuration options for the parsing operation.
+     *
+     * @remarks
+     * Contains the command-line interface options that control the behaviour
+     * of the parser throughout the XML processing workflow.
      */
     options;
     /**
-     * The XML parser instance configured for Doxygen XML.
+     * The XML parser instance configured specifically for Doxygen XML format.
+     *
+     * @remarks
+     * Configured with settings that preserve element order, remove namespace
+     * prefixes, and maintain fidelity to the original XML structure for
+     * accurate data model construction.
      */
     xmlParser;
+    /**
+     * Collection of image references extracted during XML parsing.
+     *
+     * @remarks
+     * Accumulates image elements found in the documentation content,
+     * allowing for centralised image processing and reference management.
+     */
     images = [];
     /**
      * Constructs a new instance of the DoxygenXmlParser class.
@@ -65,9 +68,8 @@ export class DoxygenXmlParser {
      * This constructor initialises the XML parser with settings that preserve the
      * order and structure of the original XML content, remove namespace prefixes,
      * and ensure that both tag and attribute values are parsed. The values are
-     * not
-     * trimmed, maintaining fidelity to the source XML. The provided options are
-     * stored for use throughout the parsing process.
+     * not trimmed, maintaining fidelity to the source XML. The provided options
+     * are stored for use throughout the parsing process.
      */
     constructor(options) {
         this.options = options;

package/dist/doxygen/data-model/doxygen-xml-parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"doxygen-xml-parser.js","sourceRoot":"","sources":["../../../src/doxygen/data-model/doxygen-xml-parser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E;;;;;;;;;;;;;;GAcG;AAEH,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAK3C,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;GAiBG;AAEH,MAAM,OAAO,gBAAgB;IAC3B;;OAEG;IACH,OAAO,CAAY;IAEnB;;OAEG;IACH,SAAS,CAAW;IAEpB,MAAM,GAA2B,EAAE,CAAA;IAEnC;;;;;;;;;;;;OAYG;IACH,YAAY,OAAmB;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QAEtB,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC;YAC7B,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,IAAI;YACpB,gBAAgB,EAAE,KAAK;YACvB,aAAa,EAAE,IAAI;YACnB,mBAAmB,EAAE,IAAI;YACzB,UAAU,EAAE,KAAK;SAClB,CAAC,CAAA;IACJ,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,OAAe;QAC3B,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;IACrC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,OAAe;QAChC,mEAAmE;QACnE,OAAO,MAAM,CAAC,IAAI,CAAE,OAAwB,CAAC,IAAI,CAAC,CAAC,CAAA;IACrD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,OAAe,EAAE,IAAY;QACxC,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,mEAAmE;YACnE,MAAM,qBAAqB,GAAG,OAAuB,CAAA;YACrD,OAAO,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAA;QACzD,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CAAC,OAAe,EAAE,IAAY;QACnD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAC7B,OACD,CAAC,IAAI,CAAC,CAAA;YACP,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,cAAc,CAAA;YACvB,CAAC;iBAAM,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBAC9C,kEAAkE;gBAClE,mEAAmE;gBACnE,WAAW;gBACX,OAAO,MAAM,CAAC,cAAc,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,YAAY,CACvE,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CAAC,OAAe,EAAE,IAAY;QACnD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAC7B,OACD,CAAC,IAAI,CAAC,CAAA;YACP,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,cAAc,CAAA;YACvB,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,UAAU;YAClE,WAAW,CACd,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,wBAAwB,CAAC,OAAe,EAAE,IAAY;QACpD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAC7B,OACD,CAAC,IAAI,CAAC,CAAA;YACP,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,cAAc,CAAC,WAAW,EAAE,KAAK,KAAK,CAAA;YAC/C,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,GAAG;YAC3D,mBAAmB,CACtB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,OAAe,EAAE,IAAY;QAC3C,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,MAAM,KAAK,GAAI,OAAoD,CACjE,OAAO,CACR,CAAA;gBACD,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;oBACzB,OAAO,KAAK,KAAK,QAAQ;oBACzB,OAAO,KAAK,KAAK,SAAS,CAC3B,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,8DAA8D;gBAC9D,OAAO,KAAK,CAAC,OAAO,CAAE,OAA2B,CAAC,IAAI,CAAC,CAAC,CAAA;YAC1D,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,OAAe,EAAE,IAAY;QAC9C,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;YACP,0DAA0D;YAC1D,oCAAoC;YACpC,sCAAsC;YACtC,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,yCAAyC;gBACzC,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,CAAC;oBAC7C,MAAM,KAAK,GACT,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;oBACV,MAAM,CACJ,OAAO,KAAK,KAAK,QAAQ;wBACvB,OAAO,KAAK,KAAK,QAAQ;wBACzB,OAAO,KAAK,KAAK,SAAS,CAC7B,CAAA;oBACD,OAAO,IAAI,CAAA;gBACb,CAAC;YACH,CAAC;iBAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtC,gBAAgB;gBAChB,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAe;QAC1B,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;YACpC,MAAM,KAAK,GAAI,OAAoD,CACjE,OAAO,CACR,CAAA;YACD,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;gBACzB,OAAO,KAAK,KAAK,QAAQ;gBACzB,OAAO,KAAK,KAAK,SAAS,CAC3B,CAAA;QACH,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,6EAA6E;IAC7E,gBAAgB,CAAmB,OAAe,EAAE,IAAY;QAC9D,kDAAkD;QAClD,qDAAqD;QACrD,MAAM,aAAa,GAAmB,OAAyB,CAAC,IAAI,CAAC,CAAA;QACrE,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,aAAa,CAAA;QACtB,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,GAAG;YACjE,qBAAqB,IAAI,gBAAgB,CAC5C,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CAAC,OAAe,EAAE,IAAY;QAC/C,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;QAEP,qCAAqC;QACrC,yCAAyC;QACzC,IAAI;QACJ,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,KAAK,GACT,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;YACV,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAA;QACzB,CAAC;aAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,EAAE,CAAA;QACX,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,CAAC,OAAe,EAAE,IAAY;QACjD,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;QAEP,qCAAqC;QACrC,yCAAyC;QACzC,IAAI;QACJ,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,KAAK,GACT,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;YACV,OAAO,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;QACnC,CAAC;aAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,GAAG,CAAA;QACZ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CAAC,OAAe,EAAE,IAAY;QAClD,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;QAEP,qCAAqC;QACrC,yCAAyC;QACzC,IAAI;QACJ,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,SAAS,GACb,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;YACV,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;YACvD,OAAO,KAAK,KAAK,MAAM,CAAA;QACzB,CAAC;aAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,OAAe;QAC1B,mDAAmD;QACnD,MAAM,KAAK,GAAI,OAAoD,CAAC,OAAO,CAAC,CAAA;QAC5E,MAAM,CACJ,OAAO,KAAK,KAAK,QAAQ;YACvB,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,SAAS,CAC7B,CAAA;QACD,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAA;IACzB,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"doxygen-xml-parser.js","sourceRoot":"","sources":["../../../src/doxygen/data-model/doxygen-xml-parser.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,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAK3C,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,MAAM,OAAO,gBAAgB;IAC3B;;;;;;OAMG;IACH,OAAO,CAAY;IAEnB;;;;;;;OAOG;IACH,SAAS,CAAW;IAEpB;;;;;;OAMG;IACH,MAAM,GAA2B,EAAE,CAAA;IAEnC;;;;;;;;;;;OAWG;IACH,YAAY,OAAmB;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QAEtB,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC;YAC7B,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,IAAI;YACpB,gBAAgB,EAAE,KAAK;YACvB,aAAa,EAAE,IAAI;YACnB,mBAAmB,EAAE,IAAI;YACzB,UAAU,EAAE,KAAK;SAClB,CAAC,CAAA;IACJ,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,OAAe;QAC3B,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;IACrC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,OAAe;QAChC,mEAAmE;QACnE,OAAO,MAAM,CAAC,IAAI,CAAE,OAAwB,CAAC,IAAI,CAAC,CAAC,CAAA;IACrD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,OAAe,EAAE,IAAY;QACxC,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,mEAAmE;YACnE,MAAM,qBAAqB,GAAG,OAAuB,CAAA;YACrD,OAAO,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAA;QACzD,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CAAC,OAAe,EAAE,IAAY;QACnD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAC7B,OACD,CAAC,IAAI,CAAC,CAAA;YACP,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,cAAc,CAAA;YACvB,CAAC;iBAAM,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBAC9C,kEAAkE;gBAClE,mEAAmE;gBACnE,WAAW;gBACX,OAAO,MAAM,CAAC,cAAc,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,YAAY,CACvE,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CAAC,OAAe,EAAE,IAAY;QACnD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAC7B,OACD,CAAC,IAAI,CAAC,CAAA;YACP,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,cAAc,CAAA;YACvB,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,UAAU;YAClE,WAAW,CACd,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,wBAAwB,CAAC,OAAe,EAAE,IAAY;QACpD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,yBAAyB,GAC7B,OACD,CAAC,IAAI,CAAC,CAAA;YACP,MAAM,cAAc,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;YACtD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,cAAc,CAAC,WAAW,EAAE,KAAK,KAAK,CAAA;YAC/C,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,GAAG;YAC3D,mBAAmB,CACtB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,OAAe,EAAE,IAAY;QAC3C,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,MAAM,KAAK,GAAI,OAAoD,CACjE,OAAO,CACR,CAAA;gBACD,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;oBACzB,OAAO,KAAK,KAAK,QAAQ;oBACzB,OAAO,KAAK,KAAK,SAAS,CAC3B,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,8DAA8D;gBAC9D,OAAO,KAAK,CAAC,OAAO,CAAE,OAA2B,CAAC,IAAI,CAAC,CAAC,CAAA;YAC1D,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,OAAe,EAAE,IAAY;QAC9C,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;YACP,0DAA0D;YAC1D,oCAAoC;YACpC,sCAAsC;YACtC,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,yCAAyC;gBACzC,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,CAAC;oBAC7C,MAAM,KAAK,GACT,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;oBACV,MAAM,CACJ,OAAO,KAAK,KAAK,QAAQ;wBACvB,OAAO,KAAK,KAAK,QAAQ;wBACzB,OAAO,KAAK,KAAK,SAAS,CAC7B,CAAA;oBACD,OAAO,IAAI,CAAA;gBACb,CAAC;YACH,CAAC;iBAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtC,gBAAgB;gBAChB,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAe;QAC1B,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;YACpC,MAAM,KAAK,GAAI,OAAoD,CACjE,OAAO,CACR,CAAA;YACD,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;gBACzB,OAAO,KAAK,KAAK,QAAQ;gBACzB,OAAO,KAAK,KAAK,SAAS,CAC3B,CAAA;QACH,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,6EAA6E;IAC7E,gBAAgB,CAAmB,OAAe,EAAE,IAAY;QAC9D,kDAAkD;QAClD,qDAAqD;QACrD,MAAM,aAAa,GAAmB,OAAyB,CAAC,IAAI,CAAC,CAAA;QACrE,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,aAAa,CAAA;QACtB,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,GAAG;YACjE,qBAAqB,IAAI,gBAAgB,CAC5C,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CAAC,OAAe,EAAE,IAAY;QAC/C,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;QAEP,qCAAqC;QACrC,yCAAyC;QACzC,IAAI;QACJ,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,KAAK,GACT,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;YACV,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAA;QACzB,CAAC;aAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,EAAE,CAAA;QACX,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,CAAC,OAAe,EAAE,IAAY;QACjD,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;QAEP,qCAAqC;QACrC,yCAAyC;QACzC,IAAI;QACJ,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,KAAK,GACT,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;YACV,OAAO,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;QACnC,CAAC;aAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,GAAG,CAAA;QACZ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CAAC,OAAe,EAAE,IAAY;QAClD,MAAM,aAAa,GACjB,OACD,CAAC,IAAI,CAAC,CAAA;QAEP,qCAAqC;QACrC,yCAAyC;QACzC,IAAI;QACJ,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,SAAS,GACb,aAAa,CAAC,CAAC,CAChB,CAAC,OAAO,CAAC,CAAA;YACV,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;YACvD,OAAO,KAAK,KAAK,MAAM,CAAA;QACzB,CAAC;aAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,OAAe;QAC1B,mDAAmD;QACnD,MAAM,KAAK,GAAI,OAAoD,CAAC,OAAO,CAAC,CAAA;QAC5E,MAAM,CACJ,OAAO,KAAK,KAAK,QAAQ;YACvB,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,SAAS,CAC7B,CAAA;QACD,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAA;IACzB,CAAC;CACF;AAED,+EAA+E"}

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

@@ -2,20 +2,112 @@ import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
 import { IndexMemberDataModel } from './indexmembertype-dm.js';
 import { AbstractDataModelBase } from '../types.js';
 /**
+ * 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 declare abstract class AbstractIndexCompoundType extends AbstractDataModelBase {
+    /**
+     * 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: string;
+    /**
+     * 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: IndexMemberDataModel[] | undefined;
+    /**
+     * 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: string;
+    /**
+     * 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: string;
+    /**
+     * 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: DoxygenXmlParser, element: object, elementName: string);
 }
+/**
+ * Union type representing the various kinds of compounds in Doxygen
+ * documentation.
+ *
+ * @remarks
+ * Corresponds to the CompoundKind simple type in the Doxygen XML schema,
+ * which defines the allowable classifications for documented compounds.
+ * Each value represents a specific type of programming construct or
+ * documentation unit that can be indexed, ranging from code structures
+ * like classes and namespaces to documentation pages and examples.
+ *
+ * @public
+ */
 export type IndexCompoundKind = 'class' | 'struct' | 'union' | 'interface' | 'protocol' | 'category' | 'exception' | 'file' | 'namespace' | 'group' | 'page' | 'example' | 'dir' | 'type' | 'concept' | 'module';
 /**
+ * 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 declare 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: DoxygenXmlParser, element: object);
 }
 //# sourceMappingURL=indexcompoundtype-dm.d.ts.map