Skip to content

Commit b32e6ba

Browse files
brettz9gajus
authored andcommitted
docs: allowImplementsWithoutParam and allowAugmentsExtendsWithoutParam and updating allowOverrideWithoutParam (#125)
* - Add docs missing for `allowImplementsWithoutParam` and `allowAugmentsExtendsWithoutParam`, and include them with `allowOverrideWithoutParam` (to save space and to mention that they all operate if present on the parent class comment block or the same comment block) * - Rebuild docs
1 parent 9a38896 commit b32e6ba

File tree

2 files changed

+30
-4
lines changed

2 files changed

+30
-4
lines changed

.README/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,14 +128,27 @@ Use `settings.jsdoc.additionalTagNames` to configure additional, allowed JSDoc t
128128

129129
### Allow `@override` Without Accompanying `@param` Tags
130130

131-
Use `settings.jsdoc.allowOverrideWithoutParam` to indicate whether the `@override` tag can be used without accompanying `@param` tag(s). The default value is `false`. The format of the configuration is as follows:
131+
Use any of the following settings to override `require-param` and allow
132+
`@param` to be omitted when the specified tags are present on the JSDoc
133+
comment or the parent class comment. The default value for each is `false`.
134+
135+
* `settings.jsdoc.allowOverrideWithoutParam` - Enables behavior with
136+
`@override` tag
137+
* `settings.jsdoc.allowImplementsWithoutParam` - Enables behavior with
138+
`@implements` tag
139+
* `settings.jsdoc.allowAugmentsExtendsWithoutParam` - Enables behavior with
140+
`@augments` tag or its synonym `@extends`
141+
142+
The format of the configuration is as follows:
132143

133144
```json
134145
{
135146
"rules": {},
136147
"settings": {
137148
"jsdoc": {
138-
"allowOverrideWithoutParam": true
149+
"allowOverrideWithoutParam": true,
150+
"allowImplementsWithoutParam": true,
151+
"allowAugmentsExtendsWithoutParam": true
139152
}
140153
}
141154
}

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,14 +161,27 @@ Use `settings.jsdoc.additionalTagNames` to configure additional, allowed JSDoc t
161161
<a name="eslint-plugin-jsdoc-settings-allow-override-without-accompanying-param-tags"></a>
162162
### Allow <code>@override</code> Without Accompanying <code>@param</code> Tags
163163

164-
Use `settings.jsdoc.allowOverrideWithoutParam` to indicate whether the `@override` tag can be used without accompanying `@param` tag(s). The default value is `false`. The format of the configuration is as follows:
164+
Use any of the following settings to override `require-param` and allow
165+
`@param` to be omitted when the specified tags are present on the JSDoc
166+
comment or the parent class comment. The default value for each is `false`.
167+
168+
* `settings.jsdoc.allowOverrideWithoutParam` - Enables behavior with
169+
`@override` tag
170+
* `settings.jsdoc.allowImplementsWithoutParam` - Enables behavior with
171+
`@implements` tag
172+
* `settings.jsdoc.allowAugmentsExtendsWithoutParam` - Enables behavior with
173+
`@augments` tag or its synonym `@extends`
174+
175+
The format of the configuration is as follows:
165176

166177
```json
167178
{
168179
"rules": {},
169180
"settings": {
170181
"jsdoc": {
171-
"allowOverrideWithoutParam": true
182+
"allowOverrideWithoutParam": true,
183+
"allowImplementsWithoutParam": true,
184+
"allowAugmentsExtendsWithoutParam": true
172185
}
173186
}
174187
}

0 commit comments

Comments
 (0)