@xpack/doxygen2docusaurus 1.0.2 → 2.0.0

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

@@ -3,21 +3,99 @@ import { AbstractDataModelBase } from '../types.js';
 import { BriefDescriptionDataModel, DetailedDescriptionDataModel } from './descriptiontype-dm.js';
 import { InitializerDataModel } from './linkedtexttype-dm.js';
 /**
+ * Abstract base class for enumeration value data models.
+ *
+ * @remarks
+ * Represents individual values within enumeration types as parsed from
+ * Doxygen XML. Contains the value name, optional initialiser expression,
+ * and documentation descriptions with protection level information.
+ *
  * @public
  */
 export declare abstract class AbstractEnumValueType extends AbstractDataModelBase {
+    /**
+     * The name of the enumeration value.
+     *
+     * @remarks
+     * Simple identifier for the enumeration constant as it appears
+     * in the source code.
+     */
     name: string;
+    /**
+     * Optional initialiser expression for the enumeration value.
+     *
+     * @remarks
+     * Contains the explicit value assignment expression when the
+     * enumeration value is explicitly initialised in the source code.
+     */
     initializer?: InitializerDataModel | undefined;
+    /**
+     * Brief description of the enumeration value.
+     *
+     * @remarks
+     * Short documentation comment providing a concise explanation
+     * of the enumeration value's purpose or meaning.
+     */
     briefDescription?: BriefDescriptionDataModel | undefined;
+    /**
+     * Detailed description of the enumeration value.
+     *
+     * @remarks
+     * Comprehensive documentation comment providing full details
+     * about the enumeration value's purpose, usage, and behaviour.
+     */
     detailedDescription?: DetailedDescriptionDataModel | undefined;
+    /**
+     * Unique identifier for the enumeration value.
+     *
+     * @remarks
+     * Doxygen-generated identifier used for cross-referencing
+     * and creating links to this enumeration value.
+     */
     id: string;
+    /**
+     * Protection level of the enumeration value.
+     *
+     * @remarks
+     * Indicates the visibility scope such as 'public', 'private',
+     * or 'protected' based on Doxygen's protection kind enumeration.
+     */
     prot: string;
+    /**
+     * Creates a new enumeration value data model.
+     *
+     * @remarks
+     * Parses the XML element representing an enumeration value and
+     * extracts all relevant information including name, initialiser,
+     * descriptions, and attributes.
+     *
+     * @param xml - The XML parser instance
+     * @param element - The XML element to parse
+     * @param elementName - The name of the XML element
+     */
     constructor(xml: DoxygenXmlParser, element: object, elementName: string);
 }
 /**
+ * Concrete implementation of enumeration value data model.
+ *
+ * @remarks
+ * Represents a single enumeration value as parsed from Doxygen XML
+ * output. Inherits all functionality from the abstract base class
+ * and provides the specific element name for parsing.
+ *
  * @public
  */
 export declare class EnumValueDataModel extends AbstractEnumValueType {
+    /**
+     * Creates a new enumeration value data model from XML.
+     *
+     * @remarks
+     * Parses the XML element representing an enumeration value using
+     * the inherited parsing logic with the 'enumvalue' element name.
+     *
+     * @param xml - The XML parser instance
+     * @param element - The XML element to parse
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 //# sourceMappingURL=enumvaluetype-dm.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"enumvaluetype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/enumvaluetype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EACL,yBAAyB,EACzB,4BAA4B,EAC7B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAe7D;;GAEG;AACH,8BAAsB,qBAAsB,SAAQ,qBAAqB;IAEvE,IAAI,SAAK;IAGT,WAAW,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAA;IAC9C,gBAAgB,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAA;IACxD,mBAAmB,CAAC,EAAE,4BAA4B,GAAG,SAAS,CAAA;IAG9D,EAAE,SAAK;IACP,IAAI,SAAK;gBAEG,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAmExE;AAMD;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,qBAAqB;gBAC/C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
+{"version":3,"file":"enumvaluetype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/enumvaluetype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EACL,yBAAyB,EACzB,4BAA4B,EAC7B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAe7D;;;;;;;;;GASG;AACH,8BAAsB,qBAAsB,SAAQ,qBAAqB;IAEvE;;;;;;OAMG;IACH,IAAI,SAAK;IAGT;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAA;IAE9C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,yBAAyB,GAAG,SAAS,CAAA;IAExD;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,4BAA4B,GAAG,SAAS,CAAA;IAG9D;;;;;;OAMG;IACH,EAAE,SAAK;IAEP;;;;;;OAMG;IACH,IAAI,SAAK;IAET;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAmExE;AAMD;;;;;;;;;GASG;AACH,qBAAa,kBAAmB,SAAQ,qBAAqB;IAC3D;;;;;;;;;OASG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

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

@@ -26,18 +26,79 @@ import { InitializerDataModel } from './linkedtexttype-dm.js';
 //   <xsd:attribute name="prot" type="DoxProtectionKind" />
 // </xsd:complexType>
 /**
+ * Abstract base class for enumeration value data models.
+ *
+ * @remarks
+ * Represents individual values within enumeration types as parsed from
+ * Doxygen XML. Contains the value name, optional initialiser expression,
+ * and documentation descriptions with protection level information.
+ *
  * @public
  */
 export class AbstractEnumValueType extends AbstractDataModelBase {
     // Mandatory elements.
+    /**
+     * The name of the enumeration value.
+     *
+     * @remarks
+     * Simple identifier for the enumeration constant as it appears
+     * in the source code.
+     */
     name = '';
     // Optional elements.
+    /**
+     * Optional initialiser expression for the enumeration value.
+     *
+     * @remarks
+     * Contains the explicit value assignment expression when the
+     * enumeration value is explicitly initialised in the source code.
+     */
     initializer;
+    /**
+     * Brief description of the enumeration value.
+     *
+     * @remarks
+     * Short documentation comment providing a concise explanation
+     * of the enumeration value's purpose or meaning.
+     */
     briefDescription;
+    /**
+     * Detailed description of the enumeration value.
+     *
+     * @remarks
+     * Comprehensive documentation comment providing full details
+     * about the enumeration value's purpose, usage, and behaviour.
+     */
     detailedDescription;
     // Mandatory attributes.
+    /**
+     * Unique identifier for the enumeration value.
+     *
+     * @remarks
+     * Doxygen-generated identifier used for cross-referencing
+     * and creating links to this enumeration value.
+     */
     id = '';
+    /**
+     * Protection level of the enumeration value.
+     *
+     * @remarks
+     * Indicates the visibility scope such as 'public', 'private',
+     * or 'protected' based on Doxygen's protection kind enumeration.
+     */
     prot = ''; // DoxProtectionKind
+    /**
+     * Creates a new enumeration value data model.
+     *
+     * @remarks
+     * Parses the XML element representing an enumeration value and
+     * extracts all relevant information including name, initialiser,
+     * descriptions, and attributes.
+     *
+     * @param xml - The XML parser instance
+     * @param element - The XML element to parse
+     * @param elementName - The name of the XML element
+     */
     constructor(xml, element, elementName) {
         super(elementName);
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
@@ -92,9 +153,26 @@ export class AbstractEnumValueType extends AbstractDataModelBase {
 // ----------------------------------------------------------------------------
 //     <xsd:element name="enumvalue" type="enumvalueType" minOccurs="0" maxOccurs="unbounded" />
 /**
+ * Concrete implementation of enumeration value data model.
+ *
+ * @remarks
+ * Represents a single enumeration value as parsed from Doxygen XML
+ * output. Inherits all functionality from the abstract base class
+ * and provides the specific element name for parsing.
+ *
  * @public
  */
 export class EnumValueDataModel extends AbstractEnumValueType {
+    /**
+     * Creates a new enumeration value data model from XML.
+     *
+     * @remarks
+     * Parses the XML element representing an enumeration value using
+     * the inherited parsing logic with the 'enumvalue' element name.
+     *
+     * @param xml - The XML parser instance
+     * @param element - The XML element to parse
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'enumvalue');

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

@@ -1 +1 @@
-{"version":3,"file":"enumvaluetype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/enumvaluetype-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;AACnD,OAAO,EACL,yBAAyB,EACzB,4BAA4B,GAC7B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D,+EAA+E;AAE/E,yCAAyC;AACzC,mBAAmB;AACnB,oDAAoD;AACpD,6EAA6E;AAC7E,mFAAmF;AACnF,sFAAsF;AACtF,oBAAoB;AACpB,kDAAkD;AAClD,2DAA2D;AAC3D,qBAAqB;AAErB;;GAEG;AACH,MAAM,OAAgB,qBAAsB,SAAQ,qBAAqB;IACvE,sBAAsB;IACtB,IAAI,GAAG,EAAE,CAAA;IAET,qBAAqB;IACrB,WAAW,CAAmC;IAC9C,gBAAgB,CAAwC;IACxD,mBAAmB,CAA2C;IAE9D,wBAAwB;IACxB,EAAE,GAAG,EAAE,CAAA;IACP,IAAI,GAAG,EAAE,CAAA,CAAC,oBAAoB;IAE9B,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,aAAa,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAChE,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAEhC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnC,gBAAgB;YAClB,CAAC;iBAAM,IAAI,GAAG,CAAC,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC;gBACxD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;YAC3D,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,CAAC;gBAC5D,IAAI,CAAC,WAAW,GAAG,IAAI,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;YAChE,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,EAAE,CAAC;gBACjE,IAAI,CAAC,gBAAgB,GAAG,IAAI,yBAAyB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;YAC1E,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,qBAAqB,CAAC,EAAE,CAAC;gBACpE,IAAI,CAAC,mBAAmB,GAAG,IAAI,4BAA4B,CACzD,GAAG,EACH,YAAY,CACb,CAAA;YACH,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,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,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,MAAM,EAAE,CAAC;gBAC7B,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;YACxD,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,GAAG,WAAW,aAAa,EAC3B,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,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,gGAAgG;AAEhG;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IAC3D,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IAClC,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"enumvaluetype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/enumvaluetype-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;AACnD,OAAO,EACL,yBAAyB,EACzB,4BAA4B,GAC7B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D,+EAA+E;AAE/E,yCAAyC;AACzC,mBAAmB;AACnB,oDAAoD;AACpD,6EAA6E;AAC7E,mFAAmF;AACnF,sFAAsF;AACtF,oBAAoB;AACpB,kDAAkD;AAClD,2DAA2D;AAC3D,qBAAqB;AAErB;;;;;;;;;GASG;AACH,MAAM,OAAgB,qBAAsB,SAAQ,qBAAqB;IACvE,sBAAsB;IACtB;;;;;;OAMG;IACH,IAAI,GAAG,EAAE,CAAA;IAET,qBAAqB;IACrB;;;;;;OAMG;IACH,WAAW,CAAmC;IAE9C;;;;;;OAMG;IACH,gBAAgB,CAAwC;IAExD;;;;;;OAMG;IACH,mBAAmB,CAA2C;IAE9D,wBAAwB;IACxB;;;;;;OAMG;IACH,EAAE,GAAG,EAAE,CAAA;IAEP;;;;;;OAMG;IACH,IAAI,GAAG,EAAE,CAAA,CAAC,oBAAoB;IAE9B;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,aAAa,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAChE,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAEhC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnC,gBAAgB;YAClB,CAAC;iBAAM,IAAI,GAAG,CAAC,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC;gBACxD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;YAC3D,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,CAAC;gBAC5D,IAAI,CAAC,WAAW,GAAG,IAAI,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;YAChE,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,EAAE,CAAC;gBACjE,IAAI,CAAC,gBAAgB,GAAG,IAAI,yBAAyB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;YAC1E,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,qBAAqB,CAAC,EAAE,CAAC;gBACpE,IAAI,CAAC,mBAAmB,GAAG,IAAI,4BAA4B,CACzD,GAAG,EACH,YAAY,CACb,CAAA;YACH,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,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,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,MAAM,EAAE,CAAC;gBAC7B,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;YACxD,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,GAAG,WAAW,aAAa,EAC3B,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,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,gGAAgG;AAEhG;;;;;;;;;GASG;AACH,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IAC3D;;;;;;;;;OASG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IAClC,CAAC;CACF;AAED,+EAA+E"}

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

@@ -1,24 +1,131 @@
 import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
 import { AbstractDataModelBase } from '../types.js';
 /**
+ * Abstract base class for include-type elements within documentation.
+ *
+ * @remarks
+ * Implements processing for include-type elements that represent file inclusion
+ * relationships within source code documentation. This class handles the XML
+ * Schema definition for incType elements, which contain textual content
+ * representing file paths or names along with attributes that specify inclusion
+ * behaviour and reference relationships.
+ *
+ * The implementation processes both local and system includes, distinguishing
+ * between quoted includes ("filename") and angle-bracket includes (<filename>)
+ * through the local attribute. Optional reference identifiers enable
+ * cross-referencing to the included file's documentation.
+ *
  * @public
  */
 export declare abstract class AbstractIncType extends AbstractDataModelBase {
+    /**
+     * The textual content representing the file path or name being included.
+     *
+     * @remarks
+     * Contains the file path or filename as specified in the include directive.
+     * This text content represents the actual filename that appears within
+     * the include statement in the source code, providing the reference to
+     * the included file within the documentation structure.
+     */
     text: string;
+    /**
+     * Indicates whether the include uses local or system include syntax.
+     *
+     * @remarks
+     * Determines the include syntax style: when true, indicates a local include
+     * using quotation marks ("filename"), when false, indicates a system include
+     * using angle brackets (<filename>). This distinction affects how the
+     * preprocessor searches for the included file.
+     */
     local: boolean;
+    /**
+     * Optional reference identifier for cross-linking to the included file.
+     *
+     * @remarks
+     * Contains the reference identifier that links to the documentation of
+     * the included file. This enables navigation from include statements to
+     * the actual file documentation within the generated documentation system.
+     */
     refId?: string | undefined;
+    /**
+     * Constructs an AbstractIncType instance from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the include data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * This constructor processes include-type elements by extracting the
+     * textual content representing the filename and processing attributes
+     * that specify inclusion behaviour. The parser validates the presence
+     * of required content and attributes whilst maintaining compliance with
+     * the XML Schema definition for include elements.
+     *
+     * The implementation distinguishes between local and system includes
+     * through the local attribute and optionally associates reference
+     * identifiers for cross-linking to included file documentation.
+     */
     constructor(xml: DoxygenXmlParser, element: object, elementName: string);
 }
 /**
+ * Data model for includes elements within documentation content.
+ *
+ * @remarks
+ * Represents includes elements that document files included by the current
+ * source file. This implementation processes Doxygen's includes elements,
+ * which contain information about files that are included through preprocessor
+ * directives such as #include statements within the documented source code.
+ *
+ * The includes relationship indicates a dependency where the current file
+ * incorporates content from the referenced file during compilation.
+ *
  * @public
  */
 export declare class IncludesDataModel extends AbstractIncType {
+    /**
+     * Constructs an IncludesDataModel from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the includes data
+     *
+     * @remarks
+     * This constructor delegates to the parent AbstractIncType to handle
+     * include processing whilst identifying the element as 'includes' for
+     * proper XML schema compliance and include relationship documentation.
+     * The processed data represents files that are included by the current
+     * source file through preprocessor directives.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 /**
+ * Data model for includedby elements within documentation content.
+ *
+ * @remarks
+ * Represents includedby elements that document files which include the
+ * current source file. This implementation processes Doxygen's includedby
+ * elements, which contain information about files that incorporate the
+ * current file through preprocessor directives, establishing reverse
+ * inclusion relationships within the documentation system.
+ *
+ * The includedby relationship indicates a dependency where other files
+ * incorporate content from the current file during compilation.
+ *
  * @public
  */
 export declare class IncludedByDataModel extends AbstractIncType {
+    /**
+     * Constructs an IncludedByDataModel from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the includedby data
+     *
+     * @remarks
+     * This constructor delegates to the parent AbstractIncType to handle
+     * include processing whilst identifying the element as 'includedby' for
+     * proper XML schema compliance and reverse include relationship handling.
+     * The processed data represents files that include the current source file
+     * through preprocessor directives, establishing dependency relationships.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 //# sourceMappingURL=inctype-dm.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"inctype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/inctype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAanD;;GAEG;AACH,8BAAsB,eAAgB,SAAQ,qBAAqB;IAEjE,IAAI,SAAK;IAGT,KAAK,UAAQ;IAGb,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;gBAEd,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAuCxE;AAOD;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;gBACxC,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,eAAe;gBAC1C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
+{"version":3,"file":"inctype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/inctype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAanD;;;;;;;;;;;;;;;;GAgBG;AACH,8BAAsB,eAAgB,SAAQ,qBAAqB;IACjE;;;;;;;;OAQG;IAEH,IAAI,SAAK;IAET;;;;;;;;OAQG;IAEH,KAAK,UAAQ;IAEb;;;;;;;OAOG;IAEH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE1B;;;;;;;;;;;;;;;;;OAiBG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAuCxE;AAOD;;;;;;;;;;;;;GAaG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;IACpD;;;;;;;;;;;;OAYG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,mBAAoB,SAAQ,eAAe;IACtD;;;;;;;;;;;;OAYG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

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

@@ -22,15 +22,73 @@ import { AbstractDataModelBase } from '../types.js';
 //   </xsd:simpleContent>
 // </xsd:complexType>
 /**
+ * Abstract base class for include-type elements within documentation.
+ *
+ * @remarks
+ * Implements processing for include-type elements that represent file inclusion
+ * relationships within source code documentation. This class handles the XML
+ * Schema definition for incType elements, which contain textual content
+ * representing file paths or names along with attributes that specify inclusion
+ * behaviour and reference relationships.
+ *
+ * The implementation processes both local and system includes, distinguishing
+ * between quoted includes ("filename") and angle-bracket includes (<filename>)
+ * through the local attribute. Optional reference identifiers enable
+ * cross-referencing to the included file's documentation.
+ *
  * @public
  */
 export class AbstractIncType extends AbstractDataModelBase {
+    /**
+     * The textual content representing the file path or name being included.
+     *
+     * @remarks
+     * Contains the file path or filename as specified in the include directive.
+     * This text content represents the actual filename that appears within
+     * the include statement in the source code, providing the reference to
+     * the included file within the documentation structure.
+     */
     // Mandatory elements.
     text = ''; // Passed as element text.
+    /**
+     * Indicates whether the include uses local or system include syntax.
+     *
+     * @remarks
+     * Determines the include syntax style: when true, indicates a local include
+     * using quotation marks ("filename"), when false, indicates a system include
+     * using angle brackets (<filename>). This distinction affects how the
+     * preprocessor searches for the included file.
+     */
     // Mandatory attributes.
     local = false; // It means to use "..." instead of <...>.
+    /**
+     * Optional reference identifier for cross-linking to the included file.
+     *
+     * @remarks
+     * Contains the reference identifier that links to the documentation of
+     * the included file. This enables navigation from include statements to
+     * the actual file documentation within the generated documentation system.
+     */
     // Optional attributes.
     refId; // file id
+    /**
+     * Constructs an AbstractIncType instance from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the include data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * This constructor processes include-type elements by extracting the
+     * textual content representing the filename and processing attributes
+     * that specify inclusion behaviour. The parser validates the presence
+     * of required content and attributes whilst maintaining compliance with
+     * the XML Schema definition for include elements.
+     *
+     * The implementation distinguishes between local and system includes
+     * through the local attribute and optionally associates reference
+     * identifiers for cross-linking to included file documentation.
+     */
     constructor(xml, element, elementName) {
         super(elementName);
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))ect(element))ect(element))
@@ -63,18 +121,67 @@ export class AbstractIncType extends AbstractDataModelBase {
 // <xsd:element name="includes" type="incType" minOccurs="0" maxOccurs="unbounded" />
 // <xsd:element name="includedby" type="incType" minOccurs="0" maxOccurs="unbounded" />
 /**
+ * Data model for includes elements within documentation content.
+ *
+ * @remarks
+ * Represents includes elements that document files included by the current
+ * source file. This implementation processes Doxygen's includes elements,
+ * which contain information about files that are included through preprocessor
+ * directives such as #include statements within the documented source code.
+ *
+ * The includes relationship indicates a dependency where the current file
+ * incorporates content from the referenced file during compilation.
+ *
  * @public
  */
 export class IncludesDataModel extends AbstractIncType {
+    /**
+     * Constructs an IncludesDataModel from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the includes data
+     *
+     * @remarks
+     * This constructor delegates to the parent AbstractIncType to handle
+     * include processing whilst identifying the element as 'includes' for
+     * proper XML schema compliance and include relationship documentation.
+     * The processed data represents files that are included by the current
+     * source file through preprocessor directives.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'includes');
     }
 }
 /**
+ * Data model for includedby elements within documentation content.
+ *
+ * @remarks
+ * Represents includedby elements that document files which include the
+ * current source file. This implementation processes Doxygen's includedby
+ * elements, which contain information about files that incorporate the
+ * current file through preprocessor directives, establishing reverse
+ * inclusion relationships within the documentation system.
+ *
+ * The includedby relationship indicates a dependency where other files
+ * incorporate content from the current file during compilation.
+ *
  * @public
  */
 export class IncludedByDataModel extends AbstractIncType {
+    /**
+     * Constructs an IncludedByDataModel from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the includedby data
+     *
+     * @remarks
+     * This constructor delegates to the parent AbstractIncType to handle
+     * include processing whilst identifying the element as 'includedby' for
+     * proper XML schema compliance and reverse include relationship handling.
+     * The processed data represents files that include the current source file
+     * through preprocessor directives, establishing dependency relationships.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'includedby');

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

@@ -1 +1 @@
-{"version":3,"file":"inctype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/inctype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,mCAAmC;AACnC,wBAAwB;AACxB,wCAAwC;AACxC,wEAAwE;AACxE,sDAAsD;AACtD,uBAAuB;AACvB,yBAAyB;AACzB,qBAAqB;AAErB;;GAEG;AACH,MAAM,OAAgB,eAAgB,SAAQ,qBAAqB;IACjE,sBAAsB;IACtB,IAAI,GAAG,EAAE,CAAA,CAAC,0BAA0B;IAEpC,wBAAwB;IACxB,KAAK,GAAG,KAAK,CAAA,CAAC,0CAA0C;IAExD,uBAAuB;IACvB,KAAK,CAAqB,CAAC,UAAU;IAErC,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,4GAA4G;QAE5G,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAEzD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,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,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,wBAAwB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC/D,CAAC;iBAAM,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBACvC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,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,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,qFAAqF;AACrF,uFAAuF;AAEvF;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IACpD,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;IACjC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACtD,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"inctype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/inctype-dm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,mCAAmC;AACnC,wBAAwB;AACxB,wCAAwC;AACxC,wEAAwE;AACxE,sDAAsD;AACtD,uBAAuB;AACvB,yBAAyB;AACzB,qBAAqB;AAErB;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAgB,eAAgB,SAAQ,qBAAqB;IACjE;;;;;;;;OAQG;IACH,sBAAsB;IACtB,IAAI,GAAG,EAAE,CAAA,CAAC,0BAA0B;IAEpC;;;;;;;;OAQG;IACH,wBAAwB;IACxB,KAAK,GAAG,KAAK,CAAA,CAAC,0CAA0C;IAExD;;;;;;;OAOG;IACH,uBAAuB;IACvB,KAAK,CAAqB,CAAC,UAAU;IAErC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,4GAA4G;QAE5G,2EAA2E;QAC3E,oBAAoB;QAEpB,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QAEzD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE5B,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,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,wBAAwB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC/D,CAAC;iBAAM,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBACvC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,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,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,qFAAqF;AACrF,uFAAuF;AAEvF;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IACpD;;;;;;;;;;;;OAYG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;IACjC,CAAC;CACF;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACtD;;;;;;;;;;;;OAYG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAED,+EAA+E"}