From 02d2472baacd8ac091a29392a2bc9ac8693fb5e7 Mon Sep 17 00:00:00 2001 From: Joerg Mueller Date: Tue, 16 Aug 2011 13:00:55 +0000 Subject: 3D Audio GSoC: Code documentation. Also: * Fix: rlint for MSVC. * Minor other small fixes/changes. --- intern/audaspace/OpenAL/AUD_OpenALDevice.h | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'intern/audaspace/OpenAL') diff --git a/intern/audaspace/OpenAL/AUD_OpenALDevice.h b/intern/audaspace/OpenAL/AUD_OpenALDevice.h index 3e8b05d79e2..a04b483132a 100644 --- a/intern/audaspace/OpenAL/AUD_OpenALDevice.h +++ b/intern/audaspace/OpenAL/AUD_OpenALDevice.h @@ -100,6 +100,13 @@ private: public: + /** + * Creates a new OpenAL handle. + * \param device The OpenAL device the handle belongs to. + * \param format The AL format. + * \param reader The reader this handle plays. + * \param keep Whether to keep the handle alive when the reader ends. + */ AUD_OpenALHandle(AUD_OpenALDevice* device, ALenum format, AUD_Reference reader, bool keep); virtual ~AUD_OpenALHandle() {} @@ -214,6 +221,7 @@ private: /** * Starts the streaming thread. + * \param Whether the previous thread should be joined. */ void start(bool join = true); -- cgit v1.2.3