Documented SinCosTableGenerator and a few more easing parameters.

Author: hexus

src/math/SinCosTableGenerator.js

@@ -7,23 +7,23 @@
 /**
  * @typedef {object} SinCosTable
  *
- * @property {number} sin - [description]
- * @property {number} cos - [description]
- * @property {number} length - [description]
+ * @property {number} sin - The sine value.
+ * @property {number} cos - The cosine value.
+ * @property {number} length - The length.
  */
 
 /**
- * [description]
+ * Generate a series of sine and cosine values.
  *
  * @function Phaser.Math.SinCosTableGenerator
  * @since 3.0.0
  *
- * @param {number} length - [description]
- * @param {number} sinAmp - [description]
- * @param {number} cosAmp - [description]
- * @param {number} frequency - [description]
+ * @param {number} length - The number of values to generate.
+ * @param {number} [sinAmp=1] - The sine value amplitude.
+ * @param {number} [cosAmp=1] - The cosine value amplitude.
+ * @param {number} [frequency=1] - The frequency of the values.
  *
- * @return {SinCosTable} [description]
+ * @return {SinCosTable} The generated values.
  */
 var SinCosTableGenerator = function (length, sinAmp, cosAmp, frequency)
 {

src/math/easing/back/In.js

@@ -11,7 +11,7 @@
  * @since 3.0.0
  *
  * @param {number} v - The value to be tweened.
- * @param {number} [overshoot=1.70158] - [description]
+ * @param {number} [overshoot=1.70158] - The overshoot amount.
  *
  * @return {number} The tweened value.
  */

src/math/easing/back/InOut.js

@@ -11,7 +11,7 @@
  * @since 3.0.0
  *
  * @param {number} v - The value to be tweened.
- * @param {number} [overshoot=1.70158] - [description]
+ * @param {number} [overshoot=1.70158] - The overshoot amount.
  *
  * @return {number} The tweened value.
  */

src/math/easing/back/Out.js

@@ -11,7 +11,7 @@
  * @since 3.0.0
  *
  * @param {number} v - The value to be tweened.
- * @param {number} [overshoot=1.70158] - [description]
+ * @param {number} [overshoot=1.70158] - The overshoot amount.
  *
  * @return {number} The tweened value.
  */

src/math/easing/elastic/In.js

@@ -11,7 +11,7 @@
  * @since 3.0.0
  *
  * @param {number} v - The value to be tweened.
- * @param {float} [amplitude=0.1] - [description]
+ * @param {float} [amplitude=0.1] - The amplitude of the elastic ease.
  * @param {float} [period=0.1] - [description]
  *
  * @return {number} The tweened value.

src/math/easing/elastic/InOut.js

@@ -11,7 +11,7 @@
  * @since 3.0.0
  *
  * @param {number} v - The value to be tweened.
- * @param {float} [amplitude=0.1] - [description]
+ * @param {float} [amplitude=0.1] - The amplitude of the elastic ease.
  * @param {float} [period=0.1] - [description]
  *
  * @return {number} The tweened value.

src/math/easing/elastic/Out.js

@@ -11,7 +11,7 @@
  * @since 3.0.0
  *
  * @param {number} v - The value to be tweened.
- * @param {float} [amplitude=0.1] - [description]
+ * @param {float} [amplitude=0.1] - The amplitude of the elastic ease.
  * @param {float} [period=0.1] - [description]
  *
  * @return {number} The tweened value.

src/math/easing/stepped/Stepped.js

@@ -11,7 +11,7 @@
  * @since 3.0.0
  *
  * @param {number} v - The value to be tweened.
- * @param {float} [steps=1] - [description]
+ * @param {number} [steps=1] - The number of steps in the ease.
  *
  * @return {number} The tweened value.
  */