Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-26 06:30:38 +00:00
Code Issues Projects Releases Packages Wiki Activity

JSDoc fixes

Browse source
This commit is contained in:
Richard Davey 2019-02-04 11:45:17 +00:00
parent 38f90ec355
commit d04232ae54
8 changed files with 30 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/animations/Animation.js
View file

@ -803,7 +803,7 @@ var Animation = new Class({
* @method Phaser.Animations.Animation#toJSON * @method Phaser.Animations.Animation#toJSON
* @since 3.0.0 * @since 3.0.0
* *
* @return {JSONAnimation} [description] * @return {Phaser.Animations.Types.JSONAnimation} [description]
*/ */
toJSON: function () toJSON: function ()
{ {

2
src/animations/AnimationFrame.js
View file

@ -141,7 +141,7 @@ var AnimationFrame = new Class({
* @method Phaser.Animations.AnimationFrame#toJSON * @method Phaser.Animations.AnimationFrame#toJSON
* @since 3.0.0 * @since 3.0.0
* *
* @return {Phaser.Animations.AnimationFrame.JSONConfig} The AnimationFrame data. * @return {Phaser.Animations.Types.JSONAnimationFrame} The AnimationFrame data.
*/ */
toJSON: function () toJSON: function ()
{ {

13
src/animations/AnimationManager.js
View file

@ -13,13 +13,6 @@ var GameEvents = require('../core/events');
var GetValue = require('../utils/object/GetValue'); var GetValue = require('../utils/object/GetValue');
var Pad = require('../utils/string/Pad'); 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 * @classdesc
* The Animation Manager. * The Animation Manager.
@ -192,7 +185,7 @@ var AnimationManager = new Class({
* @fires Phaser.Animations.Events#ADD_ANIMATION * @fires Phaser.Animations.Events#ADD_ANIMATION
* @since 3.0.0 * @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. * @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 * @method Phaser.Animations.AnimationManager#fromJSON
* @since 3.0.0 * @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. * @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. * @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] * @param {string} key - [description]
* *
* @return {JSONAnimationManager} [description] * @return {Phaser.Animations.Types.JSONAnimations} [description]
*/ */
toJSON: function (key) toJSON: function (key)
{ {

6
src/animations/typedefs/JSONAnimations.js Normal file
View file

@ -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.
*/

2
src/cameras/2d/BaseCamera.js
View file

@ -123,7 +123,7 @@ var BaseCamera = new Class({
* A reference to the Game Scale Manager. * A reference to the Game Scale Manager.
* *
* @name Phaser.Cameras.Scene2D.BaseCamera#scaleManager * @name Phaser.Cameras.Scene2D.BaseCamera#scaleManager
* @type {Phaser.DOM.ScaleManager} * @type {Phaser.Scale.ScaleManager}
* @since 3.16.0 * @since 3.16.0
*/ */
this.scaleManager; this.scaleManager;

2
src/input/InputManager.js
View file

@ -60,7 +60,7 @@ var InputManager = new Class({
* Used for all bounds checks and pointer scaling. * Used for all bounds checks and pointer scaling.
* *
* @name Phaser.Input.InputManager#scaleManager * @name Phaser.Input.InputManager#scaleManager
* @type {Phaser.DOM.ScaleManager} * @type {Phaser.Scale.ScaleManager}
* @since 3.16.0 * @since 3.16.0
*/ */
this.scaleManager; this.scaleManager;

32
src/scale/index.js
View file

@ -10,25 +10,25 @@ var CONST = require('./const');
/** /**
* @namespace Phaser.Scale * @namespace Phaser.Scale
* *
* @borrows Phaser.Scale.Center.NO_CENTER as Phaser.Scale.NO_CENTER * @borrows Phaser.Scale.Center.NO_CENTER as NO_CENTER
* @borrows Phaser.Scale.Center.CENTER_BOTH as Phaser.Scale.CENTER_BOTH * @borrows Phaser.Scale.Center.CENTER_BOTH as CENTER_BOTH
* @borrows Phaser.Scale.Center.CENTER_HORIZONTALLY as Phaser.Scale.CENTER_HORIZONTALLY * @borrows Phaser.Scale.Center.CENTER_HORIZONTALLY as CENTER_HORIZONTALLY
* @borrows Phaser.Scale.Center.CENTER_VERTICALLY as Phaser.Scale.CENTER_VERTICALLY * @borrows Phaser.Scale.Center.CENTER_VERTICALLY as CENTER_VERTICALLY
* *
* @borrows Phaser.Scale.Orientation.LANDSCAPE as Phaser.Scale.LANDSCAPE * @borrows Phaser.Scale.Orientation.LANDSCAPE as LANDSCAPE
* @borrows Phaser.Scale.Orientation.PORTRAIT as Phaser.Scale.PORTRAIT * @borrows Phaser.Scale.Orientation.PORTRAIT as PORTRAIT
* *
* @borrows Phaser.Scale.ScaleModes.NONE as Phaser.Scale.NONE * @borrows Phaser.Scale.ScaleModes.NONE as NONE
* @borrows Phaser.Scale.ScaleModes.WIDTH_CONTROLS_HEIGHT as Phaser.Scale.WIDTH_CONTROLS_HEIGHT * @borrows Phaser.Scale.ScaleModes.WIDTH_CONTROLS_HEIGHT as WIDTH_CONTROLS_HEIGHT
* @borrows Phaser.Scale.ScaleModes.HEIGHT_CONTROLS_WIDTH as Phaser.Scale.HEIGHT_CONTROLS_WIDTH * @borrows Phaser.Scale.ScaleModes.HEIGHT_CONTROLS_WIDTH as HEIGHT_CONTROLS_WIDTH
* @borrows Phaser.Scale.ScaleModes.FIT as Phaser.Scale.FIT * @borrows Phaser.Scale.ScaleModes.FIT as FIT
* @borrows Phaser.Scale.ScaleModes.ENVELOP as Phaser.Scale.ENVELOP * @borrows Phaser.Scale.ScaleModes.ENVELOP as ENVELOP
* @borrows Phaser.Scale.ScaleModes.RESIZE as Phaser.Scale.RESIZE * @borrows Phaser.Scale.ScaleModes.RESIZE as RESIZE
* *
* @borrows Phaser.Scale.Zoom.NO_ZOOM as Phaser.Scale.NO_ZOOM * @borrows Phaser.Scale.Zoom.NO_ZOOM as NO_ZOOM
* @borrows Phaser.Scale.Zoom.ZOOM_2X as Phaser.Scale.ZOOM_2X * @borrows Phaser.Scale.Zoom.ZOOM_2X as ZOOM_2X
* @borrows Phaser.Scale.Zoom.ZOOM_4X as Phaser.Scale.ZOOM_4X * @borrows Phaser.Scale.Zoom.ZOOM_4X as ZOOM_4X
* @borrows Phaser.Scale.Zoom.MAX_ZOOM as Phaser.Scale.MAX_ZOOM * @borrows Phaser.Scale.Zoom.MAX_ZOOM as MAX_ZOOM
*/ */
var Scale = { var Scale = {

2
src/scene/Systems.js
View file

@ -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. * In the default set-up you can access this from within a Scene via the `this.scale` property.
* *
* @name Phaser.Scenes.Systems#scale * @name Phaser.Scenes.Systems#scale
* @type {Phaser.DOM.ScaleManager} * @type {Phaser.Scale.ScaleManager}
* @since 3.15.0 * @since 3.15.0
*/ */
this.scale; this.scale;