diff --git a/src/display/color/ColorToRGBA.js b/src/display/color/ColorToRGBA.js index dc8821caa..06bf57411 100644 --- a/src/display/color/ColorToRGBA.js +++ b/src/display/color/ColorToRGBA.js @@ -1,3 +1,11 @@ +/** + * [description] + * + * @function Phaser.Display.Color.ColorToRGBA + * @since 3.0.0 + * + * @param {number} color - [description] + */ var ColorToRGBA = function (color) { var output = { diff --git a/src/display/color/ComponentToHex.js b/src/display/color/ComponentToHex.js index 3606a9241..dc5359b14 100644 --- a/src/display/color/ComponentToHex.js +++ b/src/display/color/ComponentToHex.js @@ -1,6 +1,16 @@ // Return a string containing a hex representation of the given color component. // @param {integer} color - The color channel to get the hex value for, must be a value between 0 and 255. // @return {string} A string of length 2 characters, i.e. 255 = ff, 100 = 64. +/** + * [description] + * + * @function Phaser.Display.Color.ComponentToHex + * @since 3.0.0 + * + * @param {integer} color - [description] + * + * @return {string} [description] + */ var ComponentToHex = function (color) { var hex = color.toString(16); diff --git a/src/display/color/GetColor.js b/src/display/color/GetColor.js index 20fb824c3..29c9bef94 100644 --- a/src/display/color/GetColor.js +++ b/src/display/color/GetColor.js @@ -1,6 +1,18 @@ /** * Given 3 color values this will return an integer representation of it. */ +/** + * [description] + * + * @function Phaser.Display.Color.GetColor + * @since 3.0.0 + * + * @param {number} red - [description] + * @param {number} green - [description] + * @param {number} blue - [description] + * + * @return {number} [description] + */ var GetColor = function (red, green, blue) { return red << 16 | green << 8 | blue; diff --git a/src/display/color/GetColor32.js b/src/display/color/GetColor32.js index fee35c75b..8d0b1a738 100644 --- a/src/display/color/GetColor32.js +++ b/src/display/color/GetColor32.js @@ -1,6 +1,19 @@ /** * Given an alpha and 3 color values this will return an integer representation of it. */ +/** + * [description] + * + * @function Phaser.Display.Color.GetColor32 + * @since 3.0.0 + * + * @param {number} red - [description] + * @param {number} green - [description] + * @param {number} blue - [description] + * @param {number} alpha - [description] + * + * @return {number} [description] + */ var GetColor32 = function (red, green, blue, alpha) { return alpha << 24 | red << 16 | green << 8 | blue; diff --git a/src/display/color/HexStringToColor.js b/src/display/color/HexStringToColor.js index 4fc300346..827ff7d75 100644 --- a/src/display/color/HexStringToColor.js +++ b/src/display/color/HexStringToColor.js @@ -7,6 +7,16 @@ var Color = require('./Color'); * * An alpha channel is _not_ supported. */ +/** + * [description] + * + * @function Phaser.Display.Color.HexStringToColor + * @since 3.0.0 + * + * @param {string} hex - [description] + * + * @return {Phaser.Color} [description] + */ var HexStringToColor = function (hex) { var color = new Color(); diff --git a/src/display/color/index.js b/src/display/color/index.js index c2af3e32c..c4aba17c9 100644 --- a/src/display/color/index.js +++ b/src/display/color/index.js @@ -4,7 +4,6 @@ var Color = require('./Color'); Color.ColorToRGBA = require('./ColorToRGBA'); Color.ComponentToHex = require('./ComponentToHex'); -Color.CSSToColor = require('./CSSToColor'); Color.GetColor = require('./GetColor'); Color.GetColor32 = require('./GetColor32'); Color.HexStringToColor = require('./HexStringToColor'); diff --git a/src/display/color/CSSToColor.js b/wip/CSSToColor.js similarity index 100% rename from src/display/color/CSSToColor.js rename to wip/CSSToColor.js