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

[lordhoto at users.sourceforge.net]

Revision: 46862
          http://scummvm.svn.sourceforge.net/scummvm/?rev=46862&view=rev
Author:   lordhoto
Date:     2010-01-01 22:56:18 +0000 (Fri, 01 Jan 2010)

Log Message:
-----------
Mention in documentation of AudioStream::setNumLoops, that this function also resets the number of loops played counter.

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

Modified: scummvm/trunk/sound/audiostream.h
===================================================================
--- scummvm/trunk/sound/audiostream.h	2010-01-01 22:55:38 UTC (rev 46861)
+++ scummvm/trunk/sound/audiostream.h	2010-01-01 22:56:18 UTC (rev 46862)
@@ -100,6 +100,10 @@
 
 	/** 
 	 * Sets number of times the stream is supposed to get looped
+	 * This also resets the number of loops played counter, which
+	 * can be queried with getNumPlayedLoops.
+	 * @see getNumPlayedLoops
+	 *
 	 * @param numLoops number of loops to play, 0 - infinite
 	 */
 	virtual void setNumLoops(uint numLoops = 1) {}


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