Merge branch 'pr/3439'

Author: photonstorm

src/actions/Call.js

@@ -18,7 +18,7 @@
  *
  * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
  * @param {CallCallback} callback - The callback to be invoked. It will be passed just one argument: the item from the array.
- * @param {object} context - The scope in which the callback will be invoked.
+ * @param {*} context - The scope in which the callback will be invoked.
  *
  * @return {array} The array of objects that was passed to this Action.
  */

src/actions/GetFirst.js

@@ -18,7 +18,7 @@
  * @param {object} compare - The comparison object. Each property in this object will be checked against the items of the array.
  * @param {integer} [index=0] - An optional offset to start searching from within the items array.
  *
- * @return {object} The first object in the array that matches the comparison object, or `null` if no match was found.
+ * @return {?(object|Phaser.GameObjects.GameObject)} The first object in the array that matches the comparison object, or `null` if no match was found.
  */
 var GetFirst = function (items, compare, index)
 {

src/actions/GetLast.js

@@ -18,7 +18,7 @@
  * @param {object} compare - The comparison object. Each property in this object will be checked against the items of the array.
  * @param {integer} [index=0] - An optional offset to start searching from within the items array.
  *
- * @return {object} The last object in the array that matches the comparison object, or `null` if no match was found.
+ * @return {?(object|Phaser.GameObjects.GameObject)} The last object in the array that matches the comparison object, or `null` if no match was found.
  */
 var GetLast = function (items, compare, index)
 {

src/cameras/2d/Camera.js

@@ -25,7 +25,11 @@ var Vector2 = require('../../math/Vector2');
  * @property {number} scrollX - The horizontal scroll of camera
  * @property {number} scrollY - The vertical scroll of camera
  * @property {string} backgroundColor - The background color of camera
- * @property {object} [bounds] - The bounds of camera // TODO 19/03/2018 Create BoundsObject ({x:number,y:number,width:number,height:number})
+ * @property {object} [bounds] - The bounds of camera
+ * @property {number} [bounds.x] - The horizontal position of bounds of camera
+ * @property {number} [bounds.y] - The vertical position of bounds of camera
+ * @property {number} [bounds.width] - The width of the bounds of camera
+ * @property {number} [bounds.height] - The height of the bounds of camera
  */
 
 /**

src/cameras/sprite3d/Camera.js

@@ -24,6 +24,13 @@ var billboardMatrix = new Matrix4();
 
 //  @author attribute https://github.com/mattdesl/cam3d/wiki
 
+/**
+ * @typedef {object} RayDef
+ *
+ * @property {Phaser.Math.Vector3} origin - [description]
+ * @property {Phaser.Math.Vector3} direction - [description]
+ */
+
 /**
  * @classdesc
  * [description]
@@ -174,13 +181,6 @@ var Camera = new Class({
          */
         this.far = 100;
 
-        /**
-         * @typedef {object} RayDef
-         *
-         * @property {Phaser.Math.Vector3} origin - [description]
-         * @property {Phaser.Math.Vector3} direction - [description]
-         */
-
         /**
          * [description]
          *

src/gameobjects/BuildGameObject.js

@@ -8,6 +8,26 @@ var BlendModes = require('../renderer/BlendModes');
 var GetAdvancedValue = require('../utils/object/GetAdvancedValue');
 var ScaleModes = require('../renderer/ScaleModes');
 
+/**
+ * @typedef {object} GameObjectConfig
+ *
+ * @property {number} [x=0] - [description]
+ * @property {number} [y=0] - [description]
+ * @property {number} [depth=0] - [description]
+ * @property {boolean} [flipX=false] - [description]
+ * @property {boolean} [flipY=false] - [description]
+ * @property {?(number|object)} [scale=null] - [description]
+ * @property {?(number|object)} [scrollFactor=null] - [description]
+ * @property {number} [rotation=0] - [description]
+ * @property {?number} [angle=null] - [description]
+ * @property {number} [alpha=1] - [description]
+ * @property {?(number|object)} [origin=null] - [description]
+ * @property {number} [scaleMode=ScaleModes.DEFAULT] - [description]
+ * @property {number} [blendMode=BlendModes.DEFAULT] - [description]
+ * @property {boolean} [visible=true] - [description]
+ * @property {boolean} [add=true] - [description]
+ */
+
 /**
  * Builds a Game Object using the provided configuration object.
  *
@@ -16,7 +36,7 @@ var ScaleModes = require('../renderer/ScaleModes');
  *
  * @param {Phaser.Scene} scene - [description]
  * @param {Phaser.GameObjects.GameObject} gameObject - [description]
- * @param {object} config - [description]
+ * @param {GameObjectConfig} config - [description]
  *
  * @return {Phaser.GameObjects.GameObject} The built Game Object.
  */

src/gameobjects/bitmaptext/dynamic/DynamicBitmapText.js

@@ -125,7 +125,7 @@ var DynamicBitmapText = new Class({
          * [description]
          *
          * @name Phaser.GameObjects.DynamicBitmapText#_bounds
-         * @type {object}
+         * @type {TextBounds}
          * @private
          * @since 3.0.0
          */
@@ -360,7 +360,7 @@ var DynamicBitmapText = new Class({
      * @method Phaser.GameObjects.DynamicBitmapText#toJSON
      * @since 3.0.0
      *
-     * @return {object} [description]
+     * @return {JSONGameObject.<JSONBitmapText>} [description]
      */
     toJSON: function ()
     {

src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextCreator.js

@@ -9,15 +9,25 @@ var BuildGameObject = require('../../BuildGameObject');
 var GameObjectCreator = require('../../GameObjectCreator');
 var GetAdvancedValue = require('../../../utils/object/GetAdvancedValue');
 
+/**
+ * @typedef {object} BitmapTextConfig
+ * @extends GameObjectConfig
+ *
+ * @property {string} [font=''] - [description]
+ * @property {string} [text=''] - [description]
+ * @property {(number|false)} [size=false] - [description]
+ * @property {string} [align=''] - [description]
+ */
+
 /**
  * Creates a new Dynamic Bitmap Text Game Object and returns it.
  *
  * Note: This method will only be available if the Dynamic Bitmap Text Game Object has been built into Phaser.
  *
  * @method Phaser.GameObjects.GameObjectCreator#dynamicBitmapText
  * @since 3.0.0
- *
- * @param {object} config - [description]
+ *²
+ * @param {BitmapTextConfig} config - [description]
  *
  * @return {Phaser.GameObjects.DynamicBitmapText} The Game Object that was created.
  */

src/gameobjects/bitmaptext/static/BitmapText.js

@@ -15,16 +15,24 @@ var Render = require('./BitmapTextRender');
 /**
  * @typedef {object} TextBounds
  *
- * @param {object} local - [description]
- * @param {number} local.x - [description]
- * @param {number} local.y - [description]
- * @param {number} local.width - [description]
- * @param {number} local.height - [description]
- * @param {object} global - [description]
- * @param {number} global.x - [description]
- * @param {number} global.y - [description]
- * @param {number} global.width - [description]
- * @param {number} global.height - [description]
+ * @property {object} local - [description]
+ * @property {number} local.x - [description]
+ * @property {number} local.y - [description]
+ * @property {number} local.width - [description]
+ * @property {number} local.height - [description]
+ * @property {object} global - [description]
+ * @property {number} global.x - [description]
+ * @property {number} global.y - [description]
+ * @property {number} global.width - [description]
+ * @property {number} global.height - [description]
+ */
+
+/**
+ * @typedef {object} JSONBitmapText
+ *
+ * @property {string} font - [description]
+ * @property {string} text - [description]
+ * @property {number} fontSize - [description]
  */
 
 /**
@@ -130,7 +138,7 @@ var BitmapText = new Class({
          * [description]
          *
          * @name Phaser.GameObjects.BitmapText#_bounds
-         * @type {object}
+         * @type {TextBounds}
          * @private
          * @since 3.0.0
          */
@@ -248,7 +256,7 @@ var BitmapText = new Class({
      * @method Phaser.GameObjects.BitmapText#toJSON
      * @since 3.0.0
      *
-     * @return {JSONGameObject} [description]
+     * @return {JSONGameObject.<JSONBitmapText>} [description]
      */
     toJSON: function ()
     {

src/gameobjects/bitmaptext/static/BitmapTextCreator.js

@@ -18,7 +18,7 @@ var GetValue = require('../../../utils/object/GetValue');
  * @method Phaser.GameObjects.GameObjectCreator#bitmapText
  * @since 3.0.0
  *
- * @param {object} config - [description]
+ * @param {BitmapTextConfig} config - [description]
  *
  * @return {Phaser.GameObjects.BitmapText} The Game Object that was created.
  */