Jsdoc fixup: Number -> Integer, array -> Type[]

Author: mikewesthad

v3/src/gameobjects/tilemap/ParseToTilemap.js

@@ -11,12 +11,12 @@ var Tilemap = require('./Tilemap');
  *
  * @param {Scene} scene - [description]
  * @param {string} [key] - The key in the Phaser cache that corresponds to the loaded tilemap data.
- * @param {number} [tileWidth=32] - The width of a tile in pixels.
- * @param {number} [tileHeight=32] - The height of a tile in pixels.
- * @param {number} [width=10] - The width of the map in tiles.
- * @param {number} [height=10] - The height of the map in tiles.
- * @param {array} [data] - Instead of loading from the cache, you can also load directly from a 2D
- * array of tile indexes.
+ * @param {integer} [tileWidth=32] - The width of a tile in pixels.
+ * @param {integer} [tileHeight=32] - The height of a tile in pixels.
+ * @param {integer} [width=10] - The width of the map in tiles.
+ * @param {integer} [height=10] - The height of the map in tiles.
+ * @param {integer[][]} [data] - Instead of loading from the cache, you can also load directly from
+ * a 2D array of tile indexes.
  * @param {boolean} [insertNull=false] - Controls how empty tiles, tiles with an index of -1, in the
  * map data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty
  * location will get a Tile object with an index of -1. If you've a large sparsely populated map and

v3/src/gameobjects/tilemap/Tilemap.js

