typedoc 0.24.7 → 0.25.0

package/README.md

@@ -46,7 +46,7 @@ https://github.com/Gerrit0/typedoc-packages-example
 ### Arguments
 
 For a complete list of the command line arguments run `typedoc --help` or visit
-[our website](https://typedoc.org/guides/options/).
+[our website](https://typedoc.org/options/).
 
 -   `--out <path/to/documentation/>`<br>
     Specifies the location the documentation should be written to. Defaults to `./docs`

package/dist/index.d.ts

@@ -5,6 +5,10 @@ export { resetReflectionID } from "./lib/models/reflections/abstract";
  * All symbols documented under the Models namespace are also available in the root import.
  */
 export * as Models from "./lib/models";
+/**
+ * All symbols documented under the Configuration namespace are also available in the root import.
+ */
+export * as Configuration from "./lib/utils/options";
 export * from "./lib/models";
 export { Converter, Context, type CommentParserConfig, type DeclarationReference, type SymbolReference, type ComponentPath, type Meaning, type MeaningKeyword, type ExternalResolveResult, type ExternalSymbolResolver, } from "./lib/converter";
 export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";

package/dist/index.js

@@ -29,7 +29,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeScript = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.normalizePath = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.Models = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
+exports.TypeScript = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.normalizePath = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.Configuration = exports.Models = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
 var application_1 = require("./lib/application");
 Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return application_1.Application; } });
 var events_1 = require("./lib/utils/events");
