@xpack/doxygen2docusaurus 1.0.2 → 2.0.0

package/dist/docusaurus/renderers/linkedtexttype.d.ts

@@ -1,6 +1,28 @@
 import { ElementStringRendererBase } from './element-renderer-base.js';
 import type { AbstractLinkedTextType } from '../../doxygen/data-model/compounds/linkedtexttype-dm.js';
+/**
+ * Renderer for Doxygen linked text elements containing mixed content.
+ *
+ * @remarks
+ * Handles complex text structures that contain both character data and
+ * reference elements. Renders child elements recursively to build the
+ * complete text output with embedded links.
+ *
+ * @public
+ */
 export declare class LinkedTextTypeStringRenderer extends ElementStringRendererBase {
+    /**
+     * Renders a linked text element to a formatted string.
+     *
+     * @remarks
+     * Processes all child elements in sequence to generate the complete
+     * text output with embedded references and mixed content. Maintains
+     * the original order of text and reference elements.
+     *
+     * @param element - The linked text element to render
+     * @param type - The rendering context type
+     * @returns The formatted string with mixed content
+     */
     renderToString(element: AbstractLinkedTextType, type: string): string;
 }
 //# sourceMappingURL=linkedtexttype.d.ts.map

package/dist/docusaurus/renderers/linkedtexttype.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"linkedtexttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/linkedtexttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yDAAyD,CAAA;AAYrG,qBAAa,4BAA6B,SAAQ,yBAAyB;IACzE,cAAc,CAAC,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAStE"}
+{"version":3,"file":"linkedtexttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/linkedtexttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yDAAyD,CAAA;AAYrG;;;;;;;;;GASG;AACH,qBAAa,4BAA6B,SAAQ,yBAAyB;IACzE;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAStE"}

package/dist/docusaurus/renderers/linkedtexttype.js

@@ -20,7 +20,29 @@ import { ElementStringRendererBase } from './element-renderer-base.js';
 //                                              maxOccurs="unbounded" />
 //   </xsd:sequence>
 // </xsd:complexType>
