typedoc 0.24.4 → 0.24.6

package/dist/lib/application.js

@@ -373,11 +373,18 @@ let Application = Application_1 = class Application extends component_1.Childabl
     _merge() {
         const start = Date.now();
         const rootDir = (0, fs_1.deriveRootDir)(this.entryPoints);
-        this.logger.verbose(`Derived root dir is ${rootDir}, will expand ${this.entryPoints
-            .map(index_2.normalizePath)
-            .join(", ")}`);
-        const entryPoints = this.entryPoints.flatMap((entry) => (0, fs_1.glob)(entry, rootDir));
-        this.logger.verbose(`Merging entry points:\n\t${entryPoints.map(paths_1.nicePath).join("\n\t")}`);
+        const entryPoints = this.entryPoints.flatMap((entry) => {
+            const result = (0, fs_1.glob)(entry, rootDir);
+            if (result.length === 0) {
+                this.logger.warn(`The entrypoint glob ${(0, paths_1.nicePath)(entry)} did not match any files.`);
+            }
+            else {
+                this.logger.verbose(`Expanded ${(0, paths_1.nicePath)(entry)} to:\n\t${result
+                    .map(paths_1.nicePath)
+                    .join("\n\t")}`);
+            }
+            return result;
+        });
         if (entryPoints.length < 1) {
             this.logger.error("No entry points provided to merge.");
             return;

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

@@ -36,14 +36,26 @@ function* lexBlockComment(file, pos = 0, end = file.length, jsDoc = undefined, c
 exports.lexBlockComment = lexBlockComment;
 function getLinkTags(jsDoc) {
     const result = [];
-    if (!jsDoc || typeof jsDoc.comment !== "object")
-        return result;
-    for (const part of jsDoc.comment) {
-        switch (part.kind) {
-            case typescript_1.default.SyntaxKind.JSDocLink:
-            case typescript_1.default.SyntaxKind.JSDocLinkCode:
-            case typescript_1.default.SyntaxKind.JSDocLinkPlain:
-                result.push(part);
+    if (jsDoc?.comment && typeof jsDoc.comment !== "string") {
+        for (const part of jsDoc.comment) {
+            switch (part.kind) {
+                case typescript_1.default.SyntaxKind.JSDocLink:
+                case typescript_1.default.SyntaxKind.JSDocLinkCode:
+                case typescript_1.default.SyntaxKind.JSDocLinkPlain:
+                    result.push(part);
+            }
+        }
+    }
+    for (const block of jsDoc?.tags || []) {
+        if (!block.comment || typeof block.comment === "string")
+            continue;
+        for (const part of block.comment) {
+            switch (part.kind) {
+                case typescript_1.default.SyntaxKind.JSDocLink:
+                case typescript_1.default.SyntaxKind.JSDocLinkCode:
+                case typescript_1.default.SyntaxKind.JSDocLinkPlain:
+                    result.push(part);
+            }
         }
     }
     return result;

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

@@ -7,5 +7,10 @@ export interface DiscoveredComment {
     ranges: ts.CommentRange[];
     jsDoc: ts.JSDoc | undefined;
 }
+export declare function discoverFileComment(node: ts.SourceFile, commentStyle: CommentStyle): {
+    file: ts.SourceFile;
+    ranges: ts.CommentRange[];
+    jsDoc: ts.JSDoc | undefined;
+} | undefined;
 export declare function discoverComment(symbol: ts.Symbol, kind: ReflectionKind, logger: Logger, commentStyle: CommentStyle): DiscoveredComment | undefined;
 export declare function discoverSignatureComment(declaration: ts.SignatureDeclaration | ts.JSDocSignature, commentStyle: CommentStyle): DiscoveredComment | undefined;

package/dist/lib/converter/comments/discovery.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.discoverSignatureComment = exports.discoverComment = void 0;
+exports.discoverSignatureComment = exports.discoverComment = exports.discoverFileComment = void 0;
 const typescript_1 = __importDefault(require("typescript"));
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
@@ -98,6 +98,19 @@ const wantedKinds = {
         typescript_1.default.SyntaxKind.ExportSpecifier,
     ],
 };
+function discoverFileComment(node, commentStyle) {
+    const text = node.text;
+    const comments = collectCommentRanges(typescript_1.default.getLeadingCommentRanges(text, node.pos));
+    const selectedDocComment = comments.find((ranges) => permittedRange(text, ranges, commentStyle));
+    if (selectedDocComment) {
+        return {
+            file: node,
+            ranges: selectedDocComment,
+            jsDoc: findJsDocForComment(node, selectedDocComment),
+        };
+    }
+}
+exports.discoverFileComment = discoverFileComment;
 function discoverComment(symbol, kind, logger, commentStyle) {
     // For a module comment, we want the first one defined in the file,
     // not the last one, since that will apply to the import or declaration.

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

@@ -10,5 +10,6 @@ export interface CommentParserConfig {
 }
 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 getFileComment(file: ts.SourceFile, 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 = exports.clearCommentCache = void 0;
+exports.getJsDocComment = exports.getSignatureComment = exports.getFileComment = exports.getComment = exports.clearCommentCache = void 0;
 const typescript_1 = __importDefault(require("typescript"));
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
@@ -81,6 +81,11 @@ function getComment(symbol, kind, config, logger, commentStyle, checker) {
     return comment;
 }
 exports.getComment = getComment;
+function getFileComment(file, config, logger, commentStyle, checker) {
+    return getCommentImpl((0, discovery_1.discoverFileComment)(file, commentStyle), config, logger, 
+    /* moduleComment */ true, checker);
+}
+exports.getFileComment = getFileComment;
 function getConstructorParamPropertyComment(symbol, config, logger, commentStyle, checker) {
     const decl = symbol.declarations?.find(typescript_1.default.isParameter);
     if (!decl)

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

@@ -105,6 +105,11 @@ function postProcessComment(comment, warning) {
         warning("At most one @remarks tag is expected in a comment, ignoring all but the first");
         (0, utils_1.removeIf)(comment.blockTags, (tag) => remarks.indexOf(tag) > 0);
     }
+    const returns = comment.blockTags.filter((tag) => tag.tag === "@returns");
+    if (remarks.length > 1) {
+        warning("At most one @returns tag is expected in a comment, ignoring all but the first");
+        (0, utils_1.removeIf)(comment.blockTags, (tag) => returns.indexOf(tag) > 0);
+    }
     const inheritDoc = comment.blockTags.filter((tag) => tag.tag === "@inheritDoc");
     const inlineInheritDoc = comment.summary.filter((part) => part.kind === "inline-tag" && part.tag === "@inheritDoc");
     if (inlineInheritDoc.length + inheritDoc.length > 1) {
@@ -223,7 +228,9 @@ function blockContent(comment, lexer, config, warning) {
                 break;
             case lexer_1.TokenSyntaxKind.Tag:
                 if (next.text === "@inheritdoc") {
-                    warning("The @inheritDoc tag should be properly capitalized", next);
+                    if (!config.jsDocCompatibility.inheritDocTag) {
+                        warning("The @inheritDoc tag should be properly capitalized", next);
+                    }
                     next.text = "@inheritDoc";
                 }
                 if (config.modifierTags.has(next.text)) {
@@ -246,7 +253,9 @@ 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`, next);
+                if (!config.jsDocCompatibility.ignoreUnescapedBraces) {
+                    warning(`Unmatched closing brace`, next);
+                }
                 content.push({ kind: "text", text: next.text });
                 break;
             case lexer_1.TokenSyntaxKind.OpenBrace:
@@ -294,7 +303,9 @@ 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", openBrace);
+        if (!config.jsDocCompatibility.ignoreUnescapedBraces) {
+            warning("Encountered an unescaped open brace without an inline tag", openBrace);
+        }
         block.push({ kind: "text", text: openBrace.text });
         return;
     }
@@ -303,7 +314,9 @@ 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", openBrace);
+        if (!config.jsDocCompatibility.ignoreUnescapedBraces) {
+            warning("Encountered an unescaped open brace without an inline tag", openBrace);
+        }
         block.push({ kind: "text", text: openBrace.text + tagName.text });
         return;
     }

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

@@ -79,6 +79,7 @@ export declare class Context {
     /** @internal */
     setActiveProgram(program: ts.Program | undefined): void;
     getComment(symbol: ts.Symbol, kind: ReflectionKind): import("../models/index").Comment | undefined;
+    getFileComment(node: ts.SourceFile): 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;
     /**

package/dist/lib/converter/context.js

@@ -176,6 +176,9 @@ class Context {
     getComment(symbol, kind) {
         return (0, comments_1.getComment)(symbol, kind, this.converter.config, this.logger, this.converter.commentStyle, this.converter.useTsLinkResolution ? this.checker : undefined);
     }
+    getFileComment(node) {
+        return (0, comments_1.getFileComment)(node, 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);
     }

package/dist/lib/converter/converter.js

@@ -163,13 +163,17 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
             // Special case for when we're giving a single entry point, we don't need to
             // create modules for each entry. Register the project as this module.
             context.project.registerReflection(context.project, symbol);
-            context.project.comment =
-                symbol && context.getComment(symbol, context.project.kind);
+            context.project.comment = symbol
+                ? context.getComment(symbol, context.project.kind)
+                : context.getFileComment(node);
             context.trigger(Converter_1.EVENT_CREATE_DECLARATION, context.project);
             moduleContext = context;
         }
         else {
             const reflection = context.createDeclarationReflection(index_1.ReflectionKind.Module, symbol, void 0, entryName);
+            if (!reflection.comment && !symbol) {
+                reflection.comment = context.getFileComment(node);
+            }
             if (entryPoint.readmeFile) {
                 const readme = (0, utils_1.readFile)(entryPoint.readmeFile);
                 const comment = this.parseRawComment(new utils_1.MinimalSourceFile(readme, entryPoint.readmeFile));

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

@@ -9,7 +9,9 @@ import { ConverterComponent } from "../components";
 export declare class GroupPlugin extends ConverterComponent {
     sortFunction: (reflections: DeclarationReflection[]) => void;
     boosts: Record<string, number>;
+    groupOrder: string[];
     usedBoosts: Set<string>;
+    static WEIGHTS: string[];
     /**
      * Create a new GroupPlugin instance.
      */
@@ -44,4 +46,8 @@ export declare class GroupPlugin extends ConverterComponent {
      * @returns An array containing all children of the given reflection grouped by their kind.
      */
     getReflectionGroups(reflections: DeclarationReflection[]): ReflectionGroup[];
+    /**
+     * Callback used to sort groups by name.
+     */
+    static sortGroupCallback(a: ReflectionGroup, b: ReflectionGroup): number;
 }

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

@@ -5,6 +5,7 @@ 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 GroupPlugin_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GroupPlugin = void 0;
 const index_1 = require("../../models/reflections/index");
@@ -19,7 +20,7 @@ const models_1 = require("../../models");
  *
  * The handler sets the `groups` property of all container reflections.
  */
-let GroupPlugin = class GroupPlugin extends components_1.ConverterComponent {
+let GroupPlugin = GroupPlugin_1 = class GroupPlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         this.usedBoosts = new Set();
@@ -31,6 +32,7 @@ let GroupPlugin = class GroupPlugin extends components_1.ConverterComponent {
         this.listenTo(this.owner, {
             [converter_1.Converter.EVENT_RESOLVE_BEGIN]: () => {
                 this.sortFunction = (0, sort_1.getSortFunction)(this.application.options);
+                GroupPlugin_1.WEIGHTS = this.groupOrder;
             },
             [converter_1.Converter.EVENT_RESOLVE]: this.onResolve,
             [converter_1.Converter.EVENT_RESOLVE_END]: this.onEndResolve,
@@ -135,13 +137,40 @@ let GroupPlugin = class GroupPlugin extends components_1.ConverterComponent {
                 group.children.push(child);
             }
         });
-        return Array.from(groups.values());
+        return Array.from(groups.values()).sort(GroupPlugin_1.sortGroupCallback);
+    }
+    /**
+     * Callback used to sort groups by name.
+     */
+    static sortGroupCallback(a, b) {
+        let aWeight = GroupPlugin_1.WEIGHTS.indexOf(a.title);
+        let bWeight = GroupPlugin_1.WEIGHTS.indexOf(b.title);
+        if (aWeight === -1 || bWeight === -1) {
+            let asteriskIndex = GroupPlugin_1.WEIGHTS.indexOf("*");
+            if (asteriskIndex === -1) {
+                asteriskIndex = GroupPlugin_1.WEIGHTS.length;
+            }
+            if (aWeight === -1) {
+                aWeight = asteriskIndex;
+            }
+            if (bWeight === -1) {
+                bWeight = asteriskIndex;
+            }
+        }
+        if (aWeight === bWeight) {
+            return a.title > b.title ? 1 : -1;
+        }
+        return aWeight - bWeight;
     }
 };
+GroupPlugin.WEIGHTS = [];
 __decorate([
     (0, utils_1.BindOption)("searchGroupBoosts")
 ], GroupPlugin.prototype, "boosts", void 0);
-GroupPlugin = __decorate([
+__decorate([
+    (0, utils_1.BindOption)("groupOrder")
+], GroupPlugin.prototype, "groupOrder", void 0);
+GroupPlugin = GroupPlugin_1 = __decorate([
     (0, components_1.Component)({ name: "group" })
 ], GroupPlugin);
 exports.GroupPlugin = GroupPlugin;

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

@@ -165,14 +165,15 @@ output file :
             markedOptions.renderer = new Marked.Renderer();
             markedOptions.renderer.heading = (text, level, _, slugger) => {
                 const slug = slugger.slug(text);
-                // Prefix the slug with an extra `$` to prevent conflicts with TypeDoc's anchors.
+                // Prefix the slug with an extra `md:` to prevent conflicts with TypeDoc's anchors.
                 this.page.pageHeadings.push({
                     link: `#md:${slug}`,
                     text: (0, html_1.getTextContent)(text),
                     level,
                 });
-                return `<a id="md:${slug}" class="tsd-anchor"></a><h${level}><a href="#$${slug}" style="color:inherit;text-decoration:none">${text}</a></h${level}>`;
+                return `<a id="md:${slug}" class="tsd-anchor"></a><h${level}><a href="#md:${slug}">${text}</a></h${level}>`;
             };
+            markedOptions.renderer.code = renderCode;
         }
         markedOptions.mangle ?? (markedOptions.mangle = false); // See https://github.com/TypeStrong/typedoc/issues/1395
         return markedOptions;
@@ -202,3 +203,20 @@ MarkedPlugin = __decorate([
     (0, components_1.Component)({ name: "marked" })
 ], MarkedPlugin);
 exports.MarkedPlugin = MarkedPlugin;
+// Basically a copy/paste of Marked's code, with the addition of the button
+// https://github.com/markedjs/marked/blob/v4.3.0/src/Renderer.js#L15-L39
+function renderCode(code, infostring, escaped) {
+    const lang = (infostring || "").match(/\S*/)[0];
+    if (this.options.highlight) {
+        const out = this.options.highlight(code, lang);
+        if (out != null && out !== code) {
+            escaped = true;
+            code = out;
+        }
+    }
+    code = code.replace(/\n$/, "") + "\n";
+    if (!lang) {
+        return `<pre><code>${escaped ? code : (0, html_1.escapeHtml)(code)}</code><button>Copy</button></pre>\n`;
+    }
+    return `<pre><code class="${this.options.langPrefix + (0, html_1.escapeHtml)(lang)}">${escaped ? code : (0, html_1.escapeHtml)(code)}</code><button>Copy</button></pre>\n`;
+}

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";
+import { Reflection } from "../../../../models";
 export declare function comment({ markdown }: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;

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

@@ -2,14 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.comment = void 0;
 const utils_1 = require("../../../../utils");
+const models_1 = require("../../../../models");
 const lib_1 = require("../../lib");
 function comment({ markdown }, props) {
     if (!props.comment?.hasVisibleComponent())
         return;
     // Note: Comment modifiers are handled in `renderFlags`
+    const tags = props.kindOf(models_1.ReflectionKind.SomeSignature)
+        ? props.comment.blockTags.filter((tag) => tag.tag !== "@returns")
+        : props.comment.blockTags;
     return (utils_1.JSX.createElement("div", { class: "tsd-comment tsd-typography" },
         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,
+        tags.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(item.content) }))))));
 }

package/dist/lib/output/themes/default/partials/member.declaration.js

@@ -7,7 +7,7 @@ const lib_1 = require("../../lib");
 const memberDeclaration = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
     utils_1.JSX.createElement("div", { class: "tsd-signature" },
         utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(props) }, (0, lib_1.wbr)(props.name)),
-        (0, lib_1.renderTypeParametersSignature)(props.typeParameters),
+        (0, lib_1.renderTypeParametersSignature)(context, props.typeParameters),
         props.type && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
                 !!props.flags.isOptional && "?",

package/dist/lib/output/themes/default/partials/member.signature.body.d.ts

@@ -1,6 +1,6 @@
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import { JSX } from "../../../../utils";
 import { SignatureReflection } from "../../../../models";
-export declare const memberSignatureBody: (context: DefaultThemeRenderContext, props: SignatureReflection, { hideSources }?: {
-    hideSources?: boolean | undefined;
-}) => JSX.Element;
+export declare function memberSignatureBody(context: DefaultThemeRenderContext, props: SignatureReflection, { hideSources }?: {
+    hideSources?: boolean;
+}): JSX.Element;

package/dist/lib/output/themes/default/partials/member.signature.body.js

@@ -4,28 +4,32 @@ exports.memberSignatureBody = void 0;
 const utils_1 = require("../../../../utils");
 const models_1 = require("../../../../models");
 const lib_1 = require("../../lib");
-const memberSignatureBody = (context, props, { hideSources = false } = {}) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-    (0, lib_1.renderFlags)(props.flags, props.comment),
-    context.comment(props),
-    (0, lib_1.hasTypeParameters)(props) && context.typeParameters(props.typeParameters),
-    props.parameters && props.parameters.length > 0 && (utils_1.JSX.createElement("div", { class: "tsd-parameters" },
-        utils_1.JSX.createElement("h4", { class: "tsd-parameters-title" }, "Parameters"),
-        utils_1.JSX.createElement("ul", { class: "tsd-parameter-list" }, props.parameters.map((item) => (utils_1.JSX.createElement("li", null,
-            utils_1.JSX.createElement("h5", null,
-                (0, lib_1.renderFlags)(item.flags, item.comment),
-                !!item.flags.isRest && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "..."),
-                utils_1.JSX.createElement("span", { class: "tsd-kind-parameter" }, item.name),
-                ": ",
-                context.type(item.type),
-                item.defaultValue != null && (utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
-                    " = ",
-                    item.defaultValue))),
-            context.comment(item),
-            item.type instanceof models_1.ReflectionType && context.parameter(item.type.declaration))))))),
-    props.type && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-        utils_1.JSX.createElement("h4", { class: "tsd-returns-title" },
-            "Returns ",
-            context.type(props.type)),
-        props.type instanceof models_1.ReflectionType && context.parameter(props.type.declaration))),
-    !hideSources && context.memberSources(props)));
+function memberSignatureBody(context, props, { hideSources = false } = {}) {
+    const returnsTag = props.comment?.getTag("@returns");
+    return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+        (0, lib_1.renderFlags)(props.flags, props.comment),
+        context.comment(props),
+        (0, lib_1.hasTypeParameters)(props) && context.typeParameters(props.typeParameters),
+        props.parameters && props.parameters.length > 0 && (utils_1.JSX.createElement("div", { class: "tsd-parameters" },
+            utils_1.JSX.createElement("h4", { class: "tsd-parameters-title" }, "Parameters"),
+            utils_1.JSX.createElement("ul", { class: "tsd-parameter-list" }, props.parameters.map((item) => (utils_1.JSX.createElement("li", null,
+                utils_1.JSX.createElement("h5", null,
+                    (0, lib_1.renderFlags)(item.flags, item.comment),
+                    !!item.flags.isRest && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "..."),
+                    utils_1.JSX.createElement("span", { class: "tsd-kind-parameter" }, item.name),
+                    ": ",
+                    context.type(item.type),
+                    item.defaultValue != null && (utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
+                        " = ",
+                        item.defaultValue))),
+                context.comment(item),
+                item.type instanceof models_1.ReflectionType && context.parameter(item.type.declaration))))))),
+        props.type && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+            utils_1.JSX.createElement("h4", { class: "tsd-returns-title" },
+                "Returns ",
+                context.type(props.type)),
+            returnsTag && utils_1.JSX.createElement(utils_1.Raw, { html: context.markdown(returnsTag.content) }),
+            props.type instanceof models_1.ReflectionType && context.parameter(props.type.declaration))),
+        !hideSources && context.memberSources(props)));
+}
 exports.memberSignatureBody = memberSignatureBody;

