Updated jsdocs

Author: photonstorm

src/tilemaps/ParseToTilemap.js

@@ -27,7 +27,7 @@ var Tilemap = require('./Tilemap');
  * consumption. However if your map is small or you need to update the tiles dynamically, then leave
  * the default value set.
  * 
- * @returns {Phaser.Tilemaps.Tilemap}
+ * @return {Phaser.Tilemaps.Tilemap}
  */
 var ParseToTilemap = function (scene, key, tileWidth, tileHeight, width, height, data, insertNull)
 {

src/tilemaps/Tile.js

@@ -296,7 +296,7 @@ var Tile = new Class({
      * 
      * @param {Phaser.Tilemaps.Tile} tile - The tile to copy from.
      * 
-     * @returns {Phaser.Tilemaps.Tile} This Tile object.
+     * @return {Phaser.Tilemaps.Tile} This Tile object.
      */
     copy: function (tile)
     {
@@ -325,7 +325,7 @@ var Tile = new Class({
      * @method Phaser.Tilemaps.Tile#getCollisionGroup
      * @since 3.0.0
      * 
-     * @returns {object|null} tileset
+     * @return {object|null} tileset
      */
     getCollisionGroup: function ()
     {
@@ -341,7 +341,7 @@ var Tile = new Class({
      * @method Phaser.Tilemaps.Tile#getTileData
      * @since 3.0.0
      * 
-     * @returns {object|null} tileset
+     * @return {object|null} tileset
      */
     getTileData: function ()
     {
@@ -357,7 +357,7 @@ var Tile = new Class({
      * 
      * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.
      * 
-     * @returns {number}
+     * @return {number}
      */
     getLeft: function (camera)
     {
@@ -375,7 +375,7 @@ var Tile = new Class({
      * 
      * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.
      * 
-     * @returns {number}
+     * @return {number}
      */
     getRight: function (camera)
     {
@@ -393,7 +393,7 @@ var Tile = new Class({
      * 
      * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.
      * 
-     * @returns {number}
+     * @return {number}
      */
     getTop: function (camera)
     {
@@ -416,7 +416,7 @@ var Tile = new Class({
      * 
      * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.
      * 
-     * @returns {number}
+     * @return {number}
      */
     getBottom: function (camera)
     {
@@ -437,7 +437,7 @@ var Tile = new Class({
      * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.
      * @param {object} [output] - [description]
      * 
-     * @returns {Phaser.Geom.Rectangle|object}
+     * @return {Phaser.Geom.Rectangle|object}
      */
     getBounds: function (camera, output)
     {
@@ -460,7 +460,7 @@ var Tile = new Class({
      * 
      * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.
      * 
-     * @returns {number}
+     * @return {number}
      */
     getCenterX: function (camera)
     {
@@ -476,7 +476,7 @@ var Tile = new Class({
      * 
      * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to use to perform the check.
      * 
-     * @returns {number}
+     * @return {number}
      */
     getCenterY: function (camera)
     {
@@ -527,7 +527,7 @@ var Tile = new Class({
      * @param {boolean} collides - If true, will consider the tile interesting if it collides on any side.
      * @param {boolean} faces - If true, will consider the tile interesting if it has an interesting face.
      * 
-     * @returns {boolean} True if the Tile is interesting, otherwise false.
+     * @return {boolean} True if the Tile is interesting, otherwise false.
      */
     isInteresting: function (collides, faces)
     {
@@ -545,7 +545,7 @@ var Tile = new Class({
      * 
      * @param {boolean} [recalculateFaces=true] - Whether or not to recalculate interesting faces for this tile and its neighbors.
      * 
-     * @returns {Phaser.Tilemaps.Tile} This Tile object.
+     * @return {Phaser.Tilemaps.Tile} This Tile object.
      */
     resetCollision: function (recalculateFaces)
     {
@@ -580,7 +580,7 @@ var Tile = new Class({
      * @method Phaser.Tilemaps.Tile#resetFaces
      * @since 3.0.0
      *
-     * @returns {Phaser.Tilemaps.Tile} This Tile object.
+     * @return {Phaser.Tilemaps.Tile} This Tile object.
      */
     resetFaces: function ()
     {
@@ -605,7 +605,7 @@ var Tile = new Class({
      * @param {boolean} [recalculateFaces=true] - Whether or not to recalculate interesting faces
      * for this tile and its neighbors.
      * 
-     * @returns {Phaser.Tilemaps.Tile} This Tile object.
+     * @return {Phaser.Tilemaps.Tile} This Tile object.
      */
     setCollision: function (left, right, up, down, recalculateFaces)
     {
@@ -647,7 +647,7 @@ var Tile = new Class({
      * @param {function} callback - Callback function.
      * @param {object} context - Callback will be called within this context.
      * 
-     * @returns {Phaser.Tilemaps.Tile} This Tile object.
+     * @return {Phaser.Tilemaps.Tile} This Tile object.
      */
     setCollisionCallback: function (callback, context)
     {
@@ -676,7 +676,7 @@ var Tile = new Class({
      * @param {integer} baseWidth - The base width a tile in the map (in pixels).
      * @param {integer} baseHeight - The base height of the tile in pixels (in pixels).
      * 
-     * @returns {Phaser.Tilemaps.Tile} This Tile object.
+     * @return {Phaser.Tilemaps.Tile} This Tile object.
      */
     setSize: function (tileWidth, tileHeight, baseWidth, baseHeight)
     {
@@ -696,7 +696,7 @@ var Tile = new Class({
      * @method Phaser.Tilemaps.Tile#updatePixelXY
      * @since 3.0.0
      *
-     * @returns {Phaser.Tilemaps.Tile} This Tile object.
+     * @return {Phaser.Tilemaps.Tile} This Tile object.
      */
     updatePixelXY: function ()
     {

src/tilemaps/Tilemap.js

@@ -1571,7 +1571,7 @@ var Tilemap = new Class({
      * tile faces. If set to null, interesting tile faces will not be drawn.
      * @param {Phaser.Tilemaps.LayerData} layer - [description]
      *
-     * @returns {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
+     * @return {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
      */
     renderDebug: function (graphics, styleConfig, layer)
     {
@@ -1603,7 +1603,7 @@ var Tilemap = new Class({
      * @param {integer} [height=max height based on tileY] - [description]
      * @param {Phaser.Tilemaps.LayerData} layer - [description]
      *
-     * @returns {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
+     * @return {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
      */
     replaceByIndex: function (findIndex, newIndex, tileX, tileY, width, height, layer)
     {
@@ -1636,7 +1636,7 @@ var Tilemap = new Class({
      * update.
      * @param {Phaser.Tilemaps.LayerData} layer - [description]
      *
-     * @returns {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
+     * @return {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
      */
     setCollision: function (indexes, collides, recalculateFaces, layer)
     {
@@ -1668,7 +1668,7 @@ var Tilemap = new Class({
      * update.
      * @param {Phaser.Tilemaps.LayerData} layer - [description]
      *
-     * @returns {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
+     * @return {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
      */
     setCollisionBetween: function (start, stop, collides, recalculateFaces, layer)
     {
@@ -1703,7 +1703,7 @@ var Tilemap = new Class({
      * update.
      * @param {Phaser.Tilemaps.LayerData} layer - [description]
      *
-     * @returns {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
+     * @return {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
      */
     setCollisionByProperty: function (properties, collides, recalculateFaces, layer)
     {
@@ -1733,7 +1733,7 @@ var Tilemap = new Class({
      * update.
      * @param {Phaser.Tilemaps.LayerData} layer - [description]
      *
-     * @returns {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
+     * @return {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
      */
     setCollisionByExclusion: function (indexes, collides, recalculateFaces, layer)
     {
@@ -1763,7 +1763,7 @@ var Tilemap = new Class({
      * update.
      * @param {Phaser.Tilemaps.LayerData} layer - [description]
      *
-     * @returns {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
+     * @return {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
      */
     setCollisionFromCollisionGroup: function (collides, recalculateFaces, layer)
     {
@@ -1793,7 +1793,7 @@ var Tilemap = new Class({
      * @param {object} callbackContext - The context under which the callback is called.
      * @param {Phaser.Tilemaps.LayerData} layer - [description]
      *
-     * @returns {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
+     * @return {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
      */
     setTileIndexCallback: function (indexes, callback, callbackContext, layer)
     {
@@ -1824,7 +1824,7 @@ var Tilemap = new Class({
      * @param {object} callbackContext - The context under which the callback is called.
      * @param {Phaser.Tilemaps.LayerData} layer - [description]
      *
-     * @returns {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
+     * @return {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
      */
     setTileLocationCallback: function (tileX, tileY, width, height, callback, callbackContext, layer)
     {
@@ -1967,7 +1967,7 @@ var Tilemap = new Class({
      * @param {integer} [height=max height based on tileY] - [description]
      * @param {Phaser.Tilemaps.LayerData} layer - [description]
      *
-     * @returns {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
+     * @return {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
      */
     shuffle: function (tileX, tileY, width, height, layer)
     {
@@ -2002,7 +2002,7 @@ var Tilemap = new Class({
      * @param {integer} [height=max height based on tileY] - [description]
      * @param {Phaser.Tilemaps.LayerData} layer - [description]
      *
-     * @returns {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
+     * @return {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
      */
     swapByIndex: function (indexA, indexB, tileX, tileY, width, height, layer)
     {
@@ -2123,7 +2123,7 @@ var Tilemap = new Class({
      * { index: [0, 1], weight: 4 } if you wish to draw from multiple tile indexes.
      * @param {Phaser.Tilemaps.LayerData} layer - [description]
      *
-     * @returns {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
+     * @return {Phaser.Tilemaps.Tilemap|null} Return this Tilemap object, or null if the layer given was invalid.
      */
     weightedRandomize: function (tileX, tileY, width, height, weightedIndexes, layer)
     {

src/tilemaps/TilemapCreator.js

@@ -1,14 +1,15 @@
 var GameObjectCreator = require('../gameobjects/GameObjectCreator');
 var ParseToTilemap = require('./ParseToTilemap');
 
-//  When registering a factory function 'this' refers to the GameObjectCreator context.
-
 /**
  * Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided.
  * When loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing
  * from a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map
  * data. For an empty map, you should specify tileWidth, tileHeight, width & height.
  *
+ * @method Phaser.GameObjects.GameObjectCreator#tilemap
+ * @since 3.0.0
+ * 
  * @param {object} [config] - The config options for the Tilemap.
  * @param {string} [config.key] - The key in the Phaser cache that corresponds to the loaded tilemap
  * data.
@@ -24,12 +25,24 @@ var ParseToTilemap = require('./ParseToTilemap');
  * map and the tile data doesn't need to change then setting this value to `true` will help with
  * memory consumption. However if your map is small or you need to update the tiles dynamically,
  * then leave the default value set.
- * @returns {Tilemap}
+ * 
+ * @return {Phaser.Tilemaps.Tilemap}
  */
 GameObjectCreator.register('tilemap', function (config)
 {
     // Defaults are applied in ParseToTilemap
-    var c = config !== undefined ? config : {};
-    return ParseToTilemap(this.scene, c.key, c.tileWidth, c.tileHeight, c.width, c.height, c.data,
-        c.insertNull);
+    var c = (config !== undefined) ? config : {};
+
+    return ParseToTilemap(
+        this.scene,
+        c.key,
+        c.tileWidth,
+        c.tileHeight,
+        c.width,
+        c.height,
+        c.data,
+        c.insertNull
+    );
 });
+
+//  When registering a factory function 'this' refers to the GameObjectCreator context.

src/tilemaps/TilemapFactory.js

@@ -1,20 +1,15 @@
 var GameObjectFactory = require('../gameobjects/GameObjectFactory');
 var ParseToTilemap = require('./ParseToTilemap');
 
-//  When registering a factory function 'this' refers to the GameObjectFactory context.
-//
-//  There are several properties available to use:
-//
-//  this.scene - a reference to the Scene that owns the GameObjectFactory
-//  this.displayList - a reference to the Display List the Scene owns
-//  this.updateList - a reference to the Update List the Scene owns
-
 /**
  * Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided.
  * When loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing
  * from a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map
  * data. For an empty map, you should specify tileWidth, tileHeight, width & height.
  *
+ * @method Phaser.GameObjects.GameObjectFactory#tilemap
+ * @since 3.0.0
+ *
  * @param {string} [key] - The key in the Phaser cache that corresponds to the loaded tilemap data.
  * @param {integer} [tileWidth=32] - The width of a tile in pixels. Pass in `null` to leave as the
  * default.
@@ -32,13 +27,15 @@ var ParseToTilemap = require('./ParseToTilemap');
  * the tile data doesn't need to change then setting this value to `true` will help with memory
  * consumption. However if your map is small or you need to update the tiles dynamically, then leave
  * the default value set.
- * @returns {Tilemap}
+ * 
+ * @return {Phaser.Tilemaps.Tilemap}
  */
 GameObjectFactory.register('tilemap', function (key, tileWidth, tileHeight, width, height, data, insertNull)
 {
     // Allow users to specify null to indicate that they want the default value, since null is
     // shorter & more legible than undefined. Convert null to undefined to allow ParseToTilemap
     // defaults to take effect.
+
     if (key === null) { key = undefined; }
     if (tileWidth === null) { tileWidth = undefined; }
     if (tileHeight === null) { tileHeight = undefined; }
@@ -47,3 +44,11 @@ GameObjectFactory.register('tilemap', function (key, tileWidth, tileHeight, widt
 
     return ParseToTilemap(this.scene, key, tileWidth, tileHeight, width, height, data, insertNull);
 });
+
+//  When registering a factory function 'this' refers to the GameObjectFactory context.
+//
+//  There are several properties available to use:
+//
+//  this.scene - a reference to the Scene that owns the GameObjectFactory
+//  this.displayList - a reference to the Display List the Scene owns
+//  this.updateList - a reference to the Update List the Scene owns