typedoc 0.24.0-beta.6 → 0.24.0-beta.7

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

@@ -249,7 +249,8 @@ function* lexBlockComment2(file, pos, end, linkTags, checker) {
             if (link.name) {
                 const tsTarget = checker?.getSymbolAtLocation(link.name);
                 if (tsTarget) {
-                    token.linkTarget = new ReflectionSymbolId_1.ReflectionSymbolId((0, symbols_1.resolveAliasedSymbol)(tsTarget, checker));
+                    token.tsLinkTarget = new ReflectionSymbolId_1.ReflectionSymbolId((0, symbols_1.resolveAliasedSymbol)(tsTarget, checker));
+                    token.tsLinkText = link.text.replace(/^\s*\|\s*/, "");
                 }
             }
         }

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

@@ -7,6 +7,7 @@ export interface CommentParserConfig {
     inlineTags: Set<string>;
     modifierTags: Set<string>;
 }
-export declare function getComment(symbol: ts.Symbol, kind: ReflectionKind, config: CommentParserConfig, logger: Logger, commentStyle: CommentStyle, checker: ts.TypeChecker): Comment | undefined;
-export declare function getSignatureComment(declaration: ts.SignatureDeclaration | ts.JSDocSignature, config: CommentParserConfig, logger: Logger, commentStyle: CommentStyle, checker: ts.TypeChecker): Comment | undefined;
-export declare function getJsDocComment(declaration: ts.JSDocPropertyLikeTag | ts.JSDocCallbackTag | ts.JSDocTypedefTag | ts.JSDocTemplateTag | ts.JSDocEnumTag, config: CommentParserConfig, logger: Logger, checker: ts.TypeChecker): Comment | undefined;
+export declare function clearCommentCache(): void;
+export declare function getComment(symbol: ts.Symbol, kind: ReflectionKind, config: CommentParserConfig, logger: Logger, commentStyle: CommentStyle, checker: ts.TypeChecker | undefined): Comment | undefined;
+export declare function getSignatureComment(declaration: ts.SignatureDeclaration | ts.JSDocSignature, config: CommentParserConfig, logger: Logger, commentStyle: CommentStyle, checker: ts.TypeChecker | undefined): Comment | undefined;
+export declare function getJsDocComment(declaration: ts.JSDocPropertyLikeTag | ts.JSDocCallbackTag | ts.JSDocTypedefTag | ts.JSDocTemplateTag | ts.JSDocEnumTag, config: CommentParserConfig, logger: Logger, checker: ts.TypeChecker | undefined): Comment | undefined;

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

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getJsDocComment = exports.getSignatureComment = exports.getComment = void 0;
+exports.getJsDocComment = exports.getSignatureComment = exports.getComment = exports.clearCommentCache = void 0;
 const typescript_1 = __importDefault(require("typescript"));
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
@@ -18,7 +18,14 @@ const jsDocCommentKinds = [
     typescript_1.default.SyntaxKind.JSDocTemplateTag,
     typescript_1.default.SyntaxKind.JSDocEnumTag,
 ];
