[Scummvm-cvs-logs] SF.net SVN: scummvm:[34628] scummvm/trunk/common/util.h

[fingolfin at users.sourceforge.net]

Revision: 34628
          http://scummvm.svn.sourceforge.net/scummvm/?rev=34628&view=rev
Author:   fingolfin
Date:     2008-09-22 20:55:27 +0000 (Mon, 22 Sep 2008)

Log Message:
-----------
Fix comments for random() funcs (thanks to salty-horse for pointing this out)

Modified Paths:
--------------
    scummvm/trunk/common/util.h

Modified: scummvm/trunk/common/util.h
===================================================================
--- scummvm/trunk/common/util.h	2008-09-22 17:33:30 UTC (rev 34627)
+++ scummvm/trunk/common/util.h	2008-09-22 20:55:27 UTC (rev 34628)
@@ -106,20 +106,20 @@
 	/**
 	 * Generates a random unsigned integer in the interval [0, max].
 	 * @param max	the upper bound
-	 * @return	a random number in the interval [0, max].
+	 * @return	a random number in the interval [0, max]
 	 */
 	uint getRandomNumber(uint max);
 	/**
-	 * Generates a random unsigned integer in the interval [0, 1].
+	 * Generates a random bit, i.e. either 0 or 1.
 	 * Identical to getRandomNumber(1), but faster, hopefully.
-	 * @return	a random number in the interval [0, max].
+	 * @return	a random bit, either 0 or 1
 	 */
 	uint getRandomBit(void);
 	/**
 	 * Generates a random unsigned integer in the interval [min, max].
 	 * @param min	the lower bound
 	 * @param max	the upper bound
-	 * @return	a random number in the interval [min, max].
+	 * @return	a random number in the interval [min, max]
 	 */
 	uint getRandomNumberRng(uint min, uint max);
 };


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