Skip to content

Commit d75f5ef

Browse files
committed
Merge pull request #54 from hzoo/require-hyphen-before-@param-description
requireHyphenBeforeDescription: add rule to readme
2 parents 2caffd5 + 78ceb47 commit d75f5ef

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -455,6 +455,43 @@ function _f() {}
455455
function _g() {}
456456
```
457457

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+
```js
480+
/**
481+
* @param {String} - message
482+
*/
483+
function method() {}
484+
```
485+
486+
##### Invalid
487+
488+
```js
489+
/**
490+
* @param {String} message
491+
*/
492+
function method() {}
493+
```
494+
458495
## Browser Usage
459496

460497
NOT SUPPORTED ATM. SORRY.

0 commit comments

Comments
 (0)