UNPKG

stylelint-sassdoc

Version:

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

34 lines (27 loc) • 947 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# atParam Checks if there are as many @param definitions in the comments as there are params in the function or mixin. Also checks if they have a {type} declaration. > ** Ignores private functions and mixins. ** ## Options (to-do) string: "both"|"private"|"public" Define which rules to check against. ## Information about @param http://sassdoc.com/annotations/#parameter ### Description: Describes a parameter of the documented item - Multiple true - Default — - Aliases @arg, @argument, @param, @parameter - Autofilled false - Allowed on functions, mixins - Extra notes Default value is optional. - Description is optional. Hyphen before description is optional. - Description is parsed as Markdown.* - Multiple types should be separated by pipes (|). ### Example of usage ```scss /// @param {type} $name /// @param {type | othertype} $name /// @param {type} $name - description /// @param {type} $name [default value] - description ```