From a836a83d84b26fd75fab7637641f77334b5e6827 Mon Sep 17 00:00:00 2001
From: Max Horn
Date: Fri, 3 Mar 2006 15:36:12 +0000
Subject: Explain the (admittedly strange) usage of some of our makeXXXStream
 factory functions

svn-id: r21040
---
 sound/mp3.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'sound/mp3.h')

diff --git a/sound/mp3.h b/sound/mp3.h
index 3ff5576330..db4f0cec6d 100644
--- a/sound/mp3.h
+++ b/sound/mp3.h
@@ -36,6 +36,12 @@ namespace Common {
 
 DigitalTrackInfo *getMP3Track(int track);
 
+/**
+ * Create a new AudioStream from the MP3 data in the given
+ * file. If you only want to play part of that file, then seek
+ * to the start position in file before passing it to this
+ * factory function, and specify the appropriate size.
+ */
 AudioStream *makeMP3Stream(Common::File *file, uint32 size);
 
 #endif
-- 
cgit v1.2.3