Skip to content

Commit 2619665

Browse files
authored
feat: Update supported jsdoc tags (fixes #163)
feat: Update supported jsdoc tags (fixes #163)
2 parents 692d4b9 + a1d0dca commit 2619665

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-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
|||

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -674,6 +674,7 @@ Valid [JSDoc 3 Block Tags](http://usejsdoc.org/#block-tags) are:
674674
abstract
675675
access
676676
alias
677+
async
677678
augments
678679
author
679680
borrows
@@ -694,6 +695,7 @@ external
694695
file
695696
fires
696697
function
698+
generator
697699
global
698700
hideconstructor
699701
ignore
@@ -714,6 +716,7 @@ module
714716
name
715717
namespace
716718
override
719+
package
717720
param
718721
private
719722
property
@@ -734,6 +737,7 @@ type
734737
typedef
735738
variation
736739
version
740+
yields
737741
```
738742

739743
|||

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)