typedoc 0.23.2 → 0.23.5

package/dist/index.d.ts

@@ -4,9 +4,9 @@ export { resetReflectionID } from "./lib/models/reflections/abstract";
 export { normalizePath } from "./lib/utils/fs";
 export * from "./lib/models";
 export { Converter, Context, type CommentParserConfig } from "./lib/converter";
-export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, } from "./lib/output";
+export { Renderer, DefaultTheme, DefaultThemeRenderContext, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";
 export type { RenderTemplate, RendererHooks } from "./lib/output";
-export { ArgumentsReader, BindOption, CommentStyle, JSX, LogLevel, Logger, Options, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, } from "./lib/utils";
+export { ArgumentsReader, BindOption, CommentStyle, JSX, LogLevel, Logger, Options, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, } from "./lib/utils";
 export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, ManuallyValidatedOption, } from "./lib/utils";
 export type { EventMap, EventCallback } from "./lib/utils/events";
 export { JSONOutput, Serializer, type SerializerComponent, SerializeEvent, } from "./lib/serialization";

package/dist/index.js

@@ -14,7 +14,7 @@ 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);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeScript = exports.SerializeEvent = exports.Serializer = exports.JSONOutput = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.BindOption = exports.ArgumentsReader = 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.Serializer = exports.JSONOutput = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = 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;
 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");
