Skip to content

Commit 15424f8

Browse files
committed
docs: generate docs
1 parent 2a605bf commit 15424f8

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1379,6 +1379,26 @@ function quux () {
13791379
}
13801380
// Settings: {"jsdoc":{"tagNamePreference":{"todo":55}}}
13811381
// Message: Invalid `settings.jsdoc.tagNamePreference`. Values must be falsy, a string, or an object.
1382+
1383+
/**
1384+
* @property {object} a
1385+
* @prop {boolean} b
1386+
*/
1387+
function quux () {
1388+
1389+
}
1390+
// Message: Invalid JSDoc tag (preference). Replace "prop" JSDoc tag with "property".
1391+
1392+
/**
1393+
* @abc foo
1394+
* @abcd bar
1395+
*/
1396+
function quux () {
1397+
1398+
}
1399+
// Settings: {"jsdoc":{"tagNamePreference":{"abc":"abcd"}}}
1400+
// Options: [{"definedTags":["abcd"]}]
1401+
// Message: Invalid JSDoc tag (preference). Replace "abc" JSDoc tag with "abcd".
13821402
````
13831403

13841404
The following patterns are not considered problems:

0 commit comments

Comments
 (0)