diff options
Diffstat (limited to 'sound/mods/rjp1.h')
| -rw-r--r-- | sound/mods/rjp1.h | 5 |
1 files changed, 3 insertions, 2 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); |