piecss 0.1.6.5.1 → 0.1.7

data/sass/piecss/utilities/_rhythm.scss

@@ -16,16 +16,16 @@
 
 // 1. Functions
 
-/**
- * Calculates a value based on the [$rhythm](./#variable-rhythm).
- * 
- * @since 0.1
- * @access private
- *
- * @param {Int | Fraction} $units (1) - The number of -rhythm-units (whole or fraction) to span
- *
- * @return {Number} - The calculated span in px
- */
+///
+/// Calculates a value based on the [$rhythm](./#variable-rhythm).
+/// 
+/// @since 0.1
+/// @access private
+///
+/// @param {Int | Fraction} $units (1) - The number of -rhythm-units (whole or fraction) to span
+///
+/// @return {Number} - The calculated span in px
+///
 
 @function -rhythm-units($units: 1)
 {
@@ -33,19 +33,19 @@
 }
 
 
-/**
- * Find the optimal rhythm units for a given size in px.
- * If the specified span is too small for the size, find the next best one 
- * based on a specified increment.
- *
- * @since 0.1
- * 
- * @param {Number} $units - The number of rhythm units to span (whole or fraction), 1 equals 1 $rhythm
- * @param {Number} $size-px - The size in px
- * @param {Number} $increment - The increment in rhythm-units (whole or fraction)
- *
- * @return {Number} - The calculated span in px
- */
+///
+/// Find the optimal rhythm units for a given size in px.
+/// If the specified span is too small for the size, find the next best one 
+/// based on a specified increment.
+///
+/// @since 0.1
+/// 
+/// @param {Number} $units - The number of rhythm units to span (whole or fraction), 1 equals 1 $rhythm
+/// @param {Number} $size-px - The size in px
+/// @param {Number} $increment - The increment in rhythm-units (whole or fraction)
+///
+/// @return {Number} - The calculated span in px
+///
 
 @function rhythm($args...)
 {
@@ -84,18 +84,18 @@
 
 // 2. MIXINS
 
-/**
- * Use for left and right margins and paddings. Uses  [$gutter-width](./#variable-gutter-width) declared in grid settings
- *
- * @example
- *  @include rhythm(1, padding-left);
- * 
- * @since 0.1
- *
- * @param {Number} $units - The fraction of the gutter measurement
- * @param {String} $property - The property to be set, e.g. padding, margin-left
- * @param {Number} $context (16px) - The font-size context
- */
+///
+/// Use for left and right margins and paddings. Uses  [$gutter-width](./#variable-gutter-width) declared in grid settings
+///
+/// @example
+///  @include rhythm(1, padding-left);
+/// 
+/// @since 0.1
+///
+/// @param {Number} $units - The fraction of the gutter measurement
+/// @param {String} $property - The property to be set, e.g. padding, margin-left
+/// @param {Number} $context (16px) - The font-size context
+///
 
 @mixin rhythm($units, $property, $context: $default-font-size) 
 {
@@ -109,11 +109,11 @@
 }
 
 
-/**
- * Reveals the document's vertical rhythm. Will automatically be mixed in when [$debug-rhythm](./#variable-debug-rhythm) is set to true.
- *
- * @since 0.1
- */
+///
+/// Reveals the document's vertical rhythm. Will automatically be mixed in when [$debug-rhythm](./#variable-debug-rhythm) is set to true.
+///
+/// @since 0.1
+///
 
 @mixin debug-rhythm()
 {
@@ -124,11 +124,11 @@
     background-image: linear-gradient($from 50%, $to 50%);
     background-size: 2*$default-line-height 2*$default-line-height;
 
-    * {
+/// {
         background-color: transparent !important;
         background-image: none !important;
         outline: rgba(255,0,255,.1) dotted 1px;
         outline: #D6D6D6 dotted 1px;
         outline: lighten(rgb(255,0,255),.1) dotted 1px \9;
     }
-}
+}

data/sass/piecss/utilities/_side.scss

@@ -15,14 +15,14 @@
 // 1. FUNCTIONS
 
 
-/**
- * Takes a list of values and keys and returns a spacing map.
- *
- * @since 0.1
- *
- * @param {List} $values - A list of value arguments like CSS's normal padding (0 0 0 0)
- * @param {String} $property (padding) - The property to which the values should be applied
- */
+///
+/// Takes a list of values and keys and returns a spacing map.
+///
+/// @since 0.1
+///
+/// @param {List} $values - A list of value arguments like CSS's normal padding (0 0 0 0)
+/// @param {String} $property (padding) - The property to which the values should be applied
+///
 
 @function value-map($values, $keys: $keys-side) {
 
@@ -42,16 +42,16 @@
     @return $map;
 }
 
