Added jsdocs

Author: photonstorm

src/scene/Scene.js

@@ -9,7 +9,7 @@ var Systems = require('./Systems');
 
 /**
  * @classdesc
- * [description]
+ * A base Phaser.Scene class which you could extend for your own use.
  *
  * @class Scene
  * @memberof Phaser

src/scene/Settings.js

@@ -16,50 +16,50 @@ var InjectionMap = require('./InjectionMap');
 /**
  * @typedef {object} Phaser.Scenes.Settings.Config
  *
- * @property {string} [key] - [description]
- * @property {boolean} [active=false] - [description]
- * @property {boolean} [visible=true] - [description]
- * @property {(false|Phaser.Loader.FileTypes.PackFileConfig)} [pack=false] - [description]
- * @property {?(InputJSONCameraObject|InputJSONCameraObject[])} [cameras=null] - [description]
+ * @property {string} [key] - The unique key of this Scene. Must be unique within the entire Game instance.
+ * @property {boolean} [active=false] - Does the Scene start as active or not? An active Scene updates each step.
+ * @property {boolean} [visible=true] - Does the Scene start as visible or not? A visible Scene renders each step.
+ * @property {(false|Phaser.Loader.FileTypes.PackFileConfig)} [pack=false] - An optional Loader Packfile to be loaded before the Scene begins.
+ * @property {?(InputJSONCameraObject|InputJSONCameraObject[])} [cameras=null] - An optional Camera configuration object.
  * @property {Object.<string, string>} [map] - Overwrites the default injection map for a scene.
  * @property {Object.<string, string>} [mapAdd] - Extends the injection map for a scene.
- * @property {object} [physics={}] - [description]
- * @property {object} [loader={}] - [description]
- * @property {(false|*)} [plugins=false] - [description]
+ * @property {object} [physics={}] - The physics configuration object for the Scene.
+ * @property {object} [loader={}] - The loader configuration object for the Scene.
+ * @property {(false|*)} [plugins=false] - The plugin configuration object for the Scene.
  */
 
 /**
  * @typedef {object} Phaser.Scenes.Settings.Object
  *
- * @property {number} status - [description]
- * @property {string} key - [description]
- * @property {boolean} active - [description]
- * @property {boolean} visible - [description]
- * @property {boolean} isBooted - [description]
- * @property {boolean} isTransition - [description]
- * @property {?Phaser.Scene} transitionFrom - [description]
- * @property {integer} transitionDuration - [description]
- * @property {boolean} transitionAllowInput - [description]
- * @property {object} data - [description]
- * @property {(false|Phaser.Loader.FileTypes.PackFileConfig)} pack - [description]
- * @property {?(InputJSONCameraObject|InputJSONCameraObject[])} cameras - [description]
- * @property {Object.<string, string>} map - [description]
- * @property {object} physics - [description]
- * @property {object} loader - [description]
- * @property {(false|*)} plugins - [description]
+ * @property {number} status - The current status of the Scene. Maps to the Scene constants.
+ * @property {string} key - The unique key of this Scene. Unique within the entire Game instance.
+ * @property {boolean} active - The active state of this Scene. An active Scene updates each step.
+ * @property {boolean} visible - The visible state of this Scene. A visible Scene renders each step.
+ * @property {boolean} isBooted - Has the Scene finished booting?
+ * @property {boolean} isTransition - Is the Scene in a state of transition?
+ * @property {?Phaser.Scene} transitionFrom - The Scene this Scene is transitioning from, if set.
+ * @property {integer} transitionDuration - The duration of the transition, if set.
+ * @property {boolean} transitionAllowInput - Is this Scene allowed to receive input during transitions?
+ * @property {object} data - a data bundle passed to this Scene from the Scene Manager.
+ * @property {(false|Phaser.Loader.FileTypes.PackFileConfig)} pack - The Loader Packfile to be loaded before the Scene begins.
+ * @property {?(InputJSONCameraObject|InputJSONCameraObject[])} cameras - The Camera configuration object.
+ * @property {Object.<string, string>} map - The Scene's Injection Map.
+ * @property {object} physics - The physics configuration object for the Scene.
+ * @property {object} loader - The loader configuration object for the Scene.
+ * @property {(false|*)} plugins - The plugin configuration object for the Scene.
  */
 
 var Settings = {
 
     /**
-     * Takes a Scene configuration object and returns a fully formed Systems object.
+     * Takes a Scene configuration object and returns a fully formed System Settings object.
      *
      * @function Phaser.Scenes.Settings.create
      * @since 3.0.0
      *
-     * @param {(string|Phaser.Scenes.Settings.Config)} config - [description]
+     * @param {(string|Phaser.Scenes.Settings.Config)} config - The Scene configuration object used to create this Scene Settings.
      *
-     * @return {Phaser.Scenes.Settings.Object} [description]
+     * @return {Phaser.Scenes.Settings.Object} The Scene Settings object created as a result of the config and default settings.
      */
     create: function (config)
     {

src/structs/List.js

@@ -433,7 +433,7 @@ var List = new Class({
      * @param {integer} [endIndex] - The position to stop removing at. The item at this position won't be removed.
      * @param {boolean} [skipCallback=false] - Skip calling the List.removeCallback.
      *
-     * @return {Array.<*>} An array of the items which were removed.[description]
+     * @return {Array.<*>} An array of the items which were removed.
      */
     removeBetween: function (startIndex, endIndex, skipCallback)
     {

src/structs/Map.js

@@ -10,10 +10,10 @@ var Class = require('../utils/Class');
  * @callback EachMapCallback
  * @generic E - [entry]
  *
- * @param {string} key - [description]
- * @param {*} entry - [description]
+ * @param {string} key - The key of the Map entry.
+ * @param {*} entry - The value of the Map entry.
  *
- * @return {?boolean} [description]
+ * @return {?boolean} The callback result.
  */
 
 /**

src/structs/ProcessQueue.js

@@ -8,7 +8,16 @@ var Class = require('../utils/Class');
 
 /**
  * @classdesc
- * [description]
+ * A Process Queue maintains three internal lists.
+ * 
+ * The `pending` list is a selection of items which are due to be made 'active' in the next update.
+ * The `active` list is a selection of items which are considered active and should be updated.
+ * The `destroy` list is a selection of items that were active and are awaiting being destroyed in the next update.
+ *
+ * When new items are added to a Process Queue they are put in a pending data, rather than being added
+ * immediately the active list. Equally, items that are removed are put into the destroy list, rather than
+ * being destroyed immediately. This allows the Process Queue to carefully process each item at a specific, fixed
+ * time, rather than at the time of the request from the API.
  *
  * @class ProcessQueue
  * @memberof Phaser.Structs
@@ -24,7 +33,7 @@ var ProcessQueue = new Class({
     function ProcessQueue ()
     {
         /**
-         * [description]
+         * The `pending` list is a selection of items which are due to be made 'active' in the next update.
          *
          * @genericUse {T[]} - [$type]
          *
@@ -37,7 +46,7 @@ var ProcessQueue = new Class({
         this._pending = [];
 
         /**
-         * [description]
+         * The `active` list is a selection of items which are considered active and should be updated.
          *
          * @genericUse {T[]} - [$type]
          *
@@ -50,7 +59,7 @@ var ProcessQueue = new Class({
         this._active = [];
 
         /**
-         * [description]
+         * The `destroy` list is a selection of items that were active and are awaiting being destroyed in the next update.
          *
          * @genericUse {T[]} - [$type]
          *
@@ -63,7 +72,7 @@ var ProcessQueue = new Class({
         this._destroy = [];
 
         /**
-         * [description]
+         * The total number of items awaiting processing.
          *
          * @name Phaser.Structs.ProcessQueue#_toProcess
          * @type {integer}
@@ -75,15 +84,16 @@ var ProcessQueue = new Class({
     },
 
     /**
-     * [description]
+     * Adds a new item to the Process Queue.
+     * The item is added to the pending list and made active in the next update.
      *
      * @method Phaser.Structs.ProcessQueue#add
      * @since 3.0.0
      *
      * @genericUse {T} - [item]
      * @genericUse {Phaser.Structs.ProcessQueue.<T>} - [$return]
      *
-     * @param {*} item - [description]
+     * @param {*} item - The item to add to the queue.
      *
      * @return {Phaser.Structs.ProcessQueue} This Process Queue object.
      */
@@ -97,15 +107,16 @@ var ProcessQueue = new Class({
     },
 
     /**
-     * [description]
+     * Removes an item from the Process Queue.
+     * The item is added to the pending destroy and fully removed in the next update.
      *
      * @method Phaser.Structs.ProcessQueue#remove
      * @since 3.0.0
      *
      * @genericUse {T} - [item]
      * @genericUse {Phaser.Structs.ProcessQueue.<T>} - [$return]
      *
-     * @param {*} item - [description]
+     * @param {*} item - The item to be removed from the queue.
      *
      * @return {Phaser.Structs.ProcessQueue} This Process Queue object.
      */
@@ -119,14 +130,17 @@ var ProcessQueue = new Class({
     },
 
     /**
-     * [description]
+     * Update this queue. First it will process any items awaiting destruction, and remove them.
+     * 
+     * Then it will check to see if there are any items pending insertion, and move them to an
+     * active state. Finally, it will return a list of active items for further processing.
      *
      * @method Phaser.Structs.ProcessQueue#update
      * @since 3.0.0
      *
      * @genericUse {T[]} - [$return]
      *
-     * @return {Array.<*>} [description]
+     * @return {Array.<*>} A list of active items.
      */
     update: function ()
     {
@@ -178,28 +192,30 @@ var ProcessQueue = new Class({
     },
 
     /**
-     * [description]
+     * Returns the current list of active items.
      *
      * @method Phaser.Structs.ProcessQueue#getActive
      * @since 3.0.0
      *
      * @genericUse {T[]} - [$return]
      *
-     * @return {Array.<*>} [description]
+     * @return {Array.<*>} A list of active items.
      */
     getActive: function ()
     {
         return this._active;
     },
 
     /**
-     * [description]
+     * Immediately destroys this process queue, clearing all of its internal arrays and resetting the process totals.
      *
      * @method Phaser.Structs.ProcessQueue#destroy
      * @since 3.0.0
      */
     destroy: function ()
     {
+        this._toProcess = 0;
+
         this._pending = [];
         this._active = [];
         this._destroy = [];

src/structs/Set.js

@@ -10,10 +10,10 @@ var Class = require('../utils/Class');
  * @callback EachSetCallback
  * @generic E - [entry]
  *
- * @param {*} entry - [description]
- * @param {number} index - [description]
+ * @param {*} entry - The Set entry.
+ * @param {number} index - The index of the entry within the Set.
  *
- * @return {?boolean} [description]
+ * @return {?boolean} The callback result.
  */
 
 /**

src/utils/array/Range.js

@@ -63,7 +63,7 @@ var BuildChunk = function (a, b, qty)
  * @param {array} b - The second array of range elements.
  * @param {object} [options] - A range configuration object. Can contain: repeat, random, randomB, yoyo, max, qty.
  *
- * @return {array} [description]
+ * @return {array} An array of arranged elements.
  */
 var Range = function (a, b, options)
 {