From 6cbcfefe7b9189458a982944525b38a227eea8aa Mon Sep 17 00:00:00 2001 From: Richard Davey Date: Thu, 7 Sep 2023 13:28:52 +0100 Subject: [PATCH] Clarified jsdocs --- src/gameobjects/particles/ParticleEmitter.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/gameobjects/particles/ParticleEmitter.js b/src/gameobjects/particles/ParticleEmitter.js index 142ae55ea..15a27b4a4 100644 --- a/src/gameobjects/particles/ParticleEmitter.js +++ b/src/gameobjects/particles/ParticleEmitter.js @@ -2559,7 +2559,7 @@ var ParticleEmitter = new Class({ * @param {number} [x=this.x] - The x coordinate to emit the Particles from. * @param {number} [y=this.x] - The y coordinate to emit the Particles from. * - * @return {Phaser.GameObjects.Particles.Particle | undefined} The most recently emitted Particle. + * @return {(Phaser.GameObjects.Particles.Particle|undefined)} The most recently emitted Particle, or `undefined` if the emitter is at its limit. */ explode: function (count, x, y) { @@ -2585,7 +2585,7 @@ var ParticleEmitter = new Class({ * @param {number} [y=this.x] - The y coordinate to emit the Particles from. * @param {number} [count=this.quantity] - The number of Particles to emit. * - * @return {Phaser.GameObjects.Particles.Particle | undefined} The most recently emitted Particle. + * @return {(Phaser.GameObjects.Particles.Particle|undefined)} The most recently emitted Particle, or `undefined` if the emitter is at its limit. */ emitParticleAt: function (x, y, count) { @@ -2602,7 +2602,7 @@ var ParticleEmitter = new Class({ * @param {number} [x=this.x] - The x coordinate to emit the Particles from. * @param {number} [y=this.x] - The y coordinate to emit the Particles from. * - * @return {Phaser.GameObjects.Particles.Particle | undefined} The most recently emitted Particle. + * @return {(Phaser.GameObjects.Particles.Particle|undefined)} The most recently emitted Particle, or `undefined` if the emitter is at its limit. * * @see Phaser.GameObjects.Particles.Particle#fire */