Merge pull request phaserjs#4975 from JasonHK/jsdoc

Fixed `this` return types

Author: photonstorm

src/animations/Animation.js

@@ -226,7 +226,7 @@ var Animation = new Class({
      *
      * @param {(string|Phaser.Types.Animations.AnimationFrame[])} config - Either a string, in which case it will use all frames from a texture with the matching key, or an array of Animation Frame configuration objects.
      *
-     * @return {Phaser.Animations.Animation} This Animation object.
+     * @return {this} This Animation object.
      */
     addFrame: function (config)
     {
@@ -242,7 +242,7 @@ var Animation = new Class({
      * @param {integer} index - The index to insert the frame at within the animation.
      * @param {(string|Phaser.Types.Animations.AnimationFrame[])} config - Either a string, in which case it will use all frames from a texture with the matching key, or an array of Animation Frame configuration objects.
      *
-     * @return {Phaser.Animations.Animation} This Animation object.
+     * @return {this} This Animation object.
      */
     addFrameAt: function (index, config)
     {
@@ -698,7 +698,7 @@ var Animation = new Class({
      *
      * @param {Phaser.Animations.AnimationFrame} frame - The AnimationFrame to be removed.
      *
-     * @return {Phaser.Animations.Animation} This Animation object.
+     * @return {this} This Animation object.
      */
     removeFrame: function (frame)
     {
@@ -721,7 +721,7 @@ var Animation = new Class({
      *
      * @param {integer} index - The index in the AnimationFrame array
      *
-     * @return {Phaser.Animations.Animation} This Animation object.
+     * @return {this} This Animation object.
      */
     removeFrameAt: function (index)
     {
@@ -841,7 +841,7 @@ var Animation = new Class({
      * @method Phaser.Animations.Animation#updateFrameSequence
      * @since 3.0.0
      *
-     * @return {Phaser.Animations.Animation} This Animation object.
+     * @return {this} This Animation object.
      */
     updateFrameSequence: function ()
     {
@@ -898,7 +898,7 @@ var Animation = new Class({
      * @method Phaser.Animations.Animation#pause
      * @since 3.0.0
      *
-     * @return {Phaser.Animations.Animation} This Animation object.
+     * @return {this} This Animation object.
      */
     pause: function ()
     {
@@ -913,7 +913,7 @@ var Animation = new Class({
      * @method Phaser.Animations.Animation#resume
      * @since 3.0.0
      *
-     * @return {Phaser.Animations.Animation} This Animation object.
+     * @return {this} This Animation object.
      */
     resume: function ()
     {

src/animations/AnimationManager.js

@@ -131,15 +131,15 @@ var AnimationManager = new Class({
      * @param {string} key - The key under which the Animation should be added. The Animation will be updated with it. Must be unique.
      * @param {Phaser.Animations.Animation} animation - The Animation which should be added to the Animation Manager.
      *
-     * @return {Phaser.Animations.AnimationManager} This Animation Manager.
+     * @return {this} This Animation Manager.
      */
     add: function (key, animation)
     {
         if (this.anims.has(key))
         {
             console.warn('Animation key exists: ' + key);
 
-            return;
+            return this;
         }
 
         animation.key = key;
@@ -486,7 +486,7 @@ var AnimationManager = new Class({
      * @fires Phaser.Animations.Events#PAUSE_ALL
      * @since 3.0.0
      *
-     * @return {Phaser.Animations.AnimationManager} This Animation Manager.
+     * @return {this} This Animation Manager.
      */
     pauseAll: function ()
     {
@@ -509,7 +509,7 @@ var AnimationManager = new Class({
      * @param {string} key - The key of the animation to play on the Game Object.
      * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} child - The Game Objects to play the animation on.
      *
-     * @return {Phaser.Animations.AnimationManager} This Animation Manager.
+     * @return {this} This Animation Manager.
      */
     play: function (key, child)
     {
@@ -522,7 +522,7 @@ var AnimationManager = new Class({
 
         if (!anim)
         {
-            return;
+            return this;
         }
 
         for (var i = 0; i < child.length; i++)
@@ -568,7 +568,7 @@ var AnimationManager = new Class({
      * @fires Phaser.Animations.Events#RESUME_ALL
      * @since 3.0.0
      *
-     * @return {Phaser.Animations.AnimationManager} This Animation Manager.
+     * @return {this} This Animation Manager.
      */
     resumeAll: function ()
     {
@@ -596,7 +596,7 @@ var AnimationManager = new Class({
      * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} children - An array of Game Objects to play the animation on. They must have an Animation Component.
      * @param {number} [stagger=0] - The amount of time, in milliseconds, to offset each play time by.
      *
-     * @return {Phaser.Animations.AnimationManager} This Animation Manager.
+     * @return {this} This Animation Manager.
      */
     staggerPlay: function (key, children, stagger)
     {
@@ -611,7 +611,7 @@ var AnimationManager = new Class({
 
         if (!anim)
         {
-            return;
+            return this;
         }
 
         for (var i = 0; i < children.length; i++)

src/cache/BaseCache.js

@@ -60,7 +60,7 @@ var BaseCache = new Class({
      * @param {string} key - The unique key by which the data added to the cache will be referenced.
      * @param {*} data - The data to be stored in the cache.
      *
-     * @return {Phaser.Cache.BaseCache} This BaseCache object.
+     * @return {this} This BaseCache object.
      */
     add: function (key, data)
     {
@@ -131,7 +131,7 @@ var BaseCache = new Class({
      *
      * @param {string} key - The unique key of the item to remove from the cache.
      *
-     * @return {Phaser.Cache.BaseCache} This BaseCache object.
+     * @return {this} This BaseCache object.
      */
     remove: function (key)
     {

src/cameras/2d/BaseCamera.js

@@ -609,7 +609,7 @@ var BaseCamera = new Class({
      *
      * @param {number} x - The horizontal coordinate to center on.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     centerOnX: function (x)
     {
@@ -636,7 +636,7 @@ var BaseCamera = new Class({
      *
      * @param {number} y - The vertical coordinate to center on.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     centerOnY: function (y)
     {
@@ -663,7 +663,7 @@ var BaseCamera = new Class({
      * @param {number} x - The horizontal coordinate to center on.
      * @param {number} y - The vertical coordinate to center on.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     centerOn: function (x, y)
     {
@@ -679,7 +679,7 @@ var BaseCamera = new Class({
      * @method Phaser.Cameras.Scene2D.BaseCamera#centerToBounds
      * @since 3.0.0
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     centerToBounds: function ()
     {
@@ -704,7 +704,7 @@ var BaseCamera = new Class({
      * @method Phaser.Cameras.Scene2D.BaseCamera#centerToSize
      * @since 3.0.0
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     centerToSize: function ()
     {
@@ -872,7 +872,7 @@ var BaseCamera = new Class({
      *
      * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]|Phaser.GameObjects.Group)} entries - The Game Object, or array of Game Objects, to be ignored by this Camera.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     ignore: function (entries)
     {
@@ -1042,7 +1042,7 @@ var BaseCamera = new Class({
      * @method Phaser.Cameras.Scene2D.BaseCamera#removeBounds
      * @since 3.0.0
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     removeBounds: function ()
     {
@@ -1065,7 +1065,7 @@ var BaseCamera = new Class({
      *
      * @param {number} [value=0] - The cameras angle of rotation, given in degrees.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     setAngle: function (value)
     {
@@ -1089,7 +1089,7 @@ var BaseCamera = new Class({
      *
      * @param {(string|number|Phaser.Types.Display.InputColorObject)} [color='rgba(0,0,0,0)'] - The color value. In CSS, hex or numeric color notation.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     setBackgroundColor: function (color)
     {
@@ -1130,7 +1130,7 @@ var BaseCamera = new Class({
      * @param {integer} height - The height of the bounds, in pixels.
      * @param {boolean} [centerOn=false] - If `true` the Camera will automatically be centered on the new bounds.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     setBounds: function (x, y, width, height, centerOn)
     {
@@ -1188,7 +1188,7 @@ var BaseCamera = new Class({
      *
      * @param {string} [value=''] - The name of the Camera.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     setName: function (value)
     {
@@ -1210,7 +1210,7 @@ var BaseCamera = new Class({
      * @param {number} x - The top-left x coordinate of the Camera viewport.
      * @param {number} [y=x] - The top-left y coordinate of the Camera viewport.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     setPosition: function (x, y)
     {
@@ -1232,7 +1232,7 @@ var BaseCamera = new Class({
      *
      * @param {number} [value=0] - The rotation of the Camera, in radians.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     setRotation: function (value)
     {
@@ -1253,7 +1253,7 @@ var BaseCamera = new Class({
      *
      * @param {boolean} value - `true` to round Camera pixels, `false` to not.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     setRoundPixels: function (value)
     {
@@ -1272,7 +1272,7 @@ var BaseCamera = new Class({
      *
      * @param {Phaser.Scene} scene - The Scene the camera is bound to.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     setScene: function (scene)
     {
@@ -1316,7 +1316,7 @@ var BaseCamera = new Class({
      * @param {number} x - The x coordinate of the Camera in the game world.
      * @param {number} [y=x] - The y coordinate of the Camera in the game world.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     setScroll: function (x, y)
     {
@@ -1341,7 +1341,7 @@ var BaseCamera = new Class({
      * @param {integer} width - The width of the Camera viewport.
      * @param {integer} [height=width] - The height of the Camera viewport.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     setSize: function (width, height)
     {
@@ -1372,7 +1372,7 @@ var BaseCamera = new Class({
      * @param {integer} width - The width of the Camera viewport.
      * @param {integer} [height=width] - The height of the Camera viewport.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     setViewport: function (x, y, width, height)
     {
@@ -1399,7 +1399,7 @@ var BaseCamera = new Class({
      *
      * @param {number} [value=1] - The zoom value of the Camera. The minimum it can be is 0.001.
      *
-     * @return {Phaser.Cameras.Scene2D.BaseCamera} This Camera instance.
+     * @return {this} This Camera instance.
      */
     setZoom: function (value)
     {