jsdoc blocks added.

photonstorm · photonstorm · commit 876d88516720 · 2017-10-12T13:12:52.000+01:00
diff --git a/v3/src/math/easing/back/In.js b/v3/src/math/easing/back/In.js
@@ -1,3 +1,14 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Back.In
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ * @param {number} [overshoot=1.70158] - [description]
+ *
+ * @return {number} [description]
+ */
 var In = function (v, overshoot)
 {
     if (overshoot === undefined) { overshoot = 1.70158; }
diff --git a/v3/src/math/easing/back/InOut.js b/v3/src/math/easing/back/InOut.js
@@ -1,3 +1,14 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Back.InOut
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ * @param {number} [overshoot=1.70158] - [description]
+ *
+ * @return {number} [description]
+ */
 var InOut = function (v, overshoot)
 {
     if (overshoot === undefined) { overshoot = 1.70158; }
diff --git a/v3/src/math/easing/back/Out.js b/v3/src/math/easing/back/Out.js
@@ -1,3 +1,14 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Back.Out
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ * @param {number} [overshoot=1.70158] - [description]
+ *
+ * @return {number} [description]
+ */
 var Out = function (v, overshoot)
 {
     if (overshoot === undefined) { overshoot = 1.70158; }
diff --git a/v3/src/math/easing/bounce/In.js b/v3/src/math/easing/bounce/In.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Bounce.In
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var In = function (v)
 {
     v = 1 - v;
diff --git a/v3/src/math/easing/bounce/InOut.js b/v3/src/math/easing/bounce/InOut.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Bounce.InOut
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var InOut = function (v)
 {
     var reverse = false;
diff --git a/v3/src/math/easing/bounce/Out.js b/v3/src/math/easing/bounce/Out.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Bounce.Out
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var Out = function (v)
 {
     if (v < 1 / 2.75)
diff --git a/v3/src/math/easing/circular/In.js b/v3/src/math/easing/circular/In.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Circular.In
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var In = function (v)
 {
     return 1 - Math.sqrt(1 - v * v);
diff --git a/v3/src/math/easing/circular/InOut.js b/v3/src/math/easing/circular/InOut.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Circular.InOut
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var InOut = function (v)
 {
     if ((v *= 2) < 1)
diff --git a/v3/src/math/easing/circular/Out.js b/v3/src/math/easing/circular/Out.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Circular.Out
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var Out = function (v)
 {
     return Math.sqrt(1 - (--v * v));
diff --git a/v3/src/math/easing/cubic/In.js b/v3/src/math/easing/cubic/In.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Cubic.In
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var In = function (v)
 {
     return v * v * v;
diff --git a/v3/src/math/easing/cubic/InOut.js b/v3/src/math/easing/cubic/InOut.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Cubic.InOut
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var InOut = function (v)
 {
     if ((v *= 2) < 1)
diff --git a/v3/src/math/easing/cubic/Out.js b/v3/src/math/easing/cubic/Out.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Cubic.Out
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var Out = function (v)
 {
     return --v * v * v + 1;
diff --git a/v3/src/math/easing/elastic/In.js b/v3/src/math/easing/elastic/In.js
@@ -1,3 +1,15 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Elastic.In
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ * @param {float} [amplitude=0.1] - [description]
+ * @param {float} [period=0.1] - [description]
+ *
+ * @return {number} [description]
+ */
 var In = function (v, amplitude, period)
 {
     if (amplitude === undefined) { amplitude = 0.1; }
diff --git a/v3/src/math/easing/elastic/InOut.js b/v3/src/math/easing/elastic/InOut.js
@@ -1,3 +1,15 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Elastic.InOut
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ * @param {float} [amplitude=0.1] - [description]
+ * @param {float} [period=0.1] - [description]
+ *
+ * @return {number} [description]
+ */
 var InOut = function (v, amplitude, period)
 {
     if (amplitude === undefined) { amplitude = 0.1; }
diff --git a/v3/src/math/easing/elastic/Out.js b/v3/src/math/easing/elastic/Out.js
@@ -1,3 +1,15 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Elastic.Out
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ * @param {float} [amplitude=0.1] - [description]
+ * @param {float} [period=0.1] - [description]
+ *
+ * @return {number} [description]
+ */
 var Out = function (v, amplitude, period)
 {
     if (amplitude === undefined) { amplitude = 0.1; }
diff --git a/v3/src/math/easing/expo/In.js b/v3/src/math/easing/expo/In.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Expo.In
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var In = function (v)
 {
     return Math.pow(2, 10 * (v - 1)) - 0.001;
diff --git a/v3/src/math/easing/expo/InOut.js b/v3/src/math/easing/expo/InOut.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Expo.InOut
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var InOut = function (v)
 {
     if ((v *= 2) < 1)
diff --git a/v3/src/math/easing/expo/Out.js b/v3/src/math/easing/expo/Out.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Expo.Out
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var Out = function (v)
 {
     return 1 - Math.pow(2, -10 * v);
diff --git a/v3/src/math/easing/linear/Linear.js b/v3/src/math/easing/linear/Linear.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Linear
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var Linear = function (v)
 {
     return v;
diff --git a/v3/src/math/easing/quadratic/In.js b/v3/src/math/easing/quadratic/In.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Quadratic.In
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var In = function (v)
 {
     return v * v;
diff --git a/v3/src/math/easing/quadratic/InOut.js b/v3/src/math/easing/quadratic/InOut.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Quadratic.InOut
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var InOut = function (v)
 {
     if ((v *= 2) < 1)
diff --git a/v3/src/math/easing/quadratic/Out.js b/v3/src/math/easing/quadratic/Out.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Quadratic.Out
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var Out = function (v)
 {
     return v * (2 - v);
diff --git a/v3/src/math/easing/quartic/In.js b/v3/src/math/easing/quartic/In.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Quartic.In
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var In = function (v)
 {
     return v * v * v * v;
diff --git a/v3/src/math/easing/quartic/InOut.js b/v3/src/math/easing/quartic/InOut.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Quartic.InOut
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var InOut = function (v)
 {
     if ((v *= 2) < 1)
diff --git a/v3/src/math/easing/quartic/Out.js b/v3/src/math/easing/quartic/Out.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Quartic.Out
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var Out = function (v)
 {
     return 1 - (--v * v * v * v);
diff --git a/v3/src/math/easing/quintic/In.js b/v3/src/math/easing/quintic/In.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Quintic.In
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var In = function (v)
 {
     return v * v * v * v * v;
diff --git a/v3/src/math/easing/quintic/InOut.js b/v3/src/math/easing/quintic/InOut.js
@@ -1,3 +1,13 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Math.Easing.Quintic.InOut
+ * @since 3.0.0
+ *
+ * @param {number} v - [description]
+ *
+ * @return {number} [description]
+ */
 var InOut = function (v)
 {
     if ((v *= 2) < 1)
diff --git a/v3/src/math/easing/quintic/Out.js b/v3/src/math/easing/quintic/Out.js
diff --git a/v3/src/math/easing/sine/In.js b/v3/src/math/easing/sine/In.js
diff --git a/v3/src/math/easing/sine/InOut.js b/v3/src/math/easing/sine/InOut.js
diff --git a/v3/src/math/easing/sine/Out.js b/v3/src/math/easing/sine/Out.js
