Add docs for groups and Arcade.Factory

Author: samme

src/gameobjects/group/Group.js

@@ -105,7 +105,7 @@ var Sprite = require('../sprite/Sprite');
  * @constructor
  * @since 3.0.0
  * @param {Phaser.Scene} scene - The scene this group belongs to.
- * @param {(Phaser.GameObjects.GameObject[]|GroupConfig)} [children] - Game objects to add to this group; or the `config` argument.
+ * @param {(Phaser.GameObjects.GameObject[]|GroupConfig|GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.
  * @param {GroupConfig|GroupCreateConfig} [config] - Settings for this group. If `key` is set, Phaser.GameObjects.Group#createMultiple is also called with these settings.
  *
  * @see Phaser.Physics.Arcade.Group

src/physics/arcade/Factory.js

@@ -101,8 +101,8 @@ var Factory = new Class({
      * @method Phaser.Physics.Arcade.Factory#existing
      * @since 3.0.0
      *
-     * @param {Phaser.GameObjects.GameObject} gameObject - [description]
-     * @param {boolean} [isStatic=false] - Set to true to create a Static body, otherwise it will create a Dynamic body.
+     * @param {Phaser.GameObjects.GameObject} gameObject - A Game Object.
+     * @param {boolean} [isStatic=false] - Create a Static body (true) or Dynamic body (false).
      *
      * @return {Phaser.GameObjects.GameObject} The Game Object.
      */
@@ -220,8 +220,8 @@ var Factory = new Class({
      * @method Phaser.Physics.Arcade.Factory#staticGroup
      * @since 3.0.0
      *
-     * @param {object|object[]} [children] - [description]
-     * @param {GroupConfig} [config] - [description]
+     * @param {(Phaser.GameObjects.GameObject[]|GroupConfig|GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.
+     * @param {GroupConfig|GroupCreateConfig} [config] - Settings for this group.
      *
      * @return {Phaser.Physics.Arcade.StaticGroup} The Static Group object that was created.
      */
@@ -237,8 +237,8 @@ var Factory = new Class({
      * @method Phaser.Physics.Arcade.Factory#group
      * @since 3.0.0
      *
-     * @param {object|object[]} [children] - [description]
-     * @param {PhysicsGroupConfig} [config] - [description]
+     * @param {(Phaser.GameObjects.GameObject[]|PhysicsGroupConfig|GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.
+     * @param {PhysicsGroupConfig|GroupCreateConfig} [config] - Settings for this group.
      *
      * @return {Phaser.Physics.Arcade.Group} The Group object that was created.
      */

src/physics/arcade/PhysicsGroup.js

@@ -41,27 +41,27 @@ var IsPlainObject = require('../../utils/object/IsPlainObject');
 /**
  * @typedef {object} PhysicsGroupDefaults
  *
- * @property {boolean} setCollideWorldBounds - [description]
- * @property {number} setAccelerationX - [description]
- * @property {number} setAccelerationY - [description]
- * @property {boolean} setAllowDrag - [description]
- * @property {boolean} setAllowGravity - [description]
- * @property {boolean} setAllowRotation - [description]
- * @property {number} setBounceX - [description]
- * @property {number} setBounceY - [description]
- * @property {number} setDragX - [description]
- * @property {number} setDragY - [description]
- * @property {number} setGravityX - [description]
- * @property {number} setGravityY - [description]
- * @property {number} setFrictionX - [description]
- * @property {number} setFrictionY - [description]
- * @property {number} setVelocityX - [description]
- * @property {number} setVelocityY - [description]
- * @property {number} setAngularVelocity - [description]
- * @property {number} setAngularAcceleration - [description]
- * @property {number} setAngularDrag - [description]
- * @property {number} setMass - [description]
- * @property {boolean} setImmovable - [description]
+ * @property {boolean} setCollideWorldBounds - As {@link Phaser.Physics.Arcade.Body#setCollideWorldBounds}.
+ * @property {number} setAccelerationX - As {@link Phaser.Physics.Arcade.Body#setAccelerationX}.
+ * @property {number} setAccelerationY - As {@link Phaser.Physics.Arcade.Body#setAccelerationY}.
+ * @property {boolean} setAllowDrag - As {@link Phaser.Physics.Arcade.Body#setAllowDrag}.
+ * @property {boolean} setAllowGravity - As {@link Phaser.Physics.Arcade.Body#setAllowGravity}.
+ * @property {boolean} setAllowRotation - As {@link Phaser.Physics.Arcade.Body#setAllowRotation}.
+ * @property {number} setBounceX - As {@link Phaser.Physics.Arcade.Body#setBounceX}.
+ * @property {number} setBounceY - As {@link Phaser.Physics.Arcade.Body#setBounceY}.
+ * @property {number} setDragX - As {@link Phaser.Physics.Arcade.Body#setDragX}.
+ * @property {number} setDragY - As {@link Phaser.Physics.Arcade.Body#setDragY}.
+ * @property {number} setGravityX - As {@link Phaser.Physics.Arcade.Body#setGravityX}.
+ * @property {number} setGravityY - As {@link Phaser.Physics.Arcade.Body#setGravityY}.
+ * @property {number} setFrictionX - As {@link Phaser.Physics.Arcade.Body#setFrictionX}.
+ * @property {number} setFrictionY - As {@link Phaser.Physics.Arcade.Body#setFrictionY}.
+ * @property {number} setVelocityX - As {@link Phaser.Physics.Arcade.Body#setVelocityX}.
+ * @property {number} setVelocityY - As {@link Phaser.Physics.Arcade.Body#setVelocityY}.
+ * @property {number} setAngularVelocity - As {@link Phaser.Physics.Arcade.Body#setAngularVelocity}.
+ * @property {number} setAngularAcceleration - As {@link Phaser.Physics.Arcade.Body#setAngularAcceleration}.
+ * @property {number} setAngularDrag - As {@link Phaser.Physics.Arcade.Body#setAngularDrag}.
+ * @property {number} setMass - As {@link Phaser.Physics.Arcade.Body#setMass}.
+ * @property {boolean} setImmovable - As {@link Phaser.Physics.Arcade.Body#setImmovable}.
  */
 
 /**
@@ -78,10 +78,10 @@ var IsPlainObject = require('../../utils/object/IsPlainObject');
  * @constructor
  * @since 3.0.0
  *
- * @param {Phaser.Physics.Arcade.World} world - [description]
- * @param {Phaser.Scene} scene - [description]
- * @param {array} children - [description]
- * @param {PhysicsGroupConfig} [config] - [description]
+ * @param {Phaser.Physics.Arcade.World} world - The physics simulation.
+ * @param {Phaser.Scene} scene - The scene this group belongs to.
+ * @param {(Phaser.GameObjects.GameObject[]|PhysicsGroupConfig|GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.
+ * @param {PhysicsGroupConfig|GroupCreateConfig} [config] - Settings for this group.
  */
 var PhysicsGroup = new Class({
 
@@ -121,7 +121,7 @@ var PhysicsGroup = new Class({
         }
 
         /**
-         * [description]
+         * The physics simulation.
          *
          * @name Phaser.Physics.Arcade.Group#world
          * @type {Phaser.Physics.Arcade.World}
@@ -140,7 +140,7 @@ var PhysicsGroup = new Class({
         config.classType = GetFastValue(config, 'classType', ArcadeSprite);
 
         /**
-         * [description]
+         * The physics type of the Group's members.
          *
          * @name Phaser.Physics.Arcade.Group#physicsType
          * @type {integer}
@@ -189,7 +189,7 @@ var PhysicsGroup = new Class({
      * @method Phaser.Physics.Arcade.Group#createCallbackHandler
      * @since 3.0.0
      *
-     * @param {Phaser.GameObjects.GameObject} child - [description]
+     * @param {Phaser.GameObjects.GameObject} child - The Game Object being added.
      */
     createCallbackHandler: function (child)
     {
@@ -212,7 +212,7 @@ var PhysicsGroup = new Class({
      * @method Phaser.Physics.Arcade.Group#removeCallbackHandler
      * @since 3.0.0
      *
-     * @param {Phaser.GameObjects.GameObject} child - [description]
+     * @param {Phaser.GameObjects.GameObject} child - The Game Object being removed.
      */
     removeCallbackHandler: function (child)
     {
@@ -228,9 +228,9 @@ var PhysicsGroup = new Class({
      * @method Phaser.Physics.Arcade.Group#setVelocity
      * @since 3.0.0
      *
-     * @param {number} x - [description]
-     * @param {number} y - [description]
-     * @param {number} step - [description]
+     * @param {number} x - The horizontal velocity.
+     * @param {number} y - The vertical velocity.
+     * @param {number} [step=0] - The velocity increment. When set, the first member receives velocity (x, y), the second (x + step, y + step), and so on.
      *
      * @return {Phaser.Physics.Arcade.Group} This Physics Group object.
      */
@@ -254,8 +254,8 @@ var PhysicsGroup = new Class({
      * @method Phaser.Physics.Arcade.Group#setVelocityX
      * @since 3.0.0
      *
-     * @param {number} value - [description]
-     * @param {number} step - [description]
+     * @param {number} value - The velocity value.
+     * @param {number} [step=0] - The velocity increment. When set, the first member receives velocity (x), the second (x + step), and so on.
      *
      * @return {Phaser.Physics.Arcade.Group} This Physics Group object.
      */
@@ -279,8 +279,8 @@ var PhysicsGroup = new Class({
      * @method Phaser.Physics.Arcade.Group#setVelocityY
      * @since 3.0.0
      *
-     * @param {number} value - [description]
-     * @param {number} step - [description]
+     * @param {number} value - The velocity value.
+     * @param {number} [step=0] - The velocity increment. When set, the first member receives velocity (y), the second (y + step), and so on.
      *
      * @return {Phaser.Physics.Arcade.Group} This Physics Group object.
      */

src/physics/arcade/StaticPhysicsGroup.js

@@ -24,10 +24,10 @@ var IsPlainObject = require('../../utils/object/IsPlainObject');
  * @constructor
  * @since 3.0.0
  *
- * @param {Phaser.Physics.Arcade.World} world - [description]
- * @param {Phaser.Scene} scene - [description]
- * @param {array} children - [description]
- * @param {GroupConfig} config - [description]
+ * @param {Phaser.Physics.Arcade.World} world - The physics simulation.
+ * @param {Phaser.Scene} scene - The scene this group belongs to.
+ * @param {(Phaser.GameObjects.GameObject[]|GroupConfig|GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.
+ * @param {GroupConfig|GroupCreateConfig} [config] - Settings for this group.
  */
 var StaticPhysicsGroup = new Class({
 
@@ -73,7 +73,7 @@ var StaticPhysicsGroup = new Class({
         }
 
         /**
-         * [description]
+         * The physics simulation.
          *
          * @name Phaser.Physics.Arcade.StaticGroup#world
          * @type {Phaser.Physics.Arcade.World}
@@ -82,7 +82,7 @@ var StaticPhysicsGroup = new Class({
         this.world = world;
 
         /**
-         * [description]
+         * The scene this group belongs to.
          *
          * @name Phaser.Physics.Arcade.StaticGroup#physicsType
          * @type {integer}
@@ -95,12 +95,14 @@ var StaticPhysicsGroup = new Class({
     },
 
     /**
-     * [description]
+     * Adds a static physics body to the new group member (if it lacks one) and adds it to the simulation.
      *
      * @method Phaser.Physics.Arcade.StaticGroup#createCallbackHandler
      * @since 3.0.0
      *
-     * @param {Phaser.GameObjects.GameObject} child - [description]
+     * @param {Phaser.GameObjects.GameObject} child - The new group member.
+     *
+     * @see Phaser.Physics.Arcade.World#enableBody
      */
     createCallbackHandler: function (child)
     {
@@ -111,12 +113,14 @@ var StaticPhysicsGroup = new Class({
     },
 
     /**
-     * [description]
+     * Disables the group member's physics body, removing it from the simulation.
      *
      * @method Phaser.Physics.Arcade.StaticGroup#removeCallbackHandler
      * @since 3.0.0
      *
-     * @param {Phaser.GameObjects.GameObject} child - [description]
+     * @param {Phaser.GameObjects.GameObject} child - The group member being removed.
+     *
+     * @see Phaser.Physics.Arcade.World#disableBody
      */
     removeCallbackHandler: function (child)
     {
@@ -127,12 +131,14 @@ var StaticPhysicsGroup = new Class({
     },
 
     /**
-     * [description]
+     * Refreshes the group.
      *
      * @method Phaser.Physics.Arcade.StaticGroup#createMultipleCallbackHandler
      * @since 3.0.0
      *
-     * @param {object} entries - [description]
+     * @param {Phaser.GameObjects.GameObject[]} entries - The newly created group members.
+     *
+     * @see Phaser.Physics.Arcade.StaticGroup#refresh
      */
     createMultipleCallbackHandler: function ()
     {
@@ -146,7 +152,7 @@ var StaticPhysicsGroup = new Class({
      * @method Phaser.Physics.Arcade.StaticGroup#refresh
      * @since 3.0.0
      *
-     * @return {Phaser.Physics.Arcade.StaticGroup} [description]
+     * @return {Phaser.Physics.Arcade.StaticGroup} This group.
      *
      * @see Phaser.Physics.Arcade.StaticBody#reset
      */