piecss 0.1.6.5.1 → 0.1.7

data/sass/piecss/utilities/_layout.scss

@@ -26,15 +26,15 @@
 // 1. FUNCTIONS
 
 
-/**
- * Convert a fraction to a percentage.
- *
- * @deprecated
- *
- * @param {Number} $fraction (1/3) - A fraction, e.g. 1/2
- *
- * @return {Number} - The resulting percentage value
- */
+///
+/// Convert a fraction to a percentage.
+///
+/// @deprecated
+///
+/// @param {Number} $fraction (1/3) - A fraction, e.g. 1/2
+///
+/// @return {Number} - The resulting percentage value
+///
 
 @function fraction-to-percentage($fraction: 1/3)
 {
@@ -42,24 +42,24 @@
 }
 
 
-/**
- * Convert a fraction to a word.
- * Used to build style rules based on column widths.
- * For values up to #/16.
- *
- * @example scss
- *  .#{fraction-to-text(1/2)} {
- *      // Column properties }
- *  // Output:
- *  .half {
- *     // Column properties }
- *
- * @since 0.1
- *
- * @param {Number} $fraction - A fraction, e.g. 1/2
- *
- * @return {String}
- */
+///
+/// Convert a fraction to a word.
+/// Used to build style rules based on column widths.
+/// For values up to #/16.
+///
+/// @example scss
+///  .#{fraction-to-text(1/2)} {
+///      // Column properties }
+///  // Output:
+///  .half {
+///     // Column properties }
+///
+/// @since 0.1
+///
+/// @param {Number} $fraction - A fraction, e.g. 1/2
+///
+/// @return {String}
+///
 
 @function fraction-to-text($fraction)
 {
@@ -153,15 +153,15 @@
 }
 
 
