@xpack/doxygen2docusaurus 2.0.0 → 2.2.0

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

@@ -1,127 +1,17 @@
-/*
- * 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="referenceType" mixed="true">
-//   <xsd:attribute name="refid" type="xsd:string" />
-//   <xsd:attribute name="compoundref" type="xsd:string" use="optional" />
-//   <xsd:attribute name="startline" type="xsd:integer" />
-//   <xsd:attribute name="endline" type="xsd:integer" />
-// </xsd:complexType>
-/**
- * Abstract base class for reference type data models.
- *
- * @remarks
- * Represents the foundational structure for reference relationship elements
- * within Doxygen XML documentation, corresponding to the referenceType
- * complex type in the XML schema. This class manages bidirectional reference
- * relationships between documented entities, capturing both the descriptive
- * text and precise location information including line number ranges. The
- * reference system enables comprehensive dependency tracking and cross-
- * referencing capabilities, essential for understanding code relationships
- * and generating accurate documentation navigation structures.
- *
- * @public
- */
 export class AbstractReferenceType extends AbstractDataModelBase {
-    /**
-     * The descriptive text content for this reference relationship.
-     *
-     * @remarks
-     * Contains the textual description of the reference relationship, typically
-     * including the name or signature of the referenced entity. This text
-     * provides human-readable context about the relationship and is used for
-     * display purposes within the generated documentation. Note that this
-     * property is not explicitly defined in the XML schema DTD but appears
-     * in practice within reference elements.
-     */
-    // WARNING: not in DTD?
     text = '';
-    /**
-     * The unique reference identifier for the referenced entity.
-     *
-     * @remarks
-     * Mandatory attribute that provides a unique identifier for the entity
-     * being referenced. This identifier enables precise linking and cross-
-     * referencing between documentation elements, allowing navigation to the
-     * detailed documentation of the referenced item within the documentation
-     * structure.
-     */
     refid = '';
-    /**
-     * The starting line number where the reference occurs.
-     *
-     * @remarks
-     * Specifies the line number in the source code where the reference
-     * relationship begins. This location information enables precise source
-     * code navigation and helps establish the exact context of the reference
-     * within the original source files. Note that this attribute may be missing
-     * in some reference elements despite being defined as mandatory in the
-     * XML schema.
-     */
-    // WARNING: may be missing
     startline;
-    /**
-     * The ending line number where the reference concludes.
-     *
-     * @remarks
-     * Specifies the line number in the source code where the reference
-     * relationship ends. Combined with the starting line, this provides a
-     * complete range for the reference occurrence, enabling precise source
-     * code highlighting and navigation capabilities. Note that this attribute
-     * may be missing in some reference elements despite being defined as
-     * mandatory in the XML schema.
-     */
-    // WARNING: may be missing
     endline;
-    /**
-     * The compound reference identifier for the containing entity.
-     *
-     * @remarks
-     * Optional attribute that provides the identifier of the compound entity
-     * (such as a class or namespace) that contains the referenced item. This
-     * additional context enables more precise navigation and helps establish
-     * the hierarchical relationship between the referencing and referenced
-     * entities within the documentation structure.
-     */
     compoundref;
-    /**
-     * Constructs a new abstract reference type from XML data.
-     *
-     * @param xml - The Doxygen XML parser instance
-     * @param element - The XML element containing reference relationship data
-     * @param elementName - The expected XML element name
-     *
-     * @remarks
-     * Parses the provided XML element to construct a complete reference
-     * relationship data model. The parsing process extracts the textual content
-     * from the element and processes all defined attributes including the
-     * mandatory refid attribute, line number information, and optional compound
-     * reference data. Validation ensures that the reference identifier is
-     * present, maintaining the integrity of the reference relationship
-     * documentation.
-     */
     constructor(xml, element, elementName) {
         super(elementName);
-        // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
-        // ------------------------------------------------------------------------
-        // 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) {
@@ -129,10 +19,10 @@ export class AbstractReferenceType extends AbstractDataModelBase {
                 this.refid = xml.getAttributeStringValue(element, '@_refid');
             }
             else if (attributeName === '@_startline') {
-                this.startline = Number(xml.getAttributeNumberValue(element, '@_startline'));
+                this.startline = xml.getAttributeNumberValue(element, '@_startline');
             }
             else if (attributeName === '@_endline') {
-                this.endline = Number(xml.getAttributeNumberValue(element, '@_endline'));
+                this.endline = xml.getAttributeNumberValue(element, '@_endline');
             }
             else if (attributeName === '@_compoundref') {
                 this.compoundref = xml.getAttributeStringValue(element, '@_compoundref');
@@ -143,79 +33,16 @@ export class AbstractReferenceType extends AbstractDataModelBase {
             }
         }
         assert(this.refid.length > 0);
-        // ------------------------------------------------------------------------
-        // console.log(util.inspect(this, { compact: false, depth: 999 }))
     }
 }
