Misc: Update jscs-jsdoc to 1.3.1

Closes gh-2009

Author: ljharb

lib/rules/jsdoc.js

@@ -18,15 +18,15 @@
  *
  * ### checkAnnotations
  *
- * Ensures tag names are valid
+ * Checks tag names are valid.
  *
  * There are 3 presets for `Closure Compiler`, `JSDoc3` and `JSDuck5`.
  *
- * By default it allows any tag of mixed set. You can pass `Object` to select
- * preset with `preset` field and add custom tags with `extra` field.
+ * By default it allows any tag from any preset. You can pass `Object`
+ * to select preset with `preset` field and add custom tags with `extra` field.
  *
  * Type: `Boolean` or `String` or `{"preset": String, "extra": Object}`
- * (see [tag values](#user-content-tag-values))
+ * (see [tag values](#user-content-tag-values)).
  *
  * Values: `true`, `"closurecompiler"`, `"jsdoc3"`, `"jsduck5"`, `Object`
  *
@@ -99,7 +99,7 @@
  *
  * ### checkParamExistence
  *
- * Ensures all parameters are documented.
+ * Checks all parameters are documented.
  *
  * Type: `Boolean`
  *
@@ -144,7 +144,7 @@
  *
  * ### checkParamNames
  *
- * Ensures param names in jsdoc and in function declaration are equal
+ * Checks param names in jsdoc and in function declaration are equal.
  *
  * Type: `Boolean`
  *
@@ -182,7 +182,7 @@
  *
  * ### requireParamTypes
  *
- * Ensures params in jsdoc contains type
+ * Checks params in jsdoc contains type.
  *
  * Type: `Boolean`
  *
@@ -218,7 +218,7 @@
  *
  * ### checkRedundantParams
  *
- * Reports redundant params in jsdoc
+ * Reports redundant params in jsdoc.
  *
  * Type: `Boolean`
  *
@@ -254,8 +254,7 @@
  *
  * ### checkReturnTypes
  *
- * Reports discrepancies between the claimed in jsdoc and actual type if both
- * exist (code scan)
+ * Checks for differences between the jsdoc and actual return types if both exist.
  *
  * Type: `Boolean`
  *
@@ -298,7 +297,7 @@
  *
  * ### checkRedundantReturns
  *
- * Report statements for functions with no return
+ * Report statements for functions without return.
  *
  * Type: `Boolean`
  *
@@ -338,7 +337,7 @@
  *
  * ### requireReturnTypes
  *
- * Ensures returns in jsdoc contains type
+ * Checks returns in jsdoc contains type
  *
  * Type: `Boolean`
  *
@@ -379,14 +378,14 @@
  *
  * ### checkTypes
  *
- * Reports invalid types for bunch of tags
+ * Reports invalid types for bunch of tags.
  *
- * In `strictNativeCase` mode ensures that case of natives is the same as in this
+ * The `strictNativeCase` mode checks that case of natives is the same as in this
  * list: `boolean`, `number`, `string`, `Object`, `Array`, `Date`, `RegExp`.
  *
- * In `capitalizedNativeCase` mode ensures that first letter in all native types
- * and primitives is uppercased except the case with `function` in google closure
- * format: `{function(...)}`
+ * The `capitalizedNativeCase` mode checks that the first letter in all native
+ * types and primitives is uppercased except the case with `function` in google
+ * closure format: `{function(...)}`
  *
  * Type: `Boolean` or `String`
  *
@@ -455,7 +454,7 @@
  *
  * ### checkRedundantAccess
  *
- * Reports redundant access declarations
+ * Reports redundant access declarations.
  *
  * Type: `Boolean` or `String`
  *
@@ -507,10 +506,11 @@
  *
  * ### leadingUnderscoreAccess
  *
- * Ensures access declaration is set for `_underscored` function names
+ * Checks access declaration is set for `_underscored` function names
  *
- * Ignores a bunch of popular identifiers: `__filename`, `__dirname`, `__proto__`,
- * `__defineGetter__`, `super_`, `__constructor`, etc.
+ * Ignores a bunch of popular identifiers:
+ * `__filename`, `__dirname`, `__proto__`, `__defineGetter__`, `super_`,
+ * `__constructor`, etc.
  *
  * Type: `Boolean` or `String`
  *
@@ -548,7 +548,7 @@
  *
  * ### enforceExistence
  *
- * Ensures jsdoc block exist
+ * Checks jsdoc block exists.
  *
  * Type: `Boolean`, `String` or `Object`
  *
@@ -588,7 +588,7 @@
  *
  * ### requireHyphenBeforeDescription
  *
- * Ensures a param description has a hyphen before it (checks for `- `)
+ * Checks a param description has a hyphen before it (checks for `- `).
  *
  * Type: `Boolean`
  *
@@ -625,7 +625,7 @@
  *
  * ### requireNewlineAfterDescription
  *
- * Ensures a doc comment description has padding newline
+ * Checks a doc comment description has padding newline.
  *
  * Type: `Boolean`
  *
@@ -645,9 +645,9 @@
  *
  * ```js
  * /**
- *  * @param {String} - message
+ *  * @param {String} msg - message
  *  *\/
- * function method() {}
+ * function method(msg) {}
  *
  * /**
  *  * Description
@@ -657,9 +657,9 @@
  * /**
  *  * Description
  *  *
- *  * @param {String} - message
+ *  * @param {String} msg - message
  *  *\/
- * function method() {}
+ * function method(msg) {}
  * ```
  *
  * ##### Invalid
@@ -675,7 +675,7 @@
  *
  * ### disallowNewlineAfterDescription
  *
- * Ensures a doc comment description has no padding newlines
+ * Checks a doc comment description has no padding newlines.
  *
  * Type: `Boolean`
  *
@@ -695,9 +695,9 @@
  *
  * ```js
  * /**
- *  * @param {String} - message
+ *  * @param {String} msg - message
  *  *\/
- * function method() {}
+ * function method(msg) {}
  *
  * /**
  *  * Description
@@ -706,9 +706,9 @@
  *
  * /**
  *  * Description
- *  * @param {String} - message
+ *  * @param {String} msg - message
  *  *\/
- * function method() {}
+ * function method(msg) {}
  * ```
  *
  * ##### Invalid
@@ -719,13 +719,13 @@
  *  *
  *  * @param {String} message
  *  *\/
- * function method() {}
+ * function method(message) {}
  * ```
  *
  *
  * ### requireDescriptionCompleteSentence
  *
- * Ensures a doc comment description is a complete sentence.
+ * Checks a doc comment description is a complete sentence.
  *
  * A complete sentence is defined as starting with an upper case letter and ending
  * with a period.
@@ -748,9 +748,9 @@
  *
  * ```js
  * /**
- *  * @param {String} - message
+ *  * @param {String} msg - message
  *  *\/
- * function method() {}
+ * function method(msg) {}
  *
  * /**
  *  * Description.
@@ -765,17 +765,17 @@
  * /**
  *  * Description.
  *  *
- *  * @param {String} - message
+ *  * @param {String} msg - message
  *  *\/
- * function method() {}
+ * function method(msg) {}
  *
  * /**
  *  * Description
- *  * On multiple lines.
+ *  * on multiple lines are allowed.
  *  *
- *  * @param {String} - message
+ *  * @param {String} msg - message
  *  *\/
- * function method() {}
+ * function method(msg) {}
  * ```
  *
  * ##### Invalid
@@ -788,6 +788,14 @@
  * function method() {}
  *
  * /**
+ *  * Description
+ *  * On multiple lines should not start with an upper case.
+ *  *
+ *  * @param {String} - message
+ *  *\/
+ * function method() {}
+ *
+ * /**
  *  * description starting with a lower case letter.
  *  * @param {String} message
  *  *\/
@@ -809,7 +817,7 @@
  *
  * ### requireParamDescription
  *
- * Ensures a param description exists.
+ * Checks a param description exists.
  *
  * Type: `Boolean`
  *
@@ -856,7 +864,7 @@
  *
  * ### requireReturnDescription
  *
- * Ensures a return description exists.
+ * Checks a return description exists.
  *
  * Type: `Boolean`
  *
@@ -901,6 +909,5 @@
  * }
  * ```
  *
- *
  */
 module.exports = require('jscs-jsdoc/lib/rules/validate-jsdoc');

package.json

@@ -72,7 +72,7 @@
     "glob": "^5.0.1",
     "htmlparser2": "3.8.3",
     "js-yaml": "~3.4.0",
-    "jscs-jsdoc": "1.2.0",
+    "jscs-jsdoc": "^1.3.1",
     "jscs-preset-wikimedia": "~1.0.0",
     "jsonlint": "~1.6.2",
     "lodash": "~3.10.0",