requireHyphenBeforeDescription: add rule to readme

jscs-dev · Nov 18, 2014 · 78ceb47 · 78ceb47
1 parent e317b03
commit 78ceb47
Showing 1 changed file with 37 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -455,6 +455,43 @@ function _f() {}
 function _g() {}
 ```
 
+
+### requireHyphenBeforeDescription
+
+Ensures a param description has a hyphen before it (checks for `- `)
+
+Type: `Boolean`
+
+Values: `true`
+
+Context: `functions`
+
+Tags: `param`, `arg`, `argument`
+
+#### Example
+
+```js
+"requireHyphenBeforeDescription": true
+```
+
+##### Valid
+
+```js
+/**
+ * @param {String} - message
+ */
+function method() {}
+```
+
+##### Invalid
+
+```js
+/**
+ * @param {String} message
+ */
+function method() {}
+```
+
 ## Browser Usage
 
 NOT SUPPORTED ATM. SORRY.