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

Author: photonstorm

src/gameobjects/UpdateList.js

@@ -231,7 +231,7 @@ var UpdateList = new Class({
      * @method Phaser.GameObjects.UpdateList#removeAll
      * @since 3.0.0
      *
-     * @return {Phaser.GameObjects.UpdateList} The UpdateList object.
+     * @return {Phaser.GameObjects.UpdateList} This UpdateList.
      */
     removeAll: function ()
     {
@@ -285,7 +285,7 @@ var UpdateList = new Class({
     },
 
     /**
-     * [description]
+     * The length of the list.
      *
      * @name Phaser.GameObjects.UpdateList#length
      * @type {integer}

src/gameobjects/bitmaptext/GetBitmapTextSize.js

@@ -7,20 +7,24 @@
 /**
  * @typedef {object} BitmapTextSize
  *
- * @property {GlobalBitmapTextSize} global - The position and size of the BitmapText, taking into consideration the position and scale of the Game Object.
- * @property {LocalBitmapTextSize} local - The position and size of the BitmapText, taking just the font size into consideration.
+ * @property {GlobalBitmapTextSize} global - The position and size of the BitmapText, taking into account the position and scale of the Game Object.
+ * @property {LocalBitmapTextSize} local - The position and size of the BitmapText, taking just the font size into account.
  */
 
 /**
+ * The position and size of the Bitmap Text in global space, taking into account the Game Object's scale and world position.
+ *
  * @typedef {object} GlobalBitmapTextSize
  *
- * @property {number} x - The x position of the BitmapText, taking into consideration the x coordinate of the Game Object.
- * @property {number} y - The y position of the BitmapText, taking into consideration the y coordinate of the Game Object.
- * @property {number} width - The width of the BitmapText, taking into consideration the x scale of the Game Object.
- * @property {number} width - The height of the BitmapText, taking into consideration the y scale of the Game Object.
+ * @property {number} x - The x position of the BitmapText, taking into account the x position and scale of the Game Object.
+ * @property {number} y - The y position of the BitmapText, taking into account the y position and scale of the Game Object.
+ * @property {number} width - The width of the BitmapText, taking into account the x scale of the Game Object.
+ * @property {number} width - The height of the BitmapText, taking into account the y scale of the Game Object.
  */
 
 /**
+ * The position and size of the Bitmap Text in local space, taking just the font size into account.
+ *
  * @typedef {object} LocalBitmapTextSize
  *
  * @property {number} x - The x position of the BitmapText.
@@ -35,16 +39,16 @@
  * Returns a BitmapTextSize object that contains global and local variants of the Game Objects x and y coordinates and
  * its width and height.
  *
- * The global position and size take into consideration the Game Object's position and scale.
+ * The global position and size take into account the Game Object's position and scale.
  *
- * The local position and size just takes into consideration the font data.
+ * The local position and size just takes into account the font data.
  *
  * @function GetBitmapTextSize
  * @since 3.0.0
  * @private
  *
  * @param {(Phaser.GameObjects.DynamicBitmapText|Phaser.GameObjects.BitmapText)} src - The BitmapText to calculate the position, width and height of.
- * @param {boolean} round - Whether to round the results to the nearest integer.
+ * @param {boolean} [round] - Whether to round the results to the nearest integer.
  *
  * @return {BitmapTextSize} The calculated position, width and height of the BitmapText.
  */

src/gameobjects/bitmaptext/ParseFromAtlas.js

@@ -9,6 +9,8 @@ var ParseXMLBitmapFont = require('./ParseXMLBitmapFont');
 /**
  * Parse an XML Bitmap Font from an Atlas.
  *
+ * Adds the parsed Bitmap Font data to the cache with the `fontName` key.
+ *
  * @function ParseFromAtlas
  * @since 3.0.0
  * @private
@@ -20,6 +22,8 @@ var ParseXMLBitmapFont = require('./ParseXMLBitmapFont');
  * @param {string} xmlKey - The key of the XML data of the font to parse.
  * @param {integer} xSpacing - The x-axis spacing to add between each letter.
  * @param {integer} ySpacing - The y-axis spacing to add to the line height.
+ *
+ * @return {boolean} Whether the parsing was successful or not.
  */
 var ParseFromAtlas = function (scene, fontName, textureKey, frameKey, xmlKey, xSpacing, ySpacing)
 {

src/gameobjects/bitmaptext/ParseRetroFont.js

@@ -15,6 +15,8 @@ var GetValue = require('../../utils/object/GetValue');
  *
  * @param {Phaser.Scene} scene - A reference to the Phaser Scene.
  * @param {Phaser.GameObjects.RetroFont.Config} config - The font configuration object.
+ *
+ * @return {object} A parsed Bitmap Font data entry for the Bitmap Font cache.
  */
 var ParseRetroFont = function (scene, config)
 {

src/gameobjects/bitmaptext/ParseXMLBitmapFont.js

@@ -5,16 +5,25 @@
  */
 
 /**
+ * Read an integer value from an XML Node.
+ *
  * @function getValue
  * @since 3.0.0
  * @private
+ *
+ * @param {Node} node - The XML Node.
+ * @param {string} attribute - The attribute to read.
+ *
+ * @return {integer} The parsed value.
  */
 function getValue (node, attribute)
 {
     return parseInt(node.getAttribute(attribute), 10);
 }
 
 /**
+ * Parse an XML font to Bitmap Font data for the Bitmap Font cache.
+ *
  * @function ParseXMLBitmapFont
  * @since 3.0.0
  * @private
@@ -23,6 +32,8 @@ function getValue (node, attribute)
  * @param {integer} [xSpacing=0] - The x-axis spacing to add between each letter.
  * @param {integer} [ySpacing=0] - The y-axis spacing to add to the line height.
  * @param {Phaser.Textures.Frame} [frame] - The texture frame to take into account while parsing.
+ *
+ * @return {BitmapFontData} The parsed Bitmap Font data.
  */
 var ParseXMLBitmapFont = function (xml, xSpacing, ySpacing, frame)
 {

src/gameobjects/bitmaptext/RetroFont.js

@@ -10,7 +10,7 @@ var Extend = require('../../utils/object/Extend');
 /**
  * @typedef {object} Phaser.GameObjects.RetroFont.Config
  * 
- * @property {string} image - [description]
+ * @property {string} image - The key of the image containing the font.
  * @property {number} offset.x - If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.
  * @property {number} offset.y - If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.
  * @property {number} width - The width of each character in the font set.