Updated jsdocs

Author: photonstorm

src/animations/Animation.js

@@ -435,7 +435,7 @@ var Animation = new Class({
      * @method Phaser.Animations.Animation#getFrames
      * @since 3.0.0
      *
-     * @param {[type]} textureManager - [description]
+     * @param {Phaser.Textures.TextureManager} textureManager - [description]
      * @param {[type]} frames - [description]
      *
      * @return {Phaser.Animations.AnimationFrame[]} [description]

src/boot/Game.js

@@ -346,7 +346,7 @@ var Game = new Class({
      * @since 3.0.0
      *
      * @param {integer} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.
-     * @param {number} delta - The delta time elapsed since the last frame.
+     * @param {number} delta - The delta time, in ms, elapsed since the last frame.
      */
     step: function (time, delta)
     {

src/cameras/2d/Camera.js

@@ -1283,10 +1283,10 @@ var Camera = new Class({
      * @method Phaser.Cameras.Scene2D.Camera#update
      * @since 3.0.0
      *
-     * @param {[type]} timestep - [description]
-     * @param {[type]} delta - [description]
+     * @param {integer} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.
+     * @param {number} delta - The delta time, in ms, elapsed since the last frame.
      */
-    update: function (timestep, delta)
+    update: function (time, delta)
     {
         if (this._flashAlpha > 0.0)
         {

src/cameras/2d/CameraManager.js

@@ -325,7 +325,7 @@ var CameraManager = new Class({
      * @method Phaser.Cameras.Scene2D.CameraManager#getCameraBelowPointer
      * @since 3.0.0
      *
-     * @param {[type]} pointer - [description]
+     * @param {Phaser.Input.Pointer} pointer - [description]
      *
      * @return {Phaser.Cameras.Scene2D.Camera} [description]
      */
@@ -375,9 +375,9 @@ var CameraManager = new Class({
      * @method Phaser.Cameras.Scene2D.CameraManager#render
      * @since 3.0.0
      *
-     * @param {[type]} renderer - [description]
-     * @param {[type]} children - [description]
-     * @param {[type]} interpolation - [description]
+     * @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - The Renderer that will render the children to this camera.
+     * @param {Phaser.GameObjects.GameObject[]} children - An array of renderable Game Objects.
+     * @param {number} interpolation - Interpolation value. Reserved for future use.
      */
     render: function (renderer, children, interpolation)
     {

src/cameras/controls/SmoothedKeyControl.js

@@ -304,7 +304,7 @@ var SmoothedKeyControl = new Class({
      * @method Phaser.Cameras.Controls.SmoothedKeyControl#update
      * @since 3.0.0
      *
-     * @param {[type]} delta - [description]
+     * @param {number} delta - The delta time, in ms, elapsed since the last frame.
      */
     update: function (delta)
     {

src/curves/CubicBezierCurve.js

@@ -82,14 +82,14 @@ var CubicBezierCurve = new Class({
     },
 
     /**
-     * [description]
+     * Gets the starting point on the curve.
      *
      * @method Phaser.Curves.CubicBezierCurve#getStartPoint
      * @since 3.0.0
      *
-     * @param {Phaser.Math.Vector2} out - [description]
+     * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.
      *
-     * @return {Phaser.Math.Vector2} [description]
+     * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.
      */
     getStartPoint: function (out)
     {
@@ -104,25 +104,25 @@ var CubicBezierCurve = new Class({
      * @method Phaser.Curves.CubicBezierCurve#getResolution
      * @since 3.0.0
      *
-     * @param {[type]} divisions - [description]
+     * @param {number} divisions - The amount of divisions used by this curve.
      *
-     * @return {[type]} [description]
+     * @return {number} The resolution of the curve.
      */
     getResolution: function (divisions)
     {
         return divisions;
     },
 
     /**
-     * [description]
+     * Get point at relative position in curve according to length.
      *
      * @method Phaser.Curves.CubicBezierCurve#getPoint
      * @since 3.0.0
      *
-     * @param {[type]} t - [description]
-     * @param {[type]} out - [description]
+     * @param {float} t - The position along the curve to return. Where 0 is the start and 1 is the end.
+     * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.
      *
-     * @return {[type]} [description]
+     * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.
      */
     getPoint: function (t, out)
     {
@@ -190,6 +190,16 @@ var CubicBezierCurve = new Class({
 
 });
 
+/**
+ * [description]
+ *
+ * @function Phaser.Curves.CubicBezierCurve.fromJSON
+ * @since 3.0.0
+ *
+ * @param {object} data - The JSON object containing this curve data.
+ *
+ * @return {Phaser.Curves.CubicBezierCurve} [description]
+ */
 CubicBezierCurve.fromJSON = function (data)
 {
     var points = data.points;

src/curves/Curve.js

@@ -139,10 +139,10 @@ var Curve = new Class({
      * @method Phaser.Curves.Curve#getBounds
      * @since 3.0.0
      *
-     * @param {Phaser.Geom.Rectangle} out - The Rectangle to store the bounds in. If falsey a new object will be created.
+     * @param {Phaser.Geom.Rectangle} [out] - The Rectangle to store the bounds in. If falsey a new object will be created.
      * @param {integer} [accuracy=16] - The accuracy of the bounds calculations.
      *
-     * @return {Phaser.Geom.Rectangle} A Rectangle containing the bounds values of this Curve.
+     * @return {Phaser.Geom.Rectangle} A Rectangle object holding the bounds of this curve. If `out` was given it will be this object.
      */
     getBounds: function (out, accuracy)
     {

src/curves/EllipseCurve.js

@@ -139,14 +139,14 @@ var EllipseCurve = new Class({
     },
 
     /**
-     * [description]
+     * Gets the starting point on the curve.
      *
      * @method Phaser.Curves.EllipseCurve#getStartPoint
      * @since 3.0.0
      *
-     * @param {[type]} out - [description]
+     * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.
      *
-     * @return {[type]} [description]
+     * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.
      */
     getStartPoint: function (out)
     {
@@ -161,25 +161,25 @@ var EllipseCurve = new Class({
      * @method Phaser.Curves.EllipseCurve#getResolution
      * @since 3.0.0
      *
-     * @param {[type]} divisions - [description]
+     * @param {number} divisions - [description]
      *
-     * @return {[type]} [description]
+     * @return {number} [description]
      */
     getResolution: function (divisions)
     {
         return divisions * 2;
     },
 
     /**
-     * [description]
+     * Get point at relative position in curve according to length.
      *
      * @method Phaser.Curves.EllipseCurve#getPoint
      * @since 3.0.0
      *
-     * @param {[type]} t - [description]
-     * @param {[type]} out - [description]
+     * @param {float} t - The position along the curve to return. Where 0 is the start and 1 is the end.
+     * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.
      *
-     * @return {[type]} [description]
+     * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.
      */
     getPoint: function (t, out)
     {
@@ -245,14 +245,14 @@ var EllipseCurve = new Class({
     },
 
     /**
-     * [description]
+     * Sets the horizontal radius of this curve.
      *
      * @method Phaser.Curves.EllipseCurve#setXRadius
      * @since 3.0.0
      *
-     * @param {[type]} value - [description]
+     * @param {number} value - The horizontal radius of this curve.
      *
-     * @return {[type]} [description]
+     * @return {Phaser.Curves.EllipseCurve} This curve object.
      */
     setXRadius: function (value)
     {
@@ -262,14 +262,14 @@ var EllipseCurve = new Class({
     },
 
     /**
-     * [description]
+     * Sets the vertical radius of this curve.
      *
      * @method Phaser.Curves.EllipseCurve#setYRadius
      * @since 3.0.0
      *
-     * @param {[type]} value - [description]
+     * @param {number} value - The vertical radius of this curve.
      *
-     * @return {[type]} [description]
+     * @return {Phaser.Curves.EllipseCurve} This curve object.
      */
     setYRadius: function (value)
     {
@@ -279,14 +279,14 @@ var EllipseCurve = new Class({
     },
 
     /**
-     * [description]
+     * Sets the width of this curve.
      *
      * @method Phaser.Curves.EllipseCurve#setWidth
      * @since 3.0.0
      *
-     * @param {[type]} value - [description]
+     * @param {number} value - The width of this curve.
      *
-     * @return {[type]} [description]
+     * @return {Phaser.Curves.EllipseCurve} This curve object.
      */
     setWidth: function (value)
     {
@@ -296,14 +296,14 @@ var EllipseCurve = new Class({
     },
 
     /**
-     * [description]
+     * Sets the height of this curve.
      *
      * @method Phaser.Curves.EllipseCurve#setHeight
      * @since 3.0.0
      *
-     * @param {[type]} value - [description]
+     * @param {number} value - The height of this curve.
      *
-     * @return {[type]} [description]
+     * @return {Phaser.Curves.EllipseCurve} This curve object.
      */
     setHeight: function (value)
     {
@@ -313,14 +313,14 @@ var EllipseCurve = new Class({
     },
 
     /**
-     * [description]
+     * Sets the start angle of this curve.
      *
      * @method Phaser.Curves.EllipseCurve#setStartAngle
      * @since 3.0.0
      *
-     * @param {[type]} value - [description]
+     * @param {number} value - The start angle of this curve, in radians.
      *
-     * @return {[type]} [description]
+     * @return {Phaser.Curves.EllipseCurve} This curve object.
      */
     setStartAngle: function (value)
     {
@@ -330,14 +330,14 @@ var EllipseCurve = new Class({
     },
 
     /**
-     * [description]
+     * Sets the end angle of this curve.
      *
      * @method Phaser.Curves.EllipseCurve#setEndAngle
      * @since 3.0.0
      *
-     * @param {[type]} value - [description]
+     * @param {number} value - The end angle of this curve, in radians.
      *
-     * @return {[type]} [description]
+     * @return {Phaser.Curves.EllipseCurve} This curve object.
      */
     setEndAngle: function (value)
     {
@@ -347,14 +347,14 @@ var EllipseCurve = new Class({
     },
 
     /**
-     * [description]
+     * Sets if this curve extends clockwise or anti-clockwise.
      *
      * @method Phaser.Curves.EllipseCurve#setClockwise
      * @since 3.0.0
      *
-     * @param {[type]} value - [description]
+     * @param {boolean} value - The clockwise state of this curve.
      *
-     * @return {[type]} [description]
+     * @return {Phaser.Curves.EllipseCurve} This curve object.
      */
     setClockwise: function (value)
     {
@@ -364,14 +364,14 @@ var EllipseCurve = new Class({
     },
 
     /**
-     * [description]
+     * Sets the rotation of this curve.
      *
      * @method Phaser.Curves.EllipseCurve#setRotation
      * @since 3.0.0
      *
-     * @param {[type]} value - [description]
+     * @param {number} value - The rotation of this curve, in radians.
      *
-     * @return {[type]} [description]
+     * @return {Phaser.Curves.EllipseCurve} This curve object.
      */
     setRotation: function (value)
     {
@@ -573,6 +573,16 @@ var EllipseCurve = new Class({
 
 });
 
+/**
+ * [description]
+ *
+ * @function Phaser.Curves.EllipseCurve.fromJSON
+ * @since 3.0.0
+ *
+ * @param {object} data - The JSON object containing this curve data.
+ *
+ * @return {Phaser.Curves.EllipseCurve} [description]
+ */
 EllipseCurve.fromJSON = function (data)
 {
     return new EllipseCurve(data);