@xpack/doxygen2docusaurus 2.0.0 → 2.1.0

package/dist/docusaurus/view-model/options.d.ts

@@ -1,51 +1,8 @@
 import type { DoxygenFileOptionDataModel } from '../../doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js';
-/**
- * Manages Doxygen file configuration options and provides access methods.
- *
- * @remarks
- * Organises Doxygen configuration options by identifier and provides
- * convenient methods for retrieving option values in different formats.
- * Used to access project-specific settings from the Doxygen configuration.
- *
- * @public
- */
 export declare class DoxygenFileOptions {
     membersById: Map<string, DoxygenFileOptionDataModel>;
-    /**
-     * Creates a new Doxygen file options manager.
-     *
-     * @remarks
-     * Builds an indexed map of configuration options for efficient lookup
-     * by option identifier. Validates that options are provided.
-     *
-     * @param options - Array of Doxygen file option data models
-     * @throws Assertion error if options array is undefined
-     */
     constructor(options: DoxygenFileOptionDataModel[] | undefined);
-    /**
-     * Retrieves a string option value by identifier.
-     *
-     * @remarks
-     * Extracts the raw string value from a Doxygen configuration option.
-     * Validates that the option exists and contains exactly one string value.
-     *
-     * @param optionId - Identifier of the configuration option
-     * @returns The string value of the specified option
-     * @throws Assertion error if option is missing or has invalid format
-     */
     getOptionStringValue(optionId: string): string;
-    /**
-     * Retrieves a CDATA option value with quote removal.
-     *
-     * @remarks
-     * Extracts the string value from a Doxygen configuration option and
-     * removes surrounding double quotes that are commonly present in
-     * CDATA sections. Useful for path and string configuration values.
-     *
-     * @param optionId - Identifier of the configuration option
-     * @returns The unquoted string value of the specified option
-     * @throws Assertion error if option is missing or has invalid format
-     */
     getOptionCdataValue(optionId: string): string;
 }
 //# sourceMappingURL=options.d.ts.map

package/dist/docusaurus/view-model/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/options.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,4DAA4D,CAAA;AAI5G;;;;;;;;;GASG;AACH,qBAAa,kBAAkB;IAC7B,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;IAEpD;;;;;;;;;OASG;gBACS,OAAO,EAAE,0BAA0B,EAAE,GAAG,SAAS;IAS7D;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAS9C;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;CAQ9C"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/options.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,4DAA4D,CAAA;AAc5G,qBAAa,kBAAkB;IAC7B,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;gBAYxC,OAAO,EAAE,0BAA0B,EAAE,GAAG,SAAS;IAoB7D,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAqB9C,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;CAQ9C"}

package/dist/docusaurus/view-model/options.js

@@ -1,39 +1,6 @@
-/*
- * This file is part of the xPack project (http://xpack.github.io).
- * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose is hereby granted, under the terms of the MIT license.
- *
- * If a copy of the license was not distributed with this file, it can
- * be obtained from https://opensource.org/licenses/MIT.
- */
-// ----------------------------------------------------------------------------
-// import * as util from 'node:util'
 import assert from 'node:assert';
