stylelint-sassdoc/src/rules/atReturn/README.MD

stylelint plugin to check scss files for a valid sassdoc documentation Credits to https://github.com/anneangersbach

# atReturn
Checks that a function has exactly one @return comment and that it has a {type} declaration.
> ** Ignores private functions. **

## Options (to-do)

string: "both"|"private"|"public"

Define which rules to check against.

## Information about @return
http://sassdoc.com/annotations/#return

### Description:
Description	Describes the return statement of the documented function
```text
Multiple: false
Default:	—
Aliases:	@returns
Autofilled:	false
Allowed on:	functions
Extra notes:	Description is optional. Hyphen before description is optional.
                Description is parsed as Markdown.*
                Multiple types must be separated by pipes (|).
```

### Example of usage
```scss
/// @return {type}
/// @return {type | othertype}
/// @return {type} description
```