Update JSDoc on "Impact" physics

Author: orblazer

src/physics/impact/Body.js

@@ -293,7 +293,7 @@ var Body = new Class({
          * @since 3.0.0
          */
         this.updateCallback;
-    
+
         /**
          * min 44 deg, max 136 deg
          *
@@ -331,7 +331,7 @@ var Body = new Class({
         this.accelGround = 0;
         this.accelAir = 0;
         this.jumpSpeed = 0;
-    
+
         this.type = TYPE.NONE;
         this.checkAgainst = TYPE.NONE;
         this.collides = COLLIDES.NEVER;
@@ -353,10 +353,10 @@ var Body = new Class({
         this.last.y = pos.y;
 
         this.vel.y += this.world.gravity * delta * this.gravityFactor;
-        
+
         this.vel.x = GetVelocity(delta, this.vel.x, this.accel.x, this.friction.x, this.maxVel.x);
         this.vel.y = GetVelocity(delta, this.vel.y, this.accel.y, this.friction.y, this.maxVel.y);
-        
+
         var mx = this.vel.x * delta;
         var my = this.vel.y * delta;
 
@@ -539,7 +539,7 @@ var Body = new Class({
      * @since 3.0.0
      *
      * @param {Phaser.Physics.Impact.Body} other - [description]
-     * @param {[type]} axis - [description]
+     * @param {string} axis - [description]
      */
     collideWith: function (other, axis)
     {

src/physics/impact/COLLIDES.js

@@ -6,21 +6,20 @@
 
 /**
  * Collision Types - Determine if and how entities collide with each other.
- * 
+ *
  * In ACTIVE vs. LITE or FIXED vs. ANY collisions, only the "weak" entity moves,
  * while the other one stays fixed. In ACTIVE vs. ACTIVE and ACTIVE vs. PASSIVE
  * collisions, both entities are moved. LITE or PASSIVE entities don't collide
  * with other LITE or PASSIVE entities at all. The behavior for FIXED vs.
  * FIXED collisions is undefined.
- * 
+ *
  * @namespace Phaser.Physics.Impact.COLLIDES
  */
-
 module.exports = {
 
     /**
      * Never collides.
-     * 
+     *
      * @name Phaser.Physics.Impact.COLLIDES.NEVER
      * @type {integer}
      * @since 3.0.0
@@ -29,7 +28,7 @@ module.exports = {
 
     /**
      * Lite collision.
-     * 
+     *
      * @name Phaser.Physics.Impact.COLLIDES.LITE
      * @type {integer}
      * @since 3.0.0
@@ -38,7 +37,7 @@ module.exports = {
 
     /**
      * Passive collision.
-     * 
+     *
      * @name Phaser.Physics.Impact.COLLIDES.PASSIVE
      * @type {integer}
      * @since 3.0.0
@@ -47,7 +46,7 @@ module.exports = {
 
     /**
      * Active collision.
-     * 
+     *
      * @name Phaser.Physics.Impact.COLLIDES.ACTIVE
      * @type {integer}
      * @since 3.0.0
@@ -56,7 +55,7 @@ module.exports = {
 
     /**
      * Fixed collision.
-     * 
+     *
      * @name Phaser.Physics.Impact.COLLIDES.FIXED
      * @type {integer}
      * @since 3.0.0

src/physics/impact/Factory.js

@@ -97,7 +97,7 @@ var Factory = new Class({
      *
      * @param {number} x - The horizontal position of this Game Object in the world.
      * @param {number} y - The vertical position of this Game Object in the world.
-     * @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
+     * @param {string} key - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
      * @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
      *
      * @return {Phaser.Physics.Impact.ImpactImage} The ImpactImage object that was created.
@@ -119,7 +119,7 @@ var Factory = new Class({
      *
      * @param {number} x - The horizontal position of this Game Object in the world.
      * @param {number} y - The vertical position of this Game Object in the world.
-     * @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
+     * @param {string} key - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
      * @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
      *
      * @return {Phaser.Physics.Impact.ImpactSprite} The ImpactSprite object that was created.

src/physics/impact/TYPE.js

@@ -6,21 +6,20 @@
 
 /**
  * Collision Types - Determine if and how entities collide with each other.
- * 
+ *
  * In ACTIVE vs. LITE or FIXED vs. ANY collisions, only the "weak" entity moves,
  * while the other one stays fixed. In ACTIVE vs. ACTIVE and ACTIVE vs. PASSIVE
  * collisions, both entities are moved. LITE or PASSIVE entities don't collide
  * with other LITE or PASSIVE entities at all. The behavior for FIXED vs.
  * FIXED collisions is undefined.
- * 
+ *
  * @namespace Phaser.Physics.Impact.TYPES
  */
-
 module.exports = {
 
     /**
      * Collides with nothing.
-     * 
+     *
      * @name Phaser.Physics.Impact.TYPES.NONE
      * @type {integer}
      * @since 3.0.0
@@ -29,7 +28,7 @@ module.exports = {
 
     /**
      * Type A. Collides with Type B.
-     * 
+     *
      * @name Phaser.Physics.Impact.TYPES.A
      * @type {integer}
      * @since 3.0.0
@@ -38,7 +37,7 @@ module.exports = {
 
     /**
      * Type B. Collides with Type A.
-     * 
+     *
      * @name Phaser.Physics.Impact.TYPES.B
      * @type {integer}
      * @since 3.0.0
@@ -47,7 +46,7 @@ module.exports = {
 
     /**
      * Collides with both types A and B.
-     * 
+     *
      * @name Phaser.Physics.Impact.TYPES.BOTH
      * @type {integer}
      * @since 3.0.0

src/physics/impact/components/Acceleration.js

@@ -18,9 +18,9 @@ var Acceleration = {
      * @method Phaser.Physics.Impact.Components.Acceleration#setAccelerationX
      * @since 3.0.0
      *
-     * @param {[type]} x - [description]
+     * @param {number} x - [description]
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setAccelerationX: function (x)
     {
@@ -35,9 +35,9 @@ var Acceleration = {
      * @method Phaser.Physics.Impact.Components.Acceleration#setAccelerationY
      * @since 3.0.0
      *
-     * @param {[type]} y - [description]
+     * @param {number} y - [description]
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setAccelerationY: function (y)
     {
@@ -52,10 +52,10 @@ var Acceleration = {
      * @method Phaser.Physics.Impact.Components.Acceleration#setAcceleration
      * @since 3.0.0
      *
-     * @param {[type]} x - [description]
-     * @param {[type]} y - [description]
+     * @param {number} x - [description]
+     * @param {number} y - [description]
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setAcceleration: function (x, y)
     {

src/physics/impact/components/BodyScale.js

@@ -18,10 +18,10 @@ var BodyScale = {
      * @method Phaser.Physics.Impact.Components.BodyScale#setBodySize
      * @since 3.0.0
      *
-     * @param {[type]} width - [description]
-     * @param {[type]} height - [description]
+     * @param {number} width - [description]
+     * @param {number} [height=width] - [description]
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setBodySize: function (width, height)
     {
@@ -39,10 +39,10 @@ var BodyScale = {
      * @method Phaser.Physics.Impact.Components.BodyScale#setBodyScale
      * @since 3.0.0
      *
-     * @param {[type]} scaleX - [description]
-     * @param {[type]} scaleY - [description]
+     * @param {number} scaleX - [description]
+     * @param {number} [scaleY] - [description]
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setBodyScale: function (scaleX, scaleY)
     {

src/physics/impact/components/BodyType.js

@@ -20,7 +20,7 @@ var BodyType = {
      * @method Phaser.Physics.Impact.Components.BodyType#getBodyType
      * @since 3.0.0
      *
-     * @return {[type]} [description]
+     * @return {number} [description]
      */
     getBodyType: function ()
     {
@@ -33,7 +33,7 @@ var BodyType = {
      * @method Phaser.Physics.Impact.Components.BodyType#setTypeNone
      * @since 3.0.0
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setTypeNone: function ()
     {
@@ -48,7 +48,7 @@ var BodyType = {
      * @method Phaser.Physics.Impact.Components.BodyType#setTypeA
      * @since 3.0.0
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setTypeA: function ()
     {
@@ -63,7 +63,7 @@ var BodyType = {
      * @method Phaser.Physics.Impact.Components.BodyType#setTypeB
      * @since 3.0.0
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setTypeB: function ()
     {

src/physics/impact/components/Bounce.js

@@ -18,9 +18,9 @@ var Bounce = {
      * @method Phaser.Physics.Impact.Components.Bounce#setBounce
      * @since 3.0.0
      *
-     * @param {[type]} value - [description]
+     * @param {number} value - [description]
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setBounce: function (value)
     {
@@ -35,9 +35,9 @@ var Bounce = {
      * @method Phaser.Physics.Impact.Components.Bounce#setMinBounceVelocity
      * @since 3.0.0
      *
-     * @param {[type]} value - [description]
+     * @param {number} value - [description]
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setMinBounceVelocity: function (value)
     {
@@ -50,7 +50,7 @@ var Bounce = {
      * [description]
      *
      * @name Phaser.Physics.Impact.Components.Bounce#bounce
-     * @type {[type]}
+     * @type {number}
      * @since 3.0.0
      */
     bounce: {

src/physics/impact/components/CheckAgainst.js

@@ -20,7 +20,7 @@ var CheckAgainst = {
      * @method Phaser.Physics.Impact.Components.CheckAgainst#setAvsB
      * @since 3.0.0
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setAvsB: function ()
     {
@@ -35,7 +35,7 @@ var CheckAgainst = {
      * @method Phaser.Physics.Impact.Components.CheckAgainst#setBvsA
      * @since 3.0.0
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setBvsA: function ()
     {
@@ -50,7 +50,7 @@ var CheckAgainst = {
      * @method Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstNone
      * @since 3.0.0
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setCheckAgainstNone: function ()
     {
@@ -65,7 +65,7 @@ var CheckAgainst = {
      * @method Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstA
      * @since 3.0.0
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setCheckAgainstA: function ()
     {
@@ -80,7 +80,7 @@ var CheckAgainst = {
      * @method Phaser.Physics.Impact.Components.CheckAgainst#setCheckAgainstB
      * @since 3.0.0
      *
-     * @return {[type]} [description]
+     * @return {Phaser.GameObjects.GameObject} This Game Object.
      */
     setCheckAgainstB: function ()
     {
@@ -93,7 +93,7 @@ var CheckAgainst = {
      * [description]
      *
      * @name Phaser.Physics.Impact.Components.CheckAgainst#checkAgainst
-     * @type {[type]}
+     * @type {number}
      * @since 3.0.0
      */
     checkAgainst: {