microsoft / microsoft/TypeScript

`{@link Class.name}` resolves wrongly to `Function.name`

Open
#61,433 4 comments 1 reaction 1 assignee Claimed by @sandersn View on GitHub
Needs Investigation
Dominant language
Go
Stars
111k
Forks
14.3k
PR merge metrics
PR metrics pending

Description

### 🔎 Search Terms

JSDoc, TSDoc, Link, Resolve, Name

### 🕗 Version & Regression Information

- This is the behavior in every version I tried, and I reviewed the FAQ for entries

### ⏯ Playground Link

https://www.typescriptlang.org/play/?ts=5.8.0-dev.20250215#code/MYGwhgzhAEAqCmEAu0DeBYAUNH0D0AVAVrjgdABLwggD2JpBeDOAdmALbwBcyATgEtWAc2gBeaACIEySVgC+WLIWLZyqAAIghAaziIkAOnZdFa5pgBmAV1bAkA2q2hgAFEm4ykASjQtofPBI1nzORibwANwKQA

### 💻 Code

```ts
class Test {
/**
* Hello
*/
name:string = "Test"
}

/**
* {@link Test.name}
*/
function a(t:Test) {
return t.name;
}
```

### 🙁 Actual behavior

The `Test.name` reference in the JSDoc/TSDoc resolves to the symbol `Function.name`. This is not correct because the `Test` class has an own property declaration for `name`.

In my real world usecase am generating markdowns from my typescript code via TypeScript compiler API and I get the wrong symbol using `typeChecker.getSymbolAtLocation(tsDocLinkNode.name)` leading to wrong documentation links.

![Image](https://github.com/user-attachments/assets/cc671d23-07b4-4aea-8529-15e1608a7a81)

### 🙂 Expected behavior

The correct documentation of my `name` property should be shown.

The typeChecker should resolve this expression to the correct symbol to allow tooling to resolve these cross references and link to the respective documentation page.

### Additional information about the issue

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.