Function properties in type space are really properties

Resolves #1637.
TypeStrong · Jul 1, 2022 · 3622a81 · 3622a81
1 parent 98903d3
commit 3622a81
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ### Bug Fixes
 
+-   Function properties in type space will no longer be interpreted as methods, #1637.
 -   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.
 -   `intentionallyNotExported` will now properly respect qualified names, #1972.

diff --git a/src/lib/converter/plugins/ImplementsPlugin.ts b/src/lib/converter/plugins/ImplementsPlugin.ts
@@ -6,7 +6,7 @@ import {
     ReflectionKind,
     SignatureReflection,
 } from "../../models/reflections/index";
-import { ReferenceType, Type } from "../../models/types";
+import { ReferenceType, ReflectionType, Type } from "../../models/types";
 import { filterMap, zip } from "../../utils/array";
 import { Component, ConverterComponent } from "../components";
 import type { Context } from "../context";
@@ -468,6 +468,18 @@ function handleInheritedComments(
         for (const [cs, ps] of zip(child.signatures, parent.signatures)) {
             copyComment(cs, ps);
         }
+    } else if (
+        parent.kindOf(ReflectionKind.Property) &&
+        parent.type instanceof ReflectionType &&
+        parent.type.declaration.signatures &&
+        child.signatures
+    ) {
+        for (const [cs, ps] of zip(
+            child.signatures,
+            parent.type.declaration.signatures
+        )) {
+            copyComment(cs, ps);
+        }
     }
 }
 

diff --git a/src/lib/converter/symbols.ts b/src/lib/converter/symbols.ts
@@ -614,20 +614,6 @@ function convertProperty(
                 exportSymbol
             );
         }
-
-        // Special case: "arrow properties" in type space should be treated as methods.
-        if (
-            ts.isPropertySignature(declaration) &&
-            declaration.type &&
-            ts.isFunctionTypeNode(declaration.type)
-        ) {
-            return convertArrowAsMethod(
-                context,
-                symbol,
-                declaration.type,
-                exportSymbol
-            );
-        }
     }
 
     const reflection = context.createDeclarationReflection(
@@ -671,7 +657,7 @@ function convertProperty(
 function convertArrowAsMethod(
     context: Context,
     symbol: ts.Symbol,
-    arrow: ts.ArrowFunction | ts.FunctionTypeNode,
+    arrow: ts.ArrowFunction,
     exportSymbol?: ts.Symbol
 ) {
     const reflection = context.createDeclarationReflection(

diff --git a/src/test/issueTests.ts b/src/test/issueTests.ts
@@ -276,8 +276,14 @@ export const issueTests: {
     },
 
     gh1624(project) {
-        ok(
-            query(project, "Foo.baz").signatures?.[0]?.hasComment(),
+        // #1637
+        equal(query(project, "Bar.baz").kind, ReflectionKind.Property);
+
+        equal(
+            Comment.combineDisplayParts(
+                query(project, "Foo.baz").signatures?.[0]?.comment?.summary
+            ),
+            "Some property style doc.",
             "Property methods declared in interface should still allow comment inheritance"
         );
     },