typedoc 0.23.9 → 0.23.10

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

@@ -54,6 +54,8 @@ const wantedKinds = {
         ts.SyntaxKind.PropertySignature,
         ts.SyntaxKind.BinaryExpression,
         ts.SyntaxKind.PropertyAssignment,
+        // class X { constructor(/** Comment */ readonly z: any) }
+        ts.SyntaxKind.Parameter,
     ],
     [models_1.ReflectionKind.Method]: [
         ts.SyntaxKind.FunctionDeclaration,

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

@@ -8,6 +8,13 @@ const blockLexer_1 = require("./blockLexer");
 const discovery_1 = require("./discovery");
 const lineLexer_1 = require("./lineLexer");
 const parser_1 = require("./parser");
+const jsDocCommentKinds = [
+    ts.SyntaxKind.JSDocPropertyTag,
+    ts.SyntaxKind.JSDocCallbackTag,
+    ts.SyntaxKind.JSDocTypedefTag,
+    ts.SyntaxKind.JSDocTemplateTag,
+    ts.SyntaxKind.JSDocEnumTag,
+];
 const commentCache = new WeakMap();
 function getCommentWithCache(discovered, config, logger) {
     if (!discovered)
@@ -52,6 +59,11 @@ function getCommentImpl(commentSource, config, logger, moduleComment) {
     return comment;
 }
 function getComment(symbol, kind, config, logger, commentStyle) {
+    if (symbol
+        .getDeclarations()
+        ?.every((d) => jsDocCommentKinds.includes(d.kind))) {
+        return getJsDocComment(symbol.declarations[0], config, logger);
+    }
     return getCommentImpl((0, discovery_1.discoverComment)(symbol, kind, logger, commentStyle), config, logger, symbol.declarations?.some(ts.isSourceFile) || false);
 }
 exports.getComment = getComment;
@@ -106,7 +118,7 @@ function getJsDocComment(declaration, config, logger) {
         logger.error(`Failed to find JSDoc tag for ${name} after parsing comment, please file a bug report.`, declaration);
     }
     else {
-        return new models_1.Comment(tag.content.slice());
+        return new models_1.Comment(models_1.Comment.cloneDisplayParts(tag.content));
     }
 }
 exports.getJsDocComment = getJsDocComment;

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

@@ -0,0 +1,4 @@
+import { Comment, CommentDisplayPart, Reflection } from "../../models";
+import type { Logger, ValidationOptions } from "../../utils";
+export declare function resolveLinks(comment: Comment, reflection: Reflection, validation: ValidationOptions, logger: Logger): void;
+export declare function resolvePartLinks(reflection: Reflection, parts: readonly CommentDisplayPart[], warn: () => void, validation: ValidationOptions, logger: Logger): CommentDisplayPart[];

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

@@ -0,0 +1,186 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolvePartLinks = exports.resolveLinks = void 0;
+const ts = require("typescript");
+const models_1 = require("../../models");
+const declarationReference_1 = require("./declarationReference");
+const declarationReferenceResolver_1 = require("./declarationReferenceResolver");
+const urlPrefix = /^(http|ftp)s?:\/\//;
+const brackets = /\[\[(?!include:)([^\]]+)\]\]/g;
+function resolveLinks(comment, reflection, validation, logger) {
+    let warned = false;
+    const warn = () => {
+        if (!warned) {
+            warned = true;
+            logger.warn(`${reflection.getFriendlyFullName()}: Comment [[target]] style links are deprecated and will be removed in 0.24`);
+        }
+    };
+    comment.summary = resolvePartLinks(reflection, comment.summary, warn, validation, logger);
+    for (const tag of comment.blockTags) {
+        tag.content = resolvePartLinks(reflection, tag.content, warn, validation, logger);
+    }
+    if (reflection instanceof models_1.DeclarationReflection && reflection.readme) {
+        reflection.readme = resolvePartLinks(reflection, reflection.readme, warn, validation, logger);
+    }
+}
+exports.resolveLinks = resolveLinks;
+function resolvePartLinks(reflection, parts, warn, validation, logger) {
+    return parts.flatMap((part) => processPart(reflection, part, warn, validation, logger));
+}
+exports.resolvePartLinks = resolvePartLinks;
+function processPart(reflection, part, warn, validation, logger) {
+    if (part.kind === "text" && brackets.test(part.text)) {
+        warn();
+        return replaceBrackets(reflection, part.text, validation, logger);
+    }
+    if (part.kind === "inline-tag") {
+        if (part.tag === "@link" ||
+            part.tag === "@linkcode" ||
+            part.tag === "@linkplain") {
+            return resolveLinkTag(reflection, part, (msg) => {
+                if (validation.invalidLink) {
+                    logger.warn(msg);
+                }
+            });
+        }
+    }
+    return part;
+}
+function resolveLinkTag(reflection, part, warn) {
+    let pos = 0;
+    const end = part.text.length;
+    while (pos < end && ts.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
+        pos++;
+    }
+    const origText = part.text;
+    // Try to parse one
+    const declRef = (0, declarationReference_1.parseDeclarationReference)(part.text, pos, end);
+    let target;
+    if (declRef) {
+        // Got one, great! Try to resolve the link
+        target = (0, declarationReferenceResolver_1.resolveDeclarationReference)(reflection, declRef[0]);
+        pos = declRef[1];
+    }
+    if (!target) {
+        if (urlPrefix.test(part.text)) {
+            const wsIndex = part.text.search(/\s/);
+            target =
+                wsIndex === -1 ? part.text : part.text.substring(0, wsIndex);
+            pos = target.length;
+        }
+    }
+    // If resolution via a declaration reference failed, revert to the legacy "split and check"
+    // method... this should go away in 0.24, once people have had a chance to migrate any failing links.
+    if (!target) {
+        const resolved = legacyResolveLinkTag(reflection, part);
+        if (resolved) {
+            warn(`Failed to resolve {@link ${origText}} in ${reflection.getFriendlyFullName()} with declaration references. This link will break in v0.24.`);
+        }
+        return resolved;
+    }
+    // Remaining text after an optional pipe is the link text, so advance
+    // until that's consumed.
+    while (pos < end && ts.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
+        pos++;
+    }
+    if (pos < end && part.text[pos] === "|") {
+        pos++;
+    }
+    part.target = target;
+    part.text =
+        part.text.substring(pos).trim() ||
+            (typeof target === "string" ? target : target.name);
+    return part;
+}
+function legacyResolveLinkTag(reflection, part) {
+    const { caption, target } = splitLinkText(part.text);
+    if (urlPrefix.test(target)) {
+        part.text = caption;
+        part.target = target;
+    }
+    else {
+        const targetRefl = reflection.findReflectionByName(target);
+        if (targetRefl) {
+            part.text = caption;
+            part.target = targetRefl;
+        }
+    }
+    return part;
+}
+function replaceBrackets(reflection, text, validation, logger) {
+    const parts = [];
+    let begin = 0;
+    brackets.lastIndex = 0;
+    for (const match of text.matchAll(brackets)) {
+        if (begin != match.index) {
+            parts.push({
+                kind: "text",
+                text: text.substring(begin, match.index),
+            });
+        }
+        begin = match.index + match[0].length;
+        const content = match[1];
+        const { target, caption } = splitLinkText(content);
+        if (urlPrefix.test(target)) {
+            parts.push({
+                kind: "inline-tag",
+                tag: "@link",
+                text: caption,
+                target,
+            });
+        }
+        else {
+            const targetRefl = reflection.findReflectionByName(target);
+            if (targetRefl) {
+                parts.push({
+                    kind: "inline-tag",
+                    tag: "@link",
+                    text: caption,
+                    target: targetRefl,
+                });
+            }
+            else {
+                if (validation.invalidLink) {
+                    logger.warn("Failed to find target: " + content);
+                }
+                parts.push({
+                    kind: "inline-tag",
+                    tag: "@link",
+                    text: content,
+                });
+            }
+        }
+    }
+    parts.push({
+        kind: "text",
+        text: text.substring(begin),
+    });
+    return parts;
+}
+/**
+ * Split the given link into text and target at first pipe or space.
+ *
+ * @param text  The source string that should be checked for a split character.
+ * @returns An object containing the link text and target.
+ */
+function splitLinkText(text) {
+    let splitIndex = text.indexOf("|");
+    if (splitIndex === -1) {
+        splitIndex = text.search(/\s/);
+    }
+    if (splitIndex !== -1) {
+        return {
+            caption: text
+                .substring(splitIndex + 1)
+                .replace(/\n+/, " ")
+                .trim(),
+            target: text.substring(0, splitIndex).trim(),
+        };
+    }
+    else {
+        return {
+            caption: text,
+            target: text,
+        };
+    }
+}

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

