fix: doc block

felix-berlin · Aug 8, 2022 · 6ed1163 · 6ed1163
1 parent 62ec3c1
commit 6ed1163
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -59,9 +59,10 @@ Visit <https://sass-butler.kasimir.dev> for full documentation.
 - [basic](https://github.com/felix-berlin/sass-butler/blob/master/mixins/_basic.scss)
   - [select-style()](https://sass-butler.kasimir.dev/#basic-mixin-select-style)
   - [target-anchor-offset()](https://sass-butler.kasimir.dev/#basic-mixin-target-anchor-offset)
-- [breakpoint](https://github.com/felix-berlin/sass-butler/blob/master/mixins/_breakpoint.scss)
-  - [breakpoint()](https://sass-butler.kasimir.dev/#breakpoint-mixin-breakpoint)
-  - [feature()](https://sass-butler.kasimir.dev/#breakpoint-mixin-feature)
+- [@media](https://github.com/felix-berlin/sass-butler/blob/master/mixins/_breakpoint.scss)
+  - [breakpoint()](https://sass-butler.kasimir.dev/#@media-mixin-breakpoint)
+  - [feature()](https://sass-butler.kasimir.dev/#@media-mixin-feature)
+  - [hover]((https://sass-butler.kasimir.dev/#@media-mixin-hover))
 - [element](https://github.com/felix-berlin/sass-butler/blob/master/mixins/_element.scss)
   - [line-on-sides()](https://sass-butler.kasimir.dev/#element-mixin-line-on-sides)
   - [overlay()](https://sass-butler.kasimir.dev/#element-mixin-overlay)

diff --git a/mixins/_breakpoint.scss b/mixins/_breakpoint.scss
@@ -32,7 +32,7 @@ $breakpoints: (
 /// @param {String} $direction ['min'] Breakpoint direction min or max
 /// @param {Map} $breakpoint-map [$breakpoints] All breakpoint vars in one map
 /// @param {Number} $max-overlap [1] How much should the max-width breakpoint overlap the min-width one?
-/// @group Breakpoint
+/// @group @media
 /// @author Felix Scholze
 /// @since v1.1.0
 ///

diff --git a/mixins/_feature.scss b/mixins/_feature.scss
@@ -3,7 +3,7 @@
 /// Includes a feature @media query
 ///
 /// @param {String} $feature Feature Name
-/// @group Breakpoint
+/// @group @media
 /// @author Felix Scholze
 /// @since v1.4.0
 ///

diff --git a/mixins/_hover.scss b/mixins/_hover.scss
@@ -1,4 +1,19 @@
-@mixin hover(){
+/// Hover using @media hover:hover
+/// @group @media
+/// @author Felix Scholze
+/// @since v1.9.0
+///
+/// @example
+///    .my-selector {
+///      @include hover {...}
+///    }
+///
+/// @example CSS - Output CSS
+///    @media (hover: hover) {
+///       .my-selector:hover {...}
+///    }
+///
+@mixin hover {
   @media (hover: hover) {
     &:hover {
       @content;