Skip to content

Commit 203a0ee

Browse files
committed
Added jsdocs
1 parent ee281f9 commit 203a0ee

14 files changed

Lines changed: 68 additions & 28 deletions

File tree

src/math/CeilTo.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
*
77
* @param {number} value - [description]
88
* @param {number} [place=0] - [description]
9-
* @param {integer]} [base=10] - [description]
9+
* @param {integer} [base=10] - [description]
1010
*
1111
* @return {number} [description]
1212
*/

src/math/Vector2.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@
33

44
var Class = require('../utils/Class');
55

6+
/**
7+
* [description]
8+
*
9+
* @class Vector2
10+
* @memberOf Phaser.Math
11+
* @constructor
12+
* @since 3.0.0
13+
*
14+
* @param {number} [x] - [description]
15+
* @param {number} [y] - [description]
16+
*/
617
var Vector2 = new Class({
718

819
initialize:
920

10-
/**
11-
* [description]
12-
*
13-
* @class Vector2
14-
* @memberOf Phaser.Math
15-
* @constructor
16-
* @since 3.0.0
17-
*
18-
* @param {number} [x] - [description]
19-
* @param {number} [y] - [description]
20-
*/
2121
function Vector2 (x, y)
2222
{
2323
if (typeof x === 'object')

src/math/angle/index.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/**
2+
* @namespace Phaser.Math.Angle
3+
*/
4+
15
module.exports = {
26

37
Between: require('./Between'),

src/math/distance/index.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
// Phaser.Math.Distance
1+
/**
2+
* @namespace Phaser.Math.Distance
3+
*/
24

35
module.exports = {
46

src/math/easing/index.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
// Phaser.Math.Easing
1+
/**
2+
* @namespace Phaser.Math.Easing
3+
*/
24

35
module.exports = {
46

src/math/fuzzy/index.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/**
2+
* @namespace Phaser.Math.Fuzzy
3+
*/
4+
15
module.exports = {
26

37
Ceil: require('./Ceil'),

src/math/interpolation/index.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
// Phaser.Math.Interpolation
1+
/**
2+
* @namespace Phaser.Math.Interpolation
3+
*/
24

35
module.exports = {
46

src/math/pow2/index.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/**
2+
* @namespace Phaser.Math.Pow2
3+
*/
4+
15
module.exports = {
26

37
GetNext: require('./GetPowerOfTwo'),

src/math/random-data-generator/RandomDataGenerator.js

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
11
var Class = require('../../utils/Class');
22

3+
/**
4+
* [description]
5+
*
6+
* @class RandomDataGenerator
7+
* @memberOf Phaser.Math
8+
* @constructor
9+
* @since 3.0.0
10+
*
11+
* @param {array} [seeds] - [description]
12+
*/
313
var RandomDataGenerator = new Class({
414

515
initialize:
616

7-
/**
8-
* [description]
9-
*
10-
* @class RandomDataGenerator
11-
* @memberOf Phaser.Math
12-
* @constructor
13-
* @since 3.0.0
14-
*
15-
* @param {array} [seeds] - [description]
16-
*/
1717
function RandomDataGenerator (seeds)
1818
{
1919
/**
2020
* Internal var.
2121
*
2222
* @property {number} c
23+
* @alias Phaser.Math.RandomDataGenerator#c
2324
* @private
2425
* @default 1
2526
* @since 3.0.0
@@ -30,6 +31,7 @@ var RandomDataGenerator = new Class({
3031
* Internal var.
3132
*
3233
* @property {number} s0
34+
* @alias Phaser.Math.RandomDataGenerator#s0
3335
* @private
3436
* @default 0
3537
* @since 3.0.0
@@ -40,6 +42,7 @@ var RandomDataGenerator = new Class({
4042
* Internal var.
4143
*
4244
* @property {number} s1
45+
* @alias Phaser.Math.RandomDataGenerator#s1
4346
* @private
4447
* @default 0
4548
* @since 3.0.0
@@ -50,6 +53,7 @@ var RandomDataGenerator = new Class({
5053
* Internal var.
5154
*
5255
* @property {number} s2
56+
* @alias Phaser.Math.RandomDataGenerator#s2
5357
* @private
5458
* @default 0
5559
* @since 3.0.0
@@ -60,6 +64,7 @@ var RandomDataGenerator = new Class({
6064
* [description]
6165
*
6266
* @property {array} sign
67+
* @alias Phaser.Math.RandomDataGenerator#sign
6368
* @since 3.0.0
6469
*/
6570
this.sign = [ -1, 1 ];

src/math/snap/index.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/**
2+
* @namespace Phaser.Math.Snap
3+
*/
4+
15
module.exports = {
26

37
Ceil: require('./SnapCeil'),

0 commit comments

Comments
 (0)