-/**
- * Get layout settings from a layout map
- *
- *
- * @param {String} $breakpoints - A valid breakpoint
- * @param {Map} $page - An optional page layout
- *
- * @return {Map} - A breakpoint global layout, or a breakpoint nested page layout from [$layouts map](./#variable-layouts)
- */
+///
+/// Get layout settings from a layout map
+///
+///
+/// @param {String} $breakpoints - A valid breakpoint
+/// @param {Map} $page - An optional page layout
+///
+/// @return {Map} - A breakpoint global layout, or a breakpoint nested page layout from [$layouts map](./#variable-layouts)
+///
 
 @function get-layout($breakpoint, $page: null) {
     $layout: map-get($layouts, $breakpoint);
@@ -175,16 +175,16 @@
 // 2. MIXINS
 
 
-/**
- * Shorthand mixin for column.
- * Uses padding by default, can be overridden to use margins instead which is especially helpful when assigning backgrounds or borders.
- *
- * @since 0.1
- * 
- * @param {Number} $fraction (1/1) - A fraction, e.g. 1/2
- * @param {Number | Bool} $apply-padding (1/2) - A fraction, e.g. 1/2, or false
- * @param {Number | Bool} $apply-margin (false) - A fraction, e.g. 1/2, or false
- */
+///
+/// Shorthand mixin for column.
+/// Uses padding by default, can be overridden to use margins instead which is especially helpful when assigning backgrounds or borders.
+///
+/// @since 0.1
+/// 
+/// @param {Number} $fraction (1/1) - A fraction, e.g. 1/2
+/// @param {Number | Bool} $apply-padding (1/2) - A fraction, e.g. 1/2, or false
+/// @param {Number | Bool} $apply-margin (false) - A fraction, e.g. 1/2, or false
+///
 
 @mixin column($fraction: 1/1, $apply-padding: 1/2, $apply-margin: false)
 {
@@ -201,14 +201,14 @@
 }
 
 
-/**
- * Mixin column-behavior: prepares an element to behave as a column. Widths must be set separately with [column-width](./#mixin-column-width).
- *
- * @since 0.1
- * 
- * @param {Bool} $column-float (false) - If true, render columns as left floated block element. If false, render as inline-blocks.
- * @param {Bool | Number} $negative-right-margin (false) - If set, applies a negative right margin to force inline-blocks to render without gaps. Only use this if you cannot minify your markup.
- */
+///
+/// Mixin column-behavior: prepares an element to behave as a column. Widths must be set separately with [column-width](./#mixin-column-width).
+///
+/// @since 0.1
+/// 
+/// @param {Bool} $column-float (false) - If true, render columns as left floated block element. If false, render as inline-blocks.
+/// @param {Bool | Number} $negative-right-margin (false) - If set, applies a negative right margin to force inline-blocks to render without gaps. Only use this if you cannot minify your markup.
+///
 
 @mixin column-behavior($column-float: $column-float, $negative-right-margin: $negative-right-margin)
 {
@@ -225,13 +225,13 @@
 }
 
 
-/**
- * Mixin column-width. If [$negative-right-margin]() is set, it will automatically remove if from columns that span the full width of their containers.
- *
- * @since 0.1
- * 
- * @param {Number} $fraction (1/1) - A fraction, e.g. 1/2
- */
+///
+/// Mixin column-width. If [$negative-right-margin]() is set, it will automatically remove if from columns that span the full width of their containers.
+///
+/// @since 0.1
+/// 
+/// @param {Number} $fraction (1/1) - A fraction, e.g. 1/2
+///
 
 @mixin column-width($fraction: $column-width-default)
 {
@@ -244,14 +244,14 @@
 }
 
 
-/**
- * Mixes in gutter properties. Gutters are declared inside the column (padding) by default, on both sides. Can be overridden to use margins instead, which is helpful when assigning backgrounds or borders
- *
- * @since 0.1
- * 
- * @param {Number} $fraction (1/2) - A fraction, e.g. 1/2
- * @param {Bool} $use-margin (false) - If true, will render gutters outside the column using margins
- */
+///
+/// Mixes in gutter properties. Gutters are declared inside the column (padding) by default, on both sides. Can be overridden to use margins instead, which is helpful when assigning backgrounds or borders
+///
+/// @since 0.1
+/// 
+/// @param {Number} $fraction (1/2) - A fraction, e.g. 1/2
+/// @param {Bool} $use-margin (false) - If true, will render gutters outside the column using margins
+///
 
 @mixin gutters($fraction: 1/2, $use-margin: false)
 {
@@ -284,13 +284,13 @@
 }
 
 
-/**
- * Fixes content width and aligns in viewport. [$root-position](./#variable-root-position) is defind in grid settings. Centers content inside the viewport by default.
- *
- * @since 0.1
- * 
- * @param {Number} $root-max-width (72em) - The maximum width of your content
- */
+///
+/// Fixes content width and aligns in viewport. [$root-position](./#variable-root-position) is defind in grid settings. Centers content inside the viewport by default.
+///
+/// @since 0.1
+/// 
+/// @param {Number} $root-max-width (72em) - The maximum width of your content
+///
 
 @mixin root($root-max-width: $root-max-width, $set-display: false)
 {
@@ -302,13 +302,13 @@
 }
 
 
-/**
- * Use it to remove column spacing on columns
- *
- * @since 0.1
- * 
- * @param {Bool} $use-margin (false)
- */
+///
+/// Use it to remove column spacing on columns
+///
+/// @since 0.1
+/// 
+/// @param {Bool} $use-margin (false)
+///
 
 @mixin container-behavior($use-margin: false)
 {
@@ -323,14 +323,14 @@
 }
 
 
-/**
- * Mixin to reverse padding on a container.
- * Use it to remove padded column spacing on columns, helpful when nesting columns and when applying backgrounds.
- *
- * @since 0.1
- * 
- * @param {Number} $fraction (1/2) - A fraction, e.g. 1/2
- */
+///
+/// Mixin to reverse padding on a container.
+/// Use it to remove padded column spacing on columns, helpful when nesting columns and when applying backgrounds.
+///
+/// @since 0.1
+/// 
+/// @param {Number} $fraction (1/2) - A fraction, e.g. 1/2
+///
 
 @mixin bleed($fraction: -1/2)
 {
@@ -338,13 +338,13 @@
 }
 
 
-/**
- * Mixin for soure ordering
- *
- * @since 0.1
- * 
- * @param {Number} $fraction (1/2) - A fraction, e.g. 1/2
- */
+///
+/// Mixin for soure ordering
+///
+/// @since 0.1
+/// 
+/// @param {Number} $fraction (1/2) - A fraction, e.g. 1/2
+///
 
 @mixin move($fraction)
 {
@@ -352,9 +352,9 @@
 }
 
 
-/**
- * @alias move
- */
+///
+/// @alias move
+///
 
 @mixin push($fraction)
 {
@@ -362,9 +362,9 @@
 }
 
 
-/**
- * @alias move
- */
+///
+/// @alias move
+///
 
 @mixin pull($fraction)
 {
@@ -372,12 +372,12 @@
 }
 
 
-/**
- * Mixin for soure ordering.
- * Will reset positioning for smallest breakpoint.
- *
- * @since 0.1
- */
+///
+/// Mixin for soure ordering.
+/// Will reset positioning for smallest breakpoint.
+///
+/// @since 0.1
+///
 
 @mixin reset-source-order()
 {
@@ -390,11 +390,11 @@
 }
 
 
-/**
- * Reveals the document's horizontal rhythm. Will automatically be mixed in when [$debug-layout](./#variable-debug-layout) is set to true.
- *
- * @since 0.1
- */
+///
+/// Reveals the document's horizontal rhythm. Will automatically be mixed in when [$debug-layout](./#variable-debug-layout) is set to true.
+///
+/// @since 0.1
+///
 
 @mixin debug-layout($columns: $columns, $color: #000, $gutter-width: $gutter-width)
 {

data/sass/piecss/utilities/_list.scss

@@ -9,18 +9,18 @@
 // 1. Mixins
 
 
-/**
- * Mixin a list-style-type
- * @example scss
- *  @include list-style-type(bullet);
- *
- * @since 0.1
- *
- * @param {String} $type
- */
+///
+/// Mixin a list-style-type
+/// @example scss
+///  @include list-style-type(bullet);
+///
+/// @since 0.1
+///
+/// @param {String} $type
+///
 
 @mixin list-style-type($type) {
 	%#{$list-selector}--#{$type} {
 		list-style-type: $type;
 	}
-}
+}

data/sass/piecss/utilities/_miscellaneous.scss

@@ -16,15 +16,15 @@
 // 1. Functions
 
 
-/**
- * Converts a value to a proper boolean value
- * 
- * @since 0.1
- *
- * @param {*} $value
- *
- * @return {Bool}
- */
+///
+/// Converts a value to a proper boolean value
+/// 
+/// @since 0.1
+///
+/// @param {*} $value
+///
+/// @return {Bool}
+///
 
 @function to-bool($value) {
   @if not $value or $value == "" or $value == 0 {
@@ -33,20 +33,20 @@
   @return true;
 }
 
-/**
- * Converts a list of property values to a property map. Use to convert 'old-style' associative arrays to SASS's new Map type.
- * 
- * @example
- * list-to-map((color #FFF, text-align left))
- *  // Output:
- *  (color: #FFF, text-align: left)
- *
- * @since 0.1
- *
- * @param {List} $properties
- *
- * @return {Map}
- */
+///
+/// Converts a list of property values to a property map. Use to convert 'old-style' associative arrays to SASS's new Map type.
+/// 
+/// @example
+/// list-to-map((color #FFF, text-align left))
+///  // Output:
+///  (color: #FFF, text-align: left)
+///
+/// @since 0.1
+///
+/// @param {List} $properties
+///
+/// @return {Map}
+///
 
 @function list-to-map($properties)
 {
@@ -62,14 +62,14 @@
 // 2. Mixins
 
 
-/**
- * Mixin for border properties
- * 
- * @since 0.1
- *
- * @param {String | Map | List | Numner} $values - The border (or outline) properties
- * @param {Bool} $outline - If true, will render the values as outline properties
- */
+///
+/// Mixin for border properties
+/// 
+/// @since 0.1
+///
+/// @param {String | Map | List | Numner} $values - The border (or outline) properties
+/// @param {Bool} $outline - If true, will render the values as outline properties
+///
 
 @mixin border($values, $outline: false)
 {
@@ -97,9 +97,9 @@
 
 }
 
-/**
- * @alias border
- */
+///
+/// @alias border
+///
 
 @mixin outline($attributes)
 {
@@ -107,13 +107,13 @@
 }
 
 
-/**
- * Provides a cross-browser method to implement opacity. This replaces [Compass's](http://compass-style.org/reference/compass/css3/opacity/) mixin by the same name with a more accessible implementation.
- * 
- * @since 0.1
- *
- * @param {Number} $opacity - A number between 0 and 1, where 0 is transparent and 1 is opaque.
- */
+///
+/// Provides a cross-browser method to implement opacity. This replaces [Compass's](http://compass-style.org/reference/compass/css3/opacity/) mixin by the same name with a more accessible implementation.
+/// 
+/// @since 0.1
+///
+/// @param {Number} $opacity - A number between 0 and 1, where 0 is transparent and 1 is opaque.
+///
 
 @mixin opacity($opacity) {
     @include old-ie() {
@@ -123,15 +123,15 @@
 }
 
 
-/**
- * Conditional mixin of property
- * 
- * @since 0.1
- * @deprecated
- *
- * @param {String} $property - A CSS property
- * @param {Bool | *} $value - A value for the property, or false if the property should not be rendered.
- */
+///
+/// Conditional mixin of property
+/// 
+/// @since 0.1
+/// @deprecated
+///
+/// @param {String} $property - A CSS property
+/// @param {Bool | *} $value - A value for the property, or false if the property should not be rendered.
+///
 
 @mixin property($property, $value)
 {
@@ -140,14 +140,14 @@
     }
 }
 
-/**
- * Support for old-mozilla, cuse it to separate old-ie declarations from your other declarations with either a separate stylesheet or added specificity (Modernizr). 
- * 
- * @since 0.1
- *
- * @example
- *  @include old-ie() { // properties }
- */
+///
+/// Support for old-mozilla, cuse it to separate old-ie declarations from your other declarations with either a separate stylesheet or added specificity (Modernizr). 
+/// 
+/// @since 0.1
+///
+/// @example
+///  @include old-ie() { // properties }
+///
 
 @mixin old-ie() {
     @if $legacy-support-for-ie {
@@ -156,14 +156,14 @@
 }
 
 
-/**
- * Support for old-mozilla, cuse it to separate old-mozilla declarations from your other declarations with either a separate stylesheet or added specificity (Modernizr). 
- * 
- * @since 0.1
- *
- * @example
- *  @include old-mozilla() { // properties }
- */
+///
+/// Support for old-mozilla, cuse it to separate old-mozilla declarations from your other declarations with either a separate stylesheet or added specificity (Modernizr). 
+/// 
+/// @since 0.1
+///
+/// @example
+///  @include old-mozilla() { // properties }
+///
 
 @mixin old-mozilla() {
     @if $legacy-support-for-mozilla {
@@ -172,17 +172,17 @@
 }
 
 
-/**
- * Provides a cross-browser method to implement display: inline-block;. This replaces [Compass's](http://compass-style.org/reference/compass/css3/inline_block/) mixin by the same name with a more accessible implementation.
- * See for valid property values: [http://www.w3schools.com/cssref/pr_pos_vertical-align.asp](http://www.w3schools.com/cssref/pr_pos_vertical-align.asp)
- * 
- * @since 0.1
- *
- * @example
- *  @include inline-block(baseline); 
- *
- * @param {String} $vertical-alignment (baseline) - Set $inline-block-alignment to none or false to disable the output of a vertical-align property in the inline-block mixin. Or set it to a legal value for vertical-align to change the default.
- */
+///
+/// Provides a cross-browser method to implement display: inline-block;. This replaces [Compass's](http://compass-style.org/reference/compass/css3/inline_block/) mixin by the same name with a more accessible implementation.
+/// See for valid property values: [http://www.w3schools.com/cssref/pr_pos_vertical-align.asp](http://www.w3schools.com/cssref/pr_pos_vertical-align.asp)
+/// 
+/// @since 0.1
+///
+/// @example
+///  @include inline-block(baseline); 
+///
+/// @param {String} $vertical-alignment (baseline) - Set $inline-block-alignment to none or false to disable the output of a vertical-align property in the inline-block mixin. Or set it to a legal value for vertical-align to change the default.
+///
 
 @mixin inline-block($vertical-alignment: baseline) {
     $vertical-alignment: unquote($vertical-alignment);
@@ -203,13 +203,13 @@
     }
 }
 
-/**
- * Accepts a string which a valid appearance
- *
- * @since 0.1
- *
- * @param {String} $appearance
- */
+///
+/// Accepts a string which a valid appearance
+///
+/// @since 0.1
+///
+/// @param {String} $appearance
+///
 
 @mixin reset-appearance($appearance)
 {
@@ -220,13 +220,13 @@
 
 
 
-/**
- * Accepts a string which a valid appearance
- *
- * @since 0.1
- *
- * @param {String} $appearance
- */
+///
+/// Accepts a string which a valid appearance
+///
+/// @since 0.1
+///
+/// @param {String} $appearance
+///
 
 @mixin reset-webkit-appearance($appearance)
 {
@@ -234,15 +234,15 @@
 }
 
 
-/**
- * Accepts a string which a valid appearance
- *
- * @since 0.1
- *
- * @param {String} $appearance
- */
+///
+/// Accepts a string which a valid appearance
+///
+/// @since 0.1
+///
+/// @param {String} $appearance
+///
 
 @mixin reset-mozilla-appearance($appearance)
 {
     -moz-appearance: $appearance; /* mobile firefox too! */
-}
+}