summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsmatz <smatz@openttd.org>2009-04-25 22:22:27 +0000
committersmatz <smatz@openttd.org>2009-04-25 22:22:27 +0000
commit25ecace01b1ead5ccf7b58f9fd8cf68139270dea (patch)
treee6883017a04268b548b619ef9085c73e566f1198
parentdec40e5501a23000576e725aabc7c9aed8248847 (diff)
downloadopenttd-25ecace01b1ead5ccf7b58f9fd8cf68139270dea.tar.xz
(svn r16148) -Fix [FS#2839]: misleading comment (part by Bilbo)
-rw-r--r--src/core/random_func.hpp10
1 files changed, 4 insertions, 6 deletions
diff --git a/src/core/random_func.hpp b/src/core/random_func.hpp
index 397e69667..811c53b55 100644
--- a/src/core/random_func.hpp
+++ b/src/core/random_func.hpp
@@ -126,16 +126,14 @@ static FORCEINLINE bool Chance16I(const uint a, const uint b, const uint32 r)
}
/**
- * Flips a coin with a given probability.
+ * Flips a coin with given probability.
*
- * This macro can be used to get true or false randomized according to a
- * given probability. The parameter a and b create a percent value with
- * (a/b). The macro returns true in (a/b) percent.
+ * This function returns true with (a/b) probability.
*
* @see Chance16I()
- * @param a The numerator of the fraction
+ * @param a The nominator of the fraction
* @param b The denominator of the fraction
- * @return True in (a/b) percent
+ * @return True with (a/b) probability
*/
static FORCEINLINE bool Chance16(const uint a, const uint b)
{