Skip to content

Commit 784e351

Browse files
committed
docs(valid-types): update namepath-accepting listing; fixes #401
1 parent 5db0241 commit 784e351

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

.README/rules/valid-types.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ The following tags have their name/namepath portion (the non-whitespace
3232
text after the tag name) checked:
3333

3434
1. Name(path)-defining tags requiring namepath: `@event`, `@callback`,
35-
`@external`, `@host`, `@name`, `@typedef`, and `@template`
35+
`@exports` (JSDoc only),
36+
`@external`, `@host`, `@name`, `@typedef` (JSDoc only), and `@template`
3637
(TypeScript/Closure only); `@param` (`@arg`, `@argument`) and `@property`
3738
(`@prop`) also fall into this category, but while this rule will check
3839
their namepath validity, we leave the requiring of the name portion
@@ -41,11 +42,11 @@ text after the tag name) checked:
4142
1. Name(path)-defining tags (which may have value without namepath or their
4243
namepath can be expressed elsewhere on the block):
4344
`@class`, `@constructor`, `@constant`, `@const`, `@function`, `@func`,
44-
`@method`, `@interface` (TypeScript tag only), `@member`, `@var`,
45+
`@method`, `@interface` (non-Closure only), `@member`, `@var`,
4546
`@mixin`, `@namespace`, `@module` (module paths are not planned for
4647
TypeScript)
4748
1. Name(path)-pointing tags requiring namepath: `@alias`, `@augments`,
48-
`@extends`, `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@this`
49+
`@extends` (JSDoc only), `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@requires`, `@this`
4950
(jsdoc only)
5051
1. Name(path)-pointing tags (which may have value without namepath or their
5152
namepath can be expressed elsewhere on the block): `@listens`, `@fires`,

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22635,7 +22635,8 @@ The following tags have their name/namepath portion (the non-whitespace
2263522635
text after the tag name) checked:
2263622636

2263722637
1. Name(path)-defining tags requiring namepath: `@event`, `@callback`,
22638-
`@external`, `@host`, `@name`, `@typedef`, and `@template`
22638+
`@exports` (JSDoc only),
22639+
`@external`, `@host`, `@name`, `@typedef` (JSDoc only), and `@template`
2263922640
(TypeScript/Closure only); `@param` (`@arg`, `@argument`) and `@property`
2264022641
(`@prop`) also fall into this category, but while this rule will check
2264122642
their namepath validity, we leave the requiring of the name portion
@@ -22644,11 +22645,11 @@ text after the tag name) checked:
2264422645
1. Name(path)-defining tags (which may have value without namepath or their
2264522646
namepath can be expressed elsewhere on the block):
2264622647
`@class`, `@constructor`, `@constant`, `@const`, `@function`, `@func`,
22647-
`@method`, `@interface` (TypeScript tag only), `@member`, `@var`,
22648+
`@method`, `@interface` (non-Closure only), `@member`, `@var`,
2264822649
`@mixin`, `@namespace`, `@module` (module paths are not planned for
2264922650
TypeScript)
2265022651
1. Name(path)-pointing tags requiring namepath: `@alias`, `@augments`,
22651-
`@extends`, `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@this`
22652+
`@extends` (JSDoc only), `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@requires`, `@this`
2265222653
(jsdoc only)
2265322654
1. Name(path)-pointing tags (which may have value without namepath or their
2265422655
namepath can be expressed elsewhere on the block): `@listens`, `@fires`,

0 commit comments

Comments
 (0)