@xpack/doxygen2docusaurus 1.0.2 → 2.0.0

package/dist/docusaurus/utils.js

@@ -11,6 +11,20 @@
 // ----------------------------------------------------------------------------
 import * as fs from 'node:fs/promises';
 // ----------------------------------------------------------------------------
+/**
+ * Formats a Date object into a standardised UTC string representation.
+ *
+ * @remarks
+ * Produces a timestamp in the format "YYYY-MM-DD HH:mm:ss +0000" using
+ * UTC timezone for consistent date formatting across different environments.
+ * This format ensures reproducible timestamps regardless of the local
+ * system timezone, which is essential for documentation generation consistency.
+ *
+ * @param date - The Date object to format.
+ * @returns A formatted date string in UTC with timezone offset.
+ *
+ * @public
+ */
 export function formatDate(date) {
     // Custom format: YYYY-MM-DD HH:mm:ss
     const year = date.getUTCFullYear();
@@ -23,6 +37,20 @@ export function formatDate(date) {
     return (`${year.toString()}-${month}-${day} ${hours}:${minutes}:${seconds} ` +
         '+0000');
 }
+/**
+ * Formats a duration value into a human-readable string representation.
+ *
+ * @remarks
+ * Converts millisecond values into appropriate units (milliseconds, seconds,
+ * or minutes) with appropriate precision for display purposes. The function
+ * automatically selects the most suitable unit based on the magnitude of
+ * the duration value to ensure optimal readability for performance reporting.
+ *
+ * @param n - The duration in milliseconds.
+ * @returns A formatted duration string with appropriate units.
+ *
+ * @public
+ */
 export function formatDuration(n) {
     if (n < 1000) {
         return `${n.toString()} ms`;
@@ -100,9 +128,38 @@ export function formatDuration(n) {
 //     .replaceAll(/{/g, '&#123;') // MD
 //     .replaceAll(/}/g, '&#125;') // MD
 // }
+/**
+ * Removes empty lines from a text string.
+ *
+ * @remarks
+ * Eliminates lines that contain only whitespace characters, helping to
+ * clean up text content for documentation processing. This function is
+ * particularly useful for normalising content extracted from XML sources
+ * where formatting artefacts may introduce unwanted empty lines.
+ *
+ * @param text - The input text to process.
+ * @returns The text with empty lines removed.
+ *
+ * @public
+ */
 export function removeEmptyLines(text) {
     return text.replace(/^\s*$(?:\r\n?|\n)/gm, '');
 }
+/**
+ * Sanitises text for use in hierarchical URL paths.
+ *
+ * @remarks
+ * Transforms text into a URL-safe format suitable for hierarchical paths
+ * by converting to lowercase, removing spaces, encoding special characters,
+ * and preserving forward slashes for path structure. This function ensures
+ * that generated URLs are compatible with web standards whilst maintaining
+ * the hierarchical nature of documentation structures.
+ *
+ * @param text - The input text to sanitise.
+ * @returns A URL-safe hierarchical path string.
+ *
+ * @public
+ */
 // Preserve '/' too.
 export function sanitizeHierarchicalPath(text) {
     return text
@@ -116,30 +173,156 @@ export function sanitizeHierarchicalPath(text) {
         .replaceAll(/\)/g, '29')
         .replaceAll(/[^a-zA-Z0-9/-]/g, '-');
 }
+/**
+ * Sanitises anonymous namespace identifiers for better readability.
+ *
+ * @remarks
+ * Simplifies the representation of anonymous namespaces by removing
+ * redundant text whilst preserving the essential identifying information.
+ * This transformation improves the readability of documentation by reducing
+ * verbose namespace representations commonly generated by Doxygen.
+ *
+ * @param text - The namespace identifier to sanitise.
+ * @returns A cleaner namespace identifier.
+ *
+ * @public
+ */
 export function sanitizeAnonymousNamespace(text) {
     return text.replaceAll(/anonymous_namespace\{/g, 'anonymous{');
 }
+/**
+ * Flattens a hierarchical path by replacing separators with hyphens.
+ *
+ * @remarks
+ * Converts forward slashes to hyphens to create a flat string suitable
+ * for use in contexts where hierarchical separators are not appropriate.
+ * This is particularly useful for creating file names or identifiers
+ * that must not contain path separators whilst preserving readability.
+ *
+ * @param text - The hierarchical path to flatten.
+ * @returns A flattened path string with hyphens instead of slashes.
+ *
+ * @public
+ */
 export function flattenPath(text) {
     return text.replaceAll('/', '-');
 }
+/**
+ * Removes hexadecimal anchor suffixes from reference identifiers.
+ *
+ * @remarks
+ * Strips trailing hexadecimal anchor patterns from Doxygen reference
+ * identifiers to obtain the base reference without anchor information.
+ * This is essential for creating clean reference links whilst preserving
+ * the ability to extract anchor information separately when needed.
+ *
+ * @param refid - The reference identifier to process.
+ * @returns The reference identifier with hexadecimal anchor removed.
+ *
+ * @public
+ */
 export function stripPermalinkHexAnchor(refid) {
     return refid.replace(/_1[0-9a-fg]*$/, '');
 }
+/**
+ * Removes text anchor suffixes from reference identifiers.
+ *
+ * @remarks
+ * Strips trailing text-based anchor patterns from Doxygen reference
+ * identifiers to obtain the base reference without anchor information.
+ * This complements the hexadecimal anchor removal function by handling
+ * text-based anchor patterns that may appear in certain Doxygen outputs.
+ *
+ * @param refid - The reference identifier to process.
+ * @returns The reference identifier with text anchor removed.
+ *
+ * @public
+ */
 export function stripPermalinkTextAnchor(refid) {
     return refid.replace(/_1_[0-9a-z]*$/, '');
 }
+/**
+ * Removes leading newline characters from text.
+ *
+ * @remarks
+ * Strips newline characters from the beginning of a text string whilst
+ * preserving the remainder of the content. This function is useful for
+ * cleaning up text content that may have unwanted leading whitespace
+ * from XML parsing or template processing operations.
+ *
+ * @param text - The input text to process.
+ * @returns The text with leading newlines removed.
+ *
+ * @public
+ */
 export function stripLeadingNewLines(text) {
     return text.replace(/^[\r\n]+/, '');
 }
+/**
+ * Removes trailing whitespace and newline characters from text.
+ *
+ * @remarks
+ * Strips trailing spaces, carriage returns, and newlines from the end
+ * of a text string whilst preserving the main content. This function
+ * ensures clean text output by removing formatting artefacts that may
+ * interfere with proper Markdown rendering or display.
+ *
+ * @param text - The input text to process.
+ * @returns The text with trailing whitespace and newlines removed.
+ *
+ * @public
+ */
 export function stripTrailingNewLines(text) {
     return text.replace(/[ \r\n]+$/, '');
 }
+/**
+ * Removes both leading and trailing newline characters from text.
+ *
+ * @remarks
+ * Combines the functionality of stripping both leading and trailing
+ * newlines to clean up text content for processing. This comprehensive
+ * cleaning function is particularly useful for normalising content
+ * extracted from various sources that may have inconsistent whitespace.
+ *
+ * @param text - The input text to process.
+ * @returns The text with leading and trailing newlines removed.
+ *
+ * @public
+ */
 export function stripLeadingAndTrailingNewLines(text) {
     return text.replace(/^[\r\n]+/, '').replace(/[ \r\n]+$/, '');
 }
+/**
+ * Extracts the anchor portion from a reference identifier.
+ *
+ * @remarks
+ * Retrieves the anchor part of a Doxygen reference identifier by removing
+ * the base reference portion and returning only the anchor suffix. This
+ * function is essential for creating proper internal links within
+ * documentation pages where anchor-based navigation is required.
+ *
+ * @param refid - The reference identifier to process.
+ * @returns The anchor portion of the reference identifier.
+ *
+ * @public
+ */
 export function getPermalinkAnchor(refid) {
     return refid.replace(/^.*_1/, '');
 }
+/**
+ * Checks whether a folder exists at the specified path.
+ *
+ * @remarks
+ * Asynchronously verifies the existence of a directory at the given path
+ * and confirms that it is indeed a directory rather than a file. This
+ * function provides safe filesystem access with proper error handling
+ * for cases where the path does not exist or is inaccessible.
+ *
+ * @param folderPath - The path to check for folder existence.
+ * @returns A promise that resolves to true if the folder exists.
+ *
+ * @public
+ */
 export async function folderExists(folderPath) {
     try {
         const stat = await fs.stat(folderPath);
@@ -149,6 +332,23 @@ export async function folderExists(folderPath) {
         return false;
     }
 }
+/**
+ * Joins an array of strings with different delimiters for the final item.
+ *
+ * @remarks
+ * Concatenates array elements using a standard delimiter between most items
+ * and a special delimiter before the last item, useful for creating
+ * grammatically correct lists (e.g., "A, B, and C"). This function ensures
+ * proper English grammar in generated text whilst handling edge cases
+ * such as empty arrays and single-item arrays appropriately.
+ *
+ * @param arr - The array of strings to join.
+ * @param delimiter - The standard delimiter between items.
+ * @param lastDelimiter - The special delimiter before the last item.
+ * @returns The joined string with appropriate delimiters.
+ *
+ * @public
+ */
 export function joinWithLast(arr, delimiter, lastDelimiter) {
     if (arr.length === 0)
         return '';
@@ -156,6 +356,20 @@ export function joinWithLast(arr, delimiter, lastDelimiter) {
         return arr[0];
     return arr.slice(0, -1).join(delimiter) + lastDelimiter + arr[arr.length - 1];
 }
+/**
+ * Validates whether a string represents a valid URL.
+ *
+ * @remarks
+ * Attempts to construct a URL object from the input string to determine
+ * if it represents a valid, well-formed URL. This validation method
+ * leverages the native URL constructor's built-in validation capabilities
+ * to provide robust URL checking without implementing custom parsing logic.
+ *
+ * @param str - The string to validate as a URL.
+ * @returns True if the string is a valid URL, false otherwise.
+ *
+ * @public
+ */
 export function isUrl(str) {
     try {
         new URL(str);

package/dist/docusaurus/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/docusaurus/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAEtC,+EAA+E;AAE/E,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,qCAAqC;IACrC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;IAClC,kDAAkD;IAClD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAC7D,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IACtD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IACzD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAC7D,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAE7D,OAAO,CACL,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,KAAK,IAAI,GAAG,IAAI,KAAK,IAAI,OAAO,IAAI,OAAO,GAAG;QACpE,OAAO,CACR,CAAA;AACH,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,CAAS;IACtC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;QACb,OAAO,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAA;IAC7B,CAAC;SAAM,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC;QACtB,OAAO,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAA;IACvC,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAA;IACxC,CAAC;AACH,CAAC;AAED,+EAA+E;AAE/E,MAAM;AACN,gEAAgE;AAChE,8DAA8D;AAC9D,MAAM;AACN,qDAAqD;AACrD,gBAAgB;AAChB,mCAAmC;AACnC,kCAAkC;AAClC,kCAAkC;AAClC,oCAAoC;AACpC,mCAAmC;AACnC,mCAAmC;AACnC,kCAAkC;AAClC,kCAAkC;AAClC,kCAAkC;AAClC,kCAAkC;AAClC,kCAAkC;AAClC,mCAAmC;AACnC,uDAAuD;AACvD,yDAAyD;AACzD,IAAI;AAEJ,qDAAqD;AACrD,gBAAgB;AAChB,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AACjC,IAAI;AAEJ,MAAM;AACN,mEAAmE;AACnE,+DAA+D;AAC/D,MAAM;AACN,0DAA0D;AAC1D,gBAAgB;AAChB,iCAAiC;AACjC,gCAAgC;AAChC,gCAAgC;AAChC,gEAAgE;AAChE,gCAAgC;AAChC,gCAAgC;AAChC,qDAAqD;AACrD,uDAAuD;AACvD,oEAAoE;AACpE,IAAI;AAEJ,MAAM;AACN,gEAAgE;AAChE,MAAM;AACN,sDAAsD;AACtD,gBAAgB;AAChB,iCAAiC;AACjC,gCAAgC;AAChC,gCAAgC;AAChC,IAAI;AAEJ,wDAAwD;AACxD,gBAAgB;AAChB,kCAAkC;AAClC,IAAI;AAEJ,uBAAuB;AACvB,wDAAwD;AACxD,gBAAgB;AAChB,wCAAwC;AACxC,wCAAwC;AACxC,IAAI;AAEJ,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAA;AAChD,CAAC;AAED,oBAAoB;AACpB,MAAM,UAAU,wBAAwB,CAAC,IAAY;IACnD,OAAO,IAAI;SACR,WAAW,EAAE;SACb,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;SACvB,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;SACvB,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;SACtB,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;SACtB,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;SACtB,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;SACvB,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;SACvB,UAAU,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAA;AACvC,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,IAAY;IACrD,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAA;AAChE,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;AAClC,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,KAAa;IACnD,OAAO,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAA;AAC3C,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,KAAa;IACpD,OAAO,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAA;AAC3C,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;AACrC,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,IAAY;IAChD,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;AACtC,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,IAAY;IAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;AAC9D,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAa;IAC9C,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;AACnC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,UAAkB;IACnD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACtC,OAAO,IAAI,CAAC,WAAW,EAAE,CAAA;IAC3B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,GAAa,EACb,SAAiB,EACjB,aAAqB;IAErB,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IAC/B,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC,CAAC,CAAC,CAAA;IACnC,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,aAAa,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AAC/E,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,GAAW;IAC/B,IAAI,CAAC;QACH,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;QACZ,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED,+EAA+E"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/docusaurus/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAEtC,+EAA+E;AAE/E;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,qCAAqC;IACrC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;IAClC,kDAAkD;IAClD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAC7D,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IACtD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IACzD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAC7D,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAE7D,OAAO,CACL,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,KAAK,IAAI,GAAG,IAAI,KAAK,IAAI,OAAO,IAAI,OAAO,GAAG;QACpE,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,cAAc,CAAC,CAAS;IACtC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;QACb,OAAO,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAA;IAC7B,CAAC;SAAM,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC;QACtB,OAAO,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAA;IACvC,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAA;IACxC,CAAC;AACH,CAAC;AAED,+EAA+E;AAE/E,MAAM;AACN,gEAAgE;AAChE,8DAA8D;AAC9D,MAAM;AACN,qDAAqD;AACrD,gBAAgB;AAChB,mCAAmC;AACnC,kCAAkC;AAClC,kCAAkC;AAClC,oCAAoC;AACpC,mCAAmC;AACnC,mCAAmC;AACnC,kCAAkC;AAClC,kCAAkC;AAClC,kCAAkC;AAClC,kCAAkC;AAClC,kCAAkC;AAClC,mCAAmC;AACnC,uDAAuD;AACvD,yDAAyD;AACzD,IAAI;AAEJ,qDAAqD;AACrD,gBAAgB;AAChB,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AACjC,IAAI;AAEJ,MAAM;AACN,mEAAmE;AACnE,+DAA+D;AAC/D,MAAM;AACN,0DAA0D;AAC1D,gBAAgB;AAChB,iCAAiC;AACjC,gCAAgC;AAChC,gCAAgC;AAChC,gEAAgE;AAChE,gCAAgC;AAChC,gCAAgC;AAChC,qDAAqD;AACrD,uDAAuD;AACvD,oEAAoE;AACpE,IAAI;AAEJ,MAAM;AACN,gEAAgE;AAChE,MAAM;AACN,sDAAsD;AACtD,gBAAgB;AAChB,iCAAiC;AACjC,gCAAgC;AAChC,gCAAgC;AAChC,IAAI;AAEJ,wDAAwD;AACxD,gBAAgB;AAChB,kCAAkC;AAClC,IAAI;AAEJ,uBAAuB;AACvB,wDAAwD;AACxD,gBAAgB;AAChB,wCAAwC;AACxC,wCAAwC;AACxC,IAAI;AAEJ;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAA;AAChD,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,oBAAoB;AACpB,MAAM,UAAU,wBAAwB,CAAC,IAAY;IACnD,OAAO,IAAI;SACR,WAAW,EAAE;SACb,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;SACvB,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;SACvB,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;SACtB,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;SACtB,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC;SACtB,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;SACvB,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;SACvB,UAAU,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAA;AACvC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,0BAA0B,CAAC,IAAY;IACrD,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAA;AAChE,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;AAClC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,uBAAuB,CAAC,KAAa;IACnD,OAAO,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAA;AAC3C,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAa;IACpD,OAAO,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAA;AAC3C,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;AACrC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAY;IAChD,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;AACtC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,+BAA+B,CAAC,IAAY;IAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;AAC9D,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAa;IAC9C,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;AACnC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,UAAkB;IACnD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACtC,OAAO,IAAI,CAAC,WAAW,EAAE,CAAA;IAC3B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,YAAY,CAC1B,GAAa,EACb,SAAiB,EACjB,aAAqB;IAErB,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IAC/B,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC,CAAC,CAAC,CAAA;IACnC,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,aAAa,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AAC/E,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,KAAK,CAAC,GAAW;IAC/B,IAAI,CAAC;QACH,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;QACZ,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED,+EAA+E"}

package/dist/docusaurus/view-model/classes-vm.d.ts

@@ -1,35 +1,172 @@
 import { CompoundBase } from './compound-base-vm.js';
 import type { CompoundDefDataModel } from '../../doxygen/data-model/compounds/compounddef-dm.js';
 import { CollectionBase } from './collection-base.js';
-import type { MenuItem, SidebarCategory, FrontMatter } from '../types.js';
+import type { SidebarCategory, FrontMatter, NavbarItem } from '../types.js';
 import type { BaseCompoundRefDataModel, DerivedCompoundRefDataModel } from '../../doxygen/data-model/compounds/compoundreftype-dm.js';
 import type { TemplateParamListDataModel } from '../../doxygen/data-model/compounds/templateparamlisttype-dm.js';
+/**
+ * Manages the collection of class, struct, and union documentation.
+ *
+ * @remarks
+ * Handles the organisation and generation of class-type compound
+ * documentation, including hierarchy creation, sidebar generation,
+ * and index file creation. Supports inheritance relationships and
+ * alphabetical organisation.
+ *
+ * @public
+ */
 export declare class Classes extends CollectionBase {
+    /**
+     * Array of top-level classes without parent classes.
+     *
+     * @remarks
+     * Contains classes that are not derived from other documented classes,
+     * used for organising hierarchical displays and inheritance trees.
+     */
     topLevelClasses: Class[];
+    /**
+     * Adds a class compound to the collection.
+     *
+     * @remarks
+     * Creates a new Class instance from the compound definition and registers
+     * it in the collection for later processing and hierarchy creation.
+     *
+     * @param compoundDef - The compound definition for the class
+     * @returns The created Class instance
+     */
     addChild(compoundDef: CompoundDefDataModel): CompoundBase;
+    /**
+     * Creates hierarchical relationships between class compounds.
+     *
+     * @remarks
+     * Establishes parent-child relationships based on inheritance data,
+     * building the class hierarchy tree and identifying top-level classes
+     * that have no documented parent classes.
+     */
     createCompoundsHierarchies(): void;
     addSidebarItems(sidebarCategory: SidebarCategory): void;
+    /**
+     * Creates sidebar item for class hierarchy recursively.
+     *
+     * @remarks
+     * Generates hierarchical sidebar structures for class inheritance
+     * trees, creating category items for classes with children and
+     * document items for leaf classes. Handles sidebar label and ID
+     * generation with proper CSS classes.
+     *
+     * @param classs - The class to create sidebar item for
+     * @returns The sidebar item or undefined if class lacks required data
+     */
     private createSidebarItemRecursively;
-    createMenuItems(): MenuItem[];
+    createNavbarItems(): NavbarItem[];
     generateIndexDotMdFile(): Promise<void>;
+    /**
+     * Generates hierarchical index content for class documentation recursively.
+     *
+     * @remarks
+     * Creates HTML tree table rows for class hierarchies with proper
+     * indentation, icons, and descriptions. Processes inheritance
+     * relationships and generates nested table structures for parent-child
+     * class relationships.
+     *
+     * @param classs - The class to generate index content for
+     * @param depth - The current depth level in the hierarchy (1-based)
+     * @returns Array of HTML strings representing the tree table rows
+     */
     private generateIndexMdFileRecursively;
     generatePerInitialsIndexMdFiles(): Promise<void>;
 }
+/**
+ * Represents a single class, struct, or union compound for documentation.
+ *
+ * @remarks
+ * Manages individual class compound data including inheritance relationships,
+ * template parameters, member organisation, and documentation generation.
+ * Supports multiple inheritance, template specialisation, and hierarchical
+ * naming conventions for comprehensive class documentation.
+ *
+ * @public
+ */
 export declare class Class extends CompoundBase {
+    /** Set of base class IDs for inheritance tracking (multiple inheritance). */
     baseClassIds: Set<string>;
+    /** Array of resolved base class instances. */
     baseClasses: Class[];
+    /** Fully qualified class name including namespace hierarchy. */
     fullyQualifiedName: string;
+    /** Simple class name without namespace qualifiers. */
     unqualifiedName: string;
+    /** Template parameter specification string. */
     templateParameters: string;
+    /** Complete class name with rendered template parameters. */
     classFullName: string;
+    /** Rendered template declaration for display purposes. */
     template: string | undefined;
+    /** Direct reference to base compound data model objects. */
     baseCompoundRefs: BaseCompoundRefDataModel[] | undefined;
+    /** Direct reference to derived compound data model objects. */
     derivedCompoundRefs: DerivedCompoundRefDataModel[] | undefined;
+    /** Template parameter list from the compound definition. */
     templateParamList: TemplateParamListDataModel | undefined;
+    /**
+     * Creates a new Class instance from compound definition data.
+     *
+     * @remarks
+     * Initialises class metadata including inheritance relationships,
+     * template parameters, naming conventions, and URL structures.
+     * Processes fully qualified names, sidebar labels, and creates
+     * hierarchical path structures for documentation generation.
+     *
+     * @param collection - The parent Classes collection managing this class
+     * @param compoundDef - The Doxygen compound definition containing class data
+     */
     constructor(collection: Classes, compoundDef: CompoundDefDataModel);
+    /**
+     * Performs late-stage initialisation after all classes are loaded.
+     *
+     * @remarks
+     * Completes class setup by rendering template parameters to HTML,
+     * building full class names with template information, and storing
+     * references to compound definition objects for inheritance processing.
+     * Called after all compounds are registered.
+     */
     initializeLate(): void;
+    /**
+     * Determines whether the class has any content to display.
+     *
+     * @remarks
+     * Checks for the presence of child classes, inner compounds,
+     * member sections, include directives, or base class content
+     * to determine if the class documentation page should be
+     * generated and displayed.
+     *
+     * @returns True if the class has displayable content, false otherwise
+     */
     hasAnyContent(): boolean;
+    /**
+     * Renders the complete class documentation to markdown lines.
+     *
+     * @remarks
+     * Generates the full documentation page including class declaration,
+     * inheritance relationships, member indices, detailed descriptions,
+     * and location information. Handles base and derived class listings
+     * with proper HTML table formatting.
+     *
+     * @param frontMatter - The frontmatter configuration for the page
+     * @returns Array of markdown strings representing the complete documentation
+     */
     renderToLines(frontMatter: FrontMatter): string[];
+    /**
+     * Renders the class as an index entry for member listings.
+     *
+     * @remarks
+     * Creates HTML table rows suitable for inclusion in member indices,
+     * with links to the class documentation page and brief descriptions.
+     * Generates formatted entries with appropriate CSS classes and
+     * structure for index displays.
+     *
+     * @returns Array of HTML strings representing the index entry
+     */
     renderIndexToLines(): string[];
 }
 //# sourceMappingURL=classes-vm.d.ts.map

package/dist/docusaurus/view-model/classes-vm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"classes-vm.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/classes-vm.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAA;AAChG,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAMrD,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EAIf,WAAW,EACZ,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAC5B,MAAM,0DAA0D,CAAA;AACjE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,gEAAgE,CAAA;AAahH,qBAAa,OAAQ,SAAQ,cAAc;IAEzC,eAAe,EAAE,KAAK,EAAE,CAAK;IAYpB,QAAQ,CAAC,WAAW,EAAE,oBAAoB,GAAG,YAAY;IASzD,0BAA0B,IAAI,IAAI;IAwClC,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IA8FhE,OAAO,CAAC,4BAA4B;IAyC3B,eAAe,IAAI,QAAQ,EAAE;IAUvB,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IA6CtD,OAAO,CAAC,8BAA8B;IA8DvB,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC;CAiGhE;AAID,qBAAa,KAAM,SAAQ,YAAY;IAErC,YAAY,cAAoB;IAChC,WAAW,EAAE,KAAK,EAAE,CAAK;IAEzB,kBAAkB,SAAQ;IAC1B,eAAe,SAAQ;IACvB,kBAAkB,SAAK;IAEvB,aAAa,SAAQ;IACrB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IAI5B,gBAAgB,EAAE,wBAAwB,EAAE,GAAG,SAAS,CAAA;IACxD,mBAAmB,EAAE,2BAA2B,EAAE,GAAG,SAAS,CAAA;IAE9D,iBAAiB,EAAE,0BAA0B,GAAG,SAAS,CAAA;gBAI7C,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,oBAAoB;IAsFzD,cAAc,IAAI,IAAI;IAuCtB,aAAa,IAAI,OAAO;IAuBxB,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE;IAyP1D,kBAAkB,IAAI,MAAM,EAAE;CAiD/B"}
+{"version":3,"file":"classes-vm.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/classes-vm.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAA;AAChG,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAMrD,OAAO,KAAK,EACV,eAAe,EAIf,WAAW,EACX,UAAU,EACX,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAC5B,MAAM,0DAA0D,CAAA;AACjE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,gEAAgE,CAAA;AAoBhH;;;;;;;;;;GAUG;AACH,qBAAa,OAAQ,SAAQ,cAAc;IAEzC;;;;;;OAMG;IACH,eAAe,EAAE,KAAK,EAAE,CAAK;IAY7B;;;;;;;;;OASG;IACM,QAAQ,CAAC,WAAW,EAAE,oBAAoB,GAAG,YAAY;IASlE;;;;;;;OAOG;IACM,0BAA0B,IAAI,IAAI;IAwClC,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IA8FhE;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,4BAA4B;IAyC3B,iBAAiB,IAAI,UAAU,EAAE;IAU3B,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IA6CtD;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,8BAA8B;IA8DvB,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC;CAiGhE;AAID;;;;;;;;;;GAUG;AACH,qBAAa,KAAM,SAAQ,YAAY;IACrC,6EAA6E;IAC7E,YAAY,cAAoB;IAEhC,8CAA8C;IAC9C,WAAW,EAAE,KAAK,EAAE,CAAK;IAEzB,gEAAgE;IAChE,kBAAkB,SAAQ;IAE1B,sDAAsD;IACtD,eAAe,SAAQ;IAEvB,+CAA+C;IAC/C,kBAAkB,SAAK;IAEvB,6DAA6D;IAC7D,aAAa,SAAQ;IAErB,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IAE5B,4DAA4D;IAC5D,gBAAgB,EAAE,wBAAwB,EAAE,GAAG,SAAS,CAAA;IAExD,+DAA+D;IAC/D,mBAAmB,EAAE,2BAA2B,EAAE,GAAG,SAAS,CAAA;IAE9D,4DAA4D;IAC5D,iBAAiB,EAAE,0BAA0B,GAAG,SAAS,CAAA;IAIzD;;;;;;;;;;;OAWG;gBACS,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,oBAAoB;IAsFlE;;;;;;;;OAQG;IACM,cAAc,IAAI,IAAI;IAuC/B;;;;;;;;;;OAUG;IACM,aAAa,IAAI,OAAO;IAsBjC;;;;;;;;;;;OAWG;IAEM,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE;IAyP1D;;;;;;;;;;OAUG;IACH,kBAAkB,IAAI,MAAM,EAAE;CAiD/B"}