Skip to content

Commit f76aff7

Browse files
Added properties docs
1 parent dbea4d2 commit f76aff7

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

v3/src/sound/BaseSound.js

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,16 @@ var BaseSound = new Class({
2222
*/
2323
this.manager = manager;
2424
/**
25-
* [description]
25+
* Asset key for the sound.
2626
*
27+
* @readonly
2728
* @property {string} key
2829
*/
2930
this.key = key;
3031
/**
31-
* Event dispatches used to handle all sound instance
32-
* relevant events.
32+
* Event dispatcher used to handle all sound instance relevant events.
3333
*
34+
* @readonly
3435
* @property {Phaser.Events.EventDispatcher}
3536
*/
3637
this.events = new EventDispatcher();
@@ -53,6 +54,7 @@ var BaseSound = new Class({
5354
* after its rate and detune values has been combined with global
5455
* rate and detune values.
5556
*
57+
* @readonly
5658
* @property {number} totalRate
5759
*/
5860
this.totalRate = 1;
@@ -65,15 +67,14 @@ var BaseSound = new Class({
6567
*/
6668
this.duration = this.duration || 0;
6769
/**
68-
* Duration of the entire sound.
70+
* The total duration of the sound in seconds.
6971
*
7072
* @readonly
7173
* @property {number}
7274
*/
7375
this.totalDuration = this.totalDuration || 0;
7476
/**
75-
* [description]
76-
*
77+
* A config object used to store default sound settings' values.
7778
* Default values will be set by properties' setters.
7879
*
7980
* @private
@@ -133,7 +134,7 @@ var BaseSound = new Class({
133134
*/
134135
this.seek = 0;
135136
/**
136-
* [description]
137+
* Flag indicating whether or not the sound or current sound marker will loop.
137138
*
138139
* @property {boolean} loop
139140
*/

0 commit comments

Comments
 (0)