-// ----------------------------------------------------------------------------
-// <xsd:element name="references" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
-// <xsd:element name="referencedby" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
-/**
- * Data model for reference relationship elements.
- *
- * @remarks
- * Represents a forward reference relationship within Doxygen XML
- * documentation, corresponding to the references XML element. This class
- * manages relationships where the current entity references or depends upon
- * another documented entity. The relationship captures both the descriptive
- * information and precise location data, enabling comprehensive dependency
- * tracking and navigation capabilities. Forward references help document
- * how entities use or depend on other components within the codebase.
- *
- * @public
- */
 export class ReferenceDataModel extends AbstractReferenceType {
-    /**
-     * Constructs a new reference relationship data model from XML.
-     *
-     * @param xml - The Doxygen XML parser instance
-     * @param element - The XML element containing reference relationship data
-     *
-     * @remarks
-     * Creates a complete forward reference relationship data model by parsing
-     * the provided XML element. This constructor delegates to the parent class
-     * to handle all standard parsing operations for the references element type,
-     * establishing the forward dependency relationship between the current
-     * entity and the referenced component.
-     */
     constructor(xml, element) {
-        // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'references');
     }
 }
-/**
- * Data model for referenced-by relationship elements.
- *
- * @remarks
- * Represents a reverse reference relationship within Doxygen XML
- * documentation, corresponding to the referencedby XML element. This class
- * manages relationships where the current entity is referenced or used by
- * another documented entity. The relationship provides bidirectional
- * dependency information, enabling comprehensive understanding of how
- * entities are utilised throughout the codebase. Referenced-by relationships
- * are essential for impact analysis and understanding the scope of changes
- * when modifying documented components.
- *
- * @public
- */
 export class ReferencedByDataModel extends AbstractReferenceType {
-    /**
-     * Constructs a new referenced-by relationship data model from XML.
-     *
-     * @param xml - The Doxygen XML parser instance
-     * @param element - The XML element containing referenced-by relationship data
-     *
-     * @remarks
-     * Creates a complete reverse reference relationship data model by parsing
-     * the provided XML element. This constructor delegates to the parent class
-     * to handle all standard parsing operations for the referencedby element
-     * type, establishing the reverse dependency relationship indicating how
-     * other entities utilise the current component.
-     */
     constructor(xml, element) {
-        // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'referencedby');
     }
 }
