From 7d984d1a67a43e14e3fc32e9c1bbe91b3157b792 Mon Sep 17 00:00:00 2001
From: Max Horn
Date: Sun, 18 Nov 2007 21:13:08 +0000
Subject: factory functions should be documented at least roughly...

svn-id: r29560
---
 sound/mods/rjp1.h    | 4 ++++
 sound/mods/soundfx.h | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/sound/mods/rjp1.h b/sound/mods/rjp1.h
index 2fb54d88a6..c22c0a1a17 100644
--- a/sound/mods/rjp1.h
+++ b/sound/mods/rjp1.h
@@ -32,6 +32,10 @@ namespace Audio {
 
 class AudioStream;
 
+/*
+ * FIXME: Document this function. In particular, who is responsible for
+ * freeing the data passed in, resp. the AudioStream it returns?
+ */
 AudioStream *makeRjp1Stream(Common::SeekableReadStream *songData, Common::SeekableReadStream *instrumentsData, int num, int rate = 44100, bool stereo = true);
 
 } // End of namespace Audio
diff --git a/sound/mods/soundfx.h b/sound/mods/soundfx.h
index 353aa6ecdc..e724707193 100644
--- a/sound/mods/soundfx.h
+++ b/sound/mods/soundfx.h
@@ -32,6 +32,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?
+ */
 AudioStream *makeSoundFxStream(Common::SeekableReadStream *data, LoadSoundFxInstrumentCallback loadCb, int rate = 44100, bool stereo = true);
 
 } // End of namespace Audio
-- 
cgit v1.2.3