@xpack/doxygen2docusaurus 1.1.0 → 2.0.0

package/README.md

@@ -2,19 +2,19 @@
 [![NPM Version](https://img.shields.io/npm/v/@xpack/doxygen2docusaurus?color=blue)](https://www.npmjs.com/package/@xpack/doxygen2docusaurus/)
 [![license](https://img.shields.io/github/license/xpack/doxygen2docusaurus-cli-ts)](https://github.com/xpack/doxygen2docusaurus-cli-ts/blob/master/LICENSE)
 
-# The doxygen2docusaurus
+# The Doxygen Documentation Converter
 
 A Node.js CLI application to convert Doxygen XML files into Docusaurus documentation.
 
 ## Project documentation
 
 For information on how to install and use this project, please refer to the
-[project website](https://xpack.github.io/doxygen2docusaurus-cli-ts/).
+[project website](https://xpack.github.io/doxygen2docusaurus/).
 
 ## Project source
 
 The source code of the current release is available on
-[GitHub tag v1.0.2 tree](https://github.com/xpack/doxygen2docusaurus-cli-ts/tree/v1.0.2).
+[GitHub tag v1.1.0 tree](https://github.com/xpack/doxygen2docusaurus-cli-ts/tree/v1.1.0).
 
 ## License
 

package/dist/cli/main.d.ts

@@ -1,6 +1,12 @@
 /**
  * Main entry point for the doxygen2docusaurus CLI tool.
  *
+ * @remarks
+ * Orchestrates the complete conversion process from Doxygen XML to Docusaurus
+ * documentation. Handles command-line argument parsing, configuration loading,
+ * data model creation, workspace initialisation, and documentation generation.
+ * Provides timing information and appropriate exit codes for integration.
+ *
  * @param argv - Command line arguments array
  * @returns Promise that resolves to the exit code (0 for success, 1 for error)
  *

package/dist/cli/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/cli/main.ts"],"names":[],"mappings":"AA8BA;;;;;;;GAOG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CA2E1D"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/cli/main.ts"],"names":[],"mappings":"AA8BA;;;;;;;;;;;;;GAaG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CA2E1D"}

package/dist/cli/main.js

@@ -12,6 +12,7 @@
 // import assert from 'node:assert'
 import * as path from 'node:path';
 import * as fs from 'node:fs/promises';
+import { fileURLToPath } from 'node:url';
 // import * as util from 'node:util'
 // https://www.npmjs.com/package/commander
 import { CliOptions } from '../docusaurus/cli-options.js';
@@ -19,13 +20,18 @@ import { formatDuration } from '../docusaurus/utils.js';
 import { DataModel } from '../doxygen/data-model/data-model.js';
 import { DocusaurusGenerator } from '../docusaurus/generator.js';
 import { Workspace } from '../docusaurus/workspace.js';
-import { fileURLToPath } from 'node:url';
 // https://www.npmjs.com/package/commander
 import { Command } from 'commander';
 // ----------------------------------------------------------------------------
 /**
  * Main entry point for the doxygen2docusaurus CLI tool.
  *
+ * @remarks
+ * Orchestrates the complete conversion process from Doxygen XML to Docusaurus
+ * documentation. Handles command-line argument parsing, configuration loading,
+ * data model creation, workspace initialisation, and documentation generation.
+ * Provides timing information and appropriate exit codes for integration.
+ *
  * @param argv - Command line arguments array
  * @returns Promise that resolves to the exit code (0 for success, 1 for error)
  *

package/dist/cli/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../../src/cli/main.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,oCAAoC;AAEpC,0CAA0C;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAA;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAA;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACxC,0CAA0C;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,+EAA+E;AAE/E;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAc;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IAE5B,uCAAuC;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IAC9D,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EACrC,cAAc,CACf,CAAA;IACD,MAAM,kBAAkB,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;IAE7D,mEAAmE;IACnE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC7D,+GAA+G;IAC/G,MAAM,cAAc,GAAW,WAAW,CAAC,OAAO,CAAA;IAElD,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAA;IAE7B,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,4CAA4C,CAAC,CAAA;IAC3E,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAA;IACzE,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,2CAA2C,CAAC,CAAA;IACtE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,2BAA2B,CAAC,CAAA;IACxD,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAA;IAClD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAEnB,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,EAAE,CAAA;IAErC,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QAC3B,OAAO,CAAC,CAAA;IACV,CAAC;IAED,IAAI,cAAc,CAAC,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAW,CAAC,CAAA;IAC3C,CAAC;IAED,IAAI,WAAW,GAAW,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAA;IACxE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,WAAW,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;IAC9C,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,YAAY,WAAW,OAAO,cAAc,MAAM,CAAC,CAAA;IAE/D,MAAM,EAAE,GAAI,cAAc,CAAC,EAAyB,IAAI,SAAS,CAAA;IACjE,MAAM,OAAO,GAAG,cAAc,CAAC,OAA8B,CAAA;IAC7D,MAAM,KAAK,GAAG,cAAc,CAAC,KAA4B,CAAA;IAEzD,MAAM,cAAc,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;IAC7C,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,cAAc,CAAC,CAAA;IAC9C,MAAM,OAAO,CAAC,KAAK,EAAE,CAAA;IAErB,IAAI,QAAQ,GAAG,CAAC,CAAA;IAEhB,OAAO,CAAC,GAAG,EAAE,CAAA;IAEb,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAA;IACxC,MAAM,SAAS,CAAC,KAAK,EAAE,CAAA;IACvB,SAAS,CAAC,cAAc,GAAG,cAAc,CAAA;IAEzC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,SAAS,CAAC,CAAA;IAE1C,MAAM,SAAS,GAAG,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAA;IACpD,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,CAAA;IAEhC,MAAM,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAA;IAE7D,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,CAAC,GAAG,EAAE,CAAA;QACb,OAAO,CAAC,GAAG,CACT,YAAY,WAAW,+BAA+B;YACpD,MAAM,cAAc,GAAG,CAC1B,CAAA;IACH,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,+EAA+E"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../../src/cli/main.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACxC,oCAAoC;AAEpC,0CAA0C;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAA;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAA;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AACtD,0CAA0C;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,+EAA+E;AAE/E;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAc;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IAE5B,uCAAuC;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IAC9D,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EACrC,cAAc,CACf,CAAA;IACD,MAAM,kBAAkB,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;IAE7D,mEAAmE;IACnE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC7D,+GAA+G;IAC/G,MAAM,cAAc,GAAW,WAAW,CAAC,OAAO,CAAA;IAElD,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAA;IAE7B,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,4CAA4C,CAAC,CAAA;IAC3E,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAA;IACzE,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,2CAA2C,CAAC,CAAA;IACtE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,2BAA2B,CAAC,CAAA;IACxD,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAA;IAClD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAEnB,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,EAAE,CAAA;IAErC,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QAC3B,OAAO,CAAC,CAAA;IACV,CAAC;IAED,IAAI,cAAc,CAAC,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAW,CAAC,CAAA;IAC3C,CAAC;IAED,IAAI,WAAW,GAAW,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAA;IACxE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,WAAW,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;IAC9C,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,YAAY,WAAW,OAAO,cAAc,MAAM,CAAC,CAAA;IAE/D,MAAM,EAAE,GAAI,cAAc,CAAC,EAAyB,IAAI,SAAS,CAAA;IACjE,MAAM,OAAO,GAAG,cAAc,CAAC,OAA8B,CAAA;IAC7D,MAAM,KAAK,GAAG,cAAc,CAAC,KAA4B,CAAA;IAEzD,MAAM,cAAc,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;IAC7C,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,cAAc,CAAC,CAAA;IAC9C,MAAM,OAAO,CAAC,KAAK,EAAE,CAAA;IAErB,IAAI,QAAQ,GAAG,CAAC,CAAA;IAEhB,OAAO,CAAC,GAAG,EAAE,CAAA;IAEb,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAA;IACxC,MAAM,SAAS,CAAC,KAAK,EAAE,CAAA;IACvB,SAAS,CAAC,cAAc,GAAG,cAAc,CAAA;IAEzC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,SAAS,CAAC,CAAA;IAE1C,MAAM,SAAS,GAAG,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAA;IACpD,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,CAAA;IAEhC,MAAM,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAA;IAE7D,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,CAAC,GAAG,EAAE,CAAA;QACb,OAAO,CAAC,GAAG,CACT,YAAY,WAAW,+BAA+B;YACpD,MAAM,cAAc,GAAG,CAC1B,CAAA;IACH,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,+EAA+E"}

package/dist/docusaurus/cli-options.d.ts

@@ -1,97 +1,325 @@
+/**
+ * Redirect configuration for URL compatibility.
+ *
+ * @public
+ */
 export interface Redirects {
+    /** Source URL(s) to redirect from. */
     from: string | string[];
+    /** Target URL to redirect to. */
     to: string;
 }
 /**
- * Options, as written by the user. All are optional.
+ * Configuration options as specified by users in configuration files.
+ *
+ * @remarks
+ * All options are optional and can be either string or boolean values
+ * depending on the specific configuration property.
  *
  * @public
  */
 export type CliConfigurationOptions = Record<string, string | boolean>;
+/**
+ * Command line argument options passed to the application.
+ *
+ * @remarks
+ * Represents the parsed command line arguments with flexible typing
+ * to accommodate various option formats and undefined values.
+ *
+ * @public
+ */
 export type CommandOptions = Record<string, string | boolean | undefined>;
 /**
- * Options, when multi-configurations are used.
+ * Multiple configuration sets for different build scenarios.
+ *
+ * @remarks
+ * Allows defining different configuration profiles that can be selected
+ * based on the build context or command line parameters.
  *
  * @public
  */
 export type MultiConfigurations = Record<string, CliConfigurationOptions>;
 /**
- * Options, as seen by the application. Most are mandatory.
+ * Comprehensive CLI options class for documentation generation configuration.
+ *
+ * @remarks
+ * The CliOptions class contains all configuration parameters that control
+ * the behaviour of the doxygen2docusaurus conversion process, including
+ * paths, URLs, styling, and feature toggles.
  *
  * @public
  */
 export declare class CliOptions {
     /**
-     * Relative to the current website folder, like `doxygen/xml`, no initial/
-     * final slashes.
+     * Path to the Doxygen XML input folder relative to the website folder.
+     *
+     * @remarks
+     * Specifies the location of XML files generated by Doxygen, typically
+     * containing the parsed documentation data. Path should not include
+     * initial or final slashes.
+     *
+     * @defaultValue 'doxygen/xml'
      */
     doxygenXmlInputFolderPath: string;
     /**
-     * Relative to the current website folder, like `docs`, no initial/final
-     * slashes.
+     * Path to the documentation folder relative to the website folder.
+     *
+     * @remarks
+     * Defines the base folder where generated documentation will be placed
+     * within the Docusaurus website structure. Path should not include
+     * initial or final slashes.
+     *
+     * @defaultValue 'docs'
      */
     docsFolderPath: string;
-    /** Relative to the docs folder, like `api`, no initial/final slashes. */
+    /**
+     * Path to the API documentation folder relative to the docs folder.
+     *
+     * @remarks
+     * Specifies the subfolder within the docs folder where API reference
+     * documentation will be generated. Path should not include initial
+     * or final slashes.
+     *
+     * @defaultValue 'api'
+     */
     apiFolderPath: string;
-    /** Site base URL, like / or /xxx/. */
+    /**
+     * Base URL for the entire website.
+     *
+     * @remarks
+     * Defines the root URL path for the website, typically '/' for root
+     * deployment or '/project-name/' for GitHub Pages or similar hosting.
+     *
+     * @defaultValue '/'
+     */
     baseUrl: string;
-    /** Relative to the web home, like `docs`, without initial/final slashes. */
+    /**
+     * URL path to the documentation section relative to the website root.
+     *
+     * @remarks
+     * Specifies the URL segment that leads to the documentation section,
+     * without initial or final slashes. Used for navigation and linking.
+     *
+     * @defaultValue 'docs'
+     */
     docsBaseUrl: string;
-    /** Relative to the docs home, like `api`, without initial/final slashes. */
+    /**
+     * URL path to the API documentation relative to the docs section.
+     *
+     * @remarks
+     * Defines the URL segment for API documentation within the docs section,
+     * without initial or final slashes. Used for generating navigation links.
+     *
+     * @defaultValue 'api'
+     */
     apiBaseUrl: string;
-    /** Relative to `static` */
+    /**
+     * Path for images relative to the `static` folder.
+     *
+     * @remarks
+     * Specifies where Doxygen-generated images will be stored within the
+     * Docusaurus static assets folder structure.
+     *
+     * @defaultValue 'assets/images/doxygen'
+     */
     imagesFolderPath: string;
-    /**  Relative to the current `website/static` folder, like `reference`. */
+    /**
+     * Output folder for compatibility redirect files.
+     *
+     * @remarks
+     * Optional path relative to the website/static folder where HTML redirect
+     * files will be generated to maintain compatibility with original Doxygen
+     * URLs. When undefined, no redirect files are created.
+     */
     compatibilityRedirectsOutputFolderPath?: string | undefined;
-    /** The title to be displayed on the main page. */
+    /**
+     * Title displayed on the main API documentation page.
+     *
+     * @remarks
+     * When specified, this title overrides the default title generated from
+     * the project brief. When empty, the title is automatically constructed
+     * from the project configuration.
+     *
+     * @defaultValue ''
+     */
     mainPageTitle: string;
     /**
-     * Relative to the current website folder, default
-     * `sidebar-category-doxygen.json`.
+     * Path to the sidebar category configuration file.
+     *
+     * @remarks
+     * Specifies the location where the generated sidebar category JSON
+     * configuration will be written, relative to the current website folder.
+     *
+     * @defaultValue 'sidebar-category-doxygen.json'
      */
     sidebarCategoryFilePath: string;
-    /** Short text to be displayed in the sidebar. */
+    /**
+     * Label displayed in the Docusaurus sidebar for the API documentation.
+     *
+     * @remarks
+     * Short descriptive text that appears in the sidebar navigation to
+     * identify the API reference section.
+     *
+     * @defaultValue 'API Reference (Doxygen)'
+     */
     sidebarCategoryLabel: string;
     /**
-     * Relative to the current website folder, default
-     * `docusaurus-config-doxygen-menu-dropdown.json`.
+     * Path to the navbar configuration file.
+     *
+     * @remarks
+     * Specifies the location where the generated navbar dropdown JSON
+     * configuration will be written, relative to the current website folder.
+     *
+     * @defaultValue 'docusaurus-config-navbar-doxygen.json'
      */
-    menuDropdownFilePath: string;
-    /** Short text to be displayed in the menu. */
-    menuDropdownLabel: string;
+    navbarFilePath: string;
     /**
-     * Relative to the current website folder, default
-     * `src/css/custom-doxygen.css`
+     * Label displayed in the top navigation bar.
+     *
+     * @remarks
+     * Short text that appears in the Docusaurus top navigation bar to
+     * provide access to the API documentation section.
+     *
+     * @defaultValue 'Reference'
+     */
+    navbarLabel: string;
+    /**
+     * Position of the navigation menu in the top bar.
+     *
+     * @remarks
+     * Determines whether the API documentation menu appears on the left
+     * or right side of the Docusaurus navigation bar.
+     *
+     * @defaultValue 'left'
+     */
+    navbarPosition: 'left' | 'right';
+    /**
+     * Path to the custom CSS file for styling overrides.
+     *
+     * @remarks
+     * Specifies the location where custom CSS styles will be written to
+     * provide Doxygen-specific styling within the Docusaurus theme.
+     * Path is relative to the current website folder.
+     *
+     * @defaultValue 'src/css/custom-doxygen2docusaurus.css'
      */
     customCssFilePath: string;
-    /** Boolean to control verbosity. */
+    /**
+     * Controls verbose output during the conversion process.
+     *
+     * @remarks
+     * When enabled, provides detailed logging information about the
+     * conversion process, including file processing status and statistics.
+     *
+     * @defaultValue false
+     */
     verbose: boolean;
-    /** Boolean to control debug verbosity. */
+    /**
+     * Controls debug-level output during the conversion process.
+     *
+     * @remarks
+     * When enabled, provides extensive debugging information useful for
+     * troubleshooting issues. Automatically enables verbose output as well.
+     *
+     * @defaultValue false
+     */
     debug: boolean;
-    /** Boolean to control if the TODO suggestions are shown. */
+    /**
+     * Controls whether TODO suggestion descriptions are displayed.
+     *
+     * @remarks
+     * When enabled, shows suggestions for improvements or missing content
+     * that could enhance the generated documentation quality.
+     *
+     * @defaultValue false
+     */
     suggestToDoDescriptions: boolean;
-    /** Boolean to render the pages to the top. */
-    renderPagesAtTop: boolean;
-    /** Boolean to render the program listing in the File pages. */
+    /**
+     * Controls whether pages are listed at the top of the sidebar.
+     *
+     * @remarks
+     * When enabled, places page links prominently at the top of the sidebar
+     * navigation structure for easier access to important pages.
+     *
+     * @defaultValue true
+     */
+    listPagesAtTop: boolean;
+    /**
+     * Controls program listing rendering in File pages.
+     *
+     * @remarks
+     * When enabled, includes syntax-highlighted source code listings
+     * within the generated File documentation pages.
+     *
+     * @defaultValue true
+     */
     renderProgramListing: boolean;
     /**
-     * Boolean to render the program listing in the member definitions sections.
+     * Controls program listing rendering in member definition sections.
+     *
+     * @remarks
+     * When enabled, includes inline syntax-highlighted code snippets
+     * within member documentation sections for better context.
+     *
+     * @defaultValue true
      */
     renderProgramListingInline: boolean;
     /**
-     * Location of original Doxygen pages
+     * Note about the location of original Doxygen pages.
      *
-     * 'For comparison, the original Doxygen html pages, styled with the
-     * <a href="https://jothepro.github.io/doxygen-awesome-css/">doxygen-awesome-css</a>
-     * plugin, continue to be available via the
-     * <a href="pathname:///doxygen/topics.html"><code>.../doxygen/*.html</b></code>
-     * URLs.'
+     * @remarks
+     * Provides information about where to find the original Doxygen HTML
+     * pages for comparison purposes. When populated, this note is displayed
+     * to inform users about the availability of alternative documentation
+     * formats.
      */
     originalPagesNote: string;
-    /** String identifier in case of multiple instances. */
+    /**
+     * String identifier for distinguishing multiple configuration instances.
+     *
+     * @remarks
+     * Used when multiple configuration instances exist to provide unique
+     * identification. Particularly useful in multi-configuration scenarios
+     * where different settings need to be applied to different outputs.
+     *
+     * @defaultValue 'default'
+     */
     id: string;
+    /**
+     * Creates a new CliOptions instance with the specified command options.
+     *
+     * @remarks
+     * Initialises the configuration object by setting the ID and optional
+     * flags like verbose and debug. When the ID is not 'default', adjusts
+     * folder paths and file names to include the ID for multi-configuration
+     * scenarios.
+     *
+     * @param commandOptions - Command-line options object containing ID and flags
+     */
     constructor(commandOptions: CommandOptions);
+    /**
+     * Parses configuration options from various JSON configuration sources.
+     *
+     * @remarks
+     * Attempts to load configuration from multiple locations in order of
+     * preference: config/doxygen2docusaurus.json, doxygen2docusaurus.json,
+     * and package.json. Validates required properties and enables debug
+     * output if requested.
+     *
+     * @throws Assertion error if required configuration properties are missing
+     */
     parse(): Promise<void>;
+    /**
+     * Selects the appropriate configuration from multi-configuration options.
+     *
+     * @remarks
+     * When using a specific ID, returns the corresponding configuration.
+     * For the default ID, returns either the 'default' configuration or
+     * treats the entire object as a single configuration.
+     *
+     * @param multiConfigurations - Configuration object or multi-config map
+     * @returns Selected configuration options or undefined if not found
+     */
     selectMultiConfiguration(multiConfigurations: CliConfigurationOptions | MultiConfigurations): CliConfigurationOptions | undefined;
 }
 export declare const renderParagraphs = true;

package/dist/docusaurus/cli-options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli-options.d.ts","sourceRoot":"","sources":["../../src/docusaurus/cli-options.ts"],"names":[],"mappings":"AAoBA,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACvB,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAA;AAEtE,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAA;AAEzE;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;AAQzE;;;;GAIG;AACH,qBAAa,UAAU;IACrB;;;OAGG;IACH,yBAAyB,SAAgB;IAEzC;;;OAGG;IACH,cAAc,SAAS;IAEvB,yEAAyE;IACzE,aAAa,SAAQ;IAErB,sCAAsC;IACtC,OAAO,SAAM;IAEb,4EAA4E;IAC5E,WAAW,SAAS;IAEpB,4EAA4E;IAC5E,UAAU,SAAQ;IAElB,2BAA2B;IAC3B,gBAAgB,SAAgB;IAEhC,0EAA0E;IAC1E,sCAAsC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE3D,kDAAkD;IAClD,aAAa,SAAK;IAElB;;;OAGG;IACH,uBAAuB,SAAkC;IAEzD,iDAAiD;IACjD,oBAAoB,SAA4B;IAEhD;;;OAGG;IACH,oBAAoB,SAAwC;IAE5D,8CAA8C;IAC9C,iBAAiB,SAAc;IAE/B;;;OAGG;IACH,iBAAiB,SAA0C;IAE3D,oCAAoC;IACpC,OAAO,UAAQ;IAEf,0CAA0C;IAC1C,KAAK,UAAQ;IAEb,4DAA4D;IAC5D,uBAAuB,UAAQ;IAE/B,8CAA8C;IAC9C,gBAAgB,UAAO;IAEvB,+DAA+D;IAC/D,oBAAoB,UAAO;IAE3B;;OAEG;IACH,0BAA0B,UAAO;IAEjC;;;;;;;;OAQG;IACH,iBAAiB,SAAK;IAEtB,uDAAuD;IACvD,EAAE,SAAY;gBAEF,cAAc,EAAE,cAAc;IA4BpC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAuH5B,wBAAwB,CACtB,mBAAmB,EAAE,uBAAuB,GAAG,mBAAmB,GACjE,uBAAuB,GAAG,SAAS;CAkBvC;AAGD,eAAO,MAAM,gBAAgB,OAAO,CAAA;AAEpC,eAAO,MAAM,mBAAmB,KAAK,CAAA"}
+{"version":3,"file":"cli-options.d.ts","sourceRoot":"","sources":["../../src/docusaurus/cli-options.ts"],"names":[],"mappings":"AAoBA;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,sCAAsC;IACtC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACvB,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAA;AAEtE;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAA;AAEzE;;;;;;;;GAQG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;AAezE;;;;;;;;;GASG;AACH,qBAAa,UAAU;IACrB;;;;;;;;;OASG;IACH,yBAAyB,SAAgB;IAEzC;;;;;;;;;OASG;IACH,cAAc,SAAS;IAEvB;;;;;;;;;OASG;IACH,aAAa,SAAQ;IAErB;;;;;;;;OAQG;IACH,OAAO,SAAM;IAEb;;;;;;;;OAQG;IACH,WAAW,SAAS;IAEpB;;;;;;;;OAQG;IACH,UAAU,SAAQ;IAElB;;;;;;;;OAQG;IACH,gBAAgB,SAA0B;IAE1C;;;;;;;OAOG;IACH,sCAAsC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE3D;;;;;;;;;OASG;IACH,aAAa,SAAK;IAElB;;;;;;;;OAQG;IACH,uBAAuB,SAAkC;IAEzD;;;;;;;;OAQG;IACH,oBAAoB,SAA4B;IAEhD;;;;;;;;OAQG;IACH,cAAc,SAA0C;IAExD;;;;;;;;OAQG;IACH,WAAW,SAAc;IAEzB;;;;;;;;OAQG;IACH,cAAc,EAAE,MAAM,GAAG,OAAO,CAAS;IAEzC;;;;;;;;;OASG;IACH,iBAAiB,SAA0C;IAE3D;;;;;;;;OAQG;IACH,OAAO,UAAQ;IAEf;;;;;;;;OAQG;IACH,KAAK,UAAQ;IAEb;;;;;;;;OAQG;IACH,uBAAuB,UAAQ;IAE/B;;;;;;;;OAQG;IACH,cAAc,UAAO;IAErB;;;;;;;;OAQG;IACH,oBAAoB,UAAO;IAE3B;;;;;;;;OAQG;IACH,0BAA0B,UAAO;IAEjC;;;;;;;;OAQG;IACH,iBAAiB,SAAK;IAEtB;;;;;;;;;OASG;IACH,EAAE,SAAY;IAEd;;;;;;;;;;OAUG;gBACS,cAAc,EAAE,cAAc;IA4B1C;;;;;;;;;;OAUG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAsH5B;;;;;;;;;;OAUG;IACH,wBAAwB,CACtB,mBAAmB,EAAE,uBAAuB,GAAG,mBAAmB,GACjE,uBAAuB,GAAG,SAAS;CAsBvC;AAGD,eAAO,MAAM,gBAAgB,OAAO,CAAA;AAGpC,eAAO,MAAM,mBAAmB,KAAK,CAAA"}