Skip to content

Commit 5d26aba

Browse files
README section for root identifier link tag support
1 parent 3793aed commit 5d26aba

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,39 @@ When assigned to a variable in the exporting module:
7070

7171
This syntax is also used when referring to types of `@typedef`s and `@enum`s.
7272

73+
### `@link` tags
74+
75+
```js
76+
/**
77+
* {@link Identifier}
78+
*/
79+
80+
/**
81+
* {@link Identifier Link text}
82+
*/
83+
84+
/**
85+
* {@link Identifier.member}
86+
*/
87+
```
88+
89+
To:
90+
91+
```js
92+
/**
93+
* {@link module:path/to/module.Identifier Identifier}
94+
*/
95+
96+
/**
97+
* {@link module:path/to/module.Identifier Link text}
98+
*/
99+
100+
/**
101+
* Member accessors are not currently linked to, just the root identifier:
102+
* {@link module:path/to/module.Identifier Identifier.member}
103+
*/
104+
```
105+
73106
### `typeof type`
74107

75108
```js
@@ -165,6 +198,7 @@ To:
165198
```
166199

167200
To:
201+
168202
```js
169203
/**
170204
* @type {Array}

0 commit comments

Comments
 (0)