Skip to content

Commit a790160

Browse files
larsgreferLeaVerou
authored andcommitted
Add JSDoc comments to color example functions
1 parent 6d3b7b9 commit a790160

File tree

4 files changed

+26
-2
lines changed

4 files changed

+26
-2
lines changed

css-color-4/hslToRgb.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
function hslToRgb (hue, sat, light) {
1+
/**
2+
* @param {number} hue - Hue as degrees 0..360
3+
* @param {number} sat - Saturation as percentage 0..100
4+
* @param {number} light - Lightness as percentage 0..100
5+
* @return {number[]} Array of RGB components 0..1
6+
*/
7+
function hslToRgb(hue, sat, light) {
28
hue = hue % 360;
39

410
if (hue < 0) {

css-color-4/hwbToRgb.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1+
/**
2+
* @param {number} hue - Hue as degrees 0..360
3+
* @param {number} white - Whiteness as percentage 0..100
4+
* @param {number} black - Blackness as percentage 0..100
5+
* @return {number[]} Array of RGB components 0..1
6+
*/
17
function hwbToRgb(hue, white, black) {
28
white /= 100;
39
black /= 100;
410
if (white + black >= 1) {
511
let gray = white / (white + black);
6-
return [gray, gray, gray];
12+
return [gray, gray, gray];
713
}
814
let rgb = hslToRgb(hue, 100, 50);
915
for (let i = 0; i < 3; i++) {

css-color-4/rgbToHsl.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/**
2+
* @param {number} red - Red component 0..1
3+
* @param {number} green - Green component 0..1
4+
* @param {number} blue - Blue component 0..1
5+
* @return {number[]} Array of HSL values: Hue as degrees 0..360, Saturation and Lightness as percentages 0..100
6+
*/
17
function rgbToHsl (red, green, blue) {
28
let max = Math.max(red, green, blue);
39
let min = Math.min(red, green, blue);

css-color-4/rgbToHwb.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/**
2+
* @param {number} red - Red component 0..1
3+
* @param {number} green - Green component 0..1
4+
* @param {number} blue - Blue component 0..1
5+
* @return {number[]} Array of HWB values: Hue as degrees 0..360, Whiteness and Blackness as percentages 0..100
6+
*/
17
function rgbToHwb(red, green, blue) {
28
var hsl = rgbToHsl(red, green, blue);
39
var white = Math.min(red, green, blue);

0 commit comments

Comments
 (0)