Added new batch of jsdocs

Author: photonstorm

CHANGELOG.md

@@ -74,11 +74,20 @@ Arian Fornaris
 cyantree
 DannyT
 Elliott Wallace
+felixnemis
+griga
+Hsaka
+icbat
 Lee
 Nathaniel Foldan
 Peter Pedersen
+rootasjey
+Sam Frantz
+snowbillr
 Stephen Hamilton
 STuFF
+TadejZupancic
+
 
 ## Version 3.13.0 - Yuuki - 20th September 2018
 

src/boot/Config.js

@@ -181,9 +181,9 @@ var ValueToColor = require('../display/color/ValueToColor');
  * @property {CanvasRenderingContext2D} [context] - Provide your own Canvas Context for Phaser to use, instead of creating one.
  * @property {object} [scene=null] - [description]
  * @property {string[]} [seed] - [description]
- * @property {string} [title=''] - [description]
- * @property {string} [url='http://phaser.io'] - [description]
- * @property {string} [version=''] - [description]
+ * @property {string} [title=''] - The title of the game.
+ * @property {string} [url='http://phaser.io'] - The url of the game.
+ * @property {string} [version=''] - The version of the game.
  * @property {boolean} [autoFocus=true] - Automatically call window.focus() when the game boots.
  * @property {(boolean|InputConfig)} [input] - [description]
  * @property {boolean} [disableContextMenu=false] - [description]
