Skip to content

Commit ed4cc55

Browse files
committed
JSDoc blocks added.
1 parent c9aefda commit ed4cc55

5 files changed

Lines changed: 43 additions & 2 deletions

File tree

v3/src/animations/frame/inc/AddFrame.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@
44
// ]
55

66
// Add frames to the end of the animation
7+
8+
/**
9+
* [description]
10+
*
11+
* @method Phaser.Animations.Animation#addFrame
12+
* @since 3.0.0
13+
*
14+
* @param {[type]} config - [description]
15+
*
16+
* @return {Phaser.Animations.Animation} [description]
17+
*/
718
var AddFrame = function (config)
819
{
920
return this.addFrameAt(this.frames.length, config);

v3/src/animations/frame/inc/AddFrameAt.js

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,20 @@ var GetFrames = require('./GetFrames');
66
// ]
77

88
// Add frame/s into the animation
9+
10+
/**
11+
* [description]
12+
*
13+
* @method Phaser.Animations.Animation#addFrameAt
14+
* @since 3.0.0
15+
*
16+
* @param {integer} index - [description]
17+
* @param {[type]} config - [description]
18+
*
19+
* @return {Phaser.Animations.Animation} [description]
20+
*/
921
var AddFrameAt = function (index, config)
1022
{
11-
if (index === undefined) { index = 0; }
12-
1323
var newFrames = GetFrames(this.manager.textureManager, config);
1424

1525
if (newFrames.length > 0)

v3/src/animations/frame/inc/CheckFrame.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
/**
2+
* [description]
3+
*
4+
* @method Phaser.Animations.Animation#checkFrame
5+
* @since 3.0.0
6+
*
7+
* @param {integer} index - [description]
8+
*
9+
* @return {boolean} [description]
10+
*/
111
var CheckFrame = function (index)
212
{
313
return (index < this.frames.length);

v3/src/animations/frame/inc/CompleteAnimation.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
/**
2+
* [description]
3+
*
4+
* @method Phaser.Animations.Animation#completeAnimation
5+
* @since 3.0.0
6+
*
7+
* @param {Phaser.GameObjects.Components.Animation} component - [description]
8+
*/
19
var CompleteAnimation = function (component)
210
{
311
if (this.hideOnComplete)

v3/src/gameobjects/components/Animation.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ var Components = require('./animation/');
44

55
// Game Object Animation Controller
66

7+
// Phaser.GameObjects.Components.Animation
8+
79
var Animation = new Class({
810

911
initialize:

0 commit comments

Comments
 (0)