Fix JSDoc inheritance for overridden methods and properties in hover

internal/checker/exports.go

@@ -62,6 +62,10 @@ func (c *Checker) GetPropertyOfType(t *Type, name string) *ast.Symbol {
 	return c.getPropertyOfType(t, name)
 }
 
+func (c *Checker) GetBaseTypes(t *Type) []*Type {
+	return c.getBaseTypes(t)
+}
+
 func (c *Checker) TypeHasCallOrConstructSignatures(t *Type) bool {
 	return c.typeHasCallOrConstructSignatures(t)
 }

internal/fourslash/tests/hoverInheritedJSDoc_test.go

@@ -0,0 +1,61 @@
+package fourslash_test
+
+import (
+	"testing"
+
+	"github.com/microsoft/typescript-go/internal/fourslash"
+	"github.com/microsoft/typescript-go/internal/testutil"
+)
+
+func TestHoverInheritedJSDocInterface(t *testing.T) {
+	t.Parallel()
+	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
+	const content = `
+interface foo {
+  /** base jsdoc */
+  bar(k: string): number;
+  /** other jsdoc */
+  other: 24;
+}
+
+interface bar extends foo {
+  bar(k: string | symbol): number | 99;
+}
+
+declare const f: foo;
+declare const b: bar;
+
+f./*1*/bar;
+f./*2*/other;
+b./*3*/bar;
+b./*4*/other;
+`
+	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
+	f.VerifyBaselineHover(t)
+}
+
+func TestHoverInheritedJSDocClass(t *testing.T) {
+	t.Parallel()
+	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
+	const content = `
+declare class thing {
+  /** doc comment */
+  method(s: string): void;
+}
+
+declare class potato extends thing {
+  method(s: "1234"): void;
+}
+
+declare const t: thing;
+declare const p: potato;
+
+t./*1*/method;
+p./*2*/method;
+`
+	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
+	// t.method should show "doc comment"
+	f.VerifyQuickInfoAt(t, "1", "(method) thing.method(s: string): void", "doc comment")
+	// p.method should inherit "doc comment" from thing
+	f.VerifyQuickInfoAt(t, "2", "(method) potato.method(s: \"1234\"): void", "doc comment")
+}

internal/ls/hover.go

@@ -59,16 +59,23 @@ func (l *LanguageService) getQuickInfoAndDocumentationForSymbol(c *checker.Check
 	if quickInfo == "" {
 		return "", ""
 	}
-	return quickInfo, l.getDocumentationFromDeclaration(c, declaration, contentFormat)
+	return quickInfo, l.getDocumentationFromDeclaration(c, symbol, declaration, contentFormat)
 }
 
