Skip to content

Commit a11cde3

Browse files
committed
docs: document fixerMessage
1 parent 081af26 commit a11cde3

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

.README/rules/require-jsdoc.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ functions.
99

1010
Adds an empty JSDoc block unless `enableFixer` is set to `false`. See
1111
the `contexts` option for how `inlineCommentBlock` can control the style
12-
of the generated JSDoc block.
12+
of the generated JSDoc block and `fixerMessage` for an optional message
13+
to insert.
1314

1415
## Options
1516

@@ -107,14 +108,19 @@ An integer to indicate a minimum number of lines expected for a node in order
107108
for it to require documentation. Defaults to `undefined`. This option will
108109
apply to any context; see `contexts` for line counts per context.
109110

111+
### `fixerMessage`
112+
113+
An optional message to add to the inserted JSDoc block. Defaults to the
114+
empty string.
115+
110116
## Context and settings
111117

112118
|||
113119
|---|---|
114120
|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `ClassExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
115121
|Tags|N/A|
116122
|Recommended|true|
117-
|Options|`publicOnly`, `require`, `contexts`, `exemptEmptyConstructors`, `exemptEmptyFunctions`, `enableFixer`, `minLineCount`|
123+
|Options|`publicOnly`, `require`, `contexts`, `exemptEmptyConstructors`, `exemptEmptyFunctions`, `enableFixer`, `minLineCount`, `fixerMessage`|
118124

119125
## Failing examples
120126

docs/rules/require-jsdoc.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
* [`checkSetters`](#user-content-require-jsdoc-options-checksetters)
1515
* [`enableFixer`](#user-content-require-jsdoc-options-enablefixer)
1616
* [`minLineCount`](#user-content-require-jsdoc-options-minlinecount)
17+
* [`fixerMessage`](#user-content-require-jsdoc-options-fixermessage)
1718
* [Context and settings](#user-content-require-jsdoc-context-and-settings)
1819
* [Failing examples](#user-content-require-jsdoc-failing-examples)
1920
* [Passing examples](#user-content-require-jsdoc-passing-examples)
@@ -28,7 +29,8 @@ functions.
2829

2930
Adds an empty JSDoc block unless `enableFixer` is set to `false`. See
3031
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.
3234

3335
<a name="user-content-require-jsdoc-options"></a>
3436
<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
148150
for it to require documentation. Defaults to `undefined`. This option will
149151
apply to any context; see `contexts` for line counts per context.
150152

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+
151160
<a name="user-content-require-jsdoc-context-and-settings"></a>
152161
<a name="require-jsdoc-context-and-settings"></a>
153162
## Context and settings
@@ -157,7 +166,7 @@ apply to any context; see `contexts` for line counts per context.
157166
|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `ClassExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
158167
|Tags|N/A|
159168
|Recommended|true|
160-
|Options|`publicOnly`, `require`, `contexts`, `exemptEmptyConstructors`, `exemptEmptyFunctions`, `enableFixer`, `minLineCount`|
169+
|Options|`publicOnly`, `require`, `contexts`, `exemptEmptyConstructors`, `exemptEmptyFunctions`, `enableFixer`, `minLineCount`, `fixerMessage`|
161170

162171
<a name="user-content-require-jsdoc-failing-examples"></a>
163172
<a name="require-jsdoc-failing-examples"></a>

0 commit comments

Comments
 (0)