@@ -1,13 +1,13 @@
 import * as ts from "typescript";
 import type { Application } from "../application";
-import { ProjectReflection, SomeType } from "../models/index";
+import { Comment, CommentDisplayPart, ProjectReflection, Reflection, 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 { CommentStyle } from "../utils/options/declaration";
+import type { CommentStyle, ValidationOptions } from "../utils/options/declaration";
 /**
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
  */
@@ -24,6 +24,8 @@ export declare class Converter extends ChildableComponent<Application, Converter
     excludePrivate: boolean;
     excludeProtected: boolean;
     commentStyle: CommentStyle;
+    /** @internal */
+    validation: ValidationOptions;
     private _config?;
     get config(): CommentParserConfig;
     /**
@@ -108,7 +110,9 @@ export declare class Converter extends ChildableComponent<Application, Converter
     /**
      * Parse the given file into a comment. Intended to be used with markdown files.
      */
-    parseRawComment(file: MinimalSourceFile): import("../models/index").Comment;
+    parseRawComment(file: MinimalSourceFile): Comment;
+    resolveLinks(comment: Comment, owner: Reflection): void;
+    resolveLinks(parts: readonly CommentDisplayPart[], owner: Reflection): CommentDisplayPart[];
     /**
      * Compile the files within the given context and convert the compiler symbols to reflections.
      *

package/dist/lib/converter/converter.js

@@ -22,6 +22,7 @@ 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");
 /**
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
  */
@@ -66,6 +67,21 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
     parseRawComment(file) {
         return (0, parser_1.parseComment)((0, rawLexer_1.lexCommentString)(file.text), this.config, file, this.application.logger);
     }
+    resolveLinks(comment, owner) {
+        if (comment instanceof index_1.Comment) {
+            (0, linkResolver_1.resolveLinks)(comment, owner, this.validation, this.owner.logger);
+        }
+        else {
+            let warned = false;
+            const warn = () => {
+                if (!warned) {
+                    warned = true;
+                    this.application.logger.warn(`${owner.name}: Comment [[target]] style links are deprecated and will be removed in 0.24`);
+                }
+            };
+            return (0, linkResolver_1.resolvePartLinks)(owner, comment, warn, this.validation, this.owner.logger);
+        }
+    }
     /**
      * Compile the files within the given context and convert the compiler symbols to reflections.
      *
@@ -267,6 +283,9 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("commentStyle")
 ], Converter.prototype, "commentStyle", void 0);
+__decorate([
+    (0, utils_1.BindOption)("validation")
+], Converter.prototype, "validation", void 0);
 Converter = Converter_1 = __decorate([
     (0, component_1.Component)({
         name: "converter",

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

@@ -62,6 +62,7 @@ function convertParameters(context, sigRef, parameters, parameterNodes) {
         if (declaration && ts.isJSDocParameterTag(declaration)) {
             paramRefl.comment = (0, comments_1.getJsDocComment)(declaration, context.converter.config, context.logger);
         }
+        paramRefl.comment || (paramRefl.comment = (0, comments_1.getComment)(param, paramRefl.kind, context.converter.config, context.logger, context.converter.commentStyle));
         context.registerReflection(paramRefl, param);
         context.trigger(converter_events_1.ConverterEvents.CREATE_PARAMETER, paramRefl);
         let type;

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

@@ -1,4 +1,3 @@
-import type { Reflection } from "../../models/reflections/abstract";
 import { ConverterComponent } from "../components";
 import type { Context } from "../../converter";
 import { ValidationOptions } from "../../utils";
@@ -11,25 +10,5 @@ export declare class LinkResolverPlugin extends ConverterComponent {
      * Create a new LinkResolverPlugin instance.
      */
     initialize(): void;
-    /**
-     * Find all old style double bracket references to symbols within the given text and transform them into a link.
-     *
-     * @param text  The text that should be parsed.
-     * @returns The text with symbol references replaced by links.
-     */
-    private replaceBrackets;
     onResolve(context: Context): void;
-    processReflection(reflection: Reflection): void;
-    private processParts;
-    private processPart;
-    /**
-     * Split the given link into text and target at first pipe or space.
-     *
-     * @param text  The source string that should be checked for a split character.
-     * @returns An object containing the link text and target.
-     */
-    static splitLinkText(text: string): {
-        caption: string;
-        target: string;
-    };
 }

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

