Circle docs and formatting return values

photonstorm · photonstorm · commit 8230f3f08626 · 2017-10-05T00:58:42.000+01:00
diff --git a/v3/src/animation/manager/inc/AddAnimation.js b/v3/src/animation/manager/inc/AddAnimation.js
@@ -9,6 +9,7 @@ var Event = require('../events/');
  * 
  * @param {string} key - [description]
  * @param {Phaser.Animations.Animation} animation - [description]
+ * 
  * @return {Phaser.Animations.AnimationManager} The Animation Manager for method chaining.
  */
 var AddAnimation = function (key, animation)
diff --git a/v3/src/animation/manager/inc/CreateFrameAnimation.js b/v3/src/animation/manager/inc/CreateFrameAnimation.js
@@ -9,6 +9,7 @@ var Animation = require('../../frame/Animation');
  * @since 3.0.0
  * 
  * @param {object} config - [description]
+ * 
  * @return {Phaser.Animations.Animation} The Animation that was created.
  */
 var CreateFrameAnimation = function (config)
diff --git a/v3/src/animation/manager/inc/FromJSON.js b/v3/src/animation/manager/inc/FromJSON.js
@@ -6,6 +6,7 @@
  * 
  * @param {string|object} data - [description]
  * @param {boolean} [clearCurrentAnimations=false] - [description]
+ * 
  * @return {array} An array containing all of the Animation objects that were created as a result of this call.
  */
 var FromJSON = function (data, clearCurrentAnimations)
diff --git a/v3/src/animation/manager/inc/GenerateFrameNames.js b/v3/src/animation/manager/inc/GenerateFrameNames.js
@@ -16,6 +16,7 @@ var Pad = require('../../../utils/string/Pad');
  * @param {integer} [config.zeroPad=0] - [description]
  * @param {array} [config.outputArray=[]] - [description]
  * @param {boolean} [config.frames=false] - [description]
+ * 
  * @return {array} [description]
  */
 var GenerateFrameNames = function (key, config)
diff --git a/v3/src/animation/manager/inc/GenerateFrameNumbers.js b/v3/src/animation/manager/inc/GenerateFrameNumbers.js
@@ -13,6 +13,7 @@ var GetValue = require('../../../utils/object/GetValue');
  * @param {boolean} [config.first=false] - [description]
  * @param {array} [config.outputArray=[]] - [description]
  * @param {boolean} [config.frames=false] - [description]
+ * 
  * @return {array} [description]
  */
 var GenerateFrameNumbers = function (key, config)
diff --git a/v3/src/animation/manager/inc/GetAnimation.js b/v3/src/animation/manager/inc/GetAnimation.js
@@ -5,6 +5,7 @@
  * @since 3.0.0
  * 
  * @param {string} key - [description]
+ * 
  * @return {Phaser.Animations.Animation} [description]
  */
 var GetAnimation = function (key)
diff --git a/v3/src/animation/manager/inc/LoadAnimationToGameObject.js b/v3/src/animation/manager/inc/LoadAnimationToGameObject.js
@@ -7,6 +7,7 @@
  * @param {Phaser.GameObjects.GameObject} child - [description]
  * @param {string} key - [description]
  * @param {string|integer} [startFrame] - [description]
+ * 
  * @return {Phaser.GameObjects.GameObject} [description]
  */
 var LoadAnimationToGameObject = function (child, key, startFrame)
diff --git a/v3/src/animation/manager/inc/PlayAnimation.js b/v3/src/animation/manager/inc/PlayAnimation.js
@@ -6,6 +6,7 @@
  * 
  * @param {string} key - [description]
  * @param {Phaser.GameObjects.GameObject} child - [description]
+ * 
  * @return {Phaser.Animations.AnimationManager} The Animation Manager for method chaining.
  */
 var PlayAnimation = function (key, child)
diff --git a/v3/src/animation/manager/inc/RemoveAnimation.js b/v3/src/animation/manager/inc/RemoveAnimation.js
@@ -8,6 +8,7 @@ var Event = require('../events/');
  * @since 3.0.0
  * 
  * @param {string} key - [description]
