Refine SassDoc comments and generate new settings file

diff --git a/scss/components/_button.scss b/scss/components/_button.scss
index a4bce44a40ff2bf6df2709329c8a5699b17e7aaa..3ade5d9467ae05e3f5e45f94c2c029521844ce95 100755 (executable)
--- a/scss/components/_button.scss
+++ b/scss/components/_button.scss
@@ -24,24 +24,24 @@ $button-font-size: (
   large: 24px,
 ) !default;
 
-/// Default color of the font in a button.
+/// Text color of buttons.
 /// @type Color
 $button-color: $white !default;
 
-/// Default color of the font in an alternate button.
+/// Text color of buttons with a light background.
 /// @type Color
 $button-color-alt: $medium-gray !default;
 
-/// Default font weight for a button.
-/// @type String
+/// Font weight of buttons.
+/// @type Weight
 $button-font-weight: bold !default;
 
-/// Default backgrounnd color for a button.
+/// Background color of buttons.
 /// @type Color
 $button-background: $primary-color !default;
 
-/// Default border color for a button.
-/// @type Color
+/// Border around buttons.
+/// @type Border
 $button-border: 2px solid $button-background !default;
 
 // Internal values for button font size

diff --git a/scss/components/_media-query.scss b/scss/components/_media-query.scss
index 90809abacbe803027a5f7b73631f4e666a0ba0a0..095dced70e293a8d00cb3a05741cffd44c647ec3 100755 (executable)
--- a/scss/components/_media-query.scss
+++ b/scss/components/_media-query.scss
@@ -7,11 +7,11 @@
 ////
 
 /// Container width for small screens.
-/// @type Number
+/// @type Length
 $container-width-small: 95% !default;
 
 /// Small breakpoint.
