@xpack/doxygen2docusaurus 1.1.0 → 2.0.0

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

@@ -1 +1 @@
-{"version":3,"file":"sectiondeftype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/sectiondeftype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,0CAA0C;AAC1C,mBAAmB;AACnB,oEAAoE;AACpE,8EAA8E;AAC9E,yCAAyC;AACzC,kGAAkG;AAClG,4FAA4F;AAC5F,oBAAoB;AACpB,oBAAoB;AACpB,wDAAwD;AACxD,qBAAqB;AAErB;;GAEG;AACH,MAAM,OAAgB,0BAA2B,SAAQ,qBAAqB;IAC5E,wBAAwB;IACxB,IAAI,GAAG,EAAE,CAAA;IAET,qBAAqB;IACrB,MAAM,CAAqB;IAC3B,WAAW,CAAmC;IAE9C,0CAA0C;IAC1C,UAAU,CAAmC;IAC7C,OAAO,CAAgC;IAEvC,YAAY,WAAmB,EAAE,IAAY;QAC3C,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,CAAA;IACpE,CAAC;IAED,mBAAmB,CACjB,aAAqB,EACrB,eAAuB,aAAa;QAEpC,0BAA0B;QAC1B,yBAAyB;QACzB,yBAAyB;QACzB,2BAA2B;QAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;YACjC,OAAO,YAAY,CAAA;QACrB,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,kDAAkD;YAClD,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,CAAC,GAAG,aAAa,EAAE,CAAA;QACvE,CAAC;aAAM,CAAC;YACN,OAAO,YAAY,CAAA;QACrB,CAAC;IACH,CAAC;CACF;AAED;;GAEG;AACH,mCAAmC;AACnC,MAAM,OAAgB,sBAAuB,SAAQ,0BAA0B;IAC7E,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;QAEtB,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,QAAQ,CAAC,EAAE,CAAC;gBAC1D,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAA;gBACjC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;YAC/D,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,CAAC;gBAC5D,MAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,CAAA;gBACtC,IAAI,CAAC,WAAW,GAAG,IAAI,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;YAChE,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;gBAC1D,IAAI,CAAC,UAAU,KAAK,EAAE,CAAA;gBACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YACjE,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,eAAe,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAC3D,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,WAAW,EACzB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,2EAA2E;QAC3E,sBAAsB;QAEtB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAElC,MAAM,eAAe,GAAG,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACvD,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;gBAC9B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;YAC5D,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;gBACpE,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,aAAa,EAC3B,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,8FAA8F;AAE9F;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,sBAAsB;IAC7D,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,0BAA0B;IACvE,YAAY,IAAY;QACtB,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,CAAA;IAC3B,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"sectiondeftype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/sectiondeftype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,0CAA0C;AAC1C,mBAAmB;AACnB,oEAAoE;AACpE,8EAA8E;AAC9E,yCAAyC;AACzC,kGAAkG;AAClG,4FAA4F;AAC5F,oBAAoB;AACpB,oBAAoB;AACpB,wDAAwD;AACxD,qBAAqB;AAErB;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAgB,0BAA2B,SAAQ,qBAAqB;IAC5E;;;;;;;OAOG;IACH,IAAI,GAAG,EAAE,CAAA;IAET;;;;;;;OAOG;IACH,MAAM,CAAqB;IAE3B;;;;;;;OAOG;IACH,WAAW,CAAmC;IAE9C;;;;;;;;OAQG;IACH,UAAU,CAAmC;IAE7C;;;;;;;;OAQG;IACH,OAAO,CAAgC;IAEvC;;;;;;;;;;OAUG;IACH,YAAY,WAAmB,EAAE,IAAY;QAC3C,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,CAAA;IACpE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,CACjB,aAAqB,EACrB,eAAuB,aAAa;QAEpC,0BAA0B;QAC1B,yBAAyB;QACzB,yBAAyB;QACzB,2BAA2B;QAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;YACjC,OAAO,YAAY,CAAA;QACrB,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,kDAAkD;YAClD,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,CAAC,GAAG,aAAa,EAAE,CAAA;QACvE,CAAC;aAAM,CAAC;YACN,OAAO,YAAY,CAAA;QACrB,CAAC;IACH,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,mCAAmC;AACnC,MAAM,OAAgB,sBAAuB,SAAQ,0BAA0B;IAC7E;;;;;;;;;;;;;;OAcG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;QAEtB,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,QAAQ,CAAC,EAAE,CAAC;gBAC1D,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAA;gBACjC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;YAC/D,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,CAAC;gBAC5D,MAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,CAAA;gBACtC,IAAI,CAAC,WAAW,GAAG,IAAI,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;YAChE,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;gBAC1D,IAAI,CAAC,UAAU,KAAK,EAAE,CAAA;gBACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YACjE,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,eAAe,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAC3D,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;gBACzC,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,WAAW,EACzB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,2EAA2E;QAC3E,sBAAsB;QAEtB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAElC,MAAM,eAAe,GAAG,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACvD,KAAK,MAAM,aAAa,IAAI,eAAe,EAAE,CAAC;YAC5C,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;gBAC9B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;YAC5D,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;gBACpE,OAAO,CAAC,KAAK,CACX,GAAG,WAAW,aAAa,EAC3B,aAAa,EACb,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,8FAA8F;AAE9F;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,mBAAoB,SAAQ,sBAAsB;IAC7D;;;;;;;;;;OAUG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,yBAA0B,SAAQ,0BAA0B;IACvE;;;;;;;;;;OAUG;IACH,YAAY,IAAY;QACtB,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,CAAA;IAC3B,CAAC;CACF;AAED,+EAA+E"}

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

@@ -1,46 +1,301 @@
 import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
 import { AbstractDataModelBase } from '../types.js';
 /**
+ * Abstract base class for table of contents type data models.
+ *
+ * @remarks
+ * Represents table of contents elements within Doxygen XML structures,
+ * corresponding to the tableofcontentsType complex type in the XML schema.
+ * This class handles the parsing of table of contents structures with
+ * mutually exclusive content choices: either table of contents sections
+ * or nested table of contents elements. All concrete table of contents
+ * data model classes should extend this abstract base to ensure consistent
+ * parsing and data representation.
+ *
  * @public
  */
 export declare abstract class AbstractTableOfContentsType extends AbstractDataModelBase {
+    /**
+     * Collection of table of contents section data models.
+     *
+     * @remarks
+     * Optional array containing table of contents section elements, part
+     * of an exclusive choice with tableOfContents. Each section represents
+     * a specific part of the documentation structure with its own name,
+     * reference, and potentially nested content.
+     */
     tocSect: TocSectDataModel[] | undefined;
+    /**
+     * Collection of nested table of contents data models.
+     *
+     * @remarks
+     * Optional array containing nested table of contents elements, part
+     * of an exclusive choice with tocSect. This allows for recursive
+     * table of contents structures to represent complex documentation
+     * hierarchies.
+     */
     tableOfContents: TableOfContentsDataModel[] | undefined;
+    /**
+     * Constructs a new AbstractTableOfContentsType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract table of contents information
+     * following the exclusive choice pattern defined in the XML schema. The
+     * constructor processes either table of contents sections or nested table
+     * of contents elements, but not both, maintaining the mutually exclusive
+     * relationship. This element type has no attributes as per the schema.
+     */
     constructor(xml: DoxygenXmlParser, element: object, elementName: string);
 }
 /**
+ * Concrete data model class for table of contents elements.
+ *
+ * @remarks
+ * Represents individual table of contents elements found within Doxygen
+ * compound XML structures. This class extends the abstract base to provide
+ * specific handling for 'tableofcontents' elements, which define the
+ * structural navigation and organisation of documentation content. Each
+ * table of contents provides hierarchical access to documentation sections
+ * and subsections.
+ *
  * @public
  */
 export declare class TableOfContentsDataModel extends AbstractTableOfContentsType {
+    /**
+     * Constructs a new TableOfContentsDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents data
+     *
+     * @remarks
+     * Initialises the table of contents data model by parsing the provided
+     * XML element as a 'tableofcontents' element type. The constructor
+     * delegates to the parent class for common table of contents processing
+     * whilst specifying the element name for proper XML structure handling.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 /**
+ * Abstract base class for table of contents kind type data models.
+ *
+ * @remarks
+ * Represents table of contents kind elements within Doxygen XML structures,
+ * corresponding to the tableofcontentsKindType complex type in the XML
+ * schema. This class handles the parsing of named table of contents sections
+ * with references and optional nested table of contents structures. All
+ * concrete table of contents kind data model classes should extend this
+ * abstract base to ensure consistent parsing and data representation.
+ *
  * @public
  */
 export declare abstract class AbstractTableOfContentsKindType extends AbstractDataModelBase {
+    /**
+     * The name of the table of contents section.
+     *
+     * @remarks
+     * Mandatory element extracted from the XML structure that provides
+     * the display name or title for this table of contents section.
+     * This name is used for navigation and presentation purposes.
+     */
     name: string;
+    /**
+     * The reference identifier for this table of contents section.
+     *
+     * @remarks
+     * Mandatory element that provides a reference or link target for
+     * this table of contents section. This reference is used to create
+     * navigation links and cross-references within the documentation.
+     */
     reference: string;
+    /**
+     * Collection of nested table of contents data models.
+     *
+     * @remarks
+     * Optional array containing nested table of contents elements that
+     * create hierarchical documentation structures. This allows for
+     * multi-level table of contents organisation with subsections and
+     * sub-subsections as needed.
+     */
     tableOfContents: TableOfContentsDataModel[] | undefined;
+    /**
+     * Constructs a new AbstractTableOfContentsKindType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents kind data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract table of contents kind
+     * information including mandatory name and reference elements, along with
+     * optional nested table of contents structures. The constructor handles
+     * unknown 'docs' elements that may appear but are not defined in the DTD.
+     * This element type has no attributes as per the XML schema.
+     */
     constructor(xml: DoxygenXmlParser, element: object, elementName: string);
 }
 /**
+ * Concrete data model class for table of contents section elements.
+ *
+ * @remarks
+ * Represents individual table of contents section elements found within
+ * Doxygen XML structures. This class extends the abstract base to provide
+ * specific handling for 'tocsect' elements, which define named sections
+ * within the table of contents hierarchy. Each section includes a name,
+ * reference, and potentially nested subsections for comprehensive
+ * documentation navigation.
+ *
  * @public
  */
 export declare class TocSectDataModel extends AbstractTableOfContentsKindType {
+    /**
+     * Constructs a new TocSectDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents section
+     * data
+     *
+     * @remarks
+     * Initialises the table of contents section data model by parsing the
+     * provided XML element as a 'tocsect' element type. The constructor
+     * delegates to the parent class for common section processing whilst
+     * specifying the element name for proper XML structure handling.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
+/**
+ * Abstract base class for document table of contents item type data models.
+ *
+ * @remarks
+ * Represents table of contents item elements within Doxygen XML structures,
+ * corresponding to the docTocItemType complex type in the XML schema. This
+ * class handles the parsing of mixed content including text and document
+ * title command groups, along with mandatory identifier attributes. All
+ * concrete table of contents item data model classes should extend this
+ * abstract base to ensure consistent parsing and data representation.
+ *
+ * @public
+ */
 export declare abstract class AbstractTocDocItemType extends AbstractDataModelBase {
+    /**
+     * The unique identifier for this table of contents item.
+     *
+     * @remarks
+     * Mandatory attribute that provides a unique identifier for referencing
+     * this table of contents item within the documentation structure. This
+     * identifier is used for cross-referencing and navigation purposes.
+     */
     id: string;
+    /**
+     * Constructs a new AbstractTocDocItemType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents item data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract table of contents item
+     * information including mixed content (text and document title command
+     * groups) and the mandatory identifier attribute. The constructor processes
+     * the mixed content model defined in the XML schema, handling both text
+     * nodes and structured command groups.
+     */
     constructor(xml: DoxygenXmlParser, element: object, elementName: string);
 }
+/**
+ * Concrete data model class for table of contents item elements.
+ *
+ * @remarks
+ * Represents individual table of contents item elements found within
+ * Doxygen XML structures. This class extends the abstract base to provide
+ * specific handling for 'tocitem' elements, which define individual entries
+ * within table of contents lists. Each item includes mixed content and
+ * a unique identifier for navigation and cross-referencing purposes.
+ *
+ * @public
+ */
 export declare class TocItemDataModel extends AbstractTocDocItemType {
+    /**
+     * Constructs a new TocItemDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents item data
+     *
+     * @remarks
+     * Initialises the table of contents item data model by parsing the provided
+     * XML element as a 'tocitem' element type. The constructor delegates to
+     * the parent class for common item processing whilst specifying the element
+     * name for proper XML structure handling.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
+/**
+ * Abstract base class for document table of contents list type data models.
+ *
+ * @remarks
+ * Represents table of contents list elements within Doxygen XML structures,
+ * corresponding to the docTocListType complex type in the XML schema. This
+ * class handles the parsing of collections of table of contents items that
+ * form structured lists for documentation navigation. All concrete table
+ * of contents list data model classes should extend this abstract base to
+ * ensure consistent parsing and data representation.
+ *
+ * @public
+ */
 export declare abstract class AbstractDocTocListType extends AbstractDataModelBase {
+    /**
+     * Collection of table of contents item data models.
+     *
+     * @remarks
+     * Optional array containing table of contents item elements that comprise
+     * the list structure. Each item represents an individual entry within the
+     * table of contents with its own content and identifier. The array supports
+     * zero to many items as per the XML schema.
+     */
     tocItems?: TocItemDataModel[] | undefined;
+    /**
+     * Constructs a new AbstractDocTocListType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents list data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract table of contents list
+     * information including collections of table of contents items. The
+     * constructor processes item elements into TocItemDataModel instances
+     * when present. This element type has no attributes as per the XML schema.
+     */
     constructor(xml: DoxygenXmlParser, element: object, elementName: string);
 }
+/**
+ * Concrete data model class for table of contents list elements.
+ *
+ * @remarks
+ * Represents individual table of contents list elements found within
+ * Doxygen XML structures. This class extends the abstract base to provide
+ * specific handling for 'toclist' elements, which define structured lists
+ * of table of contents items for documentation navigation. Each list
+ * contains multiple items that collectively form a navigational structure.
+ *
+ * @public
+ */
 export declare class TocListDataModel extends AbstractDocTocListType {
+    /**
+     * Constructs a new TocListDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents list data
+     *
+     * @remarks
+     * Initialises the table of contents list data model by parsing the provided
+     * XML element as a 'toclist' element type. The constructor delegates to
+     * the parent class for common list processing whilst specifying the element
+     * name for proper XML structure handling.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 //# sourceMappingURL=tableofcontentstype-dm.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"tableofcontentstype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/tableofcontentstype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAcnD;;GAEG;AAEH,8BAAsB,2BAA4B,SAAQ,qBAAqB;IAE7E,OAAO,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAA;IACvC,eAAe,EAAE,wBAAwB,EAAE,GAAG,SAAS,CAAA;gBAE3C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA0CxE;AAMD;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,2BAA2B;gBAC3D,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAYD;;GAEG;AAEH,8BAAsB,+BAAgC,SAAQ,qBAAqB;IAEjF,IAAI,SAAK;IACT,SAAS,SAAK;IAEd,eAAe,EAAE,wBAAwB,EAAE,GAAG,SAAS,CAAA;gBAE3C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA4CxE;AAMD;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,+BAA+B;gBACvD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AASD,8BAAsB,sBAAuB,SAAQ,qBAAqB;IAKxE,EAAE,SAAK;gBAEK,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAkDxE;AAID,qBAAa,gBAAiB,SAAQ,sBAAsB;gBAC9C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAUD,8BAAsB,sBAAuB,SAAQ,qBAAqB;IACxE,QAAQ,CAAC,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAA;gBAE7B,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAiCxE;AAMD,qBAAa,gBAAiB,SAAQ,sBAAsB;gBAC9C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
+{"version":3,"file":"tableofcontentstype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/tableofcontentstype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAcnD;;;;;;;;;;;;;GAaG;AAEH,8BAAsB,2BAA4B,SAAQ,qBAAqB;IAC7E;;;;;;;;OAQG;IACH,OAAO,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAA;IAEvC;;;;;;;;OAQG;IACH,eAAe,EAAE,wBAAwB,EAAE,GAAG,SAAS,CAAA;IAEvD;;;;;;;;;;;;;OAaG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA0CxE;AAMD;;;;;;;;;;;;GAYG;AACH,qBAAa,wBAAyB,SAAQ,2BAA2B;IACvE;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAYD;;;;;;;;;;;;GAYG;AAEH,8BAAsB,+BAAgC,SAAQ,qBAAqB;IACjF;;;;;;;OAOG;IACH,IAAI,SAAK;IAET;;;;;;;OAOG;IACH,SAAS,SAAK;IAEd;;;;;;;;OAQG;IACH,eAAe,EAAE,wBAAwB,EAAE,GAAG,SAAS,CAAA;IAEvD;;;;;;;;;;;;;OAaG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA4CxE;AAMD;;;;;;;;;;;;GAYG;AACH,qBAAa,gBAAiB,SAAQ,+BAA+B;IACnE;;;;;;;;;;;;OAYG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AASD;;;;;;;;;;;;GAYG;AACH,8BAAsB,sBAAuB,SAAQ,qBAAqB;IACxE;;;;;;;OAOG;IACH,EAAE,SAAK;IAEP;;;;;;;;;;;;;OAaG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAkDxE;AAID;;;;;;;;;;;GAWG;AACH,qBAAa,gBAAiB,SAAQ,sBAAsB;IAC1D;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAUD;;;;;;;;;;;;GAYG;AACH,8BAAsB,sBAAuB,SAAQ,qBAAqB;IACxE;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAA;IAEzC;;;;;;;;;;;;OAYG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAiCxE;AAMD;;;;;;;;;;;GAWG;AACH,qBAAa,gBAAiB,SAAQ,sBAAsB;IAC1D;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

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

@@ -23,13 +23,55 @@ import { parseDocTitleCmdGroup } from './descriptiontype-dm.js';
 //   </xsd:sequence>
 // </xsd:complexType>
 /**
+ * Abstract base class for table of contents type data models.
+ *
+ * @remarks
+ * Represents table of contents elements within Doxygen XML structures,
+ * corresponding to the tableofcontentsType complex type in the XML schema.
+ * This class handles the parsing of table of contents structures with
+ * mutually exclusive content choices: either table of contents sections
+ * or nested table of contents elements. All concrete table of contents
+ * data model classes should extend this abstract base to ensure consistent
+ * parsing and data representation.
+ *
  * @public
  */
 // eslint-disable-next-line max-len
 export class AbstractTableOfContentsType extends AbstractDataModelBase {
-    // xsd:choice, only one of them.
+    /**
+     * Collection of table of contents section data models.
+     *
+     * @remarks
+     * Optional array containing table of contents section elements, part
+     * of an exclusive choice with tableOfContents. Each section represents
+     * a specific part of the documentation structure with its own name,
+     * reference, and potentially nested content.
+     */
     tocSect;
+    /**
+     * Collection of nested table of contents data models.
+     *
+     * @remarks
+     * Optional array containing nested table of contents elements, part
+     * of an exclusive choice with tocSect. This allows for recursive
+     * table of contents structures to represent complex documentation
+     * hierarchies.
+     */
     tableOfContents;
+    /**
+     * Constructs a new AbstractTableOfContentsType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract table of contents information
+     * following the exclusive choice pattern defined in the XML schema. The
+     * constructor processes either table of contents sections or nested table
+     * of contents elements, but not both, maintaining the mutually exclusive
+     * relationship. This element type has no attributes as per the schema.
+     */
     constructor(xml, element, elementName) {
         super(elementName);
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
@@ -65,9 +107,31 @@ export class AbstractTableOfContentsType extends AbstractDataModelBase {
 // ----------------------------------------------------------------------------
 // <xsd:element name="tableofcontents" type="tableofcontentsType" minOccurs="0" maxOccurs="1" />
 /**
+ * Concrete data model class for table of contents elements.
+ *
+ * @remarks
+ * Represents individual table of contents elements found within Doxygen
+ * compound XML structures. This class extends the abstract base to provide
+ * specific handling for 'tableofcontents' elements, which define the
+ * structural navigation and organisation of documentation content. Each
+ * table of contents provides hierarchical access to documentation sections
+ * and subsections.
+ *
  * @public
  */
 export class TableOfContentsDataModel extends AbstractTableOfContentsType {
+    /**
+     * Constructs a new TableOfContentsDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents data
+     *
+     * @remarks
+     * Initialises the table of contents data model by parsing the provided
+     * XML element as a 'tableofcontents' element type. The constructor
+     * delegates to the parent class for common table of contents 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, 'tableofcontents');
@@ -82,15 +146,62 @@ export class TableOfContentsDataModel extends AbstractTableOfContentsType {
 //   </xsd:sequence>
 // </xsd:complexType>
 /**
+ * Abstract base class for table of contents kind type data models.
+ *
+ * @remarks
+ * Represents table of contents kind elements within Doxygen XML structures,
+ * corresponding to the tableofcontentsKindType complex type in the XML
+ * schema. This class handles the parsing of named table of contents sections
+ * with references and optional nested table of contents structures. All
+ * concrete table of contents kind data model classes should extend this
+ * abstract base to ensure consistent parsing and data representation.
+ *
  * @public
  */
 // eslint-disable-next-line max-len
 export class AbstractTableOfContentsKindType extends AbstractDataModelBase {
-    // Mandatory elements.
+    /**
+     * The name of the table of contents section.
+     *
+     * @remarks
+     * Mandatory element extracted from the XML structure that provides
+     * the display name or title for this table of contents section.
+     * This name is used for navigation and presentation purposes.
+     */
     name = '';
+    /**
+     * The reference identifier for this table of contents section.
+     *
+     * @remarks
+     * Mandatory element that provides a reference or link target for
+     * this table of contents section. This reference is used to create
+     * navigation links and cross-references within the documentation.
+     */
     reference = '';
-    // docs:
+    /**
+     * Collection of nested table of contents data models.
+     *
+     * @remarks
+     * Optional array containing nested table of contents elements that
+     * create hierarchical documentation structures. This allows for
+     * multi-level table of contents organisation with subsections and
+     * sub-subsections as needed.
+     */
     tableOfContents;
+    /**
+     * Constructs a new AbstractTableOfContentsKindType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents kind data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract table of contents kind
+     * information including mandatory name and reference elements, along with
+     * optional nested table of contents structures. The constructor handles
+     * unknown 'docs' elements that may appear but are not defined in the DTD.
+     * This element type has no attributes as per the XML schema.
+     */
     constructor(xml, element, elementName) {
         super(elementName);
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
@@ -130,9 +241,32 @@ export class AbstractTableOfContentsKindType extends AbstractDataModelBase {
 // ----------------------------------------------------------------------------
 // <xsd:element name="tocsect" type="tableofcontentsKindType" minOccurs="1" maxOccurs="unbounded" />
 /**
+ * Concrete data model class for table of contents section elements.
+ *
+ * @remarks
+ * Represents individual table of contents section elements found within
+ * Doxygen XML structures. This class extends the abstract base to provide
+ * specific handling for 'tocsect' elements, which define named sections
+ * within the table of contents hierarchy. Each section includes a name,
+ * reference, and potentially nested subsections for comprehensive
+ * documentation navigation.
+ *
  * @public
  */
 export class TocSectDataModel extends AbstractTableOfContentsKindType {
+    /**
+     * Constructs a new TocSectDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents section
+     * data
+     *
+     * @remarks
+     * Initialises the table of contents section data model by parsing the
+     * provided XML element as a 'tocsect' element type. The constructor
+     * delegates to the parent class for common section 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, 'tocsect');
@@ -143,11 +277,43 @@ export class TocSectDataModel extends AbstractTableOfContentsKindType {
 //   <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
 //   <xsd:attribute name="id" type="xsd:string" />
 // </xsd:complexType>
+/**
+ * Abstract base class for document table of contents item type data models.
+ *
+ * @remarks
+ * Represents table of contents item elements within Doxygen XML structures,
+ * corresponding to the docTocItemType complex type in the XML schema. This
+ * class handles the parsing of mixed content including text and document
+ * title command groups, along with mandatory identifier attributes. All
+ * concrete table of contents item data model classes should extend this
+ * abstract base to ensure consistent parsing and data representation.
+ *
+ * @public
+ */
 export class AbstractTocDocItemType extends AbstractDataModelBase {
-    // Any sequence of them.
-    // children: Array<string | DocTitleCmdGroup> = []
-    // Mandatory attributes.
+    /**
+     * The unique identifier for this table of contents item.
+     *
+     * @remarks
+     * Mandatory attribute that provides a unique identifier for referencing
+     * this table of contents item within the documentation structure. This
+     * identifier is used for cross-referencing and navigation purposes.
+     */
     id = '';
+    /**
+     * Constructs a new AbstractTocDocItemType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents item data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract table of contents item
+     * information including mixed content (text and document title command
+     * groups) and the mandatory identifier attribute. The constructor processes
+     * the mixed content model defined in the XML schema, handling both text
+     * nodes and structured command groups.
+     */
     constructor(xml, element, elementName) {
         super(elementName);
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
@@ -184,7 +350,31 @@ export class AbstractTocDocItemType extends AbstractDataModelBase {
     }
 }
 // <xsd:element name="tocitem" type="docTocItemType" minOccurs="0" maxOccurs="unbounded" />
+/**
+ * Concrete data model class for table of contents item elements.
+ *
+ * @remarks
+ * Represents individual table of contents item elements found within
+ * Doxygen XML structures. This class extends the abstract base to provide
+ * specific handling for 'tocitem' elements, which define individual entries
+ * within table of contents lists. Each item includes mixed content and
+ * a unique identifier for navigation and cross-referencing purposes.
+ *
+ * @public
+ */
 export class TocItemDataModel extends AbstractTocDocItemType {
+    /**
+     * Constructs a new TocItemDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents item data
+     *
+     * @remarks
+     * Initialises the table of contents item data model by parsing the provided
+     * XML element as a 'tocitem' element type. The constructor delegates to
+     * the parent class for common item 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, 'tocitem');
@@ -196,8 +386,43 @@ export class TocItemDataModel extends AbstractTocDocItemType {
 //     <xsd:element name="tocitem" type="docTocItemType" minOccurs="0" maxOccurs="unbounded" />
 //   </xsd:sequence>
 // </xsd:complexType>
+/**
+ * Abstract base class for document table of contents list type data models.
+ *
+ * @remarks
+ * Represents table of contents list elements within Doxygen XML structures,
+ * corresponding to the docTocListType complex type in the XML schema. This
+ * class handles the parsing of collections of table of contents items that
+ * form structured lists for documentation navigation. All concrete table
+ * of contents list data model classes should extend this abstract base to
+ * ensure consistent parsing and data representation.
+ *
+ * @public
+ */
 export class AbstractDocTocListType extends AbstractDataModelBase {
+    /**
+     * Collection of table of contents item data models.
+     *
+     * @remarks
+     * Optional array containing table of contents item elements that comprise
+     * the list structure. Each item represents an individual entry within the
+     * table of contents with its own content and identifier. The array supports
+     * zero to many items as per the XML schema.
+     */
     tocItems;
+    /**
+     * Constructs a new AbstractDocTocListType instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents list data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Parses the provided XML element to extract table of contents list
+     * information including collections of table of contents items. The
+     * constructor processes item elements into TocItemDataModel instances
+     * when present. This element type has no attributes as per the XML schema.
+     */
     constructor(xml, element, elementName) {
         super(elementName);
         const innerElements = xml.getInnerElements(element, elementName);
@@ -225,7 +450,31 @@ export class AbstractDocTocListType extends AbstractDataModelBase {
 }
 // ----------------------------------------------------------------------------
 // <xsd:element name="toclist" type="docTocListType" />
+/**
+ * Concrete data model class for table of contents list elements.
+ *
+ * @remarks
+ * Represents individual table of contents list elements found within
+ * Doxygen XML structures. This class extends the abstract base to provide
+ * specific handling for 'toclist' elements, which define structured lists
+ * of table of contents items for documentation navigation. Each list
+ * contains multiple items that collectively form a navigational structure.
+ *
+ * @public
+ */
 export class TocListDataModel extends AbstractDocTocListType {
+    /**
+     * Constructs a new TocListDataModel instance from XML data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML elements
+     * @param element - The XML element containing the table of contents list data
+     *
+     * @remarks
+     * Initialises the table of contents list data model by parsing the provided
+     * XML element as a 'toclist' element type. The constructor delegates to
+     * the parent class for common list 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, 'toclist');