@@ -5,22 +5,15 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-var LinkResolverPlugin_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LinkResolverPlugin = void 0;
 const components_1 = require("../components");
 const converter_events_1 = require("../converter-events");
-const declarationReference_1 = require("../comments/declarationReference");
-const ts = require("typescript");
 const utils_1 = require("../../utils");
-const declarationReferenceResolver_1 = require("../comments/declarationReferenceResolver");
-const models_1 = require("../../models");
-const urlPrefix = /^(http|ftp)s?:\/\//;
-const brackets = /\[\[(?!include:)([^\]]+)\]\]/g;
 /**
  * A plugin that resolves `{@link Foo}` tags.
  */
-let LinkResolverPlugin = LinkResolverPlugin_1 = class LinkResolverPlugin extends components_1.ConverterComponent {
+let LinkResolverPlugin = class LinkResolverPlugin extends components_1.ConverterComponent {
     /**
      * Create a new LinkResolverPlugin instance.
      */
@@ -28,210 +21,21 @@ let LinkResolverPlugin = LinkResolverPlugin_1 = class LinkResolverPlugin extends
         super.initialize();
         this.owner.on(converter_events_1.ConverterEvents.RESOLVE_END, this.onResolve, this, -300);
     }
-    /**
-     * Find all old style double bracket references to symbols within the given text and transform them into a link.
-     *
-     * @param text  The text that should be parsed.
-     * @returns The text with symbol references replaced by links.
-     */
-    replaceBrackets(reflection, text) {
-        const parts = [];
-        let begin = 0;
-        brackets.lastIndex = 0;
-        for (const match of text.matchAll(brackets)) {
-            if (begin != match.index) {
-                parts.push({
-                    kind: "text",
-                    text: text.substring(begin, match.index),
-                });
-            }
-            begin = match.index + match[0].length;
-            const content = match[1];
-            const { target, caption } = LinkResolverPlugin_1.splitLinkText(content);
-            if (urlPrefix.test(target)) {
-                parts.push({
-                    kind: "inline-tag",
-                    tag: "@link",
-                    text: caption,
-                    target,
-                });
-            }
-            else {
-                const targetRefl = reflection.findReflectionByName(target);
-                if (targetRefl) {
-                    parts.push({
-                        kind: "inline-tag",
-                        tag: "@link",
-                        text: caption,
-                        target: targetRefl,
-                    });
-                }
-                else {
-                    if (this.validation.invalidLink) {
-                        this.application.logger.warn("Failed to find target: " + content);
-                    }
-                    parts.push({
-                        kind: "inline-tag",
-                        tag: "@link",
-                        text: content,
-                    });
-                }
-            }
-        }
-        parts.push({
-            kind: "text",
-            text: text.substring(begin),
-        });
-        return parts;
-    }
     onResolve(context) {
         for (const reflection of Object.values(context.project.reflections)) {
-            this.processReflection(reflection);
-        }
-        let warned = false;
-        const warn = () => {
-            if (!warned) {
-                warned = true;
-                this.application.logger.warn(`README: Comment [[target]] style links are deprecated and will be removed in 0.24`);
-            }
-        };
-        if (context.project.readme) {
-            context.project.readme = this.processParts(context.project, context.project.readme, warn);
-        }
-    }
-    processReflection(reflection) {
-        const comment = reflection.comment;
-        if (!comment)
-            return;
-        let warned = false;
-        const warn = () => {
-            if (!warned) {
-                warned = true;
-                this.application.logger.warn(`${reflection.getFriendlyFullName()}: Comment [[target]] style links are deprecated and will be removed in 0.24`);
-            }
-        };
-        comment.summary = this.processParts(reflection, comment.summary, warn);
-        for (const tag of comment.blockTags) {
-            tag.content = this.processParts(reflection, tag.content, warn);
-        }
-        if (reflection instanceof models_1.DeclarationReflection && reflection.readme) {
-            reflection.readme = this.processParts(reflection, reflection.readme, warn);
-        }
-    }
-    processParts(reflection, parts, warn) {
-        return parts.flatMap((part) => this.processPart(reflection, part, warn));
-    }
-    processPart(reflection, part, warn) {
-        if (part.kind === "text" && brackets.test(part.text)) {
-            warn();
-            return this.replaceBrackets(reflection, part.text);
-        }
-        if (part.kind === "inline-tag") {
-            if (part.tag === "@link" ||
-                part.tag === "@linkcode" ||
-                part.tag === "@linkplain") {
-                return resolveLinkTag(reflection, part, (msg) => {
-                    if (this.validation.invalidLink) {
-                        this.application.logger.warn(msg);
-                    }
-                });
+            if (reflection.comment) {
+                context.converter.resolveLinks(reflection.comment, reflection);
             }
         }
-        return part;
-    }
-    /**
-     * Split the given link into text and target at first pipe or space.
-     *
-     * @param text  The source string that should be checked for a split character.
-     * @returns An object containing the link text and target.
-     */
-    static splitLinkText(text) {
-        let splitIndex = text.indexOf("|");
-        if (splitIndex === -1) {
-            splitIndex = text.search(/\s/);
-        }
-        if (splitIndex !== -1) {
-            return {
-                caption: text
-                    .substring(splitIndex + 1)
-                    .replace(/\n+/, " ")
-                    .trim(),
-                target: text.substring(0, splitIndex).trim(),
-            };
-        }
-        else {
-            return {
-                caption: text,
-                target: text,
-            };
+        if (context.project.readme) {
+            context.project.readme = context.converter.resolveLinks(context.project.readme, context.project);
         }
     }
 };
 __decorate([
     (0, utils_1.BindOption)("validation")
 ], LinkResolverPlugin.prototype, "validation", void 0);
-LinkResolverPlugin = LinkResolverPlugin_1 = __decorate([
+LinkResolverPlugin = __decorate([
     (0, components_1.Component)({ name: "link-resolver" })
 ], LinkResolverPlugin);
 exports.LinkResolverPlugin = LinkResolverPlugin;
-function resolveLinkTag(reflection, part, warn) {
-    let pos = 0;
-    const end = part.text.length;
-    while (pos < end && ts.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
-        pos++;
-    }
-    const origText = part.text;
-    // Try to parse one
-    const declRef = (0, declarationReference_1.parseDeclarationReference)(part.text, pos, end);
-    let target;
-    if (declRef) {
-        // Got one, great! Try to resolve the link
-        target = (0, declarationReferenceResolver_1.resolveDeclarationReference)(reflection, declRef[0]);
-        pos = declRef[1];
-    }
-    if (!target) {
-        if (urlPrefix.test(part.text)) {
-            const wsIndex = part.text.search(/\s/);
-            target =
-                wsIndex === -1 ? part.text : part.text.substring(0, wsIndex);
-            pos = target.length;
-        }
-    }
-    // If resolution via a declaration reference failed, revert to the legacy "split and check"
-    // method... this should go away in 0.24, once people have had a chance to migrate any failing links.
-    if (!target) {
-        const resolved = legacyResolveLinkTag(reflection, part);
-        if (resolved) {
-            warn(`Failed to resolve {@link ${origText}} in ${reflection.getFriendlyFullName()} with declaration references. This link will break in v0.24.`);
-        }
-        return resolved;
-    }
-    // Remaining text after an optional pipe is the link text, so advance
-    // until that's consumed.
-    while (pos < end && ts.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
-        pos++;
-    }
-    if (pos < end && part.text[pos] === "|") {
-        pos++;
-    }
-    part.target = target;
-    part.text =
-        part.text.substring(pos).trim() ||
-            (typeof target === "string" ? target : target.name);
-    return part;
-}
-function legacyResolveLinkTag(reflection, part) {
-    const { caption, target } = LinkResolverPlugin.splitLinkText(part.text);
-    if (urlPrefix.test(target)) {
-        part.text = caption;
-        part.target = target;
-    }
-    else {
-        const targetRefl = reflection.findReflectionByName(target);
-        if (targetRefl) {
-            part.text = caption;
-            part.target = targetRefl;
-        }
-    }
-    return part;
-}

package/dist/lib/models/types.js

@@ -671,7 +671,7 @@ class ReferenceType extends Type {
             .fileName.replace(/\\/g, "/");
         if (!symbolPath)
             return ref;
-        let startIndex = symbolPath.indexOf("node_modules/");
+        let startIndex = symbolPath.lastIndexOf("node_modules/");
         if (startIndex === -1)
             return ref;
         startIndex += "node_modules/".length;

package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts

@@ -1,6 +1,6 @@
 import type { RendererHooks } from "../..";
-import type { ReferenceType, Reflection } from "../../../models";
-import type { Options } from "../../../utils";
+import type { CommentDisplayPart, ReferenceType, Reflection } from "../../../models";
+import type { NeverIfInternal, Options } from "../../../utils";
 import type { DefaultTheme } from "./DefaultTheme";
 export declare class DefaultThemeRenderContext {
     private theme;
@@ -11,7 +11,7 @@ export declare class DefaultThemeRenderContext {
     /** Avoid this in favor of urlTo if possible */
     relativeURL: (url: string | undefined) => string | undefined;
     urlTo: (reflection: Reflection) => string | undefined;
-    markdown: (md: string | undefined) => string;
+    markdown: (md: readonly CommentDisplayPart[] | NeverIfInternal<string | undefined>) => string;
     attemptExternalResolution: (type: ReferenceType) => string | undefined;
     reflectionTemplate: (props: import("../..").PageEvent<import("../../../models").ContainerReflection>) => import("../../../utils/jsx.elements").JsxElement;
     indexTemplate: (props: import("../..").PageEvent<import("../../../models").ProjectReflection>) => import("../../../utils/jsx.elements").JsxElement;

package/dist/lib/output/themes/default/DefaultThemeRenderContext.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultThemeRenderContext = void 0;
+const lib_1 = require("../lib");
 const default_1 = require("./layouts/default");
 const partials_1 = require("./partials");
 const analytics_1 = require("./partials/analytics");
@@ -42,6 +43,9 @@ class DefaultThemeRenderContext {
         };
         this.urlTo = (reflection) => this.relativeURL(reflection.url);
         this.markdown = (md) => {
+            if (md instanceof Array) {
+                return this.theme.markedPlugin.parseMarkdown((0, lib_1.displayPartsToMarkdown)(md, this.urlTo));
+            }
             return md ? this.theme.markedPlugin.parseMarkdown(md) : "";
         };
         this.attemptExternalResolution = (type) => {

package/dist/lib/output/themes/default/partials/comment.d.ts

@@ -1,4 +1,4 @@
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import { JSX } from "../../../../utils";
 import type { Reflection } from "../../../../models";
-export declare function comment({ markdown, urlTo }: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;
+export declare function comment({ markdown }: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;

package/dist/lib/output/themes/default/partials/comment.js

@@ -3,14 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.comment = void 0;
 const utils_1 = require("../../../../utils");
 const lib_1 = require("../../lib");
-function comment({ markdown, urlTo }, props) {
+function comment({ markdown }, props) {
     if (!props.comment?.hasVisibleComponent())
         return;
     // Note: Comment modifiers are handled in `renderFlags`
     return (utils_1.JSX.createElement("div", { class: "tsd-comment tsd-typography" },
-        utils_1.JSX.createElement(utils_1.Raw, { html: markdown((0, lib_1.displayPartsToMarkdown)(props.comment.summary, urlTo)) }),
+        utils_1.JSX.createElement(utils_1.Raw, { html: markdown(props.comment.summary) }),
         props.comment.blockTags.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             utils_1.JSX.createElement("h3", null, (0, lib_1.camelToTitleCase)(item.tag.substring(1))),
-            utils_1.JSX.createElement(utils_1.Raw, { html: markdown((0, lib_1.displayPartsToMarkdown)(item.content, urlTo)) }))))));
+            utils_1.JSX.createElement(utils_1.Raw, { html: markdown(item.content) }))))));
 }
 exports.comment = comment;

package/dist/lib/output/themes/default/partials/index.js

@@ -10,7 +10,7 @@ function renderCategory({ urlTo, icons }, item, prependName = "") {
         utils_1.JSX.createElement("div", { class: "tsd-index-list" }, item.children.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             utils_1.JSX.createElement("a", { href: urlTo(item), class: (0, lib_1.classNames)({ "tsd-index-link": true, deprecated: item.isDeprecated() }, item.cssClasses) },
                 icons[item.kind](),
-                utils_1.JSX.createElement("span", null, item.name ? (0, lib_1.wbr)(item.name) : utils_1.JSX.createElement("em", null, (0, lib_1.wbr)(item.kindString)))),
+                utils_1.JSX.createElement("span", null, (0, lib_1.renderName)(item))),
             "\n"))))));
 }
 function index(context, props) {
@@ -42,7 +42,7 @@ function index(context, props) {
             props.kind === models_1.ReflectionKind.Module &&
             props.readme?.length !== 0 && (utils_1.JSX.createElement("section", { class: "tsd-panel-group" },
             utils_1.JSX.createElement("section", { class: "tsd-panel tsd-typography" },
-                utils_1.JSX.createElement(utils_1.Raw, { html: context.markdown((0, lib_1.displayPartsToMarkdown)(props.readme || [], context.urlTo)) })))),
+                utils_1.JSX.createElement(utils_1.Raw, { html: context.markdown(props.readme || []) })))),
         utils_1.JSX.createElement("section", { class: "tsd-panel-group tsd-index-group" },
             utils_1.JSX.createElement("section", { class: "tsd-panel tsd-index-panel" }, content))));
 }

