Started documenting Math.Easing functions.

hexus · hexus · commit 1aeb8327e77d · 2018-05-24T13:33:47.000+01:00
diff --git a/src/math/easing/back/In.js b/src/math/easing/back/In.js
@@ -10,10 +10,10 @@
  * @function Phaser.Math.Easing.Back.In
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  * @param {number} [overshoot=1.70158] - [description]
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var In = function (v, overshoot)
 {
diff --git a/src/math/easing/back/InOut.js b/src/math/easing/back/InOut.js
@@ -10,10 +10,10 @@
  * @function Phaser.Math.Easing.Back.InOut
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  * @param {number} [overshoot=1.70158] - [description]
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var InOut = function (v, overshoot)
 {
diff --git a/src/math/easing/back/Out.js b/src/math/easing/back/Out.js
@@ -10,10 +10,10 @@
  * @function Phaser.Math.Easing.Back.Out
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  * @param {number} [overshoot=1.70158] - [description]
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var Out = function (v, overshoot)
 {
diff --git a/src/math/easing/bounce/In.js b/src/math/easing/bounce/In.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Bounce.In
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var In = function (v)
 {
diff --git a/src/math/easing/bounce/InOut.js b/src/math/easing/bounce/InOut.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Bounce.InOut
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var InOut = function (v)
 {
diff --git a/src/math/easing/bounce/Out.js b/src/math/easing/bounce/Out.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Bounce.Out
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var Out = function (v)
 {
diff --git a/src/math/easing/circular/In.js b/src/math/easing/circular/In.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Circular.In
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var In = function (v)
 {
diff --git a/src/math/easing/circular/InOut.js b/src/math/easing/circular/InOut.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Circular.InOut
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var InOut = function (v)
 {
diff --git a/src/math/easing/circular/Out.js b/src/math/easing/circular/Out.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Circular.Out
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var Out = function (v)
 {
diff --git a/src/math/easing/cubic/In.js b/src/math/easing/cubic/In.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Cubic.In
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var In = function (v)
 {
diff --git a/src/math/easing/cubic/InOut.js b/src/math/easing/cubic/InOut.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Cubic.InOut
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var InOut = function (v)
 {
diff --git a/src/math/easing/cubic/Out.js b/src/math/easing/cubic/Out.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Cubic.Out
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var Out = function (v)
 {
diff --git a/src/math/easing/elastic/In.js b/src/math/easing/elastic/In.js
@@ -10,11 +10,11 @@
  * @function Phaser.Math.Easing.Elastic.In
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  * @param {float} [amplitude=0.1] - [description]
  * @param {float} [period=0.1] - [description]
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var In = function (v, amplitude, period)
 {
diff --git a/src/math/easing/elastic/InOut.js b/src/math/easing/elastic/InOut.js
@@ -10,11 +10,11 @@
  * @function Phaser.Math.Easing.Elastic.InOut
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  * @param {float} [amplitude=0.1] - [description]
  * @param {float} [period=0.1] - [description]
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var InOut = function (v, amplitude, period)
 {
diff --git a/src/math/easing/elastic/Out.js b/src/math/easing/elastic/Out.js
@@ -10,11 +10,11 @@
  * @function Phaser.Math.Easing.Elastic.Out
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  * @param {float} [amplitude=0.1] - [description]
  * @param {float} [period=0.1] - [description]
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var Out = function (v, amplitude, period)
 {
diff --git a/src/math/easing/expo/In.js b/src/math/easing/expo/In.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Expo.In
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var In = function (v)
 {
diff --git a/src/math/easing/expo/InOut.js b/src/math/easing/expo/InOut.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Expo.InOut
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var InOut = function (v)
 {
diff --git a/src/math/easing/expo/Out.js b/src/math/easing/expo/Out.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Expo.Out
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var Out = function (v)
 {
diff --git a/src/math/easing/linear/Linear.js b/src/math/easing/linear/Linear.js
@@ -5,14 +5,14 @@
  */
 
 /**
- * [description]
+ * Linear easing (no variation).
  *
  * @function Phaser.Math.Easing.Linear.Linear
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var Linear = function (v)
 {
diff --git a/src/math/easing/quadratic/In.js b/src/math/easing/quadratic/In.js
@@ -5,14 +5,14 @@
  */
 
 /**
- * [description]
+ * Quadratic ease-in.
  *
  * @function Phaser.Math.Easing.Quadratic.In
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var In = function (v)
 {
diff --git a/src/math/easing/quadratic/InOut.js b/src/math/easing/quadratic/InOut.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Quadratic.InOut
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var InOut = function (v)
 {
diff --git a/src/math/easing/quadratic/Out.js b/src/math/easing/quadratic/Out.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Quadratic.Out
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var Out = function (v)
 {
diff --git a/src/math/easing/quartic/In.js b/src/math/easing/quartic/In.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Quartic.In
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var In = function (v)
 {
diff --git a/src/math/easing/quartic/InOut.js b/src/math/easing/quartic/InOut.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Quartic.InOut
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var InOut = function (v)
 {
diff --git a/src/math/easing/quartic/Out.js b/src/math/easing/quartic/Out.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Quartic.Out
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var Out = function (v)
 {
diff --git a/src/math/easing/quintic/In.js b/src/math/easing/quintic/In.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Quintic.In
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var In = function (v)
 {
diff --git a/src/math/easing/quintic/InOut.js b/src/math/easing/quintic/InOut.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Quintic.InOut
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var InOut = function (v)
 {
diff --git a/src/math/easing/quintic/Out.js b/src/math/easing/quintic/Out.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Quintic.Out
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var Out = function (v)
 {
diff --git a/src/math/easing/sine/In.js b/src/math/easing/sine/In.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Sine.In
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var In = function (v)
 {
diff --git a/src/math/easing/sine/InOut.js b/src/math/easing/sine/InOut.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Sine.InOut
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var InOut = function (v)
 {
diff --git a/src/math/easing/sine/Out.js b/src/math/easing/sine/Out.js
@@ -10,9 +10,9 @@
  * @function Phaser.Math.Easing.Sine.Out
  * @since 3.0.0
  *
- * @param {number} v - [description]
+ * @param {number} v - The value to be tweened.
  *
- * @return {number} [description]
+ * @return {number} The tweened value.
  */
 var Out = function (v)
 {
diff --git a/src/math/easing/stepped/Stepped.js b/src/math/easing/stepped/Stepped.js

Original file line number	Diff line number	Diff line change
`@@ -10,10 +10,10 @@`
`10`	`10`	`* @function Phaser.Math.Easing.Back.In`
`11`	`11`	`* @since 3.0.0`
`12`	`12`	`*`
`13`		`- * @param {number} v - [description]`
	`13`	`+ * @param {number} v - The value to be tweened.`
`14`	`14`	`* @param {number} [overshoot=1.70158] - [description]`
`15`	`15`	`*`
`16`		`- * @return {number} [description]`
	`16`	`+ * @return {number} The tweened value.`
`17`	`17`	`*/`
`18`	`18`	`var In = function (v, overshoot)`
`19`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,9 @@`
`10`	`10`	`* @function Phaser.Math.Easing.Bounce.In`
`11`	`11`	`* @since 3.0.0`
`12`	`12`	`*`
`13`		`- * @param {number} v - [description]`
	`13`	`+ * @param {number} v - The value to be tweened.`
`14`	`14`	`*`
`15`		`- * @return {number} [description]`
	`15`	`+ * @return {number} The tweened value.`
`16`	`16`	`*/`
`17`	`17`	`var In = function (v)`
`18`	`18`	`{`