# HG changeset patch
# User Tom Henderson <tomh@tomh.org>
# Date 1206822534 25200
# Node ID 41489a849fc358574e1ad214c9d2329fa8db4ebb
# Parent  33fb53176f9768b1977d435aac5dc75ce7ed3185
documentation for class RngStream

diff -r 33fb53176f97 -r 41489a849fc3 src/core/rng-stream.h
--- a/src/core/rng-stream.h	Sat Mar 29 08:47:25 2008 -0700
+++ b/src/core/rng-stream.h	Sat Mar 29 13:28:54 2008 -0700
@@ -22,8 +22,20 @@
 #include <string>
 #include <stdint.h>
 
-namespace ns3{
+namespace ns3 {
 
+/**
+ * \ingroup core
+ * \ingroup randomvariable 
+ *
+ * \brief Combined Multiple-Recursive Generator MRG32k3a
+ *
+ * This class is the combined multiple-recursive random number
+ * generator called MRG32k3a.  The ns3::RandomVariableBase class
+ * holds a static instance of this class.  The details of this
+ * class are explained in:  
+ * http://www.iro.umontreal.ca/~lecuyer/myftp/papers/streams00.pdf
+ */
 class RngStream {
 public:  //public api
   RngStream ();
@@ -52,7 +64,7 @@
   static double nextSeed[6];
 };
 
-};//namespace ns3
+} //namespace ns3
 
 #endif