Skip to content

Commit 4549593

Browse files
committed
docs: generate docs
1 parent 4f71560 commit 4549593

File tree

1 file changed

+54
-9
lines changed

1 file changed

+54
-9
lines changed

README.md

Lines changed: 54 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6373,7 +6373,35 @@ function quux() {
63736373

63746374
}
63756375
// Settings: {"jsdoc":{"allowEmptyNamepaths":false}}
6376-
// Message: Syntax error in type:
6376+
// Message: Tag @callback must have a namepath
6377+
6378+
/**
6379+
* @constant {str%ng}
6380+
*/
6381+
const FOO = 'foo';
6382+
// Message: Syntax error in type: str%ng
6383+
6384+
/**
6385+
* @typedef {str%ng} UserString
6386+
*/
6387+
// Message: Syntax error in type: str%ng
6388+
6389+
/**
6390+
* @typedef {string} UserStr%ng
6391+
*/
6392+
// Message: Syntax error in type: UserStr%ng
6393+
6394+
/**
6395+
* @extends
6396+
*/
6397+
class Bar {};
6398+
// Message: Tag @extends must have either a type or namepath
6399+
6400+
/**
6401+
* @type
6402+
*/
6403+
let foo;
6404+
// Message: Tag @type must have a type
63776405
````
63786406

63796407
The following patterns are not considered problems:
@@ -6414,13 +6442,6 @@ function quux() {
64146442

64156443
}
64166444

6417-
/**
6418-
* @see foo%
6419-
*/
6420-
function quux() {
6421-
6422-
}
6423-
64246445
/**
64256446
* @alias module:namespace.SomeClass#event:ext_anevent
64266447
*/
@@ -6429,7 +6450,7 @@ function quux() {
64296450
}
64306451

64316452
/**
6432-
* @callback
6453+
* @callback foo
64336454
*/
64346455
function quux() {
64356456

@@ -6477,6 +6498,30 @@ function quux() {
64776498
function quux() {
64786499

64796500
}
6501+
6502+
/**
6503+
* @constant {string}
6504+
*/
6505+
const FOO = 'foo';
6506+
6507+
/**
6508+
* @extends Foo
6509+
*/
6510+
class Bar {};
6511+
6512+
/**
6513+
* @extends {Foo<String>}
6514+
*/
6515+
class Bar {};
6516+
6517+
/**
6518+
* @typedef {number|string} UserDefinedType
6519+
*/
6520+
6521+
/**
6522+
* @typedef {number|string}
6523+
*/
6524+
let UserDefinedGCCType;
64806525
````
64816526

64826527

0 commit comments

Comments
 (0)