Documented Math.Distance, Math.Fuzzy and Math.Interpolation.

hexus · hexus · commit 0f9bfc62f832 · 2018-05-24T11:40:53.000+01:00
diff --git a/src/math/distance/DistanceBetween.js b/src/math/distance/DistanceBetween.js
@@ -5,17 +5,17 @@
  */
 
 /**
- * [description]
+ * Calculate the distance between two sets of coordinates (points).
  *
  * @function Phaser.Math.Distance.Between
  * @since 3.0.0
  *
- * @param {number} x1 - [description]
- * @param {number} y1 - [description]
- * @param {number} x2 - [description]
- * @param {number} y2 - [description]
+ * @param {number} x1 - The x coordinate of the first point.
+ * @param {number} y1 - The y coordinate of the first point.
+ * @param {number} x2 - The x coordinate of the second point.
+ * @param {number} y2 - The y coordinate of the second point.
  *
- * @return {number} [description]
+ * @return {number} The distance between each point.
  */
 var DistanceBetween = function (x1, y1, x2, y2)
 {
diff --git a/src/math/distance/DistancePower.js b/src/math/distance/DistancePower.js
@@ -5,18 +5,18 @@
  */
 
 /**
- * [description]
+ * Calculate the distance between two sets of coordinates (points) to the power of `pow`.
  *
  * @function Phaser.Math.Distance.Power
  * @since 3.0.0
  *
- * @param {number} x1 - [description]
- * @param {number} y1 - [description]
- * @param {number} x2 - [description]
- * @param {number} y2 - [description]
- * @param {number} pow - [description]
+ * @param {number} x1 - The x coordinate of the first point.
+ * @param {number} y1 - The y coordinate of the first point.
+ * @param {number} x2 - The x coordinate of the second point.
+ * @param {number} y2 - The y coordinate of the second point.
+ * @param {number} pow - The exponent.
  *
- * @return {number} [description]
+ * @return {number} The distance between each point.
  */
 var DistancePower = function (x1, y1, x2, y2, pow)
 {
diff --git a/src/math/distance/DistanceSquared.js b/src/math/distance/DistanceSquared.js
@@ -5,17 +5,17 @@
  */
 
 /**
- * [description]
+ * Calculate the distance between two sets of coordinates (points), squared.
  *
  * @function Phaser.Math.Distance.Squared
  * @since 3.0.0
  *
- * @param {number} x1 - [description]
- * @param {number} y1 - [description]
- * @param {number} x2 - [description]
- * @param {number} y2 - [description]
+ * @param {number} x1 - The x coordinate of the first point.
+ * @param {number} y1 - The y coordinate of the first point.
+ * @param {number} x2 - The x coordinate of the second point.
+ * @param {number} y2 - The y coordinate of the second point.
  *
- * @return {number} [description]
+ * @return {number} The distance between each point, squared.
  */
 var DistanceSquared = function (x1, y1, x2, y2)
 {
diff --git a/src/math/fuzzy/Ceil.js b/src/math/fuzzy/Ceil.js
@@ -5,15 +5,15 @@
  */
 
 /**
- * [description]
+ * Calculate the ceiling of the given value.
  *
  * @function Phaser.Math.Fuzzy.Ceil
  * @since 3.0.0
  *
- * @param {number} value - [description]
- * @param {float} [epsilon=0.0001] - [description]
+ * @param {number} value - The value.
+ * @param {float} [epsilon=0.0001] - The epsilon.
  *
- * @return {number} [description]
+ * @return {number} The ceiling of the value.
  */
 var Ceil = function (value, epsilon)
 {
diff --git a/src/math/fuzzy/Equal.js b/src/math/fuzzy/Equal.js
@@ -5,16 +5,16 @@
  */
 
 /**
- * [description]
+ * Check whether the given values are equal.
  *
  * @function Phaser.Math.Fuzzy.Equal
  * @since 3.0.0
  *
- * @param {number} a - [description]
- * @param {number} b - [description]
- * @param {float} [epsilon=0.0001] - [description]
+ * @param {number} a - The first value.
+ * @param {number} b - The second value.
+ * @param {float} [epsilon=0.0001] - The epsilon.
  *
- * @return {boolean} [description]
+ * @return {boolean} Whether the given values are equal.
  */
 var Equal = function (a, b, epsilon)
 {
diff --git a/src/math/fuzzy/Floor.js b/src/math/fuzzy/Floor.js
@@ -5,15 +5,15 @@
  */
 
 /**
- * [description]
+ * Calculate the floor of the given value.
  *
  * @function Phaser.Math.Fuzzy.Floor
  * @since 3.0.0
  *
- * @param {number} value - [description]
- * @param {float} [epsilon=0.0001] - [description]
+ * @param {number} value - The value.
+ * @param {float} [epsilon=0.0001] - The epsilon.
  *
- * @return {number} [description]
+ * @return {number} The floor of the value.
  */
 var Floor = function (value, epsilon)
 {
diff --git a/src/math/fuzzy/GreaterThan.js b/src/math/fuzzy/GreaterThan.js
@@ -5,16 +5,16 @@
  */
 
 /**
- * [description]
+ * Check whether `a` is greater than `b`.
  *
  * @function Phaser.Math.Fuzzy.GreaterThan
  * @since 3.0.0
  *
- * @param {number} a - [description]
- * @param {number} b - [description]
- * @param {float} [epsilon=0.0001] - [description]
+ * @param {number} a - The first value.
+ * @param {number} b - The second value.
+ * @param {float} [epsilon=0.0001] - The epsilon.
  *
- * @return {boolean} [description]
+ * @return {boolean} Whether `a` is greater than `b`.
  */
 var GreaterThan = function (a, b, epsilon)
 {
diff --git a/src/math/fuzzy/LessThan.js b/src/math/fuzzy/LessThan.js
@@ -5,16 +5,16 @@
  */
 
 /**
- * [description]
+ * Check whether `a` is less than `b`.
  *
  * @function Phaser.Math.Fuzzy.LessThan
  * @since 3.0.0
  *
- * @param {number} a - [description]
- * @param {number} b - [description]
- * @param {float} [epsilon=0.0001] - [description]
+ * @param {number} a - The first value.
+ * @param {number} b - The second value.
+ * @param {float} [epsilon=0.0001] - The epsilon.
  *
- * @return {boolean} [description]
+ * @return {boolean} Whether `a` is less than `b`.
  */
 var LessThan = function (a, b, epsilon)
 {
diff --git a/src/math/interpolation/BezierInterpolation.js b/src/math/interpolation/BezierInterpolation.js
@@ -7,15 +7,15 @@
 var Bernstein = require('../Bernstein');
 
 /**
- * [description]
+ * A bezier interpolation method.
  *
  * @function Phaser.Math.Interpolation.Bezier
  * @since 3.0.0
  *
- * @param {number} v - [description]
- * @param {number} k - [description]
+ * @param {number[]} v - The input array of values to interpolate between.
+ * @param {number} k - The percentage of interpolation, between 0 and 1.
  *
- * @return {number} [description]
+ * @return {number} The interpolated value.
  */
 var BezierInterpolation = function (v, k)
 {
diff --git a/src/math/interpolation/CatmullRomInterpolation.js b/src/math/interpolation/CatmullRomInterpolation.js
@@ -7,15 +7,15 @@
 var CatmullRom = require('../CatmullRom');
 
 /**
- * [description]
+ * A Catmull-Rom interpolation method.
  *
  * @function Phaser.Math.Interpolation.CatmullRom
  * @since 3.0.0
  *
- * @param {number} v - [description]
- * @param {number} k - [description]
+ * @param {number[]} v - The input array of values to interpolate between.
+ * @param {number} k - The percentage of interpolation, between 0 and 1.
  *
- * @return {number} [description]
+ * @return {number} The interpolated value.
  */
 var CatmullRomInterpolation = function (v, k)
 {
diff --git a/src/math/interpolation/CubicBezierInterpolation.js b/src/math/interpolation/CubicBezierInterpolation.js
@@ -36,18 +36,18 @@ function P3 (t, p)
 // https://medium.com/@adrian_cooney/bezier-interpolation-13b68563313a
 
 /**
- * [description]
+ * A cubic bezier interpolation method.
  *
  * @function Phaser.Math.Interpolation.CubicBezier
  * @since 3.0.0
  *
- * @param {float} t - [description]
- * @param {number} p0 - [description]
- * @param {number} p1 - [description]
- * @param {number} p2 - [description]
- * @param {number} p3 - [description]
+ * @param {float} t - The percentage of interpolation, between 0 and 1.
+ * @param {number} p0 - The start point.
+ * @param {number} p1 - The first control point.
+ * @param {number} p2 - The second control point.
+ * @param {number} p3 - The end point.
  *
- * @return {number} [description]
+ * @return {number} The interpolated value.
  */
 var CubicBezierInterpolation = function (t, p0, p1, p2, p3)
 {
diff --git a/src/math/interpolation/LinearInterpolation.js b/src/math/interpolation/LinearInterpolation.js
@@ -7,7 +7,7 @@
 var Linear = require('../Linear');
 
 /**
- * A Linear Interpolation Method.
+ * A linear interpolation method.
  *
  * @function Phaser.Math.Interpolation.Linear
  * @since 3.0.0
diff --git a/src/math/interpolation/QuadraticBezierInterpolation.js b/src/math/interpolation/QuadraticBezierInterpolation.js
@@ -28,17 +28,17 @@ function P2 (t, p)
 // https://github.com/mrdoob/three.js/blob/master/src/extras/core/Interpolations.js
 
 /**
- * [description]
+ * A quadratic bezier interpolation method.
  *
  * @function Phaser.Math.Interpolation.QuadraticBezier
  * @since 3.2.0
  *
- * @param {float} t - [description]
- * @param {number} p0 - [description]
- * @param {number} p1 - [description]
- * @param {number} p2 - [description]
+ * @param {float} t - The percentage of interpolation, between 0 and 1.
+ * @param {number} p0 - The start point.
+ * @param {number} p1 - The control point.
+ * @param {number} p2 - The end point.
  *
- * @return {number} [description]
+ * @return {number} The interpolated value.
  */
 var QuadraticBezierInterpolation = function (t, p0, p1, p2)
 {

Original file line number	Diff line number	Diff line change
`@@ -5,17 +5,17 @@`
`5`	`5`	`*/`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * [description]`
	`8`	`+ * Calculate the distance between two sets of coordinates (points).`
`9`	`9`	`*`
`10`	`10`	`* @function Phaser.Math.Distance.Between`
`11`	`11`	`* @since 3.0.0`
`12`	`12`	`*`
`13`		`- * @param {number} x1 - [description]`
`14`		`- * @param {number} y1 - [description]`
`15`		`- * @param {number} x2 - [description]`
`16`		`- * @param {number} y2 - [description]`
	`13`	`+ * @param {number} x1 - The x coordinate of the first point.`
	`14`	`+ * @param {number} y1 - The y coordinate of the first point.`
	`15`	`+ * @param {number} x2 - The x coordinate of the second point.`
	`16`	`+ * @param {number} y2 - The y coordinate of the second point.`
`17`	`17`	`*`
`18`		`- * @return {number} [description]`
	`18`	`+ * @return {number} The distance between each point.`
`19`	`19`	`*/`
`20`	`20`	`var DistanceBetween = function (x1, y1, x2, y2)`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,15 +5,15 @@`
`5`	`5`	`*/`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * [description]`
	`8`	`+ * Calculate the ceiling of the given value.`
`9`	`9`	`*`
`10`	`10`	`* @function Phaser.Math.Fuzzy.Ceil`
`11`	`11`	`* @since 3.0.0`
`12`	`12`	`*`
`13`		`- * @param {number} value - [description]`
`14`		`- * @param {float} [epsilon=0.0001] - [description]`
	`13`	`+ * @param {number} value - The value.`
	`14`	`+ * @param {float} [epsilon=0.0001] - The epsilon.`
`15`	`15`	`*`
`16`		`- * @return {number} [description]`
	`16`	`+ * @return {number} The ceiling of the value.`
`17`	`17`	`*/`
`18`	`18`	`var Ceil = function (value, epsilon)`
`19`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,16 +5,16 @@`
`5`	`5`	`*/`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * [description]`
	`8`	`+ * Check whether the given values are equal.`
`9`	`9`	`*`
`10`	`10`	`* @function Phaser.Math.Fuzzy.Equal`
`11`	`11`	`* @since 3.0.0`
`12`	`12`	`*`
`13`		`- * @param {number} a - [description]`
`14`		`- * @param {number} b - [description]`
`15`		`- * @param {float} [epsilon=0.0001] - [description]`
	`13`	`+ * @param {number} a - The first value.`
	`14`	`+ * @param {number} b - The second value.`
	`15`	`+ * @param {float} [epsilon=0.0001] - The epsilon.`
`16`	`16`	`*`
`17`		`- * @return {boolean} [description]`
	`17`	`+ * @return {boolean} Whether the given values are equal.`
`18`	`18`	`*/`
`19`	`19`	`var Equal = function (a, b, epsilon)`
`20`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,15 +7,15 @@`
`7`	`7`	`var Bernstein = require('../Bernstein');`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * [description]`
	`10`	`+ * A bezier interpolation method.`
`11`	`11`	`*`
`12`	`12`	`* @function Phaser.Math.Interpolation.Bezier`
`13`	`13`	`* @since 3.0.0`
`14`	`14`	`*`
`15`		`- * @param {number} v - [description]`
`16`		`- * @param {number} k - [description]`
	`15`	`+ * @param {number[]} v - The input array of values to interpolate between.`
	`16`	`+ * @param {number} k - The percentage of interpolation, between 0 and 1.`
`17`	`17`	`*`
`18`		`- * @return {number} [description]`
	`18`	`+ * @return {number} The interpolated value.`
`19`	`19`	`*/`
`20`	`20`	`var BezierInterpolation = function (v, k)`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,15 +7,15 @@`
`7`	`7`	`var CatmullRom = require('../CatmullRom');`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * [description]`
	`10`	`+ * A Catmull-Rom interpolation method.`
`11`	`11`	`*`
`12`	`12`	`* @function Phaser.Math.Interpolation.CatmullRom`
`13`	`13`	`* @since 3.0.0`
`14`	`14`	`*`
`15`		`- * @param {number} v - [description]`
`16`		`- * @param {number} k - [description]`
	`15`	`+ * @param {number[]} v - The input array of values to interpolate between.`
	`16`	`+ * @param {number} k - The percentage of interpolation, between 0 and 1.`
`17`	`17`	`*`
`18`		`- * @return {number} [description]`
	`18`	`+ * @return {number} The interpolated value.`
`19`	`19`	`*/`
`20`	`20`	`var CatmullRomInterpolation = function (v, k)`
`21`	`21`	`{`