Started documenting the EmitterOp class.

Author: hexus

src/gameobjects/particles/EmitterOp.js

@@ -27,7 +27,7 @@ var Wrap = require('../../math/Wrap');
  *
  * @param {Phaser.GameObjects.Particles.Particle} particle - The particle.
  * @param {string} key - The name of the property.
- * @param {float} t - The normalized lifetime of the particle, between 0 (start) and 1 (end).
+ * @param {number} t - The normalized lifetime of the particle, between 0 (start) and 1 (end).
  * @param {number} value - The current value of the property.
  *
  * @return {number} The new value of the property.
@@ -37,32 +37,32 @@ var Wrap = require('../../math/Wrap');
  * Defines an operation yielding a random value within a range.
  * @typedef {object} EmitterOpRandomConfig
  *
- * @property {float[]} random - The minimum and maximum values, as [min, max].
+ * @property {number[]} random - The minimum and maximum values, as [min, max].
  */
 
 /**
  * Defines an operation yielding a random value within a range.
  * @typedef {object} EmitterOpRandomMinMaxConfig
  *
- * @property {float} min - The minimum value.
- * @property {float} max - The maximum value.
+ * @property {number} min - The minimum value.
+ * @property {number} max - The maximum value.
  */
 
 /**
  * Defines an operation yielding a random value within a range.
  * @typedef {object} EmitterOpRandomStartEndConfig
  *
- * @property {float} start - The starting value.
- * @property {float} end - The ending value.
+ * @property {number} start - The starting value.
+ * @property {number} end - The ending value.
  * @property {boolean} random - If false, this becomes {@link EmitterOpEaseConfig}.
  */
 
 /**
  * Defines an operation yielding a value incremented continuously across a range.
  * @typedef {object} EmitterOpEaseConfig
  *
- * @property {float} start - The starting value.
- * @property {float} end - The ending value.
+ * @property {number} start - The starting value.
+ * @property {number} end - The ending value.
  * @property {string} [ease='Linear'] - The name of the easing function.
  */
 
@@ -90,16 +90,18 @@ var Wrap = require('../../math/Wrap');
 
 /**
  * @classdesc
- * [description]
+ * A Particle Emitter property.
+ *
+ * Facilitates changing Particle properties as they are emitted and throughout their lifetime.
  *
  * @class EmitterOp
  * @memberOf Phaser.GameObjects.Particles
  * @constructor
  * @since 3.0.0
  *
- * @param {object} config - [description]
- * @param {string} key - [description]
- * @param {number} defaultValue - [description]
+ * @param {ParticleEmitterConfig} config - Settings for the Particle Emitter that owns this property.
+ * @param {string} key - The key of the Particle Emitter property.
+ * @param {number} defaultValue - The default value of the Particle Emitter property.
  * @param {boolean} [emitOnly=false] - [description]
  */
 var EmitterOp = new Class({
@@ -114,7 +116,7 @@ var EmitterOp = new Class({
         }
 
         /**
-         * [description]
+         * The key of this Particle Emitter property.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#propertyKey
          * @type {string}
@@ -123,7 +125,7 @@ var EmitterOp = new Class({
         this.propertyKey = key;
 
         /**
-         * [description]
+         * The value of this Particle Emitter property.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#propertyValue
          * @type {number}
@@ -132,7 +134,7 @@ var EmitterOp = new Class({
         this.propertyValue = defaultValue;
 
         /**
-         * [description]
+         * The default value of this Particle Emitter property.
          *
          * @name Phaser.GameObjects.Particles.EmitterOp#defaultValue
          * @type {number}
@@ -220,13 +222,15 @@ var EmitterOp = new Class({
     },
 
     /**
-     * [description]
+     * Load the property from a Particle Emitter configuration object.
+     *
+     * Optionally accepts a new property key to use, replacing the current one.
      *
      * @method Phaser.GameObjects.Particles.EmitterOp#loadConfig
      * @since 3.0.0
      *
-     * @param {object} [config] - [description]
-     * @param {string} [newKey] - [description]
+     * @param {ParticleEmitterConfig} [config] - Settings for the Particle Emitter that owns this property.
+     * @param {string} [newKey] - The new key to use for this property, if any.
      */
     loadConfig: function (config, newKey)
     {
@@ -256,12 +260,12 @@ var EmitterOp = new Class({
     },
 
     /**
-     * [description]
+     * Build a JSON representation of this Particle Emitter property.
      *
      * @method Phaser.GameObjects.Particles.EmitterOp#toJSON
      * @since 3.0.0
      *
-     * @return {object} [description]
+     * @return {object} A JSON representation of this Particle Emitter property.
      */
     toJSON: function ()
     {
@@ -429,49 +433,49 @@ var EmitterOp = new Class({
     },
 
     /**
-     * [description]
+     * Check whether an object has the given property.
      *
      * @method Phaser.GameObjects.Particles.EmitterOp#has
      * @since 3.0.0
      *
-     * @param {object} object - [description]
-     * @param {string} key - [description]
+     * @param {object} object - The object to check.
+     * @param {string} key - The key of the property to look for in the object.
      *
-     * @return {boolean} [description]
+     * @return {boolean} `true` if the property exists in the object, `false` otherwise.
      */
     has: function (object, key)
     {
         return object.hasOwnProperty(key);
     },
 
     /**
-     * [description]
+     * Check whether an object has both of the given properties.
      *
      * @method Phaser.GameObjects.Particles.EmitterOp#hasBoth
      * @since 3.0.0
      *
-     * @param {object} object - [description]
-     * @param {string} key1 - [description]
-     * @param {string} key2 - [description]
+     * @param {object} object - The object to check.
+     * @param {string} key1 - The key of the first property to check the object for.
+     * @param {string} key2 - The key of the second property to check the object for.
      *
-     * @return {boolean} [description]
+     * @return {boolean} `true` if both properties exist in the object, `false` otherwise.
      */
     hasBoth: function (object, key1, key2)
     {
         return object.hasOwnProperty(key1) && object.hasOwnProperty(key2);
     },
 
     /**
-     * [description]
+     * Check whether an object has at least one of the given properties.
      *
      * @method Phaser.GameObjects.Particles.EmitterOp#hasEither
      * @since 3.0.0
      *
-     * @param {object} object - [description]
-     * @param {string} key1 - [description]
-     * @param {string} key2 - [description]
+     * @param {object} object - The object to check.
+     * @param {string} key1 - The key of the first property to check the object for.
+     * @param {string} key2 - The key of the second property to check the object for.
      *
-     * @return {boolean} [description]
+     * @return {boolean} `true` if at least one of the properties exists in the object, `false` if neither exist.
      */
     hasEither: function (object, key1, key2)
     {
@@ -503,7 +507,7 @@ var EmitterOp = new Class({
      *
      * @param {Phaser.GameObjects.Particles.Particle} particle - [description]
      * @param {string} key - [description]
-     * @param {float} t - The T value (between 0 and 1)
+     * @param {number} t - The T value (between 0 and 1)
      * @param {number} value - [description]
      *
      * @return {number} [description]