]> git.ipfire.org Git - thirdparty/foundation/foundation-sites.git/commitdiff
Modify doc comment.
authorkoki-higashikawa <koki.higashikawa@crowdworks.co.jp>
Tue, 7 Feb 2017 03:56:07 +0000 (12:56 +0900)
committerkoki-higashikawa <koki.higashikawa@crowdworks.co.jp>
Tue, 7 Feb 2017 03:56:07 +0000 (12:56 +0900)
scss/util/_color.scss

index a7e4aa339fdb06b015d1694e4194cfeb16597b64..73990a867c25c27eb940e5f573625a60e43433a9 100644 (file)
 
 /// Checks the luminance of `$base`, and returns the color from `$colors` (list of colors) that has the most contrast.
 ///
-/// @param {Color} $color1 - First color to compare.
-/// @param {Color} $color2 - Second color to compare.
+/// @param {Color} $base - Color to check luminance.
+/// @param {List} $colors - Colors to compare.
+/// @param {Number} $tolerance [$global-color-pick-contrast-tolerance] - Contrast tolerance.
 ///
-/// @returns {Number} The contrast ratio of the compared colors.
+/// @returns {Color} the color from `$colors` (list of colors) that has the most contrast.
 @function color-pick-contrast($base, $colors: ($white, $black), $tolerance: $global-color-pick-contrast-tolerance) {
   $contrast: color-contrast($base, nth($colors, 1));
   $best: nth($colors, 1);