Clean up a class renaming mistake.

[simgear.git] / simgear / math / sg_random.h

diff --git a/simgear/math/sg_random.h b/simgear/math/sg_random.h
index 1ff1b1de3162bd65a4dfd052301d11c9c6a7b459..8b263b33a2f0f2b033ad23c1466dae1568bb18ca 100644 (file)
--- a/simgear/math/sg_random.h
+++ b/simgear/math/sg_random.h
@@ -1,5 +1,8 @@
-// sg_random.h -- routines to handle random number generation
-//
+/**
+ * \file sg_random.h
+ * Routines to handle random number generation and hide platform differences.
+ */
+
 // Written by Curtis Olson, started July 1997.
 //
 // Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
@@ -31,16 +34,24 @@ extern "C" {
 #endif                                   
 
 
-// Seed the random number generater with time() so we don't see the
-// same sequence every time
-void sg_srandom_time(void);
+/**
+ * Seed the random number generater with time() so we don't see the
+ * same sequence every time.
+ */
+void sg_srandom_time();
 
-// Seed the random number generater with your own seed so can set up
-// repeatable randomization.
+/**
+ * Seed the random number generater with your own seed so can set up
+ * repeatable randomization.
+ * @param seed random number generator seed
+ */
 void sg_srandom( unsigned int seed );
 
-// return a random number between [0.0, 1.0)
-double sg_random(void);
+/**
+ * Return a random number between [0.0, 1.0)
+ * @return next "random" number in the "random" sequence
+ */
+double sg_random();
 
 
 #ifdef __cplusplus