stylelint-sassdoc/src/rules/atExample/README.md

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

# atExample
Expected at least one example per mixin or function annotated with @example.
> ** Ignores private functions, mixins, variables. **

## Options (to-do)
string: "function"|"mixin"|"placeholder"|"variable"

Allow config of which of the four allowed values to check for @example.

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

Define which rules to check against.

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

### Description:
Describes a use case for the documented item, with a given language and description if specified
```text
Multiple: true
Default: —
Aliases: —
Autofilled: false
Allowed on: functions, mixins, placeholders, variables
Extra notes: Lines starting with @ need to be indented to work correctly.
            First word on the same line as @example is the language for syntax highlighting.
            Currently supported languages: css, scss, markup, javascript. New languages on demand.
            Everything but the first word on the same line as @example is the description.
            Hyphen (-) before description is optional.
            Description is parsed as Markdown.*
```

### Example of usage
```scss
/// Mixin to include a set of properties on a specific breakpoint
/// @name breakpoint.media-query
/// @param {Key} $id - ID of the breakpoint
/// @example
///   @include breakpoint.media-query(large-min) {
///       background-color: hotpink;
///   }
@mixin media-query($id) {...}
```