Skip to content

Commit 57c9c19

Browse files
Exterskybrettz9
authored andcommitted
docs: Add descriptions for require-jsdoc publicFunctionsOnly options
* Also update README for changes from previous commit
1 parent 10bb92e commit 57c9c19

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

.README/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,9 @@ Finally, enable all of the rules that you would like to use.
126126

127127
This setting object supports the following keys:
128128

129-
- `exports`
130-
- `modules`
131-
- `browserEnv`
129+
- `exports` - ESM exports are checked for JSDoc comments
130+
- `modules` - CommonJS exports are checked for JSDoc comments
131+
- `browserEnv` - Populates window variable
132132

133133
### Alias Preference
134134

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,9 @@ Finally, enable all of the rules that you would like to use.
177177

178178
This setting object supports the following keys:
179179

180-
- `exports`
181-
- `modules`
182-
- `browserEnv`
180+
- `exports` - ESM exports are checked for JSDoc comments
181+
- `modules` - CommonJS exports are checked for JSDoc comments
182+
- `browserEnv` - Populates window variable
183183

184184
<a name="eslint-plugin-jsdoc-settings-alias-preference"></a>
185185
### Alias Preference
@@ -3650,6 +3650,13 @@ export { test as test2 }
36503650
// Settings: {"jsdoc":{"publicFunctionsOnly":true}}
36513651
// Options: [{"require":{"FunctionExpression":true}}]
36523652
// Message: Missing JSDoc comment.
3653+
3654+
export default class A {
3655+
3656+
}
3657+
// Settings: {"jsdoc":{"publicFunctionsOnly":true}}
3658+
// Options: [{"require":{"ClassDeclaration":true}}]
3659+
// Message: Missing JSDoc comment.
36533660
````
36543661

36553662
The following patterns are not considered problems:

0 commit comments

Comments
 (0)