@@ -307,17 +307,17 @@ var Config = new Class({
         MATH.RND.init(this.seed);
 
         /**
-         * @const {string} Phaser.Boot.Config#gameTitle - [description]
+         * @const {string} Phaser.Boot.Config#gameTitle - The title of the game.
          */
         this.gameTitle = GetValue(config, 'title', '');
 
         /**
-         * @const {string} Phaser.Boot.Config#gameURL - [description]
+         * @const {string} Phaser.Boot.Config#gameURL - The URL of the game.
          */
         this.gameURL = GetValue(config, 'url', 'https://phaser.io');
 
         /**
-         * @const {string} Phaser.Boot.Config#gameVersion - [description]
+         * @const {string} Phaser.Boot.Config#gameVersion - The version of the game.
          */
         this.gameVersion = GetValue(config, 'version', '');
 
@@ -396,7 +396,7 @@ var Config = new Class({
         this.inputGamepadEventTarget = GetValue(config, 'input.gamepad.target', window);
 
         /**
-         * @const {boolean} Phaser.Boot.Config#disableContextMenu - [description]
+         * @const {boolean} Phaser.Boot.Config#disableContextMenu - Set to `true` to disable context menu. Default value is `false`.
          */
         this.disableContextMenu = GetValue(config, 'disableContextMenu', false);
 
@@ -466,7 +466,7 @@ var Config = new Class({
         this.roundPixels = GetValue(renderConfig, 'roundPixels', false);
 
         /**
-         * @const {boolean} Phaser.Boot.Config#pixelArt - [description]
+         * @const {boolean} Phaser.Boot.Config#pixelArt - Prevent pixel art from becoming blurred when scaled. It will remain crisp (tells the WebGL renderer to automatically create textures using a linear filter mode).
          */
         this.pixelArt = GetValue(renderConfig, 'pixelArt', false);
 
@@ -566,7 +566,7 @@ var Config = new Class({
         this.loaderPath = GetValue(config, 'loader.path', '');
 
         /**
-         * @const {integer} Phaser.Boot.Config#loaderMaxParallelDownloads - [description]
+         * @const {integer} Phaser.Boot.Config#loaderMaxParallelDownloads - Maximum parallel downloads allowed for resources (Default to 32).
          */
         this.loaderMaxParallelDownloads = GetValue(config, 'loader.maxParallelDownloads', 32);
 

src/curves/CubicBezierCurve.js

@@ -13,7 +13,7 @@ var Vector2 = require('../math/Vector2');
 
 /**
  * @classdesc
- * [description]
+ * A higher-order Bézier curve constructed of four points.
  *
  * @class CubicBezier
  * @extends Phaser.Curves.Curve
@@ -45,7 +45,7 @@ var CubicBezierCurve = new Class({
         }
 
         /**
-         * [description]
+         * The start point of this curve.
          *
          * @name Phaser.Curves.CubicBezier#p0
          * @type {Phaser.Math.Vector2}
@@ -54,7 +54,7 @@ var CubicBezierCurve = new Class({
         this.p0 = p0;
 
         /**
-         * [description]
+         * The first control point of this curve.
          *
          * @name Phaser.Curves.CubicBezier#p1
          * @type {Phaser.Math.Vector2}
@@ -63,7 +63,7 @@ var CubicBezierCurve = new Class({
         this.p1 = p1;
 
         /**
-         * [description]
+         * The second control point of this curve.
          *
          * @name Phaser.Curves.CubicBezier#p2
          * @type {Phaser.Math.Vector2}
@@ -72,7 +72,7 @@ var CubicBezierCurve = new Class({
         this.p2 = p2;
 
         /**
-         * [description]
+         * The end point of this curve.
          *
          * @name Phaser.Curves.CubicBezier#p3
          * @type {Phaser.Math.Vector2}
@@ -101,7 +101,7 @@ var CubicBezierCurve = new Class({
     },
 
     /**
-     * [description]
+     * Returns the resolution of this curve.
      *
      * @method Phaser.Curves.CubicBezier#getResolution
      * @since 3.0.0
@@ -141,17 +141,17 @@ var CubicBezierCurve = new Class({
     },
 
     /**
-     * [description]
+     * Draws this curve to the specified graphics object.
      *
      * @method Phaser.Curves.CubicBezier#draw
      * @since 3.0.0
      *
      * @generic {Phaser.GameObjects.Graphics} G - [graphics,$return]
      *
-     * @param {Phaser.GameObjects.Graphics} graphics - [description]
-     * @param {integer} [pointsTotal=32] - [description]
+     * @param {Phaser.GameObjects.Graphics} graphics - The graphics object this curve should be drawn to.
+     * @param {integer} [pointsTotal=32] - The number of intermediary points that make up this curve. A higher number of points will result in a smoother curve.
      *
-     * @return {Phaser.GameObjects.Graphics} [description]
+     * @return {Phaser.GameObjects.Graphics} The graphics object this curve was drawn to. Useful for method chaining.
      */
     draw: function (graphics, pointsTotal)
     {
@@ -174,7 +174,7 @@ var CubicBezierCurve = new Class({
     },
 
     /**
-     * [description]
+     * Returns a JSON object that describes this curve.
      *
      * @method Phaser.Curves.CubicBezier#toJSON
      * @since 3.0.0
@@ -197,14 +197,14 @@ var CubicBezierCurve = new Class({
 });
 
 /**
- * [description]
+ * Generates a curve from a JSON object.
  *
  * @function Phaser.Curves.CubicBezier.fromJSON
  * @since 3.0.0
  *
  * @param {JSONCurve} data - The JSON object containing this curve data.
  *
- * @return {Phaser.Curves.CubicBezier} [description]
+ * @return {Phaser.Curves.CubicBezier} The curve generated from the JSON object.
  */
 CubicBezierCurve.fromJSON = function (data)
 {

src/curves/Curve.js

@@ -192,9 +192,9 @@ var Curve = new Class({
      * @method Phaser.Curves.Curve#getEndPoint
      * @since 3.0.0
      *
-     * @param {Phaser.Math.Vector2} out - [description]
+     * @param {Phaser.Math.Vector2} [out] - Optional Vector object to store the result in.
      *
-     * @return {Phaser.Math.Vector2} [description]
+     * @return {Phaser.Math.Vector2} Vector2 containing the coordinates of the curves end point.
      */
     getEndPoint: function (out)
     {
@@ -398,7 +398,7 @@ var Curve = new Class({
      * @param {number} t - [description]
      * @param {Phaser.Math.Vector2} [out] - [description]
      *
-     * @return {Phaser.Math.Vector2} [description]
+     * @return {Phaser.Math.Vector2} Vector approximating the tangent line at the point t (delta +/- 0.0001)
      */
     getTangent: function (t, out)
     {

src/curves/path/Path.js

@@ -558,9 +558,9 @@ var Path = new Class({
      * @method Phaser.Curves.Path#getPoints
      * @since 3.0.0
      *
-     * @param {integer} [divisions=12] - Get random point on path.
+     * @param {integer} [divisions=12] - The number of points to divide the path in to.
      *
-     * @return {Phaser.Math.Vector2[]} [description]
+     * @return {Phaser.Math.Vector2[]} An array of Vector2 objects that containing the points along the Path.
      */
     getPoints: function (divisions)
     {

src/geom/rectangle/GetPoints.js

@@ -11,19 +11,19 @@ var Perimeter = require('./Perimeter');
 //  each spaced out based on the quantity or step required
 
 /**
- * [description]
+ * Return an array of points from the perimeter of the rectangle, each spaced out based on the quantity or step required.
  *
  * @function Phaser.Geom.Rectangle.GetPoints
  * @since 3.0.0
  *
  * @generic {Phaser.Geom.Point[]} O - [out,$return]
  *
- * @param {Phaser.Geom.Rectangle} rectangle - [description]
+ * @param {Phaser.Geom.Rectangle} rectangle - The Rectangle object to get the points from.
  * @param {number} step - [description]
  * @param {integer} quantity - [description]
- * @param {(array|Phaser.Geom.Point[])} [out] - [description]
+ * @param {(array|Phaser.Geom.Point[])} [out] - An optional array to store the points in.
  *
- * @return {(array|Phaser.Geom.Point[])} [description]
+ * @return {(array|Phaser.Geom.Point[])} An array of Points from the perimeter of the rectangle.
  */
 var GetPoints = function (rectangle, quantity, stepRate, out)
 {

src/geom/rectangle/MergeRect.js

@@ -8,17 +8,18 @@
 //  Neither rect should have negative widths or heights
 
 /**
- * [description]
+ * Merges the source rectangle into the target rectangle and returns the target.
+ * Neither rectangle should have a negative width or height.
  *
  * @function Phaser.Geom.Rectangle.MergeRect
  * @since 3.0.0
  *
  * @generic {Phaser.Geom.Rectangle} O - [target,$return]
  *
- * @param {Phaser.Geom.Rectangle} target - [description]
- * @param {Phaser.Geom.Rectangle} source - [description]
+ * @param {Phaser.Geom.Rectangle} target - Target rectangle. Will be modified to include source rectangle.
+ * @param {Phaser.Geom.Rectangle} source - Rectangle that will be merged into target rectangle.
  *
- * @return {Phaser.Geom.Rectangle} [description]
+ * @return {Phaser.Geom.Rectangle} Modified target rectangle that contains source rectangle.
  */
 var MergeRect = function (target, source)
 {

src/geom/rectangle/Rectangle.js

@@ -205,13 +205,13 @@ var Rectangle = new Class({
     },
 
     /**
-     * [description]
+     * Sets the width and height of the Rectangle.
      *
      * @method Phaser.Geom.Rectangle#setSize
      * @since 3.0.0
      *
-     * @param {number} width - [description]
-     * @param {number} [height=width] - [description]
+     * @param {number} width - The width to set the Rectangle to.
+     * @param {number} [height=width] - The height to set the Rectangle to.
      *
      * @return {Phaser.Geom.Rectangle} This Rectangle object.
      */
@@ -226,12 +226,12 @@ var Rectangle = new Class({
     },
 
     /**
-     * [description]
+     * Determines if the Rectangle is empty. A Rectangle is empty if its width or height is less than or equal to 0.
      *
      * @method Phaser.Geom.Rectangle#isEmpty
      * @since 3.0.0
      *
-     * @return {boolean} [description]
+     * @return {boolean} `true` if the Rectangle is empty. A Rectangle object is empty if its width or height is less than or equal to 0.
      */
     isEmpty: function ()
     {
@@ -323,7 +323,8 @@ var Rectangle = new Class({
     },
 
     /**
-     * [description]
+     * The x coordinate of the left of the Rectangle.
+     * Changing the left property of a Rectangle object has no effect on the y and height properties. However it does affect the width property, whereas changing the x value does not affect the width property.
      *
      * @name Phaser.Geom.Rectangle#left
      * @type {number}
@@ -353,7 +354,8 @@ var Rectangle = new Class({
     },
 
     /**
-     * [description]
+     * The sum of the x and width properties.
+     * Changing the right property of a Rectangle object has no effect on the x, y and height properties, however it does affect the width property.
      *
      * @name Phaser.Geom.Rectangle#right
      * @type {number}
@@ -381,7 +383,8 @@ var Rectangle = new Class({
     },
 
     /**
-     * [description]
+     * The y coordinate of the top of the Rectangle. Changing the top property of a Rectangle object has no effect on the x and width properties.
+     * However it does affect the height property, whereas changing the y value does not affect the height property.
      *
      * @name Phaser.Geom.Rectangle#top
      * @type {number}
@@ -411,7 +414,8 @@ var Rectangle = new Class({
     },
 
     /**
-     * [description]
+     * The sum of the y and height properties.
+     * Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.
      *
      * @name Phaser.Geom.Rectangle#bottom
      * @type {number}
@@ -439,7 +443,7 @@ var Rectangle = new Class({
     },
 
     /**
-     * [description]
+     * The x coordinate of the center of the Rectangle.
      *
      * @name Phaser.Geom.Rectangle#centerX
      * @type {number}
@@ -460,7 +464,7 @@ var Rectangle = new Class({
     },
 
     /**
-     * [description]
+     * The y coordinate of the center of the Rectangle.
      *
      * @name Phaser.Geom.Rectangle#centerY
      * @type {number}

src/geom/triangle/BuildEquilateral.js

@@ -6,24 +6,18 @@
 
 var Triangle = require('./Triangle');
 
-// Builds an equilateral triangle.
-// In the equilateral triangle, all the sides are the same length (congruent)
-// and all the angles are the same size (congruent).
-
-//  The x/y specifies the top-middle of the triangle (x1/y1) and length
-//  is the length of each side
-
 /**
- * [description]
+ * Builds an equilateral triangle. In the equilateral triangle, all the sides are the same length (congruent) and all the angles are the same size (congruent).
+ * The x/y specifies the top-middle of the triangle (x1/y1) and length is the length of each side.
  *
  * @function Phaser.Geom.Triangle.BuildEquilateral
  * @since 3.0.0
  *
- * @param {number} x - [description]
- * @param {number} y - [description]
- * @param {number} length - [description]
+ * @param {number} x - x coordinate of the top point of the triangle.
+ * @param {number} y - y coordinate of the top point of the triangle.
+ * @param {number} length - Length of each side of the triangle.
  *
- * @return {Phaser.Geom.Triangle} [description]
+ * @return {Phaser.Geom.Triangle} The Triangle object of the given size.
  */
 var BuildEquilateral = function (x, y, length)
 {