You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: allowImplementsWithoutParam and allowAugmentsExtendsWithoutParam and updating allowOverrideWithoutParam (#125)
* - Add docs missing for `allowImplementsWithoutParam` and `allowAugmentsExtendsWithoutParam`, and include them with `allowOverrideWithoutParam` (to save space and to mention that they all operate if present on the parent class comment block or the same comment block)
* - Rebuild docs
Copy file name to clipboardExpand all lines: .README/README.md
+15-2Lines changed: 15 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -128,14 +128,27 @@ Use `settings.jsdoc.additionalTagNames` to configure additional, allowed JSDoc t
128
128
129
129
### Allow `@override` Without Accompanying `@param` Tags
130
130
131
-
Use `settings.jsdoc.allowOverrideWithoutParam` to indicate whether the `@override` tag can be used without accompanying `@param` tag(s). The default value is `false`. The format of the configuration is as follows:
131
+
Use any of the following settings to override `require-param` and allow
132
+
`@param` to be omitted when the specified tags are present on the JSDoc
133
+
comment or the parent class comment. The default value for each is `false`.
134
+
135
+
*`settings.jsdoc.allowOverrideWithoutParam` - Enables behavior with
136
+
`@override` tag
137
+
*`settings.jsdoc.allowImplementsWithoutParam` - Enables behavior with
138
+
`@implements` tag
139
+
*`settings.jsdoc.allowAugmentsExtendsWithoutParam` - Enables behavior with
### Allow <code>@override</code> Without Accompanying <code>@param</code> Tags
163
163
164
-
Use `settings.jsdoc.allowOverrideWithoutParam` to indicate whether the `@override` tag can be used without accompanying `@param` tag(s). The default value is `false`. The format of the configuration is as follows:
164
+
Use any of the following settings to override `require-param` and allow
165
+
`@param` to be omitted when the specified tags are present on the JSDoc
166
+
comment or the parent class comment. The default value for each is `false`.
167
+
168
+
*`settings.jsdoc.allowOverrideWithoutParam` - Enables behavior with
169
+
`@override` tag
170
+
*`settings.jsdoc.allowImplementsWithoutParam` - Enables behavior with
171
+
`@implements` tag
172
+
*`settings.jsdoc.allowAugmentsExtendsWithoutParam` - Enables behavior with
0 commit comments