Skip to content

Commit

Permalink
docs(valid-types): update namepath-accepting listing; fixes #401
Browse files Browse the repository at this point in the history
  • Loading branch information
brettz9 committed Feb 2, 2023
1 parent 5db0241 commit 784e351
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
7 changes: 4 additions & 3 deletions .README/rules/valid-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ The following tags have their name/namepath portion (the non-whitespace
text after the tag name) checked:

1. Name(path)-defining tags requiring namepath: `@event`, `@callback`,
`@external`, `@host`, `@name`, `@typedef`, and `@template`
`@exports` (JSDoc only),
`@external`, `@host`, `@name`, `@typedef` (JSDoc only), and `@template`
(TypeScript/Closure only); `@param` (`@arg`, `@argument`) and `@property`
(`@prop`) also fall into this category, but while this rule will check
their namepath validity, we leave the requiring of the name portion
Expand All @@ -41,11 +42,11 @@ text after the tag name) checked:
1. Name(path)-defining tags (which may have value without namepath or their
namepath can be expressed elsewhere on the block):
`@class`, `@constructor`, `@constant`, `@const`, `@function`, `@func`,
`@method`, `@interface` (TypeScript tag only), `@member`, `@var`,
`@method`, `@interface` (non-Closure only), `@member`, `@var`,
`@mixin`, `@namespace`, `@module` (module paths are not planned for
TypeScript)
1. Name(path)-pointing tags requiring namepath: `@alias`, `@augments`,
`@extends`, `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@this`
`@extends` (JSDoc only), `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@requires`, `@this`
(jsdoc only)
1. Name(path)-pointing tags (which may have value without namepath or their
namepath can be expressed elsewhere on the block): `@listens`, `@fires`,
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22635,7 +22635,8 @@ The following tags have their name/namepath portion (the non-whitespace
text after the tag name) checked:

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

0 comments on commit 784e351

Please sign in to comment.