@@ -37,6 +37,7 @@ Object.defineProperty(exports, "Theme", { enumerable: true, get: function () { r
 Object.defineProperty(exports, "PageEvent", { enumerable: true, get: function () { return output_1.PageEvent; } });
 Object.defineProperty(exports, "RendererEvent", { enumerable: true, get: function () { return output_1.RendererEvent; } });
 Object.defineProperty(exports, "MarkdownEvent", { enumerable: true, get: function () { return output_1.MarkdownEvent; } });
+Object.defineProperty(exports, "IndexEvent", { enumerable: true, get: function () { return output_1.IndexEvent; } });
 var utils_1 = require("./lib/utils");
 Object.defineProperty(exports, "ArgumentsReader", { enumerable: true, get: function () { return utils_1.ArgumentsReader; } });
 Object.defineProperty(exports, "BindOption", { enumerable: true, get: function () { return utils_1.BindOption; } });
@@ -51,6 +52,7 @@ Object.defineProperty(exports, "TSConfigReader", { enumerable: true, get: functi
 Object.defineProperty(exports, "TypeDocReader", { enumerable: true, get: function () { return utils_1.TypeDocReader; } });
 Object.defineProperty(exports, "EntryPointStrategy", { enumerable: true, get: function () { return utils_1.EntryPointStrategy; } });
 Object.defineProperty(exports, "EventHooks", { enumerable: true, get: function () { return utils_1.EventHooks; } });
+Object.defineProperty(exports, "MinimalSourceFile", { enumerable: true, get: function () { return utils_1.MinimalSourceFile; } });
 var serialization_1 = require("./lib/serialization");
 Object.defineProperty(exports, "JSONOutput", { enumerable: true, get: function () { return serialization_1.JSONOutput; } });
 Object.defineProperty(exports, "Serializer", { enumerable: true, get: function () { return serialization_1.Serializer; } });

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

@@ -102,6 +102,7 @@ function* lexBlockComment2(file, pos, end) {
                         yield {
                             kind: lexer_1.TokenSyntaxKind.Code,
                             text: codeText.join(""),
+                            pos,
                         };
                         pos = lookahead;
                         break;
@@ -146,6 +147,7 @@ function* lexBlockComment2(file, pos, end) {
                         yield {
                             kind: lexer_1.TokenSyntaxKind.Code,
                             text: codeText.join(""),
+                            pos,
                         };
                         pos = lookahead;
                     }
@@ -199,12 +201,13 @@ function* lexBlockComment2(file, pos, end) {
                 if (textParts.some((part) => /\S/.test(part))) {
                     braceStartsType = false;
                 }
-                pos = lookahead;
                 // This piece of text had line continuations or escaped text
                 yield {
                     kind: lexer_1.TokenSyntaxKind.Text,
                     text: textParts.join(""),
+                    pos,
                 };
+                pos = lookahead;
                 break;
             }
         }
@@ -215,6 +218,7 @@ function* lexBlockComment2(file, pos, end) {
         return {
             kind,
             text: file.substring(start, pos),
+            pos: start,
         };
     }
     function skipIndent(pos) {

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

@@ -5,7 +5,7 @@
  *
  * @module
  */
-export declare const MeaningKeywords: readonly ["class", "interface", "type", "enum", "namespace", "function", "var", "constructor", "member", "event", "call", "new", "index", "complex"];
+export declare const MeaningKeywords: readonly ["class", "interface", "type", "enum", "namespace", "function", "var", "constructor", "member", "event", "call", "new", "index", "complex", "getter", "setter"];
 export declare type MeaningKeyword = typeof MeaningKeywords[number];
 export interface DeclarationReference {
     resolutionStart: "global" | "local";

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

@@ -22,7 +22,10 @@ exports.MeaningKeywords = [
     "call",
     "new",
     "index",
-    "complex", // Any complex type
+    "complex",
+    // TypeDoc specific
+    "getter",
+    "setter",
 ];
 // <TAB> <VT> <FF> <SP> <NBSP> <ZWNBSP> <USP>
 const WhiteSpace = /[\t\u2B7F\u240C \u00A0\uFEFF\p{White_Space}]/u;

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

@@ -137,6 +137,18 @@ function resolveKeyword(refl, kw) {
             if (refl.kindOf(models_1.ReflectionKind.SomeType))
                 return [refl];
             break;
+        case "getter":
+            if (refl.getSignature) {
+                return [refl.getSignature];
+            }
+            break;
+        case "setter":
+            if (refl.setSignature) {
+                return [refl.setSignature];
+            }
+            break;
+        default:
+            (0, utils_1.assertNever)(kw);
     }
 }
 function resolveSymbolReferencePart(refl, path) {

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

@@ -18,6 +18,7 @@ const wantedKinds = {
         ts.SyntaxKind.SourceFile,
         ts.SyntaxKind.BindingElement,
         ts.SyntaxKind.ExportSpecifier,
+        ts.SyntaxKind.NamespaceExport,
     ],
     [models_1.ReflectionKind.Enum]: [
         ts.SyntaxKind.EnumDeclaration,
@@ -33,6 +34,7 @@ const wantedKinds = {
         ts.SyntaxKind.VariableDeclaration,
         ts.SyntaxKind.BindingElement,
         ts.SyntaxKind.ExportAssignment,
+        ts.SyntaxKind.PropertyAccessExpression,
     ],
     [models_1.ReflectionKind.Function]: [
         ts.SyntaxKind.FunctionDeclaration,
@@ -68,10 +70,7 @@ const wantedKinds = {
     [models_1.ReflectionKind.Parameter]: [ts.SyntaxKind.Parameter],
     [models_1.ReflectionKind.TypeLiteral]: [ts.SyntaxKind.TypeLiteral],
     [models_1.ReflectionKind.TypeParameter]: [ts.SyntaxKind.TypeParameter],
-    [models_1.ReflectionKind.Accessor]: [
-        ts.SyntaxKind.GetAccessor,
-        ts.SyntaxKind.SetAccessor,
-    ],
+    [models_1.ReflectionKind.Accessor]: [],
     [models_1.ReflectionKind.GetSignature]: [ts.SyntaxKind.GetAccessor],
     [models_1.ReflectionKind.SetSignature]: [ts.SyntaxKind.SetAccessor],
     [models_1.ReflectionKind.ObjectLiteral]: [ts.SyntaxKind.ObjectLiteralExpression],
@@ -138,6 +137,7 @@ function discoverSignatureComment(declaration, commentStyle) {
     }
     const text = node.getSourceFile().text;
     const comments = collectCommentRanges(ts.getLeadingCommentRanges(text, node.pos));
+    comments.reverse();
     const comment = comments.find((ranges) => permittedRange(text, ranges, commentStyle));
     if (comment) {
         return [node.getSourceFile(), comment];
@@ -184,10 +184,33 @@ function getRootModuleDeclaration(node) {
     return node;
 }
 function declarationToCommentNode(node) {
-    if (node.parent?.kind === ts.SyntaxKind.VariableDeclarationList) {
+    if (!node.parent)
+        return node;
+    // const abc = 123
+    //       ^^^
+    if (node.parent.kind === ts.SyntaxKind.VariableDeclarationList) {
         return node.parent.parent;
     }
-    if (node.kind === ts.SyntaxKind.ModuleDeclaration) {
+    // const a = () => {}
+    //           ^^^^^^^^
+    if (node.parent.kind === ts.SyntaxKind.VariableDeclaration) {
+        return node.parent.parent.parent;
+    }
+    // class X { y = () => {} }
+    //               ^^^^^^^^
+    // function Z() {}
+    // Z.method = () => {}
+    //            ^^^^^^^^
+    // export default () => {}
+    //                ^^^^^^^^
+    if ([
+        ts.SyntaxKind.PropertyDeclaration,
+        ts.SyntaxKind.BinaryExpression,
+        ts.SyntaxKind.ExportAssignment,
+    ].includes(node.parent.kind)) {
+        return node.parent;
+    }
+    if (ts.isModuleDeclaration(node)) {
         if (!isTopmostModuleDeclaration(node)) {
             return;
         }
@@ -198,13 +221,7 @@ function declarationToCommentNode(node) {
     if (node.kind === ts.SyntaxKind.ExportSpecifier) {
         return node.parent.parent;
     }
-    if ([
-        ts.SyntaxKind.NamespaceExport,
-        ts.SyntaxKind.FunctionExpression,
-        ts.SyntaxKind.FunctionType,
-        ts.SyntaxKind.FunctionType,
-        ts.SyntaxKind.ArrowFunction,
-    ].includes(node.kind)) {
+    if ([ts.SyntaxKind.NamespaceExport, ts.SyntaxKind.FunctionType].includes(node.kind)) {
         return node.parent;
     }
     return node;

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

@@ -4,7 +4,6 @@ exports.getJsDocComment = exports.getSignatureComment = exports.getComment = voi
 const ts = require("typescript");
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
-const paths_1 = require("../../utils/paths");
 const blockLexer_1 = require("./blockLexer");
 const discovery_1 = require("./discovery");
 const lineLexer_1 = require("./lineLexer");
@@ -18,15 +17,13 @@ function getCommentWithCache(discovered, config, logger) {
     if (cache?.has(ranges[0].pos)) {
         return cache.get(ranges[0].pos).clone();
     }
-    const line = ts.getLineAndCharacterOfPosition(file, ranges[0].pos).line + 1;
-    const warning = (warning) => logger.warn(`${warning} in comment at ${(0, paths_1.nicePath)(file.fileName)}:${line}.`);
     let comment;
     switch (ranges[0].kind) {
         case ts.SyntaxKind.MultiLineCommentTrivia:
-            comment = (0, parser_1.parseComment)((0, blockLexer_1.lexBlockComment)(file.text, ranges[0].pos, ranges[0].end), config, warning);
+            comment = (0, parser_1.parseComment)((0, blockLexer_1.lexBlockComment)(file.text, ranges[0].pos, ranges[0].end), config, file, logger);
             break;
         case ts.SyntaxKind.SingleLineCommentTrivia:
-            comment = (0, parser_1.parseComment)((0, lineLexer_1.lexLineComments)(file.text, ranges), config, warning);
+            comment = (0, parser_1.parseComment)((0, lineLexer_1.lexLineComments)(file.text, ranges), config, file, logger);
             break;
         default:
             (0, utils_1.assertNever)(ranges[0].kind);

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

@@ -10,4 +10,5 @@ export declare enum TokenSyntaxKind {
 export interface Token {
     kind: TokenSyntaxKind;
     text: string;
+    pos: number;
 }

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

@@ -5,7 +5,7 @@ const lexer_1 = require("./lexer");
 function* lexLineComments(file, ranges) {
     // Wrapper around our real lex function to collapse adjacent text tokens.
     let textToken;
-    for (const token of lexBlockComment2(file, ranges[0].pos, ranges[ranges.length - 1].end)) {
+    for (const token of lexLineComments2(file, ranges[0].pos, ranges[ranges.length - 1].end)) {
         if (token.kind === lexer_1.TokenSyntaxKind.Text) {
             if (textToken) {
                 textToken.text += token.text;
@@ -28,7 +28,7 @@ function* lexLineComments(file, ranges) {
     return;
 }
 exports.lexLineComments = lexLineComments;
-function* lexBlockComment2(file, pos, end) {
+function* lexLineComments2(file, pos, end) {
     // Trailing whitespace
     while (pos < end && /\s/.test(file[end - 1])) {
         end--;
@@ -84,6 +84,7 @@ function* lexBlockComment2(file, pos, end) {
                         yield {
                             kind: lexer_1.TokenSyntaxKind.Code,
                             text: codeText.join(""),
+                            pos,
                         };
                         pos = lookahead;
                         break;
@@ -115,6 +116,7 @@ function* lexBlockComment2(file, pos, end) {
                         yield {
                             kind: lexer_1.TokenSyntaxKind.Code,
                             text: codeText.join(""),
+                            pos,
                         };
                         pos = lookahead;
                     }
@@ -168,12 +170,13 @@ function* lexBlockComment2(file, pos, end) {
                 if (textParts.some((part) => /\S/.test(part))) {
                     braceStartsType = false;
                 }
-                pos = lookahead;
                 // This piece of text had line continuations or escaped text
                 yield {
                     kind: lexer_1.TokenSyntaxKind.Text,
                     text: textParts.join(""),
+                    pos,
                 };
+                pos = lookahead;
                 break;
             }
         }
@@ -184,6 +187,7 @@ function* lexBlockComment2(file, pos, end) {
         return {
             kind,
             text: file.substring(start, pos),
+            pos: start,
         };
     }
     function skipLeadingLineTrivia(pos) {

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

@@ -1,4 +1,6 @@
 import type { CommentParserConfig } from ".";
 import { Comment } from "../../models";
+import { Logger } from "../../utils";
+import type { MinimalSourceFile } from "../../utils/minimalSourceFile";
 import { Token } from "./lexer";
-export declare function parseComment(tokens: Generator<Token, undefined, undefined>, config: CommentParserConfig, warning: (message: string) => void): Comment;
+export declare function parseComment(tokens: Generator<Token, undefined, undefined>, config: CommentParserConfig, file: MinimalSourceFile, logger: Logger): Comment;

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

@@ -4,34 +4,56 @@ exports.parseComment = void 0;
 const assert_1 = require("assert");
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
+const paths_1 = require("../../utils/paths");
 const lexer_1 = require("./lexer");
 function makeLookaheadGenerator(gen) {
-    let nextItem = gen.next();
+    let trackHistory = false;
+    const history = [];
+    const next = [gen.next()];
     return {
         done() {
-            return !!nextItem.done;
+            return !!next[0].done;
         },
         peek() {
-            (0, assert_1.ok)(!nextItem.done);
-            return nextItem.value;
+            (0, assert_1.ok)(!next[0].done);
+            return next[0].value;
         },
         take() {
-            const thisItem = nextItem;
+            const thisItem = next.shift();
+            if (trackHistory) {
+                history.push(thisItem);
+            }
             (0, assert_1.ok)(!thisItem.done);
-            nextItem = gen.next();
+            next.push(gen.next());
             return thisItem.value;
         },
+        mark() {
+            (0, assert_1.ok)(!trackHistory, "Can only mark one location for backtracking at a time");
+            trackHistory = true;
+        },
+        release() {
+            trackHistory = false;
+            next.unshift(...history);
+            history.length = 0;
+        },
     };
 }
-function parseComment(tokens, config, warning) {
+function parseComment(tokens, config, file, logger) {
     const lexer = makeLookaheadGenerator(tokens);
+    const tok = lexer.done() || lexer.peek();
     const comment = new models_1.Comment();
-    comment.summary = blockContent(comment, lexer, config, warning);
+    comment.summary = blockContent(comment, lexer, config, warningImpl);
     while (!lexer.done()) {
-        comment.blockTags.push(blockTag(comment, lexer, config, warning));
+        comment.blockTags.push(blockTag(comment, lexer, config, warningImpl));
     }
-    postProcessComment(comment, warning);
+    postProcessComment(comment, (message) => {
+        (0, assert_1.ok)(typeof tok === "object");
+        logger.warn(`${message} in comment at ${(0, paths_1.nicePath)(file.fileName)}:${file.getLineAndCharacterOfPosition(tok.pos).line + 1}`);
+    });
     return comment;
+    function warningImpl(message, token) {
+        logger.warn(message, token.pos, file);
+    }
 }
 exports.parseComment = parseComment;
 const HAS_USER_IDENTIFIER = [
@@ -77,37 +99,6 @@ function postProcessComment(comment, warning) {
         if (tag.content.some((part) => part.kind === "inline-tag" && part.tag === "@inheritDoc")) {
             warning("An inline @inheritDoc tag should not appear within a block tag as it will not be processed");
         }
-        if (tag.tag === "@example" &&
-            !tag.content.some((part) => part.kind === "code")) {
-            const caption = tag.content[0].text.match(/^\s*<caption>(.*?)<\/caption>\s*(\n|$)/);
-            if (caption) {
-                const code = models_1.Comment.combineDisplayParts([
-                    {
-                        kind: "text",
-                        text: tag.content[0].text.slice(caption[0].length),
-                    },
-                    ...tag.content.slice(1),
-                ]);
-                tag.content = [
-                    {
-                        kind: "text",
-                        text: caption[1] + "\n",
-                    },
-                    {
-                        kind: "code",
-                        text: makeCodeBlock(code),
-                    },
-                ];
-            }
-            else {
-                tag.content = [
-                    {
-                        kind: "code",
-                        text: makeCodeBlock(models_1.Comment.combineDisplayParts(tag.content)),
-                    },
-                ];
-            }
-        }
     }
     const remarks = comment.blockTags.filter((tag) => tag.tag === "@remarks");
     if (remarks.length > 1) {
@@ -133,9 +124,58 @@ function postProcessComment(comment, warning) {
 const aliasedTags = new Map([["@return", "@returns"]]);
 function blockTag(comment, lexer, config, warning) {
     const blockTag = lexer.take();
-    (0, assert_1.ok)(blockTag.kind === lexer_1.TokenSyntaxKind.Tag); // blockContent is broken if this fails.
+    (0, assert_1.ok)(blockTag.kind === lexer_1.TokenSyntaxKind.Tag, "blockTag called not at the start of a block tag."); // blockContent is broken if this fails.
     const tagName = aliasedTags.get(blockTag.text) || blockTag.text;
-    return new models_1.CommentTag(tagName, blockContent(comment, lexer, config, warning));
+    let content;
+    if (tagName === "@example") {
+        content = exampleBlockContent(comment, lexer, config, warning);
+    }
+    else {
+        content = blockContent(comment, lexer, config, warning);
+    }
+    return new models_1.CommentTag(tagName, content);
+}
+/**
+ * The `@example` tag gets a special case because otherwise we will produce many warnings
+ * about unescaped/mismatched/missing braces
+ */
+function exampleBlockContent(comment, lexer, config, warning) {
+    lexer.mark();
+    const content = blockContent(comment, lexer, config, () => { });
+    const end = lexer.done() || lexer.peek();
+    lexer.release();
+    if (content.some((part) => part.kind === "code")) {
+        return blockContent(comment, lexer, config, warning);
+    }
+    const tokens = [];
+    while ((lexer.done() || lexer.peek()) !== end) {
+        tokens.push(lexer.take());
+    }
+    const blockText = tokens
+        .map((tok) => tok.text)
+        .join("")
+        .trim();
+    const caption = blockText.match(/^\s*<caption>(.*?)<\/caption>\s*(\n|$)/);
+    if (caption) {
+        return [
+            {
+                kind: "text",
+                text: caption[1] + "\n",
+            },
+            {
+                kind: "code",
+                text: makeCodeBlock(blockText.slice(caption[0].length)),
+            },
+        ];
+    }
+    else {
+        return [
+            {
+                kind: "code",
+                text: makeCodeBlock(blockText),
+            },
+        ];
+    }
 }
 function blockContent(comment, lexer, config, warning) {
     const content = [];
@@ -153,7 +193,7 @@ function blockContent(comment, lexer, config, warning) {
                 break;
             case lexer_1.TokenSyntaxKind.Tag:
                 if (next.text === "@inheritdoc") {
-                    warning("The @inheritDoc tag should be properly capitalized");
+                    warning("The @inheritDoc tag should be properly capitalized", next);
                     next.text = "@inheritDoc";
                 }
                 if (config.modifierTags.has(next.text)) {
@@ -163,7 +203,7 @@ function blockContent(comment, lexer, config, warning) {
                 else if (!atNewLine && !config.blockTags.has(next.text)) {
                     // Treat unknown tag as a modifier, but warn about it.
                     comment.modifierTags.add(next.text);
-                    warning(`Treating unrecognized tag "${next.text}" as a modifier tag`);
+                    warning(`Treating unrecognized tag "${next.text}" as a modifier tag`, next);
                     break;
                 }
                 else {
@@ -176,7 +216,7 @@ function blockContent(comment, lexer, config, warning) {
                 break;
             case lexer_1.TokenSyntaxKind.CloseBrace:
                 // Unmatched closing brace, generate a warning, and treat it as text.
-                warning(`Unmatched closing brace`);
+                warning(`Unmatched closing brace`, next);
                 content.push({ kind: "text", text: next.text });
                 break;
             case lexer_1.TokenSyntaxKind.OpenBrace:
@@ -224,7 +264,7 @@ function inlineTag(lexer, block, config, warning) {
     // then produce a warning and treat what we've consumed as plain text.
     if (lexer.done() ||
         ![lexer_1.TokenSyntaxKind.Text, lexer_1.TokenSyntaxKind.Tag].includes(lexer.peek().kind)) {
-        warning("Encountered an unescaped open brace without an inline tag");
+        warning("Encountered an unescaped open brace without an inline tag", openBrace);
         block.push({ kind: "text", text: openBrace.text });
         return;
     }
@@ -233,7 +273,7 @@ function inlineTag(lexer, block, config, warning) {
         (tagName.kind === lexer_1.TokenSyntaxKind.Text &&
             (!/^\s+$/.test(tagName.text) ||
                 lexer.peek().kind != lexer_1.TokenSyntaxKind.Tag))) {
-        warning("Encountered an unescaped open brace without an inline tag");
+        warning("Encountered an unescaped open brace without an inline tag", openBrace);
         block.push({ kind: "text", text: openBrace.text + tagName.text });
         return;
     }
@@ -241,7 +281,7 @@ function inlineTag(lexer, block, config, warning) {
         tagName = lexer.take();
     }
     if (!config.inlineTags.has(tagName.text)) {
-        warning(`Encountered an unknown inline tag "${tagName.text}"`);
+        warning(`Encountered an unknown inline tag "${tagName.text}"`, tagName);
     }
     const content = [];
     // At this point, we know we have an inline tag. Treat everything following as plain text,
@@ -249,12 +289,12 @@ function inlineTag(lexer, block, config, warning) {
     while (!lexer.done() && lexer.peek().kind !== lexer_1.TokenSyntaxKind.CloseBrace) {
         const token = lexer.take();
         if (token.kind === lexer_1.TokenSyntaxKind.OpenBrace) {
-            warning("Encountered an open brace within an inline tag, this is likely a mistake");
+            warning("Encountered an open brace within an inline tag, this is likely a mistake", token);
         }
         content.push(token.kind === lexer_1.TokenSyntaxKind.NewLine ? " " : token.text);
     }
     if (lexer.done()) {
-        warning("Inline tag is not closed");
+        warning("Inline tag is not closed", openBrace);
     }
     else {
         lexer.take(); // Close brace

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

@@ -89,6 +89,7 @@ function* lexCommentString2(file) {
                         yield {
                             kind: lexer_1.TokenSyntaxKind.Code,
                             text: codeText.join(""),
+                            pos,
                         };
                         pos = lookahead;
                         break;
@@ -119,6 +120,7 @@ function* lexCommentString2(file) {
                         yield {
                             kind: lexer_1.TokenSyntaxKind.Code,
                             text: codeText.join(""),
+                            pos,
                         };
                         pos = lookahead;
                     }
@@ -172,12 +174,13 @@ function* lexCommentString2(file) {
                 if (textParts.some((part) => /\S/.test(part))) {
                     braceStartsType = false;
                 }
-                pos = lookahead;
                 // This piece of text had line continuations or escaped text
                 yield {
                     kind: lexer_1.TokenSyntaxKind.Text,
                     text: textParts.join(""),
+                    pos,
                 };
+                pos = lookahead;
                 break;
             }
         }
@@ -188,6 +191,7 @@ function* lexCommentString2(file) {
         return {
             kind,
             text: file.substring(start, pos),
+            pos: start,
         };
     }
     function lookaheadExactlyNTicks(pos, n) {

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

@@ -292,6 +292,14 @@ function handleInheritedComments(child, parent) {
             copyComment(cs, ps);
         }
     }
+    else if (parent.kindOf(index_1.ReflectionKind.Property) &&
+        parent.type instanceof types_1.ReflectionType &&
+        parent.type.declaration.signatures &&
+        child.signatures) {
+        for (const [cs, ps] of (0, array_1.zip)(child.signatures, parent.type.declaration.signatures)) {
+            copyComment(cs, ps);
+        }
+    }
 }
 /**
  * Copy the comment of the source reflection to the target reflection with a JSDoc style copy

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

@@ -70,6 +70,13 @@ let InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComp
                     sourceRefl = sourceRefl.getAllSignatures()[index];
                 }
             }
+            if (sourceRefl instanceof models_1.DeclarationReflection &&
+                sourceRefl.kindOf(models_1.ReflectionKind.Accessor)) {
+                // Accessors, like functions, never have comments on their actual root reflection.
+                // If the user didn't specify whether to inherit from the getter or setter, then implicitly
+                // try to inherit from the getter, #1968.
+                sourceRefl = sourceRefl.getSignature || sourceRefl.setSignature;
+            }
             if (!sourceRefl) {
                 this.application.logger.warn(`Failed to find "${source}" to inherit the comment from in the comment for ${reflection.getFullName()}`);
                 continue;

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

@@ -16,6 +16,7 @@ const fs_1 = require("../../utils/fs");
 const paths_1 = require("../../utils/paths");
 const rawLexer_1 = require("../comments/rawLexer");
 const parser_1 = require("../comments/parser");
+const minimalSourceFile_1 = require("../../utils/minimalSourceFile");
 /**
  * A handler that tries to find the package.json and readme.md files of the
  * current project.
@@ -75,9 +76,7 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
         const project = context.project;
         if (this.readmeFile) {
             const readme = (0, utils_1.readFile)(this.readmeFile);
-            const comment = (0, parser_1.parseComment)((0, rawLexer_1.lexCommentString)(readme), context.converter.config, (msg) => {
-                this.application.logger.warn(`${msg} in ${this.readmeFile}`);
-            });
+            const comment = (0, parser_1.parseComment)((0, rawLexer_1.lexCommentString)(readme), context.converter.config, new minimalSourceFile_1.MinimalSourceFile(readme, this.readmeFile), context.logger);
             if (comment.blockTags.length || comment.modifierTags.size) {
                 const ignored = [
                     ...comment.blockTags.map((tag) => tag.tag),

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

@@ -6,6 +6,7 @@ export declare class SourcePlugin extends ConverterComponent {
     readonly disableSources: boolean;
     readonly gitRevision: string;
     readonly gitRemote: string;
+    readonly basePath: string;
     /**
      * All file names to find the base path from.
      */

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

@@ -85,7 +85,7 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
     onBeginResolve(context) {
         if (this.disableSources)
             return;
-        const basePath = (0, fs_1.getCommonDirectory)([...this.fileNames]);
+        const basePath = this.basePath || (0, fs_1.getCommonDirectory)([...this.fileNames]);
         for (const refl of Object.values(context.project.reflections)) {
             for (const source of refl.sources || []) {
                 if (repository_1.gitIsInstalled) {
@@ -139,6 +139,9 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("gitRemote")
 ], SourcePlugin.prototype, "gitRemote", void 0);
+__decorate([
+    (0, utils_1.BindOption)("basePath")
+], SourcePlugin.prototype, "basePath", void 0);
 SourcePlugin = __decorate([
     (0, components_1.Component)({ name: "source" })
 ], SourcePlugin);