+ * 
  * @return {Phaser.Animations.Animation} [description]
  */
 var RemoveAnimation = function (key)
diff --git a/v3/src/animation/manager/inc/StaggerPlayAnimation.js b/v3/src/animation/manager/inc/StaggerPlayAnimation.js
@@ -7,6 +7,7 @@
  * @param {string} key - [description]
  * @param {Phaser.GameObjects.GameObject} child - [description]
  * @param {number} [stagger=0] - [description]
+ * 
  * @return {Phaser.Animations.AnimationManager} The Animation Manager for method chaining.
  */
 var StaggerPlayAnimation = function (key, child, stagger)
diff --git a/v3/src/animation/manager/inc/ToJSON.js b/v3/src/animation/manager/inc/ToJSON.js
@@ -5,6 +5,7 @@
  * @since 3.0.0
  * 
  * @param {string} key - [description]
+ * 
  * @return {object} [description]
  */
 var ToJSON = function (key)
diff --git a/v3/src/cache/BaseCache.js b/v3/src/cache/BaseCache.js
@@ -56,6 +56,7 @@ var BaseCache = new Class({
      * @since 3.0.0
      *
      * @param {string} key [description]
+     * 
      * @return {boolean} [description]
      */
     has: function (key)
@@ -70,6 +71,7 @@ var BaseCache = new Class({
      * @since 3.0.0
      *
      * @param {string} key [description]
+     * 
      * @return {any} [description]
      */
     get: function (key)
diff --git a/v3/src/cache/GlobalCache.js b/v3/src/cache/GlobalCache.js
@@ -123,6 +123,7 @@ var GlobalCache = new Class({
      * @since 3.0.0
      * 
      * @param {string} key - [description]
+     * 
      * @return {Phaser.Cache.BaseCache} [description]
      */
     addCustom: function (key)
diff --git a/v3/src/geom/circle/Area.js b/v3/src/geom/circle/Area.js
@@ -1,3 +1,12 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Geom.Circle.Area
+ * @since 3.0.0
+ *
+ * @param {Phaser.Geom.Circle} circle - The Circle to get the area of.
+ * @return {number} The area of the Circle.
+ */
 var Area = function (circle)
 {
     return (circle.radius > 0) ? Math.PI * circle.radius * circle.radius : 0;
diff --git a/v3/src/geom/circle/Circle.js b/v3/src/geom/circle/Circle.js
@@ -5,25 +5,80 @@ var Circle = new Class({
 
     initialize:
 
+    /**
+     * [description]
+     *
+     * @class Circle
+     * @memberOf Phaser.Geom
+     * @constructor
+     * @since 3.0.0
+     *
+     * @param {number} [x=0] - [description]
+     * @param {number} [y=0] - [description]
+     * @param {number} [radius=0] - [description]
+     */
     function Circle (x, y, radius)
     {
         if (x === undefined) { x = 0; }
         if (y === undefined) { y = 0; }
         if (radius === undefined) { radius = 0; }
 
+        /**
+         * [description]
+         *
+         * @property {number} x
+         */
         this.x = x;
 
+        /**
+         * [description]
+         *
+         * @property {number} y
+         */
         this.y = y;
 
+        /**
+         * [description]
+         *
+         * @property {number} _radius
+         * @private
+         */
         this._radius = radius;
+
+        /**
+         * [description]
+         *
+         * @property {number} _diameter
+         * @private
+         */
         this._diameter = radius * 2;
     },
 
+    /**
+     * [description]
+     *
+     * @method Phaser.Geom.Circle#getRandomPoint
+     *
+     * @param {Phaser.Geom.Point|object} point - [description]
+     *
+     * @return {Phaser.Geom.Point|object} [description]
+     */
     getRandomPoint: function (point)
     {
         return Random(this, point);
     },
 
+    /**
+     * [description]
+     *
+     * @method Phaser.Geom.Circle#setTo
+     *
+     * @param {number} x - [description]
+     * @param {number} y - [description]
+     * @param {number} radius - [description]
+     * 
+     * @return {Phaser.Geom.Circle} [description]
+     */
     setTo: function (x, y, radius)
     {
         this.x = x;
@@ -34,11 +89,28 @@ var Circle = new Class({
         return this;
     },
 
+    /**
+     * [description]
+     *
+     * @method Phaser.Geom.Circle#setEmpty
+     * 
+     * @return {Phaser.Geom.Circle} [description]
+     */
     setEmpty: function ()
     {
         return this.setTo(0, 0, 0);
     },
 
+    /**
+     * [description]
+     *
+     * @method Phaser.Geom.Circle#setPosition
+     *
+     * @param {number} x - [description]
+     * @param {number} [y=x] - [description]
+     * 
+     * @return {Phaser.Geom.Circle} [description]
+     */
     setPosition: function (x, y)
     {
         if (y === undefined) { y = x; }
@@ -49,11 +121,23 @@ var Circle = new Class({
         return this;
     },
 
+    /**
+     * [description]
+     *
+     * @method Phaser.Geom.Circle#isEmpty
+     *
+     * @return {boolean} [description]
+     */
     isEmpty: function ()
     {
         return (this._radius <= 0);
     },
 
+    /**
+     * [description]
+     *
+     * @property {number} radius
+     */
     radius: {
 
         get: function ()
@@ -69,6 +153,11 @@ var Circle = new Class({
 
     },
 
+    /**
+     * [description]
+     *
+     * @property {number} diameter
+     */
     diameter: {
 
         get: function ()
@@ -84,6 +173,11 @@ var Circle = new Class({
 
     },
 
+    /**
+     * [description]
+     *
+     * @property {number} left
+     */
     left: {
 
         get: function ()
@@ -98,6 +192,11 @@ var Circle = new Class({
 
     },
 
+    /**
+     * [description]
+     *
+     * @property {number} right
+     */
     right: {
 
         get: function ()
@@ -112,6 +211,11 @@ var Circle = new Class({
 
     },
 
+    /**
+     * [description]
+     *
+     * @property {number} top
+     */
     top: {
 
         get: function ()
@@ -126,6 +230,11 @@ var Circle = new Class({
 
     },
 
+    /**
+     * [description]
+     *
+     * @property {number} bottom
+     */
     bottom: {
 
         get: function ()
diff --git a/v3/src/geom/circle/Circumference.js b/v3/src/geom/circle/Circumference.js
@@ -1,3 +1,12 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Geom.Circle.Circumference
+ * @since 3.0.0
+ *
+ * @param {Phaser.Geom.Circle} circle - The Circle to get the circumference of.
+ * @return {number} The circumference of the Circle.
+ */
 var Circumference = function (circle)
 {
     return 2 * (Math.PI * circle.radius);
diff --git a/v3/src/geom/circle/CircumferencePoint.js b/v3/src/geom/circle/CircumferencePoint.js
@@ -1,9 +1,21 @@
+var Point = require('../point/Point');
+
+//  Returns a Point object containing the coordinates of a point on the circumference of the Circle based on the given angle.
+
 /**
-* Returns a Point object containing the coordinates of a point on the circumference of the Circle based on the given angle.
-*/
+ * [description]
+ *
+ * @function Phaser.Geom.Circle.CircumferencePoint
+ * @since 3.0.0
+ *
+ * @param {Phaser.Geom.Circle} circle - The Circle to get the circumference point on.
+ * @param {number} angle - [description]
+ * @param {Phaser.Geom.Point|object} out - [description]
+ * @return {Phaser.Geom.Point|object} [description]
+ */
 var CircumferencePoint = function (circle, angle, out)
 {
-    if (out === undefined) { out = { x: 0, y: 0 }; }
+    if (out === undefined) { out = new Point(); }
 
     out.x = circle.x + (circle.radius * Math.cos(angle));
     out.y = circle.y + (circle.radius * Math.sin(angle));
diff --git a/v3/src/geom/circle/Clone.js b/v3/src/geom/circle/Clone.js
@@ -1,5 +1,14 @@
 var Circle = require('./Circle');
 
+/**
+ * [description]
+ *
+ * @function Phaser.Geom.Circle.Clone
+ * @since 3.0.0
+ *
+ * @param {Phaser.Geom.Circle} source - The Circle to be cloned.
+ * @return {Phaser.Geom.Circle} A clone of the source Circle.
+ */
 var Clone = function (source)
 {
     return new Circle(source.x, source.y, source.radius);
diff --git a/v3/src/geom/circle/Contains.js b/v3/src/geom/circle/Contains.js
@@ -1,3 +1,14 @@
+/**
+ * [description]
+ *
+ * @function Phaser.Geom.Circle.Contains
+ * @since 3.0.0
+ *
+ * @param {Phaser.Geom.Circle} circle - [description]
+ * @param {number} x - [description]
+ * @param {number} y - [description]
+ * @return {boolean} [description]
+ */
 var Contains = function (circle, x, y)
 {
     //  Check if x/y are within the bounds first
diff --git a/v3/src/geom/circle/ContainsPoint.js b/v3/src/geom/circle/ContainsPoint.js
diff --git a/v3/src/geom/circle/ContainsRect.js b/v3/src/geom/circle/ContainsRect.js
diff --git a/v3/src/geom/circle/CopyFrom.js b/v3/src/geom/circle/CopyFrom.js
diff --git a/v3/src/geom/circle/Equals.js b/v3/src/geom/circle/Equals.js
diff --git a/v3/src/geom/circle/GetBounds.js b/v3/src/geom/circle/GetBounds.js
diff --git a/v3/src/geom/circle/Offset.js b/v3/src/geom/circle/Offset.js
diff --git a/v3/src/geom/circle/OffsetPoint.js b/v3/src/geom/circle/OffsetPoint.js
diff --git a/v3/src/geom/circle/Random.js b/v3/src/geom/circle/Random.js

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ var Event = require('../events/');`
`9`	`9`	`*`
`10`	`10`	`* @param {string} key - [description]`
`11`	`11`	`* @param {Phaser.Animations.Animation} animation - [description]`
	`12`	`+ *`
`12`	`13`	`* @return {Phaser.Animations.AnimationManager} The Animation Manager for method chaining.`
`13`	`14`	`*/`
`14`	`15`	`var AddAnimation = function (key, animation)`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ var Animation = require('../../frame/Animation');`
`9`	`9`	`* @since 3.0.0`
`10`	`10`	`*`
`11`	`11`	`* @param {object} config - [description]`
	`12`	`+ *`
`12`	`13`	`* @return {Phaser.Animations.Animation} The Animation that was created.`
`13`	`14`	`*/`
`14`	`15`	`var CreateFrameAnimation = function (config)`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`*`
`7`	`7`	`* @param {string\|object} data - [description]`
`8`	`8`	`* @param {boolean} [clearCurrentAnimations=false] - [description]`
	`9`	`+ *`
`9`	`10`	`* @return {array} An array containing all of the Animation objects that were created as a result of this call.`
`10`	`11`	`*/`
`11`	`12`	`var FromJSON = function (data, clearCurrentAnimations)`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`* @since 3.0.0`
`6`	`6`	`*`
`7`	`7`	`* @param {string} key - [description]`
	`8`	`+ *`
`8`	`9`	`* @return {Phaser.Animations.Animation} [description]`
`9`	`10`	`*/`
`10`	`11`	`var GetAnimation = function (key)`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`*`
`7`	`7`	`* @param {string} key - [description]`
`8`	`8`	`* @param {Phaser.GameObjects.GameObject} child - [description]`
	`9`	`+ *`
`9`	`10`	`* @return {Phaser.Animations.AnimationManager} The Animation Manager for method chaining.`
`10`	`11`	`*/`
`11`	`12`	`var PlayAnimation = function (key, child)`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ var Event = require('../events/');`
`8`	`8`	`* @since 3.0.0`
`9`	`9`	`*`
`10`	`10`	`* @param {string} key - [description]`
	`11`	`+ *`
`11`	`12`	`* @return {Phaser.Animations.Animation} [description]`
`12`	`13`	`*/`
`13`	`14`	`var RemoveAnimation = function (key)`