Skip to content

Commit

Permalink
readme: add additional info about checkAnnotation values
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexej Yaroshevich committed Nov 26, 2014
1 parent 072737e commit 13ed645
Showing 1 changed file with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ Ensures tag names are valid

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

By default it allows any tag of mixed set.
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.

Type: `Boolean` or `String`
Type: `Boolean` or `String` or `{"preset": String, "extra": Object}` (`extra` field should contains tags in keys and boolean in values. false means no value possible)

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

Context: `file`

Expand Down Expand Up @@ -105,6 +105,33 @@ function _f() {}
function _f() {}
```

#### Example 2

```js
"checkAnnotations": {
"preset": "jsdoc3",
"extra": {
"boomer": false
}
}
```

##### Valid

```js
/**
* @boomer
* @argument {String}
*/
function _f() {}
```

##### Invalid

```js
/** @still-invalid */
```

####

### checkParamNames
Expand Down

0 comments on commit 13ed645

Please sign in to comment.