Merge branch 'master' of https://github.com/photonstorm/phaser

Author: photonstorm

src/gameobjects/components/MatrixStack.js

@@ -7,16 +7,16 @@
 /**
  * Provides methods used for getting and setting the transform values of a Game Object.
  * Should be applied as a mixin and not used directly.
- * 
+ *
  * @name Phaser.GameObjects.Components.MatrixStack
  * @since 3.2.0
  */
 
 var MatrixStack = {
 
     /**
-     * [description]
-     * 
+     * The matrix stack.
+     *
      * @name Phaser.GameObjects.Components.MatrixStack#matrixStack
      * @type {Float32Array}
      * @private
@@ -25,8 +25,8 @@ var MatrixStack = {
     matrixStack: null,
 
     /**
-     * [description]
-     * 
+     * The current matrix.
+     *
      * @name Phaser.GameObjects.Components.MatrixStack#currentMatrix
      * @type {Float32Array}
      * @private
@@ -35,8 +35,8 @@ var MatrixStack = {
     currentMatrix: null,
 
     /**
-     * [description]
-     * 
+     * The current index of the top of the matrix stack.
+     *
      * @name Phaser.GameObjects.Components.MatrixStack#currentMatrixIndex
      * @type {integer}
      * @private
@@ -45,8 +45,8 @@ var MatrixStack = {
     currentMatrixIndex: 0,
 
     /**
-     * [description]
-     * 
+     * Initialize the matrix stack.
+     *
      * @method Phaser.GameObjects.Components.MatrixStack#initMatrixStack
      * @since 3.2.0
      *
@@ -62,11 +62,11 @@ var MatrixStack = {
     },
 
     /**
-     * [description]
-     * 
+     * Push the current matrix onto the matrix stack.
+     *
      * @method Phaser.GameObjects.Components.MatrixStack#save
      * @since 3.2.0
-     * 
+     *
      * @return {this} This Game Object instance.
      */
     save: function ()
@@ -84,16 +84,16 @@ var MatrixStack = {
         matrixStack[currentMatrixIndex + 3] = currentMatrix[3];
         matrixStack[currentMatrixIndex + 4] = currentMatrix[4];
         matrixStack[currentMatrixIndex + 5] = currentMatrix[5];
-        
+
         return this;
     },
 
     /**
-     * [description]
-     * 
+     * Pop the top of the matrix stack into the current matrix.
+     *
      * @method Phaser.GameObjects.Components.MatrixStack#restore
      * @since 3.2.0
-     * 
+     *
      * @return {this} This Game Object instance.
      */
     restore: function ()
@@ -117,11 +117,11 @@ var MatrixStack = {
     },
 
     /**
-     * [description]
-     * 
+     * Resets the current matrix to the identity matrix.
+     *
      * @method Phaser.GameObjects.Components.MatrixStack#loadIdentity
      * @since 3.2.0
-     * 
+     *
      * @return {this} This Game Object instance.
      */
     loadIdentity: function ()
@@ -132,18 +132,18 @@ var MatrixStack = {
     },
 
     /**
-     * [description]
-     * 
+     * Transform the current matrix.
+     *
      * @method Phaser.GameObjects.Components.MatrixStack#transform
      * @since 3.2.0
      *
-     * @param {number} a - [description]
-     * @param {number} b - [description]
-     * @param {number} c - [description]
-     * @param {number} d - [description]
-     * @param {number} tx - [description]
-     * @param {number} ty - [description]
-     * 
+     * @param {number} a - The Scale X value.
+     * @param {number} b - The Shear Y value.
+     * @param {number} c - The Shear X value.
+     * @param {number} d - The Scale Y value.
+     * @param {number} tx - The Translate X value.
+     * @param {number} ty - The Translate Y value.
+     *
      * @return {this} This Game Object instance.
      */
     transform: function (a, b, c, d, tx, ty)
@@ -167,18 +167,18 @@ var MatrixStack = {
     },
 
     /**
-     * [description]
-     * 
+     * Set a transform matrix as the current matrix.
+     *
      * @method Phaser.GameObjects.Components.MatrixStack#setTransform
      * @since 3.2.0
      *
-     * @param {number} a - [description]
-     * @param {number} b - [description]
-     * @param {number} c - [description]
-     * @param {number} d - [description]
-     * @param {number} tx - [description]
-     * @param {number} ty - [description]
-     * 
+     * @param {number} a - The Scale X value.
+     * @param {number} b - The Shear Y value.
+     * @param {number} c - The Shear X value.
+     * @param {number} d - The Scale Y value.
+     * @param {number} tx - The Translate X value.
+     * @param {number} ty - The Translate Y value.
+     *
      * @return {this} This Game Object instance.
      */
     setTransform: function (a, b, c, d, tx, ty)
@@ -196,14 +196,14 @@ var MatrixStack = {
     },
 
     /**
-     * [description]
-     * 
+     * Translate the current matrix.
+     *
      * @method Phaser.GameObjects.Components.MatrixStack#translate
      * @since 3.2.0
      *
-     * @param {number} x - [description]
-     * @param {number} y - [description]
-     * 
+     * @param {number} x - The horizontal translation value.
+     * @param {number} y - The vertical translation value.
+     *
      * @return {this} This Game Object instance.
      */
     translate: function (x, y)
@@ -223,14 +223,14 @@ var MatrixStack = {
     },
 
     /**
-     * [description]
-     * 
+     * Scale the current matrix.
+     *
      * @method Phaser.GameObjects.Components.MatrixStack#scale
      * @since 3.2.0
      *
-     * @param {number} x - [description]
-     * @param {number} y - [description]
-     * 
+     * @param {number} x - The horizontal scale value.
+     * @param {number} y - The vertical scale value.
+     *
      * @return {this} This Game Object instance.
      */
     scale: function (x, y)
@@ -250,13 +250,13 @@ var MatrixStack = {
     },
 
     /**
-     * [description]
-     * 
+     * Rotate the current matrix.
+     *
      * @method Phaser.GameObjects.Components.MatrixStack#rotate
      * @since 3.2.0
      *
      * @param {number} t - The angle of rotation, in radians.
-     * 
+     *
      * @return {this} This Game Object instance.
      */
     rotate: function (t)