Updated/added some comments on VOC/WAVE functions

svn-id: r21384

1 files changed, 12 insertions, 4 deletions

diff --git a/sound/wave.h b/sound/wave.h
index cc18852362..f0aca0c9fc 100644
--- a/sound/wave.h
+++ b/sound/wave.h
@@ -30,13 +30,21 @@ class AudioStream;
 namespace Common { class SeekableReadStream; }
 
 /**
- * Try to load a WAVE from the given seekable stream. Returns true if successful; in that case,
- * the stream will point at the start of the audio data, and size, rate and flags contain
- * all information about the data necessary for playback.
- * Currently this only support uncompressed raw PCM data.
+ * Try to load a WAVE from the given seekable stream. Returns true if
+ * successful. In that case, the stream's seek position will be set to the
+ * start of the audio data, and size, rate and flags contain information
+ * necessary for playback. Currently this function only supports uncompressed
+ * raw PCM data as well as IMA ADPCM.
  */
 extern bool loadWAVFromStream(Common::SeekableReadStream &stream, int &size, int &rate, byte &flags, uint16 *wavType = 0, int *blockAlign = 0);
 
+/**
+ * Try to load a WAVE from the given seekable stream and create an AudioStream
+ * from that data. Currently this function only supports uncompressed raw PCM
+ * data as well as IMA ADPCM.
+ *
+ * This function uses loadWAVFromStream() internally.
+ */
 AudioStream *makeWAVStream(Common::SeekableReadStream &stream);
 
 #endif