Skip to content

Commit c9024e3

Browse files
committed
docs: generate docs
1 parent aeae82a commit c9024e3

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ JSDoc linting rules for ESLint.
1414
* [Configuration](#eslint-plugin-jsdoc-configuration)
1515
* [Settings](#eslint-plugin-jsdoc-settings)
1616
* [Allow `@private` to disable rules for that comment block](#eslint-plugin-jsdoc-settings-allow-private-to-disable-rules-for-that-comment-block)
17+
* [Exempting empty functions from `require-jsdoc`](#eslint-plugin-jsdoc-settings-exempting-empty-functions-from-require-jsdoc)
1718
* [Alias Preference](#eslint-plugin-jsdoc-settings-alias-preference)
1819
* [Additional Tag Names](#eslint-plugin-jsdoc-settings-additional-tag-names)
1920
* [Allow `@override` Without Accompanying `@param` Tags](#eslint-plugin-jsdoc-settings-allow-override-without-accompanying-param-tags)
@@ -151,6 +152,13 @@ Finally, enable all of the rules that you would like to use.
151152
- `settings.jsdoc.allowPrivate` - Disables all rules for the comment block
152153
on which it occurs.
153154

155+
<a name="eslint-plugin-jsdoc-settings-exempting-empty-functions-from-require-jsdoc"></a>
156+
### Exempting empty functions from <code>require-jsdoc</code>
157+
158+
- `settings.jsdoc.exemptEmptyFunctions` - Will not report missing jsdoc blocks
159+
above functions/methods with no parameters or return values (intended where
160+
variable names are sufficient for themselves as documentation).
161+
154162
<a name="eslint-plugin-jsdoc-settings-alias-preference"></a>
155163
### Alias Preference
156164

@@ -1997,12 +2005,14 @@ function quux () {
19972005
<a name="eslint-plugin-jsdoc-rules-require-jsdoc"></a>
19982006
### <code>require-jsdoc</code>
19992007

2000-
Checks for presence of jsdoc comments, across a variety of contexts.
2008+
Checks for presence of jsdoc comments, on class declarations as well as
2009+
functions.
20012010

20022011
|||
20032012
|---|---|
2004-
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
2013+
|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `FunctionDeclaration`, `FunctionExpression`|
20052014
|Tags|N/A|
2015+
|Settings|`exemptEmptyFunctions`|
20062016

20072017
The following patterns are considered problems:
20082018

0 commit comments

Comments
 (0)