typedoc 0.26.0-beta.0 → 0.26.0-beta.1

package/dist/lib/application.js

@@ -488,7 +488,16 @@ let Application = (() => {
             // Generate a json file for each package
             for (const dir of packageDirs) {
                 this.logger.verbose(`Reading project at ${(0, paths_1.nicePath)(dir)}`);
-                const opts = origOptions.copyForPackage(dir);
+                let opts;
+                try {
+                    opts = origOptions.copyForPackage(dir);
+                }
+                catch (error) {
+                    (0, assert_1.ok)(error instanceof Error);
+                    this.logger.error(error.message);
+                    this.logger.info(this.i18n.previous_error_occurred_when_reading_options_for_0((0, paths_1.nicePath)(dir)));
+                    continue;
+                }
                 await opts.read(this.logger, dir);
                 // Invalid links should only be reported after everything has been merged.
                 opts.setValue("validation", { invalidLink: false });

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

@@ -226,6 +226,9 @@ const aliasedTags = new Map([["@return", "@returns"]]);
 function blockTag(comment, lexer, config, i18n, warning) {
     const blockTag = lexer.take();
     (0, assert_1.ok)(blockTag.kind === lexer_1.TokenSyntaxKind.Tag, "blockTag called not at the start of a block tag."); // blockContent is broken if this fails.
+    if (!config.blockTags.has(blockTag.text)) {
+        warning(i18n.unknown_block_tag_0(blockTag.text), blockTag);
+    }
     const tagName = aliasedTags.get(blockTag.text) || blockTag.text;
     let content;
     if (tagName === "@example") {

package/dist/lib/converter/context.js

@@ -142,6 +142,9 @@ class Context {
     }
     finalizeDeclarationReflection(reflection) {
         this.converter.trigger(converter_events_1.ConverterEvents.CREATE_DECLARATION, this, reflection);
+        if (reflection.kindOf(index_1.ReflectionKind.MayContainDocuments)) {
+            this.converter.processDocumentTags(reflection, reflection);
+        }
     }
     addChild(reflection) {
         if (this.scope instanceof index_1.ContainerReflection) {

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

@@ -1,6 +1,6 @@
 import ts from "typescript";
 import type { Application } from "../application";
-import { Comment, type CommentDisplayPart, ProjectReflection, type Reflection, type ReflectionSymbolId, type SomeType } from "../models/index";
+import { Comment, type CommentDisplayPart, type ContainerReflection, ProjectReflection, type Reflection, type ReflectionSymbolId, type SomeType } from "../models/index";
 import { Context } from "./context";
 import { ConverterComponent } from "./components";
 import { ChildableComponent } from "../utils/component";
@@ -143,7 +143,6 @@ export declare class Converter extends ChildableComponent<Application, Converter
      * reference passed will have the `moduleSource` set and the `symbolReference` will navigate via `.`)
      * and user defined \{\@link\} tags which cannot be resolved. If the link being resolved is inferred
      * from a type, then no `part` will be passed to the resolver function.
-     * @since 0.22.14
      */
     addUnknownSymbolResolver(resolver: ExternalSymbolResolver): void;
     /** @internal */
@@ -176,5 +175,6 @@ export declare class Converter extends ChildableComponent<Application, Converter
     private isExcluded;
     /** @internal */
     isExternal(symbol: ts.Symbol): boolean;
+    processDocumentTags(reflection: Reflection, parent: ContainerReflection): void;
     private _buildCommentParserConfig;
 }

package/dist/lib/converter/converter.js

@@ -67,6 +67,7 @@ const enum_1 = require("../utils/enum");
 const parser_1 = require("./comments/parser");
 const rawLexer_1 = require("./comments/rawLexer");
 const linkResolver_1 = require("./comments/linkResolver");
+const path_1 = require("path");
 /**
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
  */
@@ -257,7 +258,6 @@ let Converter = (() => {
          * reference passed will have the `moduleSource` set and the `symbolReference` will navigate via `.`)
          * and user defined \{\@link\} tags which cannot be resolved. If the link being resolved is inferred
          * from a type, then no `part` will be passed to the resolver function.
-         * @since 0.22.14
          */
         addUnknownSymbolResolver(resolver) {
             this._externalSymbolResolvers.push(resolver);
@@ -291,9 +291,16 @@ let Converter = (() => {
                     context: undefined,
                 };
             });
+            let createModuleReflections = entries.length > 1;
+            if (!createModuleReflections) {
+                const opts = this.application.options;
+                createModuleReflections = opts.isSet("alwaysCreateEntryPointModule")
+                    ? opts.getValue("alwaysCreateEntryPointModule")
+                    : !!context.scope.documents;
+            }
             entries.forEach((e) => {
                 context.setActiveProgram(e.entryPoint.program);
-                e.context = this.convertExports(context, e.entryPoint, entries.length === 1);
+                e.context = this.convertExports(context, e.entryPoint, createModuleReflections);
             });
             for (const { entryPoint, context } of entries) {
                 // active program is already set on context
@@ -304,18 +311,19 @@ let Converter = (() => {
             }
             context.setActiveProgram(undefined);
         }
-        convertExports(context, entryPoint, singleEntryPoint) {
+        convertExports(context, entryPoint, createModuleReflections) {
             const node = entryPoint.sourceFile;
             const entryName = entryPoint.displayName;
             const symbol = getSymbolForModuleLike(context, node);
             let moduleContext;
-            if (singleEntryPoint) {
+            if (createModuleReflections === false) {
                 // Special case for when we're giving a single entry point, we don't need to
                 // create modules for each entry. Register the project as this module.
                 context.project.registerReflection(context.project, symbol);
                 context.project.comment = symbol
                     ? context.getComment(symbol, context.project.kind)
                     : context.getFileComment(node);
+                this.processDocumentTags(context.project, context.project);
                 context.trigger(Converter.EVENT_CREATE_DECLARATION, context.project);
                 moduleContext = context;
             }
@@ -381,6 +389,30 @@ let Converter = (() => {
             const cache = this.externalPatternCache;
             return (symbol.getDeclarations() ?? []).some((node) => (0, paths_1.matchesAny)(cache, node.getSourceFile().fileName));
         }
+        processDocumentTags(reflection, parent) {
+            let relativeTo = reflection.comment?.sourcePath;
+            if (relativeTo) {
+                relativeTo = (0, path_1.dirname)(relativeTo);
+                const tags = reflection.comment?.getTags("@document") || [];
+                reflection.comment?.removeTags("@document");
+                for (const tag of tags) {
+                    const path = index_1.Comment.combineDisplayParts(tag.content);
+                    let file;
+                    try {
+                        const resolved = (0, path_1.resolve)(relativeTo, path);
+                        file = new utils_1.MinimalSourceFile((0, utils_1.readFile)(resolved), resolved);
+                    }
+                    catch {
+                        this.application.logger.warn(this.application.logger.i18n.failed_to_read_0_when_processing_document_tag_in_1((0, paths_1.nicePath)(path), (0, paths_1.nicePath)(reflection.comment.sourcePath)));
+                        continue;
+                    }
+                    const { content, frontmatter } = this.parseRawComment(file);
+                    const docRefl = new index_1.DocumentReflection((0, path_1.basename)(file.fileName).replace(/\.[^.]+$/, ""), parent, content, frontmatter);
+                    parent.addChild(docRefl);
+                    parent.project.registerReflection(docRefl);
+                }
+            }
+        }
         _buildCommentParserConfig() {
             this._config = {
                 blockTags: new Set(this.application.options.getValue("blockTags")),
@@ -388,6 +420,9 @@ let Converter = (() => {
                 modifierTags: new Set(this.application.options.getValue("modifierTags")),
                 jsDocCompatibility: this.application.options.getValue("jsDocCompatibility"),
             };
+            // Can't be included in options because the TSDoc parser blows up if we do.
+            // TypeDoc supports it as one, so it should always be included here.
+            this._config.blockTags.add("@inheritDoc");
             return this._config;
         }
     };

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

@@ -31,9 +31,6 @@ function createSignature(context, kind, signature, symbol, declaration) {
     if (symbol && declaration) {
         context.project.registerSymbolId(sigRef, new ReflectionSymbolId_1.ReflectionSymbolId(symbol, declaration));
     }
-    // If we are creating signatures for a variable or property and it has a comment associated with it
-    // then we should prefer that comment over any comment on the signature. The comment plugin
-    // will copy the comment down if this signature doesn't have one, so don't set one.
     let parentReflection = context.scope;
     if (parentReflection.kindOf(models_1.ReflectionKind.TypeLiteral) &&
         parentReflection.parent instanceof models_1.DeclarationReflection) {
@@ -43,6 +40,9 @@ function createSignature(context, kind, signature, symbol, declaration) {
         const sigComment = context.getSignatureComment(declaration);
         if (parentReflection.comment?.discoveryId !== sigComment?.discoveryId) {
             sigRef.comment = sigComment;
+            if (parentReflection.kindOf(models_1.ReflectionKind.MayContainDocuments)) {
+                context.converter.processDocumentTags(sigRef, parentReflection);
+            }
         }
     }
     sigRef.typeParameters = convertTypeParameters(sigRefCtx, sigRef, signature.typeParameters);

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

@@ -168,10 +168,10 @@ let CategoryPlugin = (() => {
             });
         }
         lumpCategorize(obj) {
-            if (!obj.children || obj.children.length === 0 || obj.categories) {
+            if (!obj.childrenIncludingDocuments || obj.categories) {
                 return;
             }
-            obj.categories = this.getReflectionCategories(obj, obj.children);
+            obj.categories = this.getReflectionCategories(obj, obj.childrenIncludingDocuments);
             if (obj.categories && obj.categories.length > 1) {
                 obj.categories.sort(CategoryPlugin.sortCatCallback);
             }

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

@@ -57,6 +57,7 @@ import { ConverterComponent } from "../components";
  */
 export declare class CommentPlugin extends ConverterComponent {
     accessor excludeTags: `@${string}`[];
+    accessor cascadedModifierTags: `@${string}`[];
     accessor excludeInternal: boolean;
     accessor excludePrivate: boolean;
     accessor excludeProtected: boolean;
@@ -114,6 +115,7 @@ export declare class CommentPlugin extends ConverterComponent {
     private onResolve;
     private moveSignatureParamComments;
     private removeExcludedTags;
+    private cascadeModifiers;
     /**
      * Determines whether or not a reflection has been hidden
      *

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

@@ -55,6 +55,7 @@ const converter_1 = require("../converter");
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
 const CategoryPlugin_1 = require("./CategoryPlugin");
+const set_1 = require("../../utils/set");
 /**
  * These tags are not useful to display in the generated documentation.
  * They should be ignored when parsing comments. Any relevant type information
@@ -76,6 +77,17 @@ const NEVER_RENDERED = [
     "@type",
     "@typedef",
 ];
+// We might make this user configurable at some point, but for now,
+// this set is configured here.
+const MUTUALLY_EXCLUSIVE_MODIFIERS = [
+    new Set([
+        "@alpha",
+        "@beta",
+        "@experimental",
+        "@internal",
+        "@public",
+    ]),
+];
 /**
  * Handles most behavior triggered by comments. `@group` and `@category` are handled by their respective plugins, but everything else is here.
  *
@@ -133,7 +145,7 @@ const NEVER_RENDERED = [
  *
  */
 let CommentPlugin = (() => {
-    var _CommentPlugin_excludeTags_accessor_storage, _CommentPlugin_excludeInternal_accessor_storage, _CommentPlugin_excludePrivate_accessor_storage, _CommentPlugin_excludeProtected_accessor_storage, _CommentPlugin_excludeNotDocumented_accessor_storage, _CommentPlugin_excludeCategories_accessor_storage, _CommentPlugin_defaultCategory_accessor_storage;
+    var _CommentPlugin_excludeTags_accessor_storage, _CommentPlugin_cascadedModifierTags_accessor_storage, _CommentPlugin_excludeInternal_accessor_storage, _CommentPlugin_excludePrivate_accessor_storage, _CommentPlugin_excludeProtected_accessor_storage, _CommentPlugin_excludeNotDocumented_accessor_storage, _CommentPlugin_excludeCategories_accessor_storage, _CommentPlugin_defaultCategory_accessor_storage;
     let _classDecorators = [(0, components_1.Component)({ name: "comment" })];
     let _classDescriptor;
     let _classExtraInitializers = [];
@@ -142,6 +154,9 @@ let CommentPlugin = (() => {
     let _excludeTags_decorators;
     let _excludeTags_initializers = [];
     let _excludeTags_extraInitializers = [];
+    let _cascadedModifierTags_decorators;
+    let _cascadedModifierTags_initializers = [];
+    let _cascadedModifierTags_extraInitializers = [];
     let _excludeInternal_decorators;
     let _excludeInternal_initializers = [];
     let _excludeInternal_extraInitializers = [];
@@ -164,7 +179,8 @@ let CommentPlugin = (() => {
         constructor() {
             super(...arguments);
             _CommentPlugin_excludeTags_accessor_storage.set(this, __runInitializers(this, _excludeTags_initializers, void 0));
-            _CommentPlugin_excludeInternal_accessor_storage.set(this, (__runInitializers(this, _excludeTags_extraInitializers), __runInitializers(this, _excludeInternal_initializers, void 0)));
+            _CommentPlugin_cascadedModifierTags_accessor_storage.set(this, (__runInitializers(this, _excludeTags_extraInitializers), __runInitializers(this, _cascadedModifierTags_initializers, void 0)));
+            _CommentPlugin_excludeInternal_accessor_storage.set(this, (__runInitializers(this, _cascadedModifierTags_extraInitializers), __runInitializers(this, _excludeInternal_initializers, void 0)));
             _CommentPlugin_excludePrivate_accessor_storage.set(this, (__runInitializers(this, _excludeInternal_extraInitializers), __runInitializers(this, _excludePrivate_initializers, void 0)));
             _CommentPlugin_excludeProtected_accessor_storage.set(this, (__runInitializers(this, _excludePrivate_extraInitializers), __runInitializers(this, _excludeProtected_initializers, void 0)));
             _CommentPlugin_excludeNotDocumented_accessor_storage.set(this, (__runInitializers(this, _excludeProtected_extraInitializers), __runInitializers(this, _excludeNotDocumented_initializers, void 0)));
@@ -174,6 +190,8 @@ let CommentPlugin = (() => {
         }
         get excludeTags() { return __classPrivateFieldGet(this, _CommentPlugin_excludeTags_accessor_storage, "f"); }
         set excludeTags(value) { __classPrivateFieldSet(this, _CommentPlugin_excludeTags_accessor_storage, value, "f"); }
+        get cascadedModifierTags() { return __classPrivateFieldGet(this, _CommentPlugin_cascadedModifierTags_accessor_storage, "f"); }
+        set cascadedModifierTags(value) { __classPrivateFieldSet(this, _CommentPlugin_cascadedModifierTags_accessor_storage, value, "f"); }
         get excludeInternal() { return __classPrivateFieldGet(this, _CommentPlugin_excludeInternal_accessor_storage, "f"); }
         set excludeInternal(value) { __classPrivateFieldSet(this, _CommentPlugin_excludeInternal_accessor_storage, value, "f"); }
         get excludePrivate() { return __classPrivateFieldGet(this, _CommentPlugin_excludePrivate_accessor_storage, "f"); }
@@ -296,6 +314,7 @@ let CommentPlugin = (() => {
          * @param node  The node that is currently processed if available.
          */
         onDeclaration(_context, reflection) {
+            this.cascadeModifiers(reflection);
             const comment = reflection.comment;
             if (!comment)
                 return;
@@ -369,6 +388,13 @@ let CommentPlugin = (() => {
                     !/[A-Z_][A-Z0-9_]/.test(reflection.comment.label)) {
                     context.logger.warn(context.i18n.label_0_for_1_cannot_be_referenced(reflection.comment.label, reflection.getFriendlyFullName()));
                 }
+                for (const group of MUTUALLY_EXCLUSIVE_MODIFIERS) {
+                    const intersect = (0, set_1.setIntersection)(group, reflection.comment.modifierTags);
+                    if (intersect.size > 1) {
+                        const [a, b] = intersect;
+                        context.logger.warn(context.i18n.modifier_tag_0_is_mutually_exclusive_with_1_in_comment_for_2(a, b, reflection.getFriendlyFullName()));
+                    }
+                }
                 mergeSeeTags(reflection.comment);
                 movePropertyTags(reflection.comment, reflection);
             }
@@ -393,6 +419,13 @@ let CommentPlugin = (() => {
                         reflection.comment.removeTags("@returns");
                     }
                 }
+                // Any cascaded tags will show up twice, once on this and once on our signatures
+                // This is completely redundant, so remove them from the wrapping function.
+                if (sigs.length) {
+                    for (const mod of this.cascadedModifierTags) {
+                        reflection.comment.modifierTags.delete(mod);
+                    }
+                }
             }
             if (reflection instanceof models_1.SignatureReflection) {
                 this.moveSignatureParamComments(reflection);
@@ -439,6 +472,22 @@ let CommentPlugin = (() => {
                 comment.removeModifier(tag);
             }
         }
+        cascadeModifiers(reflection) {
+            const parentComment = reflection.parent?.comment;
+            if (!parentComment)
+                return;
+            const childMods = reflection.comment?.modifierTags ?? new Set();
+            for (const mod of this.cascadedModifierTags) {
+                if (parentComment.hasModifier(mod)) {
+                    const exclusiveSet = MUTUALLY_EXCLUSIVE_MODIFIERS.find((tags) => tags.has(mod));
+                    if (!exclusiveSet ||
+                        Array.from(exclusiveSet).every((tag) => !childMods.has(tag))) {
+                        reflection.comment ||= new models_1.Comment();
+                        reflection.comment.modifierTags.add(mod);
+                    }
+                }
+            }
+        }
         /**
          * Determines whether or not a reflection has been hidden
          *
@@ -534,6 +583,7 @@ let CommentPlugin = (() => {
         }
     };
     _CommentPlugin_excludeTags_accessor_storage = new WeakMap();
+    _CommentPlugin_cascadedModifierTags_accessor_storage = new WeakMap();
     _CommentPlugin_excludeInternal_accessor_storage = new WeakMap();
     _CommentPlugin_excludePrivate_accessor_storage = new WeakMap();
     _CommentPlugin_excludeProtected_accessor_storage = new WeakMap();
@@ -544,6 +594,7 @@ let CommentPlugin = (() => {
     (() => {
         const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
         _excludeTags_decorators = [(0, utils_1.Option)("excludeTags")];
+        _cascadedModifierTags_decorators = [(0, utils_1.Option)("cascadedModifierTags")];
         _excludeInternal_decorators = [(0, utils_1.Option)("excludeInternal")];
         _excludePrivate_decorators = [(0, utils_1.Option)("excludePrivate")];
         _excludeProtected_decorators = [(0, utils_1.Option)("excludeProtected")];
@@ -551,6 +602,7 @@ let CommentPlugin = (() => {
         _excludeCategories_decorators = [(0, utils_1.Option)("excludeCategories")];
         _defaultCategory_decorators = [(0, utils_1.Option)("defaultCategory")];
         __esDecorate(_classThis, null, _excludeTags_decorators, { kind: "accessor", name: "excludeTags", static: false, private: false, access: { has: obj => "excludeTags" in obj, get: obj => obj.excludeTags, set: (obj, value) => { obj.excludeTags = value; } }, metadata: _metadata }, _excludeTags_initializers, _excludeTags_extraInitializers);
+        __esDecorate(_classThis, null, _cascadedModifierTags_decorators, { kind: "accessor", name: "cascadedModifierTags", static: false, private: false, access: { has: obj => "cascadedModifierTags" in obj, get: obj => obj.cascadedModifierTags, set: (obj, value) => { obj.cascadedModifierTags = value; } }, metadata: _metadata }, _cascadedModifierTags_initializers, _cascadedModifierTags_extraInitializers);
         __esDecorate(_classThis, null, _excludeInternal_decorators, { kind: "accessor", name: "excludeInternal", static: false, private: false, access: { has: obj => "excludeInternal" in obj, get: obj => obj.excludeInternal, set: (obj, value) => { obj.excludeInternal = value; } }, metadata: _metadata }, _excludeInternal_initializers, _excludeInternal_extraInitializers);
         __esDecorate(_classThis, null, _excludePrivate_decorators, { kind: "accessor", name: "excludePrivate", static: false, private: false, access: { has: obj => "excludePrivate" in obj, get: obj => obj.excludePrivate, set: (obj, value) => { obj.excludePrivate = value; } }, metadata: _metadata }, _excludePrivate_initializers, _excludePrivate_extraInitializers);
         __esDecorate(_classThis, null, _excludeProtected_decorators, { kind: "accessor", name: "excludeProtected", static: false, private: false, access: { has: obj => "excludeProtected" in obj, get: obj => obj.excludeProtected, set: (obj, value) => { obj.excludeProtected = value; } }, metadata: _metadata }, _excludeProtected_initializers, _excludeProtected_extraInitializers);

package/dist/lib/converter/symbols.js

@@ -14,9 +14,6 @@ const signature_1 = require("./factories/signature");
 const jsdoc_1 = require("./jsdoc");
 const nodes_1 = require("./utils/nodes");
 const reflections_1 = require("./utils/reflections");
-const path_1 = require("path");
-const utils_1 = require("../utils");
-const paths_1 = require("../utils/paths");
 const symbolConverters = {
     [typescript_1.default.SymbolFlags.RegularEnum]: convertEnum,
     [typescript_1.default.SymbolFlags.ConstEnum]: convertEnum,
@@ -180,28 +177,6 @@ function convertNamespace(context, symbol, exportSymbol) {
     else {
         reflection = context.createDeclarationReflection(models_1.ReflectionKind.Namespace, symbol, exportSymbol);
         context.finalizeDeclarationReflection(reflection);
-        let relativeTo = reflection.comment?.sourcePath;
-        if (relativeTo) {
-            relativeTo = (0, path_1.dirname)(relativeTo);
-            const tags = reflection.comment?.getTags("@document") || [];
-            reflection.comment?.removeTags("@document");
-            for (const tag of tags) {
-                const path = models_1.Comment.combineDisplayParts(tag.content);
-                let file;
-                try {
-                    const resolved = (0, path_1.resolve)(relativeTo, path);
-                    file = new utils_1.MinimalSourceFile((0, utils_1.readFile)(resolved), resolved);
-                }
-                catch {
-                    context.logger.warn(context.logger.i18n.failed_to_read_0_when_processing_document_tag_in_1((0, paths_1.nicePath)(path), (0, paths_1.nicePath)(reflection.comment.sourcePath)));
-                    continue;
-                }
-                const { content, frontmatter } = context.converter.parseRawComment(file);
-                const docRefl = new models_1.DocumentReflection((0, path_1.basename)(file.fileName).replace(/\.[^.]+$/, ""), reflection, content, frontmatter);
-                reflection.addChild(docRefl);
-                context.project.registerReflection(docRefl);
-            }
-        }
     }
     convertSymbols(context.withScope(reflection), context.checker
         .getExportsOfModule(symbol)

package/dist/lib/internationalization/translatable.d.ts

@@ -13,6 +13,7 @@ export declare const translatable: {
     readonly no_entry_points_for_packages: "No entry points provided to packages mode, documentation cannot be generated.";
     readonly failed_to_find_packages: "Failed to find any packages, ensure you have provided at least one directory as an entry point containing package.json";
     readonly nested_packages_unsupported_0: "Project at {0} has entryPointStrategy set to packages, but nested packages are not supported.";
+    readonly previous_error_occurred_when_reading_options_for_0: "The previous error occurred when reading options for the package at {0}";
     readonly converting_project_at_0: "Converting project at {0}";
     readonly failed_to_convert_packages: "Failed to convert one or more packages, result will not be merged together.";
     readonly merging_converted_projects: "Merging converted projects";
@@ -38,6 +39,7 @@ export declare const translatable: {
     readonly treating_unrecognized_tag_0_as_modifier: "Treating unrecognized tag {0} as a modifier tag.";
     readonly unmatched_closing_brace: "Unmatched closing brace.";
     readonly unescaped_open_brace_without_inline_tag: "Encountered an unescaped open brace without an inline tag.";
+    readonly unknown_block_tag_0: "Encountered an unknown block tag {0}.";
     readonly unknown_inline_tag_0: "Encountered an unknown inline tag {0}.";
     readonly open_brace_within_inline_tag: "Encountered an open brace within an inline tag, this is likely a mistake.";
     readonly inline_tag_not_closed: "Inline tag is not closed.";
@@ -50,6 +52,7 @@ export declare const translatable: {
     readonly comment_for_0_includes_categoryDescription_for_1_but_no_child_in_group: "Comment for {0} includes @categoryDescription for \"{1}\", but no child is placed in that category.";
     readonly comment_for_0_includes_groupDescription_for_1_but_no_child_in_group: "Comment for {0} includes @groupDescription for \"{1}\", but no child is placed in that group.";
     readonly label_0_for_1_cannot_be_referenced: "The label \"{0}\" for {1} cannot be referenced with a declaration reference. Labels may only contain A-Z, 0-9, and _, and may not start with a number.";
+    readonly modifier_tag_0_is_mutually_exclusive_with_1_in_comment_for_2: "The modifier tag {0} is mutually exclusive with {1} in the comment for {2}.";
     readonly signature_0_has_unused_param_with_name_1: "The signature {0} has an @param with name \"{1}\", which was not used.";
     readonly declaration_reference_in_inheritdoc_for_0_not_fully_parsed: "Declaration reference in @inheritDoc for {0} was not fully parsed and may resolve incorrectly.";
     readonly failed_to_find_0_to_inherit_comment_from_in_1: "Failed to find \"{0}\" to inherit the comment from in the comment for {1}";
@@ -102,8 +105,10 @@ export declare const translatable: {
     readonly help_compilerOptions: "Selectively override the TypeScript compiler options used by TypeDoc.";
     readonly help_lang: "Sets the language to be used in generation and in TypeDoc's messages.";
     readonly help_locales: "Add translations for a specified locale. This option is primarily intended to be used as a stopgap while waiting for official locale support to be added to TypeDoc.";
+    readonly help_packageOptions: "Set options which will be set within each package when entryPointStrategy is set to packages.";
     readonly help_entryPoints: "The entry points of your documentation.";
     readonly help_entryPointStrategy: "The strategy to be used to convert entry points into documentation modules.";
+    readonly help_alwaysCreateEntryPointModule: "When set, TypeDoc will always create a `Module` for entry points, even if only one is provided.";
     readonly help_projectDocuments: "Documents which should be added as children to the root of the generated documentation. Supports globs to match multiple files.";
     readonly help_exclude: "Define patterns to be excluded when expanding a directory that was specified as an entry point.";
     readonly help_externalPattern: "Define patterns for files that should be considered being external.";
@@ -143,6 +148,8 @@ export declare const translatable: {
     readonly help_hostedBaseUrl: "Specify a base URL to be used in generating a sitemap.xml in our output folder and canonical links. If not specified, no sitemap will be generated.";
     readonly help_gaID: "Set the Google Analytics tracking ID and activate tracking code.";
     readonly help_hideGenerator: "Do not print the TypeDoc link at the end of the page.";
+    readonly help_customFooterHtml: "Custom footer after the TypeDoc link.";
+    readonly help_customFooterHtmlDisableWrapper: "If set, disables the wrapper element for customFooterHtml.";
     readonly help_hideParameterTypesInTitle: "Hides parameter types in signature titles for easier scanning.";
     readonly help_cacheBust: "Include the generation time in links to static assets.";
     readonly help_searchInComments: "If set, the search index will also include comments. This will greatly increase the size of the search index.";

package/dist/lib/internationalization/translatable.js

@@ -22,6 +22,7 @@ exports.translatable = {
     no_entry_points_for_packages: "No entry points provided to packages mode, documentation cannot be generated.",
     failed_to_find_packages: "Failed to find any packages, ensure you have provided at least one directory as an entry point containing package.json",
     nested_packages_unsupported_0: "Project at {0} has entryPointStrategy set to packages, but nested packages are not supported.",
+    previous_error_occurred_when_reading_options_for_0: "The previous error occurred when reading options for the package at {0}",
     converting_project_at_0: "Converting project at {0}",
     failed_to_convert_packages: "Failed to convert one or more packages, result will not be merged together.",
     merging_converted_projects: "Merging converted projects",
@@ -48,6 +49,7 @@ exports.translatable = {
     treating_unrecognized_tag_0_as_modifier: `Treating unrecognized tag {0} as a modifier tag.`,
     unmatched_closing_brace: `Unmatched closing brace.`,
     unescaped_open_brace_without_inline_tag: `Encountered an unescaped open brace without an inline tag.`,
+    unknown_block_tag_0: `Encountered an unknown block tag {0}.`,
     unknown_inline_tag_0: `Encountered an unknown inline tag {0}.`,
     open_brace_within_inline_tag: `Encountered an open brace within an inline tag, this is likely a mistake.`,
     inline_tag_not_closed: `Inline tag is not closed.`,
@@ -62,6 +64,7 @@ exports.translatable = {
     comment_for_0_includes_categoryDescription_for_1_but_no_child_in_group: `Comment for {0} includes @categoryDescription for "{1}", but no child is placed in that category.`,
     comment_for_0_includes_groupDescription_for_1_but_no_child_in_group: `Comment for {0} includes @groupDescription for "{1}", but no child is placed in that group.`,
     label_0_for_1_cannot_be_referenced: `The label "{0}" for {1} cannot be referenced with a declaration reference. Labels may only contain A-Z, 0-9, and _, and may not start with a number.`,
+    modifier_tag_0_is_mutually_exclusive_with_1_in_comment_for_2: `The modifier tag {0} is mutually exclusive with {1} in the comment for {2}.`,
     signature_0_has_unused_param_with_name_1: `The signature {0} has an @param with name "{1}", which was not used.`,
     declaration_reference_in_inheritdoc_for_0_not_fully_parsed: `Declaration reference in @inheritDoc for {0} was not fully parsed and may resolve incorrectly.`,
     failed_to_find_0_to_inherit_comment_from_in_1: `Failed to find "{0}" to inherit the comment from in the comment for {1}`,
@@ -121,8 +124,10 @@ exports.translatable = {
     help_compilerOptions: "Selectively override the TypeScript compiler options used by TypeDoc.",
     help_lang: "Sets the language to be used in generation and in TypeDoc's messages.",
     help_locales: "Add translations for a specified locale. This option is primarily intended to be used as a stopgap while waiting for official locale support to be added to TypeDoc.",
+    help_packageOptions: "Set options which will be set within each package when entryPointStrategy is set to packages.",
     help_entryPoints: "The entry points of your documentation.",
     help_entryPointStrategy: "The strategy to be used to convert entry points into documentation modules.",
+    help_alwaysCreateEntryPointModule: "When set, TypeDoc will always create a `Module` for entry points, even if only one is provided.",
     help_projectDocuments: "Documents which should be added as children to the root of the generated documentation. Supports globs to match multiple files.",
     help_exclude: "Define patterns to be excluded when expanding a directory that was specified as an entry point.",
     help_externalPattern: "Define patterns for files that should be considered being external.",
@@ -162,6 +167,8 @@ exports.translatable = {
     help_hostedBaseUrl: "Specify a base URL to be used in generating a sitemap.xml in our output folder and canonical links. If not specified, no sitemap will be generated.",
     help_gaID: "Set the Google Analytics tracking ID and activate tracking code.",
     help_hideGenerator: "Do not print the TypeDoc link at the end of the page.",
+    help_customFooterHtml: "Custom footer after the TypeDoc link.",
+    help_customFooterHtmlDisableWrapper: "If set, disables the wrapper element for customFooterHtml.",
     help_hideParameterTypesInTitle: "Hides parameter types in signature titles for easier scanning.",
     help_cacheBust: "Include the generation time in links to static assets.",
     help_searchInComments: "If set, the search index will also include comments. This will greatly increase the size of the search index.",

package/dist/lib/models/reflections/kind.d.ts

@@ -56,6 +56,7 @@ export declare namespace ReflectionKind {
     const SomeMember: number;
     /** @internal */
     const SomeExport: number;
+    const MayContainDocuments: number;
     /** @internal */
     const ExportContainer: number;
     /** @internal */

package/dist/lib/models/reflections/kind.js

@@ -79,6 +79,7 @@ var ReflectionKind;
         ReflectionKind.Interface |
         ReflectionKind.TypeAlias |
         ReflectionKind.Reference;
+    ReflectionKind.MayContainDocuments = ReflectionKind.SomeExport | ReflectionKind.Project;
     /** @internal */
     ReflectionKind.ExportContainer = ReflectionKind.SomeModule | ReflectionKind.Project;
     /** @internal */

package/dist/lib/output/plugins/SitemapPlugin.d.ts

@@ -1,6 +1,6 @@
 import { RendererComponent } from "../components";
 export declare class SitemapPlugin extends RendererComponent {
-    accessor hostedBaseUrl: string;
+    private get hostedBaseUrl();
     initialize(): void;
     private onRendererBegin;
     private buildSitemap;

package/dist/lib/output/plugins/SitemapPlugin.js

@@ -37,17 +37,6 @@ var __setFunctionName = (this && this.__setFunctionName) || function (f, name, p
     if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
     return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
 };
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -61,18 +50,16 @@ const utils_1 = require("../../utils");
 const html_1 = require("../../utils/html");
 const jsx_1 = require("../../utils/jsx");
 let SitemapPlugin = (() => {
-    var _SitemapPlugin_hostedBaseUrl_accessor_storage;
     let _classDecorators = [(0, components_1.Component)({ name: "sitemap" })];
     let _classDescriptor;
     let _classExtraInitializers = [];
     let _classThis;
     let _classSuper = components_1.RendererComponent;
-    let _hostedBaseUrl_decorators;
-    let _hostedBaseUrl_initializers = [];
-    let _hostedBaseUrl_extraInitializers = [];
     var SitemapPlugin = _classThis = class extends _classSuper {
-        get hostedBaseUrl() { return __classPrivateFieldGet(this, _SitemapPlugin_hostedBaseUrl_accessor_storage, "f"); }
-        set hostedBaseUrl(value) { __classPrivateFieldSet(this, _SitemapPlugin_hostedBaseUrl_accessor_storage, value, "f"); }
+        get hostedBaseUrl() {
+            const url = this.application.options.getValue("hostedBaseUrl");
+            return !url || url.endsWith("/") ? url : url + "/";
+        }
         initialize() {
             this.listenTo(this.owner, events_1.RendererEvent.BEGIN, this.onRendererBegin);
         }
@@ -123,18 +110,10 @@ let SitemapPlugin = (() => {
                 "\n";
             await (0, utils_1.writeFile)(sitemapXml, sitemap);
         }
-        constructor() {
-            super(...arguments);
-            _SitemapPlugin_hostedBaseUrl_accessor_storage.set(this, __runInitializers(this, _hostedBaseUrl_initializers, void 0));
-            __runInitializers(this, _hostedBaseUrl_extraInitializers);
-        }
     };
-    _SitemapPlugin_hostedBaseUrl_accessor_storage = new WeakMap();
     __setFunctionName(_classThis, "SitemapPlugin");
     (() => {
         const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
-        _hostedBaseUrl_decorators = [(0, utils_1.Option)("hostedBaseUrl")];
-        __esDecorate(_classThis, null, _hostedBaseUrl_decorators, { kind: "accessor", name: "hostedBaseUrl", static: false, private: false, access: { has: obj => "hostedBaseUrl" in obj, get: obj => obj.hostedBaseUrl, set: (obj, value) => { obj.hostedBaseUrl = value; } }, metadata: _metadata }, _hostedBaseUrl_initializers, _hostedBaseUrl_extraInitializers);
         __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
         SitemapPlugin = _classThis = _classDescriptor.value;
         if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });

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

@@ -93,6 +93,8 @@ export interface RendererHooks {
  * * {@link Renderer.EVENT_PREPARE_INDEX}<br>
  *    Triggered when the JavascriptIndexPlugin is preparing the search index. Listeners receive
  *    an instance of {@link IndexEvent}.
+ *
+ * @document ../../../internal-docs/custom-themes.md
  */
 export declare class Renderer extends ChildableComponent<Application, RendererComponent> {
     private themes;

package/dist/lib/output/renderer.js

@@ -124,6 +124,8 @@ const jsx_1 = require("../utils/jsx");
  * * {@link Renderer.EVENT_PREPARE_INDEX}<br>
  *    Triggered when the JavascriptIndexPlugin is preparing the search index. Listeners receive
  *    an instance of {@link IndexEvent}.
+ *
+ * @document ../../../internal-docs/custom-themes.md
  */
 let Renderer = (() => {
     var _Renderer_themeName_accessor_storage, _Renderer_cleanOutputDir_accessor_storage, _Renderer_cname_accessor_storage, _Renderer_githubPages_accessor_storage, _Renderer_cacheBust_accessor_storage, _Renderer_lightTheme_accessor_storage, _Renderer_darkTheme_accessor_storage, _Renderer_pretty_accessor_storage;

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

@@ -2,6 +2,7 @@ import { ContextAwareRendererComponent } from "../components";
 import { type RendererEvent, MarkdownEvent, type PageEvent } from "../events";
 import type { BundledTheme } from "shiki" with { "resolution-mode": "import" };
 import type { DefaultThemeRenderContext } from "..";
+import { type CommentDisplayPart } from "../../models";
 /**
  * Implements markdown and relativeURL helpers for templates.
  * @internal
@@ -9,6 +10,7 @@ import type { DefaultThemeRenderContext } from "..";
 export declare class MarkedPlugin extends ContextAwareRendererComponent {
     accessor lightTheme: BundledTheme;
     accessor darkTheme: BundledTheme;
+    accessor markdownItOptions: Record<string, unknown>;
     private parser?;
     /**
      * This needing to be here really feels hacky... probably some nicer way to do this.
@@ -31,10 +33,10 @@ export declare class MarkedPlugin extends ContextAwareRendererComponent {
     /**
      * Parse the given markdown string and return the resulting html.
      *
-     * @param text  The markdown string that should be parsed.
+     * @param input  The markdown string that should be parsed.
      * @returns The resulting html string.
      */
-    parseMarkdown(text: string, page: PageEvent<any>, context: DefaultThemeRenderContext): string;
+    parseMarkdown(input: string | readonly CommentDisplayPart[], page: PageEvent<any>, context: DefaultThemeRenderContext): string;
     /**
      * Triggered before the renderer starts rendering a project.
      *