2 files changed, 41 insertions, 6 deletions

diff --git a/src/unit/sfile.cpp b/src/unit/file.cpp
index 2aff312..a45b8d7 100644
--- a/src/unit/sfile.cpp
+++ b/src/unit/file.cpp
@@ -1,5 +1,5 @@
 #include "unitsuite.h"
-#include "sfile.h"
+#include "file.h"
 #include "exceptions.h"
 
 #include <sys/types.h>
@@ -11,7 +11,7 @@ class Unit : public Bu::UnitSuite
 public:
         Unit()
         {
-                setName("SFile");
+                setName("File");
                 addTest( Unit::writeFull );
                 addTest( Unit::readBlocks );
                 addTest( Unit::readError1 );
@@ -25,7 +25,7 @@ public:
         //
         void writeFull()
         {
-                Bu::SFile sf("testfile1", "wb");
+                Bu::File sf("testfile1", "wb");
                 for( int c = 0; c < 256; c++ )
                 {
                         unsigned char ch = (unsigned char)c;
@@ -43,7 +43,7 @@ public:
 
         void readBlocks()
         {
-                Bu::SFile sf("testfile1", "rb");
+                Bu::File sf("testfile1", "rb");
                 unsigned char buf[50];
                 size_t total = 0;
                 for(;;)
@@ -68,7 +68,7 @@ public:
         {
                 try
                 {
-                        Bu::SFile sf("doesn'texist", "rb");
+                        Bu::File sf("doesn'texist", "rb");
                         unitFailed("No exception thrown");
                 }
                 catch( Bu::FileException &e )
@@ -79,7 +79,7 @@ public:
 
         void readError2()
         {
-                Bu::SFile sf("testfile1", "rb");
+                Bu::File sf("testfile1", "rb");
                 char buf[256];
                 int r = sf.read( buf, 256 );
                 unitTest( r == 256 );
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
         {