stylelint-sassdoc
Version:
stylelint plugin to check scss files for a valid sassdoc documentation Credits to https://github.com/anneangersbach
23 lines (19 loc) • 531 B
Markdown
# atName
Expected between 0 and 1 @name per mixin or function.
> ** Ignores private functions and mixins. **
## Information about @name
http://sassdoc.com/annotations/#name
### Description:
Provide a custom name for the documented item
```text
Multiple: false
Default: item.context.name
Aliases: —
Autofilled: true
Allowed on: functions, mixins, placeholders, variables
Extra notes: Only useful when wanting to override the self parsed name.
```
### Example of usage
```scss
/// @name message-[error|warning|success|info]
```