Skip to content

Commit f95b35e

Browse files
committed
Finished off descriptions for Data, Plugins and Sound.
1 parent b6768f8 commit f95b35e

4 files changed

Lines changed: 13 additions & 19 deletions

File tree

src/data/DataManagerPlugin.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ var PluginCache = require('../plugins/PluginCache');
2020
* @constructor
2121
* @since 3.0.0
2222
*
23-
* @param {Phaser.Scene} scene - [description]
23+
* @param {Phaser.Scene} scene - A reference to the Scene that this DataManager belongs to.
2424
*/
2525
var DataManagerPlugin = new Class({
2626

@@ -33,7 +33,7 @@ var DataManagerPlugin = new Class({
3333
DataManager.call(this, scene, scene.sys.events);
3434

3535
/**
36-
* [description]
36+
* The Scene that this DataManager belongs to.
3737
*
3838
* @name Phaser.Data.DataManagerPlugin#scene
3939
* @type {Phaser.Scene}
@@ -42,7 +42,7 @@ var DataManagerPlugin = new Class({
4242
this.scene = scene;
4343

4444
/**
45-
* [description]
45+
* The Systems of the Scene that this DataManager belongs to.
4646
*
4747
* @name Phaser.Data.DataManagerPlugin#systems
4848
* @type {Phaser.Scenes.Systems}

src/plugins/BasePlugin.js

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,17 @@
66

77
var Class = require('../utils/Class');
88

9-
// A Scene Level Plugin is installed into every Scene and belongs to that Scene.
10-
// It can listen for Scene events and respond to them.
11-
// It can map itself to a Scene property, or into the Scene Systems, or both.
12-
//
13-
// A Global Plugin is installed just once into the Game owned Plugin Manager.
14-
// It can listen for Game events and respond to them.
15-
169
/**
1710
* @classdesc
18-
* [description]
11+
* A Global Plugin is installed just once into the Game owned Plugin Manager.
12+
* It can listen for Game events and respond to them.
1913
*
2014
* @class BasePlugin
2115
* @memberOf Phaser.Plugins
2216
* @constructor
2317
* @since 3.8.0
2418
*
25-
* @param {Phaser.Game} game - [description]
19+
* @param {Phaser.Game} game - A reference to the Game instance this plugin is running under.
2620
*/
2721
var BasePlugin = new Class({
2822

@@ -33,7 +27,7 @@ var BasePlugin = new Class({
3327
/**
3428
* A handy reference to the Plugin Manager that is responsible for this plugin.
3529
* Can be used as a route to gain access to game systems and events.
36-
*
30+
*
3731
* @name Phaser.Plugins.BasePlugin#pluginManager
3832
* @type {Phaser.Plugins.PluginManager}
3933
* @protected

src/plugins/ScenePlugin.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ var Class = require('../utils/Class');
1919
* @constructor
2020
* @since 3.8.0
2121
*
22-
* @param {Phaser.Game} game - [description]
22+
* @param {Phaser.Game} game - A reference to the Scene that has installed this plugin.
2323
*/
2424
var ScenePlugin = new Class({
2525

src/sound/BaseSoundManager.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ var NOOP = require('../utils/NOOP');
1313
/**
1414
* @callback EachActiveSoundCallback
1515
*
16-
* @param {Phaser.Sound.BaseSoundManager} manager - [description]
17-
* @param {Phaser.Sound.BaseSound} sound - [description]
18-
* @param {number} index - [description]
19-
* @param {Phaser.Sound.BaseSound[]} sounds - [description]
16+
* @param {Phaser.Sound.BaseSoundManager} manager - The SoundManager
17+
* @param {Phaser.Sound.BaseSound} sound - The active Sound
18+
* @param {number} index - The index
19+
* @param {Phaser.Sound.BaseSound[]} sounds - All sounds
2020
*/
2121

2222
/**
@@ -527,7 +527,7 @@ var BaseSoundManager = new Class({
527527
* @private
528528
* @since 3.0.0
529529
*
530-
* @param {EachActiveSoundCallback} callback - Callback function. (sound: ISound, index: number, array: ISound[]) => void
530+
* @param {EachActiveSoundCallback} callback - Callback function. (manager: Phaser.Sound.BaseSoundManager, sound: Phaser.Sound.BaseSound, index: number, sounds: Phaser.Manager.BaseSound[]) => void
531531
* @param {*} [scope] - Callback context.
532532
*/
533533
forEachActiveSound: function (callback, scope)

0 commit comments

Comments
 (0)