Added new jsdocs

CHANGELOG.md

@@ -74,16 +74,30 @@
 
 My thanks to the following for helping with the Phaser 3 Examples, Docs and TypeScript definitions, either by reporting errors, fixing them or helping author the docs:
 
+31826615
+@16patsle
+@bobonthenet
+@bobonthenet
+@rgk
+@samme
 @shaneMLK
 @wemyss
+ajmetal
+andiCR
 Arian Fornaris
+bsparks
+Carl
 cyantree
 DannyT
 Elliott Wallace
 felixnemis
 griga
+Hardylr
+henriacle
 Hsaka
 icbat
+Kanthi
+Kyle
 Lee
 Nathaniel Foldan
 Peter Pedersen
@@ -94,23 +108,6 @@ Stephen Hamilton
 STuFF
 TadejZupancic
 
-ajmetal
-henriacle
-@rgk
-@samme
-Carl
-@16patsle
-Kyle
-Hardylr
-andiCR
-@bobonthenet
-Kanthi
-31826615
-bsparks
-@bobonthenet
-
-
-
 ## Version 3.13.0 - Yuuki - 20th September 2018
 
 ### Facebook Instant Games Plugin

src/tilemaps/parsers/tiled/Base64Decode.js

@@ -5,14 +5,14 @@
  */
 
 /**
- * [description]
+ * Decode base-64 encoded data, for example as exported by Tiled.
  *
  * @function Phaser.Tilemaps.Parsers.Tiled.Base64Decode
  * @since 3.0.0
  *
- * @param {object} data - [description]
+ * @param {object} data - Base-64 encoded data to decode.
  *
- * @return {array} [description]
+ * @return {array} Array containing the decoded bytes.
  */
 var Base64Decode = function (data)
 {

src/tweens/Timeline.js

@@ -243,12 +243,13 @@ var Timeline = new Class({
     },
 
     /**
-     * [description]
+     * Sets the value of the time scale applied to this Timeline. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on.
+     * Value isn't used when calculating total duration of the tween, it's a run-time delta adjustment only.
      *
      * @method Phaser.Tweens.Timeline#setTimeScale
      * @since 3.0.0
      *
-     * @param {number} value - [description]
+     * @param {number} value - The time scale value to set.
      *
      * @return {Phaser.Tweens.Timeline} This Timeline object.
      */
@@ -260,12 +261,12 @@ var Timeline = new Class({
     },
 
     /**
-     * [description]
+     * Gets the value of the time scale applied to this Timeline. A value of 1 runs in real-time. A value of 0.5 runs 50% slower, and so on. 
      *
      * @method Phaser.Tweens.Timeline#getTimeScale
      * @since 3.0.0
      *
-     * @return {number} [description]
+     * @return {number} The value of the time scale applied to this Tween.
      */
     getTimeScale: function ()
     {
@@ -273,12 +274,12 @@ var Timeline = new Class({
     },
 
     /**
-     * [description]
+     * Check whether or not the Timeline is playing.
      *
      * @method Phaser.Tweens.Timeline#isPlaying
      * @since 3.0.0
      *
-     * @return {boolean} [description]
+     * @return {boolean} `true` if this Timeline is active, otherwise `false`.
      */
     isPlaying: function ()
     {
@@ -523,7 +524,7 @@ var Timeline = new Class({
     },
 
     /**
-     * [description]
+     * Sets a callback for the Tween Manager.
      *
      * @method Phaser.Tweens.Timeline#setCallback
      * @since 3.0.0
@@ -843,7 +844,7 @@ var Timeline = new Class({
     },
 
     /**
-     * [description]
+     * Stops all the Tweens in the Timeline immediately, whatever stage of progress they are at and flags them for removal by the TweenManager.
      *
      * @method Phaser.Tweens.Timeline#destroy
      * @since 3.0.0

src/tweens/builders/GetProps.js

@@ -12,9 +12,9 @@ var RESERVED = require('../tween/ReservedProps');
  * @function Phaser.Tweens.Builders.GetProps
  * @since 3.0.0
  *
- * @param {object} config - [description]
+ * @param {object} config - The configuration object of the tween to get the target(s) from.
  *
- * @return {array} [description]
+ * @return {array} An array of all the targets the tween is operating on.
  */
 var GetProps = function (config)
 {

src/tweens/tween/Defaults.js

@@ -7,17 +7,17 @@
 /**
  * @typedef {object} Phaser.Tweens.TweenConfigDefaults
  * 
- * @property {(object|object[])} targets - [description]
- * @property {number} [delay=0] - [description]
- * @property {number} [duration=1000] - [description]
- * @property {string} [ease='Power0'] - [description]
- * @property {array} [easeParams] - [description]
- * @property {number} [hold=0] - [description]
- * @property {number} [repeat=0] - [description]
- * @property {number} [repeatDelay=0] - [description]
- * @property {boolean} [yoyo=false] - [description]
- * @property {boolean} [flipX=false] - [description]
- * @property {boolean} [flipY=false] - [description]
+ * @property {(object|object[])} targets - The object, or an array of objects, to run the tween on.
+ * @property {number} [delay=0] - The number of milliseconds to delay before the tween will start.
+ * @property {number} [duration=1000] - The duration of the tween in milliseconds.
+ * @property {string} [ease='Power0'] - The easing equation to use for the tween.
+ * @property {array} [easeParams] - Optional easing parameters.
+ * @property {number} [hold=0] - The number of milliseconds to hold the tween for before yoyo'ing.
+ * @property {number} [repeat=0] - The number of times to repeat the tween.
+ * @property {number} [repeatDelay=0] - The number of milliseconds to pause before a tween will repeat.
+ * @property {boolean} [yoyo=false] - Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take `duration` milliseconds to complete.
+ * @property {boolean} [flipX=false] - Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipX` property.
+ * @property {boolean} [flipY=false] - Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the `flipY` property.
  */
 
 var TWEEN_DEFAULTS = {

src/utils/array/matrix/MatrixToString.js

@@ -11,14 +11,14 @@ var CheckMatrix = require('./CheckMatrix');
 //  Array Matrix.
 
 /**
- * [description]
+ * Generates a string (which you can pass to console.log) from the given Array Matrix.
  *
  * @function Phaser.Utils.Array.Matrix.MatrixToString
  * @since 3.0.0
  *
- * @param {array} matrix - [description]
+ * @param {array} matrix - A 2-dimensional array.
  *
- * @return {string} [description]
+ * @return {string} A string representing the matrix.
  */
 var MatrixToString = function (matrix)
 {

src/utils/array/matrix/ReverseColumns.js

@@ -5,14 +5,14 @@
  */
 
 /**
- * [description]
+ * Reverses the columns in the given Array Matrix.
  *
  * @function Phaser.Utils.Array.Matrix.ReverseColumns
  * @since 3.0.0
  *
- * @param {array} matrix - [description]
+ * @param {array} matrix - The array matrix to reverse the columns for.
  *
- * @return {array} [description]
+ * @return {array} The column reversed matrix.
  */
 var ReverseColumns = function (matrix)
 {