package/dist/lib/output/themes/default/partials/navigation.js

@@ -103,7 +103,7 @@ function secondaryNavigation(context, props) {
         return (utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({ deprecated: child.isDeprecated(), current: props.model === child }, child.cssClasses) },
             utils_1.JSX.createElement("a", { href: context.urlTo(child), class: "tsd-index-link" },
                 context.icons[child.kind](),
-                (0, lib_1.wbr)(child.name))));
+                (0, lib_1.renderName)(child))));
     });
     if (effectivePageParent.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
         return (utils_1.JSX.createElement("nav", { class: "tsd-navigation secondary menu-sticky" }, !!pageNavigation.length && utils_1.JSX.createElement("ul", null, pageNavigation)));
@@ -116,7 +116,7 @@ function secondaryNavigation(context, props) {
                 }, effectivePageParent.cssClasses) },
                 utils_1.JSX.createElement("a", { href: context.urlTo(effectivePageParent), class: "tsd-index-link" },
                     context.icons[effectivePageParent.kind](),
-                    utils_1.JSX.createElement("span", null, (0, lib_1.wbr)(effectivePageParent.name))),
+                    utils_1.JSX.createElement("span", null, (0, lib_1.renderName)(effectivePageParent))),
                 !!pageNavigation.length && utils_1.JSX.createElement("ul", null, pageNavigation)))));
 }
 exports.secondaryNavigation = secondaryNavigation;

