Updated jsdocs

Author: photonstorm

src/tilemaps/components/CalculateFacesAt.js

@@ -8,9 +8,9 @@ var GetTileAt = require('./GetTileAt');
  * @function Phaser.Tilemaps.Components.CalculateFacesAt
  * @since 3.0.0
  * 
- * @param {integer} tileX - [description]
- * @param {integer} tileY - [description]
- * @param {Phaser.Tilemaps.LayerData} layer - [description]
+ * @param {integer} tileX - The x coordinate.
+ * @param {integer} tileY - The y coordinate.
+ * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  */
 var CalculateFacesAt = function (tileX, tileY, layer)
 {

src/tilemaps/components/CalculateFacesWithin.js

@@ -13,7 +13,7 @@ var GetTilesWithin = require('./GetTilesWithin');
  * @param {integer} [tileY=0] - [description]
  * @param {integer} [width=max width based on tileX] - [description]
  * @param {integer} [height=max height based on tileY] - [description]
- * @param {Phaser.Tilemaps.LayerData} layer - [description]
+ * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  */
 var CalculateFacesWithin = function (tileX, tileY, width, height, layer)
 {

src/tilemaps/components/Copy.js

@@ -17,7 +17,7 @@ var CalculateFacesWithin = require('./CalculateFacesWithin');
  * @param {integer} destTileY - [description]
  * @param {integer} destTileY - [description]
  * @param {boolean} [recalculateFaces=true] - [description]
- * @param {Phaser.Tilemaps.LayerData} layer - [description]
+ * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  */
 var Copy = function (srcTileX, srcTileY, width, height, destTileX, destTileY, recalculateFaces, layer)
 {

src/tilemaps/components/CreateFromTiles.js

@@ -20,7 +20,7 @@ var ReplaceByIndex = require('./ReplaceByIndex');
  * scene.make.sprite).
  * @param {Phaser.Scene} [scene=scene the map is within] - The Scene to create the Sprites within.
  * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - The Camera to use when determining the world XY
- * @param {Phaser.Tilemaps.LayerData} layer - [description]
+ * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  * 
  * @return {Phaser.GameObjects.Sprite[]} An array of the Sprites that were created.
  */

src/tilemaps/components/CullTiles.js

@@ -5,11 +5,11 @@
  * @function Phaser.Tilemaps.Components.CullTiles
  * @since 3.0.0
  *
- * @param {Phaser.Tilemaps.LayerData} layer - [description]
- * @param {Phaser.Cameras.Scene2D.Camera} [camera=main camera] - [description]
+ * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
+ * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera to run the cull check against.
  * @param {array} [outputArray] - [description]
  * 
- * @return {Phaser.Tilemaps.Tile[]}
+ * @return {Phaser.Tilemaps.Tile[]} An array of Tile objects.
  */
 var CullTiles = function (layer, camera, outputArray)
 {

src/tilemaps/components/Fill.js

@@ -16,7 +16,7 @@ var SetTileCollision = require('./SetTileCollision');
  * @param {integer} [width=max width based on tileX] - [description]
  * @param {integer} [height=max height based on tileY] - [description]
  * @param {boolean} [recalculateFaces=true] - [description]
- * @param {Phaser.Tilemaps.LayerData} layer - [description]
+ * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  */
 var Fill = function (index, tileX, tileY, width, height, recalculateFaces, layer)
 {

src/tilemaps/components/FilterTiles.js

@@ -23,7 +23,7 @@ var GetTilesWithin = require('./GetTilesWithin');
  * on at least one side.
  * @param {boolean} [filteringOptions.hasInterestingFace=false] - If true, only return tiles that
  * have at least one interesting face.
- * @param {Phaser.Tilemaps.LayerData} layer - [description]
+ * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  * 
  * @return {Phaser.Tilemaps.Tile[]} The filtered array of Tiles.
  */

src/tilemaps/components/FindByIndex.js

@@ -12,7 +12,7 @@
  * @param {integer} [skip=0] - The number of times to skip a matching tile before returning.
  * @param {boolean} [reverse=false] - If true it will scan the layer in reverse, starting at the
  * bottom-right. Otherwise it scans from the top-left.
- * @param {Phaser.Tilemaps.LayerData} layer - [description]
+ * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  * 
  * @return {Phaser.Tilemaps.Tile|null} The first (or n skipped) tile with the matching index.
  */

src/tilemaps/components/FindTile.js

@@ -22,7 +22,7 @@ var GetTilesWithin = require('./GetTilesWithin');
  * on at least one side.
  * @param {boolean} [filteringOptions.hasInterestingFace=false] - If true, only return tiles that
  * have at least one interesting face.
- * @param {Phaser.Tilemaps.LayerData} layer - [description]
+ * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  * 
  * @return {Phaser.Tilemaps.Tile|null} A Tile that matches the search, or null if no Tile found
  */

src/tilemaps/components/ForEachTile.js

@@ -21,7 +21,7 @@ var GetTilesWithin = require('./GetTilesWithin');
  * on at least one side.
  * @param {boolean} [filteringOptions.hasInterestingFace=false] - If true, only return tiles that
  * have at least one interesting face.
- * @param {Phaser.Tilemaps.LayerData} layer - [description]
+ * @param {Phaser.Tilemaps.LayerData} layer - The Tilemap Layer to act upon.
  */
 var ForEachTile = function (callback, context, tileX, tileY, width, height, filteringOptions, layer)
 {