Added new jsdocs

Author: photonstorm

CHANGELOG.md

@@ -92,10 +92,20 @@ snowbillr
 Stephen Hamilton
 STuFF
 TadejZupancic
+
 ajmetal
 henriacle
 @rgk
 @samme
+Carl
+@16patsle
+Kyle
+Hardylr
+andiCR
+@bobonthenet
+Kanthi
+
+
 
 ## Version 3.13.0 - Yuuki - 20th September 2018
 

src/physics/arcade/components/Acceleration.js

@@ -5,15 +5,15 @@
  */
 
 /**
- * [description]
+ * Provides methods used for setting the acceleration properties of an Arcade Body.
  *
  * @name Phaser.Physics.Arcade.Components.Acceleration
  * @since 3.0.0
  */
 var Acceleration = {
 
     /**
-     * [description]
+     * Sets the body's horizontal and vertical acceleration. If the vertical acceleration value is not provided, the vertical acceleration is set to the same value as the horizontal acceleration.
      *
      * @method Phaser.Physics.Arcade.Components.Acceleration#setAcceleration
      * @since 3.0.0
@@ -31,7 +31,7 @@ var Acceleration = {
     },
 
     /**
-     * [description]
+     * Sets the body's horizontal acceleration.
      *
      * @method Phaser.Physics.Arcade.Components.Acceleration#setAccelerationX
      * @since 3.0.0
@@ -48,7 +48,7 @@ var Acceleration = {
     },
 
     /**
-     * [description]
+     * Sets the body's vertical acceleration.
      *
      * @method Phaser.Physics.Arcade.Components.Acceleration#setAccelerationY
      * @since 3.0.0

src/physics/arcade/components/Friction.js

@@ -5,21 +5,22 @@
  */
 
 /**
- * [description]
+ * Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving horizontally in the X axis. The higher than friction, the faster the body will slow down once force stops being applied to it.
  *
  * @name Phaser.Physics.Arcade.Components.Friction
  * @since 3.0.0
  */
 var Friction = {
 
     /**
-     * [description]
+     * Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving.
+     * The higher than friction, the faster the body will slow down once force stops being applied to it.
      *
      * @method Phaser.Physics.Arcade.Components.Friction#setFriction
      * @since 3.0.0
      *
-     * @param {number} x - [description]
-     * @param {number} [y=x] - [description]
+     * @param {number} x - The amount of horizontal friction to apply.
+     * @param {number} [y=x] - The amount of vertical friction to apply.
      *
      * @return {this} This Game Object.
      */
@@ -31,12 +32,13 @@ var Friction = {
     },
 
     /**
-     * [description]
+     * Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving horizontally in the X axis.
+     * The higher than friction, the faster the body will slow down once force stops being applied to it.
      *
      * @method Phaser.Physics.Arcade.Components.Friction#setFrictionX
      * @since 3.0.0
      *
-     * @param {number} x - [description]
+     * @param {number} x - The amount of friction to apply.
      *
      * @return {this} This Game Object.
      */
@@ -48,12 +50,13 @@ var Friction = {
     },
 
     /**
-     * [description]
+     * Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving vertically in the Y axis.
+     * The higher than friction, the faster the body will slow down once force stops being applied to it.
      *
      * @method Phaser.Physics.Arcade.Components.Friction#setFrictionY
      * @since 3.0.0
      *
-     * @param {number} y - [description]
+     * @param {number} x - The amount of friction to apply.
      *
      * @return {this} This Game Object.
      */

src/physics/arcade/components/Gravity.js

@@ -5,21 +5,24 @@
  */
 
 /**
- * [description]
+ * Provides methods for setting the gravity properties of an Arcade Physics Game Object.
+ * Should be applied as a mixin and not used directly.
  *
  * @name Phaser.Physics.Arcade.Components.Gravity
  * @since 3.0.0
  */
 var Gravity = {
 
     /**
-     * [description]
+     * Set the X and Y values of the gravitational pull to act upon this Arcade Physics Game Object. Values can be positive or negative. Larger values result in a stronger effect.
+     * 
+     * If only one value is provided, this value will be used for both the X and Y axis.
      *
      * @method Phaser.Physics.Arcade.Components.Gravity#setGravity
      * @since 3.0.0
      *
-     * @param {number} x - [description]
-     * @param {number} [y=x] - [description]
+     * @param {number} x - The gravitational force to be applied to the X-axis.
+     * @param {number} [y=x] - The gravitational force to be applied to the Y-axis. If this is not specified, the X value will be used.
      *
      * @return {this} This Game Object.
      */
@@ -31,12 +34,12 @@ var Gravity = {
     },
 
     /**
-     * [description]
+     * Set the gravitational force to be applied to the X axis. Value can be positive or negative. Larger values result in a stronger effect.
      *
      * @method Phaser.Physics.Arcade.Components.Gravity#setGravityX
      * @since 3.0.0
      *
-     * @param {number} x - [description]
+     * @param {number} x - The gravitational force to be applied to the X-axis.
      *
      * @return {this} This Game Object.
      */
@@ -48,12 +51,12 @@ var Gravity = {
     },
 
     /**
-     * [description]
+     * Set the gravitational force to be applied to the Y axis. Value can be positive or negative. Larger values result in a stronger effect.
      *
      * @method Phaser.Physics.Arcade.Components.Gravity#setGravityY
      * @since 3.0.0
      *
-     * @param {number} y - [description]
+     * @param {number} y - The gravitational force to be applied to the Y-axis.
      *
      * @return {this} This Game Object.
      */

src/physics/arcade/components/Size.js

@@ -5,21 +5,23 @@
  */
 
 /**
- * [description]
+ * Provides methods for setting the size of an Arcade Physics Game Object.
+ * Should be applied as a mixin and not used directly.
  *
  * @name Phaser.Physics.Arcade.Components.Size
  * @since 3.0.0
  */
 var Size = {
 
     /**
-     * [description]
+     * Sets the body offset. This allows you to adjust the difference between the center of the body
+     * and the x and y coordinates of the parent Game Object.
      *
      * @method Phaser.Physics.Arcade.Components.Size#setOffset
      * @since 3.0.0
      *
-     * @param {number} x - [description]
-     * @param {number} [y=x] - [description]
+     * @param {number} x - The amount to offset the body from the parent Game Object along the x-axis.
+     * @param {number} [y=x] - The amount to offset the body from the parent Game Object along the y-axis. Defaults to the value given for the x-axis.
      *
      * @return {this} This Game Object.
      */
@@ -31,14 +33,15 @@ var Size = {
     },
 
     /**
-     * [description]
+     * Sets the size of this physics body. Setting the size does not adjust the dimensions
+     * of the parent Game Object.
      *
      * @method Phaser.Physics.Arcade.Components.Size#setSize
      * @since 3.0.0
      *
-     * @param {number} width - [description]
-     * @param {number} height - [description]
-     * @param {boolean} [center=true] - [description]
+     * @param {number} width - The new width of the physics body, in pixels.
+     * @param {number} height - The new height of the physics body, in pixels.
+     * @param {boolean} [center=true] - Should the body be re-positioned so its center aligns with the parent Game Object?
      *
      * @return {this} This Game Object.
      */
@@ -50,14 +53,14 @@ var Size = {
     },
 
     /**
-     * [description]
+     * Sets this physics body to use a circle for collision instead of a rectangle.
      *
      * @method Phaser.Physics.Arcade.Components.Size#setCircle
      * @since 3.0.0
      *
-     * @param {number} radius - [description]
-     * @param {number} [offsetX] - [description]
-     * @param {number} [offsetY] - [description]
+     * @param {number} radius - The radius of the physics body, in pixels.
+     * @param {number} [offsetX] - The amount to offset the body from the parent Game Object along the x-axis.
+     * @param {number} [offsetY] - The amount to offset the body from the parent Game Object along the y-axis.
      *
      * @return {this} This Game Object.
      */

src/physics/impact/Body.js

@@ -481,15 +481,15 @@ var Body = new Class({
     },
 
     /**
-     * [description]
+     * Reset the size and position of the physics body.
      *
      * @method Phaser.Physics.Impact.Body#resetSize
      * @since 3.0.0
      *
-     * @param {number} x - [description]
-     * @param {number} y - [description]
-     * @param {number} width - [description]
-     * @param {number} height - [description]
+     * @param {number} x - The x coordinate to position the body.
+     * @param {number} y - The y coordinate to position the body.
+     * @param {number} width - The width of the body.
+     * @param {number} height - The height of the body.
      *
      * @return {Phaser.Physics.Impact.Body} This Body object.
      */

src/physics/impact/Factory.js

@@ -19,7 +19,7 @@ var ImpactSprite = require('./ImpactSprite');
  * @constructor
  * @since 3.0.0
  *
- * @param {Phaser.Physics.Impact.World} world - [description]
+ * @param {Phaser.Physics.Impact.World} world - A reference to the Impact Physics world.
  */
 var Factory = new Class({
 
@@ -28,7 +28,7 @@ var Factory = new Class({
     function Factory (world)
     {
         /**
-         * [description]
+         * A reference to the Impact Physics world.
          *
          * @name Phaser.Physics.Impact.Factory#world
          * @type {Phaser.Physics.Impact.World}
@@ -47,15 +47,15 @@ var Factory = new Class({
     },
 
     /**
-     * [description]
+     * Creates a new ImpactBody object and adds it to the physics simulation.
      *
      * @method Phaser.Physics.Impact.Factory#body
      * @since 3.0.0
      *
-     * @param {number} x - [description]
-     * @param {number} y - [description]
-     * @param {number} width - [description]
-     * @param {number} height - [description]
+     * @param {number} x - The horizontal position of the body in the physics world.
+     * @param {number} y - The vertical position of the body in the physics world.
+     * @param {number} width - The width of the body.
+     * @param {number} height - The height of the body.
      *
      * @return {Phaser.Physics.Impact.ImpactBody} The ImpactBody object that was created.
      */
@@ -70,7 +70,7 @@ var Factory = new Class({
      * @method Phaser.Physics.Impact.Factory#existing
      * @since 3.0.0
      *
-     * @param {Phaser.GameObjects.GameObject} gameObject - [description]
+     * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to receive the physics body.
      *
      * @return {Phaser.GameObjects.GameObject} The Game Object.
      */
@@ -90,7 +90,7 @@ var Factory = new Class({
     },
 
     /**
-     * [description]
+     * Creates a new ImpactImage object and adds it to the physics world.
      *
      * @method Phaser.Physics.Impact.Factory#image
      * @since 3.0.0
@@ -112,7 +112,7 @@ var Factory = new Class({
     },
 
     /**
-     * [description]
+     * Creates a new ImpactSprite object and adds it to the physics world.
      *
      * @method Phaser.Physics.Impact.Factory#sprite
      * @since 3.0.0