-// ----------------------------------------------------------------------------
 //# sourceMappingURL=referencetype-dm.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"referencetype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/referencetype-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,sDAAsD;AACtD,qDAAqD;AACrD,0EAA0E;AAC1E,0DAA0D;AAC1D,wDAAwD;AACxD,qBAAqB;AAErB;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAgB,qBAAsB,SAAQ,qBAAqB;IACvE;;;;;;;;;;OAUG;IACH,uBAAuB;IACvB,IAAI,GAAG,EAAE,CAAA;IAET;;;;;;;;;OASG;IACH,KAAK,GAAG,EAAE,CAAA;IAEV;;;;;;;;;;OAUG;IACH,0BAA0B;IAC1B,SAAS,CAAoB;IAE7B;;;;;;;;;;OAUG;IACH,0BAA0B;IAC1B,OAAO,CAAoB;IAE3B;;;;;;;;;OASG;IACH,WAAW,CAAqB;IAEhC;;;;;;;;;;;;;;;OAeG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,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,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,aAAa,KAAK,aAAa,EAAE,CAAC;gBAC3C,IAAI,CAAC,SAAS,GAAG,MAAM,CACrB,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,aAAa,CAAC,CACpD,CAAA;YACH,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAA;YAC1E,CAAC;iBAAM,IAAI,aAAa,KAAK,eAAe,EAAE,CAAC;gBAC7C,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAA;YAC1E,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,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE7B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AAED,+EAA+E;AAE/E,6FAA6F;AAC7F,+FAA+F;AAE/F;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IAC3D;;;;;;;;;;;;OAYG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,qBAAsB,SAAQ,qBAAqB;IAC9D;;;;;;;;;;;;OAYG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;IACrC,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"referencetype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/referencetype-dm.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAG5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA0BnD,MAAM,OAAgB,qBAAsB,SAAQ,qBAAqB;IAavE,IAAI,GAAG,EAAE,CAAA;IAYT,KAAK,GAAG,EAAE,CAAA;IAcV,SAAS,CAAoB;IAc7B,OAAO,CAAoB;IAY3B,WAAW,CAAqB;IAkBhC,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,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,aAAa,KAAK,aAAa,EAAE,CAAC;gBAC3C,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;YACtE,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,CAAC;iBAAM,IAAI,aAAa,KAAK,eAAe,EAAE,CAAC;gBAC7C,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAA;YAC1E,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,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAK/B,CAAC;CACF;AAqBD,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IAc3D,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACnC,CAAC;CACF;AAiBD,MAAM,OAAO,qBAAsB,SAAQ,qBAAqB;IAc9D,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;IACrC,CAAC;CACF"}

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

@@ -1,135 +1,15 @@
 import { DoxygenXmlParser } from '../doxygen-xml-parser.js';
 import { AbstractDataModelBase } from '../types.js';
-/**
- * Abstract base class for reference text type data models.
- *
- * @remarks
- * Represents the foundational structure for reference text elements within
- * Doxygen XML documentation, corresponding to the refTextType complex type
- * in the XML schema. This class manages textual references to documented
- * entities with enhanced metadata including reference classification, external
- * linking capabilities, and tooltip information. Reference text elements
- * provide rich linking functionality within documentation content, enabling
- * precise navigation to related entities whilst maintaining readability and
- * contextual information for enhanced user experience.
- *
- * @public
- */
 export declare abstract class AbstractRefTextType extends AbstractDataModelBase {
-    /**
-     * The textual content of the reference.
-     *
-     * @remarks
-     * Mandatory element containing the display text for the reference, passed
-     * as the element's text content. This text provides the human-readable
-     * representation of the referenced entity and is typically the name or
-     * identifier that appears in the documentation content where the reference
-     * is embedded.
-     */
     text: string;
-    /**
-     * The unique reference identifier for the referenced entity.
-     *
-     * @remarks
-     * Mandatory attribute that provides a unique identifier for the referenced
-     * entity within the Doxygen documentation system. This identifier enables
-     * precise linking and cross-referencing between documentation elements,
-     * allowing navigation to the detailed documentation of the referenced item.
-     */
     refid: string;
-    /**
-     * The kind classification of the referenced entity.
-     *
-     * @remarks
-     * Mandatory attribute specifying the type of entity being referenced,
-     * according to the DoxRefKind enumeration. This classification determines
-     * how the reference is processed and presented, distinguishing between
-     * compound entities (such as classes or namespaces) and member entities
-     * (such as functions or variables).
-     */
     kindref: string;
-    /**
-     * The external reference location for cross-project linking.
-     *
-     * @remarks
-     * Optional attribute that specifies an external location for the referenced
-     * entity, enabling cross-project or cross-documentation linking. When
-     * present, this attribute indicates that the referenced entity is defined
-     * in external documentation, requiring special handling for link generation
-     * and navigation.
-     */
     external?: string | undefined;
-    /**
-     * The tooltip text for enhanced reference information.
-     *
-     * @remarks
-     * Optional attribute that provides additional contextual information to be
-     * displayed as a tooltip when interacting with the reference. This tooltip
-     * enhances the user experience by providing immediate context about the
-     * referenced entity without requiring navigation to the target documentation.
-     */
     tooltip?: string | undefined;
-    /**
-     * Constructs a new abstract reference text type from XML data.
-     *
-     * @param xml - The Doxygen XML parser instance
-     * @param element - The XML element containing reference text data
-     * @param elementName - The expected XML element name
-     *
-     * @remarks
-     * Parses the provided XML element to construct a complete reference text
-     * data model. The parsing process extracts the textual content from the
-     * element and processes all defined attributes including the mandatory
-     * refid and kindref attributes, as well as optional external and tooltip
-     * attributes. Validation ensures that required elements and attributes are
-     * present and conform to the expected XML schema structure.
-     */
     constructor(xml: DoxygenXmlParser, element: object, elementName: string);
 }
