Skip to content

Commit 28c0fdf

Browse files
Exterskybrettz9
authored andcommitted
docs: generate docs
1 parent abd2170 commit 28c0fdf

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -168,13 +168,18 @@ Finally, enable all of the rules that you would like to use.
168168
above functions/methods with no parameters or return values (intended where
169169
variable names are sufficient for themselves as documentation).
170170

171-
<a name="eslint-plugin-jsdoc-settings-requiring-jsdoc-comments-for-exported-functions-in-require-jsdoc"></a>
172171
<a name="eslint-plugin-jsdoc-settings-requiring-jsdoc-comments-for-exported-functions-in-code-require-jsdoc-code"></a>
173172
### Requiring JSDoc comments for exported functions in <code>require-jsdoc</code>
174173

175174
- `settings.jsdoc.publicFunctionsOnly` - Missing jsdoc blocks
176175
are only reported for function bodies that are exported from the module.
177176

177+
This setting object supports the following keys:
178+
179+
- `exports`
180+
- `modules`
181+
- `browserEnv`
182+
178183
<a name="eslint-plugin-jsdoc-settings-alias-preference"></a>
179184
### Alias Preference
180185

@@ -3428,11 +3433,7 @@ functions.
34283433
|---|---|
34293434
|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `FunctionDeclaration`, `FunctionExpression`|
34303435
|Tags|N/A|
3431-
|Settings|`exemptEmptyFunctions`|
3432-
|Settings|`publicFunctionsOnly`|
3433-
|Settings|`publicFunctionsOnly.exports`|
3434-
|Settings|`publicFunctionsOnly.modules`|
3435-
|Settings|`publicFunctionsOnly.browserEnv`|
3436+
|Settings|`exemptEmptyFunctions`, `publicFunctionsOnly`|
34363437

34373438
The following patterns are considered problems:
34383439

0 commit comments

Comments
 (0)