Skip to content

Commit 23f2016

Browse files
committed
JSDocs added.
1 parent c22668d commit 23f2016

146 files changed

Lines changed: 1561 additions & 68 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

v3/src/geom/circle/Area.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
* @since 3.0.0
66
*
77
* @param {Phaser.Geom.Circle} circle - The Circle to get the area of.
8+
*
89
* @return {number} The area of the Circle.
910
*/
1011
var Area = function (circle)

v3/src/geom/circle/Circumference.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
* @since 3.0.0
66
*
77
* @param {Phaser.Geom.Circle} circle - The Circle to get the circumference of.
8+
*
89
* @return {number} The circumference of the Circle.
910
*/
1011
var Circumference = function (circle)

v3/src/geom/circle/CircumferencePoint.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ var Point = require('../point/Point');
1010
*
1111
* @param {Phaser.Geom.Circle} circle - The Circle to get the circumference point on.
1212
* @param {number} angle - [description]
13-
* @param {Phaser.Geom.Point|object} out - [description]
13+
* @param {Phaser.Geom.Point|object} [out] - [description]
14+
*
1415
* @return {Phaser.Geom.Point|object} [description]
1516
*/
1617
var CircumferencePoint = function (circle, angle, out)

v3/src/geom/circle/Clone.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ var Circle = require('./Circle');
77
* @since 3.0.0
88
*
99
* @param {Phaser.Geom.Circle} source - The Circle to be cloned.
10+
*
1011
* @return {Phaser.Geom.Circle} A clone of the source Circle.
1112
*/
1213
var Clone = function (source)

v3/src/geom/circle/Contains.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
* @param {Phaser.Geom.Circle} circle - [description]
88
* @param {number} x - [description]
99
* @param {number} y - [description]
10+
*
1011
* @return {boolean} [description]
1112
*/
1213
var Contains = function (circle, x, y)

v3/src/geom/circle/ContainsPoint.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ var Contains = require('./Contains');
88
*
99
* @param {Phaser.Geom.Circle} circle - [description]
1010
* @param {Phaser.Geom.Point|object} point - [description]
11+
*
1112
* @return {boolean} [description]
1213
*/
1314
var ContainsPoint = function (circle, point)

v3/src/geom/circle/ContainsRect.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ var Contains = require('./Contains');
88
*
99
* @param {Phaser.Geom.Circle} circle - [description]
1010
* @param {Phaser.Geom.Rectangle|object} rect - [description]
11+
*
1112
* @return {boolean} [description]
1213
*/
1314
var ContainsRect = function (circle, rect)

v3/src/geom/circle/CopyFrom.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
*
88
* @param {Phaser.Geom.Circle} source - The source Circle to copy the values from.
99
* @param {Phaser.Geom.Circle} dest - The destination Circle to copy the values in to.
10+
*
1011
* @return {Phaser.Geom.Circle} The dest Circle.
1112
*/
1213
var CopyFrom = function (source, dest)

v3/src/geom/circle/Equals.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
*
88
* @param {Phaser.Geom.Circle} circle - The first Circle to compare.
99
* @param {Phaser.Geom.Circle} toCompare - The second Circle to compare.
10+
*
1011
* @return {boolean} `true` if the two Circles equal each other, otherwise `false`.
1112
*/
1213
var Equals = function (circle, toCompare)

v3/src/geom/circle/GetBounds.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ var Rectangle = require('../rectangle/Rectangle');
88
*
99
* @param {Phaser.Geom.Circle} circle - [description]
1010
* @param {Phaser.Geom.Rectangle|object} [out] - [description]
11+
*
1112
* @return {Phaser.Geom.Rectangle|object} [description]
1213
*/
1314
var GetBounds = function (circle, out)

0 commit comments

Comments
 (0)