diff --git a/v3/src/animations/frame/inc/GetFirstTick.js b/v3/src/animations/frame/inc/GetFirstTick.js index 0a9c8b3e7..aa1ba5ffc 100644 --- a/v3/src/animations/frame/inc/GetFirstTick.js +++ b/v3/src/animations/frame/inc/GetFirstTick.js @@ -1,3 +1,12 @@ +/** + * [description] + * + * @method Phaser.Animations.Animation#getFirstTick + * @since 3.0.0 + * + * @param {Phaser.GameObjects.Components.Animation} component - [description] + * @param {boolean} [includeDelay=true] - [description] + */ var GetFirstTick = function (component, includeDelay) { if (includeDelay === undefined) { includeDelay = true; } diff --git a/v3/src/animations/frame/inc/GetFrameAt.js b/v3/src/animations/frame/inc/GetFrameAt.js index ea1e770fd..abc446af0 100644 --- a/v3/src/animations/frame/inc/GetFrameAt.js +++ b/v3/src/animations/frame/inc/GetFrameAt.js @@ -1,3 +1,13 @@ +/** + * [description] + * + * @method Phaser.Animations.Animation#getFrameAt + * @since 3.0.0 + * + * @param {integer} index - [description] + * + * @return {Phaser.Animations.AnimationFrame} [description] + */ var GetFrameAt = function (index) { return this.frames[index]; diff --git a/v3/src/animations/frame/inc/GetFrames.js b/v3/src/animations/frame/inc/GetFrames.js index b5a643f77..a1df419e1 100644 --- a/v3/src/animations/frame/inc/GetFrames.js +++ b/v3/src/animations/frame/inc/GetFrames.js @@ -1,6 +1,17 @@ var Frame = require('../AnimationFrame'); var GetValue = require('../../../utils/object/GetValue'); +/** + * [description] + * + * @method Phaser.Animations.Animation#getFrames + * @since 3.0.0 + * + * @param {[type]} textureManager - [description] + * @param {[type]} frames - [description] + * + * @return {Phaser.Animations.AnimationFrame[]} [description] + */ var GetFrames = function (textureManager, frames) { // frames: [ diff --git a/v3/src/animations/frame/inc/GetNextTick.js b/v3/src/animations/frame/inc/GetNextTick.js index 69eda897a..b14e899de 100644 --- a/v3/src/animations/frame/inc/GetNextTick.js +++ b/v3/src/animations/frame/inc/GetNextTick.js @@ -1,3 +1,11 @@ +/** + * [description] + * + * @method Phaser.Animations.Animation#getNextTick + * @since 3.0.0 + * + * @param {Phaser.GameObjects.Components.Animation} component - [description] + */ var GetNextTick = function (component) { // accumulator += delta * _timeScale diff --git a/v3/src/animations/frame/inc/Load.js b/v3/src/animations/frame/inc/Load.js index 861e4fe02..71fd9e0f9 100644 --- a/v3/src/animations/frame/inc/Load.js +++ b/v3/src/animations/frame/inc/Load.js @@ -1,3 +1,12 @@ +/** + * [description] + * + * @method Phaser.Animations.Animation#load + * @since 3.0.0 + * + * @param {Phaser.GameObjects.Components.Animation} component - [description] + * @param {integer} startFrame - [description] + */ var Load = function (component, startFrame) { if (startFrame >= this.frames.length) diff --git a/v3/src/animations/frame/inc/NextFrame.js b/v3/src/animations/frame/inc/NextFrame.js index a11169e1a..7846c406f 100644 --- a/v3/src/animations/frame/inc/NextFrame.js +++ b/v3/src/animations/frame/inc/NextFrame.js @@ -1,3 +1,11 @@ +/** + * [description] + * + * @method Phaser.Animations.Animation#nextFrame + * @since 3.0.0 + * + * @param {Phaser.GameObjects.Components.Animation} component - [description] + */ var NextFrame = function (component) { var frame = component.currentFrame; diff --git a/v3/src/animations/frame/inc/PreviousFrame.js b/v3/src/animations/frame/inc/PreviousFrame.js index 62e906120..72cb2ced6 100644 --- a/v3/src/animations/frame/inc/PreviousFrame.js +++ b/v3/src/animations/frame/inc/PreviousFrame.js @@ -1,3 +1,11 @@ +/** + * [description] + * + * @method Phaser.Animations.Animation#previousFrame + * @since 3.0.0 + * + * @param {Phaser.GameObjects.Components.Animation} component - [description] + */ var PreviousFrame = function (component) { var frame = component.currentFrame; diff --git a/v3/src/animations/frame/inc/RemoveFrame.js b/v3/src/animations/frame/inc/RemoveFrame.js index d8d50ff2c..84a2a9a4c 100644 --- a/v3/src/animations/frame/inc/RemoveFrame.js +++ b/v3/src/animations/frame/inc/RemoveFrame.js @@ -1,4 +1,14 @@ // Remove frame if it matches the given frame +/** + * [description] + * + * @method Phaser.Animations.Animation#removeFrame + * @since 3.0.0 + * + * @param {Phaser.Animations.AnimationFrame} frame - [description] + * + * @return {Phaser.Animations.Animation} [description] + */ var RemoveFrame = function (frame) { var index = this.frames.indexOf(frame); diff --git a/v3/src/animations/frame/inc/RemoveFrameAt.js b/v3/src/animations/frame/inc/RemoveFrameAt.js index a3d8cc122..48d77b984 100644 --- a/v3/src/animations/frame/inc/RemoveFrameAt.js +++ b/v3/src/animations/frame/inc/RemoveFrameAt.js @@ -1,3 +1,13 @@ +/** + * [description] + * + * @method Phaser.Animations.Animation#removeFrameAt + * @since 3.0.0 + * + * @param {integer} index - [description] + * + * @return {Phaser.Animations.Animation} [description] + */ var RemoveFrameAt = function (index) { this.frames.splice(index, 1); diff --git a/v3/src/animations/frame/inc/RepeatAnimation.js b/v3/src/animations/frame/inc/RepeatAnimation.js index 1863d081f..c08f5c0bf 100644 --- a/v3/src/animations/frame/inc/RepeatAnimation.js +++ b/v3/src/animations/frame/inc/RepeatAnimation.js @@ -1,3 +1,11 @@ +/** + * [description] + * + * @method Phaser.Animations.Animation#repeatAnimation + * @since 3.0.0 + * + * @param {Phaser.GameObjects.Components.Animation} component - [description] + */ var RepeatAnimation = function (component) { if (component._repeatDelay > 0 && component.pendingRepeat === false) diff --git a/v3/src/animations/frame/inc/SetFrame.js b/v3/src/animations/frame/inc/SetFrame.js index bb1701cef..e6e22c035 100644 --- a/v3/src/animations/frame/inc/SetFrame.js +++ b/v3/src/animations/frame/inc/SetFrame.js @@ -1,3 +1,11 @@ +/** + * [description] + * + * @method Phaser.Animations.Animation#setFrame + * @since 3.0.0 + * + * @param {Phaser.GameObjects.Components.Animation} component - [description] + */ var SetFrame = function (component) { // Work out which frame should be set next on the child, and set it diff --git a/v3/src/animations/frame/inc/ToJSON.js b/v3/src/animations/frame/inc/ToJSON.js index 98beda106..70fc881d3 100644 --- a/v3/src/animations/frame/inc/ToJSON.js +++ b/v3/src/animations/frame/inc/ToJSON.js @@ -1,3 +1,11 @@ +/** + * [description] + * + * @method Phaser.Animations.Animation#toJSON + * @since 3.0.0 + * + * @return {object} [description] + */ var ToJSON = function () { var output = { diff --git a/v3/src/animations/frame/inc/UpdateFrameSequence.js b/v3/src/animations/frame/inc/UpdateFrameSequence.js index 2a001962b..d6404ef17 100644 --- a/v3/src/animations/frame/inc/UpdateFrameSequence.js +++ b/v3/src/animations/frame/inc/UpdateFrameSequence.js @@ -1,3 +1,11 @@ +/** + * [description] + * + * @method Phaser.Animations.Animation#updateFrameSequence + * @since 3.0.0 + * + * @return {Phaser.Animations.Animation} [description] + */ var UpdateFrameSequence = function () { var len = this.frames.length; diff --git a/v3/src/animations/manager/inc/FromJSON.js b/v3/src/animations/manager/inc/FromJSON.js index c08f254e2..a1a671ed1 100644 --- a/v3/src/animations/manager/inc/FromJSON.js +++ b/v3/src/animations/manager/inc/FromJSON.js @@ -7,7 +7,7 @@ * @param {string|object} data - [description] * @param {boolean} [clearCurrentAnimations=false] - [description] * - * @return {array} An array containing all of the Animation objects that were created as a result of this call. + * @return {Phaser.Animations.Animation[]} An array containing all of the Animation objects that were created as a result of this call. */ var FromJSON = function (data, clearCurrentAnimations) { diff --git a/v3/src/animations/manager/inc/GenerateFrameNames.js b/v3/src/animations/manager/inc/GenerateFrameNames.js index f23fe4752..bae28ac69 100644 --- a/v3/src/animations/manager/inc/GenerateFrameNames.js +++ b/v3/src/animations/manager/inc/GenerateFrameNames.js @@ -17,7 +17,7 @@ var Pad = require('../../../utils/string/Pad'); * @param {array} [config.outputArray=[]] - [description] * @param {boolean} [config.frames=false] - [description] * - * @return {array} [description] + * @return {object[]} [description] */ var GenerateFrameNames = function (key, config) { diff --git a/v3/src/animations/manager/inc/GenerateFrameNumbers.js b/v3/src/animations/manager/inc/GenerateFrameNumbers.js index 84820621d..f36ed2c32 100644 --- a/v3/src/animations/manager/inc/GenerateFrameNumbers.js +++ b/v3/src/animations/manager/inc/GenerateFrameNumbers.js @@ -14,7 +14,7 @@ var GetValue = require('../../../utils/object/GetValue'); * @param {array} [config.outputArray=[]] - [description] * @param {boolean} [config.frames=false] - [description] * - * @return {array} [description] + * @return {object[]} [description] */ var GenerateFrameNumbers = function (key, config) {