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/README.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,6 +88,12 @@ You can then selectively add to or override the recommended rules.
88
88
-`settings.jsdoc.ignorePrivate` - Disables all rules for the comment block
89
89
on which a `@private` tag occurs. Defaults to `false`.
90
90
91
+
### Mode
92
+
93
+
-`settings.jsdoc.mode` - Set to `jsdoc` (the default), `typescript`, or `closure`.
94
+
Currently is used for checking preferred tag names and in the `check-tag-names`
95
+
rule.
96
+
91
97
### Alias Preference
92
98
93
99
Use `settings.jsdoc.tagNamePreference` to configure a preferred alias name for a JSDoc tag. The format of the configuration is: `<primary tag name>: <preferred alias name>`, e.g.
Copy file name to clipboardExpand all lines: .README/rules/check-tag-names.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -101,14 +101,16 @@ yield
101
101
```
102
102
103
103
For [TypeScript](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html#supported-jsdoc)
104
-
(or Closure), one may also use the following:
104
+
(or Closure), when `settings.jsdoc.mode` is set to `typescript` or `closure`,
105
+
one may also use the following:
105
106
106
107
```
107
108
template
108
109
```
109
110
110
111
And for [Closure](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler#nosideeffects-modifies-thisarguments),
111
-
one may also use:
112
+
when `settings.jsdoc.mode` is set to `closure`, one may use the following (in
113
+
addition to the jsdoc and TypeScript tags):
112
114
113
115
```
114
116
define
@@ -128,7 +130,6 @@ polymerBehavior
128
130
preserve
129
131
struct
130
132
suppress
131
-
template
132
133
unrestricted
133
134
```
134
135
@@ -138,7 +139,7 @@ Note that the tags indicated as replacements in `settings.jsdoc.tagNamePreferenc
138
139
139
140
##### `definedTags`
140
141
141
-
Use an array of `definedTags` strings to configure additional, allowed JSDoc tags.
142
+
Use an array of `definedTags` strings to configure additional, allowed tags.
*[`@override`/`@augments`/`@extends`/`@implements` Without Accompanying `@param`/`@description`/`@example`/`@returns`](#eslint-plugin-jsdoc-settings-override-augments-extends-implements-without-accompanying-param-description-example-returns)
18
19
*[Settings to Configure `check-types` and `no-undefined-types`](#eslint-plugin-jsdoc-settings-settings-to-configure-check-types-and-no-undefined-types)
@@ -128,6 +129,13 @@ You can then selectively add to or override the recommended rules.
128
129
-`settings.jsdoc.ignorePrivate` - Disables all rules for the comment block
129
130
on which a `@private` tag occurs. Defaults to `false`.
130
131
132
+
<aname="eslint-plugin-jsdoc-settings-mode"></a>
133
+
### Mode
134
+
135
+
-`settings.jsdoc.mode` - Set to `jsdoc` (the default), `typescript`, or `closure`.
136
+
Currently is used for checking preferred tag names and in the `check-tag-names`
For [TypeScript](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html#supported-jsdoc)
1498
-
(or Closure), one may also use the following:
1506
+
(or Closure), when `settings.jsdoc.mode` is set to `typescript` or `closure`,
1507
+
one may also use the following:
1499
1508
1500
1509
```
1501
1510
template
1502
1511
```
1503
1512
1504
1513
And for [Closure](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler#nosideeffects-modifies-thisarguments),
1505
-
one may also use:
1514
+
when `settings.jsdoc.mode` is set to `closure`, one may use the following (in
1515
+
addition to the jsdoc and TypeScript tags):
1506
1516
1507
1517
```
1508
1518
define
@@ -1522,7 +1532,6 @@ polymerBehavior
1522
1532
preserve
1523
1533
struct
1524
1534
suppress
1525
-
template
1526
1535
unrestricted
1527
1536
```
1528
1537
@@ -1534,7 +1543,7 @@ Note that the tags indicated as replacements in `settings.jsdoc.tagNamePreferenc
0 commit comments