Updated comments with private and readonly descriptors

Author: pavle-goloskokovic

v3/src/sound/BaseSound.js

@@ -8,6 +8,7 @@ var BaseSound = new Class({
         /**
          * Local reference to the sound manager.
          *
+         * @private
          * @property {Phaser.Sound.BaseSoundManager} manager
          */
         this.manager = manager;
@@ -20,16 +21,17 @@ var BaseSound = new Class({
         /**
          * [description]
          *
-         * Duration set explicitly, rest of default values
-         * will be set by other properties setters.
+         * Default values will be set by properties' setters.
          *
+         * @private
          * @property {ISoundConfig} config
          */
         this.config = {};
         /**
          * Reference to the currently used config.
          * It could be default config or marker config.
          *
+         * @private
          * @property {ISoundConfig} currentConfig
          */
         this.currentConfig = this.config;
@@ -58,9 +60,6 @@ var BaseSound = new Class({
          * Represents detuning of sound in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).
          * The range of the value is -1200 to 1200, but we recommend setting it to [50](https://en.wikipedia.org/wiki/50_Cent).
          *
-         * Standards based Web Audio implementation only.
-         * Webkit Web Audio implementation and HTML5 Audio don't support this.
-         *
          * @property {number} detune
          */
         this.detune = 0;
@@ -109,31 +108,36 @@ var BaseSound = new Class({
         /**
          * Flag indicating if sound is currently playing.
          *
+         * @readonly
          * @property {boolean} isPlaying
          */
         this.isPlaying = false;
         /**
          * Flag indicating if sound is currently paused.
          *
+         * @readonly
          * @property {boolean} isPaused
          */
         this.isPaused = false;
         /**
          * Object containing markers definitions.
          *
+         * @readonly
          * @property {{}} markers
          */
         this.markers = {};
         /**
          * Currently playing marker.
          * 'null' if whole sound is playing.
          *
+         * @readonly
          * @property {ISoundMarker} currentMarker
          */
         this.currentMarker = null;
         /**
          * [description]
          *
+         * @private
          * @property {Phaser.Tween}
          */
         this.fadeTween = null; // TODO see how to use global tween
@@ -266,6 +270,9 @@ var BaseSound = new Class({
     fadeTo: function (volume, duration) {
         return null;
     },
+    /**
+     * @private
+     */
     update: NOOP,
     destroy: function () {
     },

v3/src/sound/BaseSoundManager.js

@@ -13,6 +13,7 @@ var BaseSoundManager = new Class({
         /**
          * An array containing all added sounds.
          *
+         * @private
          * @property {Array} sounds
          */
         this.sounds = [];
@@ -89,6 +90,13 @@ var BaseSoundManager = new Class({
         this._detune = 0;
     },
     add: NOOP,
+    /**
+     * [description]
+     *
+     * @param {string} key
+     * @param {ISoundConfig} config
+     * @returns {IAudioSpriteSound}
+     */
     addAudioSprite: function (key, config) {
         var sound = this.add(key, config);
         /**
@@ -117,11 +125,18 @@ var BaseSoundManager = new Class({
     pauseAll: NOOP,
     resumeAll: NOOP,
     stopAll: NOOP,
+    /**
+     * @private
+     */
     onBlur: NOOP,
+    /**
+     * @private
+     */
     onFocus: NOOP,
     /**
      * Update method called on every game step.
      *
+     * @private
      * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.
      * @param {number} delta - The delta time elapsed since the last frame.
      */

v3/src/sound/webaudio/WebAudioSound.js

@@ -10,6 +10,7 @@ var WebAudioSound = new Class({
         /**
          * [description]
          *
+         * @private
          * @property {AudioBuffer} audioBuffer
          */
         this.audioBuffer = manager.game.cache.audio.get(key);
@@ -20,32 +21,37 @@ var WebAudioSound = new Class({
         /**
          * [description]
          *
+         * @private
          * @property {AudioBufferSourceNode} source
          */
         this.source = null;
         /**
          * [description]
          *
+         * @private
          * @property {GainNode} muteNode
          */
         this.muteNode = manager.context.createGain();
         /**
          * [description]
          *
+         * @private
          * @property {GainNode} volumeNode
          */
         this.volumeNode = manager.context.createGain();
         /**
          * The time the previous playback started at based on
          * BaseAudioContext.currentTime value.
          *
+         * @private
          * @property {number} startTime
          */
         this.startTime = 0;
         /**
          * Relative time when sound was paused.
          * Corresponds to the seek value at the time when pause() method was called on this sound.
          *
+         * @private
          * @property {number} pausedTime
          */
         this.pausedTime = 0;

v3/src/sound/webaudio/WebAudioSoundManager.js

@@ -11,24 +11,28 @@ var WebAudioSoundManager = new Class({
          *
          * https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Porting_webkitAudioContext_code_to_standards_based_AudioContext
          *
+         * @private
          * @property {boolean} webkit
          */
         this.webkit = !!window['webkitAudioContext'] && !window['AudioContext'];
         /**
          * The AudioContext being used for playback.
          *
+         * @private
          * @property {AudioContext} context
          */
         this.context = this.createAudioContext(game);
         /**
          * [description]
          *
+         * @private
          * @property {GainNode} masterMuteNode
          */
         this.masterMuteNode = this.context.createGain();
         /**
          * [description]
          *
+         * @private
          * @property {GainNode} masterVolumeNode
          */
         this.masterVolumeNode = this.context.createGain();
@@ -37,6 +41,7 @@ var WebAudioSoundManager = new Class({
         /**
          * Destination node for connecting individual sounds to.
          *
+         * @private
          * @property {AudioNode} destination
          */
         this.destination = this.masterMuteNode;