Added hundreds of new jsdoc descriptions

Author: photonstorm

CHANGELOG.md

@@ -117,6 +117,7 @@ snowbillr
 Stephen Hamilton
 STuFF
 TadejZupancic
+telinc1
 
 ## Version 3.13.0 - Yuuki - 20th September 2018
 

src/actions/PlaceOnLine.js

@@ -7,15 +7,15 @@
 var GetPoints = require('../geom/line/GetPoints');
 
 /**
- * [description]
+ * Positions an array of Game Objects on evenly spaced points of a Line.
  *
  * @function Phaser.Actions.PlaceOnLine
  * @since 3.0.0
  *
  * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
  *
  * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
- * @param {Phaser.Geom.Line} line - [description]
+ * @param {Phaser.Geom.Line} line - The Line to position the Game Objects on.
  *
  * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.
  */

src/actions/SetHitArea.js

@@ -5,16 +5,18 @@
  */
 
 /**
- * [description]
+ * Passes all provided Game Objects to the Input Manager to enable them for input with identical areas and callbacks.
+ * 
+ * @see {@link Phaser.GameObjects.GameObject#setInteractive}
  *
  * @function Phaser.Actions.SetHitArea
  * @since 3.0.0
  *
  * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
  *
  * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
- * @param {*} hitArea - [description]
- * @param {HitAreaCallback} hitAreaCallback - [description]
+ * @param {*} hitArea - Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.
+ * @param {HitAreaCallback} hitAreaCallback - A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.
  *
  * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.
  */

src/create/GenerateTexture.js

@@ -21,8 +21,8 @@ var GetValue = require('../utils/object/GetValue');
  * @property {array} [data=[]] - [description]
  * @property {HTMLCanvasElement} [canvas=null] - [description]
  * @property {Palette} [palette=Arne16] - [description]
- * @property {number} [pixelWidth=1] - [description]
- * @property {number} [pixelHeight=1] - [description]
+ * @property {number} [pixelWidth=1] - The width of each 'pixel' in the generated texture.
+ * @property {number} [pixelHeight=1] - The height of each 'pixel' in the generated texture.
  * @property {boolean} [resizeCanvas=true] - [description]
  * @property {boolean} [clearCanvas=true] - [description]
  * @property {GenerateTextureRendererCallback} [preRender] - [description]

src/display/mask/GeometryMask.js

