Skip to content

Commit

Permalink
docs: allowImplementsWithoutParam and `allowAugmentsExtendsWithoutP…
Browse files Browse the repository at this point in the history
…aram` 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
  • Loading branch information
brettz9 authored and gajus committed Dec 9, 2018
1 parent 9a38896 commit b32e6ba
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 4 deletions.
17 changes: 15 additions & 2 deletions .README/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,14 +128,27 @@ Use `settings.jsdoc.additionalTagNames` to configure additional, allowed JSDoc t

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

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:
Use any of the following settings to override `require-param` and allow
`@param` to be omitted when the specified tags are present on the JSDoc
comment or the parent class comment. The default value for each is `false`.

* `settings.jsdoc.allowOverrideWithoutParam` - Enables behavior with
`@override` tag
* `settings.jsdoc.allowImplementsWithoutParam` - Enables behavior with
`@implements` tag
* `settings.jsdoc.allowAugmentsExtendsWithoutParam` - Enables behavior with
`@augments` tag or its synonym `@extends`

The format of the configuration is as follows:

```json
{
"rules": {},
"settings": {
"jsdoc": {
"allowOverrideWithoutParam": true
"allowOverrideWithoutParam": true,
"allowImplementsWithoutParam": true,
"allowAugmentsExtendsWithoutParam": true
}
}
}
Expand Down
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,14 +161,27 @@ Use `settings.jsdoc.additionalTagNames` to configure additional, allowed JSDoc t
<a name="eslint-plugin-jsdoc-settings-allow-override-without-accompanying-param-tags"></a>
### Allow <code>@override</code> Without Accompanying <code>@param</code> Tags

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:
Use any of the following settings to override `require-param` and allow
`@param` to be omitted when the specified tags are present on the JSDoc
comment or the parent class comment. The default value for each is `false`.

* `settings.jsdoc.allowOverrideWithoutParam` - Enables behavior with
`@override` tag
* `settings.jsdoc.allowImplementsWithoutParam` - Enables behavior with
`@implements` tag
* `settings.jsdoc.allowAugmentsExtendsWithoutParam` - Enables behavior with
`@augments` tag or its synonym `@extends`

The format of the configuration is as follows:

```json
{
"rules": {},
"settings": {
"jsdoc": {
"allowOverrideWithoutParam": true
"allowOverrideWithoutParam": true,
"allowImplementsWithoutParam": true,
"allowAugmentsExtendsWithoutParam": true
}
}
}
Expand Down

0 comments on commit b32e6ba

Please sign in to comment.