-/// @type Number
+/// @type Length
 $small-range: $container-width !default;
 
 @media only screen and (max-width: #{$small-range}) {

diff --git a/scss/components/_menu.scss b/scss/components/_menu.scss
index f44a9bfe6f1894f4795fe7e7f886c5a48f20a3df..3be193e70e9acc6bf28e93734266ff457a8717c2 100644 (file)
--- a/scss/components/_menu.scss
+++ b/scss/components/_menu.scss
@@ -7,11 +7,11 @@
 ////
 
 /// Padding inside a menu item.
-/// @type Number
+/// @type Length
 $menu-item-padding: 20px !default;
 
-/// Right-hand spacing of menus with the `.simple` class.
-/// @type Number
+/// Right-hand spacing of items in menus with the `.simple` class.
+/// @type Length
 $menu-simple-item-spacing: 10px !default;
 
 

diff --git a/scss/components/_normalize.scss b/scss/components/_normalize.scss
index 16579ab68d4398a2474125b53ab01a1e8db74be6..b2fe0d8f3913ddb4f354d95ab575d7a34a979432 100755 (executable)
--- a/scss/components/_normalize.scss
+++ b/scss/components/_normalize.scss
@@ -11,7 +11,7 @@
 $hr-background: $medium-gray !default;
 
 /// Height of a divider.
-/// @type Number
+/// @type Length
 $hr-height: 1px !default;
 
 #outlook a {

diff --git a/scss/components/_thumbnail.scss b/scss/components/_thumbnail.scss
index da2d6b83d1163bf9723412b946e0c474a4dcac52..5cd4f5eae6ab6ce6bb279ccfc13b0dafb47ff2f9 100644 (file)
--- a/scss/components/_thumbnail.scss
+++ b/scss/components/_thumbnail.scss
@@ -7,11 +7,11 @@
 ////
 
 /// Defualt value for the horizontal direction of the shadow.
-/// @type Number
+/// @type Length
 $thumbnail-shadow-h: 0 !default;
 
 /// Defualt value for the vertical direction of the shadow.
-/// @type Number
+/// @type Length
 $thumbnail-shadow-v: 0 !default;
 
 /// Defualt value for blur of the shadow.

diff --git a/scss/components/_type.scss b/scss/components/_type.scss
index 89add01a373b8a046492f1da88cdf298a2389c29..ccc8e62be301e06dc02684932e0370476f0282e7 100755 (executable)
--- a/scss/components/_type.scss
+++ b/scss/components/_type.scss
@@ -6,95 +6,95 @@
 /// @group typography
 ////
 
-/// Defualt global font color.
+/// Global font color.
 /// @type Color
 $global-font-color: $black !default;
 
-/// Defualt global font family.
-/// @type List
+/// Global font family.
+/// @type Font
 $global-font-family: Helvetica, Arial, sans-serif !default;
 
-/// Defualt global font weight.
+/// Global font weight.
 /// @type Keyword
 $global-font-weight: normal !default;
 
-/// Defualt global line height.
+/// Global line height.
 /// @type Number
 $global-line-height: 1.3 !default;
 
-/// Defualt body font size.
+/// Font size of body text.
 /// @type Number
 $body-font-size: 14px !default;
 
-/// Defualt body line height.
+/// Line height of body text.
 /// @type Number
 $body-line-height: 19px !default;
 
-/// Defualt header font family.
+/// Font family of headings.
 /// @type List
 $header-font-family: $global-font-family;
 
-/// Defualt font size for an h1.
+/// Font size of `<h1>` elements.
 /// @type Number
 $h1-font-size: 40px !default;
 
-/// Defualt font size for an h2.
+/// Font size of `<h2>` elements.
 /// @type Number
 $h2-font-size: 36px !default;
 
-/// Defualt font size for an h3.
+/// Font size of `<h3>` elements.
 /// @type Number
 $h3-font-size: 32px !default;
 
-/// Defualt font size for an h4.
+/// Font size of `<h4>` elements.
 /// @type Number
 $h4-font-size: 28px !default;
 
-/// Defualt font size for an h5.
+/// Font size of `<h5>` elements.
 /// @type Number
 $h5-font-size: 24px !default;
 
-/// Defualt font size for an h6.
+/// Font size of `<h6>` elements.
 /// @type Number
 $h6-font-size: 20px !default;
 
-/// Defualt font size for small fonts.
+/// Defualt font size for `<small>`.
 /// @type Number
 $small-font-size: 10px !default;
 
-/// Defualt font size for lead paragraphs.
+/// Font size of lead paragraphs.
 /// @type Number
 $lead-font-size: 18px !default;
 
-/// Defualt line height for lead paragraphs.
+/// Line height of lead paragraphs.
 /// @type Number
 $lead-line-height: 21px !default;
 
-/// Default margin bottom for paragraphs.
+/// Margin bottom of paragraphs.
 /// @type Number
 $paragraph-margin-bottom: 10px !default;
 
-/// Dfault text padding.
+/// Padding inside paragraphs.
 /// @type Number
 $text-padding: 10px !default;
 
-/// Defualt text decoration styles for anchors.
+/// Text decoration for anchors.
 /// @type Keyword
 $anchor-text-decoration: none !default;
 
-/// Defualt anchor font color.
+/// Text color of anchors.
 /// @type Color
 $anchor-color: $primary-color !default;
 
-/// Defualt font color for a visited anchor.
+/// Text color of anchors to visited links.
 /// @type Color
 $anchor-color-visited: $anchor-color !default;
 
-/// Defualt font color for an anchor on hover.
+/// Text color of anchors on hover.
 /// @type Color
 $anchor-color-hover: darken($primary-color, 10%) !default;
 
-/// Defualt font color for an active anchor.
+/// Text color of active anchors.
 /// @type Color
 $anchor-color-active: $anchor-color-hover !default;
 

diff --git a/scss/util/_util.scss b/scss/util/_util.scss
index 9923295fa11ce2beec455a7f03f2728d2d8591e7..29299b1325609797364d0b7b8093f0d11ad8f1c6 100755 (executable)
--- a/scss/util/_util.scss
+++ b/scss/util/_util.scss
@@ -3,7 +3,7 @@
 // Licensed under MIT Open Source
 
 /// Calculates a percentage value for a grid column width.
-/// @private
+/// @access private
 /// @param {number} $colNumber - Column count of the column.
 /// @param {number} $totalColumns - Column count of the entire row.
 /// @returns {number} A percentage width value.
@@ -12,7 +12,7 @@
 }
 
 /// Calculates a pixel value for a grid column width.