-/**
- * Type definition for Doxygen reference kind classifications.
- *
- * @remarks
- * Represents the enumeration of valid reference kinds within Doxygen XML
- * documentation, corresponding to the DoxRefKind simple type in the XML
- * schema. This type distinguishes between compound entities (such as classes,
- * structs, interfaces, and namespaces) and member entities (such as functions,
- * variables, enumerations, and typedefs). The classification affects how
- * references are processed, linked, and presented in the generated
- * documentation structure.
- *
- * @public
- */
 export type DoxRefKind = 'compound' | 'member';
-/**
- * Data model for reference text elements.
- *
- * @remarks
- * Represents a specific textual reference within Doxygen XML documentation,
- * corresponding to the ref XML element. This class manages rich textual
- * references that appear within documentation content, providing enhanced
- * linking capabilities with metadata support. Reference text elements enable
- * seamless navigation between related documentation entities whilst
- * maintaining the flow and readability of the containing text. The class
- * supports both internal and external references, with optional tooltip
- * information for improved user experience.
- *
- * @public
- */
 export declare class RefTextDataModel extends AbstractRefTextType {
-    /**
-     * Constructs a new reference text data model from XML.
-     *
-     * @param xml - The Doxygen XML parser instance
-     * @param element - The XML element containing reference text data
-     *
-     * @remarks
-     * Creates a complete reference text data model by parsing the provided XML
-     * element. This constructor delegates to the parent class to handle all
-     * standard parsing operations for the ref element type, establishing the
-     * textual reference with full metadata support for enhanced linking and
-     * navigation capabilities.
-     */
     constructor(xml: DoxygenXmlParser, element: object);
 }
 //# sourceMappingURL=reftexttype-dm.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"reftexttype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftexttype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAenD;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,mBAAoB,SAAQ,qBAAqB;IACrE;;;;;;;;;OASG;IACH,IAAI,SAAK;IAET;;;;;;;;OAQG;IACH,KAAK,SAAK;IAEV;;;;;;;;;OASG;IACH,OAAO,SAAK;IAEZ;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE7B;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE5B;;;;;;;;;;;;;;OAcG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA8CxE;AAWD;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAA;AAM9C;;;;;;;;;;;;;;GAcG;AACH,qBAAa,gBAAiB,SAAQ,mBAAmB;IACvD;;;;;;;;;;;;OAYG;gBACS,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}
+{"version":3,"file":"reftexttype-dm.d.ts","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftexttype-dm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AA8BnD,8BAAsB,mBAAoB,SAAQ,qBAAqB;IAWrE,IAAI,SAAK;IAWT,KAAK,SAAK;IAYV,OAAO,SAAK;IAYZ,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAW7B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;gBAiBhB,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CA8CxE;AAyBD,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAA;AAqB9C,qBAAa,gBAAiB,SAAQ,mBAAmB;gBAc3C,GAAG,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAInD"}

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

