add comment

diff --git a/src/ccunit/CCUnitTestCase.h b/src/ccunit/CCUnitTestCase.h
index 5f00bb0..9923b96 100755 (executable)
--- a/src/ccunit/CCUnitTestCase.h
+++ b/src/ccunit/CCUnitTestCase.h
@@ -44,6 +44,28 @@
 
 /**
  * A single test object.
+ *
+ * For each test implement a function which interacts with the
+ * case. Verify the expected results with assertions specified by
+ * calling CCUNIT_ASSERT on the expression you want to test:
+ * 
+ * @code
+ * void testAdd ()
+ * {
+ *   int result = value1 + value2;
+ *   CCUNIT_ASSERT (result == 5);
+ * }
+ *
+ * ...
+ *
+ * void MathTest_newTestCase_testAdd ()
+ * {
+ *   return ccunit_newTestCase ("addTest", "add test", addTest);
+ * }
+ * @endcode
+ *
+ * @see CCUnitTestFixture, CCUnitTestSuite, CCUintMakeSuite
+ * 
  * @ingroup WritingTestFixture
  */
 typedef struct CCUnitTestCase