-/// @private
+/// @access private
 /// @param {number} $columnNumber - Column count of the column.
 /// @param {number} $totalColumns - Column count of the entire row.
 /// @param {number} $containerWidth - Width of the surrounding container, in pixels.

diff --git a/testing/src/assets/scss/_settings.scss b/testing/src/assets/scss/_settings.scss
index 367a0a42003f853efc9588ceff0478f270330616..937c1515f8866622e4dba1953b8ec932e21afe84 100644 (file)
--- a/testing/src/assets/scss/_settings.scss
+++ b/testing/src/assets/scss/_settings.scss
@@ -46,32 +46,36 @@ $sub-column-padding-right: $grid-column-gutter / 2;
 // 3. Block Grid
 // -------------
 
-$block-grid-elements: 8;
-$block-grid-spacing: $grid-column-gutter;
+$block-grid-max: 8;
+$block-grid-gutter: $grid-column-gutter;
 
 // 4. Button
 // ---------
 
-// $button-padding: 12px 10px 12px 10px;
-// $button-padding-tiny: 5px 4px 4px 4px;
-// $button-padding-small: 8px 3px 7px 3px;
-// $button-padding-large: 13px 26px 12px 26px!default;
-$button-font-color: $white;
-$button-font-color-alt: $medium-gray;
+$button-padding: (
+  default: 12px 10px 12px 10px,
+  tiny: 5px 4px 4px 4px,
+  small: 8px 3px 7px 3px,
+  large: 13px 26px 12px 26px,
+);
+$button-font-size: (
+  default: 20px,
+  tiny: 12px,
+  small: 16px,
+  large: 24px,
+);
+$button-color: $white;
+$button-color-alt: $medium-gray;
 $button-font-weight: bold;
-// $button-font-size: 20px;
-// $button-font-size-tiny: 12px;
-// $button-font-size-small: 16px;
-// $button-font-size-large: 24px;
-$button-background-color: $primary-color;
-$button-border: 1px solid $button-background-color;
+$button-background: $primary-color;
+$button-border: 2px solid $button-background;
 
 // 5. Callout
 // ----------
 
-$callout-background-color: $light-gray;
+$callout-background: $light-gray;
 $callout-padding: 10px;
-$callout-border: 1px solid darken($callout-background-color, 20%);
+$callout-border: 1px solid darken($callout-background, 20%);
 $callout-border-success: 1px solid darken($success-color, 20%);
 $callout-border-warning: 1px solid darken($warning-color, 20%);
 $callout-border-alert: 1px solid darken darken($alert-color, 20%);
@@ -80,18 +84,18 @@ $callout-border-alert: 1px solid darken darken($alert-color, 20%);
 // --------------
 
 $menu-item-padding: 20px;
-$menu-simple-item-gutter: 10px;
+$menu-simple-item-spacing: 10px;
 
 // 7. Media Query
 // --------------
 
-$small-container-width: 95%;
+$container-width-small: 95%;
 $small-range: $container-width;
 
 // 8. Normalize
 // ------------
 
-$hr-color: $medium-gray;
+$hr-background: $medium-gray;
 $hr-height: 1px;
 
 // 9. Thumbnial
@@ -121,12 +125,13 @@ $h4-font-size: 28px;
 $h5-font-size: 24px;
 $h6-font-size: 20px;
 $small-font-size: 10px;
-$paragraph-lead-font-size: 18px;
-$paragraph-lead-line-height: 21px;
+$lead-font-size: 18px;
+$lead-line-height: 21px;
 $paragraph-margin-bottom: 10px;
 $text-padding: 10px;
 $anchor-text-decoration: none;
-$anchor-font-color: $primary-color;
-$anchor-font-color-visited: $anchor-font-color;
-$anchor-font-color-hover: darken($primary-color, 10%);
-$anchor-font-color-active: $anchor-font-color-hover;
+$anchor-color: $primary-color;
+$anchor-color-visited: $anchor-color;
+$anchor-color-hover: darken($primary-color, 10%);
+$anchor-color-active: $anchor-color-hover;
+