Skip to content

Commit b0544c7

Browse files
photonstormphotonstorm
committed
jsdoc fixes
1 parent c391662 commit b0544c7

13 files changed

Lines changed: 35 additions & 38 deletions

File tree

‎src/cameras/2d/Camera.js‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1145,14 +1145,13 @@ var Camera = new Class({
11451145
*/
11461146

11471147
/**
1148-
* Destroys this Camera instance.
1148+
* Destroys this Camera instance. You rarely need to call this directly.
11491149
*
11501150
* Called by the Camera Manager. If you wish to destroy a Camera please use `CameraManager.remove` as
11511151
* cameras are stored in a pool, ready for recycling later, and calling this directly will prevent that.
11521152
*
11531153
* @method Phaser.Cameras.Scene2D.Camera#destroy
11541154
* @fires CameraDestroyEvent
1155-
* @protected
11561155
* @since 3.0.0
11571156
*/
11581157
destroy: function ()

‎src/gameobjects/bitmaptext/dynamic/DynamicBitmapText.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ var DynamicBitmapText = new Class({
374374
* @method Phaser.GameObjects.DynamicBitmapText#toJSON
375375
* @since 3.0.0
376376
*
377-
* @return {JSONGameObject.<JSONBitmapText>} [description]
377+
* @return {JSONBitmapText} [description]
378378
*/
379379
toJSON: function ()
380380
{

‎src/gameobjects/sprite/Sprite.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ var Sprite = new Class({
9696
* [description]
9797
*
9898
* @method Phaser.GameObjects.Sprite#preUpdate
99+
* @protected
99100
* @since 3.0.0
100101
*
101102
* @param {number} time - [description]

‎src/gameobjects/text/static/Text.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1060,7 +1060,7 @@ var Text = new Class({
10601060
* @method Phaser.GameObjects.Text#toJSON
10611061
* @since 3.0.0
10621062
*
1063-
* @return {object} [description]
1063+
* @return {JSONGameObject} A JSON representation of the Game Object.
10641064
*/
10651065
toJSON: function ()
10661066
{

‎src/loader/File.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ var File = new Class({
417417
*
418418
* @method Phaser.Loader.File.createObjectURL
419419
* @static
420-
* @param {Image} image - Image object which 'src' attribute should be set to object URL.
420+
* @param {HTMLImageElement} image - Image object which 'src' attribute should be set to object URL.
421421
* @param {Blob} blob - A Blob object to create an object URL for.
422422
* @param {string} defaultType - Default mime type used if blob type is not available.
423423
*/
@@ -449,7 +449,7 @@ File.createObjectURL = function (image, blob, defaultType)
449449
*
450450
* @method Phaser.Loader.File.revokeObjectURL
451451
* @static
452-
* @param {Image} image - Image object which 'src' attribute should be revoked.
452+
* @param {HTMLImageElement} image - Image object which 'src' attribute should be revoked.
453453
*/
454454
File.revokeObjectURL = function (image)
455455
{

‎src/loader/filetypes/AnimationJSONFile.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ var JSONFile = require('./JSONFile.js');
1818
* @param {string} path - The path of the file.
1919
* @param {XHRSettingsObject} [xhrSettings] - Optional file specific XHR settings.
2020
*
21-
* @return {Phaser.Loader.FileTypes.AnimationJSONFile} A File instance to be added to the Loader.
21+
* @return {Phaser.Loader.FileTypes.JSONFile} A File instance to be added to the Loader.
2222
*/
2323
var AnimationJSONFile = function (key, url, path, xhrSettings)
2424
{

‎src/physics/arcade/ArcadeSprite.js‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ var Sprite = require('../../gameobjects/sprite/Sprite');
3939
* @extends Phaser.Physics.Arcade.Components.Size
4040
* @extends Phaser.Physics.Arcade.Components.Velocity
4141
* @extends Phaser.GameObjects.Components.Alpha
42-
* @extends Phaser.GameObjects.Components.Animation
4342
* @extends Phaser.GameObjects.Components.BlendMode
4443
* @extends Phaser.GameObjects.Components.Depth
4544
* @extends Phaser.GameObjects.Components.Flip

‎src/physics/arcade/PhysicsGroup.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ var PhysicsGroup = new Class({
101101
*/
102102
this.world = world;
103103

104-
config.createCallback = this.createCallback;
105-
config.removeCallback = this.removeCallback;
104+
config.createCallback = this.createCallbackHandler;
105+
config.removeCallback = this.removeCallbackHandler;
106106

107107
config.classType = GetFastValue(config, 'classType', ArcadeSprite);
108108

@@ -149,12 +149,12 @@ var PhysicsGroup = new Class({
149149
/**
150150
* [description]
151151
*
152-
* @method Phaser.Physics.Arcade.Group#createCallback
152+
* @method Phaser.Physics.Arcade.Group#createCallbackHandler
153153
* @since 3.0.0
154154
*
155155
* @param {Phaser.GameObjects.GameObject} child - [description]
156156
*/
157-
createCallback: function (child)
157+
createCallbackHandler: function (child)
158158
{
159159
if (!child.body)
160160
{
@@ -172,12 +172,12 @@ var PhysicsGroup = new Class({
172172
/**
173173
* [description]
174174
*
175-
* @method Phaser.Physics.Arcade.Group#removeCallback
175+
* @method Phaser.Physics.Arcade.Group#removeCallbackHandler
176176
* @since 3.0.0
177177
*
178178
* @param {Phaser.GameObjects.GameObject} child - [description]
179179
*/
180-
removeCallback: function (child)
180+
removeCallbackHandler: function (child)
181181
{
182182
if (child.body)
183183
{

‎src/physics/arcade/StaticPhysicsGroup.js‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ var StaticPhysicsGroup = new Class({
5353
*/
5454
this.world = world;
5555

56-
config.createCallback = this.createCallback;
57-
config.removeCallback = this.removeCallback;
58-
config.createMultipleCallback = this.createMultipleCallback;
56+
config.createCallback = this.createCallbackHandler;
57+
config.removeCallback = this.removeCallbackHandler;
58+
config.createMultipleCallback = this.createMultipleCallbackHandler;
5959

6060
config.classType = ArcadeSprite;
6161

@@ -74,12 +74,12 @@ var StaticPhysicsGroup = new Class({
7474
/**
7575
* [description]
7676
*
77-
* @method Phaser.Physics.Arcade.StaticGroup#createCallback
77+
* @method Phaser.Physics.Arcade.StaticGroup#createCallbackHandler
7878
* @since 3.0.0
7979
*
8080
* @param {Phaser.GameObjects.GameObject} child - [description]
8181
*/
82-
createCallback: function (child)
82+
createCallbackHandler: function (child)
8383
{
8484
if (!child.body)
8585
{
@@ -90,12 +90,12 @@ var StaticPhysicsGroup = new Class({
9090
/**
9191
* [description]
9292
*
93-
* @method Phaser.Physics.Arcade.StaticGroup#removeCallback
93+
* @method Phaser.Physics.Arcade.StaticGroup#removeCallbackHandler
9494
* @since 3.0.0
9595
*
9696
* @param {Phaser.GameObjects.GameObject} child - [description]
9797
*/
98-
removeCallback: function (child)
98+
removeCallbackHandler: function (child)
9999
{
100100
if (child.body)
101101
{
@@ -106,12 +106,12 @@ var StaticPhysicsGroup = new Class({
106106
/**
107107
* [description]
108108
*
109-
* @method Phaser.Physics.Arcade.StaticGroup#createMultipleCallback
109+
* @method Phaser.Physics.Arcade.StaticGroup#createMultipleCallbackHandler
110110
* @since 3.0.0
111111
*
112112
* @param {object} entries - [description]
113113
*/
114-
createMultipleCallback: function ()
114+
createMultipleCallbackHandler: function ()
115115
{
116116
this.refresh();
117117
},

‎src/physics/impact/ImpactSprite.js‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ var Sprite = require('../../gameobjects/sprite/Sprite');
3939
* @extends Phaser.Physics.Impact.Components.SetGameObject
4040
* @extends Phaser.Physics.Impact.Components.Velocity
4141
* @extends Phaser.GameObjects.Components.Alpha
42-
* @extends Phaser.GameObjects.Components.Animation
4342
* @extends Phaser.GameObjects.Components.BlendMode
4443
* @extends Phaser.GameObjects.Components.Depth
4544
* @extends Phaser.GameObjects.Components.Flip

0 commit comments

Comments
 (0)