@xpack/doxygen2docusaurus 2.1.0 → 2.2.0

package/src/docusaurus/renderers/linkedtexttype.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/renderers/listingtype.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/renderers/paramtype.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/renderers/referencetype.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/renderers/reftexttype.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/renderers/reftype.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/renderers/renderers.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------
@@ -74,6 +74,10 @@ import {
 import { TocListLinesRenderer } from './tableofcontentstype.js'
 import { ReferenceTypeStringRenderer } from './referencetype.js'
 import type { DataModelElement } from '../../doxygen/data-model/types.js'
+import {
+  ConceptCodePartLinesRenderer,
+  ConceptPartsLinesRenderer,
+} from './conceptparts.js'
 
 // ----------------------------------------------------------------------------
 
@@ -105,11 +109,38 @@ export class Renderers {
   registerRenderers(workspace: Workspace): void {
     // Add renderers for the parsed xml elements (in alphabetical order).
 
+    // ------------------------------------------------------------------------
+    // Register line-based renderers for elements that produce multi-line
+    // output.
+    //
+    // Some renderers are designed for specific types, while others are
+    // designed for abstract types and will be used as base renderers for
+    // multiple concrete types.
+    //
+    // The order of registration is significant, the specific renderers must
+    // be registered before the abstract ones.
+    //
+    // For readability and ease of maintenance, the renderers are registered
+    // in alphabetical order, with specific renderers listed before the
+    // abstract ones they are based on.
+
+    // This is a specific renderer.
     this.elementLinesRenderers.set(
       'VariableListPairDataModel',
       new VariableListPairLinesRenderer(workspace)
     )
 
+    // The following renderers are for abstract types, and will be used
+    // for all their concrete subtypes.
+
+    this.elementLinesRenderers.set(
+      'AbstractConceptCodePart',
+      new ConceptCodePartLinesRenderer(workspace)
+    )
+    this.elementLinesRenderers.set(
+      'AbstractConceptParts',
+      new ConceptPartsLinesRenderer(workspace)
+    )
     this.elementLinesRenderers.set(
       'AbstractDescriptionType',
       new DescriptionTypeLinesRenderer(workspace)
@@ -218,13 +249,27 @@ export class Renderers {
       'AbstractRefType',
       new RefTypeLinesRenderer(workspace)
     )
-    // console.log(this.elementGenerators.size, 'element generators')
 
+    // ------------------------------------------------------------------------
+    // Register string-based renderers for elements that produce single-line
+    // output.
+    //
+    // Same as for line renderers, the specific renderers must be registered
+    // before the abstract ones they are based on, and the renderers are
+    // registered in alphabetical order.
+
+    // This is a specific renderer.
     this.elementStringRenderers.set(
       'ComputerOutputDataModel',
       new ComputerOutputDataModelStringRenderer(workspace)
     )
 
+    // The following renderers are for abstract types, and will be used
+    // for all their concrete subtypes.
+    this.elementStringRenderers.set(
+      'ComputerOutputDataModel',
+      new ComputerOutputDataModelStringRenderer(workspace)
+    )
     this.elementStringRenderers.set(
       'AbstractDocEmptyType',
       new DocEmptyTypeStringRenderer(workspace)
@@ -425,12 +470,14 @@ export class Renderers {
    * @remarks
    * Determines the appropriate renderer based on element type and delegates
    * rendering. Handles strings, arrays, and objects with fallback logic
-   * between line and string renderers. Provides error handling for
-   * unrecognised element types.
+   * between line and string renderers. Leading spaces at the start of each
+   * rendered line are converted to HTML non-breaking space entities so that
+   * indentation is preserved in the generated output. Provides error
+   * handling for unrecognised element types.
    *
    * @param element - The element to render (single, array, or undefined)
    * @param type - The rendering context type
-   * @returns Array of formatted output lines
+   * @returns Array of formatted output lines with preserved indentation
    */
   renderElementToLines(
     element: DataModelElement | DataModelElement[] | undefined,
@@ -459,13 +506,22 @@ export class Renderers {
     const linesRenderer: ElementLinesRendererBase | undefined =
       this.getElementLinesRenderer(element)
     if (linesRenderer !== undefined) {
-      return linesRenderer.renderToLines(element, type)
+      return linesRenderer
+        .renderToLines(element, type)
+        .map((line) =>
+          line.replace(/^ +/, (match) => ' '.repeat(match.length))
+        )
     }
 
     const textRenderer: ElementStringRendererBase | undefined =
       this.getElementTextRenderer(element)
     if (textRenderer !== undefined) {
-      return textRenderer.renderToString(element, type).split('\n')
+      return textRenderer
+        .renderToString(element, type)
+        .split('\n')
+        .map((line) =>
+          line.replace(/^ +/, (match) => ' '.repeat(match.length))
+        )
     }
 
     console.error(util.inspect(element, { compact: false, depth: 999 }))

package/src/docusaurus/renderers/substringtype.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/renderers/tableofcontentstype.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/types.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/utils.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/view-model/classes-vm.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/view-model/collection-base.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/view-model/compound-base-vm.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/view-model/concepts-vm.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------
@@ -221,7 +221,7 @@ export class Concepts extends CollectionBase {
       return undefined
     }
 
-    if (!namespace.hasConcepts()) {
+    if (!namespace.hasConceptsRecursively()) {
       return undefined
     }
 
@@ -391,7 +391,7 @@ export class Concepts extends CollectionBase {
       return []
     }
 
-    if (!namespace.hasConcepts()) {
+    if (!namespace.hasConceptsRecursively()) {
       return []
     }
 
@@ -564,6 +564,19 @@ export class Concept extends CompoundBase {
    */
   initializerString = '???'
 
+  /**
+   * Rendered HTML lines for the concept parts content.
+   *
+   * @remarks
+   * Stores the rendered output of the Doxygen `conceptParts` element, which
+   * may contain an ordered mixture of documentation fragments and code
+   * fragments associated with the concept. Populated during
+   * {@link initializeLate}, and appended to the generated page body by
+   * {@link renderToLines}. The array remains empty when the compound does not
+   * include any concept parts.
+   */
+  conceptPartsHtmlLines: string[] = []
+
   /**
    * Creates a new Concept instance.
    *
@@ -652,6 +665,15 @@ export class Concept extends CompoundBase {
         .join('<br/>\n')
         .replace(/template/, 'template ')
     }
+
+    const conceptParts = this._private._compoundDef?.conceptParts
+    if (conceptParts !== undefined) {
+      this.conceptPartsHtmlLines = workspace.renderElementToLines(
+        conceptParts,
+        'html'
+      )
+      // console.log('conceptParts', this.conceptPartsHtmlLines)
+    }
   }
 
   /**
@@ -708,9 +730,17 @@ export class Concept extends CompoundBase {
       })
     )
 
+    if (this.locationLines !== undefined) {
+      lines.push(...this.locationLines)
+    }
+
+    lines.push(...this.conceptPartsHtmlLines)
+
+    // Currently here are no sections.
     // lines.push(...this.renderSectionsToLines())
 
-    lines.push(...this.renderGeneratedFromToLines())
+    // Currently there are none.
+    // lines.push(...this.renderGeneratedFromToLines())
 
     return lines
   }

package/src/docusaurus/view-model/description-anchors.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/view-model/files-and-folders-vm.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/view-model/groups-vm.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/view-model/members-vm.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------

package/src/docusaurus/view-model/namespaces-vm.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------
@@ -916,20 +916,39 @@ export class Namespace extends CompoundBase {
    *
    * @public
    */
-  hasConcepts(): boolean {
+  hasConceptsRecursively(): boolean {
     if (this.concepts.length > 0) {
       return true
     }
 
     for (const child of this.children) {
       assert(child instanceof Namespace)
-      if (child.hasConcepts()) {
+      if (child.hasConceptsRecursively()) {
         return true
       }
     }
     return false
   }
 
+  /**
+   * Determines whether this namespace contains any C++20 concept compounds.
+   *
+   * @remarks
+   * Checks the namespace's own `concepts` array to determine if it contains
+   * any concepts. This method does not recurse into child namespaces.
+   *
+   * @returns `true` if at least one concept is present in this namespace,
+   *   `false` otherwise
+   *
+   * @public
+   */
+  hasConcepts(): boolean {
+    if (this.concepts.length > 0) {
+      return true
+    }
+    return false
+  }
+
   // --------------------------------------------------------------------------
 
   /**

package/src/docusaurus/view-model/options.ts

@@ -2,11 +2,11 @@
  * This file is part of the xPack project (http://xpack.github.io).
  * Copyright (c) 2025-2026 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.
+ * 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.
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
  */
 
 // ----------------------------------------------------------------------------