From debdf051f837d6496b13661c1f23033fe1926ce3 Mon Sep 17 00:00:00 2001
From: Dmitry Marakasov <amdmi3@amdmi3.ru>
Date: Fri, 26 Dec 2014 20:36:54 +0300
Subject: [PATCH] Document missing bits of AudioDevice

---
 SDL2pp/AudioDevice.hh | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/SDL2pp/AudioDevice.hh b/SDL2pp/AudioDevice.hh
index 3f265cc..d235ec3 100644
--- a/SDL2pp/AudioDevice.hh
+++ b/SDL2pp/AudioDevice.hh
@@ -155,14 +155,20 @@ public:
 		LockHandle& operator=(const LockHandle& other);
 	};
 
-	typedef std::function<void(Uint8* stream, int len)> AudioCallback;
+	typedef std::function<void(Uint8* stream, int len)> AudioCallback; ///< Function type for audio callback
 
 private:
 	SDL_AudioDeviceID device_id_; ///< SDL2 device id
 	AudioCallback callback_;      ///< Callback used to feed audio data to the device
 
 private:
-	////
+	////////////////////////////////////////////////////////////
+	/// \brief Static wrapper for audio callback
+	///
+	/// This only extracts this from userdata and
+	/// runs real this->callback_
+	///
+	////////////////////////////////////////////////////////////
 	static void SDLCallback(void *userdata, Uint8* stream, int len);
 
 public: