Skip to content

Commit 8ca1ce0

Browse files
committed
Changed SoundJS static/private properties to be @Private instead of @Protected
1 parent 1e7569d commit 8ca1ce0

File tree

8 files changed

+42
-42
lines changed

8 files changed

+42
-42
lines changed

src/soundjs/AbstractPlugin.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ this.createjs = this.createjs || {};
112112
* @property _capabilities
113113
* @type {Object}
114114
* @default null
115-
* @protected
115+
* @private
116116
* @static
117117
*/
118118
AbstractPlugin._capabilities = null;

src/soundjs/Sound.js

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ this.createjs = this.createjs || {};
384384
* @property FILE_PATTERN
385385
* @type {RegExp}
386386
* @static
387-
* @protected
387+
* @private
388388
*/
389389
s.FILE_PATTERN = /^(?:(\w+:)\/{2}(\w+(?:\.\w+)*\/?))?([/.]*?(?:[^?]+)?\/)?((?:[^/?]+)\.(\w+))(?:\?(\S+)?)?$/;
390390

@@ -558,7 +558,7 @@ this.createjs = this.createjs || {};
558558
* @type {Boolean}
559559
* @default false
560560
* @static
561-
* @protected
561+
* @private
562562
*/
563563
s._pluginsRegistered = false;
564564

@@ -567,7 +567,7 @@ this.createjs = this.createjs || {};
567567
* @property _lastID
568568
* @type {Number}
569569
* @static
570-
* @protected
570+
* @private
571571
*/
572572
s._lastID = 0;
573573

