typedoc 0.26.4 → 0.26.5

package/dist/index.d.ts

@@ -20,7 +20,7 @@ export * from "./lib/models";
 export { Converter, Context, type CommentParserConfig, type DeclarationReference, type SymbolReference, type ComponentPath, type Meaning, type MeaningKeyword, type ExternalResolveResult, type ExternalSymbolResolver, type ConverterEvents, } from "./lib/converter";
 export { Renderer, DefaultTheme, DefaultThemeRenderContext, Slugger, UrlMapping, Theme, PageEvent, RendererEvent, MarkdownEvent, IndexEvent, } from "./lib/output";
 export type { RenderTemplate, RendererHooks, NavigationElement, RendererEvents, PageHeading, } from "./lib/output";
-export { ArgumentsReader, Option, CommentStyle, JSX, LogLevel, Logger, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, normalizePath, } from "./lib/utils";
+export { ArgumentsReader, Option, CommentStyle, JSX, LogLevel, Logger, Options, OptionDefaults, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, EntryPointStrategy, EventHooks, MinimalSourceFile, normalizePath, } from "./lib/utils";
 export type { OptionsReader, TypeDocOptions, TypeDocOptionMap, ValidationOptions, TypeDocOptionValues, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, SortStrategy, ParameterTypeToOptionTypeMap, DocumentationEntryPoint, ManuallyValidatedOption, EnumKeys, JsDocCompatibility, } from "./lib/utils";
 export { JSONOutput, Serializer, type SerializerEvents, Deserializer, type Deserializable, type DeserializerComponent, type SerializerComponent, SerializeEvent, } from "./lib/serialization";
 export * as Internationalization from "./lib/internationalization/index";

package/dist/index.js

@@ -29,7 +29,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeScript = exports.Internationalization = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.normalizePath = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.Option = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.Slugger = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.Configuration = exports.Models = exports.resetReflectionID = exports.EventDispatcher = exports.Application = void 0;
+exports.TypeScript = exports.Internationalization = exports.SerializeEvent = exports.Deserializer = exports.Serializer = exports.JSONOutput = exports.normalizePath = exports.MinimalSourceFile = exports.EventHooks = exports.EntryPointStrategy = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.OptionDefaults = exports.Options = exports.Logger = exports.LogLevel = exports.JSX = exports.CommentStyle = exports.Option = exports.ArgumentsReader = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = exports.Theme = exports.UrlMapping = exports.Slugger = exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Renderer = exports.Context = exports.Converter = exports.Configuration = exports.Models = exports.resetReflectionID = exports.EventDispatcher = exports.Application = void 0;
 var application_1 = require("./lib/application");
 Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return application_1.Application; } });
 var events_1 = require("./lib/utils/events");
@@ -74,6 +74,7 @@ Object.defineProperty(exports, "JSX", { enumerable: true, get: function () { ret
 Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return utils_1.LogLevel; } });
 Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return utils_1.Logger; } });
 Object.defineProperty(exports, "Options", { enumerable: true, get: function () { return utils_1.Options; } });
+Object.defineProperty(exports, "OptionDefaults", { enumerable: true, get: function () { return utils_1.OptionDefaults; } });
 Object.defineProperty(exports, "PackageJsonReader", { enumerable: true, get: function () { return utils_1.PackageJsonReader; } });
 Object.defineProperty(exports, "ParameterHint", { enumerable: true, get: function () { return utils_1.ParameterHint; } });
 Object.defineProperty(exports, "ParameterType", { enumerable: true, get: function () { return utils_1.ParameterType; } });

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

