typedoc 0.24.7 → 0.25.0

package/dist/lib/converter/plugins/GroupPlugin.js

@@ -131,7 +131,7 @@ let GroupPlugin = GroupPlugin_1 = class GroupPlugin extends components_1.Convert
             for (const name of this.getGroups(child)) {
                 let group = groups.get(name);
                 if (!group) {
-                    group = new ReflectionGroup_1.ReflectionGroup(name);
+                    group = new ReflectionGroup_1.ReflectionGroup(name, child);
                     groups.set(name, group);
                 }
                 group.children.push(child);
@@ -163,6 +163,7 @@ let GroupPlugin = GroupPlugin_1 = class GroupPlugin extends components_1.Convert
         return aWeight - bWeight;
     }
 };
+exports.GroupPlugin = GroupPlugin;
 GroupPlugin.WEIGHTS = [];
 __decorate([
     (0, utils_1.BindOption)("searchGroupBoosts")
@@ -170,7 +171,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("groupOrder")
 ], GroupPlugin.prototype, "groupOrder", void 0);
-GroupPlugin = GroupPlugin_1 = __decorate([
+exports.GroupPlugin = GroupPlugin = GroupPlugin_1 = __decorate([
     (0, components_1.Component)({ name: "group" })
 ], GroupPlugin);
-exports.GroupPlugin = GroupPlugin;

package/dist/lib/converter/plugins/ImplementsPlugin.js

@@ -103,9 +103,10 @@ let ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComp
         this.resolve(context.project);
     }
     resolve(project) {
-        for (const reflection of Object.values(project.reflections)) {
-            if (reflection instanceof index_1.DeclarationReflection) {
-                this.tryResolve(project, reflection);
+        for (const id in project.reflections) {
+            const refl = project.reflections[id];
+            if (refl instanceof index_1.DeclarationReflection) {
+                this.tryResolve(project, refl);
             }
         }
     }
@@ -195,7 +196,8 @@ let ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComp
         const property = findProperty(reflection, childType);
         if (!property) {
             // We're probably broken... but I don't think this should be fatal.
-            context.logger.warn(`Failed to retrieve${reflection.flags.isStatic ? " static" : ""} member "${reflection.escapedName ?? reflection.name}" of "${reflection.parent?.name}" for inheritance analysis. Please report a bug.`);
+            context.logger.warn(`Failed to retrieve${reflection.flags.isStatic ? " static" : ""} member "${reflection.escapedName ?? reflection.name}" of "${reflection.parent
+                ?.name}" for inheritance analysis. Please report a bug.`);
             return;
         }
         // Need to check both extends and implements clauses.
@@ -224,10 +226,10 @@ let ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComp
         }
     }
 };
