@xpack/doxygen2docusaurus 2.0.0 → 2.1.0

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

@@ -1,301 +1,34 @@
 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;;;;;;;;;;;;;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"}
+{"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;AA6BnD,8BAAsB,2BAA4B,SAAQ,qBAAqB;IAU7E,OAAO,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAA;IAWvC,eAAe,EAAE,wBAAwB,EAAE,GAAG,SAAS,CAAA;gBAgB3C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA0CxE;AAmBD,qBAAa,wBAAyB,SAAQ,2BAA2B;gBAa3D,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AA0BD,8BAAsB,+BAAgC,SAAQ,qBAAqB;IASjF,IAAI,SAAK;IAUT,SAAS,SAAK;IAWd,eAAe,EAAE,wBAAwB,EAAE,GAAG,SAAS,CAAA;gBAgB3C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA4CxE;AAmBD,qBAAa,gBAAiB,SAAQ,+BAA+B;gBAcvD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAsBD,8BAAsB,sBAAuB,SAAQ,qBAAqB;IASxE,EAAE,SAAK;gBAgBK,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAkDxE;AAgBD,qBAAa,gBAAiB,SAAQ,sBAAsB;gBAa9C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAuBD,8BAAsB,sBAAuB,SAAQ,qBAAqB;IAUxE,QAAQ,CAAC,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAA;gBAe7B,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAiCxE;AAkBD,qBAAa,gBAAiB,SAAQ,sBAAsB;gBAa9C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}