Tweaks to doxygen comments.

[simgear.git] / simgear / sound / sound.hxx

diff --git a/simgear/sound/sound.hxx b/simgear/sound/sound.hxx
index cd0c96ed9ef6630ee8e29f72648e8ef8fca9868e..8c3ebe33e05e182278f8818a47790e852a72a987 100644 (file)
--- a/simgear/sound/sound.hxx
+++ b/simgear/sound/sound.hxx
@@ -20,6 +20,12 @@
 //
 // $Id$
 
+/** 
+ * \file sound.hxx 
+ * Provides a class to manage a single sound event including things
+ * like looping, volume and pitch changes.
+ */
+
 #ifndef _SG_SOUND_HXX
 #define _SG_SOUND_HXX 1
 
@@ -39,15 +45,15 @@ static const double MAX_TRANSIT_TIME = 0.1; // 100 ms.
  * Class for handling one sound event.
  *
  */
-class Sound
+class SGSound
 {
 
 public:
 
-  Sound();
-  virtual ~Sound();
+  SGSound();
+  virtual ~SGSound();
 
-  virtual void init (SGPropertyNode *, SGPropertyNode *, SoundMgr *,
+  virtual void init (SGPropertyNode *, SGPropertyNode *, SGSoundMgr *,
                      const string &);
   virtual void update (double dt);
 
@@ -59,7 +65,7 @@ protected:
   enum { ONCE=0, LOOPED, IN_TRANSIT };
   enum { LEVEL=0, INVERTED, FLIPFLOP };
 
-  // Sound properties
+  // SGSound properties
   typedef struct {
         SGPropertyNode * prop;
         double (*fn)(double);
@@ -73,10 +79,10 @@ protected:
 
 private:
 
-  SoundMgr * _mgr;
-  SimpleSound * _sample;
+  SGSoundMgr * _mgr;
+  SGSimpleSound * _sample;
 
-  FGCondition * _condition;
+  SGCondition * _condition;
   SGPropertyNode * _property;
 
   bool _active;