@@ -579,7 +579,7 @@ this.createjs = this.createjs || {};
579579
* method.
580580
* @property _instances
581581
* @type {Array}
582-
* @protected
582+
* @private
583583
* @static
584584
*/
585585
s._instances = [];
@@ -588,7 +588,7 @@ this.createjs = this.createjs || {};
588588
* An object hash storing objects with sound sources, startTime, and duration via there corresponding ID.
589589
* @property _idHash
590590
* @type {Object}
591-
* @protected
591+
* @private
592592
* @static
593593
*/
594594
s._idHash = {};
@@ -599,7 +599,7 @@ this.createjs = this.createjs || {};
599599
* and data.
600600
* @property _preloadHash
601601
* @type {Object}
602-
* @protected
602+
* @private
603603
* @static
604604
*/
605605
s._preloadHash = {};
@@ -609,7 +609,7 @@ this.createjs = this.createjs || {};
609609
* {{#crossLink "Sound/registerSound"}}{{/crossLink}} and {{#crossLink "Sound/registerSounds"}}{{/crossLink}}.
610610
* @property _defaultPlayPropsHash
611611
* @type {Object}
612-
* @protected
612+
* @private
613613
* @static
614614
* @since 0.6.1
615615
*/
@@ -666,7 +666,7 @@ this.createjs = this.createjs || {};
666666
* <li>types: A list of file types that are supported by Sound (currently supports "sound").</li>
667667
* <li>extensions: A list of file extensions that are supported by Sound (see {{#crossLink "Sound/SUPPORTED_EXTENSIONS:property"}}{{/crossLink}}).</li></ul>
668668
* @static
669-
* @protected
669+
* @private
670670
*/
671671
s.getPreloadHandlers = function () {
672672
return {
@@ -680,7 +680,7 @@ this.createjs = this.createjs || {};
680680
* Used to dispatch fileload events from internal loading.
681681
* @method _handleLoadComplete
682682
* @param event A loader event.
683-
* @protected
683+
* @private
684684
* @static
685685
* @since 0.6.0
686686
*/
@@ -707,7 +707,7 @@ this.createjs = this.createjs || {};
707707
/**
708708
* Used to dispatch error events from internal preloading.
709709
* @param event
710-
* @protected
710+
* @private
711711
* @since 0.6.0
712712
* @static
713713
*/
@@ -818,7 +818,7 @@ this.createjs = this.createjs || {};
818818
* @method initLoad
819819
* @param {Object} src The object to load.
820820
* @return {Object|AbstractLoader} An instance of AbstractLoader.
821-
* @protected
821+
* @private
822822
* @static
823823
*/
824824
s.initLoad = function (loadItem) {
@@ -1154,7 +1154,7 @@ this.createjs = this.createjs || {};
11541154
* @param {String} value The path to an audio source.
11551155
* @return {Object} A formatted object that can be registered with the {{#crossLink "Sound/activePlugin:property"}}{{/crossLink}}
11561156
* and returned to a preloader like <a href="http://preloadjs.com" target="_blank">PreloadJS</a>.
1157-
* @protected
1157+
* @private
11581158
* @static
11591159
*/
11601160
s._parsePath = function (value) {
@@ -1184,7 +1184,7 @@ this.createjs = this.createjs || {};
11841184
* @param {Object} value The paths to an audio source, indexed by extension type.
11851185
* @return {Object} A formatted object that can be registered with the {{#crossLink "Sound/activePlugin:property"}}{{/crossLink}}
11861186
* and returned to a preloader like <a href="http://preloadjs.com" target="_blank">PreloadJS</a>.
1187-
* @protected
1187+
* @private
11881188
* @static
11891189
*/
11901190
s._parseSrc = function (value) {
@@ -1363,7 +1363,7 @@ this.createjs = this.createjs || {};
13631363
* @param {PlayPropsConfig} playProps A PlayPropsConfig object.
13641364
* @return {Boolean} If the sound can start playing. Sounds that fail immediately will return false. Sounds that
13651365
* have a delay will return true, but may still fail to play.
1366-
* @protected
1366+
* @private
13671367
* @static
13681368
*/
13691369
s._playInstance = function (instance, playProps) {
@@ -1399,7 +1399,7 @@ this.createjs = this.createjs || {};
13991399
* @param {PlayPropsConfig} playProps A PlayPropsConfig object.
14001400
* @return {Boolean} If the sound can start playing. If there are no available channels, or the instance fails to
14011401
* start, this will return false.
1402-
* @protected
1402+
* @private
14031403
* @static
14041404
*/
14051405
s._beginPlaying = function (instance, playProps) {
@@ -1421,7 +1421,7 @@ this.createjs = this.createjs || {};
14211421
* @method _getSrcById
14221422
* @param {String} value The ID the sound was registered with.
14231423
* @return {String} The source of the sound if it has been registered with this ID or the value that was passed in.
1424-
* @protected
1424+
* @private
14251425
* @static
14261426
*/
14271427
s._getSrcById = function (value) {
@@ -1434,7 +1434,7 @@ this.createjs = this.createjs || {};
14341434
* instances themselves.
14351435
* @method _playFinished
14361436
* @param {AbstractSoundInstance} instance The instance that finished playback.
1437-
* @protected
1437+
* @private
14381438
* @static
14391439
*/
14401440
s._playFinished = function (instance) {

src/soundjs/cordovaaudio/CordovaAudioPlugin.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ this.createjs = this.createjs || {};
9393
* of the available properties.
9494
* @property _capabilities
9595
* @type {Object}
96-
* @protected
96+
* @private
9797
* @static
9898
*/
9999
s._capabilities = null;
@@ -117,7 +117,7 @@ this.createjs = this.createjs || {};
117117
* method for an overview of plugin capabilities.
118118
* @method _generateCapabilities
119119
* @static
120-
* @protected
120+
* @private
121121
*/
122122
s._generateCapabilities = function () {
123123
if (s._capabilities != null || !(window.cordova || window.PhoneGap || window.phonegap) || !window.Media) {return;}

src/soundjs/flashaudio/FlashAudioLoader.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,15 @@ this.createjs = this.createjs || {};
6969
* A reference to the Flash instance that gets created.
7070
* @property flash
7171
* @type {Object | Embed}
72-
* @protected
72+
* @private
7373
*/
7474
s._flash = null;
7575

7676
/**
7777
* A list of loader instances that tried to load before _flash was set
7878
* @property _preloadInstances
7979
* @type {Array}
80-
* @protected
80+
* @private
8181
*/
8282
s._preloadInstances = [];
8383

src/soundjs/flashaudio/FlashAudioPlugin.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ this.createjs = this.createjs || {};
183183
* @type {String}
184184
* @default registerflashid
185185
* @static
186-
* @protected
186+
* @private
187187
*/
188188
s._REG_FLASHID = "registerflashid";
189189

@@ -193,7 +193,7 @@ this.createjs = this.createjs || {};
193193
* @type {String}
194194
* @default unregisterflashid
195195
* @static
196-
* @protected
196+
* @private
197197
*/
198198
s._UNREG_FLASHID = "unregisterflashid";
199199

@@ -203,7 +203,7 @@ this.createjs = this.createjs || {};
203203
* capabilities.
204204
* @property _capabilities
205205
* @type {Object}
206-
* @protected
206+
* @private
207207
* @static
208208
*/
209209
s._capabilities = null;
@@ -240,7 +240,7 @@ this.createjs = this.createjs || {};
240240
* method for an overview of plugin capabilities.
241241
* @method _generateCapabilities
242242
* @static
243-
* @protected
243+
* @private
244244
*/
245245
s._generateCapabilities = function () {
246246
if (s._capabilities != null) {return;}

src/soundjs/htmlaudio/HTMLAudioPlugin.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ this.createjs = this.createjs || {};
120120
* @type {String}
121121
* @default canplaythrough
122122
* @static
123-
* @protected
123+
* @private
124124
*/
125125
s._AUDIO_READY = "canplaythrough";
126126

@@ -130,7 +130,7 @@ this.createjs = this.createjs || {};
130130
* @type {String}
131131
* @default ended
132132
* @static
133-
* @protected
133+
* @private
134134
*/
135135
s._AUDIO_ENDED = "ended";
136136

@@ -140,7 +140,7 @@ this.createjs = this.createjs || {};
140140
* @type {String}
141141
* @default seeked
142142
* @static
143-
* @protected
143+
* @private
144144
*/
145145
s._AUDIO_SEEKED = "seeked";
146146

@@ -150,7 +150,7 @@ this.createjs = this.createjs || {};
150150
* @type {String}
151151
* @default stalled
152152
* @static
153-
* @protected
153+
* @private
154154
*/
155155
s._AUDIO_STALLED = "stalled";
156156

@@ -161,7 +161,7 @@ this.createjs = this.createjs || {};
161161
* @type {String}
162162
* @default timeupdate
163163
* @static
164-
* @protected
164+
* @private
165165
*/
166166
s._TIME_UPDATE = "timeupdate";
167167

@@ -171,7 +171,7 @@ this.createjs = this.createjs || {};
171171
* of the available properties.
172172
* @property _capabilities
173173
* @type {Object}
174-
* @protected
174+
* @private
175175
* @static
176176
*/
177177
s._capabilities = null;
@@ -195,7 +195,7 @@ this.createjs = this.createjs || {};
195195
* method for an overview of plugin capabilities.
196196
* @method _generateCapabilities
197197
* @static
198-
* @protected
198+
* @private
199199
*/
200200
s._generateCapabilities = function () {
201201
if (s._capabilities != null) {return;}

src/soundjs/htmlaudio/HTMLAudioTagPool.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ this.createjs = this.createjs || {};
5555
* @property _tags
5656
* @type {{}}
5757
* @static
58-
* @protected
58+
* @private
5959
*/
6060
s._tags = {};
6161

@@ -64,15 +64,15 @@ this.createjs = this.createjs || {};
6464
* @property _tagPool
6565
* @type {TagPool}
6666
* @static
67-
* @protected
67+
* @private
6868
*/
6969
s._tagPool = new TagPool();
7070

7171
/**
7272
* A hash lookup of if a base audio tag is available, indexed by the audio source
7373
* @property _tagsUsed
7474
* @type {{}}
75-
* @protected
75+
* @private
7676
* @static
7777
*/
7878
s._tagUsed = {};

src/soundjs/webaudio/WebAudioPlugin.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ this.createjs = this.createjs || {};
134134
* @property _capabilities
135135
* @type {Object}
136136
* @default null
137-
* @protected
137+
* @private
138138
* @static
139139
*/
140140
s._capabilities = null;
@@ -143,7 +143,7 @@ this.createjs = this.createjs || {};
143143
* Value to set panning model to equal power for WebAudioSoundInstance. Can be "equalpower" or 0 depending on browser implementation.
144144
* @property _panningModel
145145
* @type {Number / String}
146-
* @protected
146+
* @private
147147
* @static
148148
*/
149149
s._panningModel = "equalpower";
@@ -170,7 +170,7 @@ this.createjs = this.createjs || {};
170170
*
171171
* @property _scratchBuffer
172172
* @type {AudioBuffer}
173-
* @protected
173+
* @private
174174
* @static
175175
*/
176176
s._scratchBuffer = null;
@@ -234,7 +234,7 @@ this.createjs = this.createjs || {};
234234
* @method _isFileXHRSupported
235235
* @return {Boolean} If XHR is supported.
236236
* @since 0.4.2
237-
* @protected
237+
* @private
238238
* @static
239239
*/
240240
s._isFileXHRSupported = function() {
@@ -267,7 +267,7 @@ this.createjs = this.createjs || {};
267267
* method for an overview of plugin capabilities.
268268
* @method _generateCapabilities
269269
* @static
270-
* @protected
270+
* @private
271271
*/
272272
s._generateCapabilities = function () {
273273
if (s._capabilities != null) {return;}
@@ -329,7 +329,7 @@ this.createjs = this.createjs || {};
329329
*
330330
* @method _compatibilitySetUp
331331
* @static
332-
* @protected
332+
* @private
333333
* @since 0.4.2
334334
*/
335335
s._compatibilitySetUp = function() {

0 commit comments

Comments
 (0)