Make comments about new sound private for now

playcanvas · Jan 21, 2016 · a528b04 · a528b04
1 parent 4320856
commit a528b04
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 0 deletions.
diff --git a/src/framework/components/sound/component.js b/src/framework/components/sound/component.js
@@ -1,5 +1,6 @@
 pc.extend(pc, function () {
     /**
+    * @private
     * @component
     * @name pc.SoundComponent
     * @class The Sound Component controls playback of {@link pc.Sound}s.

diff --git a/src/framework/components/sound/slot.js b/src/framework/components/sound/slot.js
@@ -2,6 +2,7 @@ pc.extend(pc, function () {
     'use strict';
 
     /**
+     * @private
      * @name pc.SoundSlot
      * @class The SoundSlot controls playback of an audio asset.
      * @description Create a new SoundSlot

diff --git a/src/framework/components/sound/system.js b/src/framework/components/sound/system.js
@@ -1,5 +1,6 @@
 pc.extend(pc, function () {
     /**
+     * @private
      * @name pc.SoundComponentSystem
      * @class Manages creation of {@link pc.SoundComponent}s.
      * @description Create a SoundComponentSystem

diff --git a/src/sound/instance.js b/src/sound/instance.js
@@ -15,6 +15,7 @@ pc.extend(pc, function () {
 
     if (pc.SoundManager.hasAudioContext()) {
         /**
+        * @private
         * @name pc.SoundInstance
         * @class A pc.SoundInstance plays a {@link pc.Sound}
         * @param {pc.SoundManager} manager The sound manager

diff --git a/src/sound/instance3d.js b/src/sound/instance3d.js
@@ -8,6 +8,7 @@ pc.extend(pc, function () {
 
     if (pc.SoundManager.hasAudioContext()) {
         /**
+        * @private
         * @name pc.SoundInstance3d
         * @extends {pc.SoundInstance}
         * @class A pc.SoundInstance3d plays a {@link pc.Sound} in 3D

diff --git a/src/sound/manager.js b/src/sound/manager.js
@@ -24,6 +24,7 @@ pc.extend(pc, function () {
     }
 
     /**
+     * @private
      * @name pc.SoundManager
      * @class The SoundManager is used to load and play audio. As well as apply system-wide settings
      * like global volume, suspend and resume.