File tree Expand file tree Collapse file tree 1 file changed +7
-6
lines changed Expand file tree Collapse file tree 1 file changed +7
-6
lines changed Original file line number Diff line number Diff line change @@ -168,13 +168,18 @@ Finally, enable all of the rules that you would like to use.
168
168
above functions/methods with no parameters or return values (intended where
169
169
variable names are sufficient for themselves as documentation).
170
170
171
- <a name =" eslint-plugin-jsdoc-settings-requiring-jsdoc-comments-for-exported-functions-in-require-jsdoc " ></a >
172
171
<a name =" eslint-plugin-jsdoc-settings-requiring-jsdoc-comments-for-exported-functions-in-code-require-jsdoc-code " ></a >
173
172
### Requiring JSDoc comments for exported functions in <code >require-jsdoc</code >
174
173
175
174
- ` settings.jsdoc.publicFunctionsOnly ` - Missing jsdoc blocks
176
175
are only reported for function bodies that are exported from the module.
177
176
177
+ This setting object supports the following keys:
178
+
179
+ - ` exports `
180
+ - ` modules `
181
+ - ` browserEnv `
182
+
178
183
<a name =" eslint-plugin-jsdoc-settings-alias-preference " ></a >
179
184
### Alias Preference
180
185
@@ -3428,11 +3433,7 @@ functions.
3428
3433
| ---| ---|
3429
3434
| Context| ` ArrowFunctionExpression ` , ` ClassDeclaration ` , ` FunctionDeclaration ` , ` FunctionExpression ` |
3430
3435
| 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 ` |
3436
3437
3437
3438
The following patterns are considered problems:
3438
3439
You can’t perform that action at this time.
0 commit comments