From b7f9d4797dc073c6035ccef8cfc1e063ce9a3105 Mon Sep 17 00:00:00 2001
From: Gregory Montoir
Date: Sat, 8 Dec 2007 09:20:18 +0000
Subject: doc

svn-id: r29759
---
 sound/mods/rjp1.h    | 5 +++--
 sound/mods/soundfx.h | 6 ++++--
 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/sound/mods/rjp1.h b/sound/mods/rjp1.h
index c22c0a1a17..9a4947456e 100644
--- a/sound/mods/rjp1.h
+++ b/sound/mods/rjp1.h
@@ -33,8 +33,9 @@ namespace Audio {
 class AudioStream;
 
 /*
- * FIXME: Document this function. In particular, who is responsible for
- * freeing the data passed in, resp. the AudioStream it returns?
+ * Factory function for RichardJoseph1 modules. Reads all data from the
+ * given songData and instrumentsData streams and creates an AudioStream
+ * from this. No references to these stream objects are kept.
  */
 AudioStream *makeRjp1Stream(Common::SeekableReadStream *songData, Common::SeekableReadStream *instrumentsData, int num, int rate = 44100, bool stereo = true);
 
diff --git a/sound/mods/soundfx.h b/sound/mods/soundfx.h
index e724707193..f94bd59f15 100644
--- a/sound/mods/soundfx.h
+++ b/sound/mods/soundfx.h
@@ -33,8 +33,10 @@ class AudioStream;
 typedef byte *(*LoadSoundFxInstrumentCallback)(const char *name, uint32 *size);
 
 /*
- * FIXME: Document this function. In particular, who is responsible for
- * freeing the data passed in, resp. the AudioStream it returns?
+ * Factory function for SoundFX modules. Reads all data from the
+ * given data stream and creates an AudioStream from this (no references to the
+ * stream object is kept). If loadCb is non 0, then instruments are loaded using
+ * it, buffers returned are free'd at the end of playback.
  */
 AudioStream *makeSoundFxStream(Common::SeekableReadStream *data, LoadSoundFxInstrumentCallback loadCb, int rate = 44100, bool stereo = true);
 
-- 
cgit v1.2.3