Skip to content

Commit 65f6367

Browse files
committed
docs: document require option
1 parent b6d7b4f commit 65f6367

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

.README/rules/require-jsdoc.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@ be checked by the rule.
2424
- `modules` - CommonJS exports are checked for JSDoc comments (Defaults to `true`)
2525
- `browserEnv` - Populates window variable
2626

27+
- `require` - An object with the following optional boolean keys which all
28+
default to `false` except as noted:
29+
30+
- `ArrowFunctionExpression`
31+
- `ClassDeclaration`
32+
- `FunctionDeclaration` (defaults to `true`)
33+
- `FunctionExpression`
34+
- `MethodDefinition`
35+
2736
|||
2837
|---|---|
2938
|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `FunctionDeclaration`, `FunctionExpression`|

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3438,6 +3438,15 @@ be checked by the rule.
34383438
- `modules` - CommonJS exports are checked for JSDoc comments (Defaults to `true`)
34393439
- `browserEnv` - Populates window variable
34403440

3441+
- `require` - An object with the following optional boolean keys which all
3442+
default to `false` except as noted:
3443+
3444+
- `ArrowFunctionExpression`
3445+
- `ClassDeclaration`
3446+
- `FunctionDeclaration` (defaults to `true`)
3447+
- `FunctionExpression`
3448+
- `MethodDefinition`
3449+
34413450
|||
34423451
|---|---|
34433452
|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `FunctionDeclaration`, `FunctionExpression`|

0 commit comments

Comments
 (0)