Cleanup and documentation.

svn-id: r50609

1 files changed, 43 insertions, 0 deletions

diff --git a/backends/mixer/sdl/sdl-mixer.h b/backends/mixer/sdl/sdl-mixer.h
index f58260fef2..1b3a3543dc 100644
--- a/backends/mixer/sdl/sdl-mixer.h
+++ b/backends/mixer/sdl/sdl-mixer.h
@@ -34,28 +34,71 @@
 
 #include "sound/mixer_intern.h"
 
+/**
+ * SDL mixer manager. It wraps the actual implementation
+ * of the Audio:Mixer used by the engine, and setups
+ * the SDL audio subsystem and the callback for the
+ * audio mixer implementation.
+ */
 class SdlMixerManager {
 public:
 	SdlMixerManager();
 	virtual ~SdlMixerManager();
 
+	/**
+	 * Initialize and setups the mixer
+	 */
 	virtual void init();
 
+	/**
+	 * Get the audio mixer implementation
+	 */
 	Audio::Mixer *getMixer() { return (Audio::Mixer *)_mixer; }
 
 	// Used by LinuxMoto Port
+
+	/**
+	 * Pauses the audio system
+	 */
 	virtual void suspendAudio();
+
+	/**
+	 * Resumes the audio system
+	 */
 	virtual int resumeAudio();
 
 protected:
+	/** The mixer implementation */
 	Audio::MixerImpl *_mixer;
+
+	/**
+	 * The obtained audio specification after opening the
+	 * audio system.
+	 */
 	SDL_AudioSpec _obtainedRate;
+
+	/** State of the audio system */
 	bool _audioSuspended;
 
+	/**
+	 * Returns the desired audio specification 
+	 */
 	virtual SDL_AudioSpec getAudioSpec();
+
+	/**
+	 * Starts SDL audio
+	 */
 	virtual void startAudio();
 
+	/**
+	 * Handles the audio callback
+	 */
 	virtual void callbackHandler(byte *samples, int len);
+
+	/**
+	 * The mixer callback entry point. Static functions can't be overrided
+	 * by subclasses, so it invokes the non-static function callbackHandler()
+	 */
 	static void sdlCallback(void *this_, byte *samples, int len);
 };