Skip to content

Commit e5b35c0

Browse files
committed
JSDocs added.
1 parent 8ddef7a commit e5b35c0

12 files changed

Lines changed: 68 additions & 3 deletions

File tree

v3/src/dom/AddToDOM.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
/**
2+
* [description]
3+
*
4+
* @function Phaser.Dom.AddToDOM
5+
* @since 3.0.0
6+
*
7+
* @param {any} element - [description]
8+
* @param {any} parent - [description]
9+
* @param {boolean} [overflowHidden=true] - [description]
10+
*
11+
* @return {any} [description]
12+
*/
113
var AddToDOM = function (element, parent, overflowHidden)
214
{
315
if (overflowHidden === undefined) { overflowHidden = true; }

v3/src/dom/DOMContentLoaded.js

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,21 @@ var OS = require('../device/OS');
22

33
var isBooted = false;
44

5+
/**
6+
* [description]
7+
*
8+
* @function Phaser.Dom.DOMContentLoaded
9+
* @since 3.0.0
10+
*
11+
* @param {function} callback - The callback to be invoked when the device is ready and the DOM content is loaded.
12+
*
13+
* @return {boolean} Returns `false` if the document is already loaded, otherwise `true` if the callback is pending.
14+
*/
515
var DOMContentLoaded = function (callback)
616
{
717
if (isBooted)
818
{
9-
return;
19+
return false;
1020
}
1121

1222
if (document.readyState === 'complete' || document.readyState === 'interactive')
@@ -15,7 +25,7 @@ var DOMContentLoaded = function (callback)
1525

1626
callback();
1727

18-
return;
28+
return true;
1929
}
2030

2131
var check = function ()
@@ -43,6 +53,8 @@ var DOMContentLoaded = function (callback)
4353
document.addEventListener('DOMContentLoaded', check, true);
4454
window.addEventListener('load', check, true);
4555
}
56+
57+
return true;
4658
};
4759

4860
module.exports = DOMContentLoaded;

v3/src/dom/ParseXML.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
/**
2+
* [description]
3+
*
4+
* @function Phaser.Dom.ParseXML
5+
* @since 3.0.0
6+
*
7+
* @param {string} data - The XML source stored in a string.
8+
*
9+
* @return {any} [description]
10+
*/
111
var ParseXML = function (data)
212
{
313
var xml = '';

v3/src/dom/RemoveFromDOM.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
/**
2+
* [description]
3+
*
4+
* @function Phaser.Dom.RemoveFromDOM
5+
* @since 3.0.0
6+
*
7+
* @param {any} element - [description]
8+
*/
19
var RemoveFromDOM = function (element)
210
{
311
if (element.parentNode)

v3/src/tween/builder/NumberTweenBuilder.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ var GetValueOp = require('./GetValueOp');
88
var Tween = require('../tween/Tween');
99
var TweenData = require('../tween/TweenData');
1010

11+
// Phaser.Tweens.NumberTweenBuilder
12+
1113
var NumberTweenBuilder = function (parent, config, defaults)
1214
{
1315
if (defaults === undefined)

v3/src/tween/builder/TimelineBuilder.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ var GetAdvancedValue = require('../../utils/object/GetAdvancedValue');
1010
var Timeline = require('../timeline/Timeline');
1111
var TweenBuilder = require('./TweenBuilder');
1212

13+
// Phaser.Tweens.TimelineBuilder
14+
1315
var TimelineBuilder = function (manager, config)
1416
{
1517
var timeline = new Timeline(manager);

v3/src/tween/builder/TweenBuilder.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ var GetValueOp = require('./GetValueOp');
1010
var Tween = require('../tween/Tween');
1111
var TweenData = require('../tween/TweenData');
1212

13+
// Phaser.Tweens.TweenBuilder
14+
1315
var TweenBuilder = function (parent, config, defaults)
1416
{
1517
if (defaults === undefined)

v3/src/tween/index.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Phaser.Tweens
2+
3+
module.exports = {
4+
5+
TweenManager: require('./manager/TweenManager'),
6+
Tween: require('./tween/Tween'),
7+
TweenData: require('./tween/TweenData'),
8+
Timeline: require('./timeline/Timeline')
9+
10+
};

v3/src/tween/manager/TweenManager.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
21
var Class = require('../../utils/Class');
32
var TimelineBuilder = require('../builder/TimelineBuilder');
43
var TweenBuilder = require('../builder/TweenBuilder');
54
var NumberTweenBuilder = require('../builder/NumberTweenBuilder');
65
var TWEEN_CONST = require('../tween/const');
76

7+
// Phaser.Tweens.TweenManager
8+
89
var TweenManager = new Class({
910

1011
initialize:

v3/src/tween/timeline/Timeline.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ var Class = require('../../utils/Class');
22
var TweenBuilder = require('../builder/TweenBuilder');
33
var TWEEN_CONST = require('../tween/const');
44

5+
// Phaser.Tweens.Timeline
6+
57
var Timeline = new Class({
68

79
initialize:

0 commit comments

Comments
 (0)