Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-09-21 15:01:57 +00:00
Code Issues Projects Releases Packages Wiki Activity

jsdoc fixes

Browse source
This commit is contained in:
Richard Davey 2018-04-18 13:29:22 +01:00
parent c391662faa
commit b0544c73b8
13 changed files with 35 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/cameras/2d/Camera.js
View file

@ -1145,14 +1145,13 @@ var Camera = new Class({
*/
/**
* Destroys this Camera instance.
* Destroys this Camera instance. You rarely need to call this directly.
*
* Called by the Camera Manager. If you wish to destroy a Camera please use `CameraManager.remove` as
* cameras are stored in a pool, ready for recycling later, and calling this directly will prevent that.
*
* @method Phaser.Cameras.Scene2D.Camera#destroy
* @fires CameraDestroyEvent
* @protected
* @since 3.0.0
*/
destroy: function ()

2
src/gameobjects/bitmaptext/dynamic/DynamicBitmapText.js
View file

@ -374,7 +374,7 @@ var DynamicBitmapText = new Class({
* @method Phaser.GameObjects.DynamicBitmapText#toJSON
* @since 3.0.0
*
* @return {JSONGameObject.<JSONBitmapText>} [description]
* @return {JSONBitmapText} [description]
*/
toJSON: function ()
{

1
src/gameobjects/sprite/Sprite.js
View file

@ -96,6 +96,7 @@ var Sprite = new Class({
* [description]
*
* @method Phaser.GameObjects.Sprite#preUpdate
* @protected
* @since 3.0.0
*
* @param {number} time - [description]

2
src/gameobjects/text/static/Text.js
View file

@ -1060,7 +1060,7 @@ var Text = new Class({
* @method Phaser.GameObjects.Text#toJSON
* @since 3.0.0
*
* @return {object} [description]
* @return {JSONGameObject} A JSON representation of the Game Object.
*/
toJSON: function ()
{

4
src/loader/File.js
View file

@ -417,7 +417,7 @@ var File = new Class({
*
* @method Phaser.Loader.File.createObjectURL
* @static
* @param {Image} image - Image object which 'src' attribute should be set to object URL.
* @param {HTMLImageElement} image - Image object which 'src' attribute should be set to object URL.
* @param {Blob} blob - A Blob object to create an object URL for.
* @param {string} defaultType - Default mime type used if blob type is not available.
*/
@ -449,7 +449,7 @@ File.createObjectURL = function (image, blob, defaultType)
*
* @method Phaser.Loader.File.revokeObjectURL
* @static
* @param {Image} image - Image object which 'src' attribute should be revoked.
* @param {HTMLImageElement} image - Image object which 'src' attribute should be revoked.
*/
File.revokeObjectURL = function (image)
{

2
src/loader/filetypes/AnimationJSONFile.js
View file

@ -18,7 +18,7 @@ var JSONFile = require('./JSONFile.js');
* @param {string} path - The path of the file.
* @param {XHRSettingsObject} [xhrSettings] - Optional file specific XHR settings.
*
* @return {Phaser.Loader.FileTypes.AnimationJSONFile} A File instance to be added to the Loader.
* @return {Phaser.Loader.FileTypes.JSONFile} A File instance to be added to the Loader.
*/
var AnimationJSONFile = function (key, url, path, xhrSettings)
{

1
src/physics/arcade/ArcadeSprite.js
View file

@ -39,7 +39,6 @@ var Sprite = require('../../gameobjects/sprite/Sprite');
* @extends Phaser.Physics.Arcade.Components.Size
* @extends Phaser.Physics.Arcade.Components.Velocity
* @extends Phaser.GameObjects.Components.Alpha
* @extends Phaser.GameObjects.Components.Animation
* @extends Phaser.GameObjects.Components.BlendMode
* @extends Phaser.GameObjects.Components.Depth
* @extends Phaser.GameObjects.Components.Flip

12
src/physics/arcade/PhysicsGroup.js
View file

@ -101,8 +101,8 @@ var PhysicsGroup = new Class({
*/
this.world = world;
config.createCallback = this.createCallback;
config.removeCallback = this.removeCallback;
config.createCallback = this.createCallbackHandler;
config.removeCallback = this.removeCallbackHandler;
config.classType = GetFastValue(config, 'classType', ArcadeSprite);
@ -149,12 +149,12 @@ var PhysicsGroup = new Class({
/**
* [description]
*
* @method Phaser.Physics.Arcade.Group#createCallback
* @method Phaser.Physics.Arcade.Group#createCallbackHandler
* @since 3.0.0
*
* @param {Phaser.GameObjects.GameObject} child - [description]
*/
createCallback: function (child)
createCallbackHandler: function (child)
{
if (!child.body)
{
@ -172,12 +172,12 @@ var PhysicsGroup = new Class({
/**
* [description]
*
* @method Phaser.Physics.Arcade.Group#removeCallback
* @method Phaser.Physics.Arcade.Group#removeCallbackHandler
* @since 3.0.0
*
* @param {Phaser.GameObjects.GameObject} child - [description]
*/
removeCallback: function (child)
removeCallbackHandler: function (child)
{
if (child.body)
{

18
src/physics/arcade/StaticPhysicsGroup.js
View file

@ -53,9 +53,9 @@ var StaticPhysicsGroup = new Class({
*/
this.world = world;
config.createCallback = this.createCallback;
config.removeCallback = this.removeCallback;
config.createMultipleCallback = this.createMultipleCallback;
config.createCallback = this.createCallbackHandler;
config.removeCallback = this.removeCallbackHandler;
config.createMultipleCallback = this.createMultipleCallbackHandler;
config.classType = ArcadeSprite;
@ -74,12 +74,12 @@ var StaticPhysicsGroup = new Class({
/**
* [description]
*
* @method Phaser.Physics.Arcade.StaticGroup#createCallback
* @method Phaser.Physics.Arcade.StaticGroup#createCallbackHandler
* @since 3.0.0
*
* @param {Phaser.GameObjects.GameObject} child - [description]
*/
createCallback: function (child)
createCallbackHandler: function (child)
{
if (!child.body)
{
@ -90,12 +90,12 @@ var StaticPhysicsGroup = new Class({
/**
* [description]
*
* @method Phaser.Physics.Arcade.StaticGroup#removeCallback
* @method Phaser.Physics.Arcade.StaticGroup#removeCallbackHandler
* @since 3.0.0
*
* @param {Phaser.GameObjects.GameObject} child - [description]
*/
removeCallback: function (child)
removeCallbackHandler: function (child)
{
if (child.body)
{
@ -106,12 +106,12 @@ var StaticPhysicsGroup = new Class({
/**
* [description]
*
* @method Phaser.Physics.Arcade.StaticGroup#createMultipleCallback
* @method Phaser.Physics.Arcade.StaticGroup#createMultipleCallbackHandler
* @since 3.0.0
*
* @param {object} entries - [description]
*/
createMultipleCallback: function ()
createMultipleCallbackHandler: function ()
{
this.refresh();
},

1
src/physics/impact/ImpactSprite.js
View file

@ -39,7 +39,6 @@ var Sprite = require('../../gameobjects/sprite/Sprite');
* @extends Phaser.Physics.Impact.Components.SetGameObject
* @extends Phaser.Physics.Impact.Components.Velocity
* @extends Phaser.GameObjects.Components.Alpha
* @extends Phaser.GameObjects.Components.Animation
* @extends Phaser.GameObjects.Components.BlendMode
* @extends Phaser.GameObjects.Components.Depth
* @extends Phaser.GameObjects.Components.Flip

24
src/physics/impact/components/Collides.js
View file

@ -66,12 +66,12 @@ var Collides = {
/**
* [description]
*
* @method Phaser.Physics.Impact.Components.Collides#setLite
* @since 3.0.0
* @method Phaser.Physics.Impact.Components.Collides#setLiteCollision
* @since 3.5.2
*
* @return {Phaser.GameObjects.GameObject} This Game Object.
*/
setLite: function ()
setLiteCollision: function ()
{
this.body.collides = COLLIDES.LITE;
@ -81,12 +81,12 @@ var Collides = {
/**
* [description]
*
* @method Phaser.Physics.Impact.Components.Collides#setPassive
* @since 3.0.0
* @method Phaser.Physics.Impact.Components.Collides#setPassiveCollision
* @since 3.5.2
*
* @return {Phaser.GameObjects.GameObject} This Game Object.
*/
setPassive: function ()
setPassiveCollision: function ()
{
this.body.collides = COLLIDES.PASSIVE;
@ -96,12 +96,12 @@ var Collides = {
/**
* [description]
*
* @method Phaser.Physics.Impact.Components.Collides#setActive
* @since 3.0.0
* @method Phaser.Physics.Impact.Components.Collides#setActiveCollision
* @since 3.5.2
*
* @return {Phaser.GameObjects.GameObject} This Game Object.
*/
setActive: function ()
setActiveCollision: function ()
{
this.body.collides = COLLIDES.ACTIVE;
@ -111,12 +111,12 @@ var Collides = {
/**
* [description]
*
* @method Phaser.Physics.Impact.Components.Collides#setFixed
* @since 3.0.0
* @method Phaser.Physics.Impact.Components.Collides#setFixedCollision
* @since 3.5.2
*
* @return {Phaser.GameObjects.GameObject} This Game Object.
*/
setFixed: function ()
setFixedCollision: function ()
{
this.body.collides = COLLIDES.FIXED;

1
src/physics/matter-js/MatterSprite.js
View file

@ -44,7 +44,6 @@ var Vector2 = require('../../math/Vector2');
* @extends Phaser.Physics.Matter.Components.Transform
* @extends Phaser.Physics.Matter.Components.Velocity
* @extends Phaser.GameObjects.Components.Alpha
* @extends Phaser.GameObjects.Components.Animation
* @extends Phaser.GameObjects.Components.BlendMode
* @extends Phaser.GameObjects.Components.Depth
* @extends Phaser.GameObjects.Components.Flip

2
src/scene/ScenePlugin.js
View file

@ -348,7 +348,7 @@ var ScenePlugin = new Class({
}
else
{
this.manager.start(key);
this.manager.start(key, GetFastValue(config, 'data'));
}
this.systems.events.emit('transitionout', target, duration);