[Scummvm-cvs-logs] SF.net SVN: scummvm:[48121] scummvm/trunk/sound/audiostream.h

[fingolfin at users.sourceforge.net]

Revision: 48121
          http://scummvm.svn.sourceforge.net/scummvm/?rev=48121&view=rev
Author:   fingolfin
Date:     2010-02-23 22:52:18 +0000 (Tue, 23 Feb 2010)

Log Message:
-----------
Tweak QueuingAudioStream comments

Modified Paths:
--------------
    scummvm/trunk/sound/audiostream.h

Modified: scummvm/trunk/sound/audiostream.h
===================================================================
--- scummvm/trunk/sound/audiostream.h	2010-02-23 22:50:28 UTC (rev 48120)
+++ scummvm/trunk/sound/audiostream.h	2010-02-23 22:52:18 UTC (rev 48121)
@@ -301,26 +301,32 @@
 public:
 
 	/**
-	 * Queue an audio stream for playback. This stream will
-	 * play all queued streams, in the order they were queued.
-	 * If the disposeAfterUse is true, then the stream is
-	 * deleted after all data contained in it has been played.
+	 * Queue an audio stream for playback. This stream plays all queued
+	 * streams, in the order they were queued. If disposeAfterUse is set to
+	 * DisposeAfterUse::YES, then the queued stream is deleted after all data
+	 * contained in it has been played.
 	 */
 	virtual void queueAudioStream(Audio::AudioStream *audStream,
 						DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::YES) = 0;
 
 	/**
-	 * Queue a block of raw audio data for playback. This stream
-	 * will play all queued buffers, in the order they were
-	 * queued. After all data contained in them has been played,
-	 * the buffer will be released using free(). So make sure to
-	 * allocate them with malloc(), not with new[]).
+	 * Queue a block of raw audio data for playback. This stream plays all
+	 * queued block, in the order they were queued. If disposeAfterUse is set
+	 * to DisposeAfterUse::YES, then the queued block is released using free()
+	 * after all data contained in it has been played.
+	 *
+	 * @note Make sure to allocate the data block with malloc(), not with new[].
+	 *
+	 * @param data	pointer to the audio data block
+	 * @param size	length of the audio data block
+	 * @param disposeAfterUse	if equal to DisposeAfterUse::YES, the block is released using free() after use.
+	 * @param flags	a bit-ORed combination of RawFlags describing the audio data format
 	 */
 	void queueBuffer(byte *data, uint32 size, DisposeAfterUse::Flag disposeAfterUse, byte flags);
 
 	/**
-	 * Mark the stream as finished, that is, signal that no further data
-	 * will be appended to it. Only after this has been done can this
+	 * Mark this stream as finished. That is, signal that no further data
+	 * will be queued to it. Only after this has been done can this
 	 * stream ever 'end'.
 	 */
 	virtual void finish() = 0;


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