@@ -41,6 +41,10 @@ Object.defineProperty(exports, "resetReflectionID", { enumerable: true, get: fun
  * All symbols documented under the Models namespace are also available in the root import.
  */
 exports.Models = __importStar(require("./lib/models"));
+/**
+ * All symbols documented under the Configuration namespace are also available in the root import.
+ */
+exports.Configuration = __importStar(require("./lib/utils/options"));
 __exportStar(require("./lib/models"), exports);
 var converter_1 = require("./lib/converter");
 Object.defineProperty(exports, "Converter", { enumerable: true, get: function () { return converter_1.Converter; } });

package/dist/lib/application.d.ts

@@ -2,11 +2,12 @@ import { Converter } from "./converter/index";
 import { Renderer } from "./output/renderer";
 import { Deserializer, Serializer } from "./serialization";
 import type { ProjectReflection } from "./models/index";
-import { Logger } from "./utils/index";
+import { Logger, OptionsReader } from "./utils/index";
 import { AbstractComponent, ChildableComponent } from "./utils/component";
 import { Options } from "./utils";
 import type { TypeDocOptions } from "./utils/options/declaration";
 import { DocumentationEntryPoint, EntryPointStrategy } from "./utils/entry-point";
+export declare function createAppForTesting(): Application;
 /**
  * The default TypeDoc main application class.
  *
@@ -70,15 +71,25 @@ export declare class Application extends ChildableComponent<Application, Abstrac
     /**
      * Create a new TypeDoc application instance.
      */
-    constructor();
+    private constructor();
     /**
      * Initialize TypeDoc, loading plugins if applicable.
      */
-    bootstrapWithPlugins(options?: Partial<TypeDocOptions>): Promise<void>;
+    static bootstrapWithPlugins(options?: Partial<TypeDocOptions>, readers?: readonly OptionsReader[]): Promise<Application>;
     /**
      * Initialize TypeDoc without loading plugins.
+     *
+     * @example
+     * Initialize the application with pretty-printing output disabled.
+     * ```ts
+     * const app = Application.bootstrap({ pretty: false });
+     * ```
+     *
+     * @param options Options to set during initialization
+     * @param readers Option readers to use to discover options from config files.
      */
-    bootstrap(options?: Partial<TypeDocOptions>): void;
+    static bootstrap(options?: Partial<TypeDocOptions>, readers?: readonly OptionsReader[]): Promise<Application>;
+    private _bootstrap;
     private setOptions;
     /**
      * Return the path to the TypeScript compiler.
@@ -95,7 +106,7 @@ export declare class Application extends ChildableComponent<Application, Abstrac
      *
      * @returns An instance of ProjectReflection on success, undefined otherwise.
      */
-    convert(): ProjectReflection | undefined;
+    convert(): Promise<ProjectReflection | undefined>;
     convertAndWatch(success: (project: ProjectReflection) => Promise<void>): void;
     validate(project: ProjectReflection): void;
     /**

package/dist/lib/application.js

@@ -33,7 +33,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var Application_1;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Application = void 0;
+exports.Application = exports.createAppForTesting = void 0;
 const Path = __importStar(require("path"));
 const typescript_1 = __importDefault(require("typescript"));
 const index_1 = require("./converter/index");
@@ -59,6 +59,17 @@ const packageInfo = require("../../package.json");
 const supportedVersionMajorMinor = packageInfo.peerDependencies.typescript
     .split("||")
     .map((version) => version.replace(/^\s*|\.x\s*$/g, ""));
+const DETECTOR = Symbol();
+function createAppForTesting() {
+    // @ts-expect-error private constructor
+    return new Application(DETECTOR);
+}
+exports.createAppForTesting = createAppForTesting;
+const DEFAULT_READERS = [
+    new index_2.TypeDocReader(),
+    new index_2.PackageJsonReader(),
+    new index_2.TSConfigReader(),
+];
 /**
  * The default TypeDoc main application class.
  *
@@ -76,7 +87,10 @@ let Application = Application_1 = class Application extends component_1.Childabl
     /**
      * Create a new TypeDoc application instance.
      */
-    constructor() {
+    constructor(detector) {
+        if (detector !== DETECTOR) {
+            throw new Error("An application handle must be retrieved with Application.bootstrap or Application.bootstrapWithPlugins");
+        }
         super(null); // We own ourselves
         /**
          * The serializer used to generate JSON output.
@@ -86,29 +100,50 @@ let Application = Application_1 = class Application extends component_1.Childabl
          * The deserializer used to restore previously serialized JSON output.
          */
         this.deserializer = new serialization_1.Deserializer(this);
+        /**
+         * The logger that should be used to output messages.
+         */
         this.logger = new index_2.ConsoleLogger();
-        this.options = new utils_1.Options(this.logger);
+        this.options = new utils_1.Options();
         this.converter = this.addComponent("converter", index_1.Converter);
         this.renderer = this.addComponent("renderer", renderer_1.Renderer);
     }
     /**
      * Initialize TypeDoc, loading plugins if applicable.
      */
-    async bootstrapWithPlugins(options = {}) {
-        this.options.reset();
-        this.setOptions(options, /* reportErrors */ false);
-        this.options.read(new index_2.Logger());
-        this.logger.level = this.options.getValue("logLevel");
-        await (0, index_2.loadPlugins)(this, this.options.getValue("plugin"));
-        this.bootstrap(options);
+    static async bootstrapWithPlugins(options = {}, readers = DEFAULT_READERS) {
+        const app = new Application_1(DETECTOR);
+        readers.forEach((r) => app.options.addReader(r));
+        app.options.reset();
+        app.setOptions(options, /* reportErrors */ false);
+        await app.options.read(new index_2.Logger());
+        app.logger.level = app.options.getValue("logLevel");
+        await (0, index_2.loadPlugins)(app, app.options.getValue("plugin"));
+        await app._bootstrap(options);
+        return app;
     }
     /**
      * Initialize TypeDoc without loading plugins.
+     *
+     * @example
+     * Initialize the application with pretty-printing output disabled.
+     * ```ts
+     * const app = Application.bootstrap({ pretty: false });
+     * ```
+     *
+     * @param options Options to set during initialization
+     * @param readers Option readers to use to discover options from config files.
      */
-    bootstrap(options = {}) {
+    static async bootstrap(options = {}, readers = DEFAULT_READERS) {
+        const app = new Application_1(DETECTOR);
+        readers.forEach((r) => app.options.addReader(r));
+        await app._bootstrap(options);
+        return app;
+    }
+    async _bootstrap(options) {
         this.options.reset();
         this.setOptions(options, /* reportErrors */ false);
-        this.options.read(this.logger);
+        await this.options.read(this.logger);
         this.setOptions(options);
         this.logger.level = this.options.getValue("logLevel");
         if ((0, general_1.hasBeenLoadedMultipleTimes)()) {
@@ -150,7 +185,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
      *
      * @returns An instance of ProjectReflection on success, undefined otherwise.
      */
-    convert() {
+    async convert() {
         const start = Date.now();
         // We freeze here rather than in the Converter class since TypeDoc's tests reuse the Application
         // with a few different settings.
@@ -332,7 +367,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
             "",
         ].join("\n");
     }
-    _convertPackages() {
+    async _convertPackages() {
         if (!this.options.isSet("entryPoints")) {
             this.logger.error("No entry points provided to packages mode, documentation cannot be generated.");
             return;
@@ -350,14 +385,14 @@ let Application = Application_1 = class Application extends component_1.Childabl
             const opts = origOptions.copyForPackage(dir);
             // Invalid links should only be reported after everything has been merged.
             opts.setValue("validation", { invalidLink: false });
-            opts.read(this.logger, dir);
+            await opts.read(this.logger, dir);
             if (opts.getValue("entryPointStrategy") ===
                 entry_point_1.EntryPointStrategy.Packages) {
                 this.logger.error(`Project at ${(0, paths_1.nicePath)(dir)} has entryPointStrategy set to packages, but nested packages are not supported.`);
                 continue;
             }
             this.options = opts;
-            const project = this.convert();
+            const project = await this.convert();
             if (project) {
                 this.validate(project);
                 projects.push(this.serializer.projectToObject(project, process.cwd()));
@@ -410,6 +445,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         return result;
     }
 };
+exports.Application = Application;
 /**
  * The version number of TypeDoc.
  */
@@ -438,7 +474,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("entryPoints")
 ], Application.prototype, "entryPoints", void 0);
-Application = Application_1 = __decorate([
+exports.Application = Application = Application_1 = __decorate([
     (0, component_1.Component)({ name: "application", internal: true })
 ], Application);
-exports.Application = Application;

package/dist/lib/cli.js

@@ -33,27 +33,32 @@ const ExitCodes = {
     ExceptionThrown: 6,
 };
 const td = __importStar(require("typedoc"));
-const app = new td.Application();
-app.options.addReader(new td.ArgumentsReader(0));
-app.options.addReader(new td.TypeDocReader());
-app.options.addReader(new td.PackageJsonReader());
-app.options.addReader(new td.TSConfigReader());
-app.options.addReader(new td.ArgumentsReader(300));
-void run(app)
-    .catch((error) => {
-    console.error("TypeDoc exiting with unexpected error:");
-    console.error(error);
-    if (app.options.getValue("skipErrorChecking")) {
-        console.error("Try turning off --skipErrorChecking. If TypeDoc still crashes, please report a bug.");
+void main();
+async function main() {
+    let app;
+    try {
+        const start = Date.now();
+        app = await td.Application.bootstrapWithPlugins({}, [
+            new td.ArgumentsReader(0),
+            new td.TypeDocReader(),
+            new td.PackageJsonReader(),
+            new td.TSConfigReader(),
+            new td.ArgumentsReader(300),
+        ]);
+        const exitCode = await run(app);
+        app.logger.verbose(`Full run took ${Date.now() - start}ms`);
+        process.exit(exitCode);
     }
-    return ExitCodes.ExceptionThrown;
-})
-    .then((exitCode) => {
-    process.exitCode = exitCode;
-});
+    catch (error) {
+        console.error("TypeDoc exiting with unexpected error:");
+        console.error(error);
+        if (app?.options.getValue("skipErrorChecking")) {
+            console.error("Try turning off --skipErrorChecking. If TypeDoc still crashes, please report a bug.");
+        }
+        process.exit(ExitCodes.ExceptionThrown);
+    }
+}
 async function run(app) {
-    const start = Date.now();
-    await app.bootstrapWithPlugins();
     if (app.options.getValue("version")) {
         console.log(app.toString());
         return ExitCodes.Ok;
@@ -85,7 +90,7 @@ async function run(app) {
         });
         return ExitCodes.Ok;
     }
-    const project = app.convert();
+    const project = await app.convert();
     if (!project) {
         return ExitCodes.CompileError;
     }
@@ -120,6 +125,5 @@ async function run(app) {
             return ExitCodes.OutputError;
         }
     }
-    app.logger.verbose(`Full run took ${Date.now() - start}ms`);
     return ExitCodes.Ok;
 }

package/dist/lib/converter/comments/blockLexer.js

@@ -259,7 +259,7 @@ function* lexBlockComment2(file, pos, end, linkTags, checker) {
             linkTags[linkTagIndex].pos === token.pos - 1) {
             const link = linkTags[linkTagIndex];
             if (link.name) {
-                const tsTarget = checker?.getSymbolAtLocation(link.name);
+                const tsTarget = checker?.getSymbolAtLocation(getRightmostName(link.name));
                 if (tsTarget) {
                     token.tsLinkTarget = new ReflectionSymbolId_1.ReflectionSymbolId((0, symbols_1.resolveAliasedSymbol)(tsTarget, checker));
                     token.tsLinkText = link.text.replace(/^\s*\|\s*/, "");
@@ -368,3 +368,12 @@ function discoverIndent(file, pos, end) {
     const commentHasStars = pos < end && file[pos] === "*";
     return [commentHasStars, indent];
 }
+function getRightmostName(name) {
+    if (typescript_1.default.isJSDocMemberName(name)) {
+        return name.right;
+    }
+    if (typescript_1.default.isQualifiedName(name)) {
+        return name.right;
+    }
+    return name;
+}

package/dist/lib/converter/comments/declarationReference.js

@@ -315,6 +315,8 @@ function parseDeclarationReference(source, pos, end) {
         symbolReference = ref[0];
         pos = ref[1];
     }
+    if (!moduleSource && !symbolReference)
+        return;
     return [
         {
             moduleSource,

package/dist/lib/converter/comments/declarationReferenceResolver.js

@@ -126,7 +126,8 @@ function resolveKeyword(refl, kw) {
             break;
         case "new":
         case "constructor":
-            if (refl.kindOf(models_1.ReflectionKind.ClassOrInterface | models_1.ReflectionKind.TypeLiteral)) {
+            if (refl.kindOf(models_1.ReflectionKind.ClassOrInterface |
+                models_1.ReflectionKind.TypeLiteral)) {
                 const ctor = refl.children?.find((c) => c.kindOf(models_1.ReflectionKind.Constructor));
                 return ctor?.signatures;
             }

package/dist/lib/converter/comments/discovery.js

@@ -91,7 +91,6 @@ const wantedKinds = {
     [models_1.ReflectionKind.Accessor]: [typescript_1.default.SyntaxKind.PropertyDeclaration],
     [models_1.ReflectionKind.GetSignature]: [typescript_1.default.SyntaxKind.GetAccessor],
     [models_1.ReflectionKind.SetSignature]: [typescript_1.default.SyntaxKind.SetAccessor],
-    [models_1.ReflectionKind.ObjectLiteral]: [typescript_1.default.SyntaxKind.ObjectLiteralExpression],
     [models_1.ReflectionKind.TypeAlias]: [typescript_1.default.SyntaxKind.TypeAliasDeclaration],
     [models_1.ReflectionKind.Reference]: [
         typescript_1.default.SyntaxKind.NamespaceExport,

package/dist/lib/converter/comments/lexer.js

@@ -10,4 +10,4 @@ var TokenSyntaxKind;
     TokenSyntaxKind["Tag"] = "tag";
     TokenSyntaxKind["Code"] = "code";
     TokenSyntaxKind["TypeAnnotation"] = "type";
-})(TokenSyntaxKind = exports.TokenSyntaxKind || (exports.TokenSyntaxKind = {}));
+})(TokenSyntaxKind || (exports.TokenSyntaxKind = TokenSyntaxKind = {}));

package/dist/lib/converter/comments/linkResolver.d.ts

@@ -13,5 +13,8 @@ export type ExternalResolveResult = {
  *   on and TypeScript resolved the link to some symbol, the ID of that symbol.
  */
 export type ExternalSymbolResolver = (ref: DeclarationReference, refl: Reflection, part: Readonly<CommentDisplayPart> | undefined, symbolId: ReflectionSymbolId | undefined) => ExternalResolveResult | string | undefined;
-export declare function resolveLinks(comment: Comment, reflection: Reflection, externalResolver: ExternalSymbolResolver): void;
-export declare function resolvePartLinks(reflection: Reflection, parts: readonly CommentDisplayPart[], externalResolver: ExternalSymbolResolver): CommentDisplayPart[];
+export type LinkResolverOptions = {
+    preserveLinkText: boolean;
+};
+export declare function resolveLinks(comment: Comment, reflection: Reflection, externalResolver: ExternalSymbolResolver, options: LinkResolverOptions): void;
+export declare function resolvePartLinks(reflection: Reflection, parts: readonly CommentDisplayPart[], externalResolver: ExternalSymbolResolver, options: LinkResolverOptions): CommentDisplayPart[];

package/dist/lib/converter/comments/linkResolver.js

@@ -9,31 +9,31 @@ const models_1 = require("../../models");
 const declarationReference_1 = require("./declarationReference");
 const declarationReferenceResolver_1 = require("./declarationReferenceResolver");
 const urlPrefix = /^(http|ftp)s?:\/\//;
-function resolveLinks(comment, reflection, externalResolver) {
-    comment.summary = resolvePartLinks(reflection, comment.summary, externalResolver);
+function resolveLinks(comment, reflection, externalResolver, options) {
+    comment.summary = resolvePartLinks(reflection, comment.summary, externalResolver, options);
     for (const tag of comment.blockTags) {
-        tag.content = resolvePartLinks(reflection, tag.content, externalResolver);
+        tag.content = resolvePartLinks(reflection, tag.content, externalResolver, options);
     }
     if (reflection instanceof models_1.DeclarationReflection && reflection.readme) {
-        reflection.readme = resolvePartLinks(reflection, reflection.readme, externalResolver);
+        reflection.readme = resolvePartLinks(reflection, reflection.readme, externalResolver, options);
     }
 }
 exports.resolveLinks = resolveLinks;
-function resolvePartLinks(reflection, parts, externalResolver) {
-    return parts.flatMap((part) => processPart(reflection, part, externalResolver));
+function resolvePartLinks(reflection, parts, externalResolver, options) {
+    return parts.flatMap((part) => processPart(reflection, part, externalResolver, options));
 }
 exports.resolvePartLinks = resolvePartLinks;
-function processPart(reflection, part, externalResolver) {
+function processPart(reflection, part, externalResolver, options) {
     if (part.kind === "inline-tag") {
         if (part.tag === "@link" ||
             part.tag === "@linkcode" ||
             part.tag === "@linkplain") {
-            return resolveLinkTag(reflection, part, externalResolver);
+            return resolveLinkTag(reflection, part, externalResolver, options);
         }
     }
     return part;
 }
-function resolveLinkTag(reflection, part, externalResolver) {
+function resolveLinkTag(reflection, part, externalResolver, options) {
     let defaultDisplayText = "";
     let pos = 0;
     const end = part.text.length;
@@ -49,7 +49,9 @@ function resolveLinkTag(reflection, part, externalResolver) {
         if (tsTarget) {
             target = tsTarget;
             pos = end;
-            defaultDisplayText = part.tsLinkText || target.name;
+            defaultDisplayText =
+                part.tsLinkText ||
+                    (options.preserveLinkText ? part.text : target.name);
         }
         else if (declRef) {
             // If we didn't find a target, we might be pointing to a symbol in another project that will be merged in
@@ -58,7 +60,9 @@ function resolveLinkTag(reflection, part, externalResolver) {
             const externalResolveResult = externalResolver(declRef[0], reflection, part, part.target instanceof models_1.ReflectionSymbolId
                 ? part.target
                 : undefined);
-            defaultDisplayText = part.text.substring(0, pos);
+            defaultDisplayText = options.preserveLinkText
+                ? part.text
+                : part.text.substring(0, pos);
             switch (typeof externalResolveResult) {
                 case "string":
                     target = externalResolveResult;
@@ -75,14 +79,18 @@ function resolveLinkTag(reflection, part, externalResolver) {
         target = (0, declarationReferenceResolver_1.resolveDeclarationReference)(reflection, declRef[0]);
         pos = declRef[1];
         if (target) {
-            defaultDisplayText = target.name;
+            defaultDisplayText = options.preserveLinkText
+                ? part.text
+                : target.name;
         }
         else {
             // If we didn't find a link, it might be a @link tag to an external symbol, check that next.
             const externalResolveResult = externalResolver(declRef[0], reflection, part, part.target instanceof models_1.ReflectionSymbolId
                 ? part.target
                 : undefined);
-            defaultDisplayText = part.text.substring(0, pos);
+            defaultDisplayText = options.preserveLinkText
+                ? part.text
+                : part.text.substring(0, pos);
             switch (typeof externalResolveResult) {
                 case "string":
                     target = externalResolveResult;

package/dist/lib/converter/comments/parser.js

@@ -135,7 +135,8 @@ function blockTag(comment, lexer, config, warning) {
     if (tagName === "@example" && config.jsDocCompatibility.exampleTag) {
         content = exampleBlockContent(comment, lexer, config, warning);
     }
-    else if (tagName === "@default" && config.jsDocCompatibility.defaultTag) {
+    else if (["@default", "@defaultValue"].includes(tagName) &&
+        config.jsDocCompatibility.defaultTag) {
         content = defaultBlockContent(comment, lexer, config, warning);
     }
     else {

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

@@ -36,6 +36,8 @@ export declare class Converter extends ChildableComponent<Application, Converter
     externalSymbolLinkMappings: Record<string, Record<string, string>>;
     /** @internal */
     useTsLinkResolution: boolean;
+    /** @internal */
+    preserveLinkText: boolean;
     private _config?;
     private _externalSymbolResolvers;
     get config(): CommentParserConfig;

package/dist/lib/converter/converter.js

@@ -122,10 +122,10 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
     }
     resolveLinks(comment, owner) {
         if (comment instanceof index_1.Comment) {
-            (0, linkResolver_1.resolveLinks)(comment, owner, (ref, part, refl, id) => this.resolveExternalLink(ref, part, refl, id));
+            (0, linkResolver_1.resolveLinks)(comment, owner, (ref, part, refl, id) => this.resolveExternalLink(ref, part, refl, id), { preserveLinkText: this.preserveLinkText });
         }
         else {
-            return (0, linkResolver_1.resolvePartLinks)(owner, comment, (ref, part, refl, id) => this.resolveExternalLink(ref, part, refl, id));
+            return (0, linkResolver_1.resolvePartLinks)(owner, comment, (ref, part, refl, id) => this.resolveExternalLink(ref, part, refl, id), { preserveLinkText: this.preserveLinkText });
         }
     }
     /**
@@ -192,13 +192,13 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         }
         const allExports = getExports(context, node, symbol);
         for (const exp of allExports.filter((exp) => isDirectExport(context.resolveAliasedSymbol(exp), node))) {
-            (0, symbols_1.convertSymbol)(moduleContext, exp);
+            this.convertSymbol(moduleContext, exp);
         }
         return moduleContext;
     }
     convertReExports(moduleContext, node) {
         for (const exp of getExports(moduleContext, node, moduleContext.project.getSymbolFromReflection(moduleContext.scope)).filter((exp) => !isDirectExport(moduleContext.resolveAliasedSymbol(exp), node))) {
-            (0, symbols_1.convertSymbol)(moduleContext, exp);
+            this.convertSymbol(moduleContext, exp);
         }
     }
     /**
@@ -210,8 +210,8 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
     resolve(context) {
         this.trigger(Converter_1.EVENT_RESOLVE_BEGIN, context);
         const project = context.project;
-        for (const reflection of Object.values(project.reflections)) {
-            this.trigger(Converter_1.EVENT_RESOLVE, context, reflection);
+        for (const id in project.reflections) {
+            this.trigger(Converter_1.EVENT_RESOLVE, context, project.reflections[id]);
         }
         this.trigger(Converter_1.EVENT_RESOLVE_END, context);
     }
@@ -248,6 +248,7 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         return this._config;
     }
 };
+exports.Converter = Converter;
 /**
  * General events
  */
@@ -343,14 +344,16 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("useTsLinkResolution")
 ], Converter.prototype, "useTsLinkResolution", void 0);
-Converter = Converter_1 = __decorate([
+__decorate([
+    (0, utils_1.BindOption)("preserveLinkText")
+], Converter.prototype, "preserveLinkText", void 0);
+exports.Converter = Converter = Converter_1 = __decorate([
     (0, component_1.Component)({
         name: "converter",
         internal: true,
         childClass: components_1.ConverterComponent,
     })
 ], Converter);
-exports.Converter = Converter;
 function getSymbolForModuleLike(context, node) {
     const symbol = context.checker.getSymbolAtLocation(node) ?? node.symbol;
     if (symbol) {
@@ -362,7 +365,9 @@ function getSymbolForModuleLike(context, node) {
     const sourceFile = node.getSourceFile();
     const globalSymbols = context.checker
         .getSymbolsInScope(node, typescript_1.default.SymbolFlags.ModuleMember)
-        .filter((s) => s.getDeclarations()?.some((d) => d.getSourceFile() === sourceFile));
+        .filter((s) => s
+        .getDeclarations()
+        ?.some((d) => d.getSourceFile() === sourceFile));
     // Detect declaration files with declare module "foo" as their only export
     // and lift that up one level as the source file symbol
     if (globalSymbols.length === 1 &&

package/dist/lib/converter/factories/index-signature.js

@@ -16,7 +16,8 @@ function convertIndexSignature(context, symbol) {
         // and number index signatures... { [x: string]: 1 | 2; [x: number]: 2 }
         // will be misrepresented.
         const indexDeclaration = indexSymbol.getDeclarations()?.[0];
-        (0, assert_1.default)(indexDeclaration && typescript_1.default.isIndexSignatureDeclaration(indexDeclaration));
+        (0, assert_1.default)(indexDeclaration &&
+            typescript_1.default.isIndexSignatureDeclaration(indexDeclaration));
         const param = indexDeclaration.parameters[0];
         (0, assert_1.default)(param && typescript_1.default.isParameter(param));
         const index = new models_1.SignatureReflection("__index", models_1.ReflectionKind.IndexSignature, context.scope);

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

@@ -217,6 +217,7 @@ let CategoryPlugin = CategoryPlugin_1 = class CategoryPlugin extends components_
         return aWeight - bWeight;
     }
 };
+exports.CategoryPlugin = CategoryPlugin;
 // For use in static methods
 CategoryPlugin.defaultCategory = "Other";
 CategoryPlugin.WEIGHTS = [];
@@ -232,7 +233,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("searchCategoryBoosts")
 ], CategoryPlugin.prototype, "boosts", void 0);
-CategoryPlugin = CategoryPlugin_1 = __decorate([
+exports.CategoryPlugin = CategoryPlugin = CategoryPlugin_1 = __decorate([
     (0, components_1.Component)({ name: "category" })
 ], CategoryPlugin);
-exports.CategoryPlugin = CategoryPlugin;

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

@@ -289,11 +289,15 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
         if (!signatures.length) {
             return;
         }
-        const comment = reflection.comment;
+        const comment = reflection.kindOf(models_1.ReflectionKind.ClassOrInterface)
+            ? undefined
+            : reflection.comment;
         // Since this reflection has signatures, remove the comment from the parent
         // reflection. This is important so that in type aliases we don't end up with
         // a comment rendered twice.
-        delete reflection.comment;
+        if (!reflection.kindOf(models_1.ReflectionKind.ClassOrInterface)) {
+            delete reflection.comment;
+        }
         for (const signature of signatures) {
             const childComment = (signature.comment || (signature.comment = comment?.clone()));
             if (!childComment)
@@ -399,6 +403,7 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
         return isHidden;
     }
 };
+exports.CommentPlugin = CommentPlugin;
 __decorate([
     (0, utils_1.BindOption)("excludeTags")
 ], CommentPlugin.prototype, "excludeTags", void 0);
@@ -414,10 +419,9 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("excludeNotDocumented")
 ], CommentPlugin.prototype, "excludeNotDocumented", void 0);
-CommentPlugin = __decorate([
+exports.CommentPlugin = CommentPlugin = __decorate([
     (0, components_1.Component)({ name: "comment" })
 ], CommentPlugin);
-exports.CommentPlugin = CommentPlugin;
 function inTypeLiteral(refl) {
     while (refl) {
         if (refl.kind === models_1.ReflectionKind.TypeLiteral) {