Adding jsdocs

Author: photonstorm

CHANGELOG.md

@@ -8,6 +8,21 @@
 
 ### Bug Fixes
 
+### Examples, Documentation and TypeScript
+
+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:
+
+@shaneMLK
+Arian Fornaris
+cyantree
+DannyT
+Elliott Wallace
+Lee
+Nathaniel Foldan
+Peter Pedersen
+Stephen Hamilton
+STuFF
+
 
 ## Version 3.13.0 - Yuuki - 20th September 2018
 

src/animations/AnimationManager.js

@@ -187,7 +187,7 @@ var AnimationManager = new Class({
      * @since 3.0.0
      *
      * @param {(string|JSONAnimationManager|JSONAnimation)} data - [description]
-     * @param {boolean} [clearCurrentAnimations=false] - [description]
+     * @param {boolean} [clearCurrentAnimations=false] - If set to `true`, the current animations will be removed (`anims.clear()`). If set to `false` (default), the animations in `data` will be added.
      *
      * @return {Phaser.Animations.Animation[]} An array containing all of the Animation objects that were created as a result of this call.
      */

src/boot/Config.js

@@ -275,7 +275,7 @@ var Config = new Class({
         }
 
         /**
-         * @const {number} Phaser.Boot.Config#renderType - [description]
+         * @const {number} Phaser.Boot.Config#renderType - Force Phaser to use a specific renderer. Can be `CONST.CANVAS`, `CONST.WEBGL`, `CONST.HEADLESS` or `CONST.AUTO` (default)
          */
         this.renderType = GetValue(config, 'type', CONST.AUTO);
 

src/curves/QuadraticBezierCurve.js

@@ -137,10 +137,10 @@ var QuadraticBezier = new Class({
      *
      * @generic {Phaser.GameObjects.Graphics} G - [graphics,$return]
      *
-     * @param {Phaser.GameObjects.Graphics} graphics - [description]
-     * @param {integer} [pointsTotal=32] - [description]
+     * @param {Phaser.GameObjects.Graphics} graphics - `Graphics` object to draw onto.
+     * @param {integer} [pointsTotal=32] - Number of points to be used for drawing the curve. Higher numbers result in smoother curve but require more processing.
      *
-     * @return {Phaser.GameObjects.Graphics} [description]
+     * @return {Phaser.GameObjects.Graphics} `Graphics` object that was drawn to.
      */
     draw: function (graphics, pointsTotal)
     {
@@ -163,7 +163,7 @@ var QuadraticBezier = new Class({
     },
 
     /**
-     * [description]
+     * Converts the curve into a JSON compatible object.
      *
      * @method Phaser.Curves.QuadraticBezier#toJSON
      * @since 3.2.0
@@ -185,14 +185,14 @@ var QuadraticBezier = new Class({
 });
 
 /**
- * [description]
+ * Creates a curve from a JSON object, e. g. created by `toJSON`.
  *
  * @function Phaser.Curves.QuadraticBezier.fromJSON
  * @since 3.2.0
  *
  * @param {JSONCurve} data - The JSON object containing this curve data.
  *
- * @return {Phaser.Curves.QuadraticBezier} [description]
+ * @return {Phaser.Curves.QuadraticBezier} The created curve instance.
  */
 QuadraticBezier.fromJSON = function (data)
 {

src/curves/path/Path.js

@@ -558,7 +558,7 @@ var Path = new Class({
      * @method Phaser.Curves.Path#getPoints
      * @since 3.0.0
      *
-     * @param {integer} [divisions=12] - [description]
+     * @param {integer} [divisions=12] - Get random point on path.
      *
      * @return {Phaser.Math.Vector2[]} [description]
      */
@@ -614,7 +614,7 @@ var Path = new Class({
      *
      * @generic {Phaser.Math.Vector2} O - [out,$return]
      *
-     * @param {Phaser.Math.Vector2} [out] - [description]
+     * @param {Phaser.Math.Vector2} [out] - `Vector2` instance that should be used for storing the result. If `undefined` a new `Vector2` will be created.
      *
      * @return {Phaser.Math.Vector2} [description]
      */

src/geom/line/NormalX.js

@@ -13,7 +13,7 @@ var Angle = require('./Angle');
  * @function Phaser.Geom.Line.NormalX
  * @since 3.0.0
  *
- * @param {Phaser.Geom.Line} line - [description]
+ * @param {Phaser.Geom.Line} line - The Line object to get the normal value from.
  *
  * @return {number} [description]
  */

src/geom/point/Equals.js

@@ -5,15 +5,15 @@
  */
 
 /**
- * [description]
+ * A comparison of two `Point` objects to see if they are equal.
  *
  * @function Phaser.Geom.Point.Equals
  * @since 3.0.0
  *
- * @param {Phaser.Geom.Point} point - [description]
- * @param {Phaser.Geom.Point} toCompare - [description]
+ * @param {Phaser.Geom.Point} point - The original `Point` to compare against.
+ * @param {Phaser.Geom.Point} toCompare - The second `Point` to compare.
  *
- * @return {boolean} [description]
+ * @return {boolean} Returns true if the both `Point` objects are equal.
  */
 var Equals = function (point, toCompare)
 {

src/geom/polygon/Polygon.js

@@ -51,15 +51,15 @@ var Polygon = new Class({
     },
 
     /**
-     * [description]
+     * Check to see if the Polygon contains the given x / y coordinates.
      *
      * @method Phaser.Geom.Polygon#contains
      * @since 3.0.0
      *
-     * @param {number} x - [description]
-     * @param {number} y - [description]
+     * @param {number} x - The x coordinate to check within the polygon.
+     * @param {number} y - The y coordinate to check within the polygon.
      *
-     * @return {boolean} [description]
+     * @return {boolean} `true` if the coordinates are within the polygon, otherwise `false`.
      */
     contains: function (x, y)
     {
@@ -141,7 +141,7 @@ var Polygon = new Class({
      * @method Phaser.Geom.Polygon#calculateArea
      * @since 3.0.0
      *
-     * @return {number} [description]
+     * @return {number} The area of the polygon.
      */
     calculateArea: function ()
     {

src/geom/rectangle/ContainsPoint.js

@@ -7,15 +7,15 @@
 var Contains = require('./Contains');
 
 /**
- * [description]
+ * Determines whether the specified point is contained within the rectangular region defined by this Rectangle object.
  *
  * @function Phaser.Geom.Rectangle.ContainsPoint
  * @since 3.0.0
  *
- * @param {Phaser.Geom.Rectangle} rect - [description]
- * @param {Phaser.Geom.Point} point - [description]
+ * @param {Phaser.Geom.Rectangle} rect - The Rectangle object.
+ * @param {Phaser.Geom.Point} point - The point object to be checked. Can be a Phaser Point object or any object with x and y values.
  *
- * @return {boolean} [description]
+ * @return {boolean} A value of true if the Rectangle object contains the specified point, otherwise false.
  */
 var ContainsPoint = function (rect, point)
 {

src/geom/rectangle/Decompose.js

@@ -5,15 +5,16 @@
  */
 
 /**
- * [description]
+ * Create an array of points for each corner of a Rectangle
+ * If an array is specified, each point object will be added to the end of the array, otherwise a new array will be created.
  *
  * @function Phaser.Geom.Rectangle.Decompose
  * @since 3.0.0
  *
- * @param {Phaser.Geom.Rectangle} rect - [description]
- * @param {array} [out] - [description]
+ * @param {Phaser.Geom.Rectangle} rect - The Rectangle object to be decomposed.
+ * @param {array} [out] - If provided, each point will be added to this array.
  *
- * @return {array} [description]
+ * @return {array} Will return the array you specified or a new array containing the points of the Rectangle.
  */
 var Decompose = function (rect, out)
 {