@@ -14,6 +14,7 @@ JSDoc linting rules for ESLint.
14
14
* [ Configuration] ( #eslint-plugin-jsdoc-configuration )
15
15
* [ Settings] ( #eslint-plugin-jsdoc-settings )
16
16
* [ 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 )
17
18
* [ Alias Preference] ( #eslint-plugin-jsdoc-settings-alias-preference )
18
19
* [ Additional Tag Names] ( #eslint-plugin-jsdoc-settings-additional-tag-names )
19
20
* [ 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.
151
152
- ` settings.jsdoc.allowPrivate ` - Disables all rules for the comment block
152
153
on which it occurs.
153
154
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
+
154
162
<a name =" eslint-plugin-jsdoc-settings-alias-preference " ></a >
155
163
### Alias Preference
156
164
@@ -1997,12 +2005,14 @@ function quux () {
1997
2005
<a name =" eslint-plugin-jsdoc-rules-require-jsdoc " ></a >
1998
2006
### <code >require-jsdoc</code >
1999
2007
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.
2001
2010
2002
2011
|||
2003
2012
| ---| ---|
2004
- | Context| ` ArrowFunctionExpression ` , ` FunctionDeclaration ` , ` FunctionExpression ` |
2013
+ | Context| ` ArrowFunctionExpression ` , ` ClassDeclaration ` , ` FunctionDeclaration ` , ` FunctionExpression ` |
2005
2014
| Tags| N/A|
2015
+ | Settings| ` exemptEmptyFunctions ` |
2006
2016
2007
2017
The following patterns are considered problems:
2008
2018
0 commit comments