Skip to content

Commit bd0684a

Browse files
committed
docs: generate docs
1 parent 54d8bec commit bd0684a

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

README.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4198,16 +4198,25 @@ Requires all types to be valid JSDoc or Closure compiler types without syntax er
41984198

41994199
Also impacts behaviors on namepath (or event)-defining and pointing tags:
42004200

4201-
1. Name(path)-defining tags: `@class`, `@constructor`, `@constant`, `@const`, `@external`, `@host`, `@function`, `@func`, `@method`, `@interface`, `@member`, `@var`, `@mixin`, `@name`, `@namespace`, `@typedef`
4202-
1. Name(path)-pointing tags: `@alias`, `@augments`, `@extends`, `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@this`
4203-
1. Name(path)-defining tags (which may have value without namepath): `@callback`, `@event`
4204-
1. Name(path)-pointing tags (which may have value without namepath): `@listens`, `@fires`, `@emits`
4201+
1. Name(path)-defining tags requiring namepath: `@external`, `@host`, `@name`, `@typedef`
4202+
1. Name(path)-defining tags (which may have value without namepath or their
4203+
namepath can be expressed elsewhere on the block): `@event`, `@callback`,
4204+
`@class`, `@constructor`, `@constant`, `@const`,
4205+
`@function`, `@func`, `@method`, `@interface`, `@member`, `@var`,
4206+
`@mixin`, `@namespace`
4207+
1. Name(path)-pointing tags requiring namepath: `@alias`, `@augments`, `@extends`, `@lends`, `@memberof`, `@memberof!`, `@mixes`, `@this`
4208+
1. Name(path)-pointing tags (which may have value without namepath or their
4209+
namepath can be expressed elsewhere on the block): `@listens`, `@fires`,
4210+
`@emits`
42054211
1. Name(path)-pointing tags (multiple names in one): `@borrows`
42064212

42074213
...with the following applying to the above sets:
42084214

42094215
- Expect tags in set 1-4 to have a valid namepath if present
4210-
- 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)
4216+
- Prevent sets 2 and 4 from being empty by setting `allowEmptyNamepaths` to
4217+
`false` as these tags might have some indicative value without a path
4218+
or may allow a name expressed elsewhere on the block (but sets 1 and 3 will
4219+
always fail if empty)
42114220
- 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.
42124221

42134222
|||
@@ -4319,7 +4328,7 @@ function quux() {
43194328
}
43204329

43214330
/**
4322-
* @alias module:svgcanvas.SvgCanvas#event:ext_langReady
4331+
* @alias module:namespace.SomeClass#event:ext_anevent
43234332
*/
43244333
function quux() {
43254334

@@ -4332,11 +4341,26 @@ function quux() {
43324341

43334342
}
43344343

4344+
/**
4345+
* @class
4346+
*/
4347+
function quux() {
4348+
4349+
}
4350+
43354351
/**
43364352
* @see {@link foo}
43374353
*/
43384354
function quux() {
43394355

4356+
}
4357+
4358+
/**
4359+
*
4360+
* @fires {module:namespace.SomeClass#event:ext_anevent}
4361+
*/
4362+
function quux() {
4363+
43404364
}
43414365
````
43424366

0 commit comments

Comments
 (0)