Improve support for inheriting documentation from accessors

Resolves #1968

CHANGELOG.md

@@ -3,6 +3,11 @@
 ### Bug Fixes
 
 -   TypeDoc will no longer crash if a comment contains an empty `@example` tag, #1967.
+-   TypeDoc will now detect attempted inheritance from accessors and inherit from the getter or setter, #1968.
+
+### Features
+
+-   Added support for TypeDoc specific `:getter` and `:setter` meaning keywords in declaration references.
 
 ## v0.23.2 (2022-06-28)
 

src/lib/converter/comments/declarationReference.ts

@@ -23,6 +23,10 @@ export const MeaningKeywords = [
     "new", // SymbolFlags.Signature (for __new)
     "index", // SymbolFlags.Signature (for __index)
     "complex", // Any complex type
+
+    // TypeDoc specific
+    "getter",
+    "setter",
 ] as const;
 export type MeaningKeyword = typeof MeaningKeywords[number];
 

src/lib/converter/comments/declarationReferenceResolver.ts

@@ -5,7 +5,7 @@ import {
     Reflection,
     ReflectionKind,
 } from "../../models";
-import { filterMap } from "../../utils";
+import { assertNever, filterMap } from "../../utils";
 import type {
     ComponentPath,
     DeclarationReference,
@@ -166,6 +166,21 @@ function resolveKeyword(
         case "complex":
             if (refl.kindOf(ReflectionKind.SomeType)) return [refl];
             break;
+
+        case "getter":
+            if ((refl as DeclarationReflection).getSignature) {
+                return [(refl as DeclarationReflection).getSignature!];
+            }
+            break;
+
+        case "setter":
+            if ((refl as DeclarationReflection).setSignature) {
+                return [(refl as DeclarationReflection).setSignature!];
+            }
+            break;
+
+        default:
+            assertNever(kw);
     }
 }
 

src/lib/converter/plugins/InheritDocPlugin.ts

@@ -1,6 +1,7 @@
 import {
     Comment,
     DeclarationReflection,
+    ReflectionKind,
     SignatureReflection,
 } from "../../models";
 import { Component, ConverterComponent } from "../components";
@@ -77,6 +78,16 @@ export class InheritDocPlugin extends ConverterComponent {
                 }
             }
 
+            if (
+                sourceRefl instanceof DeclarationReflection &&
+                sourceRefl.kindOf(ReflectionKind.Accessor)
+            ) {
+                // Accessors, like functions, never have comments on their actual root reflection.
+                // If the user didn't specify whether to inherit from the getter or setter, then implicitly
+                // try to inherit from the getter, #1968.
+                sourceRefl = sourceRefl.getSignature || sourceRefl.setSignature;
+            }
+
             if (!sourceRefl) {
                 this.application.logger.warn(
                     `Failed to find "${source}" to inherit the comment from in the comment for ${reflection.getFullName()}`

src/test/converter2/issues/gh1968.ts

@@ -0,0 +1,19 @@
+export class Foo {
+    /** getter */
+    get x() {
+        return 1;
+    }
+    /** setter */
+    set x(value: number) {
+        throw new Error();
+    }
+}
+
+export class Bar {
+    /** {@inheritDoc Foo.x} */
+    x = 1;
+    /** {@inheritDoc Foo.x:getter} */
+    y = 2;
+    /** {@inheritDoc Foo.x:setter} */
+    z = 3;
+}

src/test/issueTests.ts

@@ -548,4 +548,11 @@ export const issueTests: {
             },
         ]);
     },
+
+    gh1968(project) {
+        const comments = ["Bar.x", "Bar.y", "Bar.z"].map((n) =>
+            Comment.combineDisplayParts(query(project, n).comment?.summary)
+        );
+        equal(comments, ["getter", "getter", "setter"]);
+    },
 };