typedoc 0.28.1 → 0.28.2

package/dist/lib/application.d.ts

@@ -34,7 +34,7 @@ export interface ApplicationEvents {
  * Access to an Application instance can be retrieved with {@link Application.bootstrap} or
  * {@link Application.bootstrapWithPlugins}. It can not be constructed manually.
  *
- * @group Common
+ * @group None
  * @summary Root level class which contains most useful behavior.
  */
 export declare class Application extends AbstractComponent<Application, ApplicationEvents> {
@@ -109,7 +109,7 @@ export declare class Application extends AbstractComponent<Application, Applicat
      * @example
      * Initialize the application with pretty-printing output disabled.
      * ```ts
-     * const app = Application.bootstrap({ pretty: false });
+     * const app = await Application.bootstrap({ pretty: false });
      * ```
      *
      * @param options Options to set during initialization

package/dist/lib/application.js

@@ -95,7 +95,7 @@ const DEFAULT_READERS = [
  * Access to an Application instance can be retrieved with {@link Application.bootstrap} or
  * {@link Application.bootstrapWithPlugins}. It can not be constructed manually.
  *
- * @group Common
+ * @group None
  * @summary Root level class which contains most useful behavior.
  */
 let Application = (() => {
@@ -236,7 +236,7 @@ let Application = (() => {
          * @example
          * Initialize the application with pretty-printing output disabled.
          * ```ts
-         * const app = Application.bootstrap({ pretty: false });
+         * const app = await Application.bootstrap({ pretty: false });
          * ```
          *
          * @param options Options to set during initialization
@@ -673,10 +673,12 @@ let Application = (() => {
             const entryPoints = this.entryPoints.flatMap((entry) => {
                 const result = glob(entry, rootDir);
                 if (result.length === 0) {
-                    this.logger.warn(i18n.entrypoint_did_not_match_files_0(nicePath(entry)));
+                    // #2918 - do not pass entry through nicePath here in case it contains
+                    // windows path separators which should cause additional warnings.
+                    this.logger.warn(i18n.entrypoint_did_not_match_files_0(entry));
                 }
                 else if (result.length !== 1) {
-                    this.logger.verbose(`Expanded ${nicePath(entry)} to:\n\t${result
+                    this.logger.verbose(`Expanded ${entry} to:\n\t${result
                         .map(nicePath)
                         .join("\n\t")}`);
                 }

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

@@ -172,7 +172,12 @@ export function getJsDocComment(declaration, config, logger, checker, files) {
     }
     const tag = comment.getIdentifiedTag(name, `@${declaration.tagName.text}`);
     if (!tag) {
-        logger.error(i18n.failed_to_find_jsdoc_tag_for_name_0(name), declaration);
+        // If this is a template tag with multiple declarations, we warned already if there
+        // was a comment attached. If there wasn't, then don't error about failing to find
+        // a tag because this is unsupported.
+        if (!ts.isJSDocTemplateTag(declaration)) {
+            logger.error(i18n.failed_to_find_jsdoc_tag_for_name_0(name), declaration);
+        }
     }
     else {
         const result = new Comment(Comment.cloneDisplayParts(tag.content));

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

@@ -36,7 +36,7 @@ export interface ConverterEvents {
 /**
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
  *
- * @group Common
+ * @group None
  * @summary Responsible for converting TypeScript symbols into {@link Reflection}s and {@link Type}s.
  */
 export declare class Converter extends AbstractComponent<Application, ConverterEvents> {

package/dist/lib/converter/converter.js

@@ -62,7 +62,7 @@ import { MergeModuleWithPlugin } from "./plugins/MergeModuleWithPlugin.js";
 /**
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
  *
- * @group Common
+ * @group None
  * @summary Responsible for converting TypeScript symbols into {@link Reflection}s and {@link Type}s.
  */
 let Converter = (() => {

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

@@ -7,6 +7,7 @@ export declare function createSignature(context: Context, kind: ReflectionKind.C
  */
 export declare function createConstructSignatureWithType(context: Context, signature: ts.Signature, classType: Reflection): void;
 export declare function convertParameterNodes(context: Context, sigRef: SignatureReflection, parameters: readonly (ts.JSDocParameterTag | ts.ParameterDeclaration)[]): ParameterReflection[];
+export declare function convertTypeParameters(context: Context, parent: Reflection, parameters: readonly ts.TypeParameter[] | undefined): TypeParameterReflection[] | undefined;
 export declare function convertTypeParameterNodes(context: Context, parameters: readonly ts.TypeParameterDeclaration[] | undefined): TypeParameterReflection[] | undefined;
 export declare function createTypeParamReflection(param: ts.TypeParameterDeclaration, context: Context): TypeParameterReflection;
 export declare function convertTemplateParameterNodes(context: Context, nodes: readonly ts.JSDocTemplateTag[] | undefined): TypeParameterReflection[] | undefined;

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

@@ -82,8 +82,22 @@ export function createConstructSignatureWithType(context, signature, classType)
     const sigRefCtx = context.withScope(sigRef);
     if (declaration) {
         sigRef.comment = context.getSignatureComment(declaration);
+        if (sigRef.comment?.discoveryId === context.scope.parent?.comment?.discoveryId) {
+            delete sigRef.comment;
+        }
     }
-    sigRef.typeParameters = convertTypeParameters(sigRefCtx, sigRef, signature.typeParameters);
+    const parameterSymbols = signature.thisParameter
+        ? [signature.thisParameter, ...signature.parameters]
+        : [...signature.parameters];
+    // Prevent a `this` parameter from appearing on constructor signature
+    // as TS disallows them on regular classes.
+    if (parameterSymbols[0]?.name === "this") {
+        parameterSymbols.shift();
+    }
+    sigRef.parameters = convertParameters(sigRefCtx, sigRef, parameterSymbols, declaration?.parameters);
+    sigRef.parameters = convertParameters(sigRefCtx, sigRef, parameterSymbols, undefined);
+    // Do NOT convert type parameters here, they go on the class itself in the @class case
+    // See #2914.
     sigRef.type = ReferenceType.createResolvedReference(context.scope.parent.name, classType, context.project);
     context.registerReflection(sigRef, undefined);
     context.scope.signatures ??= [];
@@ -203,7 +217,7 @@ function checkForDestructuredParameterDefaults(param, decl) {
         }
     }
 }
-function convertTypeParameters(context, parent, parameters) {
+export function convertTypeParameters(context, parent, parameters) {
     return parameters?.map((param) => {
         const constraintT = param.getConstraint();
         const defaultT = param.getDefault();
@@ -236,9 +250,18 @@ export function convertTypeParameterNodes(context, parameters) {
 export function createTypeParamReflection(param, context) {
     const paramRefl = new TypeParameterReflection(param.name.text, context.scope, getVariance(param.modifiers));
     const paramScope = context.withScope(paramRefl);
-    paramRefl.type = param.constraint
-        ? context.converter.convertType(paramScope, param.constraint)
-        : void 0;
+    if (ts.isJSDocTemplateTag(param.parent)) {
+        // With a @template tag, the constraint applies only to the
+        // first type parameter declared.
+        if (param.parent.typeParameters[0].name.text === param.name.text && param.parent.constraint) {
+            paramRefl.type = context.converter.convertType(paramScope, param.parent.constraint);
+        }
+    }
+    else {
+        paramRefl.type = param.constraint
+            ? context.converter.convertType(paramScope, param.constraint)
+            : void 0;
+    }
     paramRefl.default = param.default
         ? context.converter.convertType(paramScope, param.default)
         : void 0;

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

@@ -121,7 +121,7 @@ let CategoryPlugin = (() => {
             }
         }
         categorize(obj) {
-            if (this.categorizeByGroup) {
+            if (this.categorizeByGroup && obj.groups) {
                 this.groupCategorize(obj);
             }
             else {

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

@@ -150,6 +150,9 @@ let GroupPlugin = (() => {
                     this.sortFunction(reflection.documents);
                     this.sortFunction(reflection.childrenIncludingDocuments);
                 }
+                if (reflection.comment?.hasModifier("@disableGroups")) {
+                    return;
+                }
                 reflection.groups = this.getReflectionGroups(reflection, reflection.childrenIncludingDocuments);
             }
         }

package/dist/lib/converter/symbols.js

@@ -4,7 +4,7 @@ import { DeclarationReflection, IntrinsicType, LiteralType, ReferenceReflection,
 import { getEnumFlags, hasAllFlags, hasAnyFlag, i18n, removeFlag } from "#utils";
 import { convertDefaultValue } from "./convert-expression.js";
 import { convertIndexSignatures } from "./factories/index-signature.js";
-import { createConstructSignatureWithType, createSignature, createTypeParamReflection } from "./factories/signature.js";
+import { convertTypeParameters, createConstructSignatureWithType, createSignature, createTypeParamReflection, } from "./factories/signature.js";
 import { convertJsDocAlias, convertJsDocCallback } from "./jsdoc.js";
 import { getHeritageTypes } from "./utils/nodes.js";
 import { removeUndefined } from "./utils/reflections.js";
@@ -702,6 +702,9 @@ function convertSymbolAsClass(context, symbol, exportSymbol) {
         for (const sig of ctors) {
             createConstructSignatureWithType(constructContext, sig, reflection);
         }
+        // Take the type parameters from the first constructor signature and use
+        // them as the type parameters for the class, #2914
+        reflection.typeParameters = convertTypeParameters(rc, reflection, ctors[0].getTypeParameters());
         const instType = ctors[0].getReturnType();
         convertSymbols(rc, instType.getProperties());
         for (const sig of instType.getCallSignatures()) {

package/dist/lib/converter/types.js

@@ -440,11 +440,7 @@ const referenceConverter = {
         // in the type we just retrieved from node.typeName.
         if (!node.typeArguments &&
             context.shouldInline(symbol, name)) {
-            // typeLiteralConverter doesn't use the node, so we can get away with lying here.
-            // This might not actually be safe, it appears that it is in the relatively small
-            // amount of testing I've done with it, but I wouldn't be surprised if someone manages
-            // to find a crash.
-            return typeLiteralConverter.convertType(context, type, null, undefined);
+            return convertTypeInlined(context, type);
         }
         const ref = context.createSymbolReference(context.resolveAliasedSymbol(symbol), context, name);
         ref.typeArguments = node.typeArguments?.map((type) => convertType(context, type));
@@ -470,11 +466,7 @@ const referenceConverter = {
             name = node.typeName.right.text;
         }
         if (context.shouldInline(symbol, name)) {
-            // typeLiteralConverter doesn't use the node, so we can get away with lying here.
-            // This might not actually be safe, it appears that it is in the relatively small
-            // amount of testing I've done with it, but I wouldn't be surprised if someone manages
-            // to find a crash.
-            return typeLiteralConverter.convertType(context, type, null, undefined);
+            return convertTypeInlined(context, type);
         }
         const ref = context.createSymbolReference(context.resolveAliasedSymbol(symbol), context, name);
         if (type.flags & ts.TypeFlags.Substitution) {
@@ -785,3 +777,23 @@ function normalizeUnion(types) {
         types.splice(Math.min(trueIndex, falseIndex), 1, new IntrinsicType("boolean"));
     }
 }
+function convertTypeInlined(context, type) {
+    if (type.isUnion()) {
+        const types = type.types.map(type => convertType(context, type));
+        return new UnionType(types);
+    }
+    if (type.isIntersection()) {
+        const types = type.types.map(type => convertType(context, type));
+        return new IntersectionType(types);
+    }
+    if (type.isLiteral()) {
+        return new LiteralType(typeof type.value === "object"
+            ? BigInt(type.value.base10Value) * (type.value.negative ? -1n : 1n)
+            : type.value);
+    }
+    if (context.checker.isArrayType(type)) {
+        const elementType = convertType(context, context.checker.getTypeArguments(type)[0]);
+        return new ArrayType(elementType);
+    }
+    return typeLiteralConverter.convertType(context, type);
+}

package/dist/lib/internationalization/locales/zh.cjs

@@ -18,6 +18,7 @@ module.exports = localeUtils.buildIncompleteTranslation({
     no_entry_points_for_packages: "没有为包模式提供入口点，无法生成文档",
     failed_to_find_packages: "找不到任何软件包，请确保您至少提供了一个包含 package.json 的目录作为入口点",
     nested_packages_unsupported_0: "位于 {0} 的项目已将 entryPointStrategy 设置为包，但不支持嵌套包",
+    package_option_0_should_be_specified_at_root: "由 packageOptions 设置的选项 {0} 仅在根级别有效",
     previous_error_occurred_when_reading_options_for_0: "读取 {0} 处的包的选项时发生上一个错误",
     converting_project_at_0: "正在转换 {0} 处的项目",
     failed_to_convert_packages: "无法转换一个或多个包，结果将不会合并在一起",
@@ -435,6 +436,10 @@ module.exports = localeUtils.buildIncompleteTranslation({
     tag_type: "类型",
     tag_typedef: "类型定义",
     tag_summary: "概述",
+    tag_preventInline: "取消内联",
+    tag_inlineType: "内联类型",
+    tag_preventExpand: "取消扩展",
+    tag_expandType: "扩展类型",
     // Inline tags
     tag_link: "链接",
     tag_label: "标记",
@@ -467,6 +472,7 @@ module.exports = localeUtils.buildIncompleteTranslation({
     tag_inline: "内联",
     tag_interface: "接口",
     tag_namespace: "命名空间",
+    tag_function: "函数",
     tag_overload: "重载",
     tag_private: "私有成员",
     tag_protected: "受保护成员",

package/dist/lib/internationalization/locales/zh.d.cts

@@ -13,6 +13,7 @@ declare const _default: {
     no_entry_points_for_packages: string;
     failed_to_find_packages: string;
     nested_packages_unsupported_0: "位于 {0} 的项目已将 entryPointStrategy 设置为包，但不支持嵌套包";
+    package_option_0_should_be_specified_at_root: "由 packageOptions 设置的选项 {0} 仅在根级别有效";
     previous_error_occurred_when_reading_options_for_0: "读取 {0} 处的包的选项时发生上一个错误";
     converting_project_at_0: "正在转换 {0} 处的项目";
     failed_to_convert_packages: string;
@@ -400,6 +401,10 @@ declare const _default: {
     tag_type: string;
     tag_typedef: string;
     tag_summary: string;
+    tag_preventInline: string;
+    tag_inlineType: string;
+    tag_preventExpand: string;
+    tag_expandType: string;
     tag_link: string;
     tag_label: string;
     tag_linkcode: string;
@@ -430,6 +435,7 @@ declare const _default: {
     tag_inline: string;
     tag_interface: string;
     tag_namespace: string;
+    tag_function: string;
     tag_overload: string;
     tag_private: string;
     tag_protected: string;

package/dist/lib/models/types.js

@@ -899,17 +899,17 @@ export class ReflectionType extends Type {
     }
     getTypeString() {
         const parts = [];
-        const sigs = this.declaration.getAllSignatures();
+        const sigs = this.declaration.getNonIndexSignatures();
         for (const sig of sigs) {
             parts.push(sigStr(sig, ": "));
         }
-        if (this.declaration.children) {
-            for (const p of this.declaration.children) {
-                parts.push(`${p.name}${propertySep(p)} ${typeStr(p.type)}`);
-            }
-            return `{ ${parts.join("; ")} }`;
+        for (const p of this.declaration.children || []) {
+            parts.push(`${p.name}${propertySep(p)} ${typeStr(p.type)}`);
+        }
+        for (const s of this.declaration.indexSignatures || []) {
+            parts.push(sigStr(s, ": ", "[]"));
         }
-        if (sigs.length === 1) {
+        if (sigs.length === 1 && parts.length === 1) {
             return sigStr(sigs[0], " => ");
         }
         if (parts.length === 0) {
@@ -1238,7 +1238,7 @@ function propertySep(refl) {
 function typeStr(type) {
     return type?.toString() ?? "any";
 }
-function sigStr(sig, sep) {
+function sigStr(sig, sep, brackets = "()") {
     const params = joinArray(sig.parameters, ", ", (p) => `${p.name}${propertySep(p)} ${typeStr(p.type)}`);
-    return `(${params})${sep}${typeStr(sig.type)}`;
+    return `${brackets[0]}${params}${brackets[1]}${sep}${typeStr(sig.type)}`;
 }

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

@@ -115,7 +115,7 @@ export interface RendererEvents {
  *    an instance of {@link IndexEvent}.
  *
  * @summary Writes HTML output from TypeDoc's models
- * @group Common
+ * @group None
  */
 export declare class Renderer extends AbstractComponent<Application, RendererEvents> {
     private routers;
@@ -189,12 +189,16 @@ export declare class Renderer extends AbstractComponent<Application, RendererEve
      * @param theme
      */
     defineTheme(name: string, theme: new (renderer: Renderer) => Theme): void;
+    /** @internal intended for test usage only */
+    removeTheme(name: string): void;
     /**
      * Define a new router that can be used to determine the output structure.
      * @param name
      * @param router
      */
     defineRouter(name: string, router: new (app: Application) => Router): void;
+    /** @internal intended for test usage only */
+    removeRouter(name: string): void;
     /**
      * Render the given project reflection to the specified output directory.
      *

package/dist/lib/output/renderer.js

@@ -79,7 +79,7 @@ import { CategoryRouter, GroupRouter, KindDirRouter, KindRouter, StructureDirRou
  *    an instance of {@link IndexEvent}.
  *
  * @summary Writes HTML output from TypeDoc's models
- * @group Common
+ * @group None
  */
 let Renderer = (() => {
     let _classSuper = AbstractComponent;
@@ -231,6 +231,10 @@ let Renderer = (() => {
             }
             this.themes.set(name, theme);
         }
+        /** @internal intended for test usage only */
+        removeTheme(name) {
+            this.themes.delete(name);
+        }
         /**
          * Define a new router that can be used to determine the output structure.
          * @param name
@@ -242,6 +246,10 @@ let Renderer = (() => {
             }
             this.routers.set(name, router);
         }
+        /** @internal intended for test usage only */
+        removeRouter(name) {
+            this.routers.delete(name);
+        }
         /**
          * Render the given project reflection to the specified output directory.
          *

package/dist/lib/output/router.js

@@ -166,6 +166,16 @@ let BaseRouter = (() => {
                 // an own document.
                 from = from.parent;
             }
+            let toPage = to;
+            while (!this.hasOwnDocument(toPage)) {
+                toPage = toPage.parent;
+            }
+            // We unfortunately have to special case ProjectReflection as it is
+            // the model used twice for rendering. This should be changed in a
+            // future version to remove this hackery.
+            if (from === toPage && !(to instanceof ProjectReflection)) {
+                return to === toPage ? "" : `#${this.getAnchor(to)}`;
+            }
             const fromUrl = this.getFullUrl(from);
             const toUrl = this.getFullUrl(to);
             let equal = true;
@@ -181,12 +191,14 @@ let BaseRouter = (() => {
                     }
                 }
             }
-            if (equal && !(to instanceof ProjectReflection)) {
-                if (fromUrl === toUrl) {
-                    return "";
-                }
-                return `#${this.getAnchor(to)}`;
+            // If equal is still set, we're going to a page either in
+            // the same directory as this page, or a lower directory,
+            // don't bother going up directories just to come back down.
+            if (equal) {
+                return toUrl.substring(start);
             }
+            // Otherwise, go up until we get to the common directory
+            // and then back down to the target path.
             return "../".repeat(slashes) + toUrl.substring(start);
         }
         baseRelativeUrl(from, target) {

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

@@ -177,7 +177,7 @@ let MarkedPlugin = (() => {
                                     let url;
                                     let kindClass;
                                     if (typeof part.target === "string") {
-                                        url = part.target;
+                                        url = part.target === "#" ? undefined : part.target;
                                     }
                                     else if ("id" in part.target) {
                                         // No point in trying to resolve a ReflectionSymbolId at this point, we've already

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

@@ -1,8 +1,8 @@
-import { classNames, renderName } from "../../lib.js";
+import { classNames, getMemberSections, isNoneSection, renderName } from "../../lib.js";
 import { i18n, JSX } from "#utils";
-function renderCategory({ urlTo, reflectionIcon, getReflectionClasses, markdown }, item, prependName = "") {
+function renderSection({ urlTo, reflectionIcon, getReflectionClasses, markdown }, item) {
     return (JSX.createElement("section", { class: "tsd-index-section" },
-        JSX.createElement("h3", { class: "tsd-index-heading" }, prependName ? `${prependName} - ${item.title}` : item.title),
+        !isNoneSection(item) && JSX.createElement("h3", { class: "tsd-index-heading" }, item.title),
         item.description && (JSX.createElement("div", { class: "tsd-comment tsd-typography" },
             JSX.createElement(JSX.Raw, { html: markdown(item.description) }))),
         JSX.createElement("div", { class: "tsd-index-list" }, item.children.map((item) => (JSX.createElement(JSX.Fragment, null,
@@ -12,15 +12,7 @@ function renderCategory({ urlTo, reflectionIcon, getReflectionClasses, markdown
             "\n"))))));
 }
 export function index(context, props) {
-    let content = [];
-    if (props.categories?.length) {
-        content = props.categories.map((item) => renderCategory(context, item));
-    }
-    else if (props.groups?.length) {
-        content = props.groups.flatMap((item) => item.categories
-            ? item.categories.map((item2) => renderCategory(context, item2, item.title))
-            : renderCategory(context, item));
-    }
+    const sections = getMemberSections(props);
     return (JSX.createElement(JSX.Fragment, null,
         JSX.createElement("section", { class: "tsd-panel-group tsd-index-group" },
             JSX.createElement("section", { class: "tsd-panel tsd-index-panel" },
@@ -28,5 +20,5 @@ export function index(context, props) {
                     JSX.createElement("summary", { class: "tsd-accordion-summary tsd-index-summary" },
                         context.icons.chevronSmall(),
                         JSX.createElement("h5", { class: "tsd-index-heading uppercase" }, i18n.theme_index())),
-                    JSX.createElement("div", { class: "tsd-accordion-details" }, content))))));
+                    JSX.createElement("div", { class: "tsd-accordion-details" }, sections.map(s => renderSection(context, s))))))));
 }

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

@@ -1,14 +1,17 @@
 import { JSX } from "#utils";
 import {} from "../../../../models/index.js";
-import { getMemberSections } from "../../lib.js";
+import { getMemberSections, isNoneSection } from "../../lib.js";
 export function members(context, props) {
     const sections = getMemberSections(props, (child) => !context.router.hasOwnDocument(child));
-    return (JSX.createElement(JSX.Fragment, null, sections.map(({ title, children }) => {
-        context.page.startNewSection(title);
+    return (JSX.createElement(JSX.Fragment, null, sections.map((section) => {
+        if (isNoneSection(section)) {
+            return (JSX.createElement("section", { class: "tsd-panel-group tsd-member-group" }, section.children.map((item) => context.member(item))));
+        }
+        context.page.startNewSection(section.title);
         return (JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
-            JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + title },
+            JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + section.title },
                 context.icons.chevronDown(),
-                JSX.createElement("h2", null, title)),
-            JSX.createElement("section", null, children.map((item) => context.member(item)))));
+                JSX.createElement("h2", null, section.title)),
+            JSX.createElement("section", null, section.children.map((item) => context.member(item)))));
     })));
 }

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

@@ -1,6 +1,6 @@
 import { ReferenceReflection, ReflectionKind, } from "../../../../models/index.js";
 import { JSX } from "#utils";
-import { classNames, getDisplayName, getMemberSections, getUniquePath, join } from "../../lib.js";
+import { classNames, getDisplayName, getMemberSections, getUniquePath, isNoneSection, join } from "../../lib.js";
 import { anchorIcon } from "./anchor-icon.js";
 export function moduleReflection(context, mod) {
     const sections = getMemberSections(mod);
@@ -10,15 +10,22 @@ export function moduleReflection(context, mod) {
             context.commentTags(mod))),
         mod.isDeclaration() && mod.kind === ReflectionKind.Module && mod.readme?.length && (JSX.createElement("section", { class: "tsd-panel tsd-typography" },
             JSX.createElement(JSX.Raw, { html: context.markdown(mod.readme) }))),
-        sections.map(({ title, children, description }) => {
-            context.page.startNewSection(title);
+        sections.map((section) => {
+            if (!isNoneSection(section)) {
+                context.page.startNewSection(section.title);
+            }
+            const content = (JSX.createElement(JSX.Fragment, null,
+                section.description && (JSX.createElement("div", { class: "tsd-comment tsd-typography" },
+                    JSX.createElement(JSX.Raw, { html: context.markdown(section.description) }))),
+                JSX.createElement("dl", { class: "tsd-member-summaries" }, section.children.map((item) => context.moduleMemberSummary(item)))));
+            if (isNoneSection(section)) {
+                return (JSX.createElement("section", { class: "tsd-panel-group tsd-member-group" }, content));
+            }
             return (JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
-                JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + title },
+                JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + section.title },
                     context.icons.chevronDown(),
-                    JSX.createElement("h2", null, title)),
-                description && (JSX.createElement("div", { class: "tsd-comment tsd-typography" },
-                    JSX.createElement(JSX.Raw, { html: context.markdown(description) }))),
-                JSX.createElement("dl", { class: "tsd-member-summaries" }, children.map((item) => context.moduleMemberSummary(item)))));
+                    JSX.createElement("h2", null, section.title)),
+                content));
         })));
 }
 export function moduleMemberSummary(context, member) {

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

@@ -87,12 +87,20 @@ function buildSectionNavigation(context, headings) {
         const built = (JSX.createElement("ul", null, level.map((l) => JSX.createElement("li", null, l))));
         levels[levels.length - 1].push(built);
     }
+    function getInferredHeadingLevel(heading) {
+        if (heading.level) {
+            // Regular heading
+            return heading.level + 2;
+        }
+        if (heading.kind) {
+            // Reflection
+            return 2;
+        }
+        // Group/category
+        return 1;
+    }
     for (const heading of headings) {
-        const inferredLevel = heading.level
-            ? heading.level + 2 // regular heading
-            : heading.kind
-                ? 2 // reflection
-                : 1; // group/category
+        const inferredLevel = getInferredHeadingLevel(heading);
         while (inferredLevel < levels.length) {
             finalizeLevel(false);
         }

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

@@ -25,12 +25,13 @@ export declare function renderTypeParametersSignature(context: DefaultThemeRende
  */
 export declare function renderName(refl: Reflection): JSX.Element | (string | JSX.Element)[];
 export declare function getHierarchyRoots(project: ProjectReflection): DeclarationReflection[];
-export interface MemberSections {
+export declare function isNoneSection(section: MemberSection): boolean;
+export interface MemberSection {
     title: string;
     description?: CommentDisplayPart[];
     children: Array<DocumentReflection | DeclarationReflection>;
 }
-export declare function getMemberSections(parent: ContainerReflection, childFilter?: (refl: Reflection) => boolean): MemberSections[];
+export declare function getMemberSections(parent: ContainerReflection, childFilter?: (refl: Reflection) => boolean): MemberSection[];
 /**
  * Returns a (hopefully) globally unique path for the given reflection.
  *

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

@@ -70,17 +70,6 @@ export function hasTypeParameters(reflection) {
 export function renderTypeParametersSignature(context, typeParameters) {
     if (!typeParameters || typeParameters.length === 0)
         return JSX.createElement(JSX.Fragment, null);
-    const hideParamTypes = false; // context.options.getValue("hideTypesInSignatureTitle");
-    if (hideParamTypes) {
-        return (JSX.createElement(JSX.Fragment, null,
-            JSX.createElement("span", { class: "tsd-signature-symbol" }, "<"),
-            join(JSX.createElement("span", { class: "tsd-signature-symbol" }, ", "), typeParameters, (item) => (JSX.createElement(JSX.Fragment, null,
-                (item.flags.isConst || item.varianceModifier) && (JSX.createElement("span", { class: "tsd-signature-keyword" },
-                    item.flags.isConst && "const ",
-                    item.varianceModifier && `${item.varianceModifier} `)),
-                JSX.createElement("a", { class: "tsd-signature-type tsd-kind-type-parameter", href: context.urlTo(item) }, item.name)))),
-            JSX.createElement("span", { class: "tsd-signature-symbol" }, ">")));
-    }
     return (JSX.createElement(JSX.Fragment, null,
         JSX.createElement("span", { class: "tsd-signature-symbol" }, "<"),
         join(JSX.createElement("span", { class: "tsd-signature-symbol" }, ", "), typeParameters, (item) => (JSX.createElement(JSX.Fragment, null,
@@ -135,6 +124,18 @@ export function getHierarchyRoots(project) {
     rootsCache.set(project, result);
     return result;
 }
+export function isNoneSection(section) {
+    return section.title.toLocaleLowerCase() === "none";
+}
+function sortNoneSectionFirst(a, b) {
+    if (isNoneSection(a)) {
+        return -1;
+    }
+    if (isNoneSection(b)) {
+        return 1;
+    }
+    return 0;
+}
 export function getMemberSections(parent, childFilter = () => true) {
     if (parent.categories?.length) {
         return filterMap(parent.categories, (cat) => {
@@ -146,17 +147,17 @@ export function getMemberSections(parent, childFilter = () => true) {
                 description: cat.description,
                 children,
             };
-        });
+        }).sort(sortNoneSectionFirst);
     }
     if (parent.groups?.length) {
         return parent.groups.flatMap((group) => {
             if (group.categories?.length) {
-                return filterMap(group.categories, (cat) => {
+                return filterMap(group.categories.slice().sort(sortNoneSectionFirst), (cat) => {
                     const children = cat.children.filter(childFilter);
                     if (!children.length)
                         return;
                     return {
-                        title: `${group.title} - ${cat.title}`,
+                        title: isNoneSection(cat) ? group.title : `${group.title} - ${cat.title}`,
                         description: cat.description,
                         children,
                     };
@@ -170,7 +171,13 @@ export function getMemberSections(parent, childFilter = () => true) {
                 description: group.description,
                 children,
             };
-        });
+        }).sort(sortNoneSectionFirst);
+    }
+    if (parent.children?.length) {
+        return [{
+                title: "none",
+                children: parent.children || [],
+            }];
     }
     return [];
 }

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

@@ -12,7 +12,7 @@ export interface Deserializable<T> {
 /**
  * Deserializes TypeDoc's JSON output back to {@link Reflection} instances.
  *
- * @group Common
+ * @group None
  * @summary Deserializes TypeDoc's JSON output
  */
 export declare class Deserializer {

package/dist/lib/serialization/deserializer.js

@@ -5,7 +5,7 @@ const supportedSchemaVersions = [JSONOutput.SCHEMA_VERSION];
 /**
  * Deserializes TypeDoc's JSON output back to {@link Reflection} instances.
  *
- * @group Common
+ * @group None
  * @summary Deserializes TypeDoc's JSON output
  */
 export class Deserializer {

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

@@ -10,7 +10,7 @@ export interface SerializerEvents {
 /**
  * Serializes TypeDoc's models to JSON
  *
- * @group Common
+ * @group None
  * @summary Serializes TypeDoc's models to JSON
  */
 export declare class Serializer extends EventDispatcher<SerializerEvents> {

package/dist/lib/serialization/serializer.js

@@ -3,7 +3,7 @@ import { EventDispatcher, insertPrioritySorted, removeIfPresent } from "#utils";
 /**
  * Serializes TypeDoc's models to JSON
  *
- * @group Common
+ * @group None
  * @summary Serializes TypeDoc's models to JSON
  */
 export class Serializer extends EventDispatcher {

package/dist/lib/utils/entry-point.js

@@ -228,16 +228,18 @@ function expandGlobs(globs, exclude, logger) {
         });
         const filtered = result.filter((file) => file === entry || !excludePatterns.matchesAny(file));
         if (result.length === 0) {
-            logger.warn(i18n.glob_0_did_not_match_any_files(nicePath(entry)));
+            // #2918 - do not pass entry through nicePath here in case it contains
+            // windows path separators which should cause additional warnings.
+            logger.warn(i18n.glob_0_did_not_match_any_files(entry));
             if (entry.includes("\\") && !entry.includes("/")) {
                 logger.info(i18n.glob_should_use_posix_slash());
             }
         }
         else if (filtered.length === 0) {
-            logger.warn(i18n.entry_point_0_did_not_match_any_files_after_exclude(nicePath(entry)));
+            logger.warn(i18n.entry_point_0_did_not_match_any_files_after_exclude(entry));
         }
         else if (filtered.length !== 1) {
-            logger.verbose(`Expanded ${nicePath(entry)} to:\n\t${filtered
+            logger.verbose(`Expanded ${entry} to:\n\t${filtered
                 .map(nicePath)
                 .join("\n\t")}`);
         }

package/dist/lib/utils/options/defaults.js

@@ -27,6 +27,7 @@ export const excludeTags = [
     "@satisfies",
     "@overload",
     "@inline",
+    "@inlineType",
 ];
 export const blockTags = TagDefaults.blockTags;
 export const inlineTags = TagDefaults.inlineTags;
@@ -41,6 +42,7 @@ export const notRenderedTags = [
     "@showGroups",
     "@hideCategories",
     "@hideGroups",
+    "@disableGroups",
     "@expand",
     "@preventExpand",
     "@expandType",

package/dist/lib/utils/options/options.d.ts

@@ -60,7 +60,7 @@ export interface OptionsReader {
  * 4. argv (300) - Read argv again since any options set there should override those set in config
  *    files.
  *
- * @group Common
+ * @group None
  * @summary Contains all of TypeDoc's option declarations & values
  */
 export declare class Options {

package/dist/lib/utils/options/options.js

@@ -26,7 +26,7 @@ const optionSnapshots = new WeakMap();
  * 4. argv (300) - Read argv again since any options set there should override those set in config
  *    files.
  *
- * @group Common
+ * @group None
  * @summary Contains all of TypeDoc's option declarations & values
  */
 export class Options {

package/dist/lib/utils/options/tsdoc-defaults.d.ts

@@ -3,4 +3,4 @@ export declare const blockTags: readonly ["@defaultValue", "@deprecated", "@exam
 export declare const tsdocInlineTags: readonly ["@link", "@inheritDoc", "@label"];
 export declare const inlineTags: readonly ["@link", "@inheritDoc", "@label", "@linkcode", "@linkplain", "@include", "@includeCode"];
 export declare const tsdocModifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual"];
-export declare const modifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual", "@abstract", "@class", "@enum", "@event", "@expand", "@hidden", "@hideCategories", "@hideconstructor", "@hideGroups", "@ignore", "@inline", "@interface", "@namespace", "@function", "@overload", "@private", "@protected", "@showCategories", "@showGroups", "@useDeclaredType", "@primaryExport"];
+export declare const modifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual", "@abstract", "@class", "@disableGroups", "@enum", "@event", "@expand", "@hidden", "@hideCategories", "@hideconstructor", "@hideGroups", "@ignore", "@inline", "@interface", "@namespace", "@function", "@overload", "@private", "@protected", "@showCategories", "@showGroups", "@useDeclaredType", "@primaryExport"];

package/dist/lib/utils/options/tsdoc-defaults.js

@@ -69,6 +69,7 @@ export const modifierTags = [
     ...tsdocModifierTags,
     "@abstract",
     "@class",
+    "@disableGroups",
     "@enum",
     "@event",
     "@expand",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.28.1",
+  "version": "0.28.2",
   "homepage": "https://typedoc.org",
   "type": "module",
   "exports": {
@@ -31,32 +31,32 @@
     "pnpm": ">= 10"
   },
   "dependencies": {
-    "@gerrit0/mini-shiki": "^3.2.1",
+    "@gerrit0/mini-shiki": "^3.2.2",
     "lunr": "^2.3.9",
     "markdown-it": "^14.1.0",
     "minimatch": "^9.0.5",
-    "yaml": "^2.7.0 "
+    "yaml": "^2.7.1"
   },
   "peerDependencies": {
     "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x"
   },
   "devDependencies": {
-    "@eslint/js": "^9.22.0",
+    "@eslint/js": "^9.24.0",
     "@types/lunr": "^2.3.7",
     "@types/markdown-it": "^14.1.2",
     "@types/mocha": "^10.0.10",
     "@types/node": "18",
     "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#34113409e3a171e68ce5e2b55461ef5c35591cfe",
     "c8": "^10.1.3",
-    "dprint": "^0.49.0",
-    "esbuild": "^0.25.1",
-    "eslint": "^9.22.0",
+    "dprint": "^0.49.1",
+    "esbuild": "^0.25.2",
+    "eslint": "^9.24.0",
     "mocha": "^11.1.0",
-    "puppeteer": "^24.4.0",
+    "puppeteer": "^24.6.0",
     "semver": "^7.7.1",
     "tsx": "^4.19.3",
-    "typescript": "5.8.2",
-    "typescript-eslint": "^8.26.1"
+    "typescript": "5.8.3",
+    "typescript-eslint": "^8.29.0"
   },
   "files": [
     "/bin",

package/static/style.css

@@ -1004,14 +1004,14 @@
         margin-left: -1.5rem;
     }
 
-    .tsd-page-navigation-section {
-        margin-left: 10px;
-    }
     .tsd-page-navigation-section > summary {
         padding: 0.25rem;
     }
+    .tsd-page-navigation-section > summary > svg {
+        margin-right: 0.25rem;
+    }
     .tsd-page-navigation-section > div {
-        margin-left: 20px;
+        margin-left: 30px;
     }
     .tsd-page-navigation ul {
         padding-left: 1.75rem;

package/tsdoc.json

@@ -49,6 +49,11 @@
             "syntaxKind": "block",
             "allowMultiple": true
         },
+        {
+            "tagName": "@disableGroups",
+            "syntaxKind": "modifier",
+            "allowMultiple": false
+        },
         {
             "tagName": "@category",
             "syntaxKind": "block",