Skip to content

Commit 87c950a

Browse files
committed
Fixed jsdocs
1 parent 529442f commit 87c950a

1 file changed

Lines changed: 13 additions & 8 deletions

File tree

src/input/keyboard/KeyboardPlugin.js

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ var KeyboardPlugin = new Class({
9494
this.sceneInputPlugin = sceneInputPlugin;
9595

9696
/**
97-
* A boolean that controls if the Keyboard Manager is enabled or not.
97+
* A boolean that controls if the Keyboard Plugin is enabled or not.
9898
* Can be toggled on the fly.
9999
*
100100
* @name Phaser.Input.Keyboard.KeyboardPlugin#enabled
@@ -212,6 +212,7 @@ var KeyboardPlugin = new Class({
212212
* This is called automatically and does not need to be manually invoked.
213213
*
214214
* @method Phaser.Input.Keyboard.KeyboardPlugin#startListeners
215+
* @private
215216
* @since 3.10.0
216217
*/
217218
startListeners: function ()
@@ -242,7 +243,7 @@ var KeyboardPlugin = new Class({
242243
this.target.addEventListener('keydown', handler, false);
243244
this.target.addEventListener('keyup', handler, false);
244245

245-
// Finally, listen for an update event from the Input Manager
246+
// Finally, listen for an update event from the Input Plugin
246247
this.sceneInputPlugin.pluginEvents.on('update', this.update, this);
247248
},
248249

@@ -251,6 +252,7 @@ var KeyboardPlugin = new Class({
251252
* This is called automatically and does not need to be manually invoked.
252253
*
253254
* @method Phaser.Input.Keyboard.KeyboardPlugin#stopListeners
255+
* @private
254256
* @since 3.10.0
255257
*/
256258
stopListeners: function ()
@@ -345,7 +347,7 @@ var KeyboardPlugin = new Class({
345347
},
346348

347349
/**
348-
* Adds a Key object to the Keyboard Manager.
350+
* Adds a Key object to this Keyboard Plugin.
349351
*
350352
* The given argument can be either an existing Key object, a string, such as `A` or `SPACE`, or a key code value.
351353
*
@@ -392,7 +394,7 @@ var KeyboardPlugin = new Class({
392394
},
393395

394396
/**
395-
* Removes a Key object from the Keyboard Manager.
397+
* Removes a Key object from this Keyboard Plugin.
396398
*
397399
* The given argument can be either a Key object, a string, such as `A` or `SPACE`, or a key code value.
398400
*
@@ -429,7 +431,7 @@ var KeyboardPlugin = new Class({
429431
* Creates a new KeyCombo.
430432
*
431433
* A KeyCombo will listen for a specific string of keys from the Keyboard, and when it receives them
432-
* it will emit a `keycombomatch` event from the Keyboard Manager.
434+
* it will emit a `keycombomatch` event from this Keyboard Plugin.
433435
*
434436
* The keys to be listened for can be defined as:
435437
*
@@ -526,10 +528,11 @@ var KeyboardPlugin = new Class({
526528
},
527529

528530
/**
529-
* Shuts the Keyboard Manager down.
531+
* Shuts the Keyboard Plugin down.
530532
* All this does is remove any listeners bound to it.
531533
*
532534
* @method Phaser.Input.Keyboard.KeyboardPlugin#shutdown
535+
* @private
533536
* @since 3.10.0
534537
*/
535538
shutdown: function ()
@@ -540,9 +543,10 @@ var KeyboardPlugin = new Class({
540543
},
541544

542545
/**
543-
* Destroys this Keyboard Manager instance and all references it holds, plus clears out local arrays.
546+
* Destroys this Keyboard Plugin instance and all references it holds, plus clears out local arrays.
544547
*
545548
* @method Phaser.Input.Keyboard.KeyboardPlugin#destroy
549+
* @private
546550
* @since 3.10.0
547551
*/
548552
destroy: function ()
@@ -556,6 +560,7 @@ var KeyboardPlugin = new Class({
556560
this.scene = null;
557561
this.settings = null;
558562
this.sceneInputPlugin = null;
563+
this.target = null;
559564
}
560565

561566
});
@@ -568,6 +573,6 @@ var KeyboardPlugin = new Class({
568573
* @type {?Phaser.Input.Keyboard.KeyboardPlugin}
569574
* @since 3.10.0
570575
*/
571-
InputPluginCache.register('KeyboardPlugin', KeyboardPlugin, 'keyboard');
576+
InputPluginCache.register('KeyboardPlugin', KeyboardPlugin, 'keyboard', 'keyboard', 'inputKeyboard');
572577

573578
module.exports = KeyboardPlugin;

0 commit comments

Comments
 (0)