@xpack/doxygen2docusaurus 1.0.2 → 2.0.0

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

@@ -1,33 +1,156 @@
 import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
 import { AbstractDataModelBase } from '../types.js';
 /**
+ * Abstract base class for linked text elements within documentation content.
+ *
+ * @remarks
+ * Implements processing for linked text elements that contain mixed content
+ * including both textual content and reference elements. This class handles
+ * the XML Schema definition for linkedTextType elements, which support
+ * character data interspersed with reference elements that provide
+ * cross-linking capabilities within documentation structures.
+ *
+ * The implementation processes sequences of text strings and RefTextDataModel
+ * instances, maintaining their original order to preserve the intended
+ * content flow whilst enabling interactive cross-references within the
+ * generated documentation.
+ *
  * @public
  */
 export declare abstract class AbstractLinkedTextType extends AbstractDataModelBase {
+    /**
+     * Constructs an AbstractLinkedTextType instance from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the linked text data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * This constructor processes linked text elements by extracting both
+     * textual content and reference elements in their original order. The
+     * parser maintains the mixed content structure whilst creating appropriate
+     * RefTextDataModel instances for cross-reference elements, ensuring
+     * proper content flow and interactive linking capabilities within the
+     * documentation system.
+     */
     constructor(xml: DoxygenXmlParser, element: object, elementName: string);
 }
 /**
+ * Data model for initializer elements within documentation content.
+ *
+ * @remarks
+ * Represents initializer elements that contain variable or member
+ * initialization expressions within source code documentation. This
+ * implementation processes Doxygen's initializer elements, which contain
+ * mixed text and reference content describing the initial values assigned
+ * to variables, constants, or class members.
+ *
+ * The linked text structure enables cross-references to types and symbols
+ * used within initialization expressions.
+ *
  * @public
  */
 export declare class InitializerDataModel extends AbstractLinkedTextType {
+    /**
+     * Constructs an InitializerDataModel from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the initializer data
+     *
+     * @remarks
+     * This constructor delegates to the parent AbstractLinkedTextType to
+     * handle linked text processing whilst identifying the element as
+     * 'initializer' for proper XML schema compliance and initialization
+     * expression content processing.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 /**
+ * Data model for type elements within documentation content.
+ *
+ * @remarks
+ * Represents type elements that contain type information and declarations
+ * within source code documentation. This implementation processes Doxygen's
+ * type elements, which contain mixed text and reference content describing
+ * data types, including primitive types, class names, template parameters,
+ * and complex type expressions.
+ *
+ * The linked text structure enables cross-references to type definitions
+ * and related documentation within the type expressions.
+ *
  * @public
  */
 export declare class TypeDataModel extends AbstractLinkedTextType {
+    /**
+     * Constructs a TypeDataModel from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the type data
+     *
+     * @remarks
+     * This constructor delegates to the parent AbstractLinkedTextType to
+     * handle linked text processing whilst identifying the element as 'type'
+     * for proper XML schema compliance and type information content processing.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 /**
+ * Data model for default value elements within documentation content.
+ *
+ * @remarks
+ * Represents default value elements that contain parameter default values
+ * within function and method documentation. This implementation processes
+ * Doxygen's defval elements, which contain mixed text and reference content
+ * describing the default values assigned to function parameters when no
+ * explicit value is provided during function calls.
+ *
+ * The linked text structure enables cross-references to constants, enums,
+ * and other symbols used within default value expressions.
+ *
  * @public
  */
 export declare class DefValDataModel extends AbstractLinkedTextType {
+    /**
+     * Constructs a DefValDataModel from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the default value data
+     *
+     * @remarks
+     * This constructor delegates to the parent AbstractLinkedTextType to
+     * handle linked text processing whilst identifying the element as 'defval'
+     * for proper XML schema compliance and default value content processing.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 /**
+ * Data model for type constraint elements within documentation content.
+ *
+ * @remarks
+ * Represents type constraint elements that contain template and generic
+ * type constraint information within source code documentation. This
+ * implementation processes Doxygen's typeconstraint elements, which contain
+ * mixed text and reference content describing constraints applied to
+ * template parameters and generic types.
+ *
+ * The linked text structure enables cross-references to constraint types,
+ * concepts, and related template documentation within constraint expressions.
+ *
  * @public
  */
 export declare class TypeConstraintDataModel extends AbstractLinkedTextType {
+    /**
+     * Constructs a TypeConstraintDataModel from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the type constraint data
+     *
+     * @remarks
+     * This constructor delegates to the parent AbstractLinkedTextType to
+     * handle linked text processing whilst identifying the element as
+     * 'typeconstraint' for proper XML schema compliance and type constraint
+     * content processing.
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 //# sourceMappingURL=linkedtexttype-dm.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"linkedtexttype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/linkedtexttype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAE3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAUnD;;GAEG;AACH,8BAAsB,sBAAuB,SAAQ,qBAAqB;gBAI5D,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAqCxE;AAkBD;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,sBAAsB;gBAClD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,sBAAsB;gBAC3C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,sBAAsB;gBAC7C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,sBAAsB;gBACrD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
+{"version":3,"file":"linkedtexttype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/linkedtexttype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAE3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAUnD;;;;;;;;;;;;;;;;GAgBG;AACH,8BAAsB,sBAAuB,SAAQ,qBAAqB;IACxE;;;;;;;;;;;;;;OAcG;gBAIS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAqCxE;AAkBD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,oBAAqB,SAAQ,sBAAsB;IAC9D;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,aAAc,SAAQ,sBAAsB;IACvD;;;;;;;;;;OAUG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,eAAgB,SAAQ,sBAAsB;IACzD;;;;;;;;;;OAUG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,uBAAwB,SAAQ,sBAAsB;IACjE;;;;;;;;;;;OAWG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

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

@@ -20,9 +20,38 @@ import { AbstractDataModelBase } from '../types.js';
 //   </xsd:sequence>
 // </xsd:complexType>
 /**
+ * Abstract base class for linked text elements within documentation content.
+ *
+ * @remarks
+ * Implements processing for linked text elements that contain mixed content
+ * including both textual content and reference elements. This class handles
+ * the XML Schema definition for linkedTextType elements, which support
+ * character data interspersed with reference elements that provide
+ * cross-linking capabilities within documentation structures.
+ *
+ * The implementation processes sequences of text strings and RefTextDataModel
+ * instances, maintaining their original order to preserve the intended
+ * content flow whilst enabling interactive cross-references within the
+ * generated documentation.
+ *
  * @public
  */
 export class AbstractLinkedTextType extends AbstractDataModelBase {
+    /**
+     * Constructs an AbstractLinkedTextType instance from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the linked text data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * This constructor processes linked text elements by extracting both
+     * textual content and reference elements in their original order. The
+     * parser maintains the mixed content structure whilst creating appropriate
+     * RefTextDataModel instances for cross-reference elements, ensuring
+     * proper content flow and interactive linking capabilities within the
+     * documentation system.
+     */
     // Any sequence of them.
     // children: Array<string | AbstractRefTextType> = []
     constructor(xml, element, elementName) {
@@ -63,36 +92,130 @@ export class AbstractLinkedTextType extends AbstractDataModelBase {
 // <xsd:element name="defval" type="linkedTextType" minOccurs="0" />
 // <xsd:element name="typeconstraint" type="linkedTextType" minOccurs="0" />
 /**
+ * Data model for initializer elements within documentation content.
+ *
+ * @remarks
+ * Represents initializer elements that contain variable or member
+ * initialization expressions within source code documentation. This
+ * implementation processes Doxygen's initializer elements, which contain
+ * mixed text and reference content describing the initial values assigned
+ * to variables, constants, or class members.
+ *
+ * The linked text structure enables cross-references to types and symbols
+ * used within initialization expressions.
+ *
  * @public
  */
 export class InitializerDataModel extends AbstractLinkedTextType {
+    /**
+     * Constructs an InitializerDataModel from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the initializer data
+     *
+     * @remarks
+     * This constructor delegates to the parent AbstractLinkedTextType to
+     * handle linked text processing whilst identifying the element as
+     * 'initializer' for proper XML schema compliance and initialization
+     * expression content processing.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'initializer');
     }
 }
 /**
+ * Data model for type elements within documentation content.
+ *
+ * @remarks
+ * Represents type elements that contain type information and declarations
+ * within source code documentation. This implementation processes Doxygen's
+ * type elements, which contain mixed text and reference content describing
+ * data types, including primitive types, class names, template parameters,
+ * and complex type expressions.
+ *
+ * The linked text structure enables cross-references to type definitions
+ * and related documentation within the type expressions.
+ *
  * @public
  */
 export class TypeDataModel extends AbstractLinkedTextType {
+    /**
+     * Constructs a TypeDataModel from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the type data
+     *
+     * @remarks
+     * This constructor delegates to the parent AbstractLinkedTextType to
+     * handle linked text processing whilst identifying the element as 'type'
+     * for proper XML schema compliance and type information content processing.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'type');
     }
 }
 /**
+ * Data model for default value elements within documentation content.
+ *
+ * @remarks
+ * Represents default value elements that contain parameter default values
+ * within function and method documentation. This implementation processes
+ * Doxygen's defval elements, which contain mixed text and reference content
+ * describing the default values assigned to function parameters when no
+ * explicit value is provided during function calls.
+ *
+ * The linked text structure enables cross-references to constants, enums,
+ * and other symbols used within default value expressions.
+ *
  * @public
  */
 export class DefValDataModel extends AbstractLinkedTextType {
+    /**
+     * Constructs a DefValDataModel from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the default value data
+     *
+     * @remarks
+     * This constructor delegates to the parent AbstractLinkedTextType to
+     * handle linked text processing whilst identifying the element as 'defval'
+     * for proper XML schema compliance and default value content processing.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'defval');
     }
 }
 /**
+ * Data model for type constraint elements within documentation content.
+ *
+ * @remarks
+ * Represents type constraint elements that contain template and generic
+ * type constraint information within source code documentation. This
+ * implementation processes Doxygen's typeconstraint elements, which contain
+ * mixed text and reference content describing constraints applied to
+ * template parameters and generic types.
+ *
+ * The linked text structure enables cross-references to constraint types,
+ * concepts, and related template documentation within constraint expressions.
+ *
  * @public
  */
 export class TypeConstraintDataModel extends AbstractLinkedTextType {
+    /**
+     * Constructs a TypeConstraintDataModel from XML element data.
+     *
+     * @param xml - The Doxygen XML parser instance for processing XML content
+     * @param element - The XML element object containing the type constraint data
+     *
+     * @remarks
+     * This constructor delegates to the parent AbstractLinkedTextType to
+     * handle linked text processing whilst identifying the element as
+     * 'typeconstraint' for proper XML schema compliance and type constraint
+     * content processing.
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'typeconstraint');

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

@@ -1 +1 @@
-{"version":3,"file":"linkedtexttype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/linkedtexttype-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,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,6HAA6H;AAC7H,mBAAmB;AACnB,sFAAsF;AACtF,oBAAoB;AACpB,qBAAqB;AAErB;;GAEG;AACH,MAAM,OAAgB,sBAAuB,SAAQ,qBAAqB;IACxE,wBAAwB;IACxB,qDAAqD;IAErD,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;QAEhE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAElB,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAA;YACpD,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC;gBACpD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAC7D,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,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAEnC,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,4EAA4E;AAC5E,yEAAyE;AACzE,kEAAkE;AAClE,4EAA4E;AAC5E,yEAAyE;AACzE,wEAAwE;AAExE,yEAAyE;AAEzE,kEAAkE;AAElE,oEAAoE;AACpE,4EAA4E;AAE5E;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,sBAAsB;IAC9D,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,CAAA;IACpC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,sBAAsB;IACvD,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IAC7B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,sBAAsB;IACzD,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,sBAAsB;IACjE,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAA;IACvC,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"linkedtexttype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/linkedtexttype-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,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,6HAA6H;AAC7H,mBAAmB;AACnB,sFAAsF;AACtF,oBAAoB;AACpB,qBAAqB;AAErB;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAgB,sBAAuB,SAAQ,qBAAqB;IACxE;;;;;;;;;;;;;;OAcG;IACH,wBAAwB;IACxB,qDAAqD;IAErD,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;QAEhE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAElB,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAA;YACpD,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC;gBACpD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAC7D,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,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAEnC,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,4EAA4E;AAC5E,yEAAyE;AACzE,kEAAkE;AAClE,4EAA4E;AAC5E,yEAAyE;AACzE,wEAAwE;AAExE,yEAAyE;AAEzE,kEAAkE;AAElE,oEAAoE;AACpE,4EAA4E;AAE5E;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,oBAAqB,SAAQ,sBAAsB;IAC9D;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,CAAA;IACpC,CAAC;CACF;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,aAAc,SAAQ,sBAAsB;IACvD;;;;;;;;;;OAUG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IAC7B,CAAC;CACF;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,eAAgB,SAAQ,sBAAsB;IACzD;;;;;;;;;;OAUG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACF;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,uBAAwB,SAAQ,sBAAsB;IACjE;;;;;;;;;;;OAWG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAA;IACvC,CAAC;CACF;AAED,+EAA+E"}

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

@@ -2,16 +2,86 @@ import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
 import { MemberRefDataModel } from './memberreftype-dm.js';
 import { AbstractDataModelBase } from '../types.js';
 /**
+ * Abstract base class for list-of-all-members elements within documentation.
+ *
+ * @remarks
+ * Implements processing for list-of-all-members elements that contain
+ * comprehensive member reference collections within class and compound
+ * documentation. This class handles the XML Schema definition for
+ * listofallmembersType elements, which provide complete inventories of
+ * all members (including inherited members) associated with classes,
+ * structures, and other compound types.
+ *
+ * The implementation processes sequences of member reference elements,
+ * creating MemberRefDataModel instances to maintain detailed information
+ * about each member's identity, scope, and accessibility within the
+ * compound's complete member hierarchy.
+ *
  * @public
  */
 export declare abstract class AbstractListOfAllMembersType extends AbstractDataModelBase {
+    /**
+     * Collection of member reference elements within the list-of-all-members.
+     *
+     * @remarks
+     * Contains processed member reference data models representing all members
+     * associated with the compound, including both directly declared and
+     * inherited members. Each reference provides comprehensive identification
+     * and scope information for the corresponding member element.
+     *
+     * @public
+     */
     memberRefs?: MemberRefDataModel[] | undefined;
+    /**
+     * Constructs a new list-of-all-members data model instance.
+     *
+     * @param xml - The XML parser instance for processing elements
+     * @param element - The source XML element containing list-of-all-members data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Processes the XML element to extract and organise member reference
+     * information, creating appropriate data model instances for each
+     * member entry found within the comprehensive member listing.
+     * The constructor validates the element structure and ensures
+     * all member references are properly instantiated.
+     *
+     * @public
+     */
     constructor(xml: DoxygenXmlParser, element: object, elementName: string);
 }
 /**
+ * Concrete implementation for listofallmembers elements within compound
+ * documentation.
+ *
+ * @remarks
+ * Provides specific handling for listofallmembers XML elements that contain
+ * comprehensive member inventories within class and compound documentation.
+ * This implementation extends the abstract base class functionality to
+ * process the complete collection of member references, including both
+ * directly declared and inherited members.
+ *
+ * The class ensures proper instantiation of member reference data models
+ * whilst maintaining the hierarchical structure and accessibility information
+ * required for comprehensive documentation generation.
+ *
  * @public
  */
 export declare class ListOfAllMembersDataModel extends AbstractListOfAllMembersType {
+    /**
+     * Constructs a new listofallmembers data model instance.
+     *
+     * @param xml - The XML parser instance for processing elements
+     * @param element - The source XML element containing listofallmembers data
+     *
+     * @remarks
+     * Initialises the data model with the specific element name
+     * 'listofallmembers' and delegates processing to the abstract base class
+     * implementation. This ensures consistent handling of member reference
+     * collections whilst maintaining proper element identification.
+     *
+     * @public
+     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 //# sourceMappingURL=listofallmemberstype-dm.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"listofallmemberstype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/listofallmemberstype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAUnD;;GAEG;AAEH,8BAAsB,4BAA6B,SAAQ,qBAAqB;IAE9E,UAAU,CAAC,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAA;gBAEjC,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAsCxE;AAMD;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,4BAA4B;gBAC7D,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
+{"version":3,"file":"listofallmemberstype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/listofallmemberstype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAUnD;;;;;;;;;;;;;;;;;GAiBG;AAEH,8BAAsB,4BAA6B,SAAQ,qBAAqB;IAC9E;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAA;IAE7C;;;;;;;;;;;;;;;OAeG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAsCxE;AAMD;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,yBAA0B,SAAQ,4BAA4B;IACzE;;;;;;;;;;;;;OAaG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

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

@@ -20,12 +20,53 @@ import { AbstractDataModelBase } from '../types.js';
 //   </xsd:sequence>
 // </xsd:complexType>
 /**
+ * Abstract base class for list-of-all-members elements within documentation.
+ *
+ * @remarks
+ * Implements processing for list-of-all-members elements that contain
+ * comprehensive member reference collections within class and compound
+ * documentation. This class handles the XML Schema definition for
+ * listofallmembersType elements, which provide complete inventories of
+ * all members (including inherited members) associated with classes,
+ * structures, and other compound types.
+ *
+ * The implementation processes sequences of member reference elements,
+ * creating MemberRefDataModel instances to maintain detailed information
+ * about each member's identity, scope, and accessibility within the
+ * compound's complete member hierarchy.
+ *
  * @public
  */
 // eslint-disable-next-line max-len
 export class AbstractListOfAllMembersType extends AbstractDataModelBase {
-    // Optional elements.
+    /**
+     * Collection of member reference elements within the list-of-all-members.
+     *
+     * @remarks
+     * Contains processed member reference data models representing all members
+     * associated with the compound, including both directly declared and
+     * inherited members. Each reference provides comprehensive identification
+     * and scope information for the corresponding member element.
+     *
+     * @public
+     */
     memberRefs;
+    /**
+     * Constructs a new list-of-all-members data model instance.
+     *
+     * @param xml - The XML parser instance for processing elements
+     * @param element - The source XML element containing list-of-all-members data
+     * @param elementName - The name of the XML element being processed
+     *
+     * @remarks
+     * Processes the XML element to extract and organise member reference
+     * information, creating appropriate data model instances for each
+     * member entry found within the comprehensive member listing.
+     * The constructor validates the element structure and ensures
+     * all member references are properly instantiated.
+     *
+     * @public
+     */
     constructor(xml, element, elementName) {
         super(elementName);
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
@@ -57,9 +98,37 @@ export class AbstractListOfAllMembersType extends AbstractDataModelBase {
 // ----------------------------------------------------------------------------
 // <xsd:element name="listofallmembers" type="listofallmembersType" minOccurs="0" />
 /**
+ * Concrete implementation for listofallmembers elements within compound
+ * documentation.
+ *
+ * @remarks
+ * Provides specific handling for listofallmembers XML elements that contain
+ * comprehensive member inventories within class and compound documentation.
+ * This implementation extends the abstract base class functionality to
+ * process the complete collection of member references, including both
+ * directly declared and inherited members.
+ *
+ * The class ensures proper instantiation of member reference data models
+ * whilst maintaining the hierarchical structure and accessibility information
+ * required for comprehensive documentation generation.
+ *
  * @public
  */
 export class ListOfAllMembersDataModel extends AbstractListOfAllMembersType {
+    /**
+     * Constructs a new listofallmembers data model instance.
+     *
+     * @param xml - The XML parser instance for processing elements
+     * @param element - The source XML element containing listofallmembers data
+     *
+     * @remarks
+     * Initialises the data model with the specific element name
+     * 'listofallmembers' and delegates processing to the abstract base class
+     * implementation. This ensures consistent handling of member reference
+     * collections whilst maintaining proper element identification.
+     *
+     * @public
+     */
     constructor(xml, element) {
         // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'listofallmembers');

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

@@ -1 +1 @@
-{"version":3,"file":"listofallmemberstype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/listofallmemberstype-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,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,gDAAgD;AAChD,mBAAmB;AACnB,6FAA6F;AAC7F,oBAAoB;AACpB,qBAAqB;AAErB;;GAEG;AACH,mCAAmC;AACnC,MAAM,OAAgB,4BAA6B,SAAQ,qBAAqB;IAC9E,qBAAqB;IACrB,UAAU,CAAmC;IAE7C,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,kCAAkC;QAClC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnC,eAAe;YACjB,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;gBACvD,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,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,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAEnC,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,oFAAoF;AAEpF;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,4BAA4B;IACzE,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAA;IACzC,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"listofallmemberstype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/listofallmemberstype-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,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,+EAA+E;AAE/E,gDAAgD;AAChD,mBAAmB;AACnB,6FAA6F;AAC7F,oBAAoB;AACpB,qBAAqB;AAErB;;;;;;;;;;;;;;;;;GAiBG;AACH,mCAAmC;AACnC,MAAM,OAAgB,4BAA6B,SAAQ,qBAAqB;IAC9E;;;;;;;;;;OAUG;IACH,UAAU,CAAmC;IAE7C;;;;;;;;;;;;;;;OAeG;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,kCAAkC;QAClC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnC,eAAe;YACjB,CAAC;iBAAM,IAAI,GAAG,CAAC,eAAe,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;gBACvD,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,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,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;QAEnC,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,oFAAoF;AAEpF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,yBAA0B,SAAQ,4BAA4B;IACzE;;;;;;;;;;;;;OAaG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAA;IACzC,CAAC;CACF;AAED,+EAA+E"}