Updated jsdocs.

Author: photonstorm

src/animations/Animation.js

@@ -1,66 +1,72 @@
 var Class = require('../utils/Class');
 
+/**
+ * @classdesc
+ * A single frame in an Animation sequence.
+ *
+ * An AnimationFrame consists of a reference to the Texture it uses for rendering, references to other
+ * frames in the animation, and index data. It also has the ability to fire its own `onUpdate` callback
+ * and modify the animation timing.
+ *
+ * AnimationFrames are generated automatically by the Animation class.
+ *
+ * @class AnimationFrame
+ * @memberOf Phaser.Animations
+ * @constructor
+ * @since 3.0.0
+ *
+ * @param {string} textureKey - The key of the Texture this AnimationFrame uses.
+ * @param {string|integer} textureFrame - The key of the Frame within the Texture that this AnimationFrame uses.
+ * @param {integer} index - The index of this AnimationFrame within the Animation sequence.
+ * @param {Phaser.Textures.Frame} frame - A reference to the Texture Frame this AnimationFrame uses for rendering.
+ */
 var AnimationFrame = new Class({
 
     initialize:
 
-    /**
-     * A single frame in an Animation sequence.
-     *
-     * An AnimationFrame consists of a reference to the Texture it uses for rendering, references to other
-     * frames in the animation, and index data. It also has the ability to fire its own `onUpdate` callback
-     * and modify the animation timing.
-     *
-     * AnimationFrames are generated automatically by the Animation class.
-     *
-     * @class AnimationFrame
-     * @memberOf Phaser.Animations
-     * @constructor
-     * @since 3.0.0
-     *
-     * @param {string} textureKey - The key of the Texture this AnimationFrame uses.
-     * @param {string|integer} textureFrame - The key of the Frame within the Texture that this AnimationFrame uses.
-     * @param {integer} index - The index of this AnimationFrame within the Animation sequence.
-     * @param {Phaser.Textures.Frame} frame - A reference to the Texture Frame this AnimationFrame uses for rendering.
-     */
     function AnimationFrame (textureKey, textureFrame, index, frame)
     {
         /**
          * The key of the Texture this AnimationFrame uses.
          *
-         * @property {string} textureKey
+         * @name Phaser.Animations.AnimationFrame#textureKey
+         * @type {string}
          * @since 3.0.0
          */
         this.textureKey = textureKey;
 
         /**
          * The key of the Frame within the Texture that this AnimationFrame uses.
          *
-         * @property {string|integer} textureFrame
+         * @name Phaser.Animations.AnimationFrame#textureFrame
+         * @type {string|integer}
          * @since 3.0.0
          */
         this.textureFrame = textureFrame;
 
         /**
          * The index of this AnimationFrame within the Animation sequence.
          *
-         * @property {integer} index
+         * @name Phaser.Animations.AnimationFrame#index
+         * @type {integer}
          * @since 3.0.0
          */
         this.index = index;
 
         /**
          * A reference to the Texture Frame this AnimationFrame uses for rendering.
          *
-         * @property {Phaser.Textures.Frame} frame
+         * @name Phaser.Animations.AnimationFrame#frame
+         * @type {Phaser.Textures.Frame}
          * @since 3.0.0
          */
         this.frame = frame;
 
         /**
          * Is this the first frame in an animation sequence?
          *
-         * @property {boolean} isFirst
+         * @name Phaser.Animations.AnimationFrame#isFirst
+         * @type {boolean}
          * @default false
          * @readOnly
          * @since 3.0.0
@@ -70,7 +76,8 @@ var AnimationFrame = new Class({
         /**
          * Is this the last frame in an animation sequence?
          *
-         * @property {boolean} isLast
+         * @name Phaser.Animations.AnimationFrame#isLast
+         * @type {boolean}
          * @default false
          * @readOnly
          * @since 3.0.0
@@ -80,7 +87,8 @@ var AnimationFrame = new Class({
         /**
          * A reference to the AnimationFrame that comes before this one in the animation, if any.
          *
-         * @property {?Phaser.Animations.AnimationFrame} prevFrame
+         * @name Phaser.Animations.AnimationFrame#prevFrame
+         * @type {?Phaser.Animations.AnimationFrame}
          * @default null
          * @readOnly
          * @since 3.0.0
@@ -90,7 +98,8 @@ var AnimationFrame = new Class({
         /**
          * A reference to the AnimationFrame that comes after this one in the animation, if any.
          *
-         * @property {?Phaser.Animations.AnimationFrame} nextFrame
+         * @name Phaser.Animations.AnimationFrame#nextFrame
+         * @type {?Phaser.Animations.AnimationFrame}
          * @default null
          * @readOnly
          * @since 3.0.0
@@ -101,7 +110,8 @@ var AnimationFrame = new Class({
          * Additional time (in ms) that this frame should appear for during playback.
          * The value is added onto the msPerFrame set by the animation.
          *
-         * @property {number} duration
+         * @name Phaser.Animations.AnimationFrame#duration
+         * @type {number}
          * @default 0
          * @since 3.0.0
          */
@@ -111,7 +121,8 @@ var AnimationFrame = new Class({
          * What % through the animation does this frame come?
          * This value is generated when the animation is created and cached here.
          *
-         * @property {number} progress
+         * @name Phaser.Animations.AnimationFrame#progress
+         * @type {number}
          * @default 0
          * @readOnly
          * @since 3.0.0
@@ -121,7 +132,8 @@ var AnimationFrame = new Class({
         /**
          * A frame specific callback, invoked if this frame gets displayed and the callback is set.
          *
-         * @property {?function} onUpdate
+         * @name Phaser.Animations.AnimationFrame#onUpdate
+         * @type {?function}
          * @default null
          * @since 3.0.0
          */

src/animations/AnimationFrame.js

@@ -5,69 +5,90 @@ var EventEmitter = require('eventemitter3');
 var GetValue = require('../utils/object/GetValue');
 var Pad = require('../utils/string/Pad');
 
-// Animations are managed by the global AnimationManager. This is a singleton class that is
-// responsible for creating and delivering animations and their corresponding data to all Game Objects.
-// Sprites and other Game Objects get the data they need from the AnimationManager.
-// Access it via `scene.anims`.
-
+/**
+ * @classdesc
+ * The Animation Manager.
+ * 
+ * Animations are managed by the global Animation Manager. This is a singleton class that is
+ * responsible for creating and delivering animations and their corresponding data to all Game Objects.
+ * Unlike plugins it is owned by the Game instance, not the Scene.
+ * 
+ * Sprites and other Game Objects get the data they need from the AnimationManager.
+ *
+ * @class AnimationManager
+ * @memberOf Phaser.Animations
+ * @constructor
+ * @since 3.0.0
+ * 
+ * @param {Phaser.Game} game - [description]
+ */
 var AnimationManager = new Class({
 
     Extends: EventEmitter,
 
     initialize:
 
-    /**
-     * [description]
-     *
-     * @class AnimationManager
-     * @memberOf Phaser.Animations
-     * @constructor
-     * @since 3.0.0
-     * 
-     * @param {Phaser.Game} game - [description]
-     */
     function AnimationManager (game)
     {
         EventEmitter.call(this);
 
         /**
          * [description]
          *
-         * @property {Phaser.Game} game
+         * @name Phaser.Animations.AnimationManager#game
+         * @type {Phaser.Game}
          * @protected
+         * @since 3.0.0
          */
         this.game = game;
 
         /**
          * [description]
          *
-         * @property {[type]} textureManager
+         * @name Phaser.Animations.AnimationManager#textureManager
+         * @type {Phaser.Textures.TextureManager}
          * @protected
+         * @since 3.0.0
          */
         this.textureManager = null;
 
         /**
          * [description]
          *
-         * @property {number} [globalTimeScale=1]
+         * @name Phaser.Animations.AnimationManager#globalTimeScale
+         * @type {number}
+         * @default 1
+         * @since 3.0.0
          */
         this.globalTimeScale = 1;
 
         /**
          * [description]
          *
-         * @property {Phaser.Structs.Map} anims
+         * @name Phaser.Animations.AnimationManager#anims
+         * @type {Phaser.Structs.Map}
          * @protected
+         * @since 3.0.0
          */
         this.anims = new CustomMap();
 
         /**
          * [description]
          *
-         * @property {boolean} [paused=false]
+         * @name Phaser.Animations.AnimationManager#paused
+         * @type {boolean}
+         * @default false
+         * @since 3.0.0
          */
         this.paused = false;
 
+        /**
+         * [description]
+         *
+         * @name Phaser.Animations.AnimationManager#name
+         * @type {string}
+         * @since 3.0.0
+         */
         this.name = 'AnimationManager';
 
         game.events.once('boot', this.boot, this);
@@ -78,8 +99,6 @@ var AnimationManager = new Class({
      *
      * @method Phaser.Animations.AnimationManager#boot
      * @since 3.0.0
-     * 
-     * @param {[type]} textureManager - [description]
      */
     boot: function ()
     {
@@ -98,7 +117,7 @@ var AnimationManager = new Class({
      * @param {string} key - [description]
      * @param {Phaser.Animations.Animation} animation - [description]
      * 
-     * @return {Phaser.Animations.AnimationManager} The Animation Manager for method chaining.
+     * @return {Phaser.Animations.AnimationManager} This Animation Manager.
      */
     add: function (key, animation)
     {
@@ -384,7 +403,7 @@ var AnimationManager = new Class({
      * @fires PauseAllAnimationEvent
      * @since 3.0.0
      * 
-     * @return {Phaser.Animations.AnimationManager} The Animation Manager for method chaining.
+     * @return {Phaser.Animations.AnimationManager} This Animation Manager.
      */
     pauseAll: function ()
     {
@@ -407,7 +426,7 @@ var AnimationManager = new Class({
      * @param {string} key - [description]
      * @param {Phaser.GameObjects.GameObject} child - [description]
      * 
-     * @return {Phaser.Animations.AnimationManager} The Animation Manager for method chaining.
+     * @return {Phaser.Animations.AnimationManager} This Animation Manager.
      */
     play: function (key, child)
     {
@@ -463,7 +482,7 @@ var AnimationManager = new Class({
      * @fires ResumeAllAnimationEvent
      * @since 3.0.0
      * 
-     * @return {Phaser.Animations.AnimationManager} The Animation Manager for method chaining.
+     * @return {Phaser.Animations.AnimationManager} This Animation Manager.
      */
     resumeAll: function ()
     {
@@ -487,7 +506,7 @@ var AnimationManager = new Class({
      * @param {Phaser.GameObjects.GameObject} child - [description]
      * @param {number} [stagger=0] - [description]
      * 
-     * @return {Phaser.Animations.AnimationManager} The Animation Manager for method chaining.
+     * @return {Phaser.Animations.AnimationManager} This Animation Manager.
      */
     staggerPlay: function (key, child, stagger)
     {

src/animations/AnimationManager.js

@@ -6,6 +6,6 @@ module.exports = {
 
     Animation: require('./Animation'),
     AnimationFrame: require('./AnimationFrame'),
-    AnimationManager: require('./AnimationManager'),
+    AnimationManager: require('./AnimationManager')
 
 };

src/animations/index.js

@@ -81,21 +81,22 @@ var ValueToColor = require('../display/color/ValueToColor');
  * @property {string} [images.missing] - [description]
  */
 
+/**
+ * @classdesc
+ * [description]
+ *
+ * @class Config
+ * @memberOf Phaser.Boot
+ * @constructor
+ * @since 3.0.0
+ *
+ * @param {object} [GameConfig] - The configuration object for your Phaser Game instance.
+ *
+ */
 var Config = new Class({
 
     initialize:
 
-    /**
-     * [description]
-     *
-     * @class Config
-     * @memberOf Phaser.Boot
-     * @constructor
-     * @since 3.0.0
-     *
-     * @param {object} [GameConfig] - The configuration object for your Phaser Game instance.
-     *
-     */
     function Config (config)
     {
         if (config === undefined) { config = {}; }