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
@@ -1451,7 +1451,6 @@ memberof
1451
1451
memberof!
1452
1452
mixes
1453
1453
mixin
1454
-
modifies (Currently undocumented but in source)
1455
1454
module
1456
1455
name
1457
1456
namespace
@@ -1480,6 +1479,8 @@ version
1480
1479
yields
1481
1480
```
1482
1481
1482
+
`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.
1483
+
1483
1484
The following synonyms are also recognized:
1484
1485
1485
1486
```
@@ -1512,12 +1513,12 @@ one may also use the following:
1512
1513
template
1513
1514
```
1514
1515
1515
-
And for [Closure](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler#nosideeffects-modifies-thisarguments),
1516
+
And for [Closure](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler),
1516
1517
when `settings.jsdoc.mode` is set to `closure`, one may use the following (in
1517
1518
addition to the jsdoc and TypeScript tags):
1518
1519
1519
1520
```
1520
-
define
1521
+
define (synonym of `const` per jsdoc source)
1521
1522
dict
1522
1523
export
1523
1524
externs
@@ -1532,11 +1533,29 @@ nosideeffects
1532
1533
polymer
1533
1534
polymerBehavior
1534
1535
preserve
1536
+
record (synonym of `interface` per jsdoc source)
1535
1537
struct
1536
1538
suppress
1537
1539
unrestricted
1538
1540
```
1539
1541
1542
+
...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):
1543
+
1544
+
```
1545
+
closurePrimitive
1546
+
customElement
1547
+
expose
1548
+
hidden
1549
+
idGenerator
1550
+
meaning
1551
+
mixinClass
1552
+
mixinFunction
1553
+
ngInject
1554
+
owner
1555
+
typeSummary
1556
+
wizaction
1557
+
```
1558
+
1540
1559
Note that the tags indicated as replacements in `settings.jsdoc.tagNamePreference` will automatically be considered as valid.
0 commit comments