Added jsdocs

Author: photonstorm

src/gameobjects/GameObject.js

@@ -30,8 +30,8 @@ var GameObject = new Class({
          * The Scene to which this Game Object belongs.
          * Game Objects can only belong to one Scene.
          *
-         * @property {Phaser.Scene} scene
-         * @alias Phaser.GameObjects.GameObject#scene
+         * @name Phaser.GameObjects.GameObject#scene
+         * @type {Phaser.Scene}
          * @protected
          * @since 3.0.0
          */
@@ -41,8 +41,8 @@ var GameObject = new Class({
          * A textual representation of this Game Object, i.e. `sprite`.
          * Used internally by Phaser but is available for your own custom classes to populate.
          *
-         * @property {string} type
-         * @alias Phaser.GameObjects.GameObject#type
+         * @name Phaser.GameObjects.GameObject#type
+         * @type {string}
          * @since 3.0.0
          */
         this.type = type;
@@ -51,8 +51,9 @@ var GameObject = new Class({
          * The name of this Game Object.
          * Empty by default and never populated by Phaser, this is left for developers to use.
          *
-         * @property {string} [name='']
-         * @alias Phaser.GameObjects.GameObject#name
+         * @name Phaser.GameObjects.GameObject#name
+         * @type {string}
+         * @default ''
          * @since 3.0.0
          */
         this.name = '';
@@ -62,8 +63,9 @@ var GameObject = new Class({
          * A Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.
          * An active object is one which is having its logic and internal systems updated.
          *
-         * @property {boolean} [active=true]
-         * @alias Phaser.GameObjects.GameObject#active
+         * @name Phaser.GameObjects.GameObject#active
+         * @type {boolean}
+         * @default true
          * @since 3.0.0
          */
         this.active = true;
@@ -72,8 +74,9 @@ var GameObject = new Class({
          * The Tab Index of the Game Object.
          * Reserved for future use by plugins and the Input Manager.
          *
-         * @property {integer} [tabIndex=-1]
-         * @alias Phaser.GameObjects.GameObject#tabIndex
+         * @name Phaser.GameObjects.GameObject#tabIndex
+         * @type {integer}
+         * @default -1
          * @since 3.0.0
          */
         this.tabIndex = -1;
@@ -83,8 +86,9 @@ var GameObject = new Class({
          * It allows you to store, query and get key/value paired information specific to this Game Object.
          * `null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.
          *
-         * @property {Phaser.Data.DataManager} data
-         * @alias Phaser.GameObjects.GameObject#data
+         * @name Phaser.GameObjects.GameObject#data
+         * @type {Phaser.Data.DataManager}
+         * @default null
          * @since 3.0.0
          */
         this.data = null;
@@ -94,8 +98,9 @@ var GameObject = new Class({
          * The bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.
          * If those components are not used by your custom class then you can use this bitmask as you wish.
          *
-         * @property {integer} [renderFlags=15]
-         * @alias Phaser.GameObjects.GameObject#renderFlags
+         * @name Phaser.GameObjects.GameObject#renderFlags
+         * @type {integer}
+         * @default 15
          * @since 3.0.0
          */
         this.renderFlags = 15;
@@ -104,8 +109,9 @@ var GameObject = new Class({
          * A bitmask that controls if this Game Object is drawn by a Camera or not.
          * Not usually set directly. Instead call `Camera.ignore`.
          *
-         * @property {number} [cameraFilter=0]
-         * @alias Phaser.GameObjects.GameObject#cameraFilter
+         * @name Phaser.GameObjects.GameObject#cameraFilter
+         * @type {number}
+         * @default 0
          * @since 3.0.0
          */
         this.cameraFilter = 0;
@@ -114,17 +120,19 @@ var GameObject = new Class({
          * If this Game Object is enabled for input then this property will contain an InteractiveObject instance.
          * Not usually set directly. Instead call `GameObject.setInteractive()`.
          *
-         * @property {?Phaser.Input.InteractiveObject} [input=null]
-         * @alias Phaser.GameObjects.GameObject#input
+         * @name Phaser.GameObjects.GameObject#input
+         * @type {?Phaser.Input.InteractiveObject}
+         * @default null
          * @since 3.0.0
          */
         this.input = null;
 
         /**
          * If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.
          *
-         * @property {?Phaser.Physics.Body} [body=null]
-         * @alias Phaser.GameObjects.GameObject#body
+         * @name Phaser.GameObjects.GameObject#body
+         * @type {?Phaser.Physics.Body}
+         * @default null
          * @since 3.0.0
          */
         this.body = null;

src/gameobjects/bitmaptext/dynamic/DynamicBitmapText.js

@@ -1,8 +1,8 @@
 var Class = require('../../../utils/Class');
-var GameObject = require('../../GameObject');
 var Components = require('../../components');
-var Render = require('./DynamicBitmapTextRender');
+var GameObject = require('../../GameObject');
 var GetBitmapTextSize = require('../GetBitmapTextSize');
+var Render = require('./DynamicBitmapTextRender');
 
 var DynamicBitmapText = new Class({
 

src/gameobjects/blitter/Blitter.js

@@ -20,15 +20,15 @@ var GameObject = require('../GameObject');
  * @constructor
  * @since 3.0.0
  *
- * @mixes Phaser.GameObjects.Components.Alpha
+ * Mixins:
+ * @extends Phaser.GameObjects.Components.Alpha
  *
  * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. It can only belong to one Scene at any given time.
  * @param {number} [x==] - The x coordinate of this Game Object in world space.
  * @param {number} [y=0] - The y coordinate of this Game Object in world space.
  * @param {string} [texture='__DEFAULT'] - The key of the texture this Game Object will use for rendering. The Texture must already exist in the Texture Manager.
  * @param {string|integer} [frame=0] - The Frame of the Texture that this Game Object will use. Only set if the Texture has multiple frames, such as a Texture Atlas or Sprite Sheet.
  */
-
 var Blitter = new Class({
 
     Extends: GameObject,
@@ -59,17 +59,17 @@ var Blitter = new Class({
         /**
          * [description]
          *
-         * @property {Phaser.GameObjects.DisplayList} children
-         * @alias Phaser.GameObjects.Blitter#children
+         * @name Phaser.GameObjects.Blitter#children
+         * @type {Phaser.GameObjects.DisplayList}
          * @since 3.0.0
          */
         this.children = new DisplayList();
 
         /**
          * [description]
          *
-         * @property {array} renderList
-         * @alias Phaser.GameObjects.Blitter#renderList
+         * @name Phaser.GameObjects.Blitter#renderList
+         * @type {array}
          * @default []
          * @since 3.0.0
          */

src/gameobjects/components/Alpha.js

@@ -22,7 +22,8 @@ var Alpha = {
     _alphaBR: 1,
 
     /**
-     * [description]
+     * Clears all alpha values associated with this Game Object.
+     * Immediately sets the alpha levels back to 1 (fully opaque)
      *
      * @method Phaser.GameObjects.Components.Alpha.clearAlpha
      * @since 3.0.0
@@ -35,15 +36,19 @@ var Alpha = {
     },
 
     /**
-     * [description]
+     * Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.
+     * Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.
+     *
+     * If your game is running under WebGL you can optionally specify four different alpha values, each of which
+     * correspond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.
      *
      * @method Phaser.GameObjects.Components.Alpha.setAlpha
      * @since 3.0.0
      * 
      * @param {float} [topLeft=1] - The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.
-     * @param {float} [topRight] - The alpha value used for the top-right of the Game Object.
-     * @param {float} [bottomLeft] - The alpha value used for the bottom-left of the Game Object.
-     * @param {float} [bottomRight] - The alpha value used for the bottom-right of the Game Object.
+     * @param {float} [topRight] - The alpha value used for the top-right of the Game Object. WebGL only.
+     * @param {float} [bottomLeft] - The alpha value used for the bottom-left of the Game Object. WebGL only.
+     * @param {float} [bottomRight] - The alpha value used for the bottom-right of the Game Object. WebGL only.
      * 
      * @return {Phaser.GameObjects.GameObject} This Game Object instance.
      */
@@ -71,7 +76,7 @@ var Alpha = {
      * [description]
      * 
      * @name Phaser.GameObjects.Components.Alpha#alpha
-     * @property {float} alpha
+     * @type {float}
      * @since 3.0.0
      */
     alpha: {
@@ -107,7 +112,7 @@ var Alpha = {
      * [description]
      * 
      * @name Phaser.GameObjects.Components.Alpha#alphaTopLeft
-     * @property {float} alphaTopLeft
+     * @type {float}
      * @webglOnly
      * @since 3.0.0
      */
@@ -136,7 +141,7 @@ var Alpha = {
      * [description]
      * 
      * @name Phaser.GameObjects.Components.Alpha#alphaTopRight
-     * @property {float} alphaTopRight
+     * @type {float}
      * @webglOnly
      * @since 3.0.0
      */
@@ -165,7 +170,7 @@ var Alpha = {
      * [description]
      * 
      * @name Phaser.GameObjects.Components.Alpha#alphaBottomLeft
-     * @property {float} alphaBottomLeft
+     * @type {float}
      * @webglOnly
      * @since 3.0.0
      */
@@ -194,7 +199,7 @@ var Alpha = {
      * [description]
      * 
      * @name Phaser.GameObjects.Components.Alpha#alphaBottomRight
-     * @property {float} alphaBottomRight
+     * @type {float}
      * @webglOnly
      * @since 3.0.0
      */

src/gameobjects/components/BlendMode.js

@@ -1,11 +1,25 @@
 var BlendModes = require('../../renderer/BlendModes');
 
-//  BlendMode Component
+/**
+ * Provides methods used for setting the blend mode of a Game Object.
+ * Should be applied as a mixin and not used directly.
+ * 
+ * @name Phaser.GameObjects.Components.BlendMode
+ * @mixin
+ * @since 3.0.0
+ */
 
 var BlendMode = {
 
     _blendMode: BlendModes.NORMAL,
 
+    /**
+     * [description]
+     * 
+     * @name Phaser.GameObjects.Components.BlendMode#blendMode
+     * @type {integer|string}
+     * @since 3.0.0
+     */
     blendMode: {
 
         get: function ()
@@ -30,7 +44,28 @@ var BlendMode = {
 
     },
 
-    //  const or string
+    /**
+     * Sets the Blend Mode being used by this Game Object.
+     * 
+     * This can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)
+     * 
+     * Under WebGL only the following Blend Modes are available:
+     * 
+     * * ADD
+     * * MULTIPLY
+     * * SCREEN
+     *
+     * Canvas has more available depending on browser support.
+     *
+     * You can also create your own custom Blend Modes in WebGL.
+     *
+     * @method Phaser.GameObjects.Components.BlendMode.setBlendMode
+     * @since 3.0.0
+     *
+     * @param {string|integer} value - The BlendMode value. Either a string or a CONST.
+     * 
+     * @return {Phaser.GameObjects.GameObject} This Game Object instance.
+     */
     setBlendMode: function (value)
     {
         this.blendMode = value;

src/gameobjects/components/ComputedSize.js

@@ -1,8 +1,40 @@
+/**
+ * Provides methods used for setting the blend mode of a Game Object.
+ * Should be applied as a mixin and not used directly.
+ * 
+ * @name Phaser.GameObjects.Components.ComputedSize
+ * @mixin
+ * @since 3.0.0
+ */
+
 var ComputedSize = {
 
+    /**
+     * The native (un-scaled) width of this Game Object.
+     * 
+     * @name Phaser.GameObjects.Components.ComputedSize#width
+     * @type {number}
+     * @since 3.0.0
+     */
     width: 0,
+
+    /**
+     * The native (un-scaled) height of this Game Object.
+     * 
+     * @name Phaser.GameObjects.Components.ComputedSize#height
+     * @type {number}
+     * @since 3.0.0
+     */
     height: 0,
 
+    /**
+     * The displayed width of this Game Object.
+     * This value takes into account the scale factor.
+     * 
+     * @name Phaser.GameObjects.Components.ComputedSize#displayWidth
+     * @type {number}
+     * @since 3.0.0
+     */
     displayWidth: {
 
         get: function ()
@@ -17,6 +49,14 @@ var ComputedSize = {
 
     },
 
+    /**
+     * The displayed height of this Game Object.
+     * This value takes into account the scale factor.
+     * 
+     * @name Phaser.GameObjects.Components.ComputedSize#displayHeight
+     * @type {number}
+     * @since 3.0.0
+     */
     displayHeight: {
 
         get: function ()