Skip to content
This repository has been archived by the owner on Mar 23, 2024. It is now read-only.

Commit

Permalink
Merge 391f480 into b615bd7
Browse files Browse the repository at this point in the history
  • Loading branch information
mrjoelkemp committed Sep 19, 2014
2 parents b615bd7 + 391f480 commit b7d9607
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 48 deletions.
49 changes: 2 additions & 47 deletions README.md
Expand Up @@ -2850,55 +2850,10 @@ function a(b, c) {}
function a(b , c) {}
```

### validateJSDoc
### ~~validateJSDoc~~

Enables JSDoc validation.
Please use the [JSCS-JSDoc](https://github.com/jscs-dev/jscs-jsdoc) plugin instead.

Type: `Object`

Values:

- "checkParamNames" ensures param names in jsdoc and in function declaration are equal
- "requireParamTypes" ensures params in jsdoc contains type
- "checkRedundantParams" reports redundant params in jsdoc

#### Example

```js
"validateJSDoc": {
"checkParamNames": true,
"checkRedundantParams": true,
"requireParamTypes": true
}
```

##### Valid

```js
/**
* Adds style error to the list
*
* @param {String} message
* @param {Number|Object} line
* @param {Number} [column]
*/
add: function(message, line, column) {
}
```

##### Invalid

```js
/**
* Adds style error to the list
*
* @param {String} message
* @param {Number|Object} line
* @param {Number} [column]
*/
add: function() {
}
```
### safeContextKeyword

Option to check `var that = this` expressions
Expand Down
2 changes: 1 addition & 1 deletion lib/string-checker.js
Expand Up @@ -43,6 +43,7 @@ StringChecker.prototype = {
this.registerRule(new (require('./rules/disallow-left-sticked-operators'))());
this.registerRule(new (require('./rules/require-right-sticked-operators'))());
this.registerRule(new (require('./rules/disallow-right-sticked-operators'))());
this.registerRule(new (require('./rules/validate-jsdoc'))());
/* deprecated rules (end) */

this.registerRule(new (require('./rules/require-operator-before-line-break'))());
Expand All @@ -60,7 +61,6 @@ StringChecker.prototype = {
this.registerRule(new (require('./rules/disallow-keywords-on-new-line'))());
this.registerRule(new (require('./rules/require-line-feed-at-file-end'))());
this.registerRule(new (require('./rules/maximum-line-length'))());
this.registerRule(new (require('./rules/validate-jsdoc'))());
this.registerRule(new (require('./rules/require-yoda-conditions'))());
this.registerRule(new (require('./rules/disallow-yoda-conditions'))());
this.registerRule(new (require('./rules/require-spaces-inside-object-brackets'))());
Expand Down

0 comments on commit b7d9607

Please sign in to comment.