Skip to content

Commit b50e1c7

Browse files
committed
Lots more jsdoc tweaks and improvements
1 parent c843939 commit b50e1c7

49 files changed

Lines changed: 176 additions & 66 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/const.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ var CONST = {
1616
* Phaser Release Version
1717
*
1818
* @name Phaser.VERSION
19-
* @readonly
19+
* @const
2020
* @type {string}
2121
* @since 3.0.0
2222
*/
@@ -30,7 +30,7 @@ var CONST = {
3030
* AUTO Detect Renderer.
3131
*
3232
* @name Phaser.AUTO
33-
* @readonly
33+
* @const
3434
* @type {integer}
3535
* @since 3.0.0
3636
*/
@@ -40,7 +40,7 @@ var CONST = {
4040
* Canvas Renderer.
4141
*
4242
* @name Phaser.CANVAS
43-
* @readonly
43+
* @const
4444
* @type {integer}
4545
* @since 3.0.0
4646
*/
@@ -50,7 +50,7 @@ var CONST = {
5050
* WebGL Renderer.
5151
*
5252
* @name Phaser.WEBGL
53-
* @readonly
53+
* @const
5454
* @type {integer}
5555
* @since 3.0.0
5656
*/
@@ -60,7 +60,7 @@ var CONST = {
6060
* Headless Renderer.
6161
*
6262
* @name Phaser.HEADLESS
63-
* @readonly
63+
* @const
6464
* @type {integer}
6565
* @since 3.0.0
6666
*/
@@ -71,7 +71,7 @@ var CONST = {
7171
* to help you remember what the value is doing in your code.
7272
*
7373
* @name Phaser.FOREVER
74-
* @readonly
74+
* @const
7575
* @type {integer}
7676
* @since 3.0.0
7777
*/
@@ -81,7 +81,7 @@ var CONST = {
8181
* Direction constant.
8282
*
8383
* @name Phaser.NONE
84-
* @readonly
84+
* @const
8585
* @type {integer}
8686
* @since 3.0.0
8787
*/
@@ -91,7 +91,7 @@ var CONST = {
9191
* Direction constant.
9292
*
9393
* @name Phaser.UP
94-
* @readonly
94+
* @const
9595
* @type {integer}
9696
* @since 3.0.0
9797
*/
@@ -101,7 +101,7 @@ var CONST = {
101101
* Direction constant.
102102
*
103103
* @name Phaser.DOWN
104-
* @readonly
104+
* @const
105105
* @type {integer}
106106
* @since 3.0.0
107107
*/
@@ -111,7 +111,7 @@ var CONST = {
111111
* Direction constant.
112112
*
113113
* @name Phaser.LEFT
114-
* @readonly
114+
* @const
115115
* @type {integer}
116116
* @since 3.0.0
117117
*/
@@ -121,7 +121,7 @@ var CONST = {
121121
* Direction constant.
122122
*
123123
* @name Phaser.RIGHT
124-
* @readonly
124+
* @const
125125
* @type {integer}
126126
* @since 3.0.0
127127
*/

src/gameobjects/components/Tint.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ var GetColor = function (value)
1818
* Provides methods used for setting the tint of a Game Object.
1919
* Should be applied as a mixin and not used directly.
2020
*
21-
* @name Phaser.GameObjects.Components.Tint
21+
* @namespace Phaser.GameObjects.Components.Tint
2222
* @webglOnly
2323
* @since 3.0.0
2424
*/

src/physics/arcade/World.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ var World = new Class({
307307
* - 0.5 = double speed
308308
*
309309
* @name Phaser.Physics.Arcade.World#timeScale
310-
* @property {number}
310+
* @type {number}
311311
* @default 1
312312
* @since 3.10.0
313313
*/

src/physics/arcade/components/Acceleration.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
/**
88
* Provides methods used for setting the acceleration properties of an Arcade Physics Body.
99
*
10-
* @name Phaser.Physics.Arcade.Components.Acceleration
10+
* @namespace Phaser.Physics.Arcade.Components.Acceleration
1111
* @since 3.0.0
1212
*/
1313
var Acceleration = {

src/physics/arcade/components/Angular.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
/**
88
* Provides methods used for setting the angular acceleration properties of an Arcade Physics Body.
99
*
10-
* @name Phaser.Physics.Arcade.Components.Angular
10+
* @namespace Phaser.Physics.Arcade.Components.Angular
1111
* @since 3.0.0
1212
*/
1313
var Angular = {

src/physics/arcade/components/Bounce.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
/**
88
* Provides methods used for setting the bounce properties of an Arcade Physics Body.
99
*
10-
* @name Phaser.Physics.Arcade.Components.Bounce
10+
* @namespace Phaser.Physics.Arcade.Components.Bounce
1111
* @since 3.0.0
1212
*/
1313
var Bounce = {

src/physics/arcade/components/Debug.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
/**
88
* Provides methods used for setting the debug properties of an Arcade Physics Body.
99
*
10-
* @name Phaser.Physics.Arcade.Components.Debug
10+
* @namespace Phaser.Physics.Arcade.Components.Debug
1111
* @since 3.0.0
1212
*/
1313
var Debug = {

src/physics/arcade/components/Drag.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
/**
88
* Provides methods used for setting the drag properties of an Arcade Physics Body.
99
*
10-
* @name Phaser.Physics.Arcade.Components.Drag
10+
* @namespace Phaser.Physics.Arcade.Components.Drag
1111
* @since 3.0.0
1212
*/
1313
var Drag = {

src/physics/arcade/components/Enable.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
/**
88
* Provides methods used for setting the enable properties of an Arcade Physics Body.
99
*
10-
* @name Phaser.Physics.Arcade.Components.Enable
10+
* @namespace Phaser.Physics.Arcade.Components.Enable
1111
* @since 3.0.0
1212
*/
1313
var Enable = {

src/physics/arcade/components/Friction.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
/**
88
* Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving horizontally in the X axis. The higher than friction, the faster the body will slow down once force stops being applied to it.
99
*
10-
* @name Phaser.Physics.Arcade.Components.Friction
10+
* @namespace Phaser.Physics.Arcade.Components.Friction
1111
* @since 3.0.0
1212
*/
1313
var Friction = {

0 commit comments

Comments
 (0)