From ba74a8e7f657cf795046a5cf6a7ead701fd4194e Mon Sep 17 00:00:00 2001
From: Max Horn
Date: Sat, 27 Nov 2004 15:58:18 +0000
Subject: Added some more mixer doxygen docs; cleaned up Mixer API a bit,
 removing some very specialised methods

svn-id: r15914
---
 common/system.h | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'common')

diff --git a/common/system.h b/common/system.h
index da2c0fde5c..63e642a34c 100644
--- a/common/system.h
+++ b/common/system.h
@@ -569,6 +569,8 @@ public:
 	/**
 	 * Determine the output sample rate. Audio data provided by the sound
 	 * callback will be played using this rate.
+	 * @note Client code other than the sound mixer should _not_ use this
+	 *       method. Instead, call SoundMixer::getOutputRate()!
 	 * @return the output sample rate
 	 */
 	virtual int getOutputSampleRate() const = 0;
-- 
cgit v1.2.3