package/dist/lib/output/themes/default/templates/index.d.ts

@@ -2,4 +2,4 @@ import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import type { ProjectReflection } from "../../../../models";
 import type { PageEvent } from "../../../events";
 import { JSX } from "../../../../utils";
-export declare const indexTemplate: ({ markdown, urlTo }: DefaultThemeRenderContext, props: PageEvent<ProjectReflection>) => JSX.Element;
+export declare const indexTemplate: ({ markdown }: DefaultThemeRenderContext, props: PageEvent<ProjectReflection>) => JSX.Element;

package/dist/lib/output/themes/default/templates/index.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.indexTemplate = void 0;
 const utils_1 = require("../../../../utils");
-const lib_1 = require("../../lib");
-const indexTemplate = ({ markdown, urlTo }, props) => (utils_1.JSX.createElement("div", { class: "tsd-panel tsd-typography" },
-    utils_1.JSX.createElement(utils_1.Raw, { html: markdown((0, lib_1.displayPartsToMarkdown)(props.model.readme || [], urlTo)) })));
+const indexTemplate = ({ markdown }, props) => (utils_1.JSX.createElement("div", { class: "tsd-panel tsd-typography" },
+    utils_1.JSX.createElement(utils_1.Raw, { html: markdown(props.model.readme || []) })));
 exports.indexTemplate = indexTemplate;

