Skip to content

Commit 4270660

Browse files
author
Evan Cobb
committed
adding documentation to some files with only one [description] tag
1 parent 12d2751 commit 4270660

5 files changed

Lines changed: 8 additions & 5 deletions

File tree

src/actions/RotateAround.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ var RotateAroundDistance = require('../math/RotateAroundDistance');
88
var DistanceBetween = require('../math/distance/DistanceBetween');
99

1010
/**
11-
* [description]
11+
* Rotates each item around the given point by the given angle.
1212
*
1313
* @function Phaser.Actions.RotateAround
1414
* @since 3.0.0
15+
* @see Phaser.Math.RotateAroundDistance
1516
*
1617
* @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
1718
*

src/actions/Shuffle.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@
77
var ArrayShuffle = require('../utils/array/Shuffle');
88

99
/**
10-
* [description]
10+
* Shuffles the array in place. The shuffled array is both modified and returned.
1111
*
1212
* @function Phaser.Actions.Shuffle
1313
* @since 3.0.0
14+
* @see Phaser.Utils.Array.Shuffle
1415
*
1516
* @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
1617
*

src/boot/Game.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ var Game = new Class({
154154
this.cache = new CacheManager(this);
155155

156156
/**
157-
* [description]
157+
* An instance of the Data Manager
158158
*
159159
* @name Phaser.Game#registry
160160
* @type {Phaser.Data.DataManager}

src/dom/AddToDOM.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
*
1414
* @param {HTMLElement} element - The element to be added to the DOM. Usually a Canvas object.
1515
* @param {(string|HTMLElement)} [parent] - The parent in which to add the element. Can be a string which is passed to `getElementById` or an actual DOM object.
16-
* @param {boolean} [overflowHidden=true] - [description]
16+
* @param {boolean} [overflowHidden=true] - Whether or not to hide overflowing content inside the parent.
1717
*
1818
* @return {HTMLElement} The element that was added to the DOM.
1919
*/

src/gameobjects/GameObject.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,10 +195,11 @@ var GameObject = new Class({
195195
},
196196

197197
/**
198-
* [description]
198+
* Adds a DataManager to this object.
199199
*
200200
* @method Phaser.GameObjects.GameObject#setDataEnabled
201201
* @since 3.0.0
202+
* @see Phaser.Data.DataManager
202203
*
203204
* @return {Phaser.GameObjects.GameObject} This GameObject.
204205
*/

0 commit comments

Comments
 (0)