Skip to content

Commit 0b3d54a

Browse files
committed
Added jsdocs
1 parent 104eeab commit 0b3d54a

6 files changed

Lines changed: 17 additions & 13 deletions

File tree

src/dom/ScaleManager.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ var Rectangle = require('../geom/rectangle/Rectangle');
1212

1313
/**
1414
* @classdesc
15-
* [description]
15+
* TODO
1616
*
1717
* @class ScaleManager
1818
* @memberof Phaser.DOM

src/dom/_ScaleManager.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ var VisualBounds = require('./VisualBounds');
1717

1818
/**
1919
* @classdesc
20-
* [description]
20+
* TODO
2121
*
2222
* @class ScaleManager
2323
* @memberof Phaser.DOM

src/gameobjects/graphics/Graphics.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1013,7 +1013,7 @@ var Graphics = new Class({
10131013
* @param {number} x - The x coordinate to draw the line to.
10141014
* @param {number} y - The y coordinate to draw the line to.
10151015
* @param {number} width - The width of the stroke.
1016-
* @param {number} rgb - [description]
1016+
* @param {number} rgb - The color of the stroke.
10171017
*
10181018
* @return {Phaser.GameObjects.Graphics} This Game Object.
10191019
*/
@@ -1036,7 +1036,7 @@ var Graphics = new Class({
10361036
* @param {number} x - The x coordinate to move to.
10371037
* @param {number} y - The y coordinate to move to.
10381038
* @param {number} width - The new stroke width.
1039-
* @param {number} rgb - [description]
1039+
* @param {number} rgb - The new stroke color.
10401040
*
10411041
* @return {Phaser.GameObjects.Graphics} This Game Object.
10421042
*/

src/gameobjects/particles/EmitterOp.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,14 @@ var Wrap = require('../../math/Wrap');
7878
/**
7979
* @typedef {object} EmitterOpCustomEmitConfig
8080
*
81-
* @property {EmitterOpOnEmitCallback} onEmit - [description]
81+
* @property {EmitterOpOnEmitCallback} onEmit - A callback that is invoked each time the emitter emits a particle.
8282
*/
8383

8484
/**
8585
* @typedef {object} EmitterOpCustomUpdateConfig
8686
*
87-
* @property {EmitterOpOnEmitCallback} [onEmit] - [description]
88-
* @property {EmitterOpOnUpdateCallback} onUpdate - [description]
87+
* @property {EmitterOpOnEmitCallback} [onEmit] - A callback that is invoked each time the emitter emits a particle.
88+
* @property {EmitterOpOnUpdateCallback} onUpdate - A callback that is invoked each time the emitter updates.
8989
*/
9090

9191
/**

src/gameobjects/particles/GravityWell.js

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@ var GetFastValue = require('../../utils/object/GetFastValue');
1919

2020
/**
2121
* @classdesc
22-
* [description]
22+
* The GravityWell action applies a force on the particle to draw it towards, or repel it from, a single point.
23+
*
24+
* The force applied is inversely proportional to the square of the distance from the particle to the point, in accordance with Newton's law of gravity.
25+
*
26+
* This simulates the effect of gravity over large distances (as between planets, for example).
2327
*
2428
* @class GravityWell
2529
* @memberof Phaser.GameObjects.Particles
@@ -28,8 +32,8 @@ var GetFastValue = require('../../utils/object/GetFastValue');
2832
*
2933
* @param {(number|GravityWellConfig)} [x=0] - The x coordinate of the Gravity Well, in world space.
3034
* @param {number} [y=0] - The y coordinate of the Gravity Well, in world space.
31-
* @param {number} [power=0] - The power of the Gravity Well.
32-
* @param {number} [epsilon=100] - [description]
35+
* @param {number} [power=0] - The strength of the gravity force - larger numbers produce a stronger force.
36+
* @param {number} [epsilon=100] - The minimum distance for which the gravity force is calculated.
3337
* @param {number} [gravity=50] - The gravitational force of this Gravity Well.
3438
*/
3539
var GravityWell = new Class({
@@ -118,7 +122,7 @@ var GravityWell = new Class({
118122
this._epsilon = 0;
119123

120124
/**
121-
* The power of the Gravity Well.
125+
* The strength of the gravity force - larger numbers produce a stronger force.
122126
*
123127
* @name Phaser.GameObjects.Particles.GravityWell#power
124128
* @type {number}
@@ -127,7 +131,7 @@ var GravityWell = new Class({
127131
this.power = power;
128132

129133
/**
130-
* [description]
134+
* The minimum distance for which the gravity force is calculated.
131135
*
132136
* @name Phaser.GameObjects.Particles.GravityWell#epsilon
133137
* @type {number}

src/physics/arcade/tilemap/SeparateTile.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ var TileIntersectsBody = require('./TileIntersectsBody');
1717
* @param {number} i - The index of the tile within the map data.
1818
* @param {Phaser.Physics.Arcade.Body} body - The Body object to separate.
1919
* @param {Phaser.Tilemaps.Tile} tile - The tile to collide against.
20-
* @param {Phaser.Geom.Rectangle} tileWorldRect - [description]
20+
* @param {Phaser.Geom.Rectangle} tileWorldRect - A rectangle-like object defining the dimensions of the tile.
2121
* @param {(Phaser.Tilemaps.DynamicTilemapLayer|Phaser.Tilemaps.StaticTilemapLayer)} tilemapLayer - The tilemapLayer to collide against.
2222
* @param {number} tileBias - The tile bias value. Populated by the `World.TILE_BIAS` constant.
2323
*

0 commit comments

Comments
 (0)