@@ -8,15 +8,19 @@ var Class = require('../../utils/Class');
 
 /**
  * @classdesc
- * [description]
+ * A Geometry Mask can be applied to a Game Object to hide any pixels of it which don't intersect a visible pixel from the geometry mask. The mask is essentially a clipping path which can only make a masked pixel fully visible or fully invisible without changing its alpha (opacity).
+ * 
+ * A Geometry Mask uses a Graphics Game Object to determine which pixels of the masked Game Object(s) should be clipped. For any given point of a masked Game Object's texture, the pixel will only be displayed if the Graphics Game Object of the Geometry Mask has a visible pixel at the same position. The color and alpha of the pixel from the Geometry Mask do not matter.
+ * 
+ * The Geometry Mask's location matches the location of its Graphics object, not the location of the masked objects. Moving or transforming the underlying Graphics object will change the mask (and affect the visibility of any masked objects), whereas moving or transforming a masked object will not affect the mask. You can think of the Geometry Mask (or rather, of the its Graphics object) as an invisible curtain placed in front of all masked objects which has its own visual properties and, naturally, respects the camera's visual properties, but isn't affected by and doesn't follow the masked objects by itself.
  *
  * @class GeometryMask
  * @memberOf Phaser.Display.Masks
  * @constructor
  * @since 3.0.0
  *
- * @param {Phaser.Scene} scene - [description]
- * @param {Phaser.GameObjects.Graphics} graphicsGeometry - [description]
+ * @param {Phaser.Scene} scene - This parameter is not used.
+ * @param {Phaser.GameObjects.Graphics} graphicsGeometry - The Graphics Game Object to use for the Geometry Mask. Doesn't have to be in the Display List.
  */
 var GeometryMask = new Class({
 
@@ -25,7 +29,7 @@ var GeometryMask = new Class({
     function GeometryMask (scene, graphicsGeometry)
     {
         /**
-         * [description]
+         * The Graphics object which describes the Geometry Mask.
          *
          * @name Phaser.Display.Masks.GeometryMask#geometryMask
          * @type {Phaser.GameObjects.Graphics}
@@ -35,27 +39,27 @@ var GeometryMask = new Class({
     },
 
     /**
-     * [description]
+     * Sets a new Graphics object for the Geometry Mask.
      *
      * @method Phaser.Display.Masks.GeometryMask#setShape
      * @since 3.0.0
      *
-     * @param {Phaser.GameObjects.Graphics} graphicsGeometry - [description]
+     * @param {Phaser.GameObjects.Graphics} graphicsGeometry - The Graphics object which will be used for the Geometry Mask.
      */
     setShape: function (graphicsGeometry)
     {
         this.geometryMask = graphicsGeometry;
     },
 
     /**
-     * [description]
+     * Renders the Geometry Mask's underlying Graphics object to the OpenGL stencil buffer and enables the stencil test, which clips rendered pixels according to the mask.
      *
      * @method Phaser.Display.Masks.GeometryMask#preRenderWebGL
      * @since 3.0.0
      *
-     * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
-     * @param {Phaser.GameObjects.GameObject} mask - [description]
-     * @param {Phaser.Cameras.Scene2D.Camera} camera - [description]
+     * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - The WebGL Renderer instance to draw to.
+     * @param {Phaser.GameObjects.GameObject} mask - The Game Object being rendered.
+     * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera the Game Object is being rendered through.
      */
     preRenderWebGL: function (renderer, mask, camera)
     {
@@ -83,31 +87,32 @@ var GeometryMask = new Class({
     },
 
     /**
-     * [description]
+     * Flushes all rendered pixels and disables the stencil test of a WebGL context, thus disabling the mask for it.
      *
      * @method Phaser.Display.Masks.GeometryMask#postRenderWebGL
      * @since 3.0.0
      *
-     * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
+     * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - The WebGL Renderer instance to draw flush.
      */
     postRenderWebGL: function (renderer)
     {
         var gl = renderer.gl;
 
         // Force flush before disabling stencil test
         renderer.flush();
+
         gl.disable(gl.STENCIL_TEST);
     },
 
     /**
-     * [description]
+     * Sets the clipping path of a 2D canvas context to the Geometry Mask's underlying Graphics object.
      *
      * @method Phaser.Display.Masks.GeometryMask#preRenderCanvas
      * @since 3.0.0
      *
-     * @param {Phaser.Renderer.Canvas.CanvasRenderer} renderer - [description]
-     * @param {Phaser.GameObjects.GameObject} mask - [description]
-     * @param {Phaser.Cameras.Scene2D.Camera} camera - [description]
+     * @param {Phaser.Renderer.Canvas.CanvasRenderer} renderer - The Canvas Renderer instance to set the clipping path on.
+     * @param {Phaser.GameObjects.GameObject} mask - The Game Object being rendered.
+     * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera the Game Object is being rendered through.
      */
     preRenderCanvas: function (renderer, mask, camera)
     {
@@ -121,12 +126,12 @@ var GeometryMask = new Class({
     },
 
     /**
-     * [description]
+     * Restore the canvas context's previous clipping path, thus turning off the mask for it.
      *
      * @method Phaser.Display.Masks.GeometryMask#postRenderCanvas
      * @since 3.0.0
      *
-     * @param {Phaser.Renderer.Canvas.CanvasRenderer} renderer - [description]
+     * @param {Phaser.Renderer.Canvas.CanvasRenderer} renderer - The Canvas Renderer instance being restored.
      */
     postRenderCanvas: function (renderer)
     {

src/geom/intersects/CircleToCircle.js

@@ -7,15 +7,15 @@
 var DistanceBetween = require('../../math/distance/DistanceBetween');
 
 /**
- * [description]
+ * Checks if two Circles intersect.
  *
  * @function Phaser.Geom.Intersects.CircleToCircle
  * @since 3.0.0
  *
- * @param {Phaser.Geom.Circle} circleA - [description]
- * @param {Phaser.Geom.Circle} circleB - [description]
+ * @param {Phaser.Geom.Circle} circleA - The first Circle to check for intersection.
+ * @param {Phaser.Geom.Circle} circleB - The second Circle to check for intersection.
  *
- * @return {boolean} [description]
+ * @return {boolean} `true` if the two Circles intersect, otherwise `false`.
  */
 var CircleToCircle = function (circleA, circleB)
 {

src/geom/intersects/LineToLine.js

@@ -10,16 +10,16 @@ var Point = require('../point/Point');
 //  See http:'local.wasp.uwa.edu.au/~pbourke/geometry/lineline2d/
 
 /**
- * [description]
+ * Checks if two Lines intersect. If the Lines are identical, they will be treated as parallel and thus non-intersecting.
  *
  * @function Phaser.Geom.Intersects.LineToLine
  * @since 3.0.0
  *
- * @param {Phaser.Geom.Line} line1 - [description]
- * @param {Phaser.Geom.Line} line2 - [description]
- * @param {Phaser.Geom.Point} [out] - [description]
+ * @param {Phaser.Geom.Line} line1 - The first Line to check.
+ * @param {Phaser.Geom.Line} line2 - The second Line to check.
+ * @param {Phaser.Geom.Point} [out] - A Point in which to optionally store the point of intersection.
  *
- * @return {boolean} [description]
+ * @return {boolean} `true` if the two Lines intersect, and the `out` object will be populated, if given. Otherwise, `false`.
  */
 var LineToLine = function (line1, line2, out)
 {

src/geom/intersects/TriangleToLine.js

@@ -8,15 +8,17 @@ var Contains = require('../triangle/Contains');
 var LineToLine = require('./LineToLine');
 
 /**
- * [description]
+ * Checks if a Triangle and a Line intersect.
+ * 
+ * The Line intersects the Triangle if it starts inside of it, ends inside of it, or crosses any of the Triangle's sides. Thus, the Triangle is considered "solid".
  *
  * @function Phaser.Geom.Intersects.TriangleToLine
  * @since 3.0.0
  *
- * @param {Phaser.Geom.Triangle} triangle - [description]
- * @param {Phaser.Geom.Line} line - [description]
+ * @param {Phaser.Geom.Triangle} triangle - The Triangle to check with.
+ * @param {Phaser.Geom.Line} line - The Line to check with.
  *
- * @return {boolean} [description]
+ * @return {boolean} `true` if the Triangle and the Line intersect, otherwise `false`.
  */
 var TriangleToLine = function (triangle, line)
 {

src/geom/point/Invert.js

@@ -5,16 +5,16 @@
  */
 
 /**
- * [description]
+ * Swaps the X and the Y coordinate of a point.
  *
  * @function Phaser.Geom.Point.Invert
  * @since 3.0.0
  *
  * @generic {Phaser.Geom.Point} O - [point,$return]
  *
- * @param {Phaser.Geom.Point} point - [description]
+ * @param {Phaser.Geom.Point} point - The Point to modify.
  *
- * @return {Phaser.Geom.Point} [description]
+ * @return {Phaser.Geom.Point} The modified `point`.
  */
 var Invert = function (point)
 {

src/geom/polygon/Contains.js

@@ -8,16 +8,16 @@
 //  Adapted from http://www.ecse.rpi.edu/Homepages/wrf/Research/Short_Notes/pnpoly.html by Jonas Raoni Soares Silva
 
 /**
- * [description]
+ * Checks if a point is within the bounds of a Polygon.
  *
  * @function Phaser.Geom.Polygon.Contains
  * @since 3.0.0
  *
- * @param {Phaser.Geom.Polygon} polygon - [description]
- * @param {number} x - [description]
- * @param {number} y - [description]
+ * @param {Phaser.Geom.Polygon} polygon - The Polygon to check against.
+ * @param {number} x - The X coordinate of the point to check.
+ * @param {number} y - The Y coordinate of the point to check.
  *
- * @return {boolean} [description]
+ * @return {boolean} `true` if the point is within the bounds of the Polygon, otherwise `false`.
  */
 var Contains = function (polygon, x, y)
 {