Tweaks to doxygen comments.

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

diff --git a/simgear/sound/soundmgr.hxx b/simgear/sound/soundmgr.hxx
index 962459994ba2cb5c9f0a191171ecd63cac7553eb..655becef69890a248ede5223250afd98a721939a 100644 (file)
--- a/simgear/sound/soundmgr.hxx
+++ b/simgear/sound/soundmgr.hxx
@@ -23,6 +23,12 @@
 //
 // $Id$
 
+/**
+ * \file soundmgr.hxx
+ * Provides a sound manager class to keep track of
+ * multiple sounds and manage playing them with different effects and
+ * timings.
+ */
 
 #ifndef _SG_SOUNDMGR_HXX
 #define _SG_SOUNDMGR_HXX 1
@@ -44,8 +50,10 @@ SG_USING_STD(map);
 SG_USING_STD(string);
 
 
-// manages everything we need to know for an individual sound sample
-class SimpleSound {
+/**
+ * manages everything we need to know for an individual sound sample
+ */
+class SGSimpleSound {
 
 private:
 
@@ -57,9 +65,9 @@ private:
 
 public:
 
-    SimpleSound( const char *path, const char *file = NULL );
-    SimpleSound( unsigned char *buffer, int len );
-    ~SimpleSound();
+    SGSimpleSound( const char *path, const char *file = NULL );
+    SGSimpleSound( unsigned char *buffer, int len );
+    ~SGSimpleSound();
 
     void play( slScheduler *sched, bool looped );
     void stop( slScheduler *sched, bool quick = true );
@@ -96,13 +104,15 @@ typedef map < string, sample_ref * > sample_map;
 typedef sample_map::iterator sample_map_iterator;
 typedef sample_map::const_iterator const_sample_map_iterator;
 
-
-typedef map < string, SimpleSound * > sound_map;
+typedef map < string, SGSimpleSound * > sound_map;
 typedef sound_map::iterator sound_map_iterator;
 typedef sound_map::const_iterator const_sound_map_iterator;
 
 
-class SoundMgr
+/**
+ * Manage a collection of SGSimpleSound instances
+ */
+class SGSoundMgr
 {
 
     slScheduler *audio_sched;
@@ -115,8 +125,8 @@ class SoundMgr
 
 public:
 
-    SoundMgr();
-    ~SoundMgr();
+    SGSoundMgr();
+    ~SGSoundMgr();
 
 
     /**
@@ -155,43 +165,67 @@ public:
     void resume ();
 
 
-    // is audio working?
+    /**
+     * is audio working?
+     */
     inline bool is_working() const { return !audio_sched->notWorking(); }
 
-    // reinitialize the sound manager
+    /**
+     * reinitialize the sound manager
+     */
     inline void reinit() { init(); }
 
-    // add a sound effect, return true if successful
-    bool add( SimpleSound *sound, const string& refname);
+    /**
+     * add a sound effect, return true if successful
+     */
+    bool add( SGSimpleSound *sound, const string& refname);
 
-    // add a sound file, return the sample if successful, else return NULL
-    SimpleSound *add( const string& refname,
+    /**
+     * add a sound file, return the sample if successful, else return NULL
+     */
+    SGSimpleSound *add( const string& refname,
                       const char *path, const char *file = NULL );
 
-    // remove a sound effect, return true if successful
+    /** 
+     * remove a sound effect, return true if successful
+     */
     bool remove( const string& refname );
 
-    // return true of the specified sound exists in the sound manager system
+    /**
+     * return true of the specified sound exists in the sound manager system
+     */
     bool exists( const string& refname );
 
-    // return a pointer to the SimpleSound if the specified sound
-    // exists in the sound manager system, otherwise return NULL
-    SimpleSound *find( const string& refname );
+    /**
+     * return a pointer to the SGSimpleSound if the specified sound
+     * exists in the sound manager system, otherwise return NULL
+     */
+     SGSimpleSound *find( const string& refname );
 
-    // tell the scheduler to play the indexed sample in a continuous
-    // loop
+    /**
+     * tell the scheduler to play the indexed sample in a continuous
+     * loop
+     */
     bool play_looped( const string& refname );
 
-    // tell the scheduler to play the indexed sample once
+    /**
+     * tell the scheduler to play the indexed sample once
+     */
     bool play_once( const string& refname );
 
-    // return true of the specified sound is currently being played
+    /**
+     * return true of the specified sound is currently being played
+     */
     bool is_playing( const string& refname );
 
-    // immediate stop playing the sound
+    /**
+     * immediate stop playing the sound
+     */
     bool stop( const string& refname );
 
-    // return the audio scheduler 
+    /** 
+     * return the audio scheduler 
+     */
     inline slScheduler *get_scheduler( ) { return audio_sched; };
 };