@@ -1,122 +1,17 @@
-/*
- * 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="refTextType">
-//   <xsd:simpleContent>
-//     <xsd:extension base="xsd:string">
-//      <xsd:attribute name="refid" type="xsd:string" />
-//      <xsd:attribute name="kindref" type="DoxRefKind" />
-//      <xsd:attribute name="external" type="xsd:string" use="optional"/>
-//      <xsd:attribute name="tooltip" type="xsd:string" use="optional"/>
-//     </xsd:extension>
-//   </xsd:simpleContent>
-// </xsd:complexType>
-/**
- * Abstract base class for reference text type data models.
- *
- * @remarks
- * Represents the foundational structure for reference text elements within
- * Doxygen XML documentation, corresponding to the refTextType complex type
- * in the XML schema. This class manages textual references to documented
- * entities with enhanced metadata including reference classification, external
- * linking capabilities, and tooltip information. Reference text elements
- * provide rich linking functionality within documentation content, enabling
- * precise navigation to related entities whilst maintaining readability and
- * contextual information for enhanced user experience.
- *
- * @public
- */
 export class AbstractRefTextType extends AbstractDataModelBase {
-    /**
-     * The textual content of the reference.
-     *
-     * @remarks
-     * Mandatory element containing the display text for the reference, passed
-     * as the element's text content. This text provides the human-readable
-     * representation of the referenced entity and is typically the name or
-     * identifier that appears in the documentation content where the reference
-     * is embedded.
-     */
-    text = ''; // The name of the reference, passed as element text.
-    /**
-     * The unique reference identifier for the referenced entity.
-     *
-     * @remarks
-     * Mandatory attribute that provides a unique identifier for the referenced
-     * entity within the Doxygen documentation system. This identifier enables
-     * precise linking and cross-referencing between documentation elements,
-     * allowing navigation to the detailed documentation of the referenced item.
-     */
+    text = '';
     refid = '';
-    /**
-     * The kind classification of the referenced entity.
-     *
-     * @remarks
-     * Mandatory attribute specifying the type of entity being referenced,
-     * according to the DoxRefKind enumeration. This classification determines
-     * how the reference is processed and presented, distinguishing between
-     * compound entities (such as classes or namespaces) and member entities
-     * (such as functions or variables).
-     */
-    kindref = ''; // DoxRefKind
-    /**
-     * The external reference location for cross-project linking.
-     *
-     * @remarks
-     * Optional attribute that specifies an external location for the referenced
-     * entity, enabling cross-project or cross-documentation linking. When
-     * present, this attribute indicates that the referenced entity is defined
-     * in external documentation, requiring special handling for link generation
-     * and navigation.
-     */
+    kindref = '';
     external;
-    /**
-     * The tooltip text for enhanced reference information.
-     *
-     * @remarks
-     * Optional attribute that provides additional contextual information to be
-     * displayed as a tooltip when interacting with the reference. This tooltip
-     * enhances the user experience by providing immediate context about the
-     * referenced entity without requiring navigation to the target documentation.
-     */
     tooltip;
-    /**
-     * Constructs a new abstract reference text type from XML data.
-     *
-     * @param xml - The Doxygen XML parser instance
-     * @param element - The XML element containing reference text data
-     * @param elementName - The expected XML element name
-     *
-     * @remarks
-     * Parses the provided XML element to construct a complete reference text
-     * data model. The parsing process extracts the textual content from the
-     * element and processes all defined attributes including the mandatory
-     * refid and kindref attributes, as well as optional external and tooltip
-     * attributes. Validation ensures that required elements and attributes are
-     * present and conform to the expected XML schema structure.
-     */
     constructor(xml, element, elementName) {
         super(elementName);
-        // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
-        // ------------------------------------------------------------------------
-        // 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) {
@@ -139,45 +34,11 @@ export class AbstractRefTextType extends AbstractDataModelBase {
         }
         assert(this.refid.length > 0);
         assert(this.kindref.length > 0);
-        // ------------------------------------------------------------------------
-        // console.log(util.inspect(this, { compact: false, depth: 999 }))
     }
 }