@@ -308,6 +308,11 @@ function declarationToCommentNodeIgnoringParents(node) {
     // ts.SourceFile is a counterexample
     if (!node.parent)
         return node;
+    // function foo(x: number)
+    //              ^^^^^^^^^
+    if (node.kind === typescript_1.default.SyntaxKind.Parameter) {
+        return node;
+    }
     // const abc = 123
     //       ^^^
     if (node.parent.kind === typescript_1.default.SyntaxKind.VariableDeclarationList) {

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

@@ -140,8 +140,8 @@ function parseCommentString(tokens, config, file, logger, files) {
     }
     // Check for frontmatter
     let frontmatterData = {};
-    const firstBlock = content[0];
-    if (firstBlock.text.startsWith("---\n")) {
+    const firstBlock = content.at(0);
+    if (firstBlock?.text.startsWith("---\n")) {
         const end = firstBlock.text.indexOf("\n---\n");
         if (end !== -1) {
             const yamlText = firstBlock.text.slice("---\n".length, end);

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

@@ -6,6 +6,7 @@ import { ConverterComponent } from "../components";
 export declare class ImplementsPlugin extends ConverterComponent {
     private resolved;
     private postponed;
+    private revivingSerialized;
     /**
      * Create a new ImplementsPlugin instance.
      */
@@ -16,6 +17,7 @@ export declare class ImplementsPlugin extends ConverterComponent {
     private analyzeImplements;
     private analyzeInheritance;
     private onResolveEnd;
+    private onRevive;
     private resolve;
     private tryResolve;
     private doResolve;
@@ -28,4 +30,14 @@ export declare class ImplementsPlugin extends ConverterComponent {
      * during the resolve step with links which actually point to the right place.
      */
     private onDeclaration;
+    /**
+     * Responsible for copying comments from "parent" reflections defined
+     * in either a base class or implemented interface to the child class.
+     */
+    private handleInheritedComments;
+    /**
+     * Copy the comment of the source reflection to the target reflection with a JSDoc style copy
+     * function. The TSDoc copy function is in the InheritDocPlugin.
+     */
+    private copyComment;
 }

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

@@ -65,6 +65,7 @@ let ImplementsPlugin = (() => {
             super(...arguments);
             this.resolved = new WeakSet();
             this.postponed = new WeakMap();
+            this.revivingSerialized = false;
         }
         /**
          * Create a new ImplementsPlugin instance.
@@ -73,13 +74,13 @@ let ImplementsPlugin = (() => {
             this.owner.on(converter_1.Converter.EVENT_RESOLVE_END, this.onResolveEnd.bind(this));
             this.owner.on(converter_1.Converter.EVENT_CREATE_DECLARATION, this.onDeclaration.bind(this), -1000);
             this.owner.on(converter_1.Converter.EVENT_CREATE_SIGNATURE, this.onSignature.bind(this), 1000);
-            this.application.on(application_events_1.ApplicationEvents.REVIVE, this.resolve.bind(this));
+            this.application.on(application_events_1.ApplicationEvents.REVIVE, this.onRevive.bind(this));
         }
         /**
          * Mark all members of the given class to be the implementation of the matching interface member.
          */
         analyzeImplements(project, classReflection, interfaceReflection) {
-            handleInheritedComments(classReflection, interfaceReflection);
+            this.handleInheritedComments(classReflection, interfaceReflection);
             if (!interfaceReflection.children) {
                 return;
             }
@@ -110,7 +111,7 @@ let ImplementsPlugin = (() => {
                         }
                     }
                 }
-                handleInheritedComments(classMember, interfaceMember);
+                this.handleInheritedComments(classMember, interfaceMember);
             });
         }
         analyzeInheritance(project, reflection) {
@@ -121,7 +122,7 @@ let ImplementsPlugin = (() => {
                     : void 0;
             });
             for (const parent of extendedTypes) {
-                handleInheritedComments(reflection, parent.reflection);
+                this.handleInheritedComments(reflection, parent.reflection);
                 for (const parentMember of parent.reflection.children ?? []) {
                     const child = findMatchingMember(parentMember, reflection);
                     if (child) {
@@ -132,7 +133,7 @@ let ImplementsPlugin = (() => {
                             childSig[key] = types_1.ReferenceType.createResolvedReference(`${parent.name}.${parentMember.name}`, parentSig, project);
                         }
                         child[key] = types_1.ReferenceType.createResolvedReference(`${parent.name}.${parentMember.name}`, parentMember, project);
-                        handleInheritedComments(child, parentMember);
+                        this.handleInheritedComments(child, parentMember);
                     }
                 }
             }
@@ -140,6 +141,11 @@ let ImplementsPlugin = (() => {
         onResolveEnd(context) {
             this.resolve(context.project);
         }
+        onRevive(project) {
+            this.revivingSerialized = true;
+            this.resolve(project);
+            this.revivingSerialized = false;
+        }
         resolve(project) {
             for (const id in project.reflections) {
                 const refl = project.reflections[id];
@@ -262,6 +268,73 @@ let ImplementsPlugin = (() => {
                 }
             }
         }
+        /**
+         * Responsible for copying comments from "parent" reflections defined
+         * in either a base class or implemented interface to the child class.
+         */
+        handleInheritedComments(child, parent) {
+            this.copyComment(child, parent);
+            if (parent.kindOf(index_1.ReflectionKind.Property) &&
+                child.kindOf(index_1.ReflectionKind.Accessor)) {
+                if (child.getSignature) {
+                    this.copyComment(child.getSignature, parent);
+                    child.getSignature.implementationOf = child.implementationOf;
+                }
+                if (child.setSignature) {
+                    this.copyComment(child.setSignature, parent);
+                    child.setSignature.implementationOf = child.implementationOf;
+                }
+            }
+            if (parent.kindOf(index_1.ReflectionKind.Accessor) &&
+                child.kindOf(index_1.ReflectionKind.Accessor)) {
+                if (parent.getSignature && child.getSignature) {
+                    this.copyComment(child.getSignature, parent.getSignature);
+                }
+                if (parent.setSignature && child.setSignature) {
+                    this.copyComment(child.setSignature, parent.setSignature);
+                }
+            }
+            if (parent.kindOf(index_1.ReflectionKind.FunctionOrMethod) &&
+                parent.signatures &&
+                child.signatures) {
+                for (const [cs, ps] of (0, array_1.zip)(child.signatures, parent.signatures)) {
+                    this.copyComment(cs, ps);
+                }
+            }
+            else if (parent.kindOf(index_1.ReflectionKind.Property) &&
+                parent.type instanceof types_1.ReflectionType &&
+                parent.type.declaration.signatures &&
+                child.signatures) {
+                for (const [cs, ps] of (0, array_1.zip)(child.signatures, parent.type.declaration.signatures)) {
+                    this.copyComment(cs, ps);
+                }
+            }
+        }
+        /**
+         * Copy the comment of the source reflection to the target reflection with a JSDoc style copy
+         * function. The TSDoc copy function is in the InheritDocPlugin.
+         */
+        copyComment(target, source) {
+            if (!shouldCopyComment(target, source, this.revivingSerialized)) {
+                return;
+            }
+            target.comment = source.comment.clone();
+            if (target instanceof index_1.DeclarationReflection &&
+                source instanceof index_1.DeclarationReflection) {
+                for (const [tt, ts] of (0, array_1.zip)(target.typeParameters || [], source.typeParameters || [])) {
+                    this.copyComment(tt, ts);
+                }
+            }
+            if (target instanceof index_1.SignatureReflection &&
+                source instanceof index_1.SignatureReflection) {
+                for (const [tt, ts] of (0, array_1.zip)(target.typeParameters || [], source.typeParameters || [])) {
+                    this.copyComment(tt, ts);
+                }
+                for (const [pt, ps] of (0, array_1.zip)(target.parameters || [], source.parameters || [])) {
+                    this.copyComment(pt, ps);
+                }
+            }
+        }
     };
     __setFunctionName(_classThis, "ImplementsPlugin");
     (() => {
@@ -305,7 +378,9 @@ function createLink(context, reflection, clause, expr, symbol, isInherit) {
         link(sig);
     }
     // Intentionally create broken links here. These will be replaced with real links during
-    // resolution if we can do so.
+    // resolution if we can do so. We create broken links rather than real links because in the
+    // case of an inherited symbol, we'll end up referencing a single symbol ID rather than one
+    // for each class.
     function link(target) {
         if (!target)
             return;
@@ -322,79 +397,23 @@ function createLink(context, reflection, clause, expr, symbol, isInherit) {
         }
     }
 }
-/**
- * Responsible for copying comments from "parent" reflections defined
- * in either a base class or implemented interface to the child class.
- */
-function handleInheritedComments(child, parent) {
-    copyComment(child, parent);
-    if (parent.kindOf(index_1.ReflectionKind.Property) &&
-        child.kindOf(index_1.ReflectionKind.Accessor)) {
-        if (child.getSignature) {
-            copyComment(child.getSignature, parent);
-            child.getSignature.implementationOf = child.implementationOf;
-        }
-        if (child.setSignature) {
-            copyComment(child.setSignature, parent);
-            child.setSignature.implementationOf = child.implementationOf;
-        }
-    }
-    if (parent.kindOf(index_1.ReflectionKind.Accessor) &&
-        child.kindOf(index_1.ReflectionKind.Accessor)) {
-        if (parent.getSignature && child.getSignature) {
-            copyComment(child.getSignature, parent.getSignature);
-        }
-        if (parent.setSignature && child.setSignature) {
-            copyComment(child.setSignature, parent.setSignature);
-        }
-    }
-    if (parent.kindOf(index_1.ReflectionKind.FunctionOrMethod) &&
-        parent.signatures &&
-        child.signatures) {
-        for (const [cs, ps] of (0, array_1.zip)(child.signatures, parent.signatures)) {
-            copyComment(cs, ps);
-        }
-    }
-    else if (parent.kindOf(index_1.ReflectionKind.Property) &&
-        parent.type instanceof types_1.ReflectionType &&
-        parent.type.declaration.signatures &&
-        child.signatures) {
-        for (const [cs, ps] of (0, array_1.zip)(child.signatures, parent.type.declaration.signatures)) {
-            copyComment(cs, ps);
-        }
+function shouldCopyComment(target, source, revivingSerialized) {
+    if (!source.comment) {
+        return false;
     }
-}
-/**
- * Copy the comment of the source reflection to the target reflection with a JSDoc style copy
- * function. The TSDoc copy function is in the InheritDocPlugin.
- */
-function copyComment(target, source) {
     if (target.comment) {
+        // If we're reviving, then the revived project might have a better comment
+        // on source, so copy it.
+        if (revivingSerialized && source.comment.similarTo(target.comment)) {
+            return true;
+        }
         // We might still want to copy, if the child has a JSDoc style inheritDoc tag.
         const tag = target.comment.getTag("@inheritDoc");
         if (!tag || tag.name) {
-            return;
-        }
-    }
-    if (!source.comment) {
-        return;
-    }
-    target.comment = source.comment.clone();
-    if (target instanceof index_1.DeclarationReflection &&
-        source instanceof index_1.DeclarationReflection) {
-        for (const [tt, ts] of (0, array_1.zip)(target.typeParameters || [], source.typeParameters || [])) {
-            copyComment(tt, ts);
-        }
-    }
-    if (target instanceof index_1.SignatureReflection &&
-        source instanceof index_1.SignatureReflection) {
-        for (const [tt, ts] of (0, array_1.zip)(target.typeParameters || [], source.typeParameters || [])) {
-            copyComment(tt, ts);
-        }
-        for (const [pt, ps] of (0, array_1.zip)(target.parameters || [], source.parameters || [])) {
-            copyComment(pt, ps);
+            return false;
         }
     }
+    return true;
 }
 function findMatchingMember(toMatch, container) {
     return container.children?.find((child) => child.name == toMatch.name &&

package/dist/lib/models/comments/comment.d.ts

@@ -93,6 +93,12 @@ export declare class CommentTag {
      * Create a new CommentTag instance.
      */
     constructor(tag: `@${string}`, text: CommentDisplayPart[]);
+    /**
+     * Checks if this block tag is roughly equal to the other tag.
+     * This isn't exactly equal, but just "roughly equal" by the tag
+     * text.
+     */
+    similarTo(other: CommentTag): boolean;
     clone(): CommentTag;
     toObject(serializer: Serializer): JSONOutput.CommentTag;
     fromObject(de: Deserializer, obj: JSONOutput.CommentTag): void;
@@ -191,6 +197,12 @@ export declare class Comment {
      * Creates a new Comment instance.
      */
     constructor(summary?: CommentDisplayPart[], blockTags?: CommentTag[], modifierTags?: Set<`@${string}`>);
+    /**
+     * Checks if this comment is roughly equal to the other comment.
+     * This isn't exactly equal, but just "roughly equal" by the comment
+     * text.
+     */
+    similarTo(other: Comment): boolean;
     /**
      * Create a deep clone of this comment.
      */

package/dist/lib/models/comments/comment.js

@@ -58,6 +58,17 @@ class CommentTag {
         this.tag = tag;
         this.content = text;
     }
+    /**
+     * Checks if this block tag is roughly equal to the other tag.
+     * This isn't exactly equal, but just "roughly equal" by the tag
+     * text.
+     */
+    similarTo(other) {
+        return (this.tag === other.tag &&
+            this.name === other.tag &&
+            Comment.combineDisplayParts(this.content) ===
+                Comment.combineDisplayParts(other.content));
+    }
     clone() {
         const tag = new CommentTag(this.tag, Comment.cloneDisplayParts(this.content));
         if (this.name) {
@@ -317,6 +328,28 @@ let Comment = (() => {
                 this.modifierTags = modifierTags;
                 extractLabelTag(this);
             }
+            /**
+             * Checks if this comment is roughly equal to the other comment.
+             * This isn't exactly equal, but just "roughly equal" by the comment
+             * text.
+             */
+            similarTo(other) {
+                if (_a.combineDisplayParts(this.summary) !==
+                    _a.combineDisplayParts(other.summary)) {
+                    return false;
+                }
+                // Ignore modifier tags, as they could cause false negatives
+                // if a cascaded modifier tag is present in one comment but not the other.
+                if (this.blockTags.length !== other.blockTags.length) {
+                    return false;
+                }
+                for (let i = 0; i < this.blockTags.length; ++i) {
+                    if (!this.blockTags[i].similarTo(other.blockTags[i])) {
+                        return false;
+                    }
+                }
+                return true;
+            }
             /**
              * Create a deep clone of this comment.
              */

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

@@ -1,7 +1,7 @@
 export declare const emptyArray: readonly [];
 /**
  * Inserts an item into an array sorted by priority. If two items have the same priority,
- * the item will be inserted later will be placed earlier in the array.
+ * the item will be inserted later will be placed later in the array.
  * @param arr modified by inserting item.
  * @param item
  */

package/dist/lib/utils/array.js

@@ -15,12 +15,12 @@ exports.filter = filter;
 exports.emptyArray = [];
 /**
  * Inserts an item into an array sorted by priority. If two items have the same priority,
- * the item will be inserted later will be placed earlier in the array.
+ * the item will be inserted later will be placed later in the array.
  * @param arr modified by inserting item.
  * @param item
  */
 function insertPrioritySorted(arr, item) {
-    const index = binaryFindPartition(arr, (v) => v.priority <= item.priority);
+    const index = binaryFindPartition(arr, (v) => v.priority < item.priority);
     arr.splice(index === -1 ? arr.length : index, 0, item);
     return arr;
 }

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

@@ -8,7 +8,7 @@ export type { IfInternal, NeverIfInternal, Chars } from "./general";
 export { assertNever } from "./general";
 export { ConsoleLogger, Logger, LogLevel } from "./loggers";
 export { DefaultMap } from "./map";
-export { ArgumentsReader, Option, CommentStyle, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, } from "./options";
+export { ArgumentsReader, Option, CommentStyle, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, OptionDefaults, } from "./options";
 export type { ArrayDeclarationOption, BooleanDeclarationOption, DeclarationOption, DeclarationOptionBase, DeclarationOptionToOptionType, KeyToDeclaration, MapDeclarationOption, MixedDeclarationOption, NumberDeclarationOption, FlagsDeclarationOption, ObjectDeclarationOption, OptionsReader, StringDeclarationOption, TypeDocOptionMap, TypeDocOptions, ValidationOptions, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, JsDocCompatibility, } from "./options";
 export { loadPlugins } from "./plugins";
 export { getSortFunction } from "./sort";

package/dist/lib/utils/index.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MinimalSourceFile = exports.Validation = exports.renderElement = exports.Raw = exports.Fragment = exports.JSX = exports.EventHooks = exports.getSortFunction = exports.loadPlugins = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.CommentStyle = exports.Option = exports.ArgumentsReader = exports.DefaultMap = exports.LogLevel = exports.Logger = exports.ConsoleLogger = exports.assertNever = exports.normalizePath = exports.discoverPackageJson = exports.discoverInParentDir = exports.writeFileSync = exports.writeFile = exports.readFile = exports.getCommonDirectory = exports.copySync = exports.copy = exports.isFile = exports.EventDispatcher = exports.Component = exports.ChildableComponent = exports.AbstractComponent = exports.unique = exports.removeIfPresent = exports.removeIf = exports.partition = exports.insertPrioritySorted = exports.filterMap = void 0;
+exports.MinimalSourceFile = exports.Validation = exports.renderElement = exports.Raw = exports.Fragment = exports.JSX = exports.EventHooks = exports.getSortFunction = exports.loadPlugins = exports.OptionDefaults = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.CommentStyle = exports.Option = exports.ArgumentsReader = exports.DefaultMap = exports.LogLevel = exports.Logger = exports.ConsoleLogger = exports.assertNever = exports.normalizePath = exports.discoverPackageJson = exports.discoverInParentDir = exports.writeFileSync = exports.writeFile = exports.readFile = exports.getCommonDirectory = exports.copySync = exports.copy = exports.isFile = exports.EventDispatcher = exports.Component = exports.ChildableComponent = exports.AbstractComponent = exports.unique = exports.removeIfPresent = exports.removeIf = exports.partition = exports.insertPrioritySorted = exports.filterMap = void 0;
 var array_1 = require("./array");
 Object.defineProperty(exports, "filterMap", { enumerable: true, get: function () { return array_1.filterMap; } });
 Object.defineProperty(exports, "insertPrioritySorted", { enumerable: true, get: function () { return array_1.insertPrioritySorted; } });
@@ -71,6 +71,7 @@ Object.defineProperty(exports, "ParameterHint", { enumerable: true, get: functio
 Object.defineProperty(exports, "ParameterType", { enumerable: true, get: function () { return options_1.ParameterType; } });
 Object.defineProperty(exports, "TSConfigReader", { enumerable: true, get: function () { return options_1.TSConfigReader; } });
 Object.defineProperty(exports, "TypeDocReader", { enumerable: true, get: function () { return options_1.TypeDocReader; } });
+Object.defineProperty(exports, "OptionDefaults", { enumerable: true, get: function () { return options_1.OptionDefaults; } });
 var plugins_1 = require("./plugins");
 Object.defineProperty(exports, "loadPlugins", { enumerable: true, get: function () { return plugins_1.loadPlugins; } });
 var sort_1 = require("./sort");

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

@@ -0,0 +1,23 @@
+import type { BundledLanguage } from "shiki" with { "resolution-mode": "import" };
+import type { EnumKeys } from "../enum";
+import type { ReflectionKind } from "../../models/index";
+/**
+ * Default values for TypeDoc options. This object should not be modified.
+ *
+ * @privateRemarks
+ * These are declared here, rather than within the option declaration, so that
+ * they can be exposed as a part of the public API. The unfortunate type declaration
+ * is to control the type which appears in the generated documentation.
+ */
+export declare const OptionDefaults: {
+    excludeNotDocumentedKinds: readonly EnumKeys<typeof ReflectionKind>[];
+    excludeTags: readonly `@${string}`[];
+    blockTags: readonly `@${string}`[];
+    inlineTags: readonly `@${string}`[];
+    modifierTags: readonly `@${string}`[];
+    cascadedModifierTags: readonly `@${string}`[];
+    highlightLanguages: readonly BundledLanguage[];
+    sort: readonly string[];
+    kindSortOrder: readonly EnumKeys<typeof ReflectionKind>[];
+    requiredToBeDocumented: readonly EnumKeys<typeof ReflectionKind>[];
+};

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

@@ -0,0 +1,120 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionDefaults = void 0;
+const TagDefaults = __importStar(require("./tsdoc-defaults"));
+/**
+ * Default values for TypeDoc options. This object should not be modified.
+ *
+ * @privateRemarks
+ * These are declared here, rather than within the option declaration, so that
+ * they can be exposed as a part of the public API. The unfortunate type declaration
+ * is to control the type which appears in the generated documentation.
+ */
+exports.OptionDefaults = {
+    excludeNotDocumentedKinds: [
+        "Module",
+        "Namespace",
+        "Enum",
+        // Not including enum member here by default
+        "Variable",
+        "Function",
+        "Class",
+        "Interface",
+        "Constructor",
+        "Property",
+        "Method",
+        "CallSignature",
+        "IndexSignature",
+        "ConstructorSignature",
+        "Accessor",
+        "GetSignature",
+        "SetSignature",
+        "TypeAlias",
+        "Reference",
+    ],
+    excludeTags: [
+        "@override",
+        "@virtual",
+        "@privateRemarks",
+        "@satisfies",
+        "@overload",
+    ],
+    blockTags: TagDefaults.blockTags,
+    inlineTags: TagDefaults.inlineTags,
+    modifierTags: TagDefaults.modifierTags,
+    cascadedModifierTags: ["@alpha", "@beta", "@experimental"],
+    highlightLanguages: [
+        "bash",
+        "console",
+        "css",
+        "html",
+        "javascript",
+        "json",
+        "jsonc",
+        "json5",
+        "tsx",
+        "typescript",
+    ],
+    sort: ["kind", "instance-first", "alphabetical"],
+    kindSortOrder: [
+        "Document",
+        "Reference",
+        "Project",
+        "Module",
+        "Namespace",
+        "Enum",
+        "EnumMember",
+        "Class",
+        "Interface",
+        "TypeAlias",
+        "Constructor",
+        "Property",
+        "Variable",
+        "Function",
+        "Accessor",
+        "Method",
+        "Parameter",
+        "TypeParameter",
+        "TypeLiteral",
+        "CallSignature",
+        "ConstructorSignature",
+        "IndexSignature",
+        "GetSignature",
+        "SetSignature",
+    ],
+    requiredToBeDocumented: [
+        "Enum",
+        "EnumMember",
+        "Variable",
+        "Function",
+        "Class",
+        "Interface",
+        "Property",
+        "Method",
+        "Accessor",
+        "TypeAlias",
+    ],
+};

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

@@ -3,3 +3,4 @@ export type { OptionsReader } from "./options";
 export { ArgumentsReader, PackageJsonReader, TypeDocReader, TSConfigReader, } from "./readers";
 export { CommentStyle, EmitStrategy, ParameterType, ParameterHint, } from "./declaration";
 export type { TypeDocOptions, TypeDocOptionMap, ValidationOptions, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, JsDocCompatibility, } from "./declaration";
+export { OptionDefaults } from "./defaults";

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ParameterHint = exports.ParameterType = exports.EmitStrategy = exports.CommentStyle = exports.TSConfigReader = exports.TypeDocReader = exports.PackageJsonReader = exports.ArgumentsReader = exports.Option = exports.Options = void 0;
+exports.OptionDefaults = exports.ParameterHint = exports.ParameterType = exports.EmitStrategy = exports.CommentStyle = exports.TSConfigReader = exports.TypeDocReader = exports.PackageJsonReader = exports.ArgumentsReader = exports.Option = exports.Options = void 0;
 var options_1 = require("./options");
 Object.defineProperty(exports, "Options", { enumerable: true, get: function () { return options_1.Options; } });
 Object.defineProperty(exports, "Option", { enumerable: true, get: function () { return options_1.Option; } });
@@ -14,3 +14,5 @@ Object.defineProperty(exports, "CommentStyle", { enumerable: true, get: function
 Object.defineProperty(exports, "EmitStrategy", { enumerable: true, get: function () { return declaration_1.EmitStrategy; } });
 Object.defineProperty(exports, "ParameterType", { enumerable: true, get: function () { return declaration_1.ParameterType; } });
 Object.defineProperty(exports, "ParameterHint", { enumerable: true, get: function () { return declaration_1.ParameterHint; } });
+var defaults_1 = require("./defaults");
+Object.defineProperty(exports, "OptionDefaults", { enumerable: true, get: function () { return defaults_1.OptionDefaults; } });

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

@@ -30,10 +30,10 @@ const sort_1 = require("../../sort");
 const entry_point_1 = require("../../entry-point");
 const kind_1 = require("../../../models/reflections/kind");
 const Validation = __importStar(require("../../validation"));
-const tsdoc_defaults_1 = require("../tsdoc-defaults");
 const enum_1 = require("../../enum");
 const highlighter_1 = require("../../highlighter");
 const set_1 = require("../../set");
+const defaults_1 = require("../defaults");
 // For convenience, added in the same order as they are documented on the website.
 function addTypeDocOptions(options) {
     ///////////////////////////
@@ -172,27 +172,7 @@ function addTypeDocOptions(options) {
                 throw new Error(i18n.exclude_not_documented_specified_0_valid_values_are_1(Array.from(invalid).join(", "), Array.from(valid).join(", ")));
             }
         },
-        defaultValue: [
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Module],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Namespace],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Enum],
-            // Not including enum member here by default
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Variable],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Function],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Class],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Interface],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Constructor],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Property],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Method],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.CallSignature],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.IndexSignature],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.ConstructorSignature],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Accessor],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.GetSignature],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.SetSignature],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.TypeAlias],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Reference],
-        ],
+        defaultValue: defaults_1.OptionDefaults.excludeNotDocumentedKinds,
     });
     options.addDeclaration({
         name: "excludeInternal",
@@ -305,18 +285,7 @@ function addTypeDocOptions(options) {
         name: "highlightLanguages",
         help: (i18n) => i18n.help_highlightLanguages(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: [
-            "bash",
-            "console",
-            "css",
-            "html",
-            "javascript",
-            "json",
-            "jsonc",
-            "json5",
-            "tsx",
-            "typescript",
-        ],
+        defaultValue: defaults_1.OptionDefaults.highlightLanguages,
         validate(value, i18n) {
             const invalid = (0, set_1.setDifference)(value, (0, highlighter_1.getSupportedLanguagesWithoutAliases)());
             if (invalid.size) {
@@ -403,13 +372,7 @@ function addTypeDocOptions(options) {
         name: "excludeTags",
         help: (i18n) => i18n.help_excludeTags(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: [
-            "@override",
-            "@virtual",
-            "@privateRemarks",
-            "@satisfies",
-            "@overload",
-        ],
+        defaultValue: defaults_1.OptionDefaults.excludeTags,
         validate(value, i18n) {
             if (!Validation.validate([Array, Validation.isTagString], value)) {
                 throw new Error(i18n.option_0_values_must_be_array_of_tags("excludeTags"));
@@ -638,7 +601,7 @@ function addTypeDocOptions(options) {
         name: "blockTags",
         help: (i18n) => i18n.help_blockTags(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: tsdoc_defaults_1.blockTags,
+        defaultValue: defaults_1.OptionDefaults.blockTags,
         validate(value, i18n) {
             if (!Validation.validate([Array, Validation.isTagString], value)) {
                 throw new Error(i18n.option_0_values_must_be_array_of_tags("blockTags"));
@@ -649,7 +612,7 @@ function addTypeDocOptions(options) {
         name: "inlineTags",
         help: (i18n) => i18n.help_inlineTags(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: tsdoc_defaults_1.inlineTags,
+        defaultValue: defaults_1.OptionDefaults.inlineTags,
         validate(value, i18n) {
             if (!Validation.validate([Array, Validation.isTagString], value)) {
                 throw new Error(i18n.option_0_values_must_be_array_of_tags("inlineTags"));
@@ -660,7 +623,7 @@ function addTypeDocOptions(options) {
         name: "modifierTags",
         help: (i18n) => i18n.help_modifierTags(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: tsdoc_defaults_1.modifierTags,
+        defaultValue: defaults_1.OptionDefaults.modifierTags,
         validate(value, i18n) {
             if (!Validation.validate([Array, Validation.isTagString], value)) {
                 throw new Error(i18n.option_0_values_must_be_array_of_tags("modifierTags"));
@@ -671,7 +634,7 @@ function addTypeDocOptions(options) {
         name: "cascadedModifierTags",
         help: (i18n) => i18n.help_modifierTags(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: ["@alpha", "@beta", "@experimental"],
+        defaultValue: defaults_1.OptionDefaults.cascadedModifierTags,
         validate(value, i18n) {
             if (!Validation.validate([Array, Validation.isTagString], value)) {
                 throw new Error(i18n.option_0_values_must_be_array_of_tags("cascadedModifierTags"));
@@ -707,7 +670,7 @@ function addTypeDocOptions(options) {
         name: "sort",
         help: (i18n) => i18n.help_sort(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: ["kind", "instance-first", "alphabetical"],
+        defaultValue: defaults_1.OptionDefaults.sort,
         validate(value, i18n) {
             const invalid = new Set(value);
             for (const v of sort_1.SORT_STRATEGIES) {
@@ -730,13 +693,9 @@ function addTypeDocOptions(options) {
         type: declaration_1.ParameterType.Array,
         defaultValue: [],
         validate(value, i18n) {
-            const invalid = new Set(value);
-            const valid = (0, enum_1.getEnumKeys)(kind_1.ReflectionKind);
-            for (const v of valid) {
-                invalid.delete(v);
-            }
+            const invalid = (0, set_1.setDifference)(value, (0, enum_1.getEnumKeys)(kind_1.ReflectionKind));
             if (invalid.size !== 0) {
-                throw new Error(i18n.option_0_specified_1_but_only_2_is_valid(`kindSortOrder`, Array.from(invalid).join(", "), valid.join(", ")));
+                throw new Error(i18n.option_0_specified_1_but_only_2_is_valid(`kindSortOrder`, Array.from(invalid).join(", "), (0, enum_1.getEnumKeys)(kind_1.ReflectionKind).join(", ")));
             }
         },
     });
@@ -814,18 +773,7 @@ function addTypeDocOptions(options) {
                 }
             }
         },
-        defaultValue: [
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Enum],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.EnumMember],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Variable],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Function],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Class],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Interface],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Property],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Method],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Accessor],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.TypeAlias],
-        ],
+        defaultValue: defaults_1.OptionDefaults.requiredToBeDocumented,
     });
     options.addDeclaration({
         name: "validation",

package/dist/lib/utils/sort.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SORT_STRATEGIES = void 0;
 exports.getSortFunction = getSortFunction;
 const kind_1 = require("../models/reflections/kind");
+const defaults_1 = require("./options/defaults");
 exports.SORT_STRATEGIES = [
     "source-order",
     "alphabetical",
@@ -23,32 +24,6 @@ exports.SORT_STRATEGIES = [
     "documents-first",
     "documents-last",
 ];
-const defaultKindSortOrder = [
-    kind_1.ReflectionKind.Document,
-    kind_1.ReflectionKind.Reference,
-    kind_1.ReflectionKind.Project,
-    kind_1.ReflectionKind.Module,
-    kind_1.ReflectionKind.Namespace,
-    kind_1.ReflectionKind.Enum,
-    kind_1.ReflectionKind.EnumMember,
-    kind_1.ReflectionKind.Class,
-    kind_1.ReflectionKind.Interface,
-    kind_1.ReflectionKind.TypeAlias,
-    kind_1.ReflectionKind.Constructor,
-    kind_1.ReflectionKind.Property,
-    kind_1.ReflectionKind.Variable,
-    kind_1.ReflectionKind.Function,
-    kind_1.ReflectionKind.Accessor,
-    kind_1.ReflectionKind.Method,
-    kind_1.ReflectionKind.Parameter,
-    kind_1.ReflectionKind.TypeParameter,
-    kind_1.ReflectionKind.TypeLiteral,
-    kind_1.ReflectionKind.CallSignature,
-    kind_1.ReflectionKind.ConstructorSignature,
-    kind_1.ReflectionKind.IndexSignature,
-    kind_1.ReflectionKind.GetSignature,
-    kind_1.ReflectionKind.SetSignature,
-];
 // Return true if a < b
 const sorts = {
     "source-order"(a, b) {
@@ -152,9 +127,9 @@ function getSortFunction(opts) {
     const kindSortOrder = opts
         .getValue("kindSortOrder")
         .map((k) => kind_1.ReflectionKind[k]);
-    for (const kind of defaultKindSortOrder) {
-        if (!kindSortOrder.includes(kind)) {
-            kindSortOrder.push(kind);
+    for (const kind of defaults_1.OptionDefaults.kindSortOrder) {
+        if (!kindSortOrder.includes(kind_1.ReflectionKind[kind])) {
+            kindSortOrder.push(kind_1.ReflectionKind[kind]);
         }
     }
     const strategies = opts.getValue("sort");

package/dist/lib/validation/documentation.js

@@ -71,7 +71,11 @@ function validateDocumentation(project, logger, requiredToBeDocumented) {
             }
         }
         const symbolId = project.getSymbolIdFromReflection(ref);
-        if (!ref.hasComment() && symbolId) {
+        // #2644, signatures may be documented by their parent reflection.
+        const hasComment = ref.hasComment() ||
+            (ref.kindOf(models_1.ReflectionKind.SomeSignature) &&
+                ref.parent?.hasComment());
+        if (!hasComment && symbolId) {
             if (symbolId.fileName.includes("node_modules")) {
                 continue;
             }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.26.4",
+  "version": "0.26.5",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",