JSDoc blocks added.

Author: photonstorm

v3/src/curves/curve/Curve.js

@@ -9,22 +9,79 @@ var Curve = new Class({
 
     initialize:
 
+    /**
+     * [description]
+     *
+     * @class Curve
+     * @memberOf Phaser.Curves
+     * @constructor
+     * @since 3.0.0
+     *
+     * @param {string} type - [description]
+     */
     function Curve (type)
     {
-        //  String based identifier
+        /**
+         * String based identifier
+         *
+         * @property {string} type
+         */
         this.type = type;
 
+        /**
+         * [description]
+         *
+         * @property {integer} defaultDivisions
+         * @default 5
+         */
         this.defaultDivisions = 5;
 
+        /**
+         * [description]
+         *
+         * @property {integer} arcLengthDivisions
+         * @default 100
+         */
         this.arcLengthDivisions = 100;
 
+        /**
+         * [description]
+         *
+         * @property {array} cacheArcLengths
+         * @default []
+         */
         this.cacheArcLengths = [];
 
+        /**
+         * [description]
+         *
+         * @property {boolean} needsUpdate
+         * @default true
+         */
         this.needsUpdate = true;
 
+        /**
+         * [description]
+         *
+         * @property {boolean} active
+         * @default true
+         */
         this.active = true;
 
+        /**
+         * [description]
+         *
+         * @property {Phaser.Math.Vector2} _tmpVec2A
+         * @private
+         */
         this._tmpVec2A = new Vector2();
+
+        /**
+         * [description]
+         *
+         * @property {Phaser.Math.Vector2} _tmpVec2B
+         * @private
+         */
         this._tmpVec2B = new Vector2();
     },
 

v3/src/curves/curve/inc/Draw.js

@@ -1,3 +1,14 @@
+/**
+ * [description]
+ *
+ * @method Phaser.Curves.Curve#draw
+ * @since 3.0.0
+ *
+ * @param {Phaser.GameObjects.Graphics} graphics - [description]
+ * @param {integer} [pointsTotal=32] - [description]
+ *
+ * @return {Phaser.GameObjects.Graphics} [description]
+ */
 var Draw = function (graphics, pointsTotal)
 {
     if (pointsTotal === undefined) { pointsTotal = 32; }

v3/src/curves/curve/inc/GetBounds.js

@@ -1,6 +1,17 @@
 var FromPoints = require('../../../geom/rectangle/FromPoints');
 var Rectangle = require('../../../geom/rectangle/Rectangle');
 
+/**
+ * [description]
+ *
+ * @method Phaser.Curves.Curve#getBounds
+ * @since 3.0.0
+ *
+ * @param {Phaser.Geom.Rectangle} out - [description]
+ * @param {integer} [accuracy=16] - [description]
+ *
+ * @return {Phaser.Geom.Rectangle} [description]
+ */
 var GetBounds = function (out, accuracy)
 {
     if (out === undefined) { out = new Rectangle(); }

v3/src/curves/curve/inc/GetDistancePoints.js

@@ -1,18 +1,22 @@
 //  Return an array of points, spaced out X distance pixels apart
+
+/**
+ * [description]
+ *
+ * @method Phaser.Curves.Curve#getDistancePoints
+ * @since 3.0.0
+ *
+ * @param {integer} distance - [description]
+ *
+ * @return {Phaser.Geom.Point[]} [description]
+ */
 var GetDistancePoints = function (distance)
 {
     var len = this.getLength();
 
     var spaced = Math.max(1, len / distance);
 
     return this.getSpacedPoints(spaced);
-
-    //  Get the t value for 200 pixels along the curve
-    // var t = curve.getTFromDistance(200);
-    //  = this.getUtoTmapping(0, distance, divisions)
-
-    //  Get the point at t
-    // var p = curve.getPoint(t);
 };
 
 module.exports = GetDistancePoints;

v3/src/curves/curve/inc/GetEndPoint.js

@@ -1,5 +1,15 @@
 var Vector2 = require('../../../math/Vector2');
 
+/**
+ * [description]
+ *
+ * @method Phaser.Curves.Curve#getEndPoint
+ * @since 3.0.0
+ *
+ * @param {Phaser.Math.Vector2} out - [description]
+ *
+ * @return {Phaser.Math.Vector2} [description]
+ */
 var GetEndPoint = function (out)
 {
     if (out === undefined) { out = new Vector2(); }

v3/src/curves/curve/inc/GetLength.js

@@ -1,5 +1,13 @@
 // Get total curve arc length
 
+/**
+ * [description]
+ *
+ * @method Phaser.Curves.Curve#getLength
+ * @since 3.0.0
+ *
+ * @return {number} [description]
+ */
 var GetLength = function ()
 {
     var lengths = this.getLengths();

v3/src/curves/curve/inc/GetLengths.js

@@ -1,5 +1,15 @@
 // Get list of cumulative segment lengths
 
+/**
+ * [description]
+ *
+ * @method Phaser.Curves.Curve#getLengths
+ * @since 3.0.0
+ *
+ * @param {integer} [divisions] - [description]
+ *
+ * @return {number[]} [description]
+ */
 var GetLengths = function (divisions)
 {
     if (divisions === undefined) { divisions = this.arcLengthDivisions; }

v3/src/curves/curve/inc/GetPointAt.js

@@ -2,6 +2,17 @@
 
 // - u [0 .. 1]
 
+/**
+ * [description]
+ *
+ * @method Phaser.Curves.Curve#getPointAt
+ * @since 3.0.0
+ *
+ * @param {float} u - [description]
+ * @param {Phaser.Math.Vector2} [out] - [description]
+ *
+ * @return {Phaser.Math.Vector2} [description]
+ */
 var GetPointAt = function (u, out)
 {
     var t = this.getUtoTmapping(u);

v3/src/curves/curve/inc/GetPoints.js

@@ -1,5 +1,15 @@
 // Get sequence of points using getPoint( t )
 
+/**
+ * [description]
+ *
+ * @method Phaser.Curves.Curve#getPoints
+ * @since 3.0.0
+ *
+ * @param {integer} [divisions] - [description]
+ *
+ * @return {Phaser.Math.Vector2[]} [description]
+ */
 var GetPoints = function (divisions)
 {
     if (divisions === undefined) { divisions = this.defaultDivisions; }

v3/src/curves/curve/inc/GetSpacedPoints.js

@@ -1,5 +1,15 @@
 // Get sequence of points using getPointAt( u )
 
+/**
+ * [description]
+ *
+ * @method Phaser.Curves.Curve#getSpacedPoints
+ * @since 3.0.0
+ *
+ * @param {integer} [divisions] - [description]
+ *
+ * @return {Phaser.Math.Vector2[]} [description]
+ */
 var GetSpacedPoints = function (divisions)
 {
     if (divisions === undefined) { divisions = this.defaultDivisions; }