@@ -7845,6 +7845,12 @@ name will actually be part of the description (e.g., for
7845
7845
`structuredTags` setting (if `name: false`, this rule will not apply to
7846
7846
that tag).
7847
7847
7848
+ <a name="user-content-eslint-plugin-jsdoc-rules-match-name-fixer"></a>
7849
+ <a name="eslint-plugin-jsdoc-rules-match-name-fixer"></a>
7850
+ #### Fixer
7851
+
7852
+ Will replace `disallowName` with `replacement` if these are provided.
7853
+
7848
7854
<a name="user-content-eslint-plugin-jsdoc-rules-match-name-options-12"></a>
7849
7855
<a name="eslint-plugin-jsdoc-rules-match-name-options-12"></a>
7850
7856
#### Options
@@ -10976,6 +10982,15 @@ Requires that block description, explicit `@description`, and
10976
10982
* Periods after items within the `abbreviations` option array are not treated
10977
10983
as sentence endings.
10978
10984
10985
+ <a name="user-content-eslint-plugin-jsdoc-rules-require-description-complete-sentence-fixer-1"></a>
10986
+ <a name="eslint-plugin-jsdoc-rules-require-description-complete-sentence-fixer-1"></a>
10987
+ #### Fixer
10988
+
10989
+ If sentences do not end with terminal punctuation, a period will be added.
10990
+
10991
+ If sentences do not start with an uppercase character, the initial
10992
+ letter will be capitalized.
10993
+
10979
10994
<a name="user-content-eslint-plugin-jsdoc-rules-require-description-complete-sentence-options-23"></a>
10980
10995
<a name="eslint-plugin-jsdoc-rules-require-description-complete-sentence-options-23"></a>
10981
10996
#### Options
@@ -12369,8 +12384,8 @@ A value indicating whether setters should be checked. Defaults to `false`.
12369
12384
A boolean on whether to enable the fixer (which adds an empty `@example` block).
12370
12385
Defaults to `true`.
12371
12386
12372
- <a name="user-content-eslint-plugin-jsdoc-rules-require-example-fixer"></a>
12373
- <a name="eslint-plugin-jsdoc-rules-require-example-fixer"></a>
12387
+ <a name="user-content-eslint-plugin-jsdoc-rules-require-example-fixer-2 "></a>
12388
+ <a name="eslint-plugin-jsdoc-rules-require-example-fixer-2 "></a>
12374
12389
#### Fixer
12375
12390
12376
12391
The fixer for `require-example` will add an empty `@example`, but it will still
@@ -15553,16 +15568,16 @@ function quux (foo, {bar: {baz}}) {
15553
15568
15554
15569
Requires that all function parameters are documented.
15555
15570
15556
- <a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-1 "></a>
15557
- <a name="eslint-plugin-jsdoc-rules-require-param-fixer-1 "></a>
15571
+ <a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-3 "></a>
15572
+ <a name="eslint-plugin-jsdoc-rules-require-param-fixer-3 "></a>
15558
15573
#### Fixer
15559
15574
15560
15575
Adds `@param <name>` for each tag present in the function signature but
15561
15576
missing in the jsdoc. Can be disabled by setting the `enableFixer`
15562
15577
option to `false`.
15563
15578
15564
- <a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-1 -destructured-object-and-array-naming"></a>
15565
- <a name="eslint-plugin-jsdoc-rules-require-param-fixer-1 -destructured-object-and-array-naming"></a>
15579
+ <a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-3 -destructured-object-and-array-naming"></a>
15580
+ <a name="eslint-plugin-jsdoc-rules-require-param-fixer-3 -destructured-object-and-array-naming"></a>
15566
15581
##### Destructured object and array naming
15567
15582
15568
15583
When the fixer is applied to destructured objects, only the input name is
@@ -15614,8 +15629,8 @@ function quux ([foo, bar]) {
15614
15629
*/
15615
15630
```
15616
15631
15617
- <a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-1 -missing-root-fixing"></a>
15618
- <a name="eslint-plugin-jsdoc-rules-require-param-fixer-1 -missing-root-fixing"></a>
15632
+ <a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-3 -missing-root-fixing"></a>
15633
+ <a name="eslint-plugin-jsdoc-rules-require-param-fixer-3 -missing-root-fixing"></a>
15619
15634
##### Missing root fixing
15620
15635
15621
15636
Note that unless `enableRootFixer` (or `enableFixer`) is set to `false`,
@@ -15650,8 +15665,8 @@ numeric component).
15650
15665
And one can have the count begin at another number (e.g., `1`) by changing
15651
15666
`autoIncrementBase` from the default of `0`.
15652
15667
15653
- <a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-1 -rest-element-restelement-insertions"></a>
15654
- <a name="eslint-plugin-jsdoc-rules-require-param-fixer-1 -rest-element-restelement-insertions"></a>
15668
+ <a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-3 -rest-element-restelement-insertions"></a>
15669
+ <a name="eslint-plugin-jsdoc-rules-require-param-fixer-3 -rest-element-restelement-insertions"></a>
15655
15670
##### Rest Element (<code>RestElement</code>) insertions
15656
15671
15657
15672
The fixer will automatically report/insert
@@ -15703,8 +15718,8 @@ function baar ([a, ...extra]) {
15703
15718
15704
15719
...because it does not use the `...` syntax in the type.
15705
15720
15706
- <a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-1 -object-rest-property-insertions"></a>
15707
- <a name="eslint-plugin-jsdoc-rules-require-param-fixer-1 -object-rest-property-insertions"></a>
15721
+ <a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-3 -object-rest-property-insertions"></a>
15722
+ <a name="eslint-plugin-jsdoc-rules-require-param-fixer-3 -object-rest-property-insertions"></a>
15708
15723
##### Object Rest Property insertions
15709
15724
15710
15725
If the `checkRestProperty` option is set to `true` (`false` by default),
@@ -17334,8 +17349,8 @@ when their type is a plain `object`, `Object`, or `PlainObject`.
17334
17349
Note that any other type, including a subtype of object such as
17335
17350
`object<string, string>`, will not be reported.
17336
17351
17337
- <a name="user-content-eslint-plugin-jsdoc-rules-require-property-fixer-2 "></a>
17338
- <a name="eslint-plugin-jsdoc-rules-require-property-fixer-2 "></a>
17352
+ <a name="user-content-eslint-plugin-jsdoc-rules-require-property-fixer-4 "></a>
17353
+ <a name="eslint-plugin-jsdoc-rules-require-property-fixer-4 "></a>
17339
17354
#### Fixer
17340
17355
17341
17356
The fixer for `require-property` will add an empty `@property`.
0 commit comments