fix code style warned by fecs-valid-jsdoc

ecomfe · Jul 13, 2015 · 1fc7459 · 1fc7459
1 parent 3a1c19b
commit 1fc7459
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/lib/js/rules/indent.js b/lib/js/rules/indent.js
@@ -104,6 +104,7 @@ module.exports = function (context) {
 
     /**
      * Check indent for function block content
+     *
      * @param {ASTNode} node AST node
      */
     var checkIndentInFunctionBlock = function (node) {
@@ -153,6 +154,7 @@ module.exports = function (context) {
 
     /**
      * Check indent for array block content or object block content
+     *
      * @param {ASTNode} node AST node
      */
     var checkIndentInArrayOrObjectBlock = function (node) {
@@ -191,6 +193,7 @@ module.exports = function (context) {
 
     /**
      * Check indent for html strings array
+     *
      * @param {ASTNode} node AST node
      * @return {boolean}
      */

diff --git a/lib/js/rules/key-spacing.js b/lib/js/rules/key-spacing.js
@@ -10,17 +10,19 @@
 //------------------------------------------------------------------------------
 
 /**
-* Checks whether a string contains a line terminator as defined in
-* http://www.ecma-international.org/ecma-262/5.1/#sec-7.3
-* @param {string} str String to test.
-* @return {boolean} True if str contains a line terminator.
-*/
+ * Checks whether a string contains a line terminator as defined in
+ * http://www.ecma-international.org/ecma-262/5.1/#sec-7.3
+ *
+ * @param {string} str String to test.
+ * @return {boolean} True if str contains a line terminator.
+ */
 function containsLineTerminator(str) {
     return /[\n\r\u2028\u2029]/.test(str);
 }
 
 /**
  * Gets an object literal property's key as the identifier name or string value.
+ *
  * @param {ASTNode} property Property node whose key to retrieve.
  * @return {string} The property's key.
  */
@@ -30,6 +32,7 @@ function getKey(property) {
 
 /**
  * Gets the number of characters in a key, including quotes around string keys.
+ *
  * @param {ASTNode} property Property of on object literal.
  * @return {number} Width of the key, including string quotes where present.
  */
@@ -66,6 +69,7 @@ module.exports = function (context) {
 
     /**
      * Gets the whitespace around the colon in an object literal property
+     *
      * @param {ASTNode} property Property node from an object literal
      * @return {Object} Whitespace before and after the property's colon
      */
@@ -85,6 +89,7 @@ module.exports = function (context) {
     /**
      * Reports an appropriately-formatted error if spacing is incorrect on one
      * side of the colon.
+     *
      * @param {ASTNode} property Key-value pair in an object literal.
      * @param {string} side Side being verified - either "key" or "value".
      * @param {string} whitespace Actual whitespace string.

diff --git a/lib/js/rules/valid-jsdoc.js b/lib/js/rules/valid-jsdoc.js
@@ -34,6 +34,7 @@ module.exports = function (context) {
 
     /**
      * When parsing a new function, store it in our function stack.
+     *
      * @return {void}
      * @private
      */
@@ -43,6 +44,7 @@ module.exports = function (context) {
 
     /**
      * Indicate that return has been found in the current function.
+     *
      * @param {ASTNode} node The return node.
      * @return {void}
      * @private
@@ -195,6 +197,7 @@ module.exports = function (context) {
 
     /**
      * Validate the JSDoc node and output warnings if anything is wrong.
+     *
      * @param {ASTNode} node The AST node to check.
      * @return {void}
      * @private