Added documentation.

2 files changed, 15 insertions, 14 deletions

diff --git a/include/cppunit/extensions/RepeatedTest.h b/include/cppunit/extensions/RepeatedTest.h
index 7a68e88..b28deeb 100644
--- a/include/cppunit/extensions/RepeatedTest.h
+++ b/include/cppunit/extensions/RepeatedTest.h
@@ -9,10 +9,9 @@ class Test;
 class TestResult;
 
 
-/*
- * A decorator that runs a test repeatedly.
- * Does not assume ownership of the test it decorates
+/*! \brief Decorator that runs a test repeatedly.
  *
+ * Does not assume ownership of the test it decorates
  */
 class RepeatedTest : public TestDecorator 
 {
@@ -22,9 +21,9 @@ public:
         TestDecorator( test ), 
         m_timesRepeat(timesRepeat) {}
 
+    void run( TestResult *result );
     int countTestCases();
     std::string toString();
-    void run( TestResult *result );
 
 private:
     RepeatedTest( const RepeatedTest & );
diff --git a/include/cppunit/extensions/TestDecorator.h b/include/cppunit/extensions/TestDecorator.h
index caf08a3..2a6b9d7 100644
--- a/include/cppunit/extensions/TestDecorator.h
+++ b/include/cppunit/extensions/TestDecorator.h
@@ -7,30 +7,32 @@ namespace CppUnit {
 
 class TestResult;
 
-/*
- * A Decorator for Tests
+
+/*! \brief  Decorator for Tests.
  *
- * Does not assume ownership of the test it decorates
+ * TestDecorator provides an alternate means to extend functionality
+ * of a test class without subclassing the test.  Instead, one can
+ * subclass the decorater and use it to wrap the test class.
  *
+ * Does not assume ownership of the test it decorates
  */ 
-
 class TestDecorator : public Test 
 {
 public:
-                TestDecorator   (Test *test);
-                ~TestDecorator  ();
+    TestDecorator   (Test *test);
+    ~TestDecorator  ();
 
-    int         countTestCases  () const;
     void        run             (TestResult *result);
-    std::string toString        () const;
+    int         countTestCases  () const;
     std::string getName         () const;
+    std::string toString        () const;
 
 protected:
     Test        *m_test;
 
 private:
-  TestDecorator( const TestDecorator &);
-  void operator =( const TestDecorator & );
+    TestDecorator( const TestDecorator &);
+    void operator =( const TestDecorator & );
 };