-ImplementsPlugin = __decorate([
+exports.ImplementsPlugin = ImplementsPlugin;
+exports.ImplementsPlugin = ImplementsPlugin = __decorate([
     (0, components_1.Component)({ name: "implements" })
 ], ImplementsPlugin);
-exports.ImplementsPlugin = ImplementsPlugin;
 function constructorInheritance(context, reflection, childDecl, constructorDecl) {
     const extendsClause = childDecl.heritageClauses?.find((cl) => cl.token === typescript_1.default.SyntaxKind.ExtendsKeyword);
     if (!extendsClause)

package/dist/lib/converter/plugins/InheritDocPlugin.d.ts

@@ -1,4 +1,5 @@
 import { ConverterComponent } from "../components";
+import { ValidationOptions } from "../../utils";
 /**
  * A plugin that handles `@inheritDoc` tags by copying documentation from another API item.
  * It is NOT responsible for handling bare JSDoc style `@inheritDoc` tags which do not specify
@@ -13,6 +14,7 @@ import { ConverterComponent } from "../components";
  * - `@return` block
  */
 export declare class InheritDocPlugin extends ConverterComponent {
+    validation: ValidationOptions;
     private dependencies;
     /**
      * Create a new InheritDocPlugin instance.

package/dist/lib/converter/plugins/InheritDocPlugin.js

@@ -39,7 +39,7 @@ let InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComp
      */
     initialize() {
         this.owner.on(converter_1.Converter.EVENT_RESOLVE_END, (context) => this.processInheritDoc(context.project));
-        this.owner.on(application_events_1.ApplicationEvents.REVIVE, this.processInheritDoc, this);
+        this.application.on(application_events_1.ApplicationEvents.REVIVE, this.processInheritDoc, this);
     }
     /**
      * Traverse through reflection descendant to check for `inheritDoc` tag.
@@ -47,7 +47,8 @@ let InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComp
      * that will provide actual comment.
      */
     processInheritDoc(project) {
-        for (const reflection of Object.values(project.reflections)) {
+        for (const id in project.reflections) {
+            const reflection = project.reflections[id];
             const source = extractInheritDocTagReference(reflection);
             if (!source)
                 continue;
@@ -78,7 +79,9 @@ let InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComp
                 sourceRefl = sourceRefl.getSignature || sourceRefl.setSignature;
             }
             if (!sourceRefl) {
-                this.application.logger.warn(`Failed to find "${source}" to inherit the comment from in the comment for ${reflection.getFullName()}`);
+                if (this.validation.invalidLink) {
+                    this.application.logger.warn(`Failed to find "${source}" to inherit the comment from in the comment for ${reflection.getFullName()}`);
+                }
                 continue;
             }
             this.copyComment(sourceRefl, reflection);
@@ -159,10 +162,13 @@ let InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComp
         }
     }
 };
-InheritDocPlugin = __decorate([
+exports.InheritDocPlugin = InheritDocPlugin;
+__decorate([
+    (0, utils_1.BindOption)("validation")
+], InheritDocPlugin.prototype, "validation", void 0);
+exports.InheritDocPlugin = InheritDocPlugin = __decorate([
     (0, components_1.Component)({ name: "inheritDoc" })
 ], InheritDocPlugin);
-exports.InheritDocPlugin = InheritDocPlugin;
 function copySummaries(source, target) {
     for (const [s, t] of (0, array_1.zip)(source || [], target || [])) {
         t.comment = new models_1.Comment(s.comment?.summary);

package/dist/lib/converter/plugins/LinkResolverPlugin.js

@@ -26,7 +26,8 @@ let LinkResolverPlugin = class LinkResolverPlugin extends components_1.Converter
         this.resolveLinks(context.project);
     }
     resolveLinks(project) {
-        for (const reflection of Object.values(project.reflections)) {
+        for (const id in project.reflections) {
+            const reflection = project.reflections[id];
             if (reflection.comment) {
                 this.owner.resolveLinks(reflection.comment, reflection);
             }
@@ -53,10 +54,10 @@ let LinkResolverPlugin = class LinkResolverPlugin extends components_1.Converter
         }
     }
 };
+exports.LinkResolverPlugin = LinkResolverPlugin;
 __decorate([
     (0, utils_1.BindOption)("validation")
 ], LinkResolverPlugin.prototype, "validation", void 0);
-LinkResolverPlugin = __decorate([
+exports.LinkResolverPlugin = LinkResolverPlugin = __decorate([
     (0, components_1.Component)({ name: "link-resolver" })
 ], LinkResolverPlugin);
-exports.LinkResolverPlugin = LinkResolverPlugin;

package/dist/lib/converter/plugins/PackagePlugin.js

@@ -129,6 +129,7 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
         }
     }
 };
+exports.PackagePlugin = PackagePlugin;
 __decorate([
     (0, utils_1.BindOption)("readme")
 ], PackagePlugin.prototype, "readme", void 0);
@@ -141,7 +142,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("includeVersion")
 ], PackagePlugin.prototype, "includeVersion", void 0);
-PackagePlugin = __decorate([
+exports.PackagePlugin = PackagePlugin = __decorate([
     (0, components_1.Component)({ name: "package" })
 ], PackagePlugin);
-exports.PackagePlugin = PackagePlugin;

package/dist/lib/converter/plugins/SourcePlugin.d.ts

@@ -6,6 +6,7 @@ export declare class SourcePlugin extends ConverterComponent {
     readonly disableSources: boolean;
     readonly gitRevision: string;
     readonly gitRemote: string;
+    readonly disableGit: boolean;
     readonly sourceLinkTemplate: string;
     readonly basePath: string;
     /**

package/dist/lib/converter/plugins/SourcePlugin.js

@@ -71,14 +71,11 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
             const fileName = base_path_1.BasePath.normalize(sourceFile.fileName);
             this.fileNames.add(fileName);
             let position;
-            if ((0, nodes_1.isNamedNode)(node)) {
-                position = typescript_1.default.getLineAndCharacterOfPosition(sourceFile, node.name.getStart());
-            }
-            else if (typescript_1.default.isSourceFile(node)) {
+            if (typescript_1.default.isSourceFile(node)) {
                 position = { character: 0, line: 0 };
             }
             else {
-                position = typescript_1.default.getLineAndCharacterOfPosition(sourceFile, node.getStart());
+                position = typescript_1.default.getLineAndCharacterOfPosition(sourceFile, getLocationNode(node).getStart());
             }
             reflection.sources || (reflection.sources = []);
             reflection.sources.push(new models_1.SourceReference(fileName, position.line + 1, position.character));
@@ -90,7 +87,7 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
         const sourceFile = sig.getSourceFile();
         const fileName = base_path_1.BasePath.normalize(sourceFile.fileName);
         this.fileNames.add(fileName);
-        const position = typescript_1.default.getLineAndCharacterOfPosition(sourceFile, sig.getStart());
+        const position = typescript_1.default.getLineAndCharacterOfPosition(sourceFile, getLocationNode(sig).getStart());
         reflection.sources || (reflection.sources = []);
         reflection.sources.push(new models_1.SourceReference(fileName, position.line + 1, position.character));
     }
@@ -102,15 +99,25 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
     onBeginResolve(context) {
         if (this.disableSources)
             return;
+        if (this.disableGit && !this.sourceLinkTemplate) {
+            this.application.logger.error(`disableGit is set, but sourceLinkTemplate is not, so source links cannot be produced. Set a sourceLinkTemplate or disableSources to prevent source tracking.`);
+            return;
+        }
+        if (this.disableGit &&
+            this.sourceLinkTemplate.includes("{gitRevision}") &&
+            !this.gitRevision) {
+            this.application.logger.warn(`disableGit is set and sourceLinkTemplate contains {gitRevision}, which will be replaced with an empty string as no revision was provided.`);
+        }
         const basePath = this.basePath || (0, utils_1.getCommonDirectory)([...this.fileNames]);
-        for (const refl of Object.values(context.project.reflections)) {
+        for (const id in context.project.reflections) {
+            const refl = context.project.reflections[id];
             if (!(refl instanceof index_1.DeclarationReflection ||
                 refl instanceof index_1.SignatureReflection)) {
                 continue;
             }
             for (const source of refl.sources || []) {
-                if (repository_1.gitIsInstalled) {
-                    const repo = this.getRepository(source.fullFileName);
+                if (this.disableGit || (0, repository_1.gitIsInstalled)()) {
+                    const repo = this.getRepository(basePath, source.fullFileName);
                     source.url = repo?.getURL(source.fullFileName, source.line);
                 }
                 source.fileName = (0, utils_1.normalizePath)((0, path_1.relative)(basePath, source.fullFileName));
@@ -123,7 +130,10 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
      * @param fileName  The name of the file a repository should be looked for.
      * @returns The found repository info or undefined.
      */
-    getRepository(fileName) {
+    getRepository(basePath, fileName) {
+        if (this.disableGit) {
+            return new repository_1.AssumedRepository(basePath, this.gitRevision, this.sourceLinkTemplate);
+        }
         // Check for known non-repositories
         const dirName = (0, path_1.dirname)(fileName);
         const segments = dirName.split("/");
@@ -139,7 +149,7 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
             }
         }
         // Try to create a new repository
-        const repository = repository_1.Repository.tryCreateRepository(dirName, this.sourceLinkTemplate, this.gitRevision, this.gitRemote, this.application.logger);
+        const repository = repository_1.GitRepository.tryCreateRepository(dirName, this.sourceLinkTemplate, this.gitRevision, this.gitRemote, this.application.logger);
         if (repository) {
             this.repositories[repository.path.toLowerCase()] = repository;
             return repository;
@@ -148,6 +158,7 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
         this.ignoredPaths.add(dirName);
     }
 };
+exports.SourcePlugin = SourcePlugin;
 __decorate([
     (0, utils_1.BindOption)("disableSources")
 ], SourcePlugin.prototype, "disableSources", void 0);
@@ -157,13 +168,20 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("gitRemote")
 ], SourcePlugin.prototype, "gitRemote", void 0);
+__decorate([
+    (0, utils_1.BindOption)("disableGit")
+], SourcePlugin.prototype, "disableGit", void 0);
 __decorate([
     (0, utils_1.BindOption)("sourceLinkTemplate")
 ], SourcePlugin.prototype, "sourceLinkTemplate", void 0);
 __decorate([
     (0, utils_1.BindOption)("basePath")
 ], SourcePlugin.prototype, "basePath", void 0);
-SourcePlugin = __decorate([
+exports.SourcePlugin = SourcePlugin = __decorate([
     (0, components_1.Component)({ name: "source" })
 ], SourcePlugin);
-exports.SourcePlugin = SourcePlugin;
+function getLocationNode(node) {
+    if ((0, nodes_1.isNamedNode)(node))
+        return node.name;
+    return node;
+}

package/dist/lib/converter/plugins/TypePlugin.js

@@ -34,8 +34,9 @@ let TypePlugin = class TypePlugin extends components_1.ConverterComponent {
         });
     }
     onRevive(project) {
-        for (const refl of Object.values(project.reflections)) {
-            this.resolve(project, refl);
+        for (const id in project.reflections) {
+            this.resolve(project, project.reflections[id], 
+            /* create links */ false);
         }
         this.finishResolve(project);
         this.reflections.clear();
@@ -43,24 +44,24 @@ let TypePlugin = class TypePlugin extends components_1.ConverterComponent {
     onResolve(context, reflection) {
         this.resolve(context.project, reflection);
     }
-    resolve(project, reflection) {
+    resolve(project, reflection, createLinks = true) {
         if (!(reflection instanceof index_1.DeclarationReflection))
             return;
         if (reflection.kindOf(index_1.ReflectionKind.ClassOrInterface)) {
             this.postpone(reflection);
             walk(reflection.implementedTypes, (target) => {
                 this.postpone(target);
-                if (!target.implementedBy) {
-                    target.implementedBy = [];
+                target.implementedBy || (target.implementedBy = []);
+                if (createLinks) {
+                    target.implementedBy.push(types_1.ReferenceType.createResolvedReference(reflection.name, reflection, project));
                 }
-                target.implementedBy.push(types_1.ReferenceType.createResolvedReference(reflection.name, reflection, project));
             });
             walk(reflection.extendedTypes, (target) => {
                 this.postpone(target);
-                if (!target.extendedBy) {
-                    target.extendedBy = [];
+                target.extendedBy || (target.extendedBy = []);
+                if (createLinks) {
+                    target.extendedBy.push(types_1.ReferenceType.createResolvedReference(reflection.name, reflection, project));
                 }
-                target.extendedBy.push(types_1.ReferenceType.createResolvedReference(reflection.name, reflection, project));
             });
         }
         function walk(types, callback) {
@@ -121,7 +122,7 @@ let TypePlugin = class TypePlugin extends components_1.ConverterComponent {
         });
     }
 };
-TypePlugin = __decorate([
+exports.TypePlugin = TypePlugin;
+exports.TypePlugin = TypePlugin = __decorate([
     (0, components_1.Component)({ name: "type" })
 ], TypePlugin);
-exports.TypePlugin = TypePlugin;

package/dist/lib/converter/symbols.js

@@ -176,8 +176,16 @@ function convertNamespace(context, symbol, exportSymbol) {
             return;
         }
     }
-    const reflection = context.createDeclarationReflection(models_1.ReflectionKind.Namespace, symbol, exportSymbol);
-    context.finalizeDeclarationReflection(reflection);
+    // #2364, @namespace on a variable might be merged with a namespace containing types.
+    const existingReflection = context.project.getReflectionFromSymbol(exportSymbol || symbol);
+    let reflection;
+    if (existingReflection?.kind === models_1.ReflectionKind.Namespace) {
+        reflection = existingReflection;
+    }
+    else {
+        reflection = context.createDeclarationReflection(models_1.ReflectionKind.Namespace, symbol, exportSymbol);
+        context.finalizeDeclarationReflection(reflection);
+    }
     convertSymbols(context.withScope(reflection), context.checker
         .getExportsOfModule(symbol)
         .filter((s) => s.flags & exportFlags));
@@ -216,6 +224,9 @@ function convertTypeAliasAsInterface(context, symbol, exportSymbol, declaration)
     context.finalizeDeclarationReflection(reflection);
     const rc = context.withScope(reflection);
     const type = context.checker.getTypeAtLocation(declaration);
+    if (type.getFlags() & typescript_1.default.TypeFlags.Union) {
+        context.logger.warn(`Using @interface on a union type will discard properties not present on all branches of the union. TypeDoc's output may not accurately describe your source code.`, declaration);
+    }
     // Interfaces have properties
     convertSymbols(rc, type.getProperties());
     // And type arguments
@@ -511,7 +522,8 @@ function convertVariableAsNamespace(context, symbol, exportSymbol) {
     const reflection = context.createDeclarationReflection(models_1.ReflectionKind.Namespace, symbol, exportSymbol);
     context.finalizeDeclarationReflection(reflection);
     const rc = context.withScope(reflection);
-    const declaration = symbol.declarations[0];
+    const declaration = symbol.declarations?.find(typescript_1.default.isVariableDeclaration);
+    (0, assert_1.default)(declaration, "Missing variable declaration");
     const type = context.checker.getTypeAtLocation(declaration);
     convertSymbols(rc, type.getProperties());
     return typescript_1.default.SymbolFlags.Property;

package/dist/lib/converter/types.js

@@ -561,7 +561,12 @@ const tupleConverter = {
         let elements = types?.map((type) => convertType(context, type));
         if (type.target.labeledElementDeclarations) {
             const namedDeclarations = type.target.labeledElementDeclarations;
-            elements = elements?.map((el, i) => new models_1.NamedTupleMember(namedDeclarations[i].name.getText(), !!namedDeclarations[i].questionToken, (0, reflections_1.removeUndefined)(el)));
+            elements = elements?.map((el, i) => {
+                const namedDecl = namedDeclarations[i];
+                return namedDecl
+                    ? new models_1.NamedTupleMember(namedDecl.name.getText(), !!namedDecl.questionToken, (0, reflections_1.removeUndefined)(el))
+                    : el;
+            });
         }
         elements = elements?.map((el, i) => {
             if (type.target.elementFlags[i] & typescript_1.default.ElementFlags.Variable) {

package/dist/lib/converter/utils/nodes.d.ts

@@ -1,6 +1,6 @@
 import ts from "typescript";
-export declare function isNamedNode(node: ts.Node): node is ts.Node & {
-    name: ts.Identifier | ts.PrivateIdentifier | ts.ComputedPropertyName;
+export declare function isNamedNode(node: unknown): node is {
+    readonly name: ts.Identifier | ts.PrivateIdentifier | ts.ComputedPropertyName;
 };
 export declare function getHeritageTypes(declarations: readonly (ts.ClassDeclaration | ts.InterfaceDeclaration)[], kind: ts.SyntaxKind.ImplementsKeyword | ts.SyntaxKind.ExtendsKeyword): ts.ExpressionWithTypeArguments[];
 export declare function isObjectType(type: ts.Type): type is ts.ObjectType;

package/dist/lib/converter/utils/repository.d.ts

@@ -1,9 +1,19 @@
 import type { Logger } from "../../utils";
-export declare const gitIsInstalled: boolean;
+export declare function gitIsInstalled(): boolean;
+export interface Repository {
+    getURL(fileName: string, line: number): string | undefined;
+}
+export declare class AssumedRepository implements Repository {
+    readonly path: string;
+    readonly gitRevision: string;
+    readonly sourceLinkTemplate: string;
+    constructor(path: string, gitRevision: string, sourceLinkTemplate: string);
+    getURL(fileName: string, line: number): string | undefined;
+}
 /**
  * Stores data of a repository.
  */
-export declare class Repository {
+export declare class GitRepository implements Repository {
     /**
      * The path of this repository on disk.
      */
@@ -31,11 +41,11 @@ export declare class Repository {
      * Try to create a new repository instance.
      *
      * Checks whether the given path is the root of a valid repository and if so
-     * creates a new instance of {@link Repository}.
+     * creates a new instance of {@link GitRepository}.
      *
      * @param path  The potential repository root.
-     * @returns A new instance of {@link Repository} or undefined.
+     * @returns A new instance of {@link GitRepository} or undefined.
      */
-    static tryCreateRepository(path: string, sourceLinkTemplate: string, gitRevision: string, gitRemote: string, logger: Logger): Repository | undefined;
+    static tryCreateRepository(path: string, sourceLinkTemplate: string, gitRevision: string, gitRemote: string, logger: Logger): GitRepository | undefined;
 }
 export declare function guessSourceUrlTemplate(remotes: string[]): string | undefined;

package/dist/lib/converter/utils/repository.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.guessSourceUrlTemplate = exports.Repository = exports.gitIsInstalled = void 0;
+exports.guessSourceUrlTemplate = exports.GitRepository = exports.AssumedRepository = exports.gitIsInstalled = void 0;
 const child_process_1 = require("child_process");
 const base_path_1 = require("../utils/base-path");
 const TEN_MEGABYTES = 1024 * 10000;
@@ -11,11 +11,32 @@ function git(...args) {
         maxBuffer: TEN_MEGABYTES,
     });
 }
-exports.gitIsInstalled = git("--version").status === 0;
+let haveGit;
+function gitIsInstalled() {
+    haveGit ?? (haveGit = git("--version").status === 0);
+    return haveGit;
+}
+exports.gitIsInstalled = gitIsInstalled;
+class AssumedRepository {
+    constructor(path, gitRevision, sourceLinkTemplate) {
+        this.path = path;
+        this.gitRevision = gitRevision;
+        this.sourceLinkTemplate = sourceLinkTemplate;
+    }
+    getURL(fileName, line) {
+        const replacements = {
+            gitRevision: this.gitRevision,
+            path: fileName.substring(this.path.length + 1),
+            line,
+        };
+        return this.sourceLinkTemplate.replace(/\{(path|line)\}/g, (_, key) => replacements[key]);
+    }
+}
+exports.AssumedRepository = AssumedRepository;
 /**
  * Stores data of a repository.
  */
-class Repository {
+class GitRepository {
     /**
      * Create a new Repository instance.
      *
@@ -59,10 +80,10 @@ class Repository {
      * Try to create a new repository instance.
      *
      * Checks whether the given path is the root of a valid repository and if so
-     * creates a new instance of {@link Repository}.
+     * creates a new instance of {@link GitRepository}.
      *
      * @param path  The potential repository root.
-     * @returns A new instance of {@link Repository} or undefined.
+     * @returns A new instance of {@link GitRepository} or undefined.
      */
     static tryCreateRepository(path, sourceLinkTemplate, gitRevision, gitRemote, logger) {
         const topLevel = git("-C", path, "rev-parse", "--show-toplevel");
@@ -75,10 +96,6 @@ class Repository {
         if (sourceLinkTemplate) {
             urlTemplate = sourceLinkTemplate;
         }
-        else if (/^https?:\/\//.test(gitRemote)) {
-            logger.warn("Using a link as the gitRemote is deprecated and will be removed in 0.24.");
-            urlTemplate = `${gitRemote}/{gitRevision}`;
-        }
         else {
             const remotesOut = git("-C", path, "remote", "get-url", gitRemote);
             if (remotesOut.status === 0) {
@@ -90,10 +107,10 @@ class Repository {
         }
         if (!urlTemplate)
             return;
-        return new Repository(base_path_1.BasePath.normalize(topLevel.stdout.replace("\n", "")), gitRevision, urlTemplate);
+        return new GitRepository(base_path_1.BasePath.normalize(topLevel.stdout.replace("\n", "")), gitRevision, urlTemplate);
     }
 }
-exports.Repository = Repository;
+exports.GitRepository = GitRepository;
 // Should have three capturing groups:
 // 1. hostname
 // 2. user

package/dist/lib/models/ReflectionGroup.d.ts

@@ -1,5 +1,5 @@
 import { ReflectionCategory } from "./ReflectionCategory";
-import type { DeclarationReflection } from ".";
+import type { DeclarationReflection, Reflection } from ".";
 import type { Serializer, JSONOutput, Deserializer } from "../serialization";
 /**
  * A group of reflections. All reflections in a group are of the same kind.
@@ -9,6 +9,7 @@ import type { Serializer, JSONOutput, Deserializer } from "../serialization";
  * render human readable children lists in templates.
  */
 export declare class ReflectionGroup {
+    readonly owningReflection: Reflection;
     /**
      * The title, a string representation of the typescript kind, of this group.
      */
@@ -25,8 +26,9 @@ export declare class ReflectionGroup {
      * Create a new ReflectionGroup instance.
      *
      * @param title The title of this group.
+     * @param owningReflection The reflection containing this group, useful for changing rendering based on a comment on a reflection.
      */
-    constructor(title: string);
+    constructor(title: string, owningReflection: Reflection);
     /**
      * Do all children of this group have a separate document?
      */

package/dist/lib/models/ReflectionGroup.js

@@ -14,8 +14,10 @@ class ReflectionGroup {
      * Create a new ReflectionGroup instance.
      *
      * @param title The title of this group.
+     * @param owningReflection The reflection containing this group, useful for changing rendering based on a comment on a reflection.
      */
-    constructor(title) {
+    constructor(title, owningReflection) {
+        this.owningReflection = owningReflection;
         /**
          * All reflections of this group.
          */

package/dist/lib/models/comments/comment.d.ts

@@ -1,6 +1,10 @@
 import type { Reflection } from "../reflections";
 import { ReflectionSymbolId } from "../reflections/ReflectionSymbolId";
 import type { Serializer, Deserializer, JSONOutput } from "../../serialization";
+/**
+ * Represents a parsed piece of a comment.
+ * @category Comments
+ */
 export type CommentDisplayPart = {
     kind: "text";
     text: string;
@@ -13,6 +17,7 @@ export type CommentDisplayPart = {
  * property set indicating which reflection/url they link to. They may also
  * have a `tsLinkText` property which includes the part of the `text` which
  * TypeScript thinks should be displayed as the link text.
+ * @category Comments
  */
 export interface InlineTagDisplayPart {
     kind: "inline-tag";
@@ -25,6 +30,7 @@ export interface InlineTagDisplayPart {
  * A model that represents a single TypeDoc comment tag.
  *
  * Tags are stored in the {@link Comment.blockTags} property.
+ * @category Comments
  */
 export declare class CommentTag {
     /**
@@ -53,6 +59,7 @@ export declare class CommentTag {
  *
  * Instances of this model are created by the CommentPlugin. You can retrieve comments
  * through the {@link DeclarationReflection.comment} property.
+ * @category Comments
  */
 export declare class Comment {
     /**
@@ -97,7 +104,7 @@ export declare class Comment {
     /**
      * All modifier tags present on the comment, e.g. `@alpha`, `@beta`.
      */
-    modifierTags: Set<string>;
+    modifierTags: Set<`@${string}`>;
     /**
      * Label associated with this reflection, if any (https://tsdoc.org/pages/tags/label/)
      */
@@ -105,7 +112,7 @@ export declare class Comment {
     /**
      * Creates a new Comment instance.
      */
-    constructor(summary?: CommentDisplayPart[], blockTags?: CommentTag[], modifierTags?: Set<string>);
+    constructor(summary?: CommentDisplayPart[], blockTags?: CommentTag[], modifierTags?: Set<`@${string}`>);
     /**
      * Create a deep clone of this comment.
      */

package/dist/lib/models/comments/comment.js

@@ -8,6 +8,7 @@ const ReflectionSymbolId_1 = require("../reflections/ReflectionSymbolId");
  * A model that represents a single TypeDoc comment tag.
  *
  * Tags are stored in the {@link Comment.blockTags} property.
+ * @category Comments
  */
 class CommentTag {
     /**
@@ -43,6 +44,7 @@ exports.CommentTag = CommentTag;
  *
  * Instances of this model are created by the CommentPlugin. You can retrieve comments
  * through the {@link DeclarationReflection.comment} property.
+ * @category Comments
  */
 class Comment {
     /**

package/dist/lib/models/reflections/abstract.d.ts

@@ -100,6 +100,7 @@ export interface TraverseCallback {
  * This base class exposes the basic properties one may use to traverse the reflection tree.
  * You can use the {@link ContainerReflection.children} and {@link parent} properties to walk the tree. The {@link ContainerReflection.groups} property
  * contains a list of all children grouped and sorted for rendering.
+ * @category Reflections
  */
 export declare abstract class Reflection {
     /**
@@ -207,7 +208,7 @@ export declare abstract class Reflection {
      * Traverse most potential child reflections of this reflection.
      *
      * Note: This may not necessarily traverse child reflections contained within the `type` property
-     * of the reflection, and should not be relied on for this. Support for checking object types will likely be removed in v0.25.
+     * of the reflection, and should not be relied on for this. Support for checking object types will likely be removed in v0.26.
      *
      * The given callback will be invoked for all children, signatures and type parameters
      * attached to this reflection.