I did it, the streams don't start with an S now.

1 files changed, 35 insertions, 0 deletions

diff --git a/src/unitsuite.h b/src/unitsuite.h
index db249b2..6e9270a 100644
--- a/src/unitsuite.h
+++ b/src/unitsuite.h
@@ -8,7 +8,42 @@
 namespace Bu
 {
         /**
+         * Provides a unit testing framework.  This is pretty easy to use, probably
+         * the best way to get started is to use ch to generate a template, or use
+         * the code below with appropriate tweaks:
+         *@code
+         * #include "unitsuite.h"
+         * 
+         * class Unit : public Bu::UnitSuite
+         * {
+         * public:
+         *      Unit()
+         *      {
+         *              setName("Example");
+         *              addTest( Unit::test );
+         *      }
+         * 
+         *      virtual ~Unit() { }
+         * 
+         *      //
+         *      // Tests go here
+         *      //
+         *      void test()
+         *      {
+         *              unitTest( 1 == 1 );
+         *      }
+         * };
+         * 
+         * int main( int argc, char *argv[] )
+         * {
+         *      return Unit().run( argc, argv );
+         * }
          *
+         @endcode
+         * The main function can contain other things, but using this one exactly
+         * makes all of the test suites work exactly the same.  Using the optional
+         * setName at the top of the constructor replaces the class name with the
+         * chosen name when printing out stats and info.
          */
         class UnitSuite
         {