@xpack/doxygen2docusaurus 2.0.0 → 2.1.0

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

@@ -1,104 +1,15 @@
-/*
- * This file is part of the xPack project (http://xpack.github.io).
- * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose is hereby granted, under the terms of the MIT license.
- *
- * If a copy of the license was not distributed with this file, it can
- * be obtained from https://opensource.org/licenses/MIT.
- */
-// ----------------------------------------------------------------------------
 import assert from 'node:assert';
 import util from 'node:util';
 import { AbstractDataModelBase } from '../types.js';
-// ----------------------------------------------------------------------------
-// <xsd:complexType name="incType">
-//   <xsd:simpleContent>
-//     <xsd:extension base="xsd:string">
-//       <xsd:attribute name="refid" type="xsd:string" use="optional" />
-//       <xsd:attribute name="local" type="DoxBool" />
-//     </xsd:extension>
-//   </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.
-     */
+    text = '';
+    local = false;
+    refId;
     constructor(xml, element, elementName) {
         super(elementName);
-        // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))ect(element))ect(element))
-        // ------------------------------------------------------------------------
-        // Process elements.
         assert(xml.isInnerElementText(element, elementName));
         this.text = xml.getInnerElementText(element, elementName);
         assert(this.text.length > 0);
-        // ------------------------------------------------------------------------
-        // Process attributes.
         assert(xml.hasAttributes(element));
         const attributesNames = xml.getAttributesNames(element);
         for (const attributeName of attributesNames) {
@@ -113,79 +24,16 @@ export class AbstractIncType extends AbstractDataModelBase {
                 console.error(`${elementName} attribute:`, attributeName, 'not implemented yet in', this.constructor.name);
             }
         }
-        // ------------------------------------------------------------------------
-        // console.log(util.inspect(this, { compact: false, depth: 999 }))
     }
 }
-// ----------------------------------------------------------------------------
-// <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');
     }
 }
-// ----------------------------------------------------------------------------
 //# sourceMappingURL=inctype-dm.js.map

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;;;;;;;;;;;;;;;;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"}
+{"version":3,"file":"inctype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/inctype-dm.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA8BnD,MAAM,OAAgB,eAAgB,SAAQ,qBAAqB;IAWjE,IAAI,GAAG,EAAE,CAAA;IAYT,KAAK,GAAG,KAAK,CAAA;IAWb,KAAK,CAAqB;IAoB1B,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAOlB,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;QAK5B,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;IAKH,CAAC;CACF;AAqBD,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IAcpD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;IACjC,CAAC;CACF;AAiBD,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IActD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF"}

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

@@ -1,156 +1,21 @@
 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 RequiresClauseDataModel extends AbstractLinkedTextType {
+    constructor(xml: DoxygenXmlParser, element: object);
+}
 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;;;;;;;;;;;;;;;;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"}
+{"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;AA2BnD,8BAAsB,sBAAuB,SAAQ,qBAAqB;gBAmB5D,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAqCxE;AAiCD,qBAAa,oBAAqB,SAAQ,sBAAsB;gBAalD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAiBD,qBAAa,uBAAwB,SAAQ,sBAAsB;gBAarD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAiBD,qBAAa,aAAc,SAAQ,sBAAsB;gBAY3C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAiBD,qBAAa,eAAgB,SAAQ,sBAAsB;gBAY7C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD;AAiBD,qBAAa,uBAAwB,SAAQ,sBAAsB;gBAarD,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

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

@@ -1,64 +1,10 @@
-/*
- * This file is part of the xPack project (http://xpack.github.io).
- * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose is hereby granted, under the terms of the MIT license.
- *
- * If a copy of the license was not distributed with this file, it can
- * be obtained from https://opensource.org/licenses/MIT.
- */
-// ----------------------------------------------------------------------------
 import assert from 'node:assert';
 import * as util from 'node:util';
 import { RefTextDataModel } from './reftexttype-dm.js';
 import { AbstractDataModelBase } from '../types.js';
-// ----------------------------------------------------------------------------
-// <xsd:complexType name="linkedTextType" mixed="true">   <-- Character data is allowed to appear between the child elements!
-//   <xsd:sequence>
-//   <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="unbounded" />
-//   </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) {
         super(elementName);
-        // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
-        // ------------------------------------------------------------------------
-        // Process elements.
         const innerElements = xml.getInnerElements(element, elementName);
         this.children = [];
         for (const innerElement of innerElements) {
@@ -73,153 +19,32 @@ export class AbstractLinkedTextType extends AbstractDataModelBase {
                 console.error(`${elementName} element:`, Object.keys(innerElement), 'not implemented yet in', this.constructor.name);
             }
         }
-        // ------------------------------------------------------------------------
-        // Process attributes.
         assert(!xml.hasAttributes(element));
-        // ------------------------------------------------------------------------
-        // console.log(util.inspect(this, { compact: false, depth: 999 }))
     }
 }
-// ----------------------------------------------------------------------------
-// <xsd:element name="requiresclause" type="linkedTextType" minOccurs="0" />
-// <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
-// <xsd:element name="type" type="linkedTextType" minOccurs="0" />
-// <xsd:element name="requiresclause" type="linkedTextType" minOccurs="0" />
-// <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
-// <xsd:element name="exceptions" type="linkedTextType" minOccurs="0" />
-// <xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
-// <xsd:element name="type" type="linkedTextType" minOccurs="0" />
-// <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 RequiresClauseDataModel extends AbstractLinkedTextType {
+    constructor(xml, element) {
+        super(xml, element, 'requiresclause');
+    }
+}
 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');
     }
 }
-// ----------------------------------------------------------------------------
 //# sourceMappingURL=linkedtexttype-dm.js.map

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;;;;;;;;;;;;;;;;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"}
+{"version":3,"file":"linkedtexttype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/linkedtexttype-dm.ts"],"names":[],"mappings":"AAaA,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;AA2BnD,MAAM,OAAgB,sBAAuB,SAAQ,qBAAqB;IAmBxE,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAOlB,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;QAKD,MAAM,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;IAKrC,CAAC;CACF;AAiCD,MAAM,OAAO,oBAAqB,SAAQ,sBAAsB;IAa9D,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,CAAA;IACpC,CAAC;CACF;AAiBD,MAAM,OAAO,uBAAwB,SAAQ,sBAAsB;IAajE,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAA;IACvC,CAAC;CACF;AAiBD,MAAM,OAAO,aAAc,SAAQ,sBAAsB;IAYvD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IAC7B,CAAC;CACF;AAiBD,MAAM,OAAO,eAAgB,SAAQ,sBAAsB;IAYzD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;IAC/B,CAAC;CACF;AAiBD,MAAM,OAAO,uBAAwB,SAAQ,sBAAsB;IAajE,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAA;IACvC,CAAC;CACF"}