Merge branch 'master' of https://github.com/photonstorm/phaser

Author: photonstorm

src/gameobjects/particles/ParticleEmitterManager.js

@@ -28,8 +28,8 @@ var Render = require('./ParticleManagerRender');
  *
  * @param {Phaser.Scene} scene - The Scene to which this Emitter Manager belongs.
  * @param {string} texture - The key of the Texture this Emitter Manager will use to render particles, as stored in the Texture Manager.
- * @param {(string|integer)} frame - An optional frame from the Texture this Emitter Manager will use to render particles.
- * @param {ParticleEmitterConfig|ParticleEmitterConfig[]} emitters - Configuration settings for one or more emitters to create.
+ * @param {(string|integer)} [frame] - An optional frame from the Texture this Emitter Manager will use to render particles.
+ * @param {ParticleEmitterConfig|ParticleEmitterConfig[]} [emitters] - Configuration settings for one or more emitters to create.
  */
 var ParticleEmitterManager = new Class({
 
@@ -50,7 +50,7 @@ var ParticleEmitterManager = new Class({
         GameObject.call(this, scene, 'ParticleEmitterManager');
 
         /**
-         * [description]
+         * The blend mode applied to all emitters and particles.
          *
          * @name Phaser.GameObjects.Particles.ParticleEmitterManager#blendMode
          * @type {integer}
@@ -66,7 +66,7 @@ var ParticleEmitterManager = new Class({
          * This is multiplied with any timeScale set on each individual emitter.
          *
          * @name Phaser.GameObjects.Particles.ParticleEmitterManager#timeScale
-         * @type {float}
+         * @type {number}
          * @default 1
          * @since 3.0.0
          */
@@ -255,7 +255,7 @@ var ParticleEmitterManager = new Class({
      * @method Phaser.GameObjects.Particles.ParticleEmitterManager#createEmitter
      * @since 3.0.0
      *
-     * @param {object} config - [description]
+     * @param {ParticleEmitterConfig} config - Configuration settings for the Particle Emitter to create.
      *
      * @return {Phaser.GameObjects.Particles.ParticleEmitter} The Particle Emitter that was created.
      */
@@ -285,7 +285,7 @@ var ParticleEmitterManager = new Class({
      * @method Phaser.GameObjects.Particles.ParticleEmitterManager#createGravityWell
      * @since 3.0.0
      *
-     * @param {object} config - [description]
+     * @param {GravityWellConfig} config - Configuration settings for the Gravity Well to create.
      *
      * @return {Phaser.GameObjects.Particles.GravityWell} The Gravity Well that was created.
      */
@@ -301,8 +301,8 @@ var ParticleEmitterManager = new Class({
      * @since 3.0.0
      *
      * @param {integer} [count] - The number of particles to release from each emitter. The default is the emitter's own {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity}.
-     * @param {float} [x] - The x-coordinate to to emit particles from. The default is the x-coordinate of the emitter's current location.
-     * @param {float} [y] - The y-coordinate to to emit particles from. The default is the y-coordinate of the emitter's current location.
+     * @param {number} [x] - The x-coordinate to to emit particles from. The default is the x-coordinate of the emitter's current location.
+     * @param {number} [y] - The y-coordinate to to emit particles from. The default is the y-coordinate of the emitter's current location.
      *
      * @return {Phaser.GameObjects.Particles.ParticleEmitterManager} This Emitter Manager.
      */
@@ -329,8 +329,8 @@ var ParticleEmitterManager = new Class({
      * @method Phaser.GameObjects.Particles.ParticleEmitterManager#emitParticleAt
      * @since 3.0.0
      *
-     * @param {float} [x] - The x-coordinate to to emit particles from. The default is the x-coordinate of the emitter's current location.
-     * @param {float} [y] - The y-coordinate to to emit particles from. The default is the y-coordinate of the emitter's current location.
+     * @param {number} [x] - The x-coordinate to to emit particles from. The default is the x-coordinate of the emitter's current location.
+     * @param {number} [y] - The y-coordinate to to emit particles from. The default is the y-coordinate of the emitter's current location.
      * @param {integer} [count] - The number of particles to release from each emitter. The default is the emitter's own {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity}.
      *
      * @return {Phaser.GameObjects.Particles.ParticleEmitterManager} This Emitter Manager.
@@ -394,7 +394,7 @@ var ParticleEmitterManager = new Class({
      * @since 3.0.0
      *
      * @param {integer} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.
-     * @param {float} delta - The delta time, in ms, elapsed since the last frame.
+     * @param {number} delta - The delta time, in ms, elapsed since the last frame.
      */
     preUpdate: function (time, delta)
     {

src/gameobjects/particles/ParticleManagerFactory.js

@@ -16,8 +16,8 @@ var ParticleEmitterManager = require('./ParticleEmitterManager');
  * @since 3.0.0
  *
  * @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
- * @param {(string|integer|object)} [frame] - [description]
- * @param {object} [emitters] - [description]
+ * @param {(string|integer|object)} [frame] - An optional frame from the Texture this Game Object is rendering with.
+ * @param {ParticleEmitterConfig|ParticleEmitterConfig[]} [emitters] - Configuration settings for one or more emitters to create.
  *
  * @return {Phaser.GameObjects.Particles.ParticleEmitterManager} The Game Object that was created.
  */

src/gameobjects/particles/zones/DeathZone.js

@@ -9,8 +9,8 @@ var Class = require('../../../utils/Class');
 /**
  * @callback DeathZoneSourceCallback
  *
- * @param {float} x - [description]
- * @param {float} y - [description]
+ * @param {number} x - The x coordinate of the particle to check against this source area.
+ * @param {number} y - The y coordinate of the particle to check against this source area.
  *
  * @return {boolean} - True if the coordinates are within the source area.
  */

src/gameobjects/pathfollower/PathFollower.js

@@ -43,7 +43,7 @@ var Vector2 = require('../../math/Vector2');
  * @constructor
  * @since 3.0.0
  *
- * @param {Phaser.Scene} scene - [description]
+ * @param {Phaser.Scene} scene - The Scene to which this PathFollower belongs.
  * @param {Phaser.Curves.Path} path - The Path this PathFollower is following. It can only follow one Path at a time.
  * @param {number} x - The horizontal position of this Game Object in the world.
  * @param {number} y - The vertical position of this Game Object in the world.

src/gameobjects/sprite3d/Sprite3D.js

@@ -41,7 +41,7 @@ var Sprite3D = new Class({
         GameObject.call(this, scene, 'Sprite3D');
 
         /**
-         * [description]
+         * The encapsulated Sprite.
          *
          * @name Phaser.GameObjects.Sprite3D#gameObject
          * @type {Phaser.GameObjects.GameObject}
@@ -50,7 +50,7 @@ var Sprite3D = new Class({
         this.gameObject = new Sprite(scene, 0, 0, texture, frame);
 
         /**
-         * [description]
+         * The position of the Sprite.
          *
          * @name Phaser.GameObjects.Sprite3D#position
          * @type {Phaser.Math.Vector4}
@@ -59,7 +59,7 @@ var Sprite3D = new Class({
         this.position = new Vector4(x, y, z);
 
         /**
-         * [description]
+         * The 2D size of the Sprite.
          *
          * @name Phaser.GameObjects.Sprite3D#size
          * @type {Phaser.Math.Vector2}
@@ -68,7 +68,7 @@ var Sprite3D = new Class({
         this.size = new Vector2(this.gameObject.width, this.gameObject.height);
 
         /**
-         * [description]
+         * The 2D scale of the Sprite.
          *
          * @name Phaser.GameObjects.Sprite3D#scale
          * @type {Phaser.Math.Vector2}
@@ -77,7 +77,7 @@ var Sprite3D = new Class({
         this.scale = new Vector2(1, 1);
 
         /**
-         * [description]
+         * Whether to automatically set the horizontal scale of the encapsulated Sprite.
          *
          * @name Phaser.GameObjects.Sprite3D#adjustScaleX
          * @type {boolean}
@@ -87,7 +87,7 @@ var Sprite3D = new Class({
         this.adjustScaleX = true;
 
         /**
-         * [description]
+         * Whether to automatically set the vertical scale of the encapsulated Sprite.
          *
          * @name Phaser.GameObjects.Sprite3D#adjustScaleY
          * @type {boolean}
@@ -97,7 +97,7 @@ var Sprite3D = new Class({
         this.adjustScaleY = true;
 
         /**
-         * [description]
+         * The visible state of the Game Object.
          *
          * @name Phaser.GameObjects.Sprite3D#_visible
          * @type {boolean}
@@ -109,7 +109,7 @@ var Sprite3D = new Class({
     },
 
     /**
-     * [description]
+     * Project this Sprite onto the given 3D Camera.
      *
      * @method Phaser.GameObjects.Sprite3D#project
      * @since 3.0.0
@@ -152,12 +152,12 @@ var Sprite3D = new Class({
     },
 
     /**
-     * [description]
+     * Set the visible state of the Game Object.
      *
      * @method Phaser.GameObjects.Sprite3D#setVisible
      * @since 3.0.0
      *
-     * @param {boolean} value - [description]
+     * @param {boolean} value - The visible state of the Game Object.
      *
      * @return {Phaser.GameObjects.Sprite3D} This Sprite3D Object.
      */

src/gameobjects/text/GetTextSize.js

@@ -10,9 +10,9 @@
  * @function Phaser.GameObjects.Text.GetTextSize
  * @since 3.0.0
  *
- * @param {Phaser.GameObjects.Text} text - The Text object to get the size from.
- * @param {number} size - [description]
- * @param {array} lines - [description]
+ * @param {Phaser.GameObjects.Text} text - The Text object to calculate the size from.
+ * @param {TextMetrics} size - The Text metrics to use when calculating the size.
+ * @param {array} lines - The lines of text to calculate the size from.
  *
  * @return {object} An object containing dimensions of the Text object.
  */
@@ -25,7 +25,7 @@ var GetTextSize = function (text, size, lines)
     var lineWidths = [];
     var maxLineWidth = 0;
     var drawnLines = lines.length;
-    
+
     if (style.maxLines > 0 && style.maxLines < lines.length)
     {
         drawnLines = style.maxLines;

src/gameobjects/text/TextStyle.js

@@ -50,6 +50,16 @@ var propertyMap = {
     wordWrapUseAdvanced: [ 'wordWrap.useAdvancedWrap', false ]
 };
 
+/**
+ * Font metrics for a Text Style object.
+ *
+ * @typedef {object} TextMetrics
+ *
+ * @property {number} ascent - The ascent of the font.
+ * @property {number} descent - The descent of the font.
+ * @property {number} fontSize - The size of the font.
+ */
+
 /**
  * @classdesc
  * Style settings for a Text object.
@@ -60,7 +70,7 @@ var propertyMap = {
  * @since 3.0.0
  *
  * @param {Phaser.GameObjects.Text} text - The Text object that this TextStyle is styling.
- * @param {CSSStyleRule} style - The style settings to set.
+ * @param {object} style - The style settings to set.
  */
 var TextStyle = new Class({
 
@@ -919,7 +929,7 @@ var TextStyle = new Class({
      * @method Phaser.GameObjects.Text.TextStyle#getTextMetrics
      * @since 3.0.0
      *
-     * @return {object} The text metrics.
+     * @return {TextMetrics} The text metrics.
      */
     getTextMetrics: function ()
     {

src/gameobjects/tilesprite/TileSprite.js

@@ -14,6 +14,11 @@ var TileSpriteRender = require('./TileSpriteRender');
 
 /**
  * @classdesc
+ * A TileSprite is a Sprite that has a repeating texture.
+ *
+ * The texture can be scrolled and scaled independently of the TileSprite itself. Textures will automatically wrap and
+ * are designed so that you can create game backdrops using seamless textures as a source.
+ *
  * [description]
  *
  * @class TileSprite
@@ -153,7 +158,7 @@ var TileSprite = new Class({
         this.potHeight = GetPowerOfTwo(this.frame.height);
 
         /**
-         * [description]
+         * The Canvas Pattern used to repeat the TileSprite's texture.
          *
          * @name Phaser.GameObjects.TileSprite#canvasPattern
          * @type {?CanvasPattern}
@@ -163,7 +168,7 @@ var TileSprite = new Class({
         this.canvasPattern = null;
 
         /**
-         * [description]
+         * The Canvas that the TileSprite's texture is rendered to.
          *
          * @name Phaser.GameObjects.TileSprite#canvasBuffer
          * @type {HTMLCanvasElement}
@@ -172,7 +177,7 @@ var TileSprite = new Class({
         this.canvasBuffer = CanvasPool.create2D(this, this.potWidth, this.potHeight);
 
         /**
-         * [description]
+         * The Canvas Context used to render the TileSprite's texture.
          *
          * @name Phaser.GameObjects.TileSprite#canvasBufferCtx
          * @type {CanvasRenderingContext2D}

src/gameobjects/zone/Zone.js

@@ -41,7 +41,7 @@ var RectangleContains = require('../../geom/rectangle/Contains');
  * @extends Phaser.GameObjects.Components.ScrollFactor
  * @extends Phaser.GameObjects.Components.Visible
  *
- * @param {Phaser.Scene} scene - [description]
+ * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.
  * @param {number} x - The horizontal position of this Game Object in the world.
  * @param {number} y - The vertical position of this Game Object in the world.
  * @param {number} [width=1] - The width of the Game Object.

src/gameobjects/zone/ZoneCreator.js

@@ -16,7 +16,7 @@ var Zone = require('./Zone');
  * @method Phaser.GameObjects.GameObjectCreator#zone
  * @since 3.0.0
  *
- * @param {object} config - [description]
+ * @param {object} config - The configuration object this Game Object will use to create itself.
  *
  * @return {Phaser.GameObjects.Zone} The Game Object that was created.
  */