Updated properties docs

This commit is contained in:
Pavle Goloskokovic 2018-01-06 17:40:23 +01:00
parent cc25f7052f
commit a570710a09

View file

@ -21,12 +21,14 @@ var BaseSoundManager = new Class({
/** /**
* Local reference to game. * Local reference to game.
* *
* @readonly
* @property {Phaser.Game} game * @property {Phaser.Game} game
*/ */
this.game = game; this.game = game;
/** /**
* [description] * Event dispatcher used to handle all sound manager related events.
* *
* @readonly
* @property {Phaser.Events.EventDispatcher} events * @property {Phaser.Events.EventDispatcher} events
*/ */
this.events = new EventDispatcher(); this.events = new EventDispatcher();
@ -34,7 +36,7 @@ var BaseSoundManager = new Class({
* An array containing all added sounds. * An array containing all added sounds.
* *
* @private * @private
* @property {Array} sounds * @property {ISound[]} sounds
*/ */
this.sounds = []; this.sounds = [];
/** /**
@ -66,7 +68,7 @@ var BaseSoundManager = new Class({
this.detune = 0; this.detune = 0;
/** /**
* Flag indicating if sounds should be paused when game looses focus, * Flag indicating if sounds should be paused when game looses focus,
* for instance when user switches tabs or to another program/app. * for instance when user switches to another tab/program/app.
* *
* @property {boolean} pauseOnBlur * @property {boolean} pauseOnBlur
*/ */
@ -84,15 +86,15 @@ var BaseSoundManager = new Class({
/** /**
* Property that actually holds the value of global playback rate. * Property that actually holds the value of global playback rate.
* *
* @property {number} _rate
* @private * @private
* @property {number} _rate
*/ */
this._rate = 1; this._rate = 1;
/** /**
* Property that actually holds the value of global detune. * Property that actually holds the value of global detune.
* *
* @property {number} _detune
* @private * @private
* @property {number} _detune
*/ */
this._detune = 0; this._detune = 0;
}, },