Input and keyboard docs.

src/input/Key.js

@@ -1,73 +1,92 @@
+/**
+* @author       Richard Davey <rich@photonstorm.com>
+* @copyright    2013 Photon Storm Ltd.
+* @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+*/
+
+/**
+* @class Phaser.Key
+* @classdesc If you need more fine-grained control over the handling of specific keys you can create and use Phaser.Key objects.
+* @constructor
+* @param {Phaser.Game} game - Current game instance.
+* @param {number} keycode - The key code this Key is responsible for.
+*/
 Phaser.Key = function (game, keycode) {
 
+	/**
+	* @property {Phaser.Game} game - A reference to the currently running game. 
+	*/
 	this.game = game;
 
 	/**
-	*
-	* @property isDown
-	* @type Boolean
-	**/
+	* @property {boolean} isDown - The "down" state of the key.
+	* @default
+	*/
 	this.isDown = false;
 
 	/**
-	*
-	* @property isUp
-	* @type Boolean
-	**/
+	* @property {boolean} isUp - The "up" state of the key.
+	* @default
+	*/
 	this.isUp = false;
 
 	/**
-	*
-	* @property altKey
-	* @type Boolean
-	**/
+	* @property {boolean} altKey - The down state of the ALT key, if pressed at the same time as this key.
+	* @default
+	*/
 	this.altKey = false;
 
 	/**
-	*
-	* @property ctrlKey
-	* @type Boolean
-	**/
+	* @property {boolean} ctrlKey - The down state of the CTRL key, if pressed at the same time as this key.
+	* @default
+	*/
 	this.ctrlKey = false;
 
 	/**
-	*
-	* @property shiftKey
-	* @type Boolean
-	**/
+	* @property {boolean} shiftKey - The down state of the SHIFT key, if pressed at the same time as this key.
+	* @default
+	*/
 	this.shiftKey = false;
 
 	/**
-	*
-	* @property timeDown
-	* @type Number
-	**/
+	* @property {number} timeDown - The timestamp when the key was last pressed down.
+	* @default
+	*/
 	this.timeDown = 0;
 
 	/**
-	*
-	* @property duration
-	* @type Number
-	**/
+	* If the key is down this value holds the duration of that key press and is constantly updated.
+	* If the key is up it holds the duration of the previous down session.
+	* @property {number} duration - The number of milliseconds this key has been held down for.
+	* @default
+	*/
 	this.duration = 0;
 
 	/**
-	*
-	* @property timeUp
-	* @type Number
-	**/
+	* @property {number} timeUp - The timestamp when the key was last released.
+	* @default
+	*/
 	this.timeUp = 0;
 
 	/**
-	*
-	* @property repeats
-	* @type Number
-	**/
+	* @property {number} repeats - If a key is held down this holds down the number of times the key has 'repeated'.
+	* @default
+	*/
 	this.repeats = 0;
 
+	/**
+	* @property {number} keyCode - The keycode of this key.
+	*/
 	this.keyCode = keycode;
 
+	/**
+	* @property {Phaser.Signal} onDown - This Signal is dispatched every time this Key is pressed down. It is only dispatched once (until the key is released again).
+	*/
     this.onDown = new Phaser.Signal();
+
+	/**
+	* @property {Phaser.Signal} onUp - This Signal is dispatched every time this Key is pressed down. It is only dispatched once (until the key is released again).
+	*/
     this.onUp = new Phaser.Signal();
 	
 };
@@ -75,10 +94,10 @@ Phaser.Key = function (game, keycode) {
 Phaser.Key.prototype = {
 
 	/**
-    *
-    * @method update
+    * Called automatically by Phaser.Keyboard.
+    * @method Phaser.Key#processKeyDown
     * @param {KeyboardEvent} event.
-    * @return {}
+    * @protected
     */
     processKeyDown: function (event) {
 
@@ -105,6 +124,12 @@ Phaser.Key.prototype = {
 
     },
 
+	/**
+    * Called automatically by Phaser.Keyboard.
+    * @method Phaser.Key#processKeyUp
+    * @param {KeyboardEvent} event.
+    * @protected
+    */
     processKeyUp: function (event) {
 
         this.isDown = false;
@@ -116,8 +141,10 @@ Phaser.Key.prototype = {
     },
 
 	/**
-    * @param {number} [duration]
-    * @return {boolean}
+	* Returns the "just pressed" state of the Key. Just pressed is considered true if the key was pressed down within the duration given (default 250ms)
+    * @method Phaser.Key#justPressed
+    * @param {number} [duration=250] - The duration below which the key is considered as being just pressed.
+    * @return {boolean} True if the key is just pressed otherwise false.
     */
     justPressed: function (duration) {
 
@@ -128,8 +155,10 @@ Phaser.Key.prototype = {
     },
 
 	/**
-    * @param {number} [duration]
-    * @return {boolean}
+	* Returns the "just released" state of the Key. Just released is considered as being true if the key was released within the duration given (default 250ms)
+    * @method Phaser.Key#justPressed
+    * @param {number} [duration=250] - The duration below which the key is considered as being just released.
+    * @return {boolean} True if the key is just released otherwise false.
     */
     justReleased: function (duration) {
 
@@ -139,4 +168,4 @@ Phaser.Key.prototype = {
 
     }
 
-};
+};