jsdoc fixes

This commit is contained in:
Richard Davey 2018-06-13 08:37:40 +01:00
parent 9d52b6ac91
commit 15b544fc46
5 changed files with 9 additions and 29 deletions

View file

@ -290,8 +290,7 @@ var TimeStep = new Class({
* [description]
*
* @name Phaser.Boot.TimeStep#deltaHistory
* @type {array}
* @default 0
* @type {integer[]}
* @since 3.0.0
*/
this.deltaHistory = [];

View file

@ -10,26 +10,7 @@
module.exports = {
/**
* This alias will be removed in a future version.
* Use `FixedKeyControl` instead.
*
* @deprecated
* @name Phaser.Cameras.Controls.Fixed
*/
Fixed: require('./FixedKeyControl'),
FixedKeyControl: require('./FixedKeyControl'),
/**
* This alias will be removed in a future version.
* Use `SmoothedKeyControl` instead.
*
* @deprecated
* @name Phaser.Cameras.Controls.Smoothed
*/
Smoothed: require('./SmoothedKeyControl'),
SmoothedKeyControl: require('./SmoothedKeyControl')
};

View file

@ -15,7 +15,7 @@ var HSVToRGB = require('./HSVToRGB');
* @param {number} [s=1] - The saturation, in the range 0 - 1.
* @param {number} [v=1] - The value, in the range 0 - 1.
*
* @return {array} An array containing 360 elements, where each contains a single numeric value corresponding to the color at that point in the HSV color wheel.
* @return {ColorObject[]} An array containing 360 elements, where each contains a single numeric value corresponding to the color at that point in the HSV color wheel.
*/
var HSVColorWheel = function (s, v)
{

View file

@ -1797,11 +1797,11 @@ var ParticleEmitter = new Class({
* @since 3.0.0
*
* @param {ParticleEmitterCallback} callback - The function.
* @param {*} thisArg - The function's calling context.
* @param {*} context - The function's calling context.
*
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
*/
forEachAlive: function (callback, thisArg)
forEachAlive: function (callback, context)
{
var alive = this.alive;
var length = alive.length;
@ -1809,7 +1809,7 @@ var ParticleEmitter = new Class({
for (var index = 0; index < length; ++index)
{
// Sends the Particle and the Emitter
callback.call(thisArg, alive[index], this);
callback.call(context, alive[index], this);
}
return this;
@ -1822,11 +1822,11 @@ var ParticleEmitter = new Class({
* @since 3.0.0
*
* @param {ParticleEmitterCallback} callback - The function.
* @param {*} thisArg - The function's calling context.
* @param {*} context - The function's calling context.
*
* @return {Phaser.GameObjects.Particles.ParticleEmitter} This Particle Emitter.
*/
forEachDead: function (callback, thisArg)
forEachDead: function (callback, context)
{
var dead = this.dead;
var length = dead.length;
@ -1834,7 +1834,7 @@ var ParticleEmitter = new Class({
for (var index = 0; index < length; ++index)
{
// Sends the Particle and the Emitter
callback.call(thisArg, dead[index], this);
callback.call(context, dead[index], this);
}
return this;

View file

@ -639,7 +639,7 @@ var List = new Class({
* @genericUse {EachListCallback.<T>} - [callback]
*
* @param {EachListCallback} callback - The function to call.
* @param {*} [thisArg] - Value to use as `this` when executing callback.
* @param {*} [context] - Value to use as `this` when executing callback.
* @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.
*/
each: function (callback, context)