-const commentCache = new WeakMap();
+let commentCache = new WeakMap();
+// We need to do this for tests so that changing the tsLinkResolution option
+// actually works. Without it, we'd get the old parsed comment which doesn't
+// have the TS symbols attached.
+function clearCommentCache() {
+    commentCache = new WeakMap();
+}
+exports.clearCommentCache = clearCommentCache;
 function getCommentWithCache(discovered, config, logger, checker) {
     if (!discovered)
         return;

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

@@ -12,5 +12,6 @@ export interface Token {
     kind: TokenSyntaxKind;
     text: string;
     pos: number;
-    linkTarget?: ReflectionSymbolId;
+    tsLinkTarget?: ReflectionSymbolId;
+    tsLinkText?: string;
 }

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

@@ -1,9 +1,17 @@
-import { Comment, CommentDisplayPart, Reflection } from "../../models";
+import { Comment, CommentDisplayPart, Reflection, ReflectionSymbolId } from "../../models";
 import { DeclarationReference } from "./declarationReference";
 export type ExternalResolveResult = {
     target: string;
     caption?: string;
 };
-export type ExternalSymbolResolver = (ref: DeclarationReference, refl: Reflection, part: Readonly<CommentDisplayPart> | undefined) => ExternalResolveResult | string | undefined;
-export declare function resolveLinks(comment: Comment, reflection: Reflection, externalResolver: ExternalSymbolResolver, useTsResolution: boolean): void;
-export declare function resolvePartLinks(reflection: Reflection, parts: readonly CommentDisplayPart[], externalResolver: ExternalSymbolResolver, useTsResolution: boolean): CommentDisplayPart[];
+/**
+ * @param ref - Parsed declaration reference to resolve. This may be created automatically for some symbol, or
+ *   parsed from user input.
+ * @param refl - Reflection that contains the resolved link
+ * @param part - If the declaration reference was created from a comment, the originating part.
+ * @param symbolId - If the declaration reference was created from a symbol, or `useTsLinkResolution` is turned
+ *   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[];

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, useTsResolution) {
-    comment.summary = resolvePartLinks(reflection, comment.summary, externalResolver, useTsResolution);
+function resolveLinks(comment, reflection, externalResolver) {
+    comment.summary = resolvePartLinks(reflection, comment.summary, externalResolver);
     for (const tag of comment.blockTags) {
-        tag.content = resolvePartLinks(reflection, tag.content, externalResolver, useTsResolution);
+        tag.content = resolvePartLinks(reflection, tag.content, externalResolver);
     }
     if (reflection instanceof models_1.DeclarationReflection && reflection.readme) {
-        reflection.readme = resolvePartLinks(reflection, reflection.readme, externalResolver, useTsResolution);
+        reflection.readme = resolvePartLinks(reflection, reflection.readme, externalResolver);
     }
 }
 exports.resolveLinks = resolveLinks;
-function resolvePartLinks(reflection, parts, externalResolver, useTsResolution) {
-    return parts.flatMap((part) => processPart(reflection, part, externalResolver, useTsResolution));
+function resolvePartLinks(reflection, parts, externalResolver) {
+    return parts.flatMap((part) => processPart(reflection, part, externalResolver));
 }
 exports.resolvePartLinks = resolvePartLinks;
-function processPart(reflection, part, externalResolver, useTsResolution) {
+function processPart(reflection, part, externalResolver) {
     if (part.kind === "inline-tag") {
         if (part.tag === "@link" ||
             part.tag === "@linkcode" ||
             part.tag === "@linkplain") {
-            return resolveLinkTag(reflection, part, externalResolver, useTsResolution);
+            return resolveLinkTag(reflection, part, externalResolver);
         }
     }
     return part;
 }
-function resolveLinkTag(reflection, part, externalResolver, useTsResolution) {
+function resolveLinkTag(reflection, part, externalResolver) {
     let defaultDisplayText = "";
     let pos = 0;
     const end = part.text.length;
@@ -41,17 +41,36 @@ function resolveLinkTag(reflection, part, externalResolver, useTsResolution) {
         pos++;
     }
     let target;
-    if (useTsResolution && part.target instanceof models_1.ReflectionSymbolId) {
-        target = reflection.project.getReflectionFromSymbolId(part.target);
-        if (target) {
+    // Try to parse a declaration reference if we didn't use the TS symbol for resolution
+    const declRef = (0, declarationReference_1.parseDeclarationReference)(part.text, pos, end);
+    // Might already know where it should go if useTsLinkResolution is turned on
+    if (part.target instanceof models_1.ReflectionSymbolId) {
+        const tsTarget = reflection.project.getReflectionFromSymbolId(part.target);
+        if (tsTarget) {
+            target = tsTarget;
             pos = end;
-            defaultDisplayText =
-                part.text.replace(/^\s*[A-Z_$][\w$]*[ |]*/i, "") || target.name;
+            defaultDisplayText = part.tsLinkText || 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
+            // or some external symbol, so ask external resolvers to try resolution. Don't use regular declaration ref
+            // resolution in case it matches something that would have been merged in later.
+            const externalResolveResult = externalResolver(declRef[0], reflection, part, part.target instanceof models_1.ReflectionSymbolId
+                ? part.target
+                : undefined);
+            defaultDisplayText = part.text.substring(0, pos);
+            switch (typeof externalResolveResult) {
+                case "string":
+                    target = externalResolveResult;
+                    break;
+                case "object":
+                    target = externalResolveResult.target;
+                    defaultDisplayText =
+                        externalResolveResult.caption || defaultDisplayText;
+            }
         }
     }
