typedoc 0.24.0-beta.6 → 0.24.0-beta.8

package/dist/index.d.ts

@@ -2,6 +2,10 @@ export { Application } from "./lib/application";
 export { EventDispatcher, Event } from "./lib/utils/events";
 export { resetReflectionID } from "./lib/models/reflections/abstract";
 export { normalizePath } from "./lib/utils/fs";
+/**
+ * All symbols documented under the Models namespace are also available in the root import.
+ */
+export * as Models from "./lib/models";
 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

@@ -10,6 +10,18 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
@@ -17,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.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.normalizePath = exports.resetReflectionID = exports.Event = exports.EventDispatcher = exports.Application = void 0;
+exports.TypeScript = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = 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.normalizePath = 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");
@@ -27,6 +39,10 @@ var abstract_1 = require("./lib/models/reflections/abstract");
 Object.defineProperty(exports, "resetReflectionID", { enumerable: true, get: function () { return abstract_1.resetReflectionID; } });
 var fs_1 = require("./lib/utils/fs");
 Object.defineProperty(exports, "normalizePath", { enumerable: true, get: function () { return fs_1.normalizePath; } });
+/**
+ * All symbols documented under the Models namespace are also available in the root import.
+ */
+exports.Models = __importStar(require("./lib/models"));
 __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/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/discovery.js

@@ -173,7 +173,7 @@ function discoverSignatureComment(declaration, commentStyle) {
                     end: comment.end,
                 },
             ],
-            jsDoc: undefined,
+            jsDoc: comment,
         };
     }
     const text = node.getSourceFile().text;

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 = this.getComment(exportSymbol, reflection.kind);
         }
         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 = this.getComment(symbol, reflection.kind);
         }
         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";
@@ -27,6 +27,8 @@ export declare class Converter extends ChildableComponent<Application, Converter
     /** @internal */
     excludeProtected: boolean;
     /** @internal */
+    excludeReferences: boolean;
+    /** @internal */
     commentStyle: CommentStyle;
     /** @internal */
     validation: ValidationOptions;
@@ -57,13 +59,13 @@ export declare class Converter extends ChildableComponent<Application, Converter
      */
     /**
      * Triggered when the converter has created a declaration reflection.
-     * The listener will be given {@link Context} and a {@link DeclarationReflection}.
+     * The listener will be given {@link Context} and a {@link Models.DeclarationReflection}.
      * @event
      */
     static readonly EVENT_CREATE_DECLARATION: "createDeclaration";
     /**
      * Triggered when the converter has created a signature reflection.
-     * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} the declaration,
+     * The listener will be given {@link Context}, {@link Models.SignatureReflection} | {@link Models.ProjectReflection} the declaration,
      * `ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature | undefined`,
      * and `ts.Signature | undefined`. The signature will be undefined if the created signature is an index signature.
      * @event
@@ -71,13 +73,13 @@ export declare class Converter extends ChildableComponent<Application, Converter
     static readonly EVENT_CREATE_SIGNATURE: "createSignature";
     /**
      * Triggered when the converter has created a parameter reflection.
-     * The listener will be given {@link Context}, {@link ParameterReflection} and a `ts.Node?`
+     * The listener will be given {@link Context}, {@link Models.ParameterReflection} and a `ts.Node?`
      * @event
      */
     static readonly EVENT_CREATE_PARAMETER: "createParameter";
     /**
      * Triggered when the converter has created a type parameter reflection.
-     * The listener will be given {@link Context} and a {@link TypeParameterReflection}
+     * The listener will be given {@link Context} and a {@link Models.TypeParameterReflection}
      * @event
      */
     static readonly EVENT_CREATE_TYPE_PARAMETER: "createTypeParameter";
@@ -137,7 +139,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");
@@ -73,7 +72,6 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         this.compile(entryPoints, context);
         this.resolve(context);
         this.trigger(Converter_1.EVENT_END, context);
-        project.forgetTsReferences();
         return project;
     }
     /** @internal */
@@ -114,19 +112,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 +163,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;
         }
