Skip to content

Commit

Permalink
Docs: add requireNewlineAfterDescription, disallowNewlineAfterDescrip…
Browse files Browse the repository at this point in the history
…tion

Ref #85
Closes gh-99
  • Loading branch information
Alexej Yaroshevich committed May 3, 2015
1 parent 3e86bd4 commit 3bb3c22
Showing 1 changed file with 102 additions and 1 deletion.
103 changes: 102 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

[![NPM version](https://img.shields.io/npm/v/jscs-jsdoc.svg)](https://www.npmjs.com/package/jscs-jsdoc)
[![NPM downloads](https://img.shields.io/npm/dm/jscs-jsdoc.svg)](https://www.npmjs.com/package/jscs-jsdoc)
[![MIT License](https://img.shields.io/npm/l/jscs-jsdoc.svg)](https://github.com/jscs-dev/jscs-jsdoc/blob/master/LICENSExc)
[![MIT License](https://img.shields.io/npm/l/jscs-jsdoc.svg)](https://github.com/jscs-dev/jscs-jsdoc/blob/master/LICENSE)

`jsdoc` plugin for [jscs](https://github.com/jscs-dev/node-jscs/). [Twitter](https://twitter.com/jscs_dev) | [Mailing List](https://groups.google.com/group/jscs-dev)

Expand Down Expand Up @@ -616,6 +616,107 @@ function method() {}
function method() {}
```


### requireNewlineAfterDescription

Ensures a doc comment description has padding newline

Type: `Boolean`

Values: `true`

Context: `functions`

Tags: `*`

#### Example

```js
"requireNewlineAfterDescription": true
```

##### Valid

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

/**
* Description
*/
function method() {}

/**
* Description
*
* @param {String} - message
*/
function method() {}
```

##### Invalid

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


### disallowNewlineAfterDescription

Ensures a doc comment description has no padding newlines

Type: `Boolean`

Values: `true`

Context: `functions`

Tags: `*`

#### Example

```js
"disallowNewlineAfterDescription": true
```

##### Valid

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

/**
* Description
*/
function method() {}

/**
* Description
* @param {String} - message
*/
function method() {}
```

##### Invalid

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


## Browser Usage

NOT SUPPORTED ATM. SORRY.
Expand Down

0 comments on commit 3bb3c22

Please sign in to comment.