package/dist/lib/output/themes/default/partials/member.signature.title.js

@@ -27,7 +27,7 @@ function memberSignatureTitle(context, props, { hideName = false, arrowStyle = f
         !hideName ? (utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(props) }, (0, lib_1.wbr)(props.name))) : (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, props.kind === models_1.ReflectionKind.ConstructorSignature && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             !!props.flags.isAbstract && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "abstract "),
             utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "new "))))),
-        (0, lib_1.renderTypeParametersSignature)(props.typeParameters),
+        (0, lib_1.renderTypeParametersSignature)(context, props.typeParameters),
         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "("),
         (0, lib_1.join)(", ", props.parameters ?? [], renderParam),
         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ")"),

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

@@ -62,29 +62,54 @@ function settings(context) {
                         utils_1.JSX.createElement("option", { value: "dark" }, "Dark")))))));
 }
 exports.settings = settings;
+function getNavigationElements(parent, opts) {
+    if (parent instanceof models_1.ReflectionCategory) {
+        return parent.children;
+    }
+    if (parent instanceof models_1.ReflectionGroup) {
+        if (opts.includeCategories && parent.categories) {
+            return parent.categories;
+        }
+        return parent.children;
+    }
+    if (!parent.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
+        return [];
+    }
+    if (parent.categories && opts.includeCategories) {
+        return parent.categories;
+    }
+    if (parent.groups && opts.includeGroups) {
+        return parent.groups;
+    }
+    return parent.children || [];
+}
 function navigation(context, props) {
+    const opts = context.options.getValue("navigation");
     // Create the navigation for the current page
     // Recurse to children if the parent is some kind of module
     return (utils_1.JSX.createElement("nav", { class: "tsd-navigation" },
-        link(props.project),
-        utils_1.JSX.createElement("ul", { class: "tsd-small-nested-navigation" }, props.project.children?.map((c) => (utils_1.JSX.createElement("li", null, links(c)))))));
-    function links(mod) {
-        const children = (mod.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project) && mod.children) || [];
-        const nameClasses = (0, lib_1.classNames)({ deprecated: mod.isDeprecated() }, mod.isProject() ? void 0 : context.getReflectionClasses(mod));
+        createNavElement(props.project),
+        utils_1.JSX.createElement("ul", { class: "tsd-small-nested-navigation" }, getNavigationElements(props.project, opts).map((c) => (utils_1.JSX.createElement("li", null, links(c, [])))))));
+    function links(mod, parents) {
+        const nameClasses = (0, lib_1.classNames)({ deprecated: mod instanceof models_1.Reflection && mod.isDeprecated() }, !(mod instanceof models_1.Reflection) || mod.isProject() ? void 0 : context.getReflectionClasses(mod));
+        const children = getNavigationElements(mod, opts);
         if (!children.length) {
-            return link(mod, nameClasses);
+            return createNavElement(mod, nameClasses);
         }
-        return (utils_1.JSX.createElement("details", { class: (0, lib_1.classNames)({ "tsd-index-accordion": true }, nameClasses), open: inPath(mod), "data-key": mod.getFullName() },
+        return (utils_1.JSX.createElement("details", { class: (0, lib_1.classNames)({ "tsd-index-accordion": true }, nameClasses), open: mod instanceof models_1.Reflection && inPath(mod), "data-key": mod instanceof models_1.Reflection ? mod.getFullName() : [...parents, mod.title].join("$") },
             utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary" },
                 context.icons.chevronDown(),
-                link(mod)),
+                createNavElement(mod)),
             utils_1.JSX.createElement("div", { class: "tsd-accordion-details" },
-                utils_1.JSX.createElement("ul", { class: "tsd-nested-navigation" }, children.map((c) => (utils_1.JSX.createElement("li", null, links(c))))))));
+                utils_1.JSX.createElement("ul", { class: "tsd-nested-navigation" }, children.map((c) => (utils_1.JSX.createElement("li", null, links(c, mod instanceof models_1.Reflection ? [mod.getFullName()] : [...parents, mod.title]))))))));
     }