@@ -134,13 +134,13 @@ var Tilemap = new Class({
      * property of alpha: 0.5 in the map editor will duplicate that when the Sprite is created.
      *
      * @param {string} name - The name of the object layer (from Tiled) to create Sprites from.
-     * @param {number} id - Either the id (object), gid (tile object) or name (object or tile
-     * object) from Tiled. Ids are unique in Tiled, but a gid is shared by all tile objects with the
-     * same graphic. The same name can be used on multiple objects.
+     * @param {integer|string} id - Either the id (object), gid (tile object) or name (object or
+     * tile object) from Tiled. Ids are unique in Tiled, but a gid is shared by all tile objects
+     * with the same graphic. The same name can be used on multiple objects.
      * @param {object} spriteConfig - The config object to pass into the Sprite creator (i.e.
      * scene.make.sprite).
      * @param {Scene} [scene=the scene the map is within] - The Scene to create the Sprites within.
-     * @return {array} An array of the Sprites that were created.
+     * @return {Sprite[]} An array of the Sprites that were created.
      */
     createFromObjects: function (name, id, spriteConfig, scene)
     {

v3/src/gameobjects/tilemap/TilemapCreator.js

@@ -4,20 +4,20 @@ 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.
+ * 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.
  *
  * @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.
- * @param {array} [config.data] - Instead of loading from the cache, you can also load directly from
- * a 2D array of tile indexes.
- * @param {number} [config.tileWidth=32] - The width of a tile in pixels.
- * @param {number} [config.tileHeight=32] - The height of a tile in pixels.
- * @param {number} [config.width=10] - The width of the map in tiles.
- * @param {number} [config.height=10] - The height of the map in tiles.
+ * @param {integer[][]} [config.data] - Instead of loading from the cache, you can also load
+ * directly from a 2D array of tile indexes.
+ * @param {integer} [config.tileWidth=32] - The width of a tile in pixels.
+ * @param {integer} [config.tileHeight=32] - The height of a tile in pixels.
+ * @param {integer} [config.width=10] - The width of the map in tiles.
+ * @param {integer} [config.height=10] - The height of the map in tiles.
  * @param {boolean} [config.insertNull=false] - Controls how empty tiles, tiles with an index of -1,
  * in the map data are handled. If `true`, empty locations will get a value of `null`. If `false`,
  * empty location will get a Tile object with an index of -1. If you've a large sparsely populated

v3/src/gameobjects/tilemap/TilemapFactory.js

@@ -16,16 +16,16 @@ var ParseToTilemap = require('./ParseToTilemap');
  * data. For an empty map, you should specify tileWidth, tileHeight, width & height.
  *
  * @param {string} [key] - The key in the Phaser cache that corresponds to the loaded tilemap data.
- * @param {number} [tileWidth=32] - The width of a tile in pixels. Pass in `null` to leave as the
+ * @param {integer} [tileWidth=32] - The width of a tile in pixels. Pass in `null` to leave as the
  * default.
- * @param {number} [tileHeight=32] - The height of a tile in pixels. Pass in `null` to leave as the
+ * @param {integer} [tileHeight=32] - The height of a tile in pixels. Pass in `null` to leave as the
  * default.
- * @param {number} [width=10] - The width of the map in tiles. Pass in `null` to leave as the
+ * @param {integer} [width=10] - The width of the map in tiles. Pass in `null` to leave as the
  * default.
- * @param {number} [height=10] - The height of the map in tiles. Pass in `null` to leave as the
+ * @param {integer} [height=10] - The height of the map in tiles. Pass in `null` to leave as the
  * default.
- * @param {array} [data] - Instead of loading from the cache, you can also load directly from a 2D
- * array of tile indexes. Pass in `null` for no data.
+ * @param {integer[][]} [data] - Instead of loading from the cache, you can also load directly from
+ * a 2D array of tile indexes. Pass in `null` for no data.
  * @param {boolean} [insertNull=false] - Controls how empty tiles, tiles with an index of -1, in the
  * map data are handled. If `true`, empty locations will get a value of `null`. If `false`, empty
  * location will get a Tile object with an index of -1. If you've a large sparsely populated map and

v3/src/gameobjects/tilemap/Tileset.js

@@ -8,7 +8,7 @@ var Tileset = new Class({
      * A Tileset is a combination of an image containing the tiles and a container for data about
      * each tile.
      *
-     * @class MapData
+     * @class Tileset
      * @constructor
      *
      * @param {string} name - The name of the tileset in the map data.
@@ -115,7 +115,7 @@ var Tileset = new Class({
         /**
          * The look-up table to specific tile image texture coordinates (UV in pixels). Each element
          * contains the coordinates for a tile in an object of the form {x, y}.
-         * @property {array} texCoordinates
+         * @property {object[]} texCoordinates
          * @readonly
         */
         this.texCoordinates = [];

v3/src/gameobjects/tilemap/components/CalculateFacesWithin.js

@@ -6,10 +6,10 @@ var GetTilesWithin = require('./GetTilesWithin');
  * layer. Interesting faces are used internally for optimizing collisions against tiles. This method
  * is mostly used internally.
  *
- * @param {number} [tileX=0] - [description]
- * @param {number} [tileY=0] - [description]
- * @param {number} [width=max width based on tileX] - [description]
- * @param {number} [height=max height based on tileY] - [description]
+ * @param {integer} [tileX=0] - [description]
+ * @param {integer} [tileY=0] - [description]
+ * @param {integer} [width=max width based on tileX] - [description]
+ * @param {integer} [height=max height based on tileY] - [description]
  * @param {LayerData} layer - [description]
  */
 var CalculateFacesWithin = function (tileX, tileY, width, height, layer)

v3/src/gameobjects/tilemap/components/Copy.js

@@ -6,13 +6,13 @@ var CalculateFacesWithin = require('./CalculateFacesWithin');
  * coordinates) within the layer. This copies all tile properties & recalculates collision
  * information in the destination region.
  *
- * @param {number} srcTileX - [description]
- * @param {number} srcTileY - [description]
- * @param {number} width - [description]
- * @param {number} height - [description]
- * @param {number} destTileX - [description]
- * @param {number} destTileY - [description]
- * @param {number} destTileY - [description]
+ * @param {integer} srcTileX - [description]
+ * @param {integer} srcTileY - [description]
+ * @param {integer} width - [description]
+ * @param {integer} height - [description]
+ * @param {integer} destTileX - [description]
+ * @param {integer} destTileY - [description]
+ * @param {integer} destTileY - [description]
  * @param {boolean} [recalculateFaces=true] - [description]
  * @param {LayerData} layer - [description]
  */

v3/src/gameobjects/tilemap/components/CreateFromTiles.js

@@ -9,16 +9,16 @@ var ReplaceByIndex = require('./ReplaceByIndex');
  * created. This is useful if you want to lay down special tiles in a level that are converted to
  * Sprites, but want to replace the tile itself with a floor tile or similar once converted.
  *
- * @param {number|array} indexes - The tile index, or array of indexes, to create Sprites from.
- * @param {number|array} replacements - The tile index, or array of indexes, to change a converted
+ * @param {integer|array} indexes - The tile index, or array of indexes, to create Sprites from.
+ * @param {integer|array} replacements - The tile index, or array of indexes, to change a converted
  * tile to. Set to `null` to leave the tiles unchanged. If an array is given, it is assumed to be a
  * one-to-one mapping with the indexes array.
  * @param {object} spriteConfig - The config object to pass into the Sprite creator (i.e.
  * scene.make.sprite).
  * @param {Scene} [scene=scene the map is within] - The Scene to create the Sprites within.
  * @param {Camera} [camera=main camera] - The Camera to use when determining the world XY
  * @param {LayerData} layer - [description]
- * @return {array} An array of the Sprites that were created.
+ * @return {Sprite[]} An array of the Sprites that were created.
  */
 var CreateFromTiles = function (indexes, replacements, spriteConfig, scene, camera, layer)
 {

v3/src/gameobjects/tilemap/components/CullTiles.js

@@ -5,7 +5,7 @@
  * @param {LayerData} layer - [description]
  * @param {Camera} [camera=main camera] - [description]
  * @param {array} [outputArray] - [description]
- * @returns {array}
+ * @returns {Tile[]}
  */
 var CullTiles = function (layer, camera, outputArray)
 {

v3/src/gameobjects/tilemap/components/Fill.js

@@ -6,11 +6,11 @@ var CalculateFacesWithin = require('./CalculateFacesWithin');
  * specified index. Tiles will be set to collide if the given index is a colliding index.
  * Collision information in the region will be recalculated.
  *
- * @param {number} index - [description]
- * @param {number} [tileX=0] - [description]
- * @param {number} [tileY=0] - [description]
- * @param {number} [width=max width based on tileX] - [description]
- * @param {number} [height=max height based on tileY] - [description]
+ * @param {integer} index - [description]
+ * @param {integer} [tileX=0] - [description]
+ * @param {integer} [tileY=0] - [description]
+ * @param {integer} [width=max width based on tileX] - [description]
+ * @param {integer} [height=max height based on tileY] - [description]
  * @param {boolean} [recalculateFaces=true] - [description]
  * @param {LayerData} layer - [description]
  */