-/**
- * Checks if a Map is a proper value-map by checking for specific keys.
- *
- * @since 0.1
- *
- * @param {List} $values - The value to test, can be a single number or a list
- * @param {List} $keys ($keys-side) - A list of keys to match
- *
- * @return {Bool}
- */
+///
+/// Checks if a Map is a proper value-map by checking for specific keys.
+///
+/// @since 0.1
+///
+/// @param {List} $values - The value to test, can be a single number or a list
+/// @param {List} $keys ($keys-side) - A list of keys to match
+///
+/// @return {Bool}
+///
 
 @function is-value-map($values, $keys: $keys-side) {
 
@@ -71,18 +71,18 @@
     @return $is-map;
 }
 
-/**
- * Converts values in a (one-dimensional) map to the specified [unit](./#variable-unit).
- *
- * @since 0.1
- *
- * @throws Argument $map needs to be a map.
- *
- * @param {List} $values - The value to test, can be a single number or a list
- * @param {Number} $unit ($unit) - A list of keys to match
- *
- * @return {Map}
- */
+///
+/// Converts values in a (one-dimensional) map to the specified [unit](./#variable-unit).
+///
+/// @since 0.1
+///
+/// @throws Argument $map needs to be a map.
+///
+/// @param {List} $values - The value to test, can be a single number or a list
+/// @param {Number} $unit ($unit) - A list of keys to match
+///
+/// @return {Map}
+///
 
 @function value-map-to-unit($map, $unit: $unit) {
 
@@ -99,18 +99,18 @@
     @return $map;   
 }
 
