@xpack/doxygen2docusaurus 1.0.2 → 2.0.0

package/dist/docusaurus/renderers/doctabletype.js

@@ -13,7 +13,29 @@
 // import * as util from 'node:util'
 import { ElementLinesRendererBase, ElementStringRendererBase, } from './element-renderer-base.js';
 // ----------------------------------------------------------------------------
+/**
+ * Renderer for Doxygen document table elements.
+ *
+ * @remarks
+ * Converts Doxygen table structures to HTML table format with optional
+ * captions. Processes table rows and maintains styling through CSS
+ * classes for consistent documentation presentation.
+ *
+ * @public
+ */
 export class DocTableTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a document table element to formatted output lines.
+     *
+     * @remarks
+     * Creates HTML table structure with optional caption and processes
+     * all table rows. Applies CSS classes for styling and maintains
+     * proper table markup for documentation display.
+     *
+     * @param element - The document table element to render
+     * @param type - The rendering context type (unused in implementation)
+     * @returns Array of HTML strings forming the table structure
+     */
     renderToLines(element, 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     type) {
@@ -29,7 +51,29 @@ export class DocTableTypeLinesRenderer extends ElementLinesRendererBase {
         return lines;
     }
 }
+/**
+ * Renderer for Doxygen document table caption elements.
+ *
+ * @remarks
+ * Generates HTML caption elements for table titles and descriptions.
+ * Processes caption content to provide contextual information about
+ * table contents and purpose within documentation.
+ *
+ * @public
+ */
 export class DocCaptionLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a document caption element to formatted output lines.
+     *
+     * @remarks
+     * Creates HTML caption element containing the processed caption content.
+     * Renders child elements to build complete caption text with proper
+     * markup and formatting preservation.
+     *
+     * @param element - The document caption element to render
+     * @param type - The rendering context type (unused in implementation)
+     * @returns Array containing the HTML caption element
+     */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     renderToLines(element, type) {
         // console.log(util.inspect(element, { compact: false, depth: 999 }))
@@ -46,7 +90,29 @@ export class DocCaptionLinesRenderer extends ElementLinesRendererBase {
         return [text];
     }
 }
+/**
+ * Renderer for Doxygen document table row elements.
+ *
+ * @remarks
+ * Generates HTML table row structure containing table entries.
+ * Processes all entry elements within the row to build complete
+ * table row markup for documentation display.
+ *
+ * @public
+ */
 export class DocRowTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a document table row element to formatted output lines.
+     *
+     * @remarks
+     * Creates HTML table row tags around rendered table entries.
+     * Processes entry elements to generate the complete row structure
+     * with proper table markup.
+     *
+     * @param element - The document table row element to render
+     * @param type - The rendering context type (unused in implementation)
+     * @returns Array of HTML strings forming the table row
+     */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     renderToLines(element, type) {
         // console.log(util.inspect(element, { compact: false, depth: 999 }))
@@ -57,7 +123,29 @@ export class DocRowTypeLinesRenderer extends ElementLinesRendererBase {
         return lines;
     }
 }
