[Scummvm-cvs-logs] SF.net SVN: scummvm: [29560] scummvm/trunk/sound/mods

[fingolfin at users.sourceforge.net]

Revision: 29560
          http://scummvm.svn.sourceforge.net/scummvm/?rev=29560&view=rev
Author:   fingolfin
Date:     2007-11-18 13:13:08 -0800 (Sun, 18 Nov 2007)

Log Message:
-----------
factory functions should be documented at least roughly...

Modified Paths:
--------------
    scummvm/trunk/sound/mods/rjp1.h
    scummvm/trunk/sound/mods/soundfx.h

Modified: scummvm/trunk/sound/mods/rjp1.h
===================================================================
--- scummvm/trunk/sound/mods/rjp1.h	2007-11-18 20:27:31 UTC (rev 29559)
+++ scummvm/trunk/sound/mods/rjp1.h	2007-11-18 21:13:08 UTC (rev 29560)
@@ -32,6 +32,10 @@
 
 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

Modified: scummvm/trunk/sound/mods/soundfx.h
===================================================================
--- scummvm/trunk/sound/mods/soundfx.h	2007-11-18 20:27:31 UTC (rev 29559)
+++ scummvm/trunk/sound/mods/soundfx.h	2007-11-18 21:13:08 UTC (rev 29560)
@@ -32,6 +32,10 @@
 
 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


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.