@@ -265,13 +262,13 @@ Converter.EVENT_END = converter_events_1.ConverterEvents.END;
  */
 /**
  * Triggered when the converter has created a declaration reflection.
- * The listener will be given {@link Context} and a {@link DeclarationReflection}.
+ * The listener will be given {@link Context} and a {@link Models.DeclarationReflection}.
  * @event
  */
 Converter.EVENT_CREATE_DECLARATION = converter_events_1.ConverterEvents.CREATE_DECLARATION;
 /**
  * Triggered when the converter has created a signature reflection.
- * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} the declaration,
+ * The listener will be given {@link Context}, {@link Models.SignatureReflection} | {@link Models.ProjectReflection} the declaration,
  * `ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature | undefined`,
  * and `ts.Signature | undefined`. The signature will be undefined if the created signature is an index signature.
  * @event
@@ -279,13 +276,13 @@ Converter.EVENT_CREATE_DECLARATION = converter_events_1.ConverterEvents.CREATE_D
 Converter.EVENT_CREATE_SIGNATURE = converter_events_1.ConverterEvents.CREATE_SIGNATURE;
 /**
  * Triggered when the converter has created a parameter reflection.
- * The listener will be given {@link Context}, {@link ParameterReflection} and a `ts.Node?`
+ * The listener will be given {@link Context}, {@link Models.ParameterReflection} and a `ts.Node?`
  * @event
  */
 Converter.EVENT_CREATE_PARAMETER = converter_events_1.ConverterEvents.CREATE_PARAMETER;
 /**
  * Triggered when the converter has created a type parameter reflection.
- * The listener will be given {@link Context} and a {@link TypeParameterReflection}
+ * The listener will be given {@link Context} and a {@link Models.TypeParameterReflection}
  * @event
  */
 Converter.EVENT_CREATE_TYPE_PARAMETER = converter_events_1.ConverterEvents.CREATE_TYPE_PARAMETER;
@@ -325,6 +322,9 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("excludeProtected")
 ], Converter.prototype, "excludeProtected", void 0);
+__decorate([
+    (0, utils_1.BindOption)("excludeReferences")
+], Converter.prototype, "excludeReferences", void 0);
 __decorate([
     (0, utils_1.BindOption)("commentStyle")
 ], Converter.prototype, "commentStyle", void 0);

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/converter/plugins/PackagePlugin.js

@@ -50,6 +50,7 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
             [converter_1.Converter.EVENT_RESOLVE_BEGIN]: this.onBeginResolve,
             [converter_1.Converter.EVENT_END]: () => {
                 delete this.readmeFile;
+                delete this.readmeContents;
                 delete this.packageJson;
             },
         });
@@ -62,6 +63,7 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
         this.addEntries(project);
         delete this.readmeFile;
         delete this.packageJson;
+        delete this.readmeContents;
     }
     onBegin() {
         this.readmeFile = undefined;
@@ -117,7 +119,7 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
                 project.name = project.packageName || "Documentation";
             }
             if (this.includeVersion) {
-                project.packageVersion = this.packageJson.version;
+                project.packageVersion = this.packageJson.version?.replace(/^v/, "");
             }
         }
         else if (!project.name) {

package/dist/lib/converter/symbols.js

@@ -80,7 +80,7 @@ function convertSymbol(context, symbol, exportSymbol) {
     // but aren't aliased symbols because `export *` was used.
     const previous = context.project.getReflectionFromSymbol(symbol);
     if (previous &&
-        previous.parent?.kindOf(models_1.ReflectionKind.Module | models_1.ReflectionKind.Project)) {
+        previous.parent?.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
         createAlias(previous, context, symbol, exportSymbol);
         return;
     }
@@ -191,7 +191,9 @@ function convertTypeAlias(context, symbol, exportSymbol) {
         typescript_1.default.isJSDocEnumTag(d));
     (0, assert_1.default)(declaration);
     if (typescript_1.default.isTypeAliasDeclaration(declaration)) {
-        if (symbol.getJsDocTags().some((tag) => tag.name === "interface")) {
+        if (context
+            .getComment(symbol, models_1.ReflectionKind.TypeAlias)
+            ?.hasModifier("@interface")) {
             return convertTypeAliasAsInterface(context, symbol, exportSymbol, declaration);
         }
         const reflection = context.createDeclarationReflection(models_1.ReflectionKind.TypeAlias, symbol, exportSymbol);
@@ -444,6 +446,8 @@ function convertAlias(context, symbol, exportSymbol) {
     }
 }
 function createAlias(target, context, symbol, exportSymbol) {
+    if (context.converter.excludeReferences)
+        return;
     // We already have this. Create a reference.
     const ref = new models_1.ReferenceReflection(exportSymbol?.name ?? symbol.name, target, context.scope);
     context.postReflectionCreation(ref, symbol, exportSymbol);
@@ -452,12 +456,13 @@ function createAlias(target, context, symbol, exportSymbol) {
 function convertVariable(context, symbol, exportSymbol) {
     const declaration = symbol.getDeclarations()?.[0];
     (0, assert_1.default)(declaration);
+    const comment = context.getComment(symbol, models_1.ReflectionKind.Variable);
     const type = context.checker.getTypeOfSymbolAtLocation(symbol, declaration);
     if (isEnumLike(context.checker, type, declaration) &&
-        symbol.getJsDocTags().some((tag) => tag.name === "enum")) {
+        comment?.hasModifier("@enum")) {
         return convertVariableAsEnum(context, symbol, exportSymbol);
     }
-    if (symbol.getJsDocTags().some((tag) => tag.name === "namespace")) {
+    if (comment?.hasModifier("@namespace")) {
         return convertVariableAsNamespace(context, symbol, exportSymbol);
     }
     if (type.getCallSignatures().length) {