I arranged the explanation of the sample program which dispersed in one place.

[ccunit/ccunit.git] / doc / mainpage.dox

diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index f8318f2..cc5dba2 100644 (file)
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -77,34 +77,12 @@ you a organized view of %CCUnit modules.
 ¥»¥¯¥·¥ç¥ó¤Ï CCUnit ¤Î¥â¥¸¥å¡¼¥ë¤òÀ°Íý¤·¤Æɽ¼¨¤·¤Æ¤¤¤Þ¤¹¡£
 @~
 
-@~english
-You find additional samples in the examples directory.
-@~japanese
-examples ¥Ç¥£¥ì¥¯¥È¥ê¤Ë¤Ï¥µ¥ó¥×¥ë¥Õ¥¡¥¤¥ë¤¬¤¢¤ê¤Þ¤¹¡£
+@english
+@section _sample_codes Sample Codes
+@japanese
+@section _sample_codes ¥µ¥ó¥×¥ë¥³¡¼¥É
 
-- complex - @~english some complex number library test cases
-  @~japanese Ê£ÁÇ¿ô¤ò·×»»¤¹¤ë¥é¥¤¥Ö¥é¥ê¤È¤½¤Î¥Æ¥¹¥È¥±¡¼¥¹¤Î¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
-  - libcomplex.a - complex number library
-    - complex.c
-    - complex.h
-  - runTestCase @~japanese - ¤â¤Ã¤È¤âñ½ã¤Ê¥Æ¥¹¥È¥±¡¼¥¹¤ò¼Â¹Ô¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
-    - runTestCase.c - main program
-    - testComplex.c - test cases
-  - runTestCaseSetup @~japanese - ¥Æ¥¹¥È¥±¡¼¥¹¤Î½é´ü²½´Ø¿ô¤ò¼«Æ°¸Æ¤Ó½Ð¤·¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
-    - runTestCase.c - main program
-    - testComplexSetup.c - test cases
-  - runTestSuite @~japanese - ¥Æ¥¹¥È¥¹¡¼¥Ä¤Î¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
-    - runTestSuite.c - main program
-    - testComplexSetup.c - test cases
-    - testComplexArith.c - test cases
-  - runTestSuiteAuto @~japanese - ¥Æ¥¹¥È¥¹¡¼¥Ä¤ò¼«Æ°À¸À®¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
-    - runTestSuite.c - main program
-    - testComplexSetup.c - test cases
-    - suiteTestComplex.c - auto generated test suite from testComplexSetup.c
-  - runTestRunner @~japanese - ¥Æ¥¹¥È¥¹¡¼¥Ä¤ò¥Æ¥¹¥È¥é¥ó¥Ê¡¼¤Ç¼Â¹Ô¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
-    - runTestRunner.c - main program
-    - testComplexSetup.c - test cases
-    - suiteTestComplex.c - auto generated test suite from testComplexSetup.c
+@copydoc examples
 
 @english
 @section _documentation Documentation
@@ -298,3 +276,33 @@ digraph CCUnitTestStructure {
  * @defgroup ModuleHierarchy ¥â¥¸¥å¡¼¥ë³¬ÁØ
  * @endif
  */
+
+/**
+ * @defgroup examples Sample Codes
+ * @brief @~english You find additional samples in the examples directory.
+ * @~japanese examples ¥Ç¥£¥ì¥¯¥È¥ê¤Ë¤Ï¥µ¥ó¥×¥ë¥Õ¥¡¥¤¥ë¤¬¤¢¤ê¤Þ¤¹¡£@~
+ * 
+ * - complex - @~english some complex number library test cases
+ *   @~japanese Ê£ÁÇ¿ô¤ò·×»»¤¹¤ë¥é¥¤¥Ö¥é¥ê¤È¤½¤Î¥Æ¥¹¥È¥±¡¼¥¹¤Î¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
+ *   - libcomplex.a - complex number library
+ *     - complex.c
+ *     - complex.h
+ *   - runTestCase @~japanese - ¤â¤Ã¤È¤âñ½ã¤Ê¥Æ¥¹¥È¥±¡¼¥¹¤ò¼Â¹Ô¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
+ *     - runTestCase.c - main program
+ *     - testComplex.c - test cases
+ *   - runTestCaseRunner @~japanese - ¥Æ¥¹¥È¥±¡¼¥¹¤ò¥Æ¥¹¥È¥é¥ó¥Ê¡¼¤Ç¼Â¹Ô¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
+ *     - runTestCaseRunner.c - main program
+ *     - testComplex.c - test cases
+ *   - runTestCaseSetup @~japanese - ¥»¥Ã¥È¥¢¥Ã¥×´Ø¿ô¤ò¼Â¹Ô¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
+ *     - runTestCaseSetup.c - main program
+ *     - testComplexSetup.c - test cases
+ *   - runTestSuite @~japanese - ¥Æ¥¹¥È¥¹¡¼¥Ä¤Î¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
+ *     - runTestSuite.c - main program
+ *     - testComplexSetup.c - test cases
+ *     - testComplexArith.c - test cases
+ *   - runTestSuiteAuto @~japanese - ¥Æ¥¹¥È¥¹¡¼¥Ä¤ò¼«Æ°À¸À®¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
+ *     - runTest.c - main program
+ *     - testComplexSetup.c - test cases
+ *     - testComplexArith.c - test cases
+ *     - suiteTestComplex.c - auto generated test suite.
+ */