From: tsutsumi <>
Date: Tue, 16 Sep 2003 21:03:55 +0000 (+0000)
Subject: add comment
X-Git-Tag: rev-1-0-rc1~43
X-Git-Url: http://git.osdn.net/view?p=ccunit%2Fccunit.git;a=commitdiff_plain;h=afcd838bcb5041502dd7a506c7eabd61bc3d72a6

add comment
---

diff --git a/src/ccunit/CCUnitTestCase.h b/src/ccunit/CCUnitTestCase.h
index 5f00bb0..9923b96 100755
--- 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