14
14
* [ ` checkSetters ` ] ( #user-content-require-jsdoc-options-checksetters )
15
15
* [ ` enableFixer ` ] ( #user-content-require-jsdoc-options-enablefixer )
16
16
* [ ` minLineCount ` ] ( #user-content-require-jsdoc-options-minlinecount )
17
+ * [ ` fixerMessage ` ] ( #user-content-require-jsdoc-options-fixermessage )
17
18
* [ Context and settings] ( #user-content-require-jsdoc-context-and-settings )
18
19
* [ Failing examples] ( #user-content-require-jsdoc-failing-examples )
19
20
* [ Passing examples] ( #user-content-require-jsdoc-passing-examples )
@@ -28,7 +29,8 @@ functions.
28
29
29
30
Adds an empty JSDoc block unless ` enableFixer ` is set to ` false ` . See
30
31
the ` contexts ` option for how ` inlineCommentBlock ` can control the style
31
- of the generated JSDoc block.
32
+ of the generated JSDoc block and ` fixerMessage ` for an optional message
33
+ to insert.
32
34
33
35
<a name =" user-content-require-jsdoc-options " ></a >
34
36
<a name =" require-jsdoc-options " ></a >
@@ -148,6 +150,13 @@ An integer to indicate a minimum number of lines expected for a node in order
148
150
for it to require documentation. Defaults to ` undefined ` . This option will
149
151
apply to any context; see ` contexts ` for line counts per context.
150
152
153
+ <a name =" user-content-require-jsdoc-options-fixermessage " ></a >
154
+ <a name =" require-jsdoc-options-fixermessage " ></a >
155
+ ### <code >fixerMessage</code >
156
+
157
+ An optional message to add to the inserted JSDoc block. Defaults to the
158
+ empty string.
159
+
151
160
<a name =" user-content-require-jsdoc-context-and-settings " ></a >
152
161
<a name =" require-jsdoc-context-and-settings " ></a >
153
162
## Context and settings
@@ -157,7 +166,7 @@ apply to any context; see `contexts` for line counts per context.
157
166
| Context| ` ArrowFunctionExpression ` , ` ClassDeclaration ` , ` ClassExpression ` , ` FunctionDeclaration ` , ` FunctionExpression ` ; others when ` contexts ` option enabled|
158
167
| Tags| N/A|
159
168
| Recommended| true|
160
- | Options| ` publicOnly ` , ` require ` , ` contexts ` , ` exemptEmptyConstructors ` , ` exemptEmptyFunctions ` , ` enableFixer ` , ` minLineCount ` |
169
+ | Options| ` publicOnly ` , ` require ` , ` contexts ` , ` exemptEmptyConstructors ` , ` exemptEmptyFunctions ` , ` enableFixer ` , ` minLineCount ` , ` fixerMessage ` |
161
170
162
171
<a name =" user-content-require-jsdoc-failing-examples " ></a >
163
172
<a name =" require-jsdoc-failing-examples " ></a >
0 commit comments