Added a few comments and fixed a string unit test, it assumed hex would be

upper case by default and now it's lower case.

3 files changed, 25 insertions, 0 deletions

diff --git a/src/stable/randombase.h b/src/stable/randombase.h
index 946284f..953ccb8 100644
--- a/src/stable/randombase.h
+++ b/src/stable/randombase.h
@@ -11,6 +11,15 @@
 
 namespace Bu
 {
+    /**
+     * Base class for random number generators.  This provides some basic
+     * implementations of standard helper functions.  If your specific random
+     * number generator does not use the full range of a 32 bit integer then
+     * you'll want to override at least randNorm() to correct the range.
+     *
+     * Random number generators are not thread safe on their own.  See
+     * Bu::Random.
+     */
     class RandomBase
     {
     public:
diff --git a/src/stable/randomcmwc.h b/src/stable/randomcmwc.h
index 50eb8c4..2e0b0e8 100644
--- a/src/stable/randomcmwc.h
+++ b/src/stable/randomcmwc.h
@@ -11,6 +11,12 @@
 
 namespace Bu
 {
+    /**
+     * Complimentary Multiply With Carry random number generator.  This is a
+     * simpler and faster generator than Mersenne Twister, but uses about as
+     * much memory.  Many people think that it may be at least as good as
+     * Mersenne Twister, or better.
+     */
     class RandomCmwc : public RandomBase
     {
     public:
diff --git a/src/stable/randomsystem.h b/src/stable/randomsystem.h
index 63b40f3..6692e58 100644
--- a/src/stable/randomsystem.h
+++ b/src/stable/randomsystem.h
@@ -12,6 +12,16 @@
 namespace Bu
 {
     class File;
+    /**
+     * Access to operating system provided random number generation.  On linux
+     * this will provide access to /dev/random or /dev/urandom depending on
+     * weather Fast or Good is selected.  On Linux systems Good random number
+     * generation can block while organic sources are use to gather entropy, so
+     * Fast is the default, it will always provide a result.
+     *
+     * On Windows this uses the Windows system cryptographic level random number
+     * generation services.  Or at least, it will when I get to it.  Sorry.
+     */
     class RandomSystem : public RandomBase
     {
     public: