We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
2 parents 2caffd5 + 78ceb47 commit d75f5efCopy full SHA for d75f5ef
README.md
@@ -455,6 +455,43 @@ function _f() {}
455
function _g() {}
456
```
457
458
+
459
+### requireHyphenBeforeDescription
460
461
+Ensures a param description has a hyphen before it (checks for `- `)
462
463
+Type: `Boolean`
464
465
+Values: `true`
466
467
+Context: `functions`
468
469
+Tags: `param`, `arg`, `argument`
470
471
+#### Example
472
473
+```js
474
+"requireHyphenBeforeDescription": true
475
+```
476
477
+##### Valid
478
479
480
+/**
481
+ * @param {String} - message
482
+ */
483
+function method() {}
484
485
486
+##### Invalid
487
488
489
490
+ * @param {String} message
491
492
493
494
495
## Browser Usage
496
497
NOT SUPPORTED ATM. SORRY.
0 commit comments