Skip to content

Commit

Permalink
readme: checkAnnotation rule section
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexej Yaroshevich committed Nov 26, 2014
1 parent 41f1dbb commit 072737e
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,51 @@ To use plugin you should add these lines to configuration file `.jscsrc`:

## Rules

### checkAnnotations

Ensures tag names are valid

There are 3 presets for `Closure Compiler`, `JSDoc3` and `JSDuck5`.

By default it allows any tag of mixed set.

Type: `Boolean` or `String`

Values: `true`, `"closurecompiler"`, `"jsdoc3"`, `"jsduck5"`

Context: `file`

Tags: `*`

#### Example

```js
"checkAnnotations": true
```

##### Valid

```js
/**
* @chainable
* @param {string} message
* @return {string}
*/
function _f() {}
```

##### Invalid

```js
/**
* @pororo
* @lalala
*/
function _f() {}
```

####

### checkParamNames

Ensures param names in jsdoc and in function declaration are equal
Expand Down

0 comments on commit 072737e

Please sign in to comment.