-/**
- * This function takes a space separated list of padding or margin values and completes it into a list of four side values.
- *
- * @since 0.1
- * @access private
- *
- * @throws Argument $values needs to be a list.
- *
- * @param {List} $values - The value to test, can be a single number or a list
- *
- * @return {List}
- */
+///
+/// This function takes a space separated list of padding or margin values and completes it into a list of four side values.
+///
+/// @since 0.1
+/// @access private
+///
+/// @throws Argument $values needs to be a list.
+///
+/// @param {List} $values - The value to test, can be a single number or a list
+///
+/// @return {List}
+///
 @function -sides($values) {
 
     @if type-of($values)==map {
@@ -137,141 +137,141 @@
 // 2. MIXINS
 
 
-/**
- * Mixin padding for any or all sides, in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
- * 
- * @since 0.1
- * 
- * @param {Map} $sides - A spacing map in px (top:0,right:0,bottom:0,left:0)
- */
+///
+/// Mixin padding for any or all sides, in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
+/// 
+/// @since 0.1
+/// 
+/// @param {Map} $sides - A spacing map in px (top:0,right:0,bottom:0,left:0)
+///
 
 @mixin padding($values) {
 
     @include -unit-sides($values, padding);
 }
 
-/**
- * Mixin top padding in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
- * 
- * @since 0.1
- * 
- * @param {Number} $value - A value in px
- */
+///
+/// Mixin top padding in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
+/// 
+/// @since 0.1
+/// 
+/// @param {Number} $value - A value in px
+///
 
 @mixin padding-top($value) {
     @include -unit-sides((top: $value), padding);
 }
 
-/**
- * Mixin right padding in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
- * 
- * @since 0.1
- * 
- * @param {Number} $value - A value in px
- */
+///
+/// Mixin right padding in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
+/// 
+/// @since 0.1
+/// 
+/// @param {Number} $value - A value in px
+///
 
 @mixin padding-right($value) {
     @include -unit-sides((right: $value), padding);
 }
 
-/**
- * Mixin bottom padding in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
- * 
- * @since 0.1
- * 
- * @param {Number} $value - A value in px
- */
+///
+/// Mixin bottom padding in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
+/// 
+/// @since 0.1
+/// 
+/// @param {Number} $value - A value in px
+///
 
 @mixin padding-bottom($value) {
     @include -unit-sides((bottom: $value), padding);
 }
 
-/**
- * Mixin left padding in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
- * 
- * @since 0.1
- * 
- * @param {Number} $value - A value in px
- */
+///
+/// Mixin left padding in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
+/// 
+/// @since 0.1
+/// 
+/// @param {Number} $value - A value in px
+///
 
 @mixin padding-left($value) {
     @include -unit-sides((left: $value), padding);
 }
 
 
-/**
- * Mixin margin for any or all sides, in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
- * 
- * @since 0.1
- * 
- * @param {Map} $sides - A spacing map in px (top:0,right:0,bottom:0,left:0)
- */
+///
+/// Mixin margin for any or all sides, in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
+/// 
+/// @since 0.1
+/// 
+/// @param {Map} $sides - A spacing map in px (top:0,right:0,bottom:0,left:0)
+///
 
 @mixin margin($values) {
 
     @include -unit-sides($values, margin);
 }
 
-/**
- * Mixin top margin in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
- * 
- * @since 0.1
- * 
- * @param {Number} $value - A value in px
- */
+///
+/// Mixin top margin in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
+/// 
+/// @since 0.1
+/// 
+/// @param {Number} $value - A value in px
+///
 
 @mixin margin-top($value) {
     @include -unit-sides((top: $value), margin);
 }
 
-/**
- * Mixin right margin in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
- * 
- * @since 0.1
- * 
- * @param {Number} $value - A value in px
- */
+///
+/// Mixin right margin in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
+/// 
+/// @since 0.1
+/// 
+/// @param {Number} $value - A value in px
+///
 
 @mixin margin-right($value) {
     @include -unit-sides((right: $value), margin);
 }
 
-/**
- * Mixin bottom margin in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
- * 
- * @since 0.1
- * 
- * @param {Number} $value - A value in px
- */
+///
+/// Mixin bottom margin in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
+/// 
+/// @since 0.1
+/// 
+/// @param {Number} $value - A value in px
+///
 
 @mixin margin-bottom($value) {
     @include -unit-sides((bottom: $value), margin);
 }
 
-/**
- * Mixin right margin in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
- * 
- * @since 0.1
- * 
- * @param {Number} $value - A value in px
- */
+///
+/// Mixin right margin in final unit (defaults to em). The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used. With rem fallback if the final unit of output is rem.
+/// 
+/// @since 0.1
+/// 
+/// @param {Number} $value - A value in px
+///
 
 @mixin margin-left($value) {
     @include -unit-sides((left: $value), margin);
 }
 
 
-/**
- * Like [-sides](./#mixin--sides), but with rem fallback if the final unit is rem
- *
- * @access private
- *
- * @since 0.1
- *
- * @param {Map} $sides - A spacing map in final values (top:0,right:0,bottom:0,left:0)
- * @param {String} $property - The property to apply the values to (padding, margin)
- * @param {Number} $unit ($unit) - The final unit to which $target-px is converted, e.g. 1px, 1rem, 1em, 1%
- */
+///
+/// Like [-sides](./#mixin--sides), but with rem fallback if the final unit is rem
+///
+/// @access private
+///
+/// @since 0.1
+///
+/// @param {Map} $sides - A spacing map in final values (top:0,right:0,bottom:0,left:0)
+/// @param {String} $property - The property to apply the values to (padding, margin)
+/// @param {Number} $unit ($unit) - The final unit to which $target-px is converted, e.g. 1px, 1rem, 1em, 1%
+///
 
 @mixin -unit-sides($values, $property: padding, $unit: $unit) {
 
@@ -294,18 +294,18 @@
 }
 
 
-/**
- * Mixin the value for any or all sides for padding or margin. The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used.
- * 
- * @access private
- * 
- * @since 0.1
- *
- * @throws 'Argument $map needs to be a value map of four side (top, right, bottom, left) values. Mixin -sides aborted.';
- * 
- * @param {Map} $sides - A spacing map in final values (top:0,right:0,bottom:0,left:0)
- * @param {String} $property - The property to apply the values to (padding, margin)
- */
+///
+/// Mixin the value for any or all sides for padding or margin. The mixin will determine if the shorthand notation, or a single side (...-top, ...-right, ...-bottom, --left) should be used.
+/// 
+/// @access private
+/// 
+/// @since 0.1
+///
+/// @throws 'Argument $map needs to be a value map of four side (top, right, bottom, left) values. Mixin -sides aborted.';
+/// 
+/// @param {Map} $sides - A spacing map in final values (top:0,right:0,bottom:0,left:0)
+/// @param {String} $property - The property to apply the values to (padding, margin)
+///
 
 @mixin -sides($values, $property: padding) {
 
@@ -365,4 +365,4 @@
 
         }
     }
-}
+}