+/**
+ * Renderer for Doxygen linked text elements containing mixed content.
+ *
+ * @remarks
+ * Handles complex text structures that contain both character data and
+ * reference elements. Renders child elements recursively to build the
+ * complete text output with embedded links.
+ *
+ * @public
+ */
 export class LinkedTextTypeStringRenderer extends ElementStringRendererBase {
+    /**
+     * Renders a linked text element to a formatted string.
+     *
+     * @remarks
+     * Processes all child elements in sequence to generate the complete
+     * text output with embedded references and mixed content. Maintains
+     * the original order of text and reference elements.
+     *
+     * @param element - The linked text element to render
+     * @param type - The rendering context type
+     * @returns The formatted string with mixed content
+     */
     renderToString(element, type) {
         // console.log(util.inspect(element, { compact: false, depth: 999 }))
         let text = '';

package/dist/docusaurus/renderers/linkedtexttype.js.map

@@ -1 +1 @@
-{"version":3,"file":"linkedtexttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/linkedtexttype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AAGtE,+EAA+E;AAE/E,4EAA4E;AAC5E,oEAAoE;AACpE,mBAAmB;AACnB,6DAA6D;AAC7D,wEAAwE;AACxE,oBAAoB;AACpB,qBAAqB;AAErB,MAAM,OAAO,4BAA6B,SAAQ,yBAAyB;IACzE,cAAc,CAAC,OAA+B,EAAE,IAAY;QAC1D,qEAAqE;QAErE,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAE1E,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"linkedtexttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/linkedtexttype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AAGtE,+EAA+E;AAE/E,4EAA4E;AAC5E,oEAAoE;AACpE,mBAAmB;AACnB,6DAA6D;AAC7D,wEAAwE;AACxE,oBAAoB;AACpB,qBAAqB;AAErB;;;;;;;;;GASG;AACH,MAAM,OAAO,4BAA6B,SAAQ,yBAAyB;IACzE;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,OAA+B,EAAE,IAAY;QAC1D,qEAAqE;QAErE,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAE1E,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,+EAA+E"}

package/dist/docusaurus/renderers/listingtype.d.ts

@@ -1,10 +1,62 @@
 import { type AbstractHighlightType, type AbstractListingTypeBase } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
 import { ElementLinesRendererBase } from './element-renderer-base.js';
+/**
+ * Renderer for program listing elements in documentation.
+ *
+ * @remarks
+ * Handles the rendering of source code listings as parsed from Doxygen XML,
+ * converting them into formatted HTML output with syntax highlighting and
+ * line numbering. Supports both full program listings and member-specific
+ * code segments.
+ *
+ * @public
+ */
 export declare class ListingTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a program listing element to formatted output lines.
+     *
+     * @remarks
+     * Converts Doxygen program listing elements into HTML with appropriate
+     * CSS classes, line numbers, and syntax highlighting. Handles anchor
+     * generation for navigation and cross-referencing.
+     *
+     * @param element - The listing element to render
+     * @param type - The rendering context type
+     * @returns Array of formatted output lines
+     */
     renderToLines(element: AbstractListingTypeBase, type: string): string[];
 }
+/**
+ * Renderer for syntax highlighting elements in code listings.
+ *
+ * @remarks
+ * Handles the rendering of syntax-highlighted code segments by converting
+ * Doxygen highlight elements into HTML spans with appropriate CSS classes.
+ * Optimised for direct HTML generation to improve build performance.
+ *
+ * @public
+ */
 export declare class HighlightTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Mapping of Doxygen highlight classes to CSS class names.
+     *
+     * @remarks
+     * Maps Doxygen's built-in highlight types to corresponding CSS classes
+     * for consistent syntax highlighting across different code elements.
+     */
     knownClasses: Record<string, string>;
+    /**
+     * Renders a syntax highlight element to formatted output lines.
+     *
+     * @remarks
+     * Converts Doxygen highlight elements into HTML span elements with
+     * appropriate CSS classes for syntax highlighting. Handles unknown
+     * highlight types by falling back to a default class.
+     *
+     * @param element - The highlight element to render
+     * @param type - The rendering context type
+     * @returns Array containing the formatted HTML span
+     */
     renderToLines(element: AbstractHighlightType, type: string): string[];
 }
 //# sourceMappingURL=listingtype.d.ts.map

package/dist/docusaurus/renderers/listingtype.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listingtype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/listingtype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAGL,KAAK,qBAAqB,EAE1B,KAAK,uBAAuB,EAE7B,MAAM,0DAA0D,CAAA;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAKrE,qBAAa,wBAAyB,SAAQ,wBAAwB;IAC3D,aAAa,CACpB,OAAO,EAAE,uBAAuB,EAEhC,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAgCZ;AAwDD,qBAAa,0BAA2B,SAAQ,wBAAwB;IACtE,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAanC;IAEQ,aAAa,CACpB,OAAO,EAAE,qBAAqB,EAC9B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CA2BZ"}
+{"version":3,"file":"listingtype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/listingtype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAGL,KAAK,qBAAqB,EAE1B,KAAK,uBAAuB,EAE7B,MAAM,0DAA0D,CAAA;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAKrE;;;;;;;;;;GAUG;AACH,qBAAa,wBAAyB,SAAQ,wBAAwB;IACpE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAO,EAAE,uBAAuB,EAEhC,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAgCZ;AAoED;;;;;;;;;GASG;AACH,qBAAa,0BAA2B,SAAQ,wBAAwB;IACtE;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAanC;IAED;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAO,EAAE,qBAAqB,EAC9B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CA2BZ"}

package/dist/docusaurus/renderers/listingtype.js

@@ -14,7 +14,30 @@ import util from 'node:util';
 import { CodeLineDataModel, HighlightDataModel, MemberProgramListingDataModel, } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
 import { ElementLinesRendererBase } from './element-renderer-base.js';
 // ----------------------------------------------------------------------------
+/**
+ * Renderer for program listing elements in documentation.
+ *
+ * @remarks
+ * Handles the rendering of source code listings as parsed from Doxygen XML,
+ * converting them into formatted HTML output with syntax highlighting and
+ * line numbering. Supports both full program listings and member-specific
+ * code segments.
+ *
+ * @public
+ */
 export class ListingTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a program listing element to formatted output lines.
+     *
+     * @remarks
+     * Converts Doxygen program listing elements into HTML with appropriate
+     * CSS classes, line numbers, and syntax highlighting. Handles anchor
+     * generation for navigation and cross-referencing.
+     *
+     * @param element - The listing element to render
+     * @param type - The rendering context type
+     * @returns Array of formatted output lines
+     */
     renderToLines(element, 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     type) {
@@ -41,6 +64,20 @@ export class ListingTypeLinesRenderer extends ElementLinesRendererBase {
         return lines;
     }
 }
+/**
+ * Renders individual code lines with syntax highlighting and line numbers.
+ *
+ * @remarks
+ * Converts a single code line element into HTML format with appropriate
+ * line numbering, anchors for navigation, and syntax highlighting support.
+ * Handles permalink generation for cross-references when available.
+ *
+ * @param workspace - The workspace instance for rendering utilities
+ * @param element - The code line element to render
+ * @param type - The rendering context type
+ * @param showAnchor - Whether to include anchor elements for navigation
+ * @returns Formatted HTML string for the code line
+ */
 function renderCodeLinesToString(workspace, element, type, showAnchor) {
     // console.log(util.inspect(element, { compact: false, depth: 999 }))
     assert(element instanceof CodeLineDataModel);
@@ -80,9 +117,24 @@ function renderCodeLinesToString(workspace, element, type, showAnchor) {
     text += '</div>';
     return text;
 }
-// Optimise this to directly generate plain html, to save the compiler/bundler
-// a lot of efforts, since the file references are very large.
+/**
+ * Renderer for syntax highlighting elements in code listings.
+ *
+ * @remarks
+ * Handles the rendering of syntax-highlighted code segments by converting
+ * Doxygen highlight elements into HTML spans with appropriate CSS classes.
+ * Optimised for direct HTML generation to improve build performance.
+ *
+ * @public
+ */
 export class HighlightTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Mapping of Doxygen highlight classes to CSS class names.
+     *
+     * @remarks
+     * Maps Doxygen's built-in highlight types to corresponding CSS classes
+     * for consistent syntax highlighting across different code elements.
+     */
     knownClasses = {
         normal: 'doxyHighlight',
         charliteral: 'doxyHighlightCharLiteral',
@@ -97,6 +149,18 @@ export class HighlightTypeLinesRenderer extends ElementLinesRendererBase {
         vhdlkeyword: 'doxyHighlightVhdlKeyword',
         vhdllogic: 'doxyHighlightVhdlLogic',
     };
+    /**
+     * Renders a syntax highlight element to formatted output lines.
+     *
+     * @remarks
+     * Converts Doxygen highlight elements into HTML span elements with
+     * appropriate CSS classes for syntax highlighting. Handles unknown
+     * highlight types by falling back to a default class.
+     *
+     * @param element - The highlight element to render
+     * @param type - The rendering context type
+     * @returns Array containing the formatted HTML span
+     */
     renderToLines(element, type) {
         // console.log(util.inspect(element, { compact: false, depth: 999 }))
         assert(element instanceof HighlightDataModel);

package/dist/docusaurus/renderers/listingtype.js.map

@@ -1 +1 @@
-{"version":3,"file":"listingtype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/listingtype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAE5B,OAAO,EAEL,iBAAiB,EAEjB,kBAAkB,EAElB,6BAA6B,GAC9B,MAAM,0DAA0D,CAAA;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAGrE,+EAA+E;AAE/E,MAAM,OAAO,wBAAyB,SAAQ,wBAAwB;IAC3D,aAAa,CACpB,OAAgC;IAChC,6DAA6D;IAC7D,IAAY;QAEZ,qEAAqE;QAErE,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACpC,OAAO,EAAE,CAAA;QACX,CAAC;QAED,IAAI,UAAU,GAAG,IAAI,CAAA;QACrB,IAAI,OAAO,YAAY,6BAA6B,EAAE,CAAC;YACrD,UAAU,GAAG,KAAK,CAAA;QACpB,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAA;QAE9C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACzC,gEAAgE;YAChE,sCAAsC;YACtC,KAAK,CAAC,IAAI,CACR,uBAAuB,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CACtE,CAAA;QACH,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACpB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAEd,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,SAAS,uBAAuB,CAC9B,SAAoB,EACpB,OAA6B,EAC7B,IAAY,EACZ,UAAmB;IAEnB,qEAAqE;IACrE,MAAM,CAAC,OAAO,YAAY,iBAAiB,CAAC,CAAA;IAE5C,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IAChE,CAAC;IAED,IAAI,SAAS,GAAuB,SAAS,CAAA;IAC7C,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjE,SAAS,GAAG,SAAS,CAAC,YAAY,CAAC;YACjC,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,IAAI,GAAG,EAAE,CAAA;IAEb,IAAI,IAAI,4BAA4B,CAAA;IACpC,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACjC,IAAI,IAAI,+BAA+B,CAAA;QACvC,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAA;QAC/D,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,IAAI,UAAU,MAAM,QAAQ,CAAA;QAClC,CAAC;QACD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,IAAI,YAAY,SAAS,KAAK,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAA;QACnE,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAA;QACnC,CAAC;QACD,IAAI,IAAI,SAAS,CAAA;IACnB,CAAC;SAAM,CAAC;QACN,IAAI,IAAI,8CAA8C,CAAA;IACxD,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,2BAA2B,CACnD,OAAO,CAAC,UAAU,EAClB,IAAI,CACL,CAAA;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,IAAI,IAAI,iCAAiC,OAAO,SAAS,CAAA;IAC3D,CAAC;IACD,IAAI,IAAI,QAAQ,CAAA;IAEhB,OAAO,IAAI,CAAA;AACb,CAAC;AAED,8EAA8E;AAC9E,8DAA8D;AAC9D,MAAM,OAAO,0BAA2B,SAAQ,wBAAwB;IACtE,YAAY,GAA2B;QACrC,MAAM,EAAE,eAAe;QACvB,WAAW,EAAE,0BAA0B;QACvC,OAAO,EAAE,sBAAsB;QAC/B,YAAY,EAAE,2BAA2B;QACzC,OAAO,EAAE,sBAAsB;QAC/B,WAAW,EAAE,0BAA0B;QACvC,WAAW,EAAE,0BAA0B;QACvC,KAAK,EAAE,oBAAoB;QAC3B,aAAa,EAAE,4BAA4B;QAC3C,QAAQ,EAAE,uBAAuB;QACjC,WAAW,EAAE,0BAA0B;QACvC,SAAS,EAAE,wBAAwB;KACpC,CAAA;IAEQ,aAAa,CACpB,OAA8B,EAC9B,IAAY;QAEZ,qEAAqE;QACrE,MAAM,CAAC,OAAO,YAAY,kBAAkB,CAAC,CAAA;QAE7C,IAAI,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QACjD,uEAAuE;QACvE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,MAAM,EACd,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACD,SAAS,GAAG,eAAe,CAAA;QAC7B,CAAC;QAED,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,MAAM,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAA;QACtC,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,IAAI,IAAI,gBAAgB,SAAS,IAAI,CAAA;YACrC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;YAC1E,IAAI,IAAI,SAAS,CAAA;QACnB,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"listingtype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/listingtype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,IAAI,MAAM,WAAW,CAAA;AAE5B,OAAO,EAEL,iBAAiB,EAEjB,kBAAkB,EAElB,6BAA6B,GAC9B,MAAM,0DAA0D,CAAA;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAGrE,+EAA+E;AAE/E;;;;;;;;;;GAUG;AACH,MAAM,OAAO,wBAAyB,SAAQ,wBAAwB;IACpE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAgC;IAChC,6DAA6D;IAC7D,IAAY;QAEZ,qEAAqE;QAErE,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACpC,OAAO,EAAE,CAAA;QACX,CAAC;QAED,IAAI,UAAU,GAAG,IAAI,CAAA;QACrB,IAAI,OAAO,YAAY,6BAA6B,EAAE,CAAC;YACrD,UAAU,GAAG,KAAK,CAAA;QACpB,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAA;QAE9C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACzC,gEAAgE;YAChE,sCAAsC;YACtC,KAAK,CAAC,IAAI,CACR,uBAAuB,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CACtE,CAAA;QACH,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACpB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAEd,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,SAAS,uBAAuB,CAC9B,SAAoB,EACpB,OAA6B,EAC7B,IAAY,EACZ,UAAmB;IAEnB,qEAAqE;IACrE,MAAM,CAAC,OAAO,YAAY,iBAAiB,CAAC,CAAA;IAE5C,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IAChE,CAAC;IAED,IAAI,SAAS,GAAuB,SAAS,CAAA;IAC7C,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjE,SAAS,GAAG,SAAS,CAAC,YAAY,CAAC;YACjC,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,IAAI,GAAG,EAAE,CAAA;IAEb,IAAI,IAAI,4BAA4B,CAAA;IACpC,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACjC,IAAI,IAAI,+BAA+B,CAAA;QACvC,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAA;QAC/D,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,IAAI,UAAU,MAAM,QAAQ,CAAA;QAClC,CAAC;QACD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,IAAI,YAAY,SAAS,KAAK,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAA;QACnE,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAA;QACnC,CAAC;QACD,IAAI,IAAI,SAAS,CAAA;IACnB,CAAC;SAAM,CAAC;QACN,IAAI,IAAI,8CAA8C,CAAA;IACxD,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,2BAA2B,CACnD,OAAO,CAAC,UAAU,EAClB,IAAI,CACL,CAAA;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,IAAI,IAAI,iCAAiC,OAAO,SAAS,CAAA;IAC3D,CAAC;IACD,IAAI,IAAI,QAAQ,CAAA;IAEhB,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,0BAA2B,SAAQ,wBAAwB;IACtE;;;;;;OAMG;IACH,YAAY,GAA2B;QACrC,MAAM,EAAE,eAAe;QACvB,WAAW,EAAE,0BAA0B;QACvC,OAAO,EAAE,sBAAsB;QAC/B,YAAY,EAAE,2BAA2B;QACzC,OAAO,EAAE,sBAAsB;QAC/B,WAAW,EAAE,0BAA0B;QACvC,WAAW,EAAE,0BAA0B;QACvC,KAAK,EAAE,oBAAoB;QAC3B,aAAa,EAAE,4BAA4B;QAC3C,QAAQ,EAAE,uBAAuB;QACjC,WAAW,EAAE,0BAA0B;QACvC,SAAS,EAAE,wBAAwB;KACpC,CAAA;IAED;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAA8B,EAC9B,IAAY;QAEZ,qEAAqE;QACrE,MAAM,CAAC,OAAO,YAAY,kBAAkB,CAAC,CAAA;QAE7C,IAAI,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QACjD,uEAAuE;QACvE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,MAAM,EACd,wBAAwB,EACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACD,SAAS,GAAG,eAAe,CAAA;QAC7B,CAAC;QAED,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,MAAM,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAA;QACtC,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,IAAI,IAAI,gBAAgB,SAAS,IAAI,CAAA;YACrC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;YAC1E,IAAI,IAAI,SAAS,CAAA;QACnB,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF;AAED,+EAA+E"}

package/dist/docusaurus/renderers/paramtype.d.ts

@@ -1,6 +1,28 @@
 import { ElementLinesRendererBase } from './element-renderer-base.js';
 import type { AbstractParamType } from '../../doxygen/data-model/compounds/paramtype-dm.js';
+/**
+ * Renderer for parameter type elements in function documentation.
+ *
+ * @remarks
+ * Handles the rendering of function and method parameters as parsed from
+ * Doxygen XML, converting them into formatted output that includes type
+ * information, parameter names, and default values when available.
+ *
+ * @public
+ */
 export declare class ParamTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a parameter element to formatted output lines.
+     *
+     * @remarks
+     * Converts Doxygen parameter elements into formatted text including
+     * type information, parameter names, array specifications, and default
+     * values. Handles both declaration and definition name variants.
+     *
+     * @param element - The parameter element to render
+     * @param type - The rendering context type
+     * @returns Array of formatted output lines
+     */
     renderToLines(element: AbstractParamType, type: string): string[];
 }
 //# sourceMappingURL=paramtype.d.ts.map

package/dist/docusaurus/renderers/paramtype.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paramtype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/paramtype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oDAAoD,CAAA;AAkB3F,qBAAa,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAmD3E"}
+{"version":3,"file":"paramtype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/paramtype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oDAAoD,CAAA;AAkB3F;;;;;;;;;GASG;AACH,qBAAa,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAmD3E"}

package/dist/docusaurus/renderers/paramtype.js

@@ -26,7 +26,29 @@ import { ElementLinesRendererBase } from './element-renderer-base.js';
 //        minOccurs="0" />
 //   </xsd:sequence>
 // </xsd:complexType>
+/**
+ * Renderer for parameter type elements in function documentation.
+ *
+ * @remarks
+ * Handles the rendering of function and method parameters as parsed from
+ * Doxygen XML, converting them into formatted output that includes type
+ * information, parameter names, and default values when available.
+ *
+ * @public
+ */
 export class ParamTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a parameter element to formatted output lines.
+     *
+     * @remarks
+     * Converts Doxygen parameter elements into formatted text including
+     * type information, parameter names, array specifications, and default
+     * values. Handles both declaration and definition name variants.
+     *
+     * @param element - The parameter element to render
+     * @param type - The rendering context type
+     * @returns Array of formatted output lines
+     */
     renderToLines(element, type) {
         // console.log(util.inspect(element, { compact: false, depth: 999 }))
         if (element.attributes !== undefined) {

package/dist/docusaurus/renderers/paramtype.js.map

@@ -1 +1 @@
-{"version":3,"file":"paramtype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/paramtype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAGrE,+EAA+E;AAE/E,qCAAqC;AACrC,mBAAmB;AACnB,wEAAwE;AACxE,sEAAsE;AACtE,sEAAsE;AACtE,qEAAqE;AACrE,mEAAmE;AACnE,wEAAwE;AACxE,gFAAgF;AAChF,kEAAkE;AAClE,0BAA0B;AAC1B,oBAAoB;AACpB,qBAAqB;AAErB,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IACzD,aAAa,CAAC,OAA0B,EAAE,IAAY;QAC7D,qEAAqE;QAErE,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACrC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,yCAAyC,EACzC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,sCAAsC,EACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACzC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,6CAA6C,EAC7C,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YAC3C,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,+CAA+C,EAC/C,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QAED,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAChE,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAA;YAC9B,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAA;YAC7B,CAAC;YACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBACjC,IAAI,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAA;YAC1E,CAAC;QACH,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"paramtype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/paramtype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAGrE,+EAA+E;AAE/E,qCAAqC;AACrC,mBAAmB;AACnB,wEAAwE;AACxE,sEAAsE;AACtE,sEAAsE;AACtE,qEAAqE;AACrE,mEAAmE;AACnE,wEAAwE;AACxE,gFAAgF;AAChF,kEAAkE;AAClE,0BAA0B;AAC1B,oBAAoB;AACpB,qBAAqB;AAErB;;;;;;;;;GASG;AACH,MAAM,OAAO,sBAAuB,SAAQ,wBAAwB;IAClE;;;;;;;;;;;OAWG;IACM,aAAa,CAAC,OAA0B,EAAE,IAAY;QAC7D,qEAAqE;QAErE,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACrC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,yCAAyC,EACzC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,sCAAsC,EACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACzC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,6CAA6C,EAC7C,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YAC3C,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YACpE,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,+CAA+C,EAC/C,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QAED,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAChE,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAA;YAC9B,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAA;YAC7B,CAAC;YACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBACjC,IAAI,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAA;YAC1E,CAAC;QACH,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF;AAED,+EAA+E"}

package/dist/docusaurus/renderers/referencetype.d.ts

@@ -1,6 +1,29 @@
 import { ElementStringRendererBase } from './element-renderer-base.js';
 import { type AbstractReferenceType } from '../../doxygen/data-model/compounds/referencetype-dm.js';
+/**
+ * Renderer for reference elements in documentation cross-references.
+ *
+ * @remarks
+ * Handles the rendering of cross-reference elements that link to other
+ * documented members, creating appropriate hyperlinks with proper
+ * permalinks for navigation within the documentation.
+ *
+ * @public
+ */
 export declare class ReferenceTypeStringRenderer extends ElementStringRendererBase {
+    /**
+     * Renders a reference element to a formatted string with hyperlinks.
+     *
+     * @remarks
+     * Converts Doxygen reference elements into HTML anchor tags with
+     * appropriate permalinks to the referenced members. Handles both
+     * forward references and reverse references whilst sanitising
+     * anonymous namespace names for display.
+     *
+     * @param element - The reference element to render
+     * @param type - The rendering context type
+     * @returns Formatted HTML string with hyperlink
+     */
     renderToString(element: AbstractReferenceType, type: string): string;
 }
 //# sourceMappingURL=referencetype.d.ts.map

package/dist/docusaurus/renderers/referencetype.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"referencetype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/referencetype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EACL,KAAK,qBAAqB,EAG3B,MAAM,wDAAwD,CAAA;AAO/D,qBAAa,2BAA4B,SAAQ,yBAAyB;IACxE,cAAc,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CA8BrE"}
+{"version":3,"file":"referencetype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/referencetype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EACL,KAAK,qBAAqB,EAG3B,MAAM,wDAAwD,CAAA;AAK/D;;;;;;;;;GASG;AACH,qBAAa,2BAA4B,SAAQ,yBAAyB;IACxE;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CA8BrE"}

package/dist/docusaurus/renderers/referencetype.js

@@ -15,9 +15,30 @@ import { ElementStringRendererBase } from './element-renderer-base.js';
 import { ReferenceDataModel, ReferencedByDataModel, } from '../../doxygen/data-model/compounds/referencetype-dm.js';
 import { sanitizeAnonymousNamespace } from '../utils.js';
 // ----------------------------------------------------------------------------
-// ReferenceDataModel
-// ReferencedByDataModel
+/**
+ * Renderer for reference elements in documentation cross-references.
+ *
+ * @remarks
+ * Handles the rendering of cross-reference elements that link to other
+ * documented members, creating appropriate hyperlinks with proper
+ * permalinks for navigation within the documentation.
+ *
+ * @public
+ */
 export class ReferenceTypeStringRenderer extends ElementStringRendererBase {
+    /**
+     * Renders a reference element to a formatted string with hyperlinks.
+     *
+     * @remarks
+     * Converts Doxygen reference elements into HTML anchor tags with
+     * appropriate permalinks to the referenced members. Handles both
+     * forward references and reverse references whilst sanitising
+     * anonymous namespace names for display.
+     *
+     * @param element - The reference element to render
+     * @param type - The rendering context type
+     * @returns Formatted HTML string with hyperlink
+     */
     renderToString(element, type) {
         // console.log(util.inspect(element, { compact: false, depth: 999 }))
         let text = '';

package/dist/docusaurus/renderers/referencetype.js.map

@@ -1 +1 @@
-{"version":3,"file":"referencetype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/referencetype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,oCAAoC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EAEL,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,wDAAwD,CAAA;AAC/D,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AAExD,+EAA+E;AAE/E,qBAAqB;AACrB,wBAAwB;AACxB,MAAM,OAAO,2BAA4B,SAAQ,yBAAyB;IACxE,cAAc,CAAC,OAA8B,EAAE,IAAY;QACzD,qEAAqE;QAErE,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IACE,OAAO,YAAY,qBAAqB;YACxC,OAAO,YAAY,kBAAkB,EACrC,CAAC;YACD,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;gBAClD,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,OAAO,EAAE,QAAQ;aAClB,CAAC,CAAA;YACF,MAAM,CAAC,eAAe,KAAK,SAAS,CAAC,CAAA;YACrC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CACtC,0BAA0B,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAC/C,IAAI,CACL,CAAA;YACD,IAAI,IAAI,YAAY,eAAe,KAAK,IAAI,MAAM,CAAA;QACpD,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,CAAC,IAAI,EACxB,oBAAoB,EACpB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACD,OAAO,EAAE,CAAA;QACX,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"referencetype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/referencetype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,oCAAoC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EAEL,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,wDAAwD,CAAA;AAC/D,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AAExD,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,2BAA4B,SAAQ,yBAAyB;IACxE;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,OAA8B,EAAE,IAAY;QACzD,qEAAqE;QAErE,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IACE,OAAO,YAAY,qBAAqB;YACxC,OAAO,YAAY,kBAAkB,EACrC,CAAC;YACD,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;gBAClD,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,OAAO,EAAE,QAAQ;aAClB,CAAC,CAAA;YACF,MAAM,CAAC,eAAe,KAAK,SAAS,CAAC,CAAA;YACrC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CACtC,0BAA0B,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAC/C,IAAI,CACL,CAAA;YACD,IAAI,IAAI,YAAY,eAAe,KAAK,IAAI,MAAM,CAAA;QACpD,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,CAAC,IAAI,EACxB,oBAAoB,EACpB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACD,OAAO,EAAE,CAAA;QACX,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,+EAA+E"}

package/dist/docusaurus/renderers/reftexttype.d.ts

@@ -1,6 +1,28 @@
 import { ElementStringRendererBase } from './element-renderer-base.js';
 import type { AbstractRefTextType } from '../../doxygen/data-model/compounds/reftexttype-dm.js';
+/**
+ * Renderer for Doxygen reference text elements with linking functionality.
+ *
+ * @remarks
+ * Converts reference text elements into HTML anchor tags when a valid
+ * permalink is available, otherwise renders as plain text. Provides
+ * cross-reference functionality for Doxygen elements.
+ *
+ * @public
+ */
 export declare class RefTextTypeStringRenderer extends ElementStringRendererBase {
+    /**
+     * Renders a reference text element to a formatted string with linking.
+     *
+     * @remarks
+     * Generates an HTML anchor tag when a valid permalink exists for the
+     * referenced element, otherwise renders the text content directly.
+     * Logs warnings for unsupported attributes that are not yet implemented.
+     *
+     * @param element - The reference text element to render
+     * @param type - The rendering context type
+     * @returns The formatted HTML string with optional link
+     */
     renderToString(element: AbstractRefTextType, type: string): string;
 }
 //# sourceMappingURL=reftexttype.d.ts.map

package/dist/docusaurus/renderers/reftexttype.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reftexttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftexttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sDAAsD,CAAA;AAI/F,qBAAa,yBAA0B,SAAQ,yBAAyB;IACtE,cAAc,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAkCnE"}
+{"version":3,"file":"reftexttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftexttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sDAAsD,CAAA;AAI/F;;;;;;;;;GASG;AACH,qBAAa,yBAA0B,SAAQ,yBAAyB;IACtE;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAkCnE"}

package/dist/docusaurus/renderers/reftexttype.js

@@ -13,7 +13,29 @@
 // import * as util from 'node:util'
 import { ElementStringRendererBase } from './element-renderer-base.js';
 // ----------------------------------------------------------------------------
+/**
+ * Renderer for Doxygen reference text elements with linking functionality.
+ *
+ * @remarks
+ * Converts reference text elements into HTML anchor tags when a valid
+ * permalink is available, otherwise renders as plain text. Provides
+ * cross-reference functionality for Doxygen elements.
+ *
+ * @public
+ */
 export class RefTextTypeStringRenderer extends ElementStringRendererBase {
+    /**
+     * Renders a reference text element to a formatted string with linking.
+     *
+     * @remarks
+     * Generates an HTML anchor tag when a valid permalink exists for the
+     * referenced element, otherwise renders the text content directly.
+     * Logs warnings for unsupported attributes that are not yet implemented.
+     *
+     * @param element - The reference text element to render
+     * @param type - The rendering context type
+     * @returns The formatted HTML string with optional link
+     */
     renderToString(element, type) {
         // console.log(util.inspect(element, { compact: false, depth: 999 }))
         if (element.external !== undefined) {

package/dist/docusaurus/renderers/reftexttype.js.map

@@ -1 +1 @@
-{"version":3,"file":"reftexttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftexttype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AAGtE,+EAA+E;AAE/E,MAAM,OAAO,yBAA0B,SAAQ,yBAAyB;IACtE,cAAc,CAAC,OAA4B,EAAE,IAAY;QACvD,qEAAqE;QAErE,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,wCAAwC,EACxC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,uCAAuC,EACvC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QAED,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;YAC5C,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;QACtE,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,IAAI,IAAI,YAAY,SAAS,KAAK,OAAO,MAAM,CAAA;QACjD,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,OAAO,CAAA;QACjB,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"reftexttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftexttype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAA;AAGtE,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,yBAA0B,SAAQ,yBAAyB;IACtE;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,OAA4B,EAAE,IAAY;QACvD,qEAAqE;QAErE,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,wCAAwC,EACxC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,uCAAuC,EACvC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QAED,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;YAC5C,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;QACtE,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,IAAI,IAAI,YAAY,SAAS,KAAK,OAAO,MAAM,CAAA;QACjD,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,OAAO,CAAA;QACjB,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,+EAA+E"}

package/dist/docusaurus/renderers/reftype.d.ts

@@ -1,6 +1,28 @@
 import { ElementLinesRendererBase } from './element-renderer-base.js';
 import type { AbstractRefType } from '../../doxygen/data-model/compounds/reftype-dm.js';
+/**
+ * Renderer for reference type elements in documentation cross-references.
+ *
+ * @remarks
+ * Handles the rendering of reference elements that link to other documented
+ * entities, creating appropriate hyperlinks with permalinks when targets
+ * are available. Used for cross-referencing between documentation elements.
+ *
+ * @public
+ */
 export declare class RefTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a reference element to formatted output lines.
+     *
+     * @remarks
+     * Converts Doxygen reference elements into HTML anchor tags with
+     * appropriate permalinks to the referenced entities. Falls back to
+     * plain text when no permalink is available for the target.
+     *
+     * @param element - The reference element to render
+     * @param type - The rendering context type
+     * @returns Array of formatted output lines
+     */
     renderToLines(element: AbstractRefType, type: string): string[];
 }
 //# sourceMappingURL=reftype.d.ts.map

package/dist/docusaurus/renderers/reftype.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reftype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kDAAkD,CAAA;AAIvF,qBAAa,oBAAqB,SAAQ,wBAAwB;IACvD,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CA8BzE"}
+{"version":3,"file":"reftype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kDAAkD,CAAA;AAIvF;;;;;;;;;GASG;AACH,qBAAa,oBAAqB,SAAQ,wBAAwB;IAChE;;;;;;;;;;;OAWG;IACM,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CA8BzE"}

package/dist/docusaurus/renderers/reftype.js

@@ -13,7 +13,29 @@
 // import * as util from 'node:util'
 import { ElementLinesRendererBase } from './element-renderer-base.js';
 // ----------------------------------------------------------------------------
+/**
+ * Renderer for reference type elements in documentation cross-references.
+ *
+ * @remarks
+ * Handles the rendering of reference elements that link to other documented
+ * entities, creating appropriate hyperlinks with permalinks when targets
+ * are available. Used for cross-referencing between documentation elements.
+ *
+ * @public
+ */
 export class RefTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a reference element to formatted output lines.
+     *
+     * @remarks
+     * Converts Doxygen reference elements into HTML anchor tags with
+     * appropriate permalinks to the referenced entities. Falls back to
+     * plain text when no permalink is available for the target.
+     *
+     * @param element - The reference element to render
+     * @param type - The rendering context type
+     * @returns Array of formatted output lines
+     */
     renderToLines(element, type) {
         // console.log(util.inspect(element, { compact: false, depth: 999 }))
         if (element.prot !== undefined) {

package/dist/docusaurus/renderers/reftype.js.map

@@ -1 +1 @@
-{"version":3,"file":"reftype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAGrE,+EAA+E;AAE/E,MAAM,OAAO,oBAAqB,SAAQ,wBAAwB;IACvD,aAAa,CAAC,OAAwB,EAAE,IAAY;QAC3D,qEAAqE;QAErE,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,oCAAoC,EACpC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,sCAAsC,EACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;QACtE,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAChE,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,KAAK,CAAC,IAAI,CAAC,YAAY,SAAS,KAAK,OAAO,MAAM,CAAC,CAAA;QACrD,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrB,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"reftype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/reftype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAGrE,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,oBAAqB,SAAQ,wBAAwB;IAChE;;;;;;;;;;;OAWG;IACM,aAAa,CAAC,OAAwB,EAAE,IAAY;QAC3D,qEAAqE;QAErE,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,oCAAoC,EACpC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,EACnB,sCAAsC,EACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;QACH,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;QACtE,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAChE,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,KAAK,CAAC,IAAI,CAAC,YAAY,SAAS,KAAK,OAAO,MAAM,CAAC,CAAA;QACrD,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrB,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}