neko.Random.hx documentation

From http://nekovm.org/doc/view/random

std/neko/Random.hx

@@ -21,29 +21,43 @@
  */
 package neko;
 
+/**
+	A seeded pseudo-random generator
+*/
 class Random {
 
 	var r : Dynamic;
 
+	/**
+		Create a new random with random seed
+	*/
 	public function new() {
 		r = random_new();
 	}
 
+	/**
+		Set the generator seed
+	*/
 	public function setSeed( s : Int ) {
 		random_set_seed(r,s);
 	}
 
+	/**
+		Return a random integer modulo max
+	*/
 	public function int( max : Int ) : Int {
 		return random_int(r,max);
 	}
 
+	/**
+		Return a random float
+	*/
 	public function float() : Float {
 		return random_float(r);
 	}
 
-	static var random_new = Lib.load("std","random_new",0);
-	static var random_set_seed = Lib.load("std","random_set_seed",2);
-	static var random_int = Lib.load("std","random_int",2);
-	static var random_float = Lib.load("std","random_float",1);
-
+	static var random_new = Lib.load("std","random_new", 0);
+	static var random_set_seed = Lib.load("std","random_set_seed", 2);
+	static var random_int = Lib.load("std","random_int", 2);
+	static var random_float = Lib.load("std","random_float", 1);
 }