diff options
| author | Max Horn | 2007-11-18 21:13:08 +0000 |
|---|---|---|
| committer | Max Horn | 2007-11-18 21:13:08 +0000 |
| commit | 7d984d1a67a43e14e3fc32e9c1bbe91b3157b792 (patch) | |
| tree | 6ba0b73bbd3d0491cf8cf2096dc9fc04e7333519 | |
| parent | c76c6e22567b7b2f89acdf53cb73ed2cf9cac2d3 (diff) | |
| download | scummvm-rg350-7d984d1a67a43e14e3fc32e9c1bbe91b3157b792.tar.gz scummvm-rg350-7d984d1a67a43e14e3fc32e9c1bbe91b3157b792.tar.bz2 scummvm-rg350-7d984d1a67a43e14e3fc32e9c1bbe91b3157b792.zip | |
factory functions should be documented at least roughly...
svn-id: r29560
| -rw-r--r-- | sound/mods/rjp1.h | 4 | ||||
| -rw-r--r-- | sound/mods/soundfx.h | 4 |
2 files changed, 8 insertions, 0 deletions
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 |