-    function link(child, nameClasses) {
-        return (utils_1.JSX.createElement("a", { href: context.urlTo(child), class: (0, lib_1.classNames)({ current: child === props.model }, nameClasses) },
-            context.icons[child.kind](),
-            utils_1.JSX.createElement("span", null, (0, lib_1.wbr)((0, lib_1.getDisplayName)(child)))));
+    function createNavElement(child, nameClasses) {
+        if (child instanceof models_1.Reflection) {
+            return (utils_1.JSX.createElement("a", { href: context.urlTo(child), class: (0, lib_1.classNames)({ current: child === props.model }, nameClasses) },
+                context.icons[child.kind](),
+                utils_1.JSX.createElement("span", null, (0, lib_1.wbr)((0, lib_1.getDisplayName)(child)))));
+        }
+        return utils_1.JSX.createElement("span", null, child.title);
     }
     function inPath(mod) {
         let iter = props.model;

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

@@ -171,7 +171,7 @@ const typeRenderers = {
     predicate(context, type) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             !!type.asserts && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "asserts "),
-            utils_1.JSX.createElement("span", { class: "tsd-signature-type" }, type.name),
+            utils_1.JSX.createElement("span", { class: "tsd-kind-parameter" }, type.name),
             !!type.targetType && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                 utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, " is "),
                 renderType(context, type.targetType, models_1.TypeContext.predicateTarget)))));

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