package/dist/lib/output/themes/lib.d.ts

@@ -19,4 +19,8 @@ export declare function hasTypeParameters(reflection: Reflection): reflection is
 };
 export declare function renderTypeParametersSignature(typeParameters: readonly TypeParameterReflection[] | undefined): JSX.Element;
 export declare function camelToTitleCase(text: string): string;
-export declare function displayPartsToMarkdown(parts: CommentDisplayPart[], urlTo: DefaultThemeRenderContext["urlTo"]): string;
+export declare function displayPartsToMarkdown(parts: readonly CommentDisplayPart[], urlTo: DefaultThemeRenderContext["urlTo"]): string;
+/**
+ * Renders the reflection name with an additional `?` if optional.
+ */
+export declare function renderName(refl: Reflection): JSX.Element | (string | JSX.Element)[];

package/dist/lib/output/themes/lib.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.displayPartsToMarkdown = exports.camelToTitleCase = exports.renderTypeParametersSignature = exports.hasTypeParameters = exports.classNames = exports.renderFlags = exports.join = exports.wbr = exports.stringify = void 0;
+exports.renderName = exports.displayPartsToMarkdown = exports.camelToTitleCase = exports.renderTypeParametersSignature = exports.hasTypeParameters = exports.classNames = exports.renderFlags = exports.join = exports.wbr = exports.stringify = void 0;
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
 function stringify(data) {
@@ -122,3 +122,18 @@ function displayPartsToMarkdown(parts, urlTo) {
     return result.join("");
 }
 exports.displayPartsToMarkdown = displayPartsToMarkdown;
+/**
+ * Renders the reflection name with an additional `?` if optional.
+ */
+function renderName(refl) {
+    if (!refl.name) {
+        return utils_1.JSX.createElement("em", null, wbr(refl.kindString));
+    }
+    if (refl.flags.isOptional) {
+        return utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+            wbr(refl.name),
+            "?");
+    }
+    return wbr(refl.name);
+}
+exports.renderName = renderName;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.23.9",
+  "version": "0.23.10",
   "homepage": "https://typedoc.org",
   "main": "./dist/index.js",
   "exports": {
@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "lunr": "^2.3.9",
-    "marked": "^4.0.16",
+    "marked": "^4.0.18",
     "minimatch": "^5.1.0",
     "shiki": "^0.10.1"
   },