+/**
+ * Renderer for Doxygen document table entry elements.
+ *
+ * @remarks
+ * Converts table cell elements to HTML table data or header cells
+ * with appropriate attributes. Handles cell spanning, alignment,
+ * and styling attributes for flexible table presentation.
+ *
+ * @public
+ */
 export class DocEntryTypeStringRenderer extends ElementStringRendererBase {
+    /**
+     * Renders a document table entry element to a formatted string.
+     *
+     * @remarks
+     * Creates HTML table cell (td or th) with attributes including
+     * colspan, rowspan, alignment, and styling. Processes cell content
+     * and applies appropriate markup based on header status.
+     *
+     * @param element - The document table entry element to render
+     * @param type - The rendering context type (unused in implementation)
+     * @returns The formatted HTML table cell string
+     */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     renderToString(element, type) {
         // console.log(util.inspect(element, { compact: false, depth: 999 }))

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

@@ -1 +1 @@
-{"version":3,"file":"doctabletype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctabletype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EACL,wBAAwB,EACxB,yBAAyB,GAC1B,MAAM,4BAA4B,CAAA;AAQnC,+EAA+E;AAE/E,MAAM,OAAO,yBAA0B,SAAQ,wBAAwB;IAC5D,aAAa,CACpB,OAA6B;IAC7B,6DAA6D;IAC7D,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAA;QACvC,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;QAC3E,CAAC;QACD,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CACnE,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAEtB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,wBAAwB;IACnE,6DAA6D;IAC7D,aAAa,CAAC,OAA+B,EAAE,IAAY;QACzD,qEAAqE;QAErE,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,UAAU,GAAG,EAAE,CAAA;QACnB,IAAI,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,UAAU,IAAI,QAAQ,OAAO,CAAC,EAAE,GAAG,CAAA;QACrC,CAAC;QACD,IAAI,IAAI,WAAW,UAAU,GAAG,CAAA;QAChC,IAAI,IAAI,IAAI,CAAC,SAAS;aACnB,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC;aACrD,IAAI,EAAE,CAAA;QACT,IAAI,IAAI,YAAY,CAAA;QAEpB,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,wBAAwB;IACnE,6DAA6D;IACpD,aAAa,CAAC,OAA2B,EAAE,IAAY;QAC9D,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAClB,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CACtE,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEnB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,MAAM,OAAO,0BAA2B,SAAQ,yBAAyB;IACvE,6DAA6D;IAC7D,cAAc,CAAC,OAA6B,EAAE,IAAY;QACxD,qEAAqE;QAErE,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,UAAU,GAAG,EAAE,CAAA;QACnB,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,UAAU,IAAI,aAAa,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAA;QAC1D,CAAC;QACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,UAAU,IAAI,aAAa,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAA;QAC1D,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,UAAU,IAAI,WAAW,OAAO,CAAC,KAAK,GAAG,CAAA;QAC3C,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,UAAU,IAAI,YAAY,OAAO,CAAC,MAAM,GAAG,CAAA;QAC7C,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,UAAU,IAAI,WAAW,OAAO,CAAC,KAAK,GAAG,CAAA;QAC3C,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,UAAU,IAAI,WAAW,OAAO,CAAC,MAAM,GAAG,CAAA;QAC5C,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,2BAA2B,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC;aAClD,IAAI,EAAE,CAAA;QACT,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,IAAI,IAAI,MAAM,UAAU,IAAI,KAAK,OAAO,CAAA;QAC1C,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,MAAM,UAAU,IAAI,KAAK,OAAO,CAAA;QAC1C,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"doctabletype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctabletype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EACL,wBAAwB,EACxB,yBAAyB,GAC1B,MAAM,4BAA4B,CAAA;AAQnC,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,yBAA0B,SAAQ,wBAAwB;IACrE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAA6B;IAC7B,6DAA6D;IAC7D,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAA;QACvC,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;QAC3E,CAAC;QACD,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CACnE,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAEtB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,uBAAwB,SAAQ,wBAAwB;IACnE;;;;;;;;;;;OAWG;IACH,6DAA6D;IAC7D,aAAa,CAAC,OAA+B,EAAE,IAAY;QACzD,qEAAqE;QAErE,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,UAAU,GAAG,EAAE,CAAA;QACnB,IAAI,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,UAAU,IAAI,QAAQ,OAAO,CAAC,EAAE,GAAG,CAAA;QACrC,CAAC;QACD,IAAI,IAAI,WAAW,UAAU,GAAG,CAAA;QAChC,IAAI,IAAI,IAAI,CAAC,SAAS;aACnB,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC;aACrD,IAAI,EAAE,CAAA;QACT,IAAI,IAAI,YAAY,CAAA;QAEpB,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,uBAAwB,SAAQ,wBAAwB;IACnE;;;;;;;;;;;OAWG;IACH,6DAA6D;IACpD,aAAa,CAAC,OAA2B,EAAE,IAAY;QAC9D,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAClB,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CACtE,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEnB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,0BAA2B,SAAQ,yBAAyB;IACvE;;;;;;;;;;;OAWG;IACH,6DAA6D;IAC7D,cAAc,CAAC,OAA6B,EAAE,IAAY;QACxD,qEAAqE;QAErE,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,UAAU,GAAG,EAAE,CAAA;QACnB,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,UAAU,IAAI,aAAa,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAA;QAC1D,CAAC;QACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,UAAU,IAAI,aAAa,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAA;QAC1D,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,UAAU,IAAI,WAAW,OAAO,CAAC,KAAK,GAAG,CAAA;QAC3C,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,UAAU,IAAI,YAAY,OAAO,CAAC,MAAM,GAAG,CAAA;QAC7C,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,UAAU,IAAI,WAAW,OAAO,CAAC,KAAK,GAAG,CAAA;QAC3C,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,UAAU,IAAI,WAAW,OAAO,CAAC,MAAM,GAAG,CAAA;QAC5C,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,2BAA2B,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC;aAClD,IAAI,EAAE,CAAA;QACT,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,IAAI,IAAI,MAAM,UAAU,IAAI,KAAK,OAAO,CAAA;QAC1C,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,MAAM,UAAU,IAAI,KAAK,OAAO,CAAA;QAC1C,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,+EAA+E"}

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

@@ -1,6 +1,28 @@
 import { ElementLinesRendererBase } from './element-renderer-base.js';
 import { type AbstractDocTitleType } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
+/**
+ * Renderer for Doxygen document title elements.
+ *
+ * @remarks
+ * Handles title and term elements within documentation structures.
+ * Supports polymorphic rendering for different title types while
+ * providing error handling for unrecognised element variations.
+ *
+ * @public
+ */
 export declare class DocTitleTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a document title element to formatted output lines.
+     *
+     * @remarks
+     * Processes title and term data models by rendering their child elements.
+     * Logs errors for unrecognised title types that require implementation
+     * support for complete documentation coverage.
+     *
+     * @param element - The document title element to render
+     * @param type - The rendering context type
+     * @returns Array containing the rendered title text
+     */
     renderToLines(element: AbstractDocTitleType, type: string): string[];
 }
 //# sourceMappingURL=doctitletype.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"doctitletype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctitletype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EACL,KAAK,oBAAoB,EAG1B,MAAM,0DAA0D,CAAA;AAIjE,qBAAa,yBAA0B,SAAQ,wBAAwB;IAC5D,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAuBZ"}
+{"version":3,"file":"doctitletype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctitletype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EACL,KAAK,oBAAoB,EAG1B,MAAM,0DAA0D,CAAA;AAIjE;;;;;;;;;GASG;AACH,qBAAa,yBAA0B,SAAQ,wBAAwB;IACrE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAO,EAAE,oBAAoB,EAC7B,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CAuBZ"}

package/dist/docusaurus/renderers/doctitletype.js

@@ -14,7 +14,29 @@
 import { ElementLinesRendererBase } from './element-renderer-base.js';
 import { TermDataModel, TitleDataModel, } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
 // ----------------------------------------------------------------------------
+/**
+ * Renderer for Doxygen document title elements.
+ *
+ * @remarks
+ * Handles title and term elements within documentation structures.
+ * Supports polymorphic rendering for different title types while
+ * providing error handling for unrecognised element variations.
+ *
+ * @public
+ */
 export class DocTitleTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a document title element to formatted output lines.
+     *
+     * @remarks
+     * Processes title and term data models by rendering their child elements.
+     * Logs errors for unrecognised title types that require implementation
+     * support for complete documentation coverage.
+     *
+     * @param element - The document title element to render
+     * @param type - The rendering context type
+     * @returns Array containing the rendered title text
+     */
     renderToLines(element, type) {
         // console.log(util.inspect(element, { compact: false, depth: 999 }))
         let text = '';

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

@@ -1 +1 @@
-{"version":3,"file":"doctitletype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctitletype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAEL,aAAa,EACb,cAAc,GACf,MAAM,0DAA0D,CAAA;AAEjE,+EAA+E;AAE/E,MAAM,OAAO,yBAA0B,SAAQ,wBAAwB;IAC5D,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,OAAO,YAAY,cAAc,EAAE,CAAC;YACtC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAC5E,CAAC;aAAM,IAAI,OAAO,YAAY,aAAa,EAAE,CAAC;YAC5C,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAC5E,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,CAAC,IAAI,EACxB,iBAAiB,EACjB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACD,gBAAgB;YAChB,UAAU;YACV,uEAAuE;YACvE,iBAAiB;QACnB,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"doctitletype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/doctitletype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAEL,aAAa,EACb,cAAc,GACf,MAAM,0DAA0D,CAAA;AAEjE,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,yBAA0B,SAAQ,wBAAwB;IACrE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAA6B,EAC7B,IAAY;QAEZ,qEAAqE;QAErE,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,OAAO,YAAY,cAAc,EAAE,CAAC;YACtC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAC5E,CAAC;aAAM,IAAI,OAAO,YAAY,aAAa,EAAE,CAAC;YAC5C,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAC5E,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,CAAC,IAAI,EACxB,iBAAiB,EACjB,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB,CAAA;YACD,gBAAgB;YAChB,UAAU;YACV,uEAAuE;YACvE,iBAAiB;QACnB,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;CACF;AAED,+EAA+E"}

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

@@ -1,9 +1,53 @@
 import { ElementLinesRendererBase } from './element-renderer-base.js';
 import type { AbstractDocVariableListType, VariableListPairDataModel } from '../../doxygen/data-model/compounds/docvarlistentrytype-dm.js';
+/**
+ * Renderer for Doxygen variable list container elements.
+ *
+ * @remarks
+ * Creates HTML definition list structure for variable lists containing
+ * term-description pairs. Provides the outer container for organised
+ * presentation of variable documentation.
+ *
+ * @public
+ */
 export declare class DocVariableListTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a variable list container to formatted output lines.
+     *
+     * @remarks
+     * Creates an HTML definition list wrapper around variable list entries.
+     * Each child element represents a term-description pair within the
+     * structured list format.
+     *
+     * @param element - The variable list container element to render
+     * @param type - The rendering context type (unused in implementation)
+     * @returns Array of HTML strings forming the definition list structure
+     */
     renderToLines(element: AbstractDocVariableListType, type: string): string[];
 }
+/**
+ * Renderer for individual variable list entry pairs.
+ *
+ * @remarks
+ * Converts term-description pairs into HTML definition list items.
+ * Handles both single-line and multi-line descriptions with appropriate
+ * formatting for readable documentation output.
+ *
+ * @public
+ */
 export declare class VariableListPairLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a variable list entry pair to formatted output lines.
+     *
+     * @remarks
+     * Creates HTML definition term and description elements from the
+     * variable list entry. Handles multi-line descriptions by splitting
+     * content across multiple lines within the definition element.
+     *
+     * @param element - The variable list pair element to render
+     * @param type - The rendering context type (unused in implementation)
+     * @returns Array of HTML strings for the term-description pair
+     */
     renderToLines(element: VariableListPairDataModel, type: string): string[];
 }
 //# sourceMappingURL=docvariablelisttype.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"docvariablelisttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docvariablelisttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EACV,2BAA2B,EAC3B,yBAAyB,EAC1B,MAAM,8DAA8D,CAAA;AAIrE,qBAAa,gCAAiC,SAAQ,wBAAwB;IAE5E,aAAa,CAAC,OAAO,EAAE,2BAA2B,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAc5E;AAED,qBAAa,6BAA8B,SAAQ,wBAAwB;IAChE,aAAa,CACpB,OAAO,EAAE,yBAAyB,EAElC,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CA6BZ"}
+{"version":3,"file":"docvariablelisttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docvariablelisttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EACV,2BAA2B,EAC3B,yBAAyB,EAC1B,MAAM,8DAA8D,CAAA;AAIrE;;;;;;;;;GASG;AACH,qBAAa,gCAAiC,SAAQ,wBAAwB;IAC5E;;;;;;;;;;;OAWG;IAEH,aAAa,CAAC,OAAO,EAAE,2BAA2B,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAc5E;AAED;;;;;;;;;GASG;AACH,qBAAa,6BAA8B,SAAQ,wBAAwB;IACzE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAO,EAAE,yBAAyB,EAElC,IAAI,EAAE,MAAM,GACX,MAAM,EAAE;CA6BZ"}

package/dist/docusaurus/renderers/docvariablelisttype.js

@@ -13,7 +13,29 @@
 // import * as util from 'node:util'
 import { ElementLinesRendererBase } from './element-renderer-base.js';
 // ----------------------------------------------------------------------------
+/**
+ * Renderer for Doxygen variable list container elements.
+ *
+ * @remarks
+ * Creates HTML definition list structure for variable lists containing
+ * term-description pairs. Provides the outer container for organised
+ * presentation of variable documentation.
+ *
+ * @public
+ */
 export class DocVariableListTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a variable list container to formatted output lines.
+     *
+     * @remarks
+     * Creates an HTML definition list wrapper around variable list entries.
+     * Each child element represents a term-description pair within the
+     * structured list format.
+     *
+     * @param element - The variable list container element to render
+     * @param type - The rendering context type (unused in implementation)
+     * @returns Array of HTML strings forming the definition list structure
+     */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     renderToLines(element, type) {
         // console.log(util.inspect(element, { compact: false, depth: 999 }))
@@ -25,7 +47,29 @@ export class DocVariableListTypeLinesRenderer extends ElementLinesRendererBase {
         return lines;
     }
 }
+/**
+ * Renderer for individual variable list entry pairs.
+ *
+ * @remarks
+ * Converts term-description pairs into HTML definition list items.
+ * Handles both single-line and multi-line descriptions with appropriate
+ * formatting for readable documentation output.
+ *
+ * @public
+ */
 export class VariableListPairLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a variable list entry pair to formatted output lines.
+     *
+     * @remarks
+     * Creates HTML definition term and description elements from the
+     * variable list entry. Handles multi-line descriptions by splitting
+     * content across multiple lines within the definition element.
+     *
+     * @param element - The variable list pair element to render
+     * @param type - The rendering context type (unused in implementation)
+     * @returns Array of HTML strings for the term-description pair
+     */
     renderToLines(element, 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     type) {

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

@@ -1 +1 @@
-{"version":3,"file":"docvariablelisttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docvariablelisttype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAMrE,+EAA+E;AAE/E,MAAM,OAAO,gCAAiC,SAAQ,wBAAwB;IAC5E,6DAA6D;IAC7D,aAAa,CAAC,OAAoC,EAAE,IAAY;QAC9D,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAA;QAC3C,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CACvE,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEnB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,MAAM,OAAO,6BAA8B,SAAQ,wBAAwB;IAChE,aAAa,CACpB,OAAkC;IAClC,6DAA6D;IAC7D,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,yCAAyC;QACzC,sCAAsC;QAEtC,sCAAsC;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC;aACxD,IAAI,EAAE,CAAA;QAET,0DAA0D;QAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS;aAC/B,2BAA2B,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;aAC3D,IAAI,EAAE,CAAA;QAET,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,CAAA;QAC/B,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,OAAO,WAAW,OAAO,CAAC,CAAA;QACvC,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAClB,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;YACtC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrB,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"docvariablelisttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docvariablelisttype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAMrE,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,gCAAiC,SAAQ,wBAAwB;IAC5E;;;;;;;;;;;OAWG;IACH,6DAA6D;IAC7D,aAAa,CAAC,OAAoC,EAAE,IAAY;QAC9D,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAA;QAC3C,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CACvE,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEnB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,6BAA8B,SAAQ,wBAAwB;IACzE;;;;;;;;;;;OAWG;IACM,aAAa,CACpB,OAAkC;IAClC,6DAA6D;IAC7D,IAAY;QAEZ,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,yCAAyC;QACzC,sCAAsC;QAEtC,sCAAsC;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;aACzB,qBAAqB,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC;aACxD,IAAI,EAAE,CAAA;QAET,0DAA0D;QAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS;aAC/B,2BAA2B,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;aAC3D,IAAI,EAAE,CAAA;QAET,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,CAAA;QAC/B,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,OAAO,WAAW,OAAO,CAAC,CAAA;QACvC,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAClB,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;YACtC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrB,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}

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

@@ -1,6 +1,28 @@
 import { ElementLinesRendererBase } from './element-renderer-base.js';
 import type { AbstractDocXRefSectType } from '../../doxygen/data-model/compounds/descriptiontype-dm.js';
+/**
+ * Renderer for Doxygen cross-reference section elements.
+ *
+ * @remarks
+ * Generates HTML structure for cross-reference sections with titles and
+ * descriptions. Creates definition lists with linked titles and detailed
+ * content for documentation cross-references.
+ *
+ * @public
+ */
 export declare class DocXRefSectLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a cross-reference section to formatted output lines.
+     *
+     * @remarks
+     * Creates an HTML definition list structure with the cross-reference
+     * title as a linked term and the description as the definition content.
+     * Generates a permalink for the cross-reference section.
+     *
+     * @param element - The cross-reference section element to render
+     * @param type - The rendering context type (unused in implementation)
+     * @returns Array of HTML strings forming the cross-reference section
+     */
     renderToLines(element: AbstractDocXRefSectType, type: string): string[];
 }
 //# sourceMappingURL=docxrefsecttype.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"docxrefsecttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docxrefsecttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0DAA0D,CAAA;AAIvG,qBAAa,wBAAyB,SAAQ,wBAAwB;IAEpE,aAAa,CAAC,OAAO,EAAE,uBAAuB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAoCxE"}
+{"version":3,"file":"docxrefsecttype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docxrefsecttype.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0DAA0D,CAAA;AAIvG;;;;;;;;;GASG;AACH,qBAAa,wBAAyB,SAAQ,wBAAwB;IACpE;;;;;;;;;;;OAWG;IAEH,aAAa,CAAC,OAAO,EAAE,uBAAuB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAoCxE"}

package/dist/docusaurus/renderers/docxrefsecttype.js

@@ -13,7 +13,29 @@ import assert from 'node:assert';
 // import * as util from 'node:util'
 import { ElementLinesRendererBase } from './element-renderer-base.js';
 // ----------------------------------------------------------------------------
+/**
+ * Renderer for Doxygen cross-reference section elements.
+ *
+ * @remarks
+ * Generates HTML structure for cross-reference sections with titles and
+ * descriptions. Creates definition lists with linked titles and detailed
+ * content for documentation cross-references.
+ *
+ * @public
+ */
 export class DocXRefSectLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders a cross-reference section to formatted output lines.
+     *
+     * @remarks
+     * Creates an HTML definition list structure with the cross-reference
+     * title as a linked term and the description as the definition content.
+     * Generates a permalink for the cross-reference section.
+     *
+     * @param element - The cross-reference section element to render
+     * @param type - The rendering context type (unused in implementation)
+     * @returns Array of HTML strings forming the cross-reference section
+     */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     renderToLines(element, type) {
         // console.log(util.inspect(element, { compact: false, depth: 999 }))

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

@@ -1 +1 @@
-{"version":3,"file":"docxrefsecttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docxrefsecttype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAGrE,+EAA+E;AAE/E,MAAM,OAAO,wBAAyB,SAAQ,wBAAwB;IACpE,6DAA6D;IAC7D,aAAa,CAAC,OAAgC,EAAE,IAAY;QAC1D,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CACvC,OAAO,CAAC,SAAS,IAAI,KAAK,EAC1B,MAAM,CACP,CAAA;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;YAC5C,KAAK,EAAE,OAAO,CAAC,EAAE;YACjB,OAAO,EAAE,UAAU;SACpB,CAAC,CAAA;QACF,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,CAAA;QAE/B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;QACxC,KAAK,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAA;QAC3C,KAAK,CAAC,IAAI,CACR,yCAAyC,SAAS,IAAI,KAAK,WAAW,CACvE,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAA;QAElD,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAC1C,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,SAAS;iBACX,qBAAqB,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC;iBACtD,IAAI,EAAE,CACV,CAAA;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAEpB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"docxrefsecttype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/docxrefsecttype.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,oCAAoC;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAGrE,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,wBAAyB,SAAQ,wBAAwB;IACpE;;;;;;;;;;;OAWG;IACH,6DAA6D;IAC7D,aAAa,CAAC,OAAgC,EAAE,IAAY;QAC1D,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CACvC,OAAO,CAAC,SAAS,IAAI,KAAK,EAC1B,MAAM,CACP,CAAA;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;YAC5C,KAAK,EAAE,OAAO,CAAC,EAAE;YACjB,OAAO,EAAE,UAAU;SACpB,CAAC,CAAA;QACF,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,CAAA;QAE/B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;QACxC,KAAK,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAA;QAC3C,KAAK,CAAC,IAAI,CACR,yCAAyC,SAAS,IAAI,KAAK,WAAW,CACvE,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAA;QAElD,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAC1C,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,SAAS;iBACX,qBAAqB,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC;iBACtD,IAAI,EAAE,CACV,CAAA;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAEpB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}

package/dist/docusaurus/renderers/element-renderer-base.d.ts

@@ -1,12 +1,86 @@
 import type { Workspace } from '../workspace.js';
+/**
+ * Abstract base class for renderers that output string content.
+ *
+ * @remarks
+ * Provides common functionality for element renderers that convert
+ * Doxygen XML elements into formatted string output. Maintains a
+ * reference to the workspace for accessing configuration and utilities.
+ *
+ * @public
+ */
 export declare abstract class ElementStringRendererBase {
+    /**
+     * The workspace containing global configuration and utilities.
+     *
+     * @remarks
+     * Provides access to rendering utilities, permalink generation,
+     * and global configuration options needed for element processing.
+     */
     workspace: Workspace;
+    /**
+     * Creates a new string element renderer.
+     *
+     * @remarks
+     * Initialises the renderer with the workspace reference for accessing
+     * global configuration and rendering utilities.
+     *
+     * @param workspace - The workspace instance
+     */
     constructor(workspace: Workspace);
+    /**
+     * Renders an element to a formatted string.
+     *
+     * @remarks
+     * Abstract method that must be implemented by derived classes to
+     * convert specific element types into their string representation.
+     *
+     * @param element - The element to render
+     * @param type - The rendering context type
+     * @returns Formatted string output
+     */
     abstract renderToString(element: object, type: string): string;
 }
+/**
+ * Abstract base class for renderers that output multiple lines.
+ *
+ * @remarks
+ * Provides common functionality for element renderers that convert
+ * Doxygen XML elements into formatted multi-line output. Maintains
+ * a reference to the workspace for accessing configuration and utilities.
+ *
+ * @public
+ */
 export declare abstract class ElementLinesRendererBase {
+    /**
+     * The workspace containing global configuration and utilities.
+     *
+     * @remarks
+     * Provides access to rendering utilities, permalink generation,
+     * and global configuration options needed for element processing.
+     */
     workspace: Workspace;
+    /**
+     * Creates a new lines element renderer.
+     *
+     * @remarks
+     * Initialises the renderer with the workspace reference for accessing
+     * global configuration and rendering utilities.
+     *
+     * @param workspace - The workspace instance
+     */
     constructor(workspace: Workspace);
+    /**
+     * Renders an element to an array of formatted lines.
+     *
+     * @remarks
+     * Abstract method that must be implemented by derived classes to
+     * convert specific element types into their multi-line representation.
+     *
+     * @param element - The element to render
+     * @param type - The rendering context type
+     * @returns Array of formatted output lines
+     */
     abstract renderToLines(element: object, type: string): string[];
 }
 //# sourceMappingURL=element-renderer-base.d.ts.map

package/dist/docusaurus/renderers/element-renderer-base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"element-renderer-base.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/element-renderer-base.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAIhD,8BAAsB,yBAAyB;IAC7C,SAAS,EAAE,SAAS,CAAA;gBAER,SAAS,EAAE,SAAS;IAIhC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAC/D;AAED,8BAAsB,wBAAwB;IAC5C,SAAS,EAAE,SAAS,CAAA;gBAER,SAAS,EAAE,SAAS;IAIhC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAChE"}
+{"version":3,"file":"element-renderer-base.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/element-renderer-base.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAIhD;;;;;;;;;GASG;AACH,8BAAsB,yBAAyB;IAC7C;;;;;;OAMG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;;;;;;;OAQG;gBACS,SAAS,EAAE,SAAS;IAIhC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAC/D;AAED;;;;;;;;;GASG;AACH,8BAAsB,wBAAwB;IAC5C;;;;;;OAMG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;;;;;;;OAQG;gBACS,SAAS,EAAE,SAAS;IAIhC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CAChE"}

package/dist/docusaurus/renderers/element-renderer-base.js

@@ -9,14 +9,66 @@
  * be obtained from https://opensource.org/licenses/MIT.
  */
 // ----------------------------------------------------------------------------
+/**
+ * Abstract base class for renderers that output string content.
+ *
+ * @remarks
+ * Provides common functionality for element renderers that convert
+ * Doxygen XML elements into formatted string output. Maintains a
+ * reference to the workspace for accessing configuration and utilities.
+ *
+ * @public
+ */
 export class ElementStringRendererBase {
+    /**
+     * The workspace containing global configuration and utilities.
+     *
+     * @remarks
+     * Provides access to rendering utilities, permalink generation,
+     * and global configuration options needed for element processing.
+     */
     workspace;
+    /**
+     * Creates a new string element renderer.
+     *
+     * @remarks
+     * Initialises the renderer with the workspace reference for accessing
+     * global configuration and rendering utilities.
+     *
+     * @param workspace - The workspace instance
+     */
     constructor(workspace) {
         this.workspace = workspace;
     }
 }
+/**
+ * Abstract base class for renderers that output multiple lines.
+ *
+ * @remarks
+ * Provides common functionality for element renderers that convert
+ * Doxygen XML elements into formatted multi-line output. Maintains
+ * a reference to the workspace for accessing configuration and utilities.
+ *
+ * @public
+ */
 export class ElementLinesRendererBase {
+    /**
+     * The workspace containing global configuration and utilities.
+     *
+     * @remarks
+     * Provides access to rendering utilities, permalink generation,
+     * and global configuration options needed for element processing.
+     */
     workspace;
+    /**
+     * Creates a new lines element renderer.
+     *
+     * @remarks
+     * Initialises the renderer with the workspace reference for accessing
+     * global configuration and rendering utilities.
+     *
+     * @param workspace - The workspace instance
+     */
     constructor(workspace) {
         this.workspace = workspace;
     }

package/dist/docusaurus/renderers/element-renderer-base.js.map

@@ -1 +1 @@
-{"version":3,"file":"element-renderer-base.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/element-renderer-base.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAMH,+EAA+E;AAE/E,MAAM,OAAgB,yBAAyB;IAC7C,SAAS,CAAW;IAEpB,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CAGF;AAED,MAAM,OAAgB,wBAAwB;IAC5C,SAAS,CAAW;IAEpB,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CAGF;AAED,+EAA+E"}
+{"version":3,"file":"element-renderer-base.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/element-renderer-base.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAMH,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAgB,yBAAyB;IAC7C;;;;;;OAMG;IACH,SAAS,CAAW;IAEpB;;;;;;;;OAQG;IACH,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CAcF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAgB,wBAAwB;IAC5C;;;;;;OAMG;IACH,SAAS,CAAW;IAEpB;;;;;;;;OAQG;IACH,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CAcF;AAED,+EAA+E"}

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

@@ -1,6 +1,29 @@
 import { ElementLinesRendererBase } from './element-renderer-base.js';
 import type { AbstractIncType } from '../../doxygen/data-model/compounds/inctype-dm.js';
+/**
+ * Renderer for include directive elements in documentation.
+ *
+ * @remarks
+ * Handles the rendering of #include statements found in source code,
+ * converting them to appropriate HTML output with proper link generation
+ * when the included file is documented.
+ *
+ * @public
+ */
 export declare class IncTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders an include element to formatted output lines.
+     *
+     * @remarks
+     * Converts Doxygen include elements into HTML format with appropriate
+     * angle brackets or quotes, and creates links to documented files
+     * when available. Handles both local includes (quotes) and system
+     * includes (angle brackets).
+     *
+     * @param element - The include element to render
+     * @param type - The rendering context type
+     * @returns Array of formatted output lines
+     */
     renderToLines(element: AbstractIncType, type: string): string[];
 }
 //# sourceMappingURL=inctype.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"inctype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/inctype.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;CA2BzE"}
+{"version":3,"file":"inctype.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/renderers/inctype.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;;;;;;;;;;;;OAYG;IACM,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;CA2BzE"}

package/dist/docusaurus/renderers/inctype.js

@@ -13,7 +13,30 @@
 // import * as util from 'node:util'
 import { ElementLinesRendererBase } from './element-renderer-base.js';
 // ----------------------------------------------------------------------------
+/**
+ * Renderer for include directive elements in documentation.
+ *
+ * @remarks
+ * Handles the rendering of #include statements found in source code,
+ * converting them to appropriate HTML output with proper link generation
+ * when the included file is documented.
+ *
+ * @public
+ */
 export class IncTypeLinesRenderer extends ElementLinesRendererBase {
+    /**
+     * Renders an include element to formatted output lines.
+     *
+     * @remarks
+     * Converts Doxygen include elements into HTML format with appropriate
+     * angle brackets or quotes, and creates links to documented files
+     * when available. Handles both local includes (quotes) and system
+     * includes (angle brackets).
+     *
+     * @param element - The include 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 }))
         const lines = [];

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

@@ -1 +1 @@
-{"version":3,"file":"inctype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/inctype.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,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,IAAI,SAAS,GAAuB,EAAE,CAAA;QACtC,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YAC1D,oBAAoB;QACtB,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;QACtE,IAAI,IAAI,GAAG,EAAE,CAAA;QACb,IAAI,IAAI,WAAW,CAAA;QACnB,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAA;QACpC,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;QACD,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAA;QACpC,oBAAoB;QAEpB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEhB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"inctype.js","sourceRoot":"","sources":["../../../src/docusaurus/renderers/inctype.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;;;;;;;;;;;;OAYG;IACM,aAAa,CAAC,OAAwB,EAAE,IAAY;QAC3D,qEAAqE;QAErE,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,IAAI,SAAS,GAAuB,EAAE,CAAA;QACtC,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YAC1D,oBAAoB;QACtB,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;QACtE,IAAI,IAAI,GAAG,EAAE,CAAA;QACb,IAAI,IAAI,WAAW,CAAA;QACnB,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAA;QACpC,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;QACD,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAA;QACpC,oBAAoB;QAEpB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEhB,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}