Skip to content

Commit

Permalink
Docs: add rule requireParamDescription
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexej Yaroshevich committed Jun 24, 2015
1 parent bf19a6c commit 262ce3f
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -716,6 +716,7 @@ function method() {}
function method() {}
```


### requireDescriptionCompleteSentence

Ensures a doc comment description is a complete sentence.
Expand Down Expand Up @@ -794,6 +795,51 @@ function method() {}
```


### requireParamDescription

Ensures a param description exists.

Type: `Boolean`

Values: `true`

Context: `functions`

Tags: `param`, `arg`, `argument`

#### Example

```js
"requireParamDescription": true
```

##### Valid

```js
/**
* @param {String} arg message
*/
function method(arg) {}

/**
* @param arg message
*/
function method(arg) {}

##### Invalid

```js
/**
* @param {String} arg
*/
function method(arg) {}
/**
* @param arg
*/
function method(arg) {}
```


## Browser Usage

Expand Down

0 comments on commit 262ce3f

Please sign in to comment.