Functions and Mixin documentation last part

Author: cedric07

src/scss/02-tools/_f-column.scss

@@ -34,7 +34,7 @@
  *
  * ------------------------------------------------------------------------------------
  *
- * 2/ Column full - Make a column that return a percent value of the full width container (100%) minus mobile external gutter width * 2
+ * 3/ Column full - Make a column that return a percent value of the full width container (100%) minus mobile external gutter width * 2
  *
  * @author Nicolas Langle
  *

src/scss/02-tools/_m-invisible-scrollbar.scss

@@ -13,6 +13,7 @@
  *      }
  *
  */
+
 @mixin line-clamp($lines: 2) {
     display: -webkit-box;
     overflow: hidden;

src/scss/02-tools/_m-line-clamp.scss

@@ -1,7 +1,21 @@
 @use "sass:math";
 
 /**
- * Placeholder media
+ * Placeholder media. Make placeholder for images or videos
+ *
+ * @author Nicolas Langle
+ *
+ * @param $width
+ * @param $height
+ * @param $targets
+ * @param $object-fit
+ *
+ * Examples :
+ *
+ *      .placeholder-media {
+ *          @include placeholder-media($width: 800px, $height: 400px, $object-fit: cover);
+ *      }
+ *
  */
 
 @mixin placeholder-media($width, $height, $targets: "img", $object-fit: "") {

src/scss/02-tools/_m-placeholder-media.scss

@@ -1,7 +1,11 @@
 /**
- * Reduced-motion
+ * Reduced-motion for animations
  *
- * exemples :
+ * @author Paolo Tesei
+ *
+ * @param $reduce
+ *
+ * Examples :
  *
  *      @include reduced-motion { ... }
  *          return @media screen and (prefers-reduced-motion : reduce) { ... }
@@ -10,17 +14,15 @@
  *
  *      @include reduced-motion (false) { ... }
  *          return @media screen and (prefers-reduced-motion : no-preference) { ... }
+ *
  */
 
-@mixin reduced-motion ($reduce: true) {
-
+@mixin reduced-motion($reduce: true) {
     @if ($reduce == true) {
-
         @media screen and (prefers-reduced-motion: reduce) {
             @content;
         }
     } @else {
-
         @media screen and (prefers-reduced-motion: no-preference) {
             @content;
         }

src/scss/02-tools/_m-reduced-motion.scss

@@ -1,5 +1,16 @@
 /**
- * Row fullwidth
+ * Row fullwidth -  Make a row fullwidth in a container element
+ *
+ * @author Nicolas Langle
+ *
+ * @param $position
+ *
+ * Examples :
+ *
+ *      .test {
+ *          @include row-fullwidth();
+ *      }
+ *
  */
 
 @mixin row-fullwidth($position: relative) {

src/scss/02-tools/_m-row-fullwidth.scss

@@ -1,4 +1,17 @@
-// Support for rtl text, explicit support for Arabic and Hebrew
+/**
+ * Support for rtl text, explicit support for Arabic and Hebrew
+ *
+ * @author Cédric Andrietti
+ *
+ * Examples :
+ *
+ *      .my-element {
+ *          @include rtl() {
+ *              ... your css
+ *          }
+ *      }
+ *
+ */
 
 @mixin rtl {
     *[dir="rtl"] &,

src/scss/02-tools/_m-rtl.scss

@@ -1,7 +1,32 @@
 /**
- * Scrollbar invisible
+ * Scrollbar - Make an invisible scrollbar and custom the scrollbar color
+ *
+ * ALERT : Don't use this mixin neither on the html element, nor on the body element to avoid deteriorating the accessibility
+ *
+ * @author Milan Ricoul
+ *
+ * 1/ Invisible scrollbar
+ *
+ * Examples :
+ *
+ *      .my-scrollbar {
+ *          @include scrollbar-invisible;
+ *      }
+ *
+ * ------------------------------------------------------------------------
+ *
+ * 1/ Scrollbar color
+ *
+ * @param $size
+ * @param $scrollbar-color
+ * @param $track-color
+ *
+ * Examples :
+ *
+ *      .my-scrollbar-custom {
+ *          @include scrollbar-color(10px, $color-primary, $color-dark);
+ *      }
  *
- *      /!\ ALERT : Don't use this mixin neither on the html element, nor on the body element to avoid deteriorating accessibility
  */
 
 @mixin scrollbar-invisible {
@@ -13,10 +38,6 @@
     }
 }
 
-/**
- * Scrollbar color
- */
-
 @mixin scrollbar-color($size, $scrollbar-color, $track-color) {
     &::-webkit-scrollbar {
         display: none;

src/scss/02-tools/_m-scrollbar.scss

@@ -2,6 +2,15 @@
 
 /**
  * Select custom
+ *
+ * @author Nicolas Langle
+ *
+ * Examples :
+ *
+ *      select {
+ *          @include select-custom;
+ *      }
+ *
  */
 
 @mixin select-custom {

src/scss/02-tools/_m-select-custom.scss

@@ -1,32 +1,45 @@
-/*
-	Improved screen reader only CSS class
-    @see https://gist.github.com/ffoodd/000b59f431e3e64e4ce1a24d5bb36034
-	@author Gaël Poupard
-		@note Based on Yahoo!'s technique
-		@author Thierry Koblentz
-		@see https://developer.yahoo.com/blogs/ydn/clip-hidden-content-better-accessibility-53456.html
-	* 1.
-		@note `clip` is deprecated but works everywhere
-		@see https://developer.mozilla.org/en-US/docs/Web/CSS/clip
-	* 2.
-		@note `clip-path` is the future-proof version, but not very well supported yet
-		@see https://developer.mozilla.org/en-US/docs/Web/CSS/clip-path
-		@see http://caniuse.com/#search=clip-path
-		@author Yvain Liechti
-		@see https://twitter.com/ryuran78/status/778943389819604992
-	* 3.
-		@note preventing text to be condensed
-		author J. Renée Beach
-		@see https://medium.com/@jessebeach/beware-smushed-off-screen-accessible-text-5952a4c2cbfe
-		@note Drupal 8 goes with word-wrap: normal instead
-		@see https://www.drupal.org/node/2045151
-		@see http://cgit.drupalcode.org/drupal/commit/?id=5b847ea
-	* 4.
-		@note !important is important
-		@note Obviously you wanna hide something
-		@author Harry Roberts
-		@see https://csswizardry.com/2016/05/the-importance-of-important/
-*/
+/**
+ * Improved screen reader only CSS class
+ * Source : https://gist.github.com/ffoodd/000b59f431e3e64e4ce1a24d5bb36034
+ *
+ * 1.
+ *      @note `clip` is deprecated but works everywhere
+ *      @see https://developer.mozilla.org/en-US/docs/Web/CSS/clip
+ *
+ * 2.
+ *		@note `clip-path` is the future-proof version, but not very well supported yet
+ *		@see https://developer.mozilla.org/en-US/docs/Web/CSS/clip-path
+ *		@see http://caniuse.com/#search=clip-path
+ *		@author Yvain Liechti
+ *		@see https://twitter.com/ryuran78/status/778943389819604992
+ *
+ * 3.
+ *		@note preventing text to be condensed
+ *		author J. Renée Beach
+ *		@see https://medium.com/@jessebeach/beware-smushed-off-screen-accessible-text-5952a4c2cbfe
+ *		@note Drupal 8 goes with word-wrap: normal instead
+ *		@see https://www.drupal.org/node/2045151
+ *		@see http://cgit.drupalcode.org/drupal/commit/?id=5b847ea
+ *
+ * 4.
+ *		@note !important is important
+ *		@note Obviously you wanna hide something
+ *		@author Harry Roberts
+ *		@see https://csswizardry.com/2016/05/the-importance-of-important/
+ *
+ * @param $focusable
+ *
+ * Examples :
+ *
+ *      my-sr-element {
+ *          @include sr-only();
+ *      }
+ *
+ *      my-sr-element-focusable {
+ *          @include sr-only(true);
+ *      }
+ *
+ */
 
 @mixin sr-only($focusable: false) {
     position: absolute;