typedoc 0.26.3 → 0.26.5

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;
 }
@@ -119,7 +119,7 @@ function* zip(...args) {
 }
 function filterMap(iter, fn) {
     const result = [];
-    for (const item of iter) {
+    for (const item of iter || []) {
         const newItem = fn(item);
         if (newItem !== void 0) {
             result.push(newItem);

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/minimalSourceFile.d.ts

@@ -1,7 +1,7 @@
 import type { LineAndCharacter, SourceFileLike } from "typescript";
 export declare class MinimalSourceFile implements SourceFileLike {
-    readonly text: string;
     readonly fileName: string;
+    readonly text: string;
     constructor(text: string, fileName: string);
     getLineAndCharacterOfPosition(pos: number): LineAndCharacter;
 }

package/dist/lib/utils/minimalSourceFile.js

@@ -8,8 +8,16 @@ const array_1 = require("./array");
 const lineStarts = new WeakMap();
 class MinimalSourceFile {
     constructor(text, fileName) {
-        this.text = text;
         this.fileName = fileName;
+        // This is unfortunate, but the yaml library we use relies on the source
+        // text using LF line endings https://github.com/eemeli/yaml/issues/127.
+        // If we don't do this, in a simple document which includes a single key
+        // like:
+        // ---<CR><LF>
+        // title: Windows line endings<CR><LF>
+        // ---<CR><LF>
+        // we'll end up with a parsed title of "Windows line endings\r"
+        this.text = text.replaceAll("\r\n", "\n");
         lineStarts.set(this, [0]);
     }
     getLineAndCharacterOfPosition(pos) {

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/dist/lib/validation/links.js

@@ -9,7 +9,7 @@ function getBrokenPartLinks(parts) {
         if (part.kind === "inline-tag" &&
             linkTags.includes(part.tag) &&
             !part.target) {
-            links.push(part.text);
+            links.push(part.text.trim());
         }
     }
     return links;
@@ -25,42 +25,60 @@ function getBrokenLinks(comment) {
 }
 function validateLinks(project, logger) {
     for (const id in project.reflections) {
-        const reflection = project.reflections[id];
-        if (reflection.isProject() || reflection.isDeclaration()) {
-            for (const broken of getBrokenPartLinks(reflection.readme || [])) {
-                // #2360, "@" is a future reserved character in TSDoc component paths
-                // If a link starts with it, and doesn't include a module source indicator "!"
-                // then the user probably is trying to link to a package containing "@" with an absolute link.
-                if (broken.startsWith("@") && !broken.includes("!")) {
-                    logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
-                }
-                else {
-                    logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_readme_for_1(broken, reflection.getFriendlyFullName()));
-                }
+        checkReflection(project.reflections[id], logger);
+    }
+    if (!(project.id in project.reflections)) {
+        checkReflection(project, logger);
+    }
+}
+function checkReflection(reflection, logger) {
+    if (reflection.isProject() || reflection.isDeclaration()) {
+        for (const broken of getBrokenPartLinks(reflection.readme || [])) {
+            // #2360, "@" is a future reserved character in TSDoc component paths
+            // If a link starts with it, and doesn't include a module source indicator "!"
+            // then the user probably is trying to link to a package containing "@" with an absolute link.
+            if (broken.startsWith("@") && !broken.includes("!")) {
+                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
+            }
+            else {
+                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_readme_for_1(broken, reflection.getFriendlyFullName()));
             }
         }
-        for (const broken of getBrokenLinks(reflection.comment)) {
+    }
+    if (reflection.isDocument()) {
+        for (const broken of getBrokenPartLinks(reflection.content)) {
             // #2360, "@" is a future reserved character in TSDoc component paths
             // If a link starts with it, and doesn't include a module source indicator "!"
             // then the user probably is trying to link to a package containing "@" with an absolute link.
             if (broken.startsWith("@") && !broken.includes("!")) {
-                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
+                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_document_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
             }
             else {
-                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1(broken, reflection.getFriendlyFullName()));
+                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_document_1(broken, reflection.getFriendlyFullName()));
             }
         }
-        if (reflection.isDeclaration() &&
-            reflection.kindOf(models_1.ReflectionKind.TypeAlias) &&
-            reflection.type?.type === "union" &&
-            reflection.type.elementSummaries) {
-            for (const broken of reflection.type.elementSummaries.flatMap(getBrokenPartLinks)) {
-                if (broken.startsWith("@") && !broken.includes("!")) {
-                    logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
-                }
-                else {
-                    logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1(broken, reflection.getFriendlyFullName()));
-                }
+    }
+    for (const broken of getBrokenLinks(reflection.comment)) {
+        // #2360, "@" is a future reserved character in TSDoc component paths
+        // If a link starts with it, and doesn't include a module source indicator "!"
+        // then the user probably is trying to link to a package containing "@" with an absolute link.
+        if (broken.startsWith("@") && !broken.includes("!")) {
+            logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
+        }
+        else {
+            logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1(broken, reflection.getFriendlyFullName()));
+        }
+    }
+    if (reflection.isDeclaration() &&
+        reflection.kindOf(models_1.ReflectionKind.TypeAlias) &&
+        reflection.type?.type === "union" &&
+        reflection.type.elementSummaries) {
+        for (const broken of reflection.type.elementSummaries.flatMap(getBrokenPartLinks)) {
+            if (broken.startsWith("@") && !broken.includes("!")) {
+                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
+            }
+            else {
+                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1(broken, reflection.getFriendlyFullName()));
             }
         }
     }

package/package.json

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