@@ -4,9 +4,9 @@ exports.typeParameters = void 0;
 const utils_1 = require("../../../../utils");
 function typeParameters(context, typeParameters) {
     return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-        utils_1.JSX.createElement("section", { class: "tsd-panel tsd-type-parameters" },
+        utils_1.JSX.createElement("section", { class: "tsd-panel" },
             utils_1.JSX.createElement("h4", null, "Type Parameters"),
-            utils_1.JSX.createElement("ul", { class: "tsd-type-parameters" }, typeParameters?.map((item) => (utils_1.JSX.createElement("li", null,
+            utils_1.JSX.createElement("ul", { class: "tsd-type-parameter-list" }, typeParameters?.map((item) => (utils_1.JSX.createElement("li", null,
                 utils_1.JSX.createElement("h4", null,
                     item.flags.isConst && "const ",
                     item.varianceModifier ? `${item.varianceModifier} ` : "",

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

@@ -1,3 +1,4 @@
+import type { DefaultThemeRenderContext } from "..";
 import { Comment, Reflection, ReflectionFlags, TypeParameterReflection } from "../../models";
 import { JSX } from "../../utils";
 export declare function stringify(data: unknown): string;
@@ -19,7 +20,7 @@ export declare function classNames(names: Record<string, boolean | null | undefi
 export declare function hasTypeParameters(reflection: Reflection): reflection is Reflection & {
     typeParameters: TypeParameterReflection[];
 };
-export declare function renderTypeParametersSignature(typeParameters: readonly TypeParameterReflection[] | undefined): JSX.Element;
+export declare function renderTypeParametersSignature(context: DefaultThemeRenderContext, typeParameters: readonly TypeParameterReflection[] | undefined): JSX.Element;
 export declare function camelToTitleCase(text: string): string;
 /**
  * Renders the reflection name with an additional `?` if optional.

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

@@ -88,14 +88,29 @@ function hasTypeParameters(reflection) {
         reflection.typeParameters.length > 0);
 }
 exports.hasTypeParameters = hasTypeParameters;
-function renderTypeParametersSignature(typeParameters) {
-    return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, !!typeParameters && typeParameters.length > 0 && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+function renderTypeParametersSignature(context, typeParameters) {
+    if (!typeParameters || typeParameters.length === 0)
+        return utils_1.JSX.createElement(utils_1.JSX.Fragment, null);
+    const hideParamTypes = context.options.getValue("hideParameterTypesInTitle");
+    if (hideParamTypes) {
+        return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "<"),
+            join(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ", "), typeParameters, (item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+                item.flags.isConst && "const ",
+                item.varianceModifier ? `${item.varianceModifier} ` : "",
+                utils_1.JSX.createElement("span", { class: "tsd-signature-type tsd-kind-type-parameter" }, item.name)))),
+            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ">")));
+    }
+    return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "<"),
         join(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ", "), typeParameters, (item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             item.flags.isConst && "const ",
             item.varianceModifier ? `${item.varianceModifier} ` : "",
-            utils_1.JSX.createElement("span", { class: "tsd-signature-type tsd-kind-type-parameter" }, item.name)))),
-        utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ">")))));
+            utils_1.JSX.createElement("span", { class: "tsd-signature-type tsd-kind-type-parameter" }, item.name),
+            !!item.type && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+                utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, " extends "),
+                context.type(item.type)))))),
+        utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ">")));
 }
 exports.renderTypeParametersSignature = renderTypeParametersSignature;
 function camelToTitleCase(text) {