add japanese comment

diff --git a/src/ccunit/CCUnitMakeSuite.h b/src/ccunit/CCUnitMakeSuite.h
index 4cc4098..6f5e4a2 100644 (file)
--- a/src/ccunit/CCUnitMakeSuite.h
+++ b/src/ccunit/CCUnitMakeSuite.h
@@ -37,24 +37,51 @@
  * @ingroup ModuleHierarchy
  * @defgroup CCUnitMakeSuite MakeSuite
  *
- * Generate a code to creating test suite code from the test case
- * source codes. The following are pseudo-BNF of requiring test case
- * source:
+ * @~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 ¤Ë¤è¤Ã¤Æ¥Õ¥©¡¼¥Þ¥Ã
+ * ¥È¤µ¤ì¤Ê¤¯¤Æ¤Ï¤Ê¤ê¤Þ¤»¤ó¡£
+ * @~
  *
  * @code
- * SOURCEFILE ::= FIXTURE...
- * FIXTURE ::= FIXTURE_HEADER [FIXTURE_CODE]... [SETUP_FUNC] [TEARDOWN_FUNC]
- *             [TESTCASE]... FIXTURE_END
+ * SOURCEFILE ::= [SUITE]... | FIXTURE...
+ *
+ * SUITE ::= SUITE_HEADER
+ *           [ any-C-code ]...
+ *           FIXTURE...
+ *           SUITE_END
+ *
+ * SUITE_HEADER ::= JAVADOC_COMMENT_BEGIN 'test suite:' SUITE_NAME COMMENT_END
+ * SUITE_END ::= JAVADOC_COMMENT_BEGIN 'end test suite' wsp string COMMENT_END
+ *
+ * FIXTURE ::= FIXTURE_HEADER
+ *             [FIXTURE_CODE]...
+ *             [SETUP_FUNC]
+ *             [TEARDOWN_FUNC]
+ *             [TESTCASE]...
+ *             FIXTURE_END
+ *
  * FIXTURE_HEADER ::= JAVADOC_COMMENT_BEGIN
  *                    'test case:' TESTFIXTURE_NAME
  *                    COMMENT_END
  * FIXTURE_CODE ::= any C language codes.
+ *
  * SETUP_FUNC ::= [ FUNC_DESC ] 'void setUp'[A-Za-z0-9_]* '()' FUNC_BODY
- * FUNC_DESC ::= JAVADOC_COMMENT_BEGIN string COMMENT_END
- * FUNC_BODY ::= '{' C language codes... '}'
+ *
  * TEARDOWN_FUNC ::= [ FUNC_DESC ] 'void tearDown'[A-Za-z0-9_]* '()' FUNC_BODY
+ *
  * TESTCASE ::= [ FUNC_DESC ] 'void test'[A-Za-z0-9_]* '()' FUNC_BODY
+ *
  * FUXTURE_END ::= JAVADOC_COMMENT_BEGIN 'end test case' wsp string COMMENT_END
+ *
+ * FUNC_DESC ::= JAVADOC_COMMENT_BEGIN string COMMENT_END
+ *
+ * FUNC_BODY ::= '{' C language codes... '}'
+ *
  * JAVADOC_COMMENT_BEGIN ::= '/' '*' '*'
  * COMMENT_END ::= '*' '/'
  * @endcode
@@ -200,9 +227,12 @@ extern void ccunit_printSuite (FILE* ofp,
 /** @} */
 
 /**
+ * @english
  * Generate a code to creating test suite code from the test case
  * source codes.
- * @copydoc CCUnitMakeSuite
+ * @japanese
+ * ¥Æ¥¹¥È¥±¡¼¥¹¤Î¥½¡¼¥¹¥³¡¼¥É¤«¤é¡¢¥Æ¥¹¥È¥¹¡¼¥Ä¤òºîÀ®¤¹¤ë¥³¡¼¥É¤òÀ¸À®¤¹¤ë¡£
+ * @endif
  *
  * @param ac arg count.
  * @param av array of arg string.
@@ -228,8 +258,20 @@ extern void ccunit_printSuite (FILE* ofp,
  *      --help
  *      -h
  *          print this message
+ * 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
+ *
  * @return 0 if succeeded, else error occured.
  * @ingroup CreatingTestSuite
  */