-func (l *LanguageService) getDocumentationFromDeclaration(c *checker.Checker, declaration *ast.Node, contentFormat lsproto.MarkupKind) string {
+func (l *LanguageService) getDocumentationFromDeclaration(c *checker.Checker, symbol *ast.Symbol, declaration *ast.Node, contentFormat lsproto.MarkupKind) string {
 	if declaration == nil {
 		return ""
 	}
 	isMarkdown := contentFormat == lsproto.MarkupKindMarkdown
 	var b strings.Builder
-	if jsdoc := getJSDocOrTag(declaration); jsdoc != nil && !containsTypedefTag(jsdoc) {
+	jsdoc := getJSDocOrTag(declaration)
+
+	// If there's no JSDoc on the current declaration, try to find it in base types
+	if jsdoc == nil && symbol != nil && symbol.Parent != nil {
+		jsdoc = l.getJSDocFromBaseTypes(c, symbol)
+	}
+
+	if jsdoc != nil && !containsTypedefTag(jsdoc) {
 		l.writeComments(&b, c, jsdoc.Comments(), isMarkdown)
 		if jsdoc.Kind == ast.KindJSDoc {
 			if tags := jsdoc.AsJSDoc().Tags; tags != nil {
@@ -561,3 +568,52 @@ func writeEntityNameParts(b *strings.Builder, node *ast.Node) {
 		writeEntityNameParts(b, node.Name())
 	}
 }
+
+// getJSDocFromBaseTypes searches for JSDoc comments in base types when the current symbol doesn't have one
+func (l *LanguageService) getJSDocFromBaseTypes(c *checker.Checker, symbol *ast.Symbol) *ast.Node {
+	if symbol == nil || symbol.Parent == nil {
+		return nil
+	}
+
+	// Get the parent type (the class or interface containing this symbol)
+	parentType := c.GetDeclaredTypeOfSymbol(symbol.Parent)
+	if parentType == nil {
+		return nil
+	}
+
+	// Only class and interface types have base types
+	if symbol.Parent.Flags&(ast.SymbolFlagsClass|ast.SymbolFlagsInterface) == 0 {
+		return nil
+	}
+
+	// Get base types (parent classes or extended interfaces)
+	baseTypes := c.GetBaseTypes(parentType)
+	if len(baseTypes) == 0 {
+		return nil
+	}
+
+	// Search each base type for a property/method with the same name
+	symbolName := symbol.Name
+	for _, baseType := range baseTypes {
+		// Get the property from the base type
+		baseProp := c.GetPropertyOfType(baseType, symbolName)
+		if baseProp == nil {
+			continue
+		}
+
+		// Check if the base property has a declaration with JSDoc
+		if baseProp.ValueDeclaration != nil {
+			if jsdoc := getJSDocOrTag(baseProp.ValueDeclaration); jsdoc != nil {
+				return jsdoc
+			}
+		}
+
+		// If not found in this base, recursively check its bases
+		if jsdoc := l.getJSDocFromBaseTypes(c, baseProp); jsdoc != nil {
+			return jsdoc
+		}
+	}
+
+	return nil
+}
+

internal/ls/signaturehelp.go

@@ -316,7 +316,7 @@ func (l *LanguageService) getSignatureHelpItem(candidate *checker.Signature, isT
 	// Generate documentation from the signature's declaration
 	var documentation *string
 	if declaration := candidate.Declaration(); declaration != nil {
-		doc := l.getDocumentationFromDeclaration(c, declaration, docFormat)
+		doc := l.getDocumentationFromDeclaration(c, nil, declaration, docFormat)
 		if doc != "" {
 			documentation = &doc
 		}

testdata/baselines/reference/fourslash/quickInfo/hoverInheritedJSDocInterface.baseline

@@ -0,0 +1,159 @@
+// === QuickInfo ===
+=== /hoverInheritedJSDocInterface.ts ===
+// interface foo {
+//   /** base jsdoc */
+//   bar(k: string): number;
+//   /** other jsdoc */
+//   other: 24;
+// }
+// 
+// interface bar extends foo {
+//   bar(k: string | symbol): number | 99;
+// }
+// 
+// declare const f: foo;
+// declare const b: bar;
+// 
+// f.bar;
+//   ^^^
+// | ----------------------------------------------------------------------
+// | ```tsx
+// | (method) foo.bar(k: string): number
+// | ```
+// | base jsdoc
+// | ----------------------------------------------------------------------
+// f.other;
+//   ^^^^^
+// | ----------------------------------------------------------------------
+// | ```tsx
+// | (property) foo.other: 24
+// | ```
+// | other jsdoc
+// | ----------------------------------------------------------------------
+// b.bar;
+//   ^^^
+// | ----------------------------------------------------------------------
+// | ```tsx
+// | (method) bar.bar(k: string | symbol): number
+// | ```
+// | base jsdoc
+// | ----------------------------------------------------------------------
+// b.other;
+//   ^^^^^
+// | ----------------------------------------------------------------------
+// | ```tsx
+// | (property) foo.other: 24
+// | ```
+// | other jsdoc
+// | ----------------------------------------------------------------------
+// 
+[
+  {
+    "marker": {
+      "Position": 217,
+      "LSPosition": {
+        "line": 14,
+        "character": 2
+      },
+      "Name": "1",
+      "Data": {}
+    },
+    "item": {
+      "contents": {
+        "kind": "markdown",
+        "value": "```tsx\n(method) foo.bar(k: string): number\n```\nbase jsdoc"
+      },
+      "range": {
+        "start": {
+          "line": 14,
+          "character": 2
+        },
+        "end": {
+          "line": 14,
+          "character": 5
+        }
+      }
+    }
+  },
+  {
+    "marker": {
+      "Position": 224,
+      "LSPosition": {
+        "line": 15,
+        "character": 2
+      },
+      "Name": "2",
+      "Data": {}
+    },
+    "item": {
+      "contents": {
+        "kind": "markdown",
+        "value": "```tsx\n(property) foo.other: 24\n```\nother jsdoc"
+      },
+      "range": {
+        "start": {
+          "line": 15,
+          "character": 2
+        },
+        "end": {
+          "line": 15,
+          "character": 7
+        }
+      }
+    }
+  },
+  {
+    "marker": {
+      "Position": 233,
+      "LSPosition": {
+        "line": 16,
+        "character": 2
+      },
+      "Name": "3",
+      "Data": {}
+    },
+    "item": {
+      "contents": {
+        "kind": "markdown",
+        "value": "```tsx\n(method) bar.bar(k: string | symbol): number\n```\nbase jsdoc"
+      },
+      "range": {
+        "start": {
+          "line": 16,
+          "character": 2
+        },
+        "end": {
+          "line": 16,
+          "character": 5
+        }
+      }
+    }
+  },
+  {
+    "marker": {
+      "Position": 240,
+      "LSPosition": {
+        "line": 17,
+        "character": 2
+      },
+      "Name": "4",
+      "Data": {}
+    },
+    "item": {
+      "contents": {
+        "kind": "markdown",
+        "value": "```tsx\n(property) foo.other: 24\n```\nother jsdoc"
+      },
+      "range": {
+        "start": {
+          "line": 17,
+          "character": 2
+        },
+        "end": {
+          "line": 17,
+          "character": 7
+        }
+      }
+    }
+  }
+]

testdata/baselines/reference/fourslash/quickInfo/jsdocOnInheritedMembers1.baseline

@@ -18,7 +18,7 @@
 // | ```tsx
 // | (method) B.method(): void
 // | ```
-// | 
+// | Method documentation.
 // | ----------------------------------------------------------------------
 [
   {
@@ -34,7 +34,7 @@
     "item": {
       "contents": {
         "kind": "markdown",
-        "value": "```tsx\n(method) B.method(): void\n```\n"
+        "value": "```tsx\n(method) B.method(): void\n```\nMethod documentation."
       },
       "range": {
         "start": {

testdata/baselines/reference/fourslash/quickInfo/jsdocOnInheritedMembers2.baseline

@@ -18,7 +18,7 @@
 // | ```tsx
 // | (method) B.method(): void
 // | ```
-// | 
+// | Method documentation.
 // | ----------------------------------------------------------------------
 [
   {
@@ -34,7 +34,7 @@
     "item": {
       "contents": {
         "kind": "markdown",
-        "value": "```tsx\n(method) B.method(): void\n```\n"
+        "value": "```tsx\n(method) B.method(): void\n```\nMethod documentation."
       },
       "range": {
         "start": {