From 41e332a80df0195050db773a87d35ac80ec0fec3 Mon Sep 17 00:00:00 2001
From: Matthew Hoops
Date: Tue, 7 Jun 2011 09:52:42 -0400
Subject: AUDIO: Clarify makeAACStream() usage

So we don't have anyone calling the function or attempting to make the AAC code seekable or anything crazy like that.
---
 audio/decoders/aac.h | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'audio')

diff --git a/audio/decoders/aac.h b/audio/decoders/aac.h
index f14fa9488b..efcbcc6f42 100644
--- a/audio/decoders/aac.h
+++ b/audio/decoders/aac.h
@@ -46,13 +46,16 @@ namespace Audio {
 class AudioStream;
 
 /**
- * Create a new AudioStream from the AAC data in the given stream.
+ * Create a new AudioStream from the AAC data of an MPEG-4 file in the given stream.
  *
- * @param stream			the SeekableReadStream from which to read the AAC data
+ * @note This should *only* be called by our QuickTime/MPEG-4 decoder since it relies
+ *       on the MPEG-4 extra data. If you want to decode a file using AAC, go use
+ *       makeQuickTimeStream() instead!
+ * @param stream            the SeekableReadStream from which to read the AAC data
  * @param disposeStream     whether to delete the stream after use
  * @param extraData         the SeekableReadStream from which to read the AAC extra data
  * @param disposeExtraData  whether to delete the extra data stream after use
- * @return	a new AudioStream, or NULL, if an error occurred
+ * @return  a new AudioStream, or NULL, if an error occurred
  */
 AudioStream *makeAACStream(
 	Common::SeekableReadStream *stream,
-- 
cgit v1.2.3