-// ----------------------------------------------------------------------------
-/**
- * Manages Doxygen file configuration options and provides access methods.
- *
- * @remarks
- * Organises Doxygen configuration options by identifier and provides
- * convenient methods for retrieving option values in different formats.
- * Used to access project-specific settings from the Doxygen configuration.
- *
- * @public
- */
 export class DoxygenFileOptions {
     membersById;
-    /**
-     * Creates a new Doxygen file options manager.
-     *
-     * @remarks
-     * Builds an indexed map of configuration options for efficient lookup
-     * by option identifier. Validates that options are provided.
-     *
-     * @param options - Array of Doxygen file option data models
-     * @throws Assertion error if options array is undefined
-     */
     constructor(options) {
         this.membersById = new Map();
         assert(options !== undefined);
@@ -41,17 +8,6 @@ export class DoxygenFileOptions {
             this.membersById.set(option.id, option);
         }
     }
-    /**
-     * Retrieves a string option value by identifier.
-     *
-     * @remarks
-     * Extracts the raw string value from a Doxygen configuration option.
-     * Validates that the option exists and contains exactly one string value.
-     *
-     * @param optionId - Identifier of the configuration option
-     * @returns The string value of the specified option
-     * @throws Assertion error if option is missing or has invalid format
-     */
     getOptionStringValue(optionId) {
         const option = this.membersById.get(optionId);
         assert(option !== undefined);
@@ -60,18 +16,6 @@ export class DoxygenFileOptions {
         assert(typeof option.values[0] === 'string');
         return option.values[0];
     }
-    /**
-     * Retrieves a CDATA option value with quote removal.
-     *
-     * @remarks
-     * Extracts the string value from a Doxygen configuration option and
-     * removes surrounding double quotes that are commonly present in
-     * CDATA sections. Useful for path and string configuration values.
-     *
-     * @param optionId - Identifier of the configuration option
-     * @returns The unquoted string value of the specified option
-     * @throws Assertion error if option is missing or has invalid format
-     */
     getOptionCdataValue(optionId) {
         const option = this.membersById.get(optionId);
         assert(option !== undefined);
@@ -81,5 +25,4 @@ export class DoxygenFileOptions {
         return option.values[0].replace(/^"/, '').replace(/"$/, '');
     }
 }
-// ----------------------------------------------------------------------------
 //# sourceMappingURL=options.js.map

package/dist/docusaurus/view-model/options.js.map

@@ -1 +1 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,oCAAoC;AACpC,OAAO,MAAM,MAAM,aAAa,CAAA;AAIhC,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,kBAAkB;IAC7B,WAAW,CAAyC;IAEpD;;;;;;;;;OASG;IACH,YAAY,OAAiD;QAC3D,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAA;QAE5B,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAA;QAC7B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;QACzC,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,QAAgB;QACnC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7C,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAA;QAC5B,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAA;QACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;QAClC,MAAM,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAA;QAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACzB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAC,QAAgB;QAClC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7C,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAA;QAC5B,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAA;QACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;QAClC,MAAM,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAA;QAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IAC7D,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/options.ts"],"names":[],"mappings":"AAcA,OAAO,MAAM,MAAM,aAAa,CAAA;AAgBhC,MAAM,OAAO,kBAAkB;IAC7B,WAAW,CAAyC;IAYpD,YAAY,OAAiD;QAC3D,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAA;QAE5B,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAA;QAC7B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;QACzC,CAAC;IACH,CAAC;IAaD,oBAAoB,CAAC,QAAgB;QACnC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7C,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAA;QAC5B,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAA;QACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;QAClC,MAAM,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAA;QAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACzB,CAAC;IAcD,mBAAmB,CAAC,QAAgB;QAClC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7C,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAA;QAC5B,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAA;QACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;QAClC,MAAM,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAA;QAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IAC7D,CAAC;CACF"}

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

@@ -2,132 +2,17 @@ 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 { NavbarItem, SidebarCategory, FrontMatter } from '../types.js';
-/**
- * Manages documentation pages collection for the generated site.
- *
- * @remarks
- * Handles the organisation and generation of standalone documentation
- * pages that are not part of the main API reference, such as the
- * main project page and custom documentation pages.
- *
- * @public
- */
 export declare class Pages extends CollectionBase {
-    /**
-     * Adds a page compound to the collection.
-     *
-     * @remarks
-     * Creates a new Page instance from the compound definition and registers
-     * it in the collection. Special handling is provided for the main index
-     * page which becomes the workspace's main page.
-     *
-     * @param compoundDef - The compound definition for the page
-     * @returns The created Page instance
-     */
     addChild(compoundDef: CompoundDefDataModel): CompoundBase;
-    /**
-     * Creates hierarchical relationships between page compounds.
-     *
-     * @remarks
-     * Pages do not have hierarchical relationships, so this method
-     * performs no operations. Pages are organised as a flat collection.
-     */
     createCompoundsHierarchies(): void;
-    /**
-     * Adds page items to the sidebar navigation structure.
-     *
-     * @remarks
-     * Creates a "Pages" category in the sidebar and populates it with
-     * page entries. Top-level pages may be excluded based on configuration
-     * settings when they are displayed at the top of the sidebar.
-     *
-     * @param sidebarCategory - The main sidebar category to populate
-     */
     addSidebarItems(sidebarCategory: SidebarCategory): void;
-    /**
-     * Creates sidebar items for top-level pages at the root level.
-     *
-     * @remarks
-     * Conditionally adds page items directly to the main sidebar category
-     * when the configuration option to display pages at the top is enabled.
-     * This provides prominent placement for important pages outside the
-     * standard pages category.
-     *
-     * @param sidebarCategory - The main sidebar category to populate
-     */
     createTopPagesSidebarItems(sidebarCategory: SidebarCategory): void;
-    /**
-     * Creates navigation bar items for pages.
-     *
-     * @remarks
-     * Pages do not appear in the navigation bar by design, so this method
-     * returns an empty array. The workspace's main navigation is handled
-     * by other compound types such as namespaces and classes.
-     *
-     * @returns An empty array as pages are not included in navigation
-     */
     createNavbarItems(): NavbarItem[];
-    /**
-     * Generates index file for pages collection.
-     *
-     * @remarks
-     * Pages do not have a dedicated index file as they are organised
-     * as individual standalone documents. This method performs no
-     * operations to maintain interface consistency.
-     *
-     * @returns Promise that resolves immediately
-     */
     generateIndexDotMdFile(): Promise<void>;
 }
-/**
- * Represents an individual documentation page in the generated site.
- *
- * @remarks
- * Handles standalone documentation pages that are not part of the main
- * API reference structure. Pages can include special content such as
- * the main project page, deprecated items, and custom documentation.
- * The class manages permalink generation, sidebar positioning, and
- * content rendering for these standalone documents.
- *
- * @public
- */
 export declare class Page extends CompoundBase {
-    /**
-     * Initialises a new Page instance.
-     *
-     * @remarks
-     * Constructs the page with appropriate labels, permalinks, and identifiers
-     * based on the compound definition. The page title is derived from the
-     * compound's title, and relative permalinks are generated using sanitised
-     * paths to ensure valid URLs.
-     *
-     * @param collection - The parent pages collection
-     * @param compoundDef - The compound definition containing page data
-     */
     constructor(collection: Pages, compoundDef: CompoundDefDataModel);
-    /**
-     * Determines whether the page should be displayed at the top level.
-     *
-     * @remarks
-     * Special pages such as 'deprecated' and 'todo' are excluded from
-     * top-level display as they are considered auxiliary content.
-     * All other pages are eligible for prominent placement.
-     *
-     * @returns True if the page should appear at the top level
-     */
     isTopPage(): boolean;
-    /**
-     * Renders the page content to markdown lines.
-     *
-     * @remarks
-     * Generates the complete page content including brief descriptions,
-     * inner indices, section indices, detailed descriptions, and sections.
-     * A 'more' permalink is provided when detailed descriptions are available
-     * to enable navigation to the detailed content section.
-     *
-     * @param frontMatter - The front matter configuration for the page
-     * @returns Array of markdown lines representing the complete page content
-     */
     renderToLines(frontMatter: FrontMatter): string[];
 }
 //# sourceMappingURL=pages-vm.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"pages-vm.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/pages-vm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAA;AAEhG,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EACV,UAAU,EACV,eAAe,EAGf,WAAW,EACZ,MAAM,aAAa,CAAA;AAIpB;;;;;;;;;GASG;AACH,qBAAa,KAAM,SAAQ,cAAc;IAavC;;;;;;;;;;OAUG;IACM,QAAQ,CAAC,WAAW,EAAE,oBAAoB,GAAG,YAAY;IAYlE;;;;;;OAMG;IACM,0BAA0B,IAAI,IAAI;IAM3C;;;;;;;;;OASG;IACM,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IA4ChE;;;;;;;;;;OAUG;IACH,0BAA0B,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IAgClE;;;;;;;;;OASG;IACM,iBAAiB,IAAI,UAAU,EAAE;IAQ1C;;;;;;;;;OASG;IACY,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;CAGvD;AAID;;;;;;;;;;;GAWG;AACH,qBAAa,IAAK,SAAQ,YAAY;IACpC;;;;;;;;;;;OAWG;gBACS,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE,oBAAoB;IAgChE;;;;;;;;;OASG;IACH,SAAS,IAAI,OAAO;IASpB;;;;;;;;;;;OAWG;IAEM,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE;CA6B3D"}
+{"version":3,"file":"pages-vm.d.ts","sourceRoot":"","sources":["../../../src/docusaurus/view-model/pages-vm.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAA;AAEhG,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EACV,UAAU,EACV,eAAe,EAGf,WAAW,EACZ,MAAM,aAAa,CAAA;AAcpB,qBAAa,KAAM,SAAQ,cAAc;IAwB9B,QAAQ,CAAC,WAAW,EAAE,oBAAoB,GAAG,YAAY;IAmBzD,0BAA0B,IAAI,IAAI;IAgBlC,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IAuDhE,0BAA0B,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IA0CzD,iBAAiB,IAAI,UAAU,EAAE;IAkB3B,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;CAGvD;AAgBD,qBAAa,IAAK,SAAQ,YAAY;gBAaxB,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE,oBAAoB;IA0ChE,SAAS,IAAI,OAAO;IAsBX,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE;CA6B3D"}

package/dist/docusaurus/view-model/pages-vm.js

@@ -1,49 +1,8 @@
-/*
- * This file is part of the xPack project (http://xpack.github.io).
- * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose is hereby granted, under the terms of the MIT license.
- *
- * If a copy of the license was not distributed with this file, it can
- * be obtained from https://opensource.org/licenses/MIT.
- */
-// ----------------------------------------------------------------------------
-// import * as util from 'node:util'
 import assert from 'node:assert';
 import { CompoundBase } from './compound-base-vm.js';
 import { flattenPath, sanitizeHierarchicalPath } from '../utils.js';
 import { CollectionBase } from './collection-base.js';
-// ----------------------------------------------------------------------------
-/**
- * Manages documentation pages collection for the generated site.
- *
- * @remarks
- * Handles the organisation and generation of standalone documentation
- * pages that are not part of the main API reference, such as the
- * main project page and custom documentation pages.
- *
- * @public
- */
 export class Pages extends CollectionBase {
-    // compoundsById: Map<string, Page>
-    // --------------------------------------------------------------------------
-    // constructor (workspace: Workspace) {
-    //   super(workspace)
-    //   // this.compoundsById = new Map()
-    // }
-    // --------------------------------------------------------------------------
-    /**
-     * Adds a page compound to the collection.
-     *
-     * @remarks
-     * Creates a new Page instance from the compound definition and registers
-     * it in the collection. Special handling is provided for the main index
-     * page which becomes the workspace's main page.
-     *
-     * @param compoundDef - The compound definition for the page
-     * @returns The created Page instance
-     */
     addChild(compoundDef) {
         const page = new Page(this, compoundDef);
         this.collectionCompoundsById.set(page.id, page);
@@ -52,35 +11,12 @@ export class Pages extends CollectionBase {
         }
         return page;
     }
-    // --------------------------------------------------------------------------
-    /**
-     * Creates hierarchical relationships between page compounds.
-     *
-     * @remarks
-     * Pages do not have hierarchical relationships, so this method
-     * performs no operations. Pages are organised as a flat collection.
-     */
     createCompoundsHierarchies() {
-        // There are no pages hierarchies.
     }
-    // --------------------------------------------------------------------------
-    /**
-     * Adds page items to the sidebar navigation structure.
-     *
-     * @remarks
-     * Creates a "Pages" category in the sidebar and populates it with
-     * page entries. Top-level pages may be excluded based on configuration
-     * settings when they are displayed at the top of the sidebar.
-     *
-     * @param sidebarCategory - The main sidebar category to populate
-     */
     addSidebarItems(sidebarCategory) {
-        // Add pages to the sidebar.
-        // They are organised as a flat list, no hierarchies.
         const pagesCategory = {
             type: 'category',
             label: 'Pages',
-            // There is no index page.
             collapsed: true,
             items: [],
         };
@@ -109,25 +45,11 @@ export class Pages extends CollectionBase {
             sidebarCategory.items.push(pagesCategory);
         }
     }
-    /**
-     * Creates sidebar items for top-level pages at the root level.
-     *
-     * @remarks
-     * Conditionally adds page items directly to the main sidebar category
-     * when the configuration option to display pages at the top is enabled.
-     * This provides prominent placement for important pages outside the
-     * standard pages category.
-     *
-     * @param sidebarCategory - The main sidebar category to populate
-     */
     createTopPagesSidebarItems(sidebarCategory) {
-        // Add pages to the sidebar.
         if (!this.workspace.options.listPagesAtTop) {
-            // Do not list pages at the top of the sidebar.
             return;
         }
         for (const [pageId, page] of this.collectionCompoundsById) {
-            // Skip special pages.
             if (pageId === 'indexpage' ||
                 !(page instanceof Page && page.isTopPage())) {
                 continue;
@@ -143,63 +65,13 @@ export class Pages extends CollectionBase {
             sidebarCategory.items.push(docItem);
         }
     }
-    // --------------------------------------------------------------------------
-    /**
-     * Creates navigation bar items for pages.
-     *
-     * @remarks
-     * Pages do not appear in the navigation bar by design, so this method
-     * returns an empty array. The workspace's main navigation is handled
-     * by other compound types such as namespaces and classes.
-     *
-     * @returns An empty array as pages are not included in navigation
-     */
     createNavbarItems() {
-        // Pages do not show on the menu.
-        // Reference 'this' to satisfy the linter.
         return [];
     }
-    // --------------------------------------------------------------------------
-    /**
-     * Generates index file for pages collection.
-     *
-     * @remarks
-     * Pages do not have a dedicated index file as they are organised
-     * as individual standalone documents. This method performs no
-     * operations to maintain interface consistency.
-     *
-     * @returns Promise that resolves immediately
-     */
     async generateIndexDotMdFile() {
-        // There is no pages index.
     }
 }
-// ----------------------------------------------------------------------------
-/**
- * Represents an individual documentation page in the generated site.
- *
- * @remarks
- * Handles standalone documentation pages that are not part of the main
- * API reference structure. Pages can include special content such as
- * the main project page, deprecated items, and custom documentation.
- * The class manages permalink generation, sidebar positioning, and
- * content rendering for these standalone documents.
- *
- * @public
- */
 export class Page extends CompoundBase {
-    /**
-     * Initialises a new Page instance.
-     *
-     * @remarks
-     * Constructs the page with appropriate labels, permalinks, and identifiers
-     * based on the compound definition. The page title is derived from the
-     * compound's title, and relative permalinks are generated using sanitised
-     * paths to ensure valid URLs.
-     *
-     * @param collection - The parent pages collection
-     * @param compoundDef - The compound definition containing page data
-     */
     constructor(collection, compoundDef) {
         super(collection, compoundDef);
         const { title } = compoundDef;
@@ -212,47 +84,14 @@ export class Page extends CompoundBase {
         const sanitizedPath = sanitizeHierarchicalPath(this.compoundName);
         this.relativePermalink = `pages/${sanitizedPath}`;
         this.sidebarId = `pages/${flattenPath(sanitizedPath)}`;
-        // SectionDefs for pages?
         assert(compoundDef.sectionDefs === undefined);
-        // console.log('0', this.id)
-        // console.log('1', this.compoundName)
-        // console.log('2', this.relativePermalink)
-        // console.log('3', this.docusaurusId)
-        // console.log('4', this.sidebarLabel)
-        // console.log('5', this.indexName)
-        // console.log()
     }
-    // --------------------------------------------------------------------------
-    /**
-     * Determines whether the page should be displayed at the top level.
-     *
-     * @remarks
-     * Special pages such as 'deprecated' and 'todo' are excluded from
-     * top-level display as they are considered auxiliary content.
-     * All other pages are eligible for prominent placement.
-     *
-     * @returns True if the page should appear at the top level
-     */
     isTopPage() {
         if (this.id === 'deprecated' || this.id === 'todo') {
             return false;
         }
         return true;
     }
-    // --------------------------------------------------------------------------
-    /**
-     * Renders the page content to markdown lines.
-     *
-     * @remarks
-     * Generates the complete page content including brief descriptions,
-     * inner indices, section indices, detailed descriptions, and sections.
-     * A 'more' permalink is provided when detailed descriptions are available
-     * to enable navigation to the detailed content section.
-     *
-     * @param frontMatter - The front matter configuration for the page
-     * @returns Array of markdown lines representing the complete page content
-     */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     renderToLines(frontMatter) {
         const lines = [];
         const morePermalink = this.detailedDescriptionHtmlLines !== undefined ? '#details' : undefined;
@@ -271,5 +110,4 @@ export class Page extends CompoundBase {
         return lines;
     }
 }
-// ----------------------------------------------------------------------------
 //# sourceMappingURL=pages-vm.js.map

package/dist/docusaurus/view-model/pages-vm.js.map

@@ -1 +1 @@
-{"version":3,"file":"pages-vm.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/pages-vm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,oCAAoC;AACpC,OAAO,MAAM,MAAM,aAAa,CAAA;AAEhC,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEpD,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AASrD,+EAA+E;AAE/E;;;;;;;;;GASG;AACH,MAAM,OAAO,KAAM,SAAQ,cAAc;IACvC,mCAAmC;IAEnC,6EAA6E;IAE7E,uCAAuC;IACvC,qBAAqB;IAErB,sCAAsC;IACtC,IAAI;IAEJ,6EAA6E;IAE7E;;;;;;;;;;OAUG;IACM,QAAQ,CAAC,WAAiC;QACjD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;QACxC,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;QAE/C,IAAI,IAAI,CAAC,EAAE,KAAK,WAAW,EAAE,CAAC;YAC5B,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAA;QAChC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,6EAA6E;IAE7E;;;;;;OAMG;IACM,0BAA0B;QACjC,kCAAkC;IACpC,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACM,eAAe,CAAC,eAAgC;QACvD,4BAA4B;QAC5B,qDAAqD;QACrD,MAAM,aAAa,GAAwB;YACzC,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,OAAO;YACd,0BAA0B;YAC1B,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,EAAE;SACV,CAAA;QAED,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC1D,IACE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc;gBACrC,IAAI,YAAY,IAAI;gBACpB,IAAI,CAAC,SAAS,EAAE,EAChB,CAAC;gBACD,SAAQ;YACV,CAAC;YAED,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;gBAC3B,SAAQ;YACV,CAAC;YAED,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;YAC7B,IAAI,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC/D,SAAQ;YACV,CAAC;YAED,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAA;YACxD,MAAM,OAAO,GAAmB;gBAC9B,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,YAAY;gBACnB,EAAE;aACH,CAAA;YAED,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnC,CAAC;QAED,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,0BAA0B,CAAC,eAAgC;QACzD,4BAA4B;QAC5B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3C,+CAA+C;YAC/C,OAAM;QACR,CAAC;QAED,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC1D,sBAAsB;YACtB,IACE,MAAM,KAAK,WAAW;gBACtB,CAAC,CAAC,IAAI,YAAY,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,EAC3C,CAAC;gBACD,SAAQ;YACV,CAAC;YAED,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBACpE,SAAQ;YACV,CAAC;YAED,MAAM,OAAO,GAAmB;gBAC9B,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,IAAI,CAAC,YAAY;gBACxB,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,EAAE;aACvD,CAAA;YAED,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrC,CAAC;IACH,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACM,iBAAiB;QACxB,iCAAiC;QACjC,0CAA0C;QAC1C,OAAO,EAAE,CAAA;IACX,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACM,KAAK,CAAC,sBAAsB;QACnC,2BAA2B;IAC7B,CAAC;CACF;AAED,+EAA+E;AAE/E;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,IAAK,SAAQ,YAAY;IACpC;;;;;;;;;;;OAWG;IACH,YAAY,UAAiB,EAAE,WAAiC;QAC9D,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;QAE9B,MAAM,EAAE,KAAK,EAAE,GAAG,WAAW,CAAA;QAC7B,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAA;QAC3B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QAEnD,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;QAC7B,IAAI,CAAC,SAAS,GAAG,YAAY,CAAA;QAC7B,IAAI,CAAC,aAAa,GAAG,YAAY,CAAA;QAEjC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAA;QAE7B,MAAM,aAAa,GAAW,wBAAwB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACzE,IAAI,CAAC,iBAAiB,GAAG,SAAS,aAAa,EAAE,CAAA;QAEjD,IAAI,CAAC,SAAS,GAAG,SAAS,WAAW,CAAC,aAAa,CAAC,EAAE,CAAA;QAEtD,yBAAyB;QACzB,MAAM,CAAC,WAAW,CAAC,WAAW,KAAK,SAAS,CAAC,CAAA;QAE7C,4BAA4B;QAC5B,sCAAsC;QACtC,2CAA2C;QAC3C,sCAAsC;QACtC,sCAAsC;QACtC,mCAAmC;QACnC,gBAAgB;IAClB,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;OASG;IACH,SAAS;QACP,IAAI,IAAI,CAAC,EAAE,KAAK,YAAY,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;YACnD,OAAO,KAAK,CAAA;QACd,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;;;OAWG;IACH,6DAA6D;IACpD,aAAa,CAAC,WAAwB;QAC7C,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,aAAa,GACjB,IAAI,CAAC,4BAA4B,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAA;QAE1E,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,kCAAkC,CAAC;YACtC,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,aAAa;SACd,CAAC,CACH,CAAA;QAED,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC,CAAA;QAEjD,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,2BAA2B,EAAE,CAAC,CAAA;QAEjD,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,oCAAoC,CAAC;YAC3C,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,4BAA4B,EAAE,IAAI,CAAC,4BAA4B;YAC/D,UAAU,EAAE,KAAK;SAClB,CAAC,CACH,CAAA;QAED,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA;QAE3C,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,+EAA+E"}
+{"version":3,"file":"pages-vm.js","sourceRoot":"","sources":["../../../src/docusaurus/view-model/pages-vm.ts"],"names":[],"mappings":"AAcA,OAAO,MAAM,MAAM,aAAa,CAAA;AAEhC,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEpD,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAqBrD,MAAM,OAAO,KAAM,SAAQ,cAAc;IAwB9B,QAAQ,CAAC,WAAiC;QACjD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;QACxC,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;QAE/C,IAAI,IAAI,CAAC,EAAE,KAAK,WAAW,EAAE,CAAC;YAC5B,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAA;QAChC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAWQ,0BAA0B;IAEnC,CAAC;IAcQ,eAAe,CAAC,eAAgC;QAGvD,MAAM,aAAa,GAAwB;YACzC,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,OAAO;YAEd,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,EAAE;SACV,CAAA;QAED,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC1D,IACE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc;gBACrC,IAAI,YAAY,IAAI;gBACpB,IAAI,CAAC,SAAS,EAAE,EAChB,CAAC;gBACD,SAAQ;YACV,CAAC;YAED,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;gBAC3B,SAAQ;YACV,CAAC;YAED,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;YAC7B,IAAI,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC/D,SAAQ;YACV,CAAC;YAED,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAA;YACxD,MAAM,OAAO,GAAmB;gBAC9B,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,YAAY;gBACnB,EAAE;aACH,CAAA;YAED,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnC,CAAC;QAED,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IAaD,0BAA0B,CAAC,eAAgC;QAEzD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAE3C,OAAM;QACR,CAAC;QAED,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAE1D,IACE,MAAM,KAAK,WAAW;gBACtB,CAAC,CAAC,IAAI,YAAY,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,EAC3C,CAAC;gBACD,SAAQ;YACV,CAAC;YAED,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBACpE,SAAQ;YACV,CAAC;YAED,MAAM,OAAO,GAAmB;gBAC9B,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,IAAI,CAAC,YAAY;gBACxB,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,EAAE;aACvD,CAAA;YAED,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrC,CAAC;IACH,CAAC;IAcQ,iBAAiB;QAGxB,OAAO,EAAE,CAAA;IACX,CAAC;IAcQ,KAAK,CAAC,sBAAsB;IAErC,CAAC;CACF;AAgBD,MAAM,OAAO,IAAK,SAAQ,YAAY;IAapC,YAAY,UAAiB,EAAE,WAAiC;QAC9D,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;QAE9B,MAAM,EAAE,KAAK,EAAE,GAAG,WAAW,CAAA;QAC7B,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAA;QAC3B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QAEnD,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;QAC7B,IAAI,CAAC,SAAS,GAAG,YAAY,CAAA;QAC7B,IAAI,CAAC,aAAa,GAAG,YAAY,CAAA;QAEjC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAA;QAE7B,MAAM,aAAa,GAAW,wBAAwB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACzE,IAAI,CAAC,iBAAiB,GAAG,SAAS,aAAa,EAAE,CAAA;QAEjD,IAAI,CAAC,SAAS,GAAG,SAAS,WAAW,CAAC,aAAa,CAAC,EAAE,CAAA;QAGtD,MAAM,CAAC,WAAW,CAAC,WAAW,KAAK,SAAS,CAAC,CAAA;IAS/C,CAAC;IAcD,SAAS;QACP,IAAI,IAAI,CAAC,EAAE,KAAK,YAAY,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;YACnD,OAAO,KAAK,CAAA;QACd,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAiBQ,aAAa,CAAC,WAAwB;QAC7C,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,MAAM,aAAa,GACjB,IAAI,CAAC,4BAA4B,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAA;QAE1E,KAAK,CAAC,IAAI,CACR,IAAI,CAAC,kCAAkC,CAAC;YACtC,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,aAAa;SACd,CAAC,CACH,CAAA;QAED,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC,CAAA;QAEjD,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,2BAA2B,EAAE,CAAC,CAAA;QAEjD,KAAK,CAAC,IAAI,CACR,GAAG,IAAI,CAAC,oCAAoC,CAAC;YAC3C,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,4BAA4B,EAAE,IAAI,CAAC,4BAA4B;YAC/D,UAAU,EAAE,KAAK;SAClB,CAAC,CACH,CAAA;QAED,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA;QAE3C,OAAO,KAAK,CAAA;IACd,CAAC;CACF"}