Hundreds more jsdocs completed.

Author: photonstorm

src/input/InputPlugin.js

@@ -9,10 +9,11 @@
  * Return `true` if it reached the end of the combo, `false` if not.
  *
  * @function Phaser.Input.Keyboard.KeyCombo.AdvanceKeyCombo
+ * @private
  * @since 3.0.0
  *
- * @param {KeyboardEvent} event - [description]
- * @param {Phaser.Input.Keyboard.KeyCombo} combo - [description]
+ * @param {KeyboardEvent} event - The native Keyboard Event.
+ * @param {Phaser.Input.Keyboard.KeyCombo} combo - The KeyCombo object to advance.
  *
  * @return {boolean} `true` if it reached the end of the combo, `false` if not.
  */

src/input/keyboard/combo/AdvanceKeyCombo.js

@@ -12,36 +12,54 @@ var ResetKeyCombo = require('./ResetKeyCombo');
 /**
  * @callback KeyboardKeydownCallback
  *
- * @param {KeyboardEvent} event - [description]
+ * @param {KeyboardEvent} event - The Keyboard Event.
  */
 
 /**
  * @typedef {object} KeyComboConfig
  *
- * @property {boolean} [resetOnWrongKey=true] - [description]
- * @property {number} [maxKeyDelay=0] - [description]
- * @property {boolean} [resetOnMatch=false] - [description]
- * @property {boolean} [deleteOnMatch=false] - [description]
+ * @property {boolean} [resetOnWrongKey=true] - If they press the wrong key do we reset the combo?
+ * @property {number} [maxKeyDelay=0] - The max delay in ms between each key press. Above this the combo is reset. 0 means disabled.
+ * @property {boolean} [resetOnMatch=false] - If previously matched and they press the first key of the combo again, will it reset?
+ * @property {boolean} [deleteOnMatch=false] - If the combo matches, will it delete itself?
  */
 
 /**
  * @classdesc
- * [description]
+ * A KeyCombo will listen for a specific string of keys from the Keyboard, and when it receives them
+ * it will emit a `keycombomatch` event from the Keyboard Manager.
  *
- * `keys` argument can be:
+ * The keys to be listened for can be defined as:
  *
- * A string (ATARI)
+ * A string (i.e. 'ATARI')
  * An array of either integers (key codes) or strings, or a mixture of both
  * An array of objects (such as Key objects) with a public 'keyCode' property
  *
+ * For example, to listen for the Konami code (up, up, up, down, down, down, left, left, left, right, right, right)
+ * you could pass the following array of key codes:
+ *
+ * ```javascript
+ * this.input.keyboard.createCombo([ 38, 38, 38, 40, 40, 40, 37, 37, 37, 39, 39, 39 ], { resetOnMatch: true });
+ *
+ * this.input.keyboard.on('keycombomatch', function (event) {
+ *     console.log('Konami Code entered!');
+ * });
+ * ```
+ *
+ * Or, to listen for the user entering the word PHASER:
+ *
+ * ```javascript
+ * this.input.keyboard.createCombo('PHASER');
+ * ```
+ *
  * @class KeyCombo
  * @memberOf Phaser.Input.Keyboard
  * @constructor
  * @since 3.0.0
  *
- * @param {Phaser.Input.Keyboard.KeyboardManager} keyboardManager - [description]
- * @param {(string|integer[]|object[])} keys - [description]
- * @param {KeyComboConfig} [config] - [description]
+ * @param {Phaser.Input.Keyboard.KeyboardManager} keyboardManager - A reference to the Keyboard Manager.
+ * @param {(string|integer[]|object[])} keys - The keys that comprise this combo.
+ * @param {KeyComboConfig} [config] - A Key Combo configuration object.
  */
 var KeyCombo = new Class({
 
@@ -58,7 +76,7 @@ var KeyCombo = new Class({
         }
 
         /**
-         * [description]
+         * A reference to the Keyboard Manager
          *
          * @name Phaser.Input.Keyboard.KeyCombo#manager
          * @type {Phaser.Input.Keyboard.KeyboardManager}
@@ -67,7 +85,7 @@ var KeyCombo = new Class({
         this.manager = keyboardManager;
 
         /**
-         * [description]
+         * A flag that controls if this Key Combo is actively processing keys or not.
          *
          * @name Phaser.Input.Keyboard.KeyCombo#enabled
          * @type {boolean}
@@ -77,7 +95,7 @@ var KeyCombo = new Class({
         this.enabled = true;
 
         /**
-         * [description]
+         * An array of the keycodes that comprise this combo.
          *
          * @name Phaser.Input.Keyboard.KeyCombo#keyCodes
          * @type {array}
@@ -119,7 +137,7 @@ var KeyCombo = new Class({
          * The current index of the key being waited for in the 'keys' string.
          *
          * @name Phaser.Input.Keyboard.KeyCombo#index
-         * @type {number}
+         * @type {integer}
          * @default 0
          * @since 3.0.0
          */
@@ -185,7 +203,7 @@ var KeyCombo = new Class({
         this.maxKeyDelay = GetFastValue(config, 'maxKeyDelay', 0);
 
         /**
-         * If previously matched and they press Key 1 again, will it reset?
+         * If previously matched and they press the first key of the combo again, will it reset?
          *
          * @name Phaser.Input.Keyboard.KeyCombo#resetOnMatch
          * @type {boolean}
@@ -231,9 +249,10 @@ var KeyCombo = new Class({
         };
 
         /**
-         * [description]
+         * The internal Key Down handler.
          *
          * @name Phaser.Input.Keyboard.KeyCombo#onKeyDown
+         * @private
          * @type {KeyboardKeydownCallback}
          * @since 3.0.0
          */
@@ -260,7 +279,7 @@ var KeyCombo = new Class({
     },
 
     /**
-     * [description]
+     * Destroys this Key Combo and all of its references.
      *
      * @method Phaser.Input.Keyboard.KeyCombo#destroy
      * @since 3.0.0
@@ -271,7 +290,8 @@ var KeyCombo = new Class({
         this.keyCodes = [];
 
         this.manager.off('keydown', this.onKeyDown);
-        this.manager = undefined;
+
+        this.manager = null;
     }
 
 });

src/input/keyboard/combo/KeyCombo.js

@@ -10,12 +10,13 @@ var AdvanceKeyCombo = require('./AdvanceKeyCombo');
  * Used internally by the KeyCombo class.
  *
  * @function Phaser.Input.Keyboard.KeyCombo.ProcessKeyCombo
+ * @private
  * @since 3.0.0
  *
- * @param {KeyboardEvent} event - [description]
- * @param {Phaser.Input.Keyboard.KeyCombo} combo - [description]
+ * @param {KeyboardEvent} event - The native Keyboard Event.
+ * @param {Phaser.Input.Keyboard.KeyCombo} combo - The KeyCombo object to be processed.
  *
- * @return {boolean} [description]
+ * @return {boolean} `true` if the combo was matched, otherwise `false`.
  */
 var ProcessKeyCombo = function (event, combo)
 {

src/input/keyboard/combo/ProcessKeyCombo.js

@@ -8,6 +8,7 @@
  * Used internally by the KeyCombo class.
  *
  * @function Phaser.Input.Keyboard.KeyCombo.ResetKeyCombo
+ * @private
  * @since 3.0.0
  *
  * @param {Phaser.Input.Keyboard.KeyCombo} combo - The KeyCombo to reset.

src/input/keyboard/combo/ResetKeyCombo.js

@@ -11,10 +11,10 @@
  * @function Phaser.Input.Keyboard.DownDuration
  * @since 3.0.0
  *
- * @param {Phaser.Input.Keyboard.Key} key - [description]
- * @param {integer} [duration=50] - [description]
+ * @param {Phaser.Input.Keyboard.Key} key - The Key object to test.
+ * @param {integer} [duration=50] - The duration, in ms, within which the key must have been pressed down.
  *
- * @return {boolean} [description]
+ * @return {boolean} `true` if the Key was pressed down within `duration` ms, otherwise `false`.
  */
 var DownDuration = function (key, duration)
 {

src/input/keyboard/keys/DownDuration.js

@@ -6,16 +6,18 @@
 
 /**
  * The justDown value allows you to test if this Key has just been pressed down or not.
+ * 
  * When you check this value it will return `true` if the Key is down, otherwise `false`.
+ * 
  * You can only call justDown once per key press. It will only return `true` once, until the Key is released and pressed down again.
- * This allows you to use it in situations where you want to check if this key is down without using a Signal, such as in a core game loop.
+ * This allows you to use it in situations where you want to check if this key is down without using an event, such as in a core game loop.
  *
  * @function Phaser.Input.Keyboard.JustDown
  * @since 3.0.0
  *
- * @param {Phaser.Input.Keyboard.Key} key - [description]
+ * @param {Phaser.Input.Keyboard.Key} key - The Key to check to see if it's just down or not.
  *
- * @return {boolean} [description]
+ * @return {boolean} `true` if the Key was just pressed, otherwise `false`.
  */
 var JustDown = function (key)
 {

src/input/keyboard/keys/JustDown.js

@@ -6,16 +6,18 @@
 
 /**
  * The justUp value allows you to test if this Key has just been released or not.
+ * 
  * When you check this value it will return `true` if the Key is up, otherwise `false`.
- * You can only call justUp once per key release. It will only return `true` once, until the Key is pressed down and released again.
- * This allows you to use it in situations where you want to check if this key is up without using a Signal, such as in a core game loop.
+ * 
+ * You can only call JustUp once per key release. It will only return `true` once, until the Key is pressed down and released again.
+ * This allows you to use it in situations where you want to check if this key is up without using an event, such as in a core game loop.
  *
  * @function Phaser.Input.Keyboard.JustUp
  * @since 3.0.0
  *
- * @param {Phaser.Input.Keyboard.Key} key - [description]
+ * @param {Phaser.Input.Keyboard.Key} key - The Key to check to see if it's just up or not.
  *
- * @return {boolean} [description]
+ * @return {boolean} `true` if the Key was just released, otherwise `false`.
  */
 var JustUp = function (key)
 {

src/input/keyboard/keys/JustUp.js

@@ -8,12 +8,13 @@
  * Used internally by the KeyboardManager.
  *
  * @function Phaser.Input.Keyboard.ProcessKeyDown
+ * @private
  * @since 3.0.0
  *
- * @param {Phaser.Input.Keyboard.Key} key - [description]
- * @param {KeyboardEvent} event - [description]
+ * @param {Phaser.Input.Keyboard.Key} key - The Key to process the event for.
+ * @param {KeyboardEvent} event - The native Keyboard event.
  *
- * @return {Phaser.Input.Keyboard.Key} [description]
+ * @return {Phaser.Input.Keyboard.Key} The Key that was processed.
  */
 var ProcessKeyDown = function (key, event)
 {

src/input/keyboard/keys/ProcessKeyDown.js

@@ -8,12 +8,13 @@
  * Used internally by the KeyboardManager.
  *
  * @function Phaser.Input.Keyboard.ProcessKeyUp
+ * @private
  * @since 3.0.0
  *
- * @param {Phaser.Input.Keyboard.Key} key - [description]
- * @param {KeyboardEvent} event - [description]
+ * @param {Phaser.Input.Keyboard.Key} key - The Key to process the event for.
+ * @param {KeyboardEvent} event - The native Keyboard event.
  *
- * @return {Phaser.Input.Keyboard.Key} [description]
+ * @return {Phaser.Input.Keyboard.Key} The Key that was processed.
  */
 var ProcessKeyUp = function (key, event)
 {