typedoc 0.26.10 → 0.27.0-beta.0

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

@@ -1,4 +1,3 @@
-"use strict";
 var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
     function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
     var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
@@ -33,29 +32,12 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
     }
     return useValue ? value : void 0;
 };
-var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
-    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;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommentPlugin = void 0;
-const components_1 = require("../components");
-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");
+import { Comment, CommentTag, DeclarationReflection, ParameterReflection, ReflectionFlag, ReflectionKind, ReflectionType, SignatureReflection, } from "../../models/index.js";
+import { Option, filterMap, partition, removeIf, removeIfPresent, unique, } from "../../utils/index.js";
+import { setIntersection } from "../../utils/set.js";
+import { ConverterComponent } from "../components.js";
+import { ConverterEvents } from "../converter-events.js";
+import { CategoryPlugin } from "./CategoryPlugin.js";
 /**
  * These tags are not useful to display in the generated documentation.
  * They should be ignored when parsing comments. Any relevant type information
@@ -146,12 +128,7 @@ const MUTUALLY_EXCLUSIVE_MODIFIERS = [
  *
  */
 let CommentPlugin = (() => {
-    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 = [];
-    let _classThis;
-    let _classSuper = components_1.ConverterComponent;
+    let _classSuper = ConverterComponent;
     let _excludeTags_decorators;
     let _excludeTags_initializers = [];
     let _excludeTags_extraInitializers = [];
@@ -176,51 +153,66 @@ let CommentPlugin = (() => {
     let _defaultCategory_decorators;
     let _defaultCategory_initializers = [];
     let _defaultCategory_extraInitializers = [];
-    var CommentPlugin = _classThis = class extends _classSuper {
-        constructor() {
-            super(...arguments);
-            _CommentPlugin_excludeTags_accessor_storage.set(this, __runInitializers(this, _excludeTags_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)));
-            _CommentPlugin_excludeCategories_accessor_storage.set(this, (__runInitializers(this, _excludeNotDocumented_extraInitializers), __runInitializers(this, _excludeCategories_initializers, void 0)));
-            _CommentPlugin_defaultCategory_accessor_storage.set(this, (__runInitializers(this, _excludeCategories_extraInitializers), __runInitializers(this, _defaultCategory_initializers, void 0)));
-            this._excludeKinds = __runInitializers(this, _defaultCategory_extraInitializers);
+    return class CommentPlugin extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _excludeTags_decorators = [Option("excludeTags")];
+            _cascadedModifierTags_decorators = [Option("cascadedModifierTags")];
+            _excludeInternal_decorators = [Option("excludeInternal")];
+            _excludePrivate_decorators = [Option("excludePrivate")];
+            _excludeProtected_decorators = [Option("excludeProtected")];
+            _excludeNotDocumented_decorators = [Option("excludeNotDocumented")];
+            _excludeCategories_decorators = [Option("excludeCategories")];
+            _defaultCategory_decorators = [Option("defaultCategory")];
+            __esDecorate(this, 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(this, 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(this, 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(this, 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(this, 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);
+            __esDecorate(this, null, _excludeNotDocumented_decorators, { kind: "accessor", name: "excludeNotDocumented", static: false, private: false, access: { has: obj => "excludeNotDocumented" in obj, get: obj => obj.excludeNotDocumented, set: (obj, value) => { obj.excludeNotDocumented = value; } }, metadata: _metadata }, _excludeNotDocumented_initializers, _excludeNotDocumented_extraInitializers);
+            __esDecorate(this, null, _excludeCategories_decorators, { kind: "accessor", name: "excludeCategories", static: false, private: false, access: { has: obj => "excludeCategories" in obj, get: obj => obj.excludeCategories, set: (obj, value) => { obj.excludeCategories = value; } }, metadata: _metadata }, _excludeCategories_initializers, _excludeCategories_extraInitializers);
+            __esDecorate(this, null, _defaultCategory_decorators, { kind: "accessor", name: "defaultCategory", static: false, private: false, access: { has: obj => "defaultCategory" in obj, get: obj => obj.defaultCategory, set: (obj, value) => { obj.defaultCategory = value; } }, metadata: _metadata }, _defaultCategory_initializers, _defaultCategory_extraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
         }
-        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"); }
-        set excludePrivate(value) { __classPrivateFieldSet(this, _CommentPlugin_excludePrivate_accessor_storage, value, "f"); }
-        get excludeProtected() { return __classPrivateFieldGet(this, _CommentPlugin_excludeProtected_accessor_storage, "f"); }
-        set excludeProtected(value) { __classPrivateFieldSet(this, _CommentPlugin_excludeProtected_accessor_storage, value, "f"); }
-        get excludeNotDocumented() { return __classPrivateFieldGet(this, _CommentPlugin_excludeNotDocumented_accessor_storage, "f"); }
-        set excludeNotDocumented(value) { __classPrivateFieldSet(this, _CommentPlugin_excludeNotDocumented_accessor_storage, value, "f"); }
-        get excludeCategories() { return __classPrivateFieldGet(this, _CommentPlugin_excludeCategories_accessor_storage, "f"); }
-        set excludeCategories(value) { __classPrivateFieldSet(this, _CommentPlugin_excludeCategories_accessor_storage, value, "f"); }
-        get defaultCategory() { return __classPrivateFieldGet(this, _CommentPlugin_defaultCategory_accessor_storage, "f"); }
-        set defaultCategory(value) { __classPrivateFieldSet(this, _CommentPlugin_defaultCategory_accessor_storage, value, "f"); }
+        #excludeTags_accessor_storage = __runInitializers(this, _excludeTags_initializers, void 0);
+        get excludeTags() { return this.#excludeTags_accessor_storage; }
+        set excludeTags(value) { this.#excludeTags_accessor_storage = value; }
+        #cascadedModifierTags_accessor_storage = (__runInitializers(this, _excludeTags_extraInitializers), __runInitializers(this, _cascadedModifierTags_initializers, void 0));
+        get cascadedModifierTags() { return this.#cascadedModifierTags_accessor_storage; }
+        set cascadedModifierTags(value) { this.#cascadedModifierTags_accessor_storage = value; }
+        #excludeInternal_accessor_storage = (__runInitializers(this, _cascadedModifierTags_extraInitializers), __runInitializers(this, _excludeInternal_initializers, void 0));
+        get excludeInternal() { return this.#excludeInternal_accessor_storage; }
+        set excludeInternal(value) { this.#excludeInternal_accessor_storage = value; }
+        #excludePrivate_accessor_storage = (__runInitializers(this, _excludeInternal_extraInitializers), __runInitializers(this, _excludePrivate_initializers, void 0));
+        get excludePrivate() { return this.#excludePrivate_accessor_storage; }
+        set excludePrivate(value) { this.#excludePrivate_accessor_storage = value; }
+        #excludeProtected_accessor_storage = (__runInitializers(this, _excludePrivate_extraInitializers), __runInitializers(this, _excludeProtected_initializers, void 0));
+        get excludeProtected() { return this.#excludeProtected_accessor_storage; }
+        set excludeProtected(value) { this.#excludeProtected_accessor_storage = value; }
+        #excludeNotDocumented_accessor_storage = (__runInitializers(this, _excludeProtected_extraInitializers), __runInitializers(this, _excludeNotDocumented_initializers, void 0));
+        get excludeNotDocumented() { return this.#excludeNotDocumented_accessor_storage; }
+        set excludeNotDocumented(value) { this.#excludeNotDocumented_accessor_storage = value; }
+        #excludeCategories_accessor_storage = (__runInitializers(this, _excludeNotDocumented_extraInitializers), __runInitializers(this, _excludeCategories_initializers, void 0));
+        get excludeCategories() { return this.#excludeCategories_accessor_storage; }
+        set excludeCategories(value) { this.#excludeCategories_accessor_storage = value; }
+        #defaultCategory_accessor_storage = (__runInitializers(this, _excludeCategories_extraInitializers), __runInitializers(this, _defaultCategory_initializers, void 0));
+        get defaultCategory() { return this.#defaultCategory_accessor_storage; }
+        set defaultCategory(value) { this.#defaultCategory_accessor_storage = value; }
+        _excludeKinds = __runInitializers(this, _defaultCategory_extraInitializers);
         get excludeNotDocumentedKinds() {
             this._excludeKinds ??= this.application.options
                 .getValue("excludeNotDocumentedKinds")
-                .reduce((a, b) => a | models_1.ReflectionKind[b], 0);
+                .reduce((a, b) => a | ReflectionKind[b], 0);
             return this._excludeKinds;
         }
-        /**
-         * Create a new CommentPlugin instance.
-         */
-        initialize() {
-            this.owner.on(converter_1.Converter.EVENT_CREATE_DECLARATION, this.onDeclaration.bind(this));
-            this.owner.on(converter_1.Converter.EVENT_CREATE_SIGNATURE, this.onDeclaration.bind(this));
-            this.owner.on(converter_1.Converter.EVENT_CREATE_TYPE_PARAMETER, this.onCreateTypeParameter.bind(this));
-            this.owner.on(converter_1.Converter.EVENT_RESOLVE_BEGIN, this.onBeginResolve.bind(this));
-            this.owner.on(converter_1.Converter.EVENT_RESOLVE, this.onResolve.bind(this));
-            this.owner.on(converter_1.Converter.EVENT_END, () => {
+        constructor(owner) {
+            super(owner);
+            this.owner.on(ConverterEvents.CREATE_DECLARATION, this.onDeclaration.bind(this));
+            this.owner.on(ConverterEvents.CREATE_SIGNATURE, this.onDeclaration.bind(this));
+            this.owner.on(ConverterEvents.CREATE_TYPE_PARAMETER, this.onCreateTypeParameter.bind(this));
+            this.owner.on(ConverterEvents.RESOLVE_BEGIN, this.onBeginResolve.bind(this));
+            this.owner.on(ConverterEvents.RESOLVE, this.onResolve.bind(this));
+            this.owner.on(ConverterEvents.END, () => {
                 this._excludeKinds = undefined;
             });
         }
@@ -231,56 +223,56 @@ let CommentPlugin = (() => {
          * @param comment  The comment that should be searched for modifiers.
          */
         applyModifiers(reflection, comment) {
-            if (reflection.kindOf(models_1.ReflectionKind.SomeModule)) {
+            if (reflection.kindOf(ReflectionKind.SomeModule)) {
                 comment.removeModifier("@namespace");
             }
-            if (reflection.kindOf(models_1.ReflectionKind.Interface)) {
+            if (reflection.kindOf(ReflectionKind.Interface)) {
                 comment.removeModifier("@interface");
             }
             if (comment.hasModifier("@abstract")) {
-                if (reflection.kindOf(models_1.ReflectionKind.SomeSignature)) {
-                    reflection.parent.setFlag(models_1.ReflectionFlag.Abstract);
+                if (reflection.kindOf(ReflectionKind.SomeSignature)) {
+                    reflection.parent.setFlag(ReflectionFlag.Abstract);
                 }
                 else {
-                    reflection.setFlag(models_1.ReflectionFlag.Abstract);
+                    reflection.setFlag(ReflectionFlag.Abstract);
                 }
                 comment.removeModifier("@abstract");
             }
             if (comment.hasModifier("@private")) {
-                reflection.setFlag(models_1.ReflectionFlag.Private);
-                if (reflection.kindOf(models_1.ReflectionKind.CallSignature)) {
-                    reflection.parent?.setFlag(models_1.ReflectionFlag.Private);
+                reflection.setFlag(ReflectionFlag.Private);
+                if (reflection.kindOf(ReflectionKind.CallSignature)) {
+                    reflection.parent?.setFlag(ReflectionFlag.Private);
                 }
                 comment.removeModifier("@private");
             }
             if (comment.hasModifier("@protected")) {
-                reflection.setFlag(models_1.ReflectionFlag.Protected);
-                if (reflection.kindOf(models_1.ReflectionKind.CallSignature)) {
-                    reflection.parent?.setFlag(models_1.ReflectionFlag.Protected);
+                reflection.setFlag(ReflectionFlag.Protected);
+                if (reflection.kindOf(ReflectionKind.CallSignature)) {
+                    reflection.parent?.setFlag(ReflectionFlag.Protected);
                 }
                 comment.removeModifier("@protected");
             }
             if (comment.hasModifier("@public")) {
-                reflection.setFlag(models_1.ReflectionFlag.Public);
-                if (reflection.kindOf(models_1.ReflectionKind.CallSignature)) {
-                    reflection.parent?.setFlag(models_1.ReflectionFlag.Public);
+                reflection.setFlag(ReflectionFlag.Public);
+                if (reflection.kindOf(ReflectionKind.CallSignature)) {
+                    reflection.parent?.setFlag(ReflectionFlag.Public);
                 }
                 comment.removeModifier("@public");
             }
             if (comment.hasModifier("@readonly")) {
-                const target = reflection.kindOf(models_1.ReflectionKind.GetSignature)
+                const target = reflection.kindOf(ReflectionKind.GetSignature)
                     ? reflection.parent
                     : reflection;
-                target.setFlag(models_1.ReflectionFlag.Readonly);
+                target.setFlag(ReflectionFlag.Readonly);
                 comment.removeModifier("@readonly");
             }
             if (comment.hasModifier("@event") ||
                 comment.hasModifier("@eventProperty")) {
-                comment.blockTags.push(new models_1.CommentTag("@group", [{ kind: "text", text: "Events" }]));
+                comment.blockTags.push(new CommentTag("@group", [{ kind: "text", text: "Events" }]));
                 comment.removeModifier("@event");
                 comment.removeModifier("@eventProperty");
             }
-            if (reflection.kindOf(models_1.ReflectionKind.Project | models_1.ReflectionKind.SomeModule)) {
+            if (reflection.kindOf(ReflectionKind.Project | ReflectionKind.SomeModule)) {
                 comment.removeTags("@module");
                 comment.removeModifier("@packageDocumentation");
             }
@@ -305,9 +297,9 @@ let CommentPlugin = (() => {
                     tag = comment.getIdentifiedTag(reflection.name, "@param");
                 }
                 if (tag) {
-                    reflection.comment = new models_1.Comment(tag.content);
+                    reflection.comment = new Comment(tag.content);
                     reflection.comment.sourcePath = comment.sourcePath;
-                    (0, utils_1.removeIfPresent)(comment.blockTags, tag);
+                    removeIfPresent(comment.blockTags, tag);
                 }
             }
         }
@@ -325,16 +317,16 @@ let CommentPlugin = (() => {
             const comment = reflection.comment;
             if (!comment)
                 return;
-            if (reflection.kindOf(models_1.ReflectionKind.SomeModule)) {
+            if (reflection.kindOf(ReflectionKind.SomeModule)) {
                 const tag = comment.getTag("@module");
                 if (tag) {
                     // If no name is specified, this is a flag to mark a comment as a module comment
                     // and should not result in a reflection rename.
-                    const newName = models_1.Comment.combineDisplayParts(tag.content).trim();
+                    const newName = Comment.combineDisplayParts(tag.content).trim();
                     if (newName.length && !newName.includes("\n")) {
                         reflection.name = newName;
                     }
-                    (0, utils_1.removeIfPresent)(comment.blockTags, tag);
+                    removeIfPresent(comment.blockTags, tag);
                 }
             }
             this.applyModifiers(reflection, comment);
@@ -355,13 +347,13 @@ let CommentPlugin = (() => {
             // Remove hidden reflections
             const hidden = new Set();
             for (const ref of reflections) {
-                if (ref.kindOf(models_1.ReflectionKind.Accessor) && ref.flags.isReadonly) {
+                if (ref.kindOf(ReflectionKind.Accessor) && ref.flags.isReadonly) {
                     const decl = ref;
                     if (decl.setSignature) {
                         hidden.add(decl.setSignature);
                     }
                     // Clear flag set by @readonly since it shouldn't be rendered.
-                    ref.setFlag(models_1.ReflectionFlag.Readonly, false);
+                    ref.setFlag(ReflectionFlag.Readonly, false);
                 }
                 if (this.isHidden(ref)) {
                     hidden.add(ref);
@@ -369,7 +361,7 @@ let CommentPlugin = (() => {
             }
             hidden.forEach((reflection) => project.removeReflection(reflection));
             // remove functions with empty signatures after their signatures have been removed
-            const [allRemoved, someRemoved] = (0, utils_1.partition)((0, utils_1.unique)((0, utils_1.filterMap)(hidden, (reflection) => reflection.parent?.kindOf(models_1.ReflectionKind.SignatureContainer)
+            const [allRemoved, someRemoved] = partition(unique(filterMap(hidden, (reflection) => reflection.parent?.kindOf(ReflectionKind.SignatureContainer)
                 ? reflection.parent
                 : void 0)), (method) => method.getNonIndexSignatures().length === 0);
             allRemoved.forEach((reflection) => {
@@ -400,7 +392,7 @@ let CommentPlugin = (() => {
                     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);
+                    const intersect = 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()));
@@ -411,18 +403,18 @@ let CommentPlugin = (() => {
                 // Unlike other modifiers, this one has to wait until resolution to be removed
                 // as it needs to remain present so that it can be checked when `@hidden` tags are
                 // being processed.
-                if (reflection.kindOf(models_1.ReflectionKind.Class)) {
+                if (reflection.kindOf(ReflectionKind.Class)) {
                     reflection.comment.removeModifier("@hideconstructor");
                 }
             }
-            if ((reflection instanceof models_1.DeclarationReflection ||
-                reflection instanceof models_1.ParameterReflection) &&
+            if ((reflection instanceof DeclarationReflection ||
+                reflection instanceof ParameterReflection) &&
                 reflection.comment) {
                 let sigs = [];
-                if (reflection.type instanceof models_1.ReflectionType) {
+                if (reflection.type instanceof ReflectionType) {
                     sigs = reflection.type.declaration.getNonIndexSignatures();
                 }
-                else if (reflection instanceof models_1.DeclarationReflection) {
+                else if (reflection instanceof DeclarationReflection) {
                     sigs = reflection.getNonIndexSignatures();
                 }
                 // For variables and properties, the symbol might own the comment but we might also
@@ -432,7 +424,7 @@ let CommentPlugin = (() => {
                     this.moveSignatureParamComments(sigs[0], reflection.comment);
                     const returnsTag = reflection.comment.getTag("@returns");
                     if (returnsTag) {
-                        sigs[0].comment = new models_1.Comment();
+                        sigs[0].comment = new Comment();
                         sigs[0].comment.sourcePath = reflection.comment.sourcePath;
                         sigs[0].comment.blockTags.push(returnsTag);
                         reflection.comment.removeTags("@returns");
@@ -446,7 +438,7 @@ let CommentPlugin = (() => {
                     }
                 }
             }
-            if (reflection instanceof models_1.SignatureReflection) {
+            if (reflection instanceof SignatureReflection) {
                 this.moveSignatureParamComments(reflection);
             }
         }
@@ -463,7 +455,7 @@ let CommentPlugin = (() => {
                 }
                 const tag = comment.getIdentifiedTag(parameter.name, "@param");
                 if (tag) {
-                    parameter.comment = new models_1.Comment(models_1.Comment.cloneDisplayParts(tag.content));
+                    parameter.comment = new Comment(Comment.cloneDisplayParts(tag.content));
                     parameter.comment.sourcePath = comment.sourcePath;
                 }
             });
@@ -472,7 +464,7 @@ let CommentPlugin = (() => {
                     comment.getIdentifiedTag(parameter.name, "@template") ||
                     comment.getIdentifiedTag(`<${parameter.name}>`, "@param");
                 if (tag) {
-                    parameter.comment = new models_1.Comment(models_1.Comment.cloneDisplayParts(tag.content));
+                    parameter.comment = new Comment(Comment.cloneDisplayParts(tag.content));
                     parameter.comment.sourcePath = comment.sourcePath;
                 }
             }
@@ -501,7 +493,7 @@ let CommentPlugin = (() => {
                     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 ||= new Comment();
                         reflection.comment.modifierTags.add(mod);
                     }
                 }
@@ -514,24 +506,24 @@ let CommentPlugin = (() => {
          */
         isHidden(reflection) {
             const comment = reflection.comment;
-            if (reflection.flags.hasFlag(models_1.ReflectionFlag.Private) &&
+            if (reflection.flags.hasFlag(ReflectionFlag.Private) &&
                 this.excludePrivate) {
                 return true;
             }
-            if (reflection.flags.hasFlag(models_1.ReflectionFlag.Protected) &&
+            if (reflection.flags.hasFlag(ReflectionFlag.Protected) &&
                 this.excludeProtected) {
                 return true;
             }
             if (this.excludedByCategory(reflection)) {
                 return true;
             }
-            if (reflection.kindOf(models_1.ReflectionKind.ConstructorSignature |
-                models_1.ReflectionKind.Constructor)) {
+            if (reflection.kindOf(ReflectionKind.ConstructorSignature |
+                ReflectionKind.Constructor)) {
                 if (comment?.hasModifier("@hideconstructor"))
                     return true;
-                const cls = reflection.parent?.kindOf(models_1.ReflectionKind.Class)
+                const cls = reflection.parent?.kindOf(ReflectionKind.Class)
                     ? reflection.parent
-                    : reflection.parent?.parent?.kindOf(models_1.ReflectionKind.Class)
+                    : reflection.parent?.parent?.kindOf(ReflectionKind.Class)
                         ? reflection.parent.parent
                         : undefined;
                 if (cls?.comment?.hasModifier("@hideconstructor")) {
@@ -541,29 +533,29 @@ let CommentPlugin = (() => {
             if (!comment) {
                 // We haven't moved comments from the parent for signatures without a direct
                 // comment, so don't exclude those due to not being documented.
-                if (reflection.kindOf(models_1.ReflectionKind.CallSignature |
-                    models_1.ReflectionKind.ConstructorSignature) &&
+                if (reflection.kindOf(ReflectionKind.CallSignature |
+                    ReflectionKind.ConstructorSignature) &&
                     reflection.parent?.comment) {
                     return false;
                 }
                 if (this.excludeNotDocumented) {
                     // Don't let excludeNotDocumented remove parameters.
-                    if (!(reflection instanceof models_1.DeclarationReflection) &&
-                        !(reflection instanceof models_1.SignatureReflection)) {
+                    if (!(reflection instanceof DeclarationReflection) &&
+                        !(reflection instanceof SignatureReflection)) {
                         return false;
                     }
                     if (!reflection.kindOf(this.excludeNotDocumentedKinds)) {
                         return false;
                     }
                     // excludeNotDocumented should hide a module only if it has no visible children
-                    if (reflection.kindOf(models_1.ReflectionKind.SomeModule)) {
+                    if (reflection.kindOf(ReflectionKind.SomeModule)) {
                         if (!reflection.children) {
                             return true;
                         }
                         return reflection.children.every((child) => this.isHidden(child));
                     }
                     // signature containers should only be hidden if all their signatures are hidden
-                    if (reflection.kindOf(models_1.ReflectionKind.SignatureContainer)) {
+                    if (reflection.kindOf(ReflectionKind.SignatureContainer)) {
                         return reflection
                             .getAllSignatures()
                             .every((child) => this.isHidden(child));
@@ -577,7 +569,7 @@ let CommentPlugin = (() => {
                 comment.hasModifier("@ignore") ||
                 (comment.hasModifier("@internal") && this.excludeInternal);
             if (!isHidden &&
-                reflection.kindOf(models_1.ReflectionKind.ContainsCallSignatures)) {
+                reflection.kindOf(ReflectionKind.ContainsCallSignatures)) {
                 return reflection
                     .getNonIndexSignatures()
                     .every((sig) => this.isHidden(sig));
@@ -587,15 +579,15 @@ let CommentPlugin = (() => {
         excludedByCategory(reflection) {
             const excludeCategories = this.excludeCategories;
             let target;
-            if (reflection instanceof models_1.DeclarationReflection) {
+            if (reflection instanceof DeclarationReflection) {
                 target = reflection;
             }
-            else if (reflection instanceof models_1.SignatureReflection) {
+            else if (reflection instanceof SignatureReflection) {
                 target = reflection.parent;
             }
             if (!target || !excludeCategories.length)
                 return false;
-            const categories = CategoryPlugin_1.CategoryPlugin.getCategories(target);
+            const categories = CategoryPlugin.getCategories(target);
             if (categories.size === 0) {
                 categories.add(this.defaultCategory);
             }
@@ -603,7 +595,7 @@ let CommentPlugin = (() => {
         }
         validateParamTags(signature, comment, params) {
             const paramTags = comment.blockTags.filter((tag) => tag.tag === "@param");
-            (0, utils_1.removeIf)(paramTags, (tag) => params.some((param) => param.name === tag.name));
+            removeIf(paramTags, (tag) => params.some((param) => param.name === tag.name));
             moveNestedParamTags(/* in-out */ paramTags, params, comment.sourcePath);
             if (!comment.inheritedFromParentDeclaration) {
                 for (const tag of paramTags) {
@@ -612,50 +604,33 @@ 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();
-    _CommentPlugin_excludeNotDocumented_accessor_storage = new WeakMap();
-    _CommentPlugin_excludeCategories_accessor_storage = new WeakMap();
-    _CommentPlugin_defaultCategory_accessor_storage = new WeakMap();
-    __setFunctionName(_classThis, "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")];
-        _excludeNotDocumented_decorators = [(0, utils_1.Option)("excludeNotDocumented")];
-        _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);
-        __esDecorate(_classThis, null, _excludeNotDocumented_decorators, { kind: "accessor", name: "excludeNotDocumented", static: false, private: false, access: { has: obj => "excludeNotDocumented" in obj, get: obj => obj.excludeNotDocumented, set: (obj, value) => { obj.excludeNotDocumented = value; } }, metadata: _metadata }, _excludeNotDocumented_initializers, _excludeNotDocumented_extraInitializers);
-        __esDecorate(_classThis, null, _excludeCategories_decorators, { kind: "accessor", name: "excludeCategories", static: false, private: false, access: { has: obj => "excludeCategories" in obj, get: obj => obj.excludeCategories, set: (obj, value) => { obj.excludeCategories = value; } }, metadata: _metadata }, _excludeCategories_initializers, _excludeCategories_extraInitializers);
-        __esDecorate(_classThis, null, _defaultCategory_decorators, { kind: "accessor", name: "defaultCategory", static: false, private: false, access: { has: obj => "defaultCategory" in obj, get: obj => obj.defaultCategory, set: (obj, value) => { obj.defaultCategory = value; } }, metadata: _metadata }, _defaultCategory_initializers, _defaultCategory_extraInitializers);
-        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
-        CommentPlugin = _classThis = _classDescriptor.value;
-        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
-        __runInitializers(_classThis, _classExtraInitializers);
-    })();
-    return CommentPlugin = _classThis;
 })();
-exports.CommentPlugin = CommentPlugin;
+export { CommentPlugin };
 function inTypeLiteral(refl) {
     while (refl) {
-        if (refl.kind === models_1.ReflectionKind.TypeLiteral) {
+        if (refl.kind === ReflectionKind.TypeLiteral) {
             return true;
         }
         refl = refl.parent;
     }
     return false;
 }
+function validHighlightedName(ref, name) {
+    const refl = ref.reflection;
+    // Assume external types are documented properly
+    if (!refl)
+        return true;
+    // If it is a direct child, it is valid.
+    if (refl.getChildByName([name]))
+        return true;
+    // Or if it is the child of the referenced reflection's type
+    if (refl.isDeclaration() && refl.type?.type === "reflection") {
+        if (refl.type.declaration.getChildByName([name])) {
+            return true;
+        }
+    }
+    return false;
+}
 // Moves tags like `@param foo.bar docs for bar` into the `bar` property of the `foo` parameter.
 function moveNestedParamTags(
 /* in-out */ paramTags, parameters, sourcePath) {
@@ -667,9 +642,9 @@ function moveNestedParamTags(
                 for (const tag of tags) {
                     const path = tag.name.split(".");
                     path.shift();
-                    const child = target.declaration.getChildByName(path);
+                    const child = target.declaration.getChildOrTypePropertyByName(path);
                     if (child && !child.comment) {
-                        child.comment = new models_1.Comment(models_1.Comment.cloneDisplayParts(tag.content));
+                        child.comment = new Comment(Comment.cloneDisplayParts(tag.content));
                         child.comment.sourcePath = sourcePath;
                         used.add(paramTags.indexOf(tag));
                     }
@@ -682,6 +657,21 @@ function moveNestedParamTags(
             intersection(i) {
                 i.types.forEach((t) => t.visit(visitor));
             },
+            // #2147, support highlighting parts of a referenced type
+            reference(ref) {
+                for (let i = 0; i < paramTags.length; ++i) {
+                    const tag = paramTags[i];
+                    if (tag.name?.startsWith(`${param.name}.`)) {
+                        const childName = tag.name.substring(param.name.length + 1);
+                        if (!validHighlightedName(ref, childName)) {
+                            continue;
+                        }
+                        ref.highlightedProperties ??= new Map();
+                        ref.highlightedProperties.set(childName, paramTags[i].content);
+                        used.add(i);
+                    }
+                }
+            },
         };
         param.type?.visit(visitor);
     }
@@ -701,11 +691,11 @@ function movePropertyTags(comment, container) {
             continue;
         const child = container.getChildByName(prop.name);
         if (child) {
-            child.comment = new models_1.Comment(models_1.Comment.cloneDisplayParts(prop.content));
+            child.comment = new Comment(Comment.cloneDisplayParts(prop.content));
             child.comment.sourcePath = comment.sourcePath;
-            if (child instanceof models_1.DeclarationReflection && child.signatures) {
+            if (child instanceof DeclarationReflection && child.signatures) {
                 for (const sig of child.signatures) {
-                    sig.comment = new models_1.Comment(models_1.Comment.cloneDisplayParts(prop.content));
+                    sig.comment = new Comment(Comment.cloneDisplayParts(prop.content));
                     sig.comment.sourcePath = comment.sourcePath;
                 }
             }