From 7f232b6bedac2dbde4fec3d752f5bb33cc84b58b Mon Sep 17 00:00:00 2001
From: Chris Andrew <chris@hexus.io>
Date: Wed, 20 Jun 2018 17:18:03 +0100
Subject: [PATCH] Further EmitterOp documentation.

---
 src/gameobjects/particles/EmitterOp.js       | 33 +++++++++++++-------
 src/gameobjects/particles/ParticleEmitter.js |  2 +-
 2 files changed, 22 insertions(+), 13 deletions(-)

diff --git a/src/gameobjects/particles/EmitterOp.js b/src/gameobjects/particles/EmitterOp.js
index 498dc3c42..94d2edc9b 100644
--- a/src/gameobjects/particles/EmitterOp.js
+++ b/src/gameobjects/particles/EmitterOp.js
@@ -116,7 +116,7 @@ var EmitterOp = new Class({
         }
 
         /**
-         * The key of this Particle Emitter property.
+         * The key of this property.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#propertyKey
          * @type {string}
@@ -125,7 +125,7 @@ var EmitterOp = new Class({
         this.propertyKey = key;
 
         /**
-         * The value of this Particle Emitter property.
+         * The value of this property.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#propertyValue
          * @type {number}
@@ -134,7 +134,7 @@ var EmitterOp = new Class({
         this.propertyValue = defaultValue;
 
         /**
-         * The default value of this Particle Emitter property.
+         * The default value of this property.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#defaultValue
          * @type {number}
@@ -143,7 +143,8 @@ var EmitterOp = new Class({
         this.defaultValue = defaultValue;
 
         /**
-         * [description]
+         * The number of steps for stepped easing between {@link Phaser.GameObjects.Particles.EmitterOp#start} and
+         * {@link Phaser.GameObjects.Particles.EmitterOp#end} values, per emit.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#steps
          * @type {number}
@@ -153,7 +154,7 @@ var EmitterOp = new Class({
         this.steps = 0;
 
         /**
-         * [description]
+         * The step counter for stepped easing, per emit.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#counter
          * @type {number}
@@ -163,7 +164,7 @@ var EmitterOp = new Class({
         this.counter = 0;
 
         /**
-         * [description]
+         * The start value for this property to ease between.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#start
          * @type {number}
@@ -173,7 +174,7 @@ var EmitterOp = new Class({
         this.start = 0;
 
         /**
-         * [description]
+         * The end value for this property to ease between.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#end
          * @type {number}
@@ -183,7 +184,7 @@ var EmitterOp = new Class({
         this.end = 0;
 
         /**
-         * [description]
+         * The easing function to use for interpolating this property.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#ease
          * @type {?function}
@@ -192,7 +193,13 @@ var EmitterOp = new Class({
         this.ease;
 
         /**
-         * [description]
+         * Whether this property can only be modified when a Particle is emitted.
+         *
+         * Set to `true` to allow only {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} callbacks to be set and
+         * affect this property.
+         *
+         * Set to `false` to allow both {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} and
+         * {@link Phaser.GameObjects.Particles.EmitterOp#onUpdate} callbacks to be set and affect this property.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#emitOnly
          * @type {boolean}
@@ -201,7 +208,7 @@ var EmitterOp = new Class({
         this.emitOnly = emitOnly;
 
         /**
-         * [description]
+         * The callback to run for Particles when they are emitted from the Particle Emitter.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#onEmit
          * @type {EmitterOpOnEmitCallback}
@@ -210,7 +217,7 @@ var EmitterOp = new Class({
         this.onEmit = this.defaultEmit;
 
         /**
-         * [description]
+         * The callback to run for Particles when they are updated.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#onUpdate
          * @type {EmitterOpOnUpdateCallback}
@@ -290,7 +297,9 @@ var EmitterOp = new Class({
     },
 
     /**
-     * [description]
+     * Update the {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} and
+     * {@link Phaser.GameObjects.Particles.EmitterOp#onUpdate} callbacks based on the type of the current
+     * {@link Phaser.GameObjects.Particles.EmitterOp#propertyValue}.
      *
      * @method Phaser.GameObjects.Particles.EmitterOp#setMethods
      * @since 3.0.0
diff --git a/src/gameobjects/particles/ParticleEmitter.js b/src/gameobjects/particles/ParticleEmitter.js
index c81bc5cf9..dabe81736 100644
--- a/src/gameobjects/particles/ParticleEmitter.js
+++ b/src/gameobjects/particles/ParticleEmitter.js
@@ -356,7 +356,7 @@ var ParticleEmitter = new Class({
         this.gravityY = 0;
 
         /**
-         * Whether accelerationX and accelerationY are nonzero. Set automatically during configuration.
+         * Whether accelerationX and accelerationY are non-zero. Set automatically during configuration.
          *
          * @name Phaser.GameObjects.Particles.ParticleEmitter#acceleration
          * @type {boolean}