Skip to content

Commit 917888d

Browse files
committed
feat: Update supported jsdoc tags (fixes #163)
1 parent 23ba6b3 commit 917888d

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

.README/rules/check-tag-names.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Valid [JSDoc 3 Block Tags](http://usejsdoc.org/#block-tags) are:
88
abstract
99
access
1010
alias
11+
async
1112
augments
1213
author
1314
borrows
@@ -28,6 +29,7 @@ external
2829
file
2930
fires
3031
function
32+
generator
3133
global
3234
hideconstructor
3335
ignore
@@ -48,6 +50,7 @@ module
4850
name
4951
namespace
5052
override
53+
package
5154
param
5255
private
5356
property
@@ -68,6 +71,7 @@ type
6871
typedef
6972
variation
7073
version
74+
yields
7175
```
7276

7377
|||

src/tagNames.js

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ export default {
4545
'func',
4646
'method'
4747
],
48+
generator: [],
4849
global: [],
4950
hideconstructor: [],
5051
ignore: [],
@@ -67,6 +68,7 @@ export default {
6768
name: [],
6869
namespace: [],
6970
override: [],
71+
package: [],
7072
param: [
7173
'arg',
7274
'argument'
@@ -95,5 +97,8 @@ export default {
9597
type: [],
9698
typedef: [],
9799
variation: [],
98-
version: []
100+
version: [],
101+
yields: [
102+
'yield'
103+
]
99104
};

0 commit comments

Comments
 (0)