-// ----------------------------------------------------------------------------
-// <xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="unbounded" />
-/**
- * Data model for reference text elements.
- *
- * @remarks
- * Represents a specific textual reference within Doxygen XML documentation,
- * corresponding to the ref XML element. This class manages rich textual
- * references that appear within documentation content, providing enhanced
- * linking capabilities with metadata support. Reference text elements enable
- * seamless navigation between related documentation entities whilst
- * maintaining the flow and readability of the containing text. The class
- * supports both internal and external references, with optional tooltip
- * information for improved user experience.
- *
- * @public
- */
 export class RefTextDataModel extends AbstractRefTextType {
-    /**
-     * Constructs a new reference text data model from XML.
-     *
-     * @param xml - The Doxygen XML parser instance
-     * @param element - The XML element containing reference text data
-     *
-     * @remarks
-     * Creates a complete reference text data model by parsing the provided XML
-     * element. This constructor delegates to the parent class to handle all
-     * standard parsing operations for the ref element type, establishing the
-     * textual reference with full metadata support for enhanced linking and
-     * navigation capabilities.
-     */
     constructor(xml, element) {
-        // console.log(elementName, util.inspect(element, { compact: false, depth: 999 }))
         super(xml, element, 'ref');
     }
 }
-// ----------------------------------------------------------------------------
 //# sourceMappingURL=reftexttype-dm.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"reftexttype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftexttype-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,uCAAuC;AACvC,wBAAwB;AACxB,wCAAwC;AACxC,wDAAwD;AACxD,0DAA0D;AAC1D,yEAAyE;AACzE,wEAAwE;AACxE,uBAAuB;AACvB,yBAAyB;AACzB,qBAAqB;AAErB;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAgB,mBAAoB,SAAQ,qBAAqB;IACrE;;;;;;;;;OASG;IACH,IAAI,GAAG,EAAE,CAAA,CAAC,qDAAqD;IAE/D;;;;;;;;OAQG;IACH,KAAK,GAAG,EAAE,CAAA;IAEV;;;;;;;;;OASG;IACH,OAAO,GAAG,EAAE,CAAA,CAAC,aAAa;IAE1B;;;;;;;;;OASG;IACH,QAAQ,CAAqB;IAE7B;;;;;;;;OAQG;IACH,OAAO,CAAqB;IAE5B;;;;;;;;;;;;;;OAcG;IACH,YAAY,GAAqB,EAAE,OAAe,EAAE,WAAmB;QACrE,KAAK,CAAC,WAAW,CAAC,CAAA;QAElB,kFAAkF;QAElF,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,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,CAAC;iBAAM,IAAI,aAAa,KAAK,YAAY,EAAE,CAAC;gBAC1C,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;YACpE,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,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,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC7B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE/B,2EAA2E;QAE3E,kEAAkE;IACpE,CAAC;CACF;AA2BD,+EAA+E;AAE/E,oFAAoF;AAEpF;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,gBAAiB,SAAQ,mBAAmB;IACvD;;;;;;;;;;;;OAYG;IACH,YAAY,GAAqB,EAAE,OAAe;QAChD,kFAAkF;QAClF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IAC5B,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"reftexttype-dm.js","sourceRoot":"","sources":["../../../../src/doxygen/data-model/compounds/reftexttype-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,mBAAoB,SAAQ,qBAAqB;IAWrE,IAAI,GAAG,EAAE,CAAA;IAWT,KAAK,GAAG,EAAE,CAAA;IAYV,OAAO,GAAG,EAAE,CAAA;IAYZ,QAAQ,CAAqB;IAW7B,OAAO,CAAqB;IAiB5B,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,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC9D,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,CAAC;iBAAM,IAAI,aAAa,KAAK,YAAY,EAAE,CAAC;gBAC1C,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;YACpE,CAAC;iBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;gBACzC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAClE,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,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC7B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAKjC,CAAC;CACF;AA8CD,MAAM,OAAO,gBAAiB,SAAQ,mBAAmB;IAcvD,YAAY,GAAqB,EAAE,OAAe;QAEhD,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IAC5B,CAAC;CACF"}