Skip to content

Add necessary use case of @link #2987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 8, 2024
Merged

Add necessary use case of @link #2987

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b75a01
add necessary use case of @link
zhangzhuang15 Dec 3, 2023
2d0ccc3
Merge branch 'microsoft:v2' into jasonzhang/improve-link-tag-jsdoc
zhangzhuang15 Oct 6, 2024
6dc9d7d
improve the expression in the necessary use case of @link
Oct 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions packages/documentation/copy/en/javascript/JSDoc Reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -663,6 +663,37 @@ function box<U>(u: U): Box<U> {
return { t: u };
}
```
sometimes, you don't want to link a type, instead, link a prop defined in a type:

```ts twoslash
type Pet = {
name: string
hello: () => string
}

/**
* Note: you should implement {@link Pet.hello} method of Pet.
*/
function hello(p: Pet) {
p.hello()
}
```

furthermore, you can define another name of link:

```ts twoslash
type Pet = {
name: string
hello: () => string
}

/**
* Note: you should implement {@link Pet.hello | hello} method of Pet.
*/
function hello(p: Pet) {
p.hello()
}
```

## Other

Expand Down