|
13 | 13 | /** |
14 | 14 | * Shorthand for positioning. |
15 | 15 | * @link http://hugogiraudel.com/2013/08/05/offsets-sass-mixin/ Documentation |
16 | | - * |
| 16 | + * |
17 | 17 | * @access private |
18 | | - * |
| 18 | + * |
19 | 19 | * @requires is-valid-length |
20 | | - * |
| 20 | + * |
21 | 21 | * @param {String} $position - Position type (either `absolute`, `fixed` or `relative`) |
22 | 22 | * @param {List} $args (()) - List of offsets and values |
23 | 23 | * |
|
59 | 59 | * Shorthand for absolute positioning. |
60 | 60 | * |
61 | 61 | * @link http://hugogiraudel.com/2014/05/19/new-offsets-sass-mixin/ Documentation |
62 | | - * |
| 62 | + * |
63 | 63 | * @requires {mixin} position |
64 | | - * |
| 64 | + * |
65 | 65 | * @param {List} $args - List of offsets and values |
66 | 66 | */ |
67 | 67 | @mixin absolute($args) { |
|
73 | 73 | * Shorthand for relative positioning. |
74 | 74 | * |
75 | 75 | * @link http://hugogiraudel.com/2014/05/19/new-offsets-sass-mixin/ Documentation |
76 | | - * |
| 76 | + * |
77 | 77 | * @requires {mixin} position |
78 | | - * |
| 78 | + * |
79 | 79 | * @param {List} $args - List of offsets and values |
80 | 80 | */ |
81 | 81 | @mixin relative($args) { |
|
87 | 87 | * Shorthand for fixed positioning. |
88 | 88 | * |
89 | 89 | * @link http://hugogiraudel.com/2014/05/19/new-offsets-sass-mixin/ Documentation |
90 | | - * |
| 90 | + * |
91 | 91 | * @requires {mixin} position |
92 | | - * |
| 92 | + * |
93 | 93 | * @param {List} $args - List of offsets and values |
94 | 94 | */ |
95 | 95 | @mixin fixed($args) { |
|
101 | 101 | * Responsive manager. |
102 | 102 | * |
103 | 103 | * @requires {variable} breakpoints |
104 | | - * |
| 104 | + * |
105 | 105 | * @param {String} $breakpoint - Breakpoint |
106 | 106 | * |
107 | 107 | * @throws No value found for `$breakpoint`. Please make sure it is defined in `$breakpoints` map. |
|
114 | 114 | @content; |
115 | 115 | } |
116 | 116 | } |
117 | | - |
| 117 | + |
118 | 118 | // If the key doesn't exist in the map |
119 | 119 | @else { |
120 | 120 | @warn "No value found for `#{$breakpoint}`. " |
|
125 | 125 |
|
126 | 126 | /** |
127 | 127 | * Mixin to fake CSS triangles with border hacks. |
128 | | - * |
| 128 | + * |
129 | 129 | * @requires {mixin} absolute |
130 | 130 | * @requires {mixin} size |
131 | 131 | * @requires {function} opposite-direction |
132 | 132 | * @requires {function} z |
133 | | - * |
| 133 | + * |
134 | 134 | * @param {String} $direction - Triangle direction |
135 | 135 | * @param {List} $position - Triangle position |
136 | 136 | * @param {Color} $color (currentcolor) - Triangle color |
|
167 | 167 |
|
168 | 168 | /** |
169 | 169 | * Mixin to handle cross browser keyframes for CSS animations. |
170 | | - * |
| 170 | + * |
171 | 171 | * @param {String} $name - Animation name |
172 | 172 | */ |
173 | 173 | @mixin keyframes($name) { |
|
183 | 183 |
|
184 | 184 | /** |
185 | 185 | * Mixin to prefix properties that are not prefixed by Compass |
186 | | - * |
| 186 | + * |
| 187 | + * @example |
| 188 | + * @include prefixer('transform', 'translate(10px)'); |
| 189 | + * |
187 | 190 | * @param {String} $property - Property to prefix |
188 | 191 | * @param {*} $value - Value for property |
189 | 192 | * @param {List} $vendors (webkit moz ms o) - Vendor prefixes to output |
|
202 | 205 | /** |
203 | 206 | * Mixin for cross-browser opacity (IE 8). |
204 | 207 | * Clamps the value between 0 and 1. |
205 | | - * |
| 208 | + * |
206 | 209 | * @requires {function} clamp |
207 | | - * |
| 210 | + * |
208 | 211 | * @param {Number} $opacity - Opacity level, between 0 and 1 |
209 | 212 | */ |
210 | 213 | @mixin opacity($opacity) { |
|
215 | 218 |
|
216 | 219 |
|
217 | 220 | /* |
218 | | - * Mixin handling inline-block and vertical-align at once. |
| 221 | + * Mixin handling inline-block and vertical-align at once. |
219 | 222 | * If no align is specified, then the `vertical-align` property won't be output. |
220 | | - * |
| 223 | + * |
221 | 224 | * @param {String} $align (null) - Vertical align |
222 | 225 | */ |
223 | 226 | @mixin inline-block($align: null) { |
|
0 commit comments