modify comments

diff --git a/src/ccunit/CCUnitMakeSuite.h b/src/ccunit/CCUnitMakeSuite.h
index 6f5e4a2..37b1c1f 100644 (file)
--- a/src/ccunit/CCUnitMakeSuite.h
+++ b/src/ccunit/CCUnitMakeSuite.h
@@ -42,9 +42,9 @@
  * source codes, the test case source codes must be formatted by
  * following pseudo-BNF:
  * @~japanese
- * ¥Æ¥¹¥È¥±¡¼¥¹¥½¡¼¥¹¥³¡¼¥É¤«¤é¥Æ¥¹¥È¥¹¥¤¡¼¥È¥³¡¼¥É¤òºî¤ë¥³¡¼¥É¤òÀ¸À®¤¹
- * ¤ë¤¿¤á¤Ë¡¢¥Æ¥¹¥È¥±¡¼¥¹¥½¡¼¥¹¥³¡¼¥É¤Ï²¼µ­µ¿»÷ BNF ¤Ë¤è¤Ã¤Æ¥Õ¥©¡¼¥Þ¥Ã
- * ¥È¤µ¤ì¤Ê¤¯¤Æ¤Ï¤Ê¤ê¤Þ¤»¤ó¡£
+ * @brief ¥Æ¥¹¥È¥±¡¼¥¹¥½¡¼¥¹¥³¡¼¥É¤«¤é¥Æ¥¹¥È¥¹¡¼¥Ä¥³¡¼¥É¤òºî¤ë¥³¡¼¥É¤òÀ¸À®¤·¤Þ¤¹¡£
+ *
+ * ¥Æ¥¹¥È¥±¡¼¥¹¥½¡¼¥¹¥³¡¼¥É¤Ï¼¡¤Îµ¿»÷ BNF ¤Ë¤è¤Ã¤Æ¥Õ¥©¡¼¥Þ¥Ã¥È¤µ¤ì¤Ê¤¯¤Æ¤Ï¤Ê¤ê¤Þ¤»¤ó¡£
  * @~
  *
  * @code
@@ -180,7 +180,8 @@ typedef struct _CCUnitTestFixtureDef
 
 /** @} */
 
-/** @ingroup CCUnitMakeSuite
+/**
+ * @ingroup CCUnitMakeSuite
  * @defgroup CCUnitReadSuite _ReadSuite
  * Read test case definitions from test source code.
  * @{
@@ -261,16 +262,7 @@ extern void ccunit_printSuite (FILE* ofp,
  * FILES: the special name '-' means input from stdin.
  * @endcode
  *
- * @~english
- * To generate a code to create test suite code from the test case
- * source codes, the test case source codes must be formatted by
- * following pseudo-BNF:
- * @~japanese
- * ¥Æ¥¹¥È¥±¡¼¥¹¥½¡¼¥¹¥³¡¼¥É¤«¤é¥Æ¥¹¥È¥¹¥¤¡¼¥È¥³¡¼¥É¤òºî¤ë¥³¡¼¥É¤òÀ¸À®¤¹
- * ¤ë¤¿¤á¤Ë¡¢¥Æ¥¹¥È¥±¡¼¥¹¥½¡¼¥¹¥³¡¼¥É¤Ï²¼µ­µ¿»÷ BNF ¤Ë¤è¤Ã¤Æ¥Õ¥©¡¼¥Þ¥Ã
- * ¥È¤µ¤ì¤Ê¤¯¤Æ¤Ï¤Ê¤ê¤Þ¤»¤ó¡£
- * @~
- * @copydoc CCUnitMakeSuite
+ * @copydetails CCUnitMakeSuite
  *
  * @return 0 if succeeded, else error occured.
  * @ingroup CreatingTestSuite

diff --git a/src/ccunit/CCUnitTestFixture.c b/src/ccunit/CCUnitTestFixture.c
index f00707d..86abe1f 100644 (file)
--- a/src/ccunit/CCUnitTestFixture.c
+++ b/src/ccunit/CCUnitTestFixture.c
@@ -32,12 +32,12 @@
 #include <setjmp.h>
 
 /**
- * run tests exception.
+ * run tests exception environment.
  */
 jmp_buf _ccunit_runTest_env;
 
 /**
- * run tests exception
+ * run tests exception.
  */
 CCUnitTestFailure* _ccunit_testFailure;
 
@@ -67,7 +67,7 @@ CCUnitTestCase* ccunit_addNewTestCase (CCUnitTestFixture* fixture,
   return c;
 }
 
-/*
+/**
  * Runs the bare test sequence.
  *
  * @return failure

diff --git a/src/ccunit/CCUnitTestFixture.h b/src/ccunit/CCUnitTestFixture.h
index 0d7c5c6..2277b18 100644 (file)
--- a/src/ccunit/CCUnitTestFixture.h
+++ b/src/ccunit/CCUnitTestFixture.h
@@ -44,7 +44,7 @@
  */
 
 /**
- * Wraps a test case with setUp and tearDown methods.
+ * Wraps a test case with setUp and tearDown function.
  *
  * A TestCase is used to provide a common environment for a set
  * of test cases.
@@ -90,7 +90,7 @@
  *
  * void MathTest_newTestCase_testAdd ()
  * {
- *   return ccunit_newTestCase ("addTest", "add test", addTest);
+ *   return ccunit_newTestCase ("testAdd", "add test", testAdd);
  * }
  * @endcode
  * 

diff --git a/src/ccunit/CCUnitTestSuite.c b/src/ccunit/CCUnitTestSuite.c
index 2f2a27e..8057086 100755 (executable)
--- a/src/ccunit/CCUnitTestSuite.c
+++ b/src/ccunit/CCUnitTestSuite.c
@@ -27,11 +27,12 @@
 #include <ccunit/CCUnitTestSuite.h>
 #include <ccunit/CCUnitTestResult.h>
 
-/** @addtogroup CCUnitTestSuite
+/**
+ * @addtogroup CCUnitTestSuite
  * @{
  */
 
-/*
+/**
  * Runs the test cases and collects their result in a TestResult.
  * @param testSuite test suite.
  * @param result result container.
@@ -52,7 +53,7 @@ static void run (CCUnitTest* testSuite, CCUnitTestResult* result)
     }
 }
 
-/*
+/**
  * destruct test suite.
  * @param test destruct object.
  */

diff --git a/src/ccunit/CCUnitTestSuite.h b/src/ccunit/CCUnitTestSuite.h
index 711f02b..925429e 100755 (executable)
--- a/src/ccunit/CCUnitTestSuite.h
+++ b/src/ccunit/CCUnitTestSuite.h
@@ -44,15 +44,15 @@
 
 /**
  * A <code>Composite</code> class of Tests.
- * It runs a collection of test cases. Here is an example.
+ * It runs a collection of test fixture or suite. Here is an example.
  *
  * @code
  * CCUnitTestSuite* suite = ccunit_newTestSuite ();
- * ccunit_addTestCase (suite, TESTCASE_1);
- * ccunit_addTestCase (suite, TESTCASE_2);
+ * ccunit_addTestFixture (suite, TESTFIXTURE);
+ * ccunit_addTestSuite (suite, TESTSUITE);
  * @endcode
  *
- * @see CCUnitTest, CCUnitTestCase.
+ * @see CCUnitTest, CCUnitTestFixture.
  * @ingroup CreatingTestSuite
  */
 typedef struct CCUnitTestSuite