You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .README/rules/check-tag-names.md
+22-3Lines changed: 22 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,6 @@ memberof
47
47
memberof!
48
48
mixes
49
49
mixin
50
-
modifies (Currently undocumented but in source)
51
50
module
52
51
name
53
52
namespace
@@ -76,6 +75,8 @@ version
76
75
yields
77
76
```
78
77
78
+
`modifies` is also supported (see [source](https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/tag/dictionary/definitions.js#L594)) but is undocumented.
79
+
79
80
The following synonyms are also recognized:
80
81
81
82
```
@@ -108,12 +109,12 @@ one may also use the following:
108
109
template
109
110
```
110
111
111
-
And for [Closure](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler#nosideeffects-modifies-thisarguments),
112
+
And for [Closure](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler),
112
113
when `settings.jsdoc.mode` is set to `closure`, one may use the following (in
113
114
addition to the jsdoc and TypeScript tags):
114
115
115
116
```
116
-
define
117
+
define (synonym of `const` per jsdoc source)
117
118
dict
118
119
export
119
120
externs
@@ -128,11 +129,29 @@ nosideeffects
128
129
polymer
129
130
polymerBehavior
130
131
preserve
132
+
record (synonym of `interface` per jsdoc source)
131
133
struct
132
134
suppress
133
135
unrestricted
134
136
```
135
137
138
+
...and these undocumented tags which are only in [source](https://github.com/google/closure-compiler/blob/master/src/com/google/javascript/jscomp/parsing/Annotation.java):
139
+
140
+
```
141
+
closurePrimitive
142
+
customElement
143
+
expose
144
+
hidden
145
+
idGenerator
146
+
meaning
147
+
mixinClass
148
+
mixinFunction
149
+
ngInject
150
+
owner
151
+
typeSummary
152
+
wizaction
153
+
```
154
+
136
155
Note that the tags indicated as replacements in `settings.jsdoc.tagNamePreference` will automatically be considered as valid.
Copy file name to clipboardExpand all lines: README.md
+22-3Lines changed: 22 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1427,7 +1427,6 @@ memberof
1427
1427
memberof!
1428
1428
mixes
1429
1429
mixin
1430
-
modifies (Currently undocumented but in source)
1431
1430
module
1432
1431
name
1433
1432
namespace
@@ -1456,6 +1455,8 @@ version
1456
1455
yields
1457
1456
```
1458
1457
1458
+
`modifies` is also supported (see [source](https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/tag/dictionary/definitions.js#L594)) but is undocumented.
1459
+
1459
1460
The following synonyms are also recognized:
1460
1461
1461
1462
```
@@ -1488,12 +1489,12 @@ one may also use the following:
1488
1489
template
1489
1490
```
1490
1491
1491
-
And for [Closure](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler#nosideeffects-modifies-thisarguments),
1492
+
And for [Closure](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler),
1492
1493
when `settings.jsdoc.mode` is set to `closure`, one may use the following (in
1493
1494
addition to the jsdoc and TypeScript tags):
1494
1495
1495
1496
```
1496
-
define
1497
+
define (synonym of `const` per jsdoc source)
1497
1498
dict
1498
1499
export
1499
1500
externs
@@ -1508,11 +1509,29 @@ nosideeffects
1508
1509
polymer
1509
1510
polymerBehavior
1510
1511
preserve
1512
+
record (synonym of `interface` per jsdoc source)
1511
1513
struct
1512
1514
suppress
1513
1515
unrestricted
1514
1516
```
1515
1517
1518
+
...and these undocumented tags which are only in [source](https://github.com/google/closure-compiler/blob/master/src/com/google/javascript/jscomp/parsing/Annotation.java):
1519
+
1520
+
```
1521
+
closurePrimitive
1522
+
customElement
1523
+
expose
1524
+
hidden
1525
+
idGenerator
1526
+
meaning
1527
+
mixinClass
1528
+
mixinFunction
1529
+
ngInject
1530
+
owner
1531
+
typeSummary
1532
+
wizaction
1533
+
```
1534
+
1516
1535
Note that the tags indicated as replacements in `settings.jsdoc.tagNamePreference` will automatically be considered as valid.
0 commit comments