Skip to content

Commit 34da0dd

Browse files
committed
docs: generate docs
1 parent e4b5dcb commit 34da0dd

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3396,17 +3396,19 @@ const language = {
33963396

33973397
Requires all types to be valid JSDoc or Closure compiler types without syntax errors.
33983398

3399-
Also impacts behaviors on namepath-pointing or event-pointing tags:
3399+
Also impacts behaviors on namepath (or event)-defining and pointing tags:
34003400

3401-
1. `@alias`, `@augments`, `@extends`, `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@name`, `@this`
3402-
1. `@callback`, `@event`, `@listens`, `@fires`, `@emits`
3403-
1. `@borrows`
3401+
1. Name(path)-defining tags: `@class`, `@constructor`, `@constant`, `@const`, `@external`, `@host`, `@function`, `@func`, `@method`, `@interface`, `@member`, `@var`, `@mixin`, `@name`, `@namespace`, `@typedef`
3402+
1. Name(path)-pointing tags: `@alias`, `@augments`, `@extends`, `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@this`
3403+
1. Name(path)-defining tags (which may have value without namepath): `@callback`, `@event`
3404+
1. Name(path)-pointing tags (which may have value without namepath): `@listens`, `@fires`, `@emits`
3405+
1. Name(path)-pointing tags (multiple names in one): `@borrows`
34043406

34053407
The following apply to the above sets:
34063408

3407-
- Expect tags in set 1 or 2 to have a valid namepath if present
3408-
- Prevent set 2 from being empty by setting `allowEmptyNamepaths` to `false` as these tags might have some indicative value without a path (but set 1 will always fail if empty)
3409-
- For the special case of set 3, i.e., `@borrows <that namepath> as <this namepath>`, check that both namepaths are present and valid and ensure there is an `as ` between them.
3409+
- Expect tags in set 1-4 to have a valid namepath if present
3410+
- Prevent sets 3-4 from being empty by setting `allowEmptyNamepaths` to `false` as these tags might have some indicative value without a path (but sets 1-2 will always fail if empty)
3411+
- For the special case of set 5, i.e., `@borrows <that namepath> as <this namepath>`, check that both namepaths are present and valid and ensure there is an `as ` between them.
34103412

34113413
|||
34123414
|---|---|

0 commit comments

Comments
 (0)