Skip to content

Commit

Permalink
documentation improving
Browse files Browse the repository at this point in the history
  • Loading branch information
Black Mirror committed May 2, 2018
1 parent c7c61d2 commit c0cf834
Show file tree
Hide file tree
Showing 9 changed files with 355 additions and 324 deletions.
4 changes: 0 additions & 4 deletions .sassdocrc
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ description: |
* [Hugo Giraudel](https://hugogiraudel.com)
* [Bootstrap](https://getbootstrap.com)
* [normalize.css](https://github.com/necolas/normalize.css)
sort:
- group
- file
- access
groups:
undefined: Core
core: Core
Expand Down
638 changes: 319 additions & 319 deletions docs/index.html

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions scss/mixins/_animation.scss
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@ $animation-timing-function-modes: array-concat((linear, ease, ease-in, ease-out,
///
/// @access public
/// @param {string} $atf - the animation timing function
/// @requires {function} array-contains
/// @requires {function} is-defined
/// @requires {function} string-starts-with
/// @requires {variable} animation-timing-function-modes
/// @link https://www.w3schools.com/cssref/css3_pr_animation-timing-function.asp W3Schools animation-timing-function docs
/// @return {boolean}
@function is-animation-timing-function($atf) {
Expand Down
8 changes: 7 additions & 1 deletion scss/mixins/_background.scss
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,14 @@ $background-size-modes: array-concat((auto, cover, contain), $css-default-modes)
///
/// @access public
/// @param {string | array} $bs - the background size value/values
/// @link https://www.w3schools.com/cssref/css3_pr_background-size.asp W3Schools background-size docs
/// @requires {function} array-contains
/// @requires {function} is-array
/// @requires {function} is-defined
/// @requires {function} is-size
/// @requires {function} is-percentage
/// @requires {function} nth-value
/// @requires {variable} background-size-modes
/// @link https://www.w3schools.com/cssref/css3_pr_background-size.asp W3Schools background-size docs
/// @return {boolean}
@function is-background-size($bs) {
@if is-defined($bs) {
Expand Down
6 changes: 6 additions & 0 deletions scss/mixins/_box.scss
Original file line number Diff line number Diff line change
Expand Up @@ -269,8 +269,11 @@ $box-bound-size-modes: array-concat((none), $css-default-modes);
/// @param {size | percentage} $options.max-height [null] - the max height bound
/// @param {boolean} $height-fallback [true] - falls back the height value to the width value, if height is not specified (useful for square sizes)
/// @requires {function} extend
/// @requires {function} is-box-size
/// @requires {function} is-defined
/// @requires {function} is-object
/// @requires {function} nth-value
/// @requires {mixin} box-bounds
/// @example scss - Usage - height fallback
/// .size-element {
/// @include box-size(100px);
Expand Down Expand Up @@ -595,6 +598,9 @@ $backface-visibility-modes: array-concat((visible, hidden), $css-default-modes);
/// @param {integer | size} $width [1] - desired width for aspect ratio calculation
/// @param {integer | size} $height [1] - desired height for aspect ratio calculation
/// @param {integer | size} $content-selector ['.content'] - desired content selector
/// @requires {function} strip-unit
/// @requires {mixin} box-size
/// @requires {mixin} display
/// @example scss - Usage
/// .aspect-ratio-element {
/// @include aspect-ratio(170px, 20px);
Expand Down
1 change: 1 addition & 0 deletions scss/mixins/_overflow.scss
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ $overflow-modes: array-concat((visible, hidden, scroll, overlay, unset, auto), $
/// Overflow mixin
///
/// @param {string} $o - the overflow mode
/// @requires {function} nth-value
/// @example scss - Usage
/// .overflow-element {
/// @include overflow(hidden);
Expand Down
5 changes: 5 additions & 0 deletions scss/mixins/_text.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
///
/// @type list
/// @access private
/// @requires {function} array-concat
$font-size-modes: array-concat((medium, xx-small, x-small, small, large, x-large, xx-large, smaller, larger), $css-default-modes);

/// Checks if something is a supported font-size value
Expand Down Expand Up @@ -166,6 +167,10 @@ $font-weight-modes: array-concat((normal, bold, bolder, lighter, 100, 200, 300,
/// @param {string | array | list} $options.family [null] - the font-family value
/// @param {string | integer} $options.weight [normal] - the font-weight value
/// @param {color} $options.color [null] - the color value
/// @requires {function} extend
/// @requires {function} is-defined
/// @requires {function} is-object
/// @requires {function} nth-value
/// @example scss - Usage
/// .font-element {
/// @include font(1.5rem 2.5rem);
Expand Down
1 change: 1 addition & 0 deletions scss/types/_common.scss
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ $css-default-modes: (initial, inherit);
///
/// @access public
/// @param {any} $cl - the value to check
/// @requires {function} string-replace
/// @return {css-expression}
@function get-calc-length-expression($cl) {
@if is-calc-length($cl) {
Expand Down
12 changes: 12 additions & 0 deletions scss/types/_string.scss
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@
/// @access public
/// @param {string} $h - the haystack
/// @param {string} $n - the needle
/// @requires {function} is-string
/// @requires {function} string-length
/// @requires {function} string-slice
/// @return {boolean}
@function string-starts-with($h, $n) {
@if is-string($h) and is-string($n) {
Expand All @@ -85,6 +88,8 @@
/// @access public
/// @param {string} $h - the haystack
/// @param {string} $n - the needle
/// @requires {function} is-string
/// @requires {function} string-index
/// @return {boolean}
@function string-contains($h, $n) {
@if is-string($h) and is-string($n) {
Expand All @@ -100,6 +105,9 @@
/// @access public
/// @param {string} $h - the haystack
/// @param {string} $n - the needle
/// @requires {function} is-string
/// @requires {function} string-length
/// @requires {function} string-slice
/// @return {boolean}
@function string-ends-with($h, $n) {
@if is-string($h) and is-string($n) {
Expand All @@ -118,6 +126,9 @@
/// @access public
/// @param {string} $s - the string to split
/// @param {string} $sep ['.'] - the separator
/// @requires {function} array-concat
/// @requires {function} string-index
/// @requires {function} string-slice
/// @return {list | array}
@function string-split($s, $sep: '.') {
$split: ();
Expand All @@ -142,6 +153,7 @@
/// @param {string} $h - the haystack
/// @param {string} $n - the needle
/// @param {string} $r [''] - the string to use for replacement
/// @requires {function} string-slice
/// @return {string} - the updated string
@function string-replace($h, $n, $r: '') {
$i: string-index($h, $n);
Expand Down

0 comments on commit c0cf834

Please sign in to comment.