@@ -2254,15 +2254,27 @@ by our supported Node versions):
2254
2254
2255
2255
`` ^([A-Z]|[`\\d_])([\\s\\S]*[.?!`])?$ ``
2256
2256
2257
- You can supply your own expression passing a ` matchDescription ` string on
2258
- the options object.
2257
+ <a name =" eslint-plugin-jsdoc-rules-match-description-options-1 " ></a >
2258
+ #### Options
2259
+
2260
+ <a name =" eslint-plugin-jsdoc-rules-match-description-options-1-matchdescription " ></a >
2261
+ ##### <code >matchDescription</code >
2262
+
2263
+ You can supply your own expression to override the default, passing a
2264
+ ` matchDescription ` string on the options object.
2259
2265
2260
2266
``` js
2261
2267
{
2262
2268
' jsdoc/match-description' : [' error' , {matchDescription: ' [A-Z].*\\ .' }]
2263
2269
}
2264
2270
```
2265
2271
2272
+ As with the default, the supplied regular expression will be applied with the
2273
+ Unicode (` "u" ` ) flag and is * not* case-insensitive.
2274
+
2275
+ <a name =" eslint-plugin-jsdoc-rules-match-description-options-1-tags " ></a >
2276
+ ##### <code >tags</code >
2277
+
2266
2278
If you want different regular expressions to apply to tags, you may use
2267
2279
the ` tags ` option object:
2268
2280
@@ -2737,7 +2749,7 @@ The following types are always considered defined.
2737
2749
- ` any ` , ` * `
2738
2750
- ` Array ` , ` Object ` , ` RegExp ` , ` Date ` , ` Function `
2739
2751
2740
- <a name =" eslint-plugin-jsdoc-rules-no-undefined-types-options-1 " ></a >
2752
+ <a name =" eslint-plugin-jsdoc-rules-no-undefined-types-options-2 " ></a >
2741
2753
#### Options
2742
2754
2743
2755
An option object may have the following keys:
@@ -3307,7 +3319,7 @@ Requires that all functions have a description.
3307
3319
* All functions must have a ` @description ` tag.
3308
3320
* Every description tag must have a non-empty description that explains the purpose of the method.
3309
3321
3310
- <a name =" eslint-plugin-jsdoc-rules-require-description-options-2 " ></a >
3322
+ <a name =" eslint-plugin-jsdoc-rules-require-description-options-3 " ></a >
3311
3323
#### Options
3312
3324
3313
3325
An options object may have any of the following properties:
@@ -3485,7 +3497,7 @@ Requires that all functions have examples.
3485
3497
* All functions must have one or more ` @example ` tags.
3486
3498
* Every example tag must have a non-empty description that explains the method's usage.
3487
3499
3488
- <a name =" eslint-plugin-jsdoc-rules-require-example-options-3 " ></a >
3500
+ <a name =" eslint-plugin-jsdoc-rules-require-example-options-4 " ></a >
3489
3501
#### Options
3490
3502
3491
3503
Has an object option with one optional property:
@@ -3709,7 +3721,7 @@ function quux () {
3709
3721
Checks for presence of jsdoc comments, on class declarations as well as
3710
3722
functions.
3711
3723
3712
- <a name =" eslint-plugin-jsdoc-rules-require-jsdoc-options-4 " ></a >
3724
+ <a name =" eslint-plugin-jsdoc-rules-require-jsdoc-options-5 " ></a >
3713
3725
#### Options
3714
3726
3715
3727
Accepts one optional options object, with two optional keys, ` publicOnly `
@@ -4705,7 +4717,7 @@ function quux (foo) {
4705
4717
4706
4718
Requires that all function parameters are documented.
4707
4719
4708
- <a name =" eslint-plugin-jsdoc-rules-require-param-options-5 " ></a >
4720
+ <a name =" eslint-plugin-jsdoc-rules-require-param-options-6 " ></a >
4709
4721
#### Options
4710
4722
4711
4723
An options object accepts one optional property:
@@ -5596,7 +5608,7 @@ function quux () {
5596
5608
5597
5609
Requires returns are documented.
5598
5610
5599
- <a name =" eslint-plugin-jsdoc-rules-require-returns-options-6 " ></a >
5611
+ <a name =" eslint-plugin-jsdoc-rules-require-returns-options-7 " ></a >
5600
5612
#### Options
5601
5613
5602
5614
- ` exemptedBy ` - Array of tags (e.g., ` ['type'] ` ) whose presence on the document
0 commit comments