-    // Try to parse a declaration reference if we didn't use the TS symbol for resolution
-    const declRef = !target && (0, declarationReference_1.parseDeclarationReference)(part.text, pos, end);
-    if (declRef) {
+    if (!target && declRef) {
         // Got one, great! Try to resolve the link
         target = (0, declarationReferenceResolver_1.resolveDeclarationReference)(reflection, declRef[0]);
         pos = declRef[1];
@@ -60,7 +79,9 @@ function resolveLinkTag(reflection, part, externalResolver, useTsResolution) {
         }
         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);
+            const externalResolveResult = externalResolver(declRef[0], reflection, part, part.target instanceof models_1.ReflectionSymbolId
+                ? part.target
+                : undefined);
             defaultDisplayText = part.text.substring(0, pos);
             switch (typeof externalResolveResult) {
                 case "string":

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

@@ -304,8 +304,9 @@ function inlineTag(lexer, block, config, warning) {
         tag: tagName.text,
         text: content.join(""),
     };
-    if (tagName.linkTarget) {
-        inlineTag.target = tagName.linkTarget;
+    if (tagName.tsLinkTarget) {
+        inlineTag.target = tagName.tsLinkTarget;
+        inlineTag.tsLinkText = tagName.tsLinkText;
     }
     block.push(inlineTag);
 }

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

@@ -78,6 +78,9 @@ export declare class Context {
     trigger(name: string, reflection: Reflection, node?: ts.Node): void;
     /** @internal */
     setActiveProgram(program: ts.Program | undefined): void;
+    getComment(symbol: ts.Symbol, kind: ReflectionKind): import("../models/index").Comment | undefined;
+    getJsDocComment(declaration: ts.JSDocPropertyLikeTag | ts.JSDocCallbackTag | ts.JSDocTypedefTag | ts.JSDocTemplateTag | ts.JSDocEnumTag): import("../models/index").Comment | undefined;
+    getSignatureComment(declaration: ts.SignatureDeclaration | ts.JSDocSignature): import("../models/index").Comment | undefined;
     /**
      * @param callback  The callback function that should be executed with the changed context.
      */

package/dist/lib/converter/context.js

@@ -114,10 +114,10 @@ class Context {
         if (exportSymbol &&
             reflection.kind &
                 (index_1.ReflectionKind.SomeModule | index_1.ReflectionKind.Reference)) {
-            reflection.comment = (0, comments_1.getComment)(exportSymbol, reflection.kind, this.converter.config, this.logger, this.converter.commentStyle, this.checker);
+            reflection.comment = (0, comments_1.getComment)(exportSymbol, reflection.kind, this.converter.config, this.logger, this.converter.commentStyle, this.converter.useTsLinkResolution ? this.checker : undefined);
         }
         if (symbol && !reflection.comment) {
-            reflection.comment = (0, comments_1.getComment)(symbol, reflection.kind, this.converter.config, this.logger, this.converter.commentStyle, this.checker);
+            reflection.comment = (0, comments_1.getComment)(symbol, reflection.kind, this.converter.config, this.logger, this.converter.commentStyle, this.converter.useTsLinkResolution ? this.checker : undefined);
         }
         if (this.shouldBeStatic) {
             reflection.setFlag(index_1.ReflectionFlag.Static);
@@ -173,6 +173,15 @@ class Context {
     setActiveProgram(program) {
         this._program = program;
     }
+    getComment(symbol, kind) {
+        return (0, comments_1.getComment)(symbol, kind, this.converter.config, this.logger, this.converter.commentStyle, this.converter.useTsLinkResolution ? this.checker : undefined);
+    }
+    getJsDocComment(declaration) {
+        return (0, comments_1.getJsDocComment)(declaration, this.converter.config, this.logger, this.converter.useTsLinkResolution ? this.checker : undefined);
+    }
+    getSignatureComment(declaration) {
+        return (0, comments_1.getSignatureComment)(declaration, this.converter.config, this.logger, this.converter.commentStyle, this.converter.useTsLinkResolution ? this.checker : undefined);
+    }
     /**
      * @param callback  The callback function that should be executed with the changed context.
      */

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

@@ -1,12 +1,12 @@
 import ts from "typescript";
 import type { Application } from "../application";
-import { Comment, CommentDisplayPart, ProjectReflection, Reflection, SomeType } from "../models/index";
+import { Comment, CommentDisplayPart, ProjectReflection, Reflection, ReflectionSymbolId, SomeType } from "../models/index";
 import { Context } from "./context";
 import { ConverterComponent } from "./components";
 import { ChildableComponent } from "../utils/component";
 import { MinimalSourceFile } from "../utils";
 import type { DocumentationEntryPoint } from "../utils/entry-point";
-import { CommentParserConfig } from "./comments";
+import type { CommentParserConfig } from "./comments";
 import type { CommentStyle, ValidationOptions } from "../utils/options/declaration";
 import { ExternalSymbolResolver, ExternalResolveResult } from "./comments/linkResolver";
 import type { DeclarationReference } from "./comments/declarationReference";
@@ -137,7 +137,7 @@ export declare class Converter extends ChildableComponent<Application, Converter
      */
     addUnknownSymbolResolver(resolver: ExternalSymbolResolver): void;
     /** @internal */
-    resolveExternalLink(ref: DeclarationReference, refl: Reflection, part?: CommentDisplayPart): ExternalResolveResult | string | undefined;
+    resolveExternalLink(ref: DeclarationReference, refl: Reflection, part: CommentDisplayPart | undefined, symbolId: ReflectionSymbolId | undefined): ExternalResolveResult | string | undefined;
     resolveLinks(comment: Comment, owner: Reflection): void;
     resolveLinks(parts: readonly CommentDisplayPart[], owner: Reflection): CommentDisplayPart[];
     /**

package/dist/lib/converter/converter.js

@@ -22,7 +22,6 @@ const converter_events_1 = require("./converter-events");
 const symbols_1 = require("./symbols");
 const paths_1 = require("../utils/paths");
 const enum_1 = require("../utils/enum");
-const comments_1 = require("./comments");
 const parser_1 = require("./comments/parser");
 const rawLexer_1 = require("./comments/rawLexer");
 const linkResolver_1 = require("./comments/linkResolver");
@@ -114,19 +113,19 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         this._externalSymbolResolvers.push(resolver);
     }
     /** @internal */
-    resolveExternalLink(ref, refl, part) {
+    resolveExternalLink(ref, refl, part, symbolId) {
         for (const resolver of this._externalSymbolResolvers) {
-            const resolved = resolver(ref, refl, part);
+            const resolved = resolver(ref, refl, part, symbolId);
             if (resolved)
                 return resolved;
         }
     }
     resolveLinks(comment, owner) {
         if (comment instanceof index_1.Comment) {
-            (0, linkResolver_1.resolveLinks)(comment, owner, (ref, part, refl) => this.resolveExternalLink(ref, part, refl), this.useTsLinkResolution);
+            (0, linkResolver_1.resolveLinks)(comment, owner, (ref, part, refl, id) => this.resolveExternalLink(ref, part, refl, id));
         }
         else {
-            return (0, linkResolver_1.resolvePartLinks)(owner, comment, (ref, part, refl) => this.resolveExternalLink(ref, part, refl), this.useTsLinkResolution);
+            return (0, linkResolver_1.resolvePartLinks)(owner, comment, (ref, part, refl, id) => this.resolveExternalLink(ref, part, refl, id));
         }
     }
     /**
@@ -165,8 +164,7 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
             // create modules for each entry. Register the project as this module.
             context.project.registerReflection(context.project, symbol);
             context.project.comment =
-                symbol &&
-                    (0, comments_1.getComment)(symbol, context.project.kind, this.config, this.application.logger, this.commentStyle, context.checker);
+                symbol && context.getComment(symbol, context.project.kind);
             context.trigger(Converter_1.EVENT_CREATE_DECLARATION, context.project);
             moduleContext = context;
         }

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

@@ -10,7 +10,6 @@ const models_1 = require("../../models");
 const converter_events_1 = require("../converter-events");
 const convert_expression_1 = require("../convert-expression");
 const reflections_1 = require("../utils/reflections");
-const comments_1 = require("../comments");
 const ReflectionSymbolId_1 = require("../../models/reflections/ReflectionSymbolId");
 function createSignature(context, kind, signature, symbol, declaration) {
     var _a;
@@ -35,7 +34,7 @@ function createSignature(context, kind, signature, symbol, declaration) {
         (!parentReflection.comment ||
             !(parentReflection.conversionFlags &
                 models_1.ConversionFlags.VariableOrPropertySource))) {
-        sigRef.comment = (0, comments_1.getSignatureComment)(declaration, context.converter.config, context.logger, context.converter.commentStyle, context.checker);
+        sigRef.comment = context.getSignatureComment(declaration);
     }
     sigRef.typeParameters = convertTypeParameters(sigRefCtx, sigRef, signature.typeParameters);
     const parameterSymbols = signature.thisParameter
@@ -79,9 +78,9 @@ function convertParameters(context, sigRef, parameters, parameterNodes) {
             typescript_1.default.isJSDocParameterTag(declaration));
         const paramRefl = new models_1.ParameterReflection(/__\d+/.test(param.name) ? "__namedParameters" : param.name, models_1.ReflectionKind.Parameter, sigRef);
         if (declaration && typescript_1.default.isJSDocParameterTag(declaration)) {
-            paramRefl.comment = (0, comments_1.getJsDocComment)(declaration, context.converter.config, context.logger, context.checker);
+            paramRefl.comment = context.getJsDocComment(declaration);
         }
-        paramRefl.comment || (paramRefl.comment = (0, comments_1.getComment)(param, paramRefl.kind, context.converter.config, context.logger, context.converter.commentStyle, context.checker));
+        paramRefl.comment || (paramRefl.comment = context.getComment(param, paramRefl.kind));
         context.registerReflection(paramRefl, param);
         context.trigger(converter_events_1.ConverterEvents.CREATE_PARAMETER, paramRefl);
         let type;
@@ -125,7 +124,7 @@ function convertParameterNodes(context, sigRef, parameters) {
             ? "__namedParameters"
             : param.name.getText(), models_1.ReflectionKind.Parameter, sigRef);
         if (typescript_1.default.isJSDocParameterTag(param)) {
-            paramRefl.comment = (0, comments_1.getJsDocComment)(param, context.converter.config, context.logger, context.checker);
+            paramRefl.comment = context.getJsDocComment(param);
         }
         context.registerReflection(paramRefl, context.getSymbolAtLocation(param));
         context.trigger(converter_events_1.ConverterEvents.CREATE_PARAMETER, paramRefl);
@@ -191,7 +190,7 @@ function createTypeParamReflection(param, context) {
     }
     context.registerReflection(paramRefl, param.symbol);
     if (typescript_1.default.isJSDocTemplateTag(param.parent)) {
-        paramRefl.comment = (0, comments_1.getJsDocComment)(param.parent, context.converter.config, context.logger, context.checker);
+        paramRefl.comment = context.getJsDocComment(param.parent);
     }
     context.trigger(converter_events_1.ConverterEvents.CREATE_TYPE_PARAMETER, paramRefl, param);
     return paramRefl;

package/dist/lib/converter/jsdoc.js

@@ -11,7 +11,6 @@ const assert_1 = require("assert");
 const typescript_1 = __importDefault(require("typescript"));
 const models_1 = require("../models");
 const ReflectionSymbolId_1 = require("../models/reflections/ReflectionSymbolId");
-const comments_1 = require("./comments");
 const converter_events_1 = require("./converter-events");
 const signature_1 = require("./factories/signature");
 function convertJsDocAlias(context, symbol, declaration, exportSymbol) {
@@ -29,7 +28,7 @@ function convertJsDocAlias(context, symbol, declaration, exportSymbol) {
         return;
     }
     const reflection = context.createDeclarationReflection(models_1.ReflectionKind.TypeAlias, symbol, exportSymbol);
-    reflection.comment = (0, comments_1.getJsDocComment)(declaration, context.converter.config, context.logger, context.checker);
+    reflection.comment = context.getJsDocComment(declaration);
     reflection.type = context.converter.convertType(context.withScope(reflection), declaration.typeExpression?.type);
     convertTemplateParameters(context.withScope(reflection), declaration.parent);
     context.finalizeDeclarationReflection(reflection);
@@ -37,7 +36,7 @@ function convertJsDocAlias(context, symbol, declaration, exportSymbol) {
 exports.convertJsDocAlias = convertJsDocAlias;
 function convertJsDocCallback(context, symbol, declaration, exportSymbol) {
     const alias = context.createDeclarationReflection(models_1.ReflectionKind.TypeAlias, symbol, exportSymbol);
-    alias.comment = (0, comments_1.getJsDocComment)(declaration, context.converter.config, context.logger, context.checker);
+    alias.comment = context.getJsDocComment(declaration);
     context.finalizeDeclarationReflection(alias);
     const ac = context.withScope(alias);
     alias.type = convertJsDocSignature(ac, declaration.typeExpression);
@@ -46,7 +45,7 @@ function convertJsDocCallback(context, symbol, declaration, exportSymbol) {
 exports.convertJsDocCallback = convertJsDocCallback;
 function convertJsDocInterface(context, declaration, symbol, exportSymbol) {
     const reflection = context.createDeclarationReflection(models_1.ReflectionKind.Interface, symbol, exportSymbol);
-    reflection.comment = (0, comments_1.getJsDocComment)(declaration, context.converter.config, context.logger, context.checker);
+    reflection.comment = context.getJsDocComment(declaration);
     context.finalizeDeclarationReflection(reflection);
     const rc = context.withScope(reflection);
     const type = context.checker.getDeclaredTypeOfSymbol(symbol);

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

@@ -40,7 +40,7 @@ let LinkResolverPlugin = class LinkResolverPlugin extends components_1.Converter
         }
         for (const { type, owner } of (0, reflections_1.discoverAllReferenceTypes)(project, false)) {
             if (!type.reflection) {
-                const resolveResult = this.owner.resolveExternalLink(type.toDeclarationReference(), owner);
+                const resolveResult = this.owner.resolveExternalLink(type.toDeclarationReference(), owner, undefined, type.symbolId);
                 switch (typeof resolveResult) {
                     case "string":
                         type.externalUrl = resolveResult;

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

@@ -9,13 +9,16 @@ export type CommentDisplayPart = {
 } | InlineTagDisplayPart;
 /**
  * The `@link`, `@linkcode`, and `@linkplain` tags may have a `target`
- * property set indicating which reflection/url they link to.
+ * 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.
  */
 export interface InlineTagDisplayPart {
     kind: "inline-tag";
     tag: `@${string}`;
     text: string;
     target?: Reflection | string | ReflectionSymbolId;
+    tsLinkText?: string;
 }
 /**
  * A model that represents a single TypeDoc comment tag.
@@ -76,6 +79,7 @@ export declare class Comment {
         tag: `@${string}`;
         text: string;
         target?: string | Reflection | ReflectionSymbolId | undefined;
+        tsLinkText?: string | undefined;
     })[];
     static serializeDisplayParts(serializer: Serializer, parts: CommentDisplayPart[]): JSONOutput.CommentDisplayPart[];
     /** @hidden no point in showing this signature in api docs */

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

@@ -164,6 +164,7 @@ class Comment {
                 case "inline-tag": {
                     if (typeof part.target !== "number") {
                         // TS isn't quite smart enough here...
+                        // GERRIT this is wrong
                         return { ...part };
                     }
                     else {

package/dist/lib/serialization/schema.d.ts

@@ -182,6 +182,7 @@ export interface InlineTagDisplayPart {
     tag: `@${string}`;
     text: string;
     target?: string | number | ReflectionSymbolId;
+    tsLinkText?: string;
 }
 export interface SourceReference extends S<M.SourceReference, "fileName" | "line" | "character" | "url"> {
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.24.0-beta.6",
+  "version": "0.24.0-beta.7",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",