@xpack/doxygen2docusaurus 1.0.2 → 2.0.0

package/dist/doxygen/data-model/types.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Represents the XML prologue declaration at the start of XML files.
+ *
+ * @remarks
+ * Contains the XML declaration with version, encoding, and standalone
+ * attributes as parsed by the XML parser from Doxygen-generated files.
+ *
+ * @public
+ */
 export interface XmlPrologue {
     '?xml': [XmlText];
     ':@': {
@@ -7,12 +16,25 @@ export interface XmlPrologue {
     };
 }
 /**
+ * Represents XML element attributes in the parsed structure.
+ *
+ * @remarks
+ * Contains the attributes map used by the XML parser to store element
+ * attributes with support for various primitive value types.
+ *
  * @public
  */
 export interface XmlAttributes {
     ':@': Record<string, string | number | boolean>;
 }
 /**
+ * Represents a generic XML element in the parsed structure.
+ *
+ * @remarks
+ * Defines the structure used by the XML parser for representing parsed
+ * XML elements, including text content, attributes, and child elements.
+ * Each element maps keys to arrays of child elements.
+ *
  * @public
  */
 export interface XmlElement {
@@ -20,25 +42,98 @@ export interface XmlElement {
     '#text': string | number | boolean;
     ':@'?: Record<string, string | number | boolean>;
 }
+/**
+ * Represents XML text content within elements.
+ *
+ * @remarks
+ * Simple wrapper for text content found within XML elements,
+ * used by the XML parser to distinguish text nodes.
+ *
+ * @public
+ */
 export interface XmlText {
     '#text': string;
 }
+/**
+ * Represents XML CDATA content within elements.
+ *
+ * @remarks
+ * Simple wrapper for CDATA content found within XML elements,
+ * used by the XML parser to distinguish CDATA nodes.
+ *
+ * @public
+ */
 export interface XmlCDATA {
     '#cdata': string;
 }
+/**
+ * Represents an XML element with a name property containing text content.
+ *
+ * @remarks
+ * Used for elements that have a `name` property with associated text content,
+ * as commonly found in Doxygen-generated XML files.
+ *
+ * @public
+ */
 export interface XmlNameElement {
     name: {
         '#text': string;
     };
 }
 /**
+ * Abstract base class for all data model elements in the Doxygen XML layer.
+ *
+ * @remarks
+ * Provides the common interface and properties for all data model elements
+ * parsed from Doxygen XML files. All concrete data model classes should
+ * extend this base class to ensure consistent structure and behaviour.
+ *
  * @public
  */
 export declare abstract class AbstractDataModelBase {
+    /**
+     * The name of the XML element represented by this data model instance.
+     *
+     * @remarks
+     * Used to identify the XML element type for this data model object.
+     */
     elementName: string;
+    /**
+     * Indicates whether paragraph processing should be skipped for this element.
+     *
+     * @remarks
+     * Optional property used to control paragraph handling during documentation
+     * generation. If true, paragraph tags are not generated for this element.
+     */
     skipPara?: boolean;
+    /**
+     * The child elements or text nodes contained within this data model element.
+     *
+     * @remarks
+     * Contains an array of child elements or text nodes, supporting recursive
+     * data model structures for complex XML hierarchies.
+     */
     children?: (string | AbstractDataModelBase)[];
+    /**
+     * Constructs a new data model base instance for a given XML element name.
+     *
+     * @param elementName - The name of the XML element represented by this
+     *   instance
+     *
+     * @remarks
+     * Initialises the base data model with the specified element name. All
+     * derived data model classes should call this constructor.
+     */
     constructor(elementName: string);
 }
-export type DataModelElement = AbstractDataModelBase | string;
+/**
+ * Union type for data model element content.
+ *
+ * @remarks
+ * Represents content that can be either a string value or an instance of
+ * an abstract data model class. Used to handle mixed content in XML elements.
+ *
+ * @public
+ */
+export type DataModelElement = string | AbstractDataModelBase;
 //# sourceMappingURL=types.d.ts.map

package/dist/doxygen/data-model/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/doxygen/data-model/types.ts"],"names":[],"mappings":"AAiBA,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,CAAC,OAAO,CAAC,CAAA;IACjB,IAAI,EAAE;QACJ,WAAW,EAAE,MAAM,CAAA;QACnB,YAAY,EAAE,MAAM,CAAA;QACpB,cAAc,EAAE,MAAM,CAAA;KACvB,CAAA;CACF;AAKD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IAEzB,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,EAAE,CAAA;IAC3B,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CACjD;AAED,MAAM,WAAW,OAAO;IACtB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAID;;GAEG;AACH,8BAAsB,qBAAqB;IACzC,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,qBAAqB,CAAC,EAAE,CAAA;gBAEjC,WAAW,EAAE,MAAM;CAGhC;AAED,MAAM,MAAM,gBAAgB,GAAG,qBAAqB,GAAG,MAAM,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/doxygen/data-model/types.ts"],"names":[],"mappings":"AAiBA;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,CAAC,OAAO,CAAC,CAAA;IACjB,IAAI,EAAE;QACJ,WAAW,EAAE,MAAM,CAAA;QACnB,YAAY,EAAE,MAAM,CAAA;QACpB,cAAc,EAAE,MAAM,CAAA;KACvB,CAAA;CACF;AAKD;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CAChD;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,UAAU;IAEzB,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,EAAE,CAAA;IAC3B,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CACjD;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,OAAO;IACtB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAID;;;;;;;;;GASG;AACH,8BAAsB,qBAAqB;IACzC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,qBAAqB,CAAC,EAAE,CAAA;IAE7C;;;;;;;;;OASG;gBACS,WAAW,EAAE,MAAM;CAGhC;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,qBAAqB,CAAA"}

package/dist/doxygen/data-model/types.js

@@ -10,12 +10,49 @@
  */
 // ----------------------------------------------------------------------------
 /**
+ * Abstract base class for all data model elements in the Doxygen XML layer.
+ *
+ * @remarks
+ * Provides the common interface and properties for all data model elements
+ * parsed from Doxygen XML files. All concrete data model classes should
+ * extend this base class to ensure consistent structure and behaviour.
+ *
  * @public
  */
 export class AbstractDataModelBase {
+    /**
+     * The name of the XML element represented by this data model instance.
+     *
+     * @remarks
+     * Used to identify the XML element type for this data model object.
+     */
     elementName;
+    /**
+     * Indicates whether paragraph processing should be skipped for this element.
+     *
+     * @remarks
+     * Optional property used to control paragraph handling during documentation
+     * generation. If true, paragraph tags are not generated for this element.
+     */
     skipPara;
+    /**
+     * The child elements or text nodes contained within this data model element.
+     *
+     * @remarks
+     * Contains an array of child elements or text nodes, supporting recursive
+     * data model structures for complex XML hierarchies.
+     */
     children;
+    /**
+     * Constructs a new data model base instance for a given XML element name.
+     *
+     * @param elementName - The name of the XML element represented by this
+     *   instance
+     *
+     * @remarks
+     * Initialises the base data model with the specified element name. All
+     * derived data model classes should call this constructor.
+     */
     constructor(elementName) {
         this.elementName = elementName;
     }

package/dist/doxygen/data-model/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/doxygen/data-model/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAmDH,+EAA+E;AAE/E;;GAEG;AACH,MAAM,OAAgB,qBAAqB;IACzC,WAAW,CAAQ;IACnB,QAAQ,CAAU;IAClB,QAAQ,CAAqC;IAE7C,YAAY,WAAmB;QAC7B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;CACF;AAID,+EAA+E"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/doxygen/data-model/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAoGH,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAgB,qBAAqB;IACzC;;;;;OAKG;IACH,WAAW,CAAQ;IAEnB;;;;;;OAMG;IACH,QAAQ,CAAU;IAElB;;;;;;OAMG;IACH,QAAQ,CAAqC;IAE7C;;;;;;;;;OASG;IACH,YAAY,WAAmB;QAC7B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;CACF;AAaD,+EAA+E"}