Skip to content

Commit 84363d9

Browse files
committed
Updated documentation per current Phaser tag usage
1 parent 9a16448 commit 84363d9

6 files changed

Lines changed: 18 additions & 12 deletions

File tree

src/input/Gamepad.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Phaser.Gamepad = function (game) {
4646

4747
/**
4848
* Gamepad input will only be processed if enabled.
49-
* @member {boolean}
49+
* @property {boolean} enabled
5050
* @default
5151
*/
5252
this.enabled = true;
@@ -483,7 +483,8 @@ Phaser.Gamepad.prototype.constructor = Phaser.Gamepad;
483483

484484
/**
485485
* If disabled all Gamepad input will be ignored.
486-
* @member {boolean}
486+
* @property {boolean} disabled
487+
* @memberof Phaser.Gamepad
487488
* @default false
488489
* @deprecated Use {@link Phaser.Gamepad#enabled} instead
489490
*/

src/input/Input.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Phaser.Input = function (game) {
5656
* When enabled, input (eg. Keyboard, Mouse, Touch) will be processed - as long as the individual sources are enabled themselves.
5757
*
5858
* When not enabled, _all_ input sources are ignored. To disable just one type of input; for example, the Mouse, use `input.mouse.enabled = false`.
59-
* @member {boolean}
59+
* @property {boolean} enabled
6060
* @default
6161
*/
6262
this.enabled = true;
@@ -990,7 +990,8 @@ Object.defineProperty(Phaser.Input.prototype, "worldY", {
990990
/**
991991
* _All_ input sources (eg. Mouse, Keyboard, Touch) are ignored when Input is disabled.
992992
* To disable just one type of input; for example, the Mouse, use `input.mouse.enabled = false`.
993-
* @member {boolean}
993+
* @property {boolean} disabled
994+
* @memberof Phaser.Input
994995
* @default false
995996
* @deprecated Use {@link Phaser.Input#enabled} instead
996997
*/

src/input/Keyboard.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Phaser.Keyboard = function (game) {
2323

2424
/**
2525
* Keyboard input will only be processed if enabled.
26-
* @member {boolean}
26+
* @property {boolean} enabled
2727
* @default
2828
*/
2929
this.enabled = true;
@@ -519,7 +519,8 @@ Phaser.Keyboard.prototype = {
519519

520520
/**
521521
* If disabled all Keyboard input will be ignored.
522-
* @member {boolean}
522+
* @property {boolean} disabled
523+
* @memberof Phaser.Keyboard
523524
* @default false
524525
* @deprecated Use {@link Phaser.Keyboard#enabled} instead
525526
*/

src/input/MSPointer.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Phaser.MSPointer = function (game) {
2828

2929
/**
3030
* MSPointer input will only be processed if enabled.
31-
* @member {boolean}
31+
* @property {boolean} enabled
3232
* @default
3333
*/
3434
this.enabled = true;
@@ -178,7 +178,8 @@ Phaser.MSPointer.prototype.constructor = Phaser.MSPointer;
178178

179179
/**
180180
* If disabled all MSPointer input will be ignored.
181-
* @member {boolean}
181+
* @property {boolean} disabled
182+
* @memberof Phaser.MSPointer
182183
* @default false
183184
* @deprecated Use {@link Phaser.MSPointer#enabled} instead
184185
*/

src/input/Mouse.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Phaser.Mouse = function (game) {
7474

7575
/**
7676
* Mouse input will only be processed if enabled.
77-
* @member {boolean}
77+
* @property {boolean} enabled
7878
* @default
7979
*/
8080
this.enabled = true;
@@ -548,7 +548,8 @@ Phaser.Mouse.prototype.constructor = Phaser.Mouse;
548548

549549
/**
550550
* If disabled all Mouse input will be ignored.
551-
* @member {boolean}
551+
* @property {boolean} disabled
552+
* @memberof Phaser.Mouse
552553
* @default false
553554
* @deprecated Use {@link Phaser.Mouse#enabled} instead
554555
*/

src/input/Touch.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Phaser.Touch = function (game) {
2020

2121
/**
2222
* Touch events will only be processed if enabled.
23-
* @member {boolean}
23+
* @property {boolean} enabled
2424
* @default
2525
*/
2626
this.enabled = true;
@@ -382,7 +382,8 @@ Phaser.Touch.prototype.constructor = Phaser.Touch;
382382

383383
/**
384384
* If disabled all Touch events will be ignored.
385-
* @member {boolean}
385+
* @property {boolean} disabled
386+
* @memberof Phaser.Touch
386387
* @default false
387388
* @deprecated Use {@link Phaser.Touch#enabled} instead
388389
*/

0 commit comments

Comments
 (0)