@@ -37,22 +37,21 @@
     "@types/marked": "^4.0.3",
     "@types/minimatch": "3.0.5",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^17.0.35",
-    "@typescript-eslint/eslint-plugin": "^5.26.0",
-    "@typescript-eslint/parser": "^5.26.0",
+    "@types/node": "^18.6.3",
+    "@typescript-eslint/eslint-plugin": "^5.31.0",
+    "@typescript-eslint/parser": "^5.31.0",
     "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#b88cd06fe814614a0d924af9d10d04ff95a551de",
-    "c8": "^7.11.3",
+    "c8": "^7.12.0",
     "esbuild": "^0.14.39",
-    "eslint": "^8.16.0",
-    "mocha": "^9.2.1",
-    "prettier": "2.6.2",
+    "eslint": "^8.20.0",
+    "mocha": "^10.0.0",
+    "prettier": "2.7.1",
     "puppeteer": "^13.5.2",
-    "reg-notify-github-plugin": "^0.11.1",
-    "reg-suit": "^0.11.1",
-    "reg-suit-core": "^0.11.1",
-    "reg-suit-interface": "^0.11.0",
-    "ts-node": "^10.8.0",
-    "typescript": "^4.7.2"
+    "reg-suit": "^0.12.1",
+    "reg-suit-core": "^0.12.1",
+    "reg-suit-interface": "^0.12.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
   },
   "files": [
     "/bin",

package/tsdoc.json

@@ -1,5 +1,5 @@
 {
-    "$schema": "https://developer.microsoft.com/en-us/json-schemas/tsdoc/v0/tsdoc.schema.json",
+    "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
     "noStandardTags": false,
     "tagDefinitions": [
         {