From cb708dcc32e3f4e53c9ed1c5ec5acdaa3746027e Mon Sep 17 00:00:00 2001 From: orblazer Date: Mon, 19 Mar 2018 02:03:17 +0100 Subject: [PATCH] Update JSDoc on Textures, Tilemaps and Time --- src/textures/TextureSource.js | 4 ++-- src/tilemaps/parsers/Parse.js | 2 +- src/tilemaps/parsers/Parse2DArray.js | 6 +++--- src/tilemaps/parsers/ParseCSV.js | 6 +++--- src/time/Clock.js | 4 ++-- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/textures/TextureSource.js b/src/textures/TextureSource.js index eefffacf1..25b69590d 100644 --- a/src/textures/TextureSource.js +++ b/src/textures/TextureSource.js @@ -97,7 +97,7 @@ var TextureSource = new Class({ * Either Linear or Nearest. * * @name Phaser.Textures.TextureSource#scaleMode - * @type {[type]} + * @type {number} * @since 3.0.0 */ this.scaleMode = ScaleModes.DEFAULT; @@ -124,7 +124,7 @@ var TextureSource = new Class({ * The WebGL Texture of the source image. * * @name Phaser.Textures.TextureSource#glTexture - * @type {?[type]} + * @type {?WebGLTexture} * @default null * @since 3.0.0 */ diff --git a/src/tilemaps/parsers/Parse.js b/src/tilemaps/parsers/Parse.js index 237303ea5..f5b3cbf4f 100644 --- a/src/tilemaps/parsers/Parse.js +++ b/src/tilemaps/parsers/Parse.js @@ -33,7 +33,7 @@ var ParseWeltmeister = require('./impact/ParseWeltmeister'); * consumption. However if your map is small or you need to update the tiles dynamically, then leave * the default value set. * - * @return {[type]} [description] + * @return {Phaser.Tilemaps.MapData} [description] */ var Parse = function (name, mapFormat, data, tileWidth, tileHeight, insertNull) { diff --git a/src/tilemaps/parsers/Parse2DArray.js b/src/tilemaps/parsers/Parse2DArray.js index 54550f9d3..a80940d42 100644 --- a/src/tilemaps/parsers/Parse2DArray.js +++ b/src/tilemaps/parsers/Parse2DArray.js @@ -14,7 +14,7 @@ var Tile = require('../Tile'); * * @function Phaser.Tilemaps.Parsers.Parse2DArray * @since 3.0.0 - * + * * @param {string} name - The name of the tilemap, used to set the name on the MapData. * @param {integer[][]} data - 2D array, CSV string or Tiled JSON object. * @param {integer} tileWidth - The width of a tile in pixels. @@ -25,8 +25,8 @@ var Tile = require('../Tile'); * 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. - * - * @return {[type]} [description] + * + * @return {Phaser.Tilemaps.MapData} [description] */ var Parse2DArray = function (name, data, tileWidth, tileHeight, insertNull) { diff --git a/src/tilemaps/parsers/ParseCSV.js b/src/tilemaps/parsers/ParseCSV.js index ea0b427db..d57e80a1b 100644 --- a/src/tilemaps/parsers/ParseCSV.js +++ b/src/tilemaps/parsers/ParseCSV.js @@ -12,7 +12,7 @@ var Parse2DArray = require('./Parse2DArray'); * * @function Phaser.Tilemaps.Parsers.ParseCSV * @since 3.0.0 - * + * * @param {string} name - The name of the tilemap, used to set the name on the MapData. * @param {string} data - CSV string of tile indexes. * @param {integer} tileWidth - The width of a tile in pixels. @@ -23,8 +23,8 @@ var Parse2DArray = require('./Parse2DArray'); * 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. - * - * @return {[type]} [description] + * + * @return {Phaser.Tilemaps.MapData} [description] */ var ParseCSV = function (name, data, tileWidth, tileHeight, insertNull) { diff --git a/src/time/Clock.js b/src/time/Clock.js index bcc0e7b54..6e873ea0d 100644 --- a/src/time/Clock.js +++ b/src/time/Clock.js @@ -160,7 +160,7 @@ var Clock = new Class({ * @param {array} args - [description] * @param {object} callbackScope - [description] * - * @return {[type]} [description] + * @return {Phaser.Time.TimerEvent} [description] */ delayedCall: function (delay, callback, args, callbackScope) { @@ -172,7 +172,7 @@ var Clock = new Class({ * * @method Phaser.Time.Clock#clearPendingEvents * @since 3.0.0 - * + * * @return {Phaser.Time.Clock} [description] */ clearPendingEvents: function ()