diff --git a/src/animations/Animation.js b/src/animations/Animation.js index fac19ba0e..b3e233998 100644 --- a/src/animations/Animation.js +++ b/src/animations/Animation.js @@ -803,7 +803,7 @@ var Animation = new Class({ * @method Phaser.Animations.Animation#toJSON * @since 3.0.0 * - * @return {JSONAnimation} [description] + * @return {Phaser.Animations.Types.JSONAnimation} [description] */ toJSON: function () { diff --git a/src/animations/AnimationFrame.js b/src/animations/AnimationFrame.js index 744c2e56b..957528055 100644 --- a/src/animations/AnimationFrame.js +++ b/src/animations/AnimationFrame.js @@ -141,7 +141,7 @@ var AnimationFrame = new Class({ * @method Phaser.Animations.AnimationFrame#toJSON * @since 3.0.0 * - * @return {Phaser.Animations.AnimationFrame.JSONConfig} The AnimationFrame data. + * @return {Phaser.Animations.Types.JSONAnimationFrame} The AnimationFrame data. */ toJSON: function () { diff --git a/src/animations/AnimationManager.js b/src/animations/AnimationManager.js index 4beb8aed8..78aa549d9 100644 --- a/src/animations/AnimationManager.js +++ b/src/animations/AnimationManager.js @@ -13,13 +13,6 @@ var GameEvents = require('../core/events'); var GetValue = require('../utils/object/GetValue'); var Pad = require('../utils/string/Pad'); -/** - * @typedef {object} JSONAnimationManager - * - * @property {JSONAnimation[]} anims - An array of all Animations added to the Animation Manager. - * @property {number} globalTimeScale - The global time scale of the Animation Manager. - */ - /** * @classdesc * The Animation Manager. @@ -192,7 +185,7 @@ var AnimationManager = new Class({ * @fires Phaser.Animations.Events#ADD_ANIMATION * @since 3.0.0 * - * @param {AnimationConfig} config - The configuration settings for the Animation. + * @param {Phaser.Animations.Types.Animation} config - The configuration settings for the Animation. * * @return {(Phaser.Animations.Animation|false)} The Animation that was created, or `false` is the key is already in use. */ @@ -225,7 +218,7 @@ var AnimationManager = new Class({ * @method Phaser.Animations.AnimationManager#fromJSON * @since 3.0.0 * - * @param {(string|JSONAnimationManager|JSONAnimation)} data - The JSON object to parse. + * @param {(string|Phaser.Animations.Types.JSONAnimations|Phaser.Animations.Types.JSONAnimation)} data - The JSON object to parse. * @param {boolean} [clearCurrentAnimations=false] - If set to `true`, the current animations will be removed (`anims.clear()`). If set to `false` (default), the animations in `data` will be added. * * @return {Phaser.Animations.Animation[]} An array containing all of the Animation objects that were created as a result of this call. @@ -618,7 +611,7 @@ var AnimationManager = new Class({ * * @param {string} key - [description] * - * @return {JSONAnimationManager} [description] + * @return {Phaser.Animations.Types.JSONAnimations} [description] */ toJSON: function (key) { diff --git a/src/animations/typedefs/JSONAnimations.js b/src/animations/typedefs/JSONAnimations.js new file mode 100644 index 000000000..27795e691 --- /dev/null +++ b/src/animations/typedefs/JSONAnimations.js @@ -0,0 +1,6 @@ +/** + * @typedef {object} Phaser.Animations.Types.JSONAnimations + * + * @property {Phaser.Animations.Types.JSONAnimation[]} anims - An array of all Animations added to the Animation Manager. + * @property {number} globalTimeScale - The global time scale of the Animation Manager. + */ diff --git a/src/cameras/2d/BaseCamera.js b/src/cameras/2d/BaseCamera.js index 31424b2f5..6f0009607 100644 --- a/src/cameras/2d/BaseCamera.js +++ b/src/cameras/2d/BaseCamera.js @@ -123,7 +123,7 @@ var BaseCamera = new Class({ * A reference to the Game Scale Manager. * * @name Phaser.Cameras.Scene2D.BaseCamera#scaleManager - * @type {Phaser.DOM.ScaleManager} + * @type {Phaser.Scale.ScaleManager} * @since 3.16.0 */ this.scaleManager; diff --git a/src/input/InputManager.js b/src/input/InputManager.js index d4ca2a9fb..9f1836ccf 100644 --- a/src/input/InputManager.js +++ b/src/input/InputManager.js @@ -60,7 +60,7 @@ var InputManager = new Class({ * Used for all bounds checks and pointer scaling. * * @name Phaser.Input.InputManager#scaleManager - * @type {Phaser.DOM.ScaleManager} + * @type {Phaser.Scale.ScaleManager} * @since 3.16.0 */ this.scaleManager; diff --git a/src/scale/index.js b/src/scale/index.js index 94f26c114..702949930 100644 --- a/src/scale/index.js +++ b/src/scale/index.js @@ -10,25 +10,25 @@ var CONST = require('./const'); /** * @namespace Phaser.Scale * - * @borrows Phaser.Scale.Center.NO_CENTER as Phaser.Scale.NO_CENTER - * @borrows Phaser.Scale.Center.CENTER_BOTH as Phaser.Scale.CENTER_BOTH - * @borrows Phaser.Scale.Center.CENTER_HORIZONTALLY as Phaser.Scale.CENTER_HORIZONTALLY - * @borrows Phaser.Scale.Center.CENTER_VERTICALLY as Phaser.Scale.CENTER_VERTICALLY + * @borrows Phaser.Scale.Center.NO_CENTER as NO_CENTER + * @borrows Phaser.Scale.Center.CENTER_BOTH as CENTER_BOTH + * @borrows Phaser.Scale.Center.CENTER_HORIZONTALLY as CENTER_HORIZONTALLY + * @borrows Phaser.Scale.Center.CENTER_VERTICALLY as CENTER_VERTICALLY * - * @borrows Phaser.Scale.Orientation.LANDSCAPE as Phaser.Scale.LANDSCAPE - * @borrows Phaser.Scale.Orientation.PORTRAIT as Phaser.Scale.PORTRAIT + * @borrows Phaser.Scale.Orientation.LANDSCAPE as LANDSCAPE + * @borrows Phaser.Scale.Orientation.PORTRAIT as PORTRAIT * - * @borrows Phaser.Scale.ScaleModes.NONE as Phaser.Scale.NONE - * @borrows Phaser.Scale.ScaleModes.WIDTH_CONTROLS_HEIGHT as Phaser.Scale.WIDTH_CONTROLS_HEIGHT - * @borrows Phaser.Scale.ScaleModes.HEIGHT_CONTROLS_WIDTH as Phaser.Scale.HEIGHT_CONTROLS_WIDTH - * @borrows Phaser.Scale.ScaleModes.FIT as Phaser.Scale.FIT - * @borrows Phaser.Scale.ScaleModes.ENVELOP as Phaser.Scale.ENVELOP - * @borrows Phaser.Scale.ScaleModes.RESIZE as Phaser.Scale.RESIZE + * @borrows Phaser.Scale.ScaleModes.NONE as NONE + * @borrows Phaser.Scale.ScaleModes.WIDTH_CONTROLS_HEIGHT as WIDTH_CONTROLS_HEIGHT + * @borrows Phaser.Scale.ScaleModes.HEIGHT_CONTROLS_WIDTH as HEIGHT_CONTROLS_WIDTH + * @borrows Phaser.Scale.ScaleModes.FIT as FIT + * @borrows Phaser.Scale.ScaleModes.ENVELOP as ENVELOP + * @borrows Phaser.Scale.ScaleModes.RESIZE as RESIZE * - * @borrows Phaser.Scale.Zoom.NO_ZOOM as Phaser.Scale.NO_ZOOM - * @borrows Phaser.Scale.Zoom.ZOOM_2X as Phaser.Scale.ZOOM_2X - * @borrows Phaser.Scale.Zoom.ZOOM_4X as Phaser.Scale.ZOOM_4X - * @borrows Phaser.Scale.Zoom.MAX_ZOOM as Phaser.Scale.MAX_ZOOM + * @borrows Phaser.Scale.Zoom.NO_ZOOM as NO_ZOOM + * @borrows Phaser.Scale.Zoom.ZOOM_2X as ZOOM_2X + * @borrows Phaser.Scale.Zoom.ZOOM_4X as ZOOM_4X + * @borrows Phaser.Scale.Zoom.MAX_ZOOM as MAX_ZOOM */ var Scale = { diff --git a/src/scene/Systems.js b/src/scene/Systems.js index b937bba66..80621d746 100644 --- a/src/scene/Systems.js +++ b/src/scene/Systems.js @@ -155,7 +155,7 @@ var Systems = new Class({ * In the default set-up you can access this from within a Scene via the `this.scale` property. * * @name Phaser.Scenes.Systems#scale - * @type {Phaser.DOM.ScaleManager} + * @type {Phaser.Scale.ScaleManager} * @since 3.15.0 */ this.scale;