From 8b94fbbf72690d104d5ea8fee5b818527de9bbbd Mon Sep 17 00:00:00 2001 From: tsutsumi <> Date: Mon, 16 Aug 2010 08:51:56 +0000 Subject: [PATCH] reexamined format command and add details --- doc/cookbook.dox | 140 ++++++++++++++++++++++++++++++++++++++----------------- doc/mainpage.dox | 78 ++++++++++++++++++++++++------- 2 files changed, 158 insertions(+), 60 deletions(-) diff --git a/doc/cookbook.dox b/doc/cookbook.dox index e9e8888..77f74cc 100644 --- a/doc/cookbook.dox +++ b/doc/cookbook.dox @@ -1,4 +1,21 @@ /* -*- Indented-Text -*- */ +/* Copyright (C) 2003, 2010 TSUTSUMI Kikuo. + This file is part of the CCUnit Library. + + The CCUnit Library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public License + as published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + The CCUnit Library is distributed in the hope that it will be + useful, but WITHOUT ANY WARRANTY; without even the implied warranty + of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with the CCUnit Library; see the file COPYING.LESSER. + If not, see +*/ /* $Id$ */ /** @english @@ -45,13 +62,23 @@ To make a simple test, here is what you do:
  1. @~english Create a test function - @~japanese ¥Æ¥¹¥È´Ø¿ô¤òºî¤ë
  2. + @~japanese ¥Æ¥¹¥È´Ø¿ô¤òºî¤ë + @~ +
  3. @~english When you want to check a value, call @~japanese Ãͤò¥Á¥§¥Ã¥¯¤·¤¿¤¤¾ì¹ç¤Ï¡¢@~ @link CCUNIT_ASSERT() CCUNIT_ASSERT(bool) @endlink @~english and pass a bool that is true if the test succeeds @~japanese ¤ò¸Æ¤Ó½Ð¤·¤Æ¡¢ - ¤â¤·¥Æ¥¹¥È¤¬À®¸ù¤¹¤ë¤Î¤Ç¤¢¤ì¤Ð¿¿¤òÊÖ¤¹¤è¤¦¤Ê¿¿µ¶ÃͤòÅϤ·¤Þ¤¹
  4. + ¤â¤·¥Æ¥¹¥È¤¬À®¸ù¤¹¤ë¤Ê¤é¿¿¤òÊÖ¤¹¤è¤¦¤Ê¿¿µ¶ÃͤòÅϤ·¤Þ¤¹@~ + + @~english ASSERT macro is listed in others as well in + @link Assertions Making assertions @endlink. + @~japanese ASSERT ´Ø·¸¤Î¥Þ¥¯¥í¤Ï¾¤Ë¤â + @link Assertions Making assertions @endlink + ¤Ë¥ê¥¹¥È¤·¤Æ¤¢¤ê¤Þ¤¹¡£ + @~ +
@~english @@ -61,6 +88,12 @@ write: @~japanese Î㤨¤Ð¡¢Æó¤Ä¤ÎÊ£ÁÇ¿ô¤Î¹ç·×¤¬¡¢ Æó¤Ä¤ÎÊ£ÁÇ¿ô¤ÎÃͤò²Ã»»¤·¤¿ÃͤÈƱ¤¸¤Ç¤¢¤ë¤³¤È¤ò¥Æ¥¹¥È¤¹¤ë¤È¤·¤Þ¤¹¡£ +¡Ê¤³¤³¤Ç»ÈÍѤ¹¤ë¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ï +examples/complex ¥Ç¥£¥ì¥¯¥È¥ê¤Ë¤¢¤ê¤Þ¤¹¡£¡Ë +@~ + +@~english +This sample program is in the examples/complex directory. @~ @code @@ -70,7 +103,7 @@ void test_complex_add () complex_t c1_1 = { 1.0, 1.0 }; complex_t result; complex_t c11_2 = { 11.0, 2.0 }; - CCUNIT_ASSERT (complex_equals (&c11_2, complex_add (&result, c10_1, c1_1))); + CCUNIT_ASSERT (complex_equals (&c11_2, complex_add (&result, &c10_1, &c1_1))); } @endcode @@ -82,7 +115,7 @@ objects. To do this, use a fixture. ¤³¤ì¤ÏÂçÊÑñ½ã¤Ê¥Æ¥¹¥È¤Ç¤¹¡£ Ä̾Ʊ¤¸¥Ç¡¼¥¿¤Î¥»¥Ã¥È¤ÇÁö¤é¤»¤ë¤¿¤á¤Ë¡¢ ¤¿¤¯¤µ¤ó¤Î¾®¤µ¤Ê¥Æ¥¹¥È¥±¡¼¥¹¤òºî¤é¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¤Ç¤·¤ç¤¦¡£ -¤½¤¦¤¹¤ë¤Ë¤Ï¥Õ¥£¥¯¥¹¥Á¥ã¡ÊÈ÷Éʡˤò»È¤¤¤Þ¤¹¡£ +¤½¤³¤Ç¥Õ¥£¥¯¥¹¥Á¥ã¡ÊÈ÷Éʡˤò»È¤¤¤Þ¤¹¡£ @~ @english @@ -110,7 +143,7 @@ in actually testing values. ¤³¤Î¥Ç¡¼¥¿¤Î¥»¥Ã¥È¤ò¥Õ¥£¥¯¥¹¥Á¥ã¤È¸Æ¤Ö¤³¤È¤Ë¤·¤Þ¤¹¡£ ¥Æ¥¹¥È¤ò½ñ¤¤¤Æ¤¤¤ë¤È¡¢ ¼ÂºÝ¤Î¥Æ¥¹¥È¤¹¤ëÃͤò¥Õ¥£¥¯¥¹¥Á¥ã¤Ë¥»¥Ã¥È¥¢¥Ã¥×¤¹¤ë¥³¡¼¥É¤ò½ñ¤¯Êý¤Ë¡¢ -¤â¤Ã¤È»þ´Ö¤ò¤«¤±¤Æ¤¤¤ë¤³¤È¤Ëµ¤¤Å¤¯¤³¤È¤¬¤è¤¯¤¢¤ê¤Þ¤¹¡£ +¤è¤ê»þ´Ö¤ò¤«¤±¤Æ¤¤¤ë¤³¤È¤Ëµ¤¤Å¤¯¤³¤È¤¬¤è¤¯¤¢¤ê¤Þ¤¹¡£ @~ @~english @@ -128,8 +161,7 @@ different results. @~english When you have a common fixture, here is what you do: @~japanese -¤â¤·¶¦Ä̤¹¤ë¥Õ¥£¥¯¥¹¥Á¥ã¤¬¤¢¤ì¤Ð¡¢¤³¤ó¤Ê¤Õ¤¦¤Ë¤¹¤ë¤³¤È¤Ë¤Ê¤ê -¤Þ¤¹¡£ +¤â¤·¶¦Ä̤¹¤ë¥Õ¥£¥¯¥¹¥Á¥ã¤¬¤¢¤ì¤Ð¡¢¤³¤ó¤Ê¤Õ¤¦¤Ë¤¹¤ë¤³¤È¤Ë¤Ê¤ê¤Þ¤¹¡£ @~
    @@ -138,16 +170,19 @@ When you have a common fixture, here is what you do: @~japanese @link CCUnitTestCase TestCase @endlink ¹½Â¤ÂΤ˥á¥â¥ê¤ò³ä¤êÅö¤Æ¤Þ¤¹ ¡Ê°Ê¹ß¡¢¹½Â¤ÂΤ˳ä¤êÅö¤Æ¤¿¥á¥â¥ê¤ò¡¢¥ª¥Ö¥¸¥§¥¯¥È¤È¸Æ¤Ö¤³¤È¤Ë¤·¤Þ¤¹¡Ë + @~
  1. @~english Add an global variable for each part of the fixture @~japanese ¥Õ¥£¥¯¥¹¥Á¥ã¤Î¤½¤ì¤¾¤ì¤ÎÉôʬ¤ËÂç°èÊÑ¿ô¤òÄɲä·¤Þ¤¹ + @~
  2. @~english Write setUp() function to initialize the valiables @~japanese setUp() ´Ø¿ô¤ò½ñ¤¤¤ÆÊÑ¿ô¤ò½é´ü²½¤·¤Þ¤¹ + @~
  3. @~english Write tearDown() to release any permanent @@ -155,12 +190,14 @@ When you have a common fixture, here is what you do: @~japanese tearDown() ´Ø¿ô¤ò½ñ¤¤¤ÆsetUp ¤Ç³ä¤êÅö¤Æ¤¿±Ê³Ū¥ê¥½¡¼¥¹¤ò²òÊü¤·¤Þ¤¹ + @~
  4. @~english Create a @link CCUnitTestFixture TestFixture @endlink object @~japanese @link CCUnitTestFixture CCUnitTestFixture @endlink ¹½Â¤ÂΤ˥á¥â¥ê¤ò³ä¤êÅö¤Æ¤Þ¤¹ + @~
  5. @~english Add @link CCUnitTestCase TestCase @endlink objects to fixture object @@ -168,6 +205,7 @@ When you have a common fixture, here is what you do: @link CCUnitTestCase TestCase @endlink ¥ª¥Ö¥¸¥§¥¯¥È¤ò @link CCUnitTestFixture TestFixture @endlink ¥Õ¥£¥¯¥¹¥Á¥ã¥ª¥Ö¥¸¥§¥¯¥È¤ËÅÐÏ¿¤·¤Þ¤¹¡£ + @~
@@ -188,14 +226,14 @@ static complex_t* s10_1; static complex_t* s1_1; static complex_t* s11_2; -void setUp_ComplexTest () +void setUp_complex_test () { s10_1 = complex_new (10, 1); s1_1 = complex_new (1, 1); s11_2 = complex_new (11, 2); } -void tearDown_ComplexTest () +void tearDown_complex_test () { complex_delete (s10_1); complex_delete (s1_1); @@ -205,9 +243,9 @@ void tearDown_ComplexTest () ... CCUnitTestFixture* fixture; - fixture = ccunit_newTestFixture ("ComplexTest", - CCUNIT_NEWTESTFUNC(setUp_ComplexTest), - CCUNIT_NEWTESTFUNC(tearDown_ComplexTest)); + fixture = ccunit_newTestFixture ("complex test", + CCUNIT_NEWTESTFUNC(setUp_complex_test), + CCUNIT_NEWTESTFUNC(tearDown_complex_test)); @endcode @~english @@ -259,8 +297,7 @@ void test_complex_equals () One may create and run objects for each test case like this: @~japanese °ì¤Ä¤Ë¤Ï¼¡¤Î¤è¤¦¤Ë¡¢ -¥Õ¥£¥¯¥¹¥Á¥ã¤òºîÀ®¤·¤Æ¤½¤ì¤¾¤ì¤Î¥Æ¥¹¥È¥±¡¼¥¹¤ò¼Â¹Ô¤µ¤»¤ë¤³¤È -¤¬¤Ç¤­¤Þ¤¹¡£ +¥Õ¥£¥¯¥¹¥Á¥ã¤òºîÀ®¤·¤Æ¤½¤ì¤¾¤ì¤Î¥Æ¥¹¥È¥±¡¼¥¹¤ò¼Â¹Ô¤µ¤»¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£ @~ @code @@ -282,28 +319,30 @@ display the results. Ä̾ï¤Ï @link ExecutingTest TestRunner @endlink (@ref test_runner ¸å½Ò) ¤Ç·ë²Ì¤òɽ¼¨¤·¤Þ¤¹¡£ +@~ @~english Once you have several tests, organize them into a suite. @~japanese °ìÅÙ¤¤¤¯¤Ä¤«¤Î¥Æ¥¹¥È¤òºî¤Ã¤¿¤é¡¢ -¤½¤ì¤é¤ò¥¹¥¤¡¼¥È¤ËÀ°Íý¤·¤Þ¤¹¡£ +¤½¤ì¤é¤ò¥¹¡¼¥Ä¤ËÀ°Íý¤·¤Þ¤¹¡£ +@~ @english @section suite Suite @japanese -@section suite ¥¹¥¤¡¼¥È +@section suite ¥¹¡¼¥Ä @endif @~english How do you set up your tests so that you can run them all at once? @~japanese -¤É¤Î¤è¤¦¤Ë¤·¤Æ¡¢°ìÅ٤˥ƥ¹¥È¤ò¼Â¹Ô¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¤è¤¦¡¢ -½àÈ÷¤·¤¿¤é¤¤¤¤¤Ç¤·¤ç¤¦¤«¡© +°ìÅ٤˥ƥ¹¥È¤ò¼Â¹Ô¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¤è¤¦¤Ë½àÈ÷¤¹¤ë¤Ë¤Ï¡¢ +¤É¤Î¤è¤¦¤Ë¤·¤¿¤é¤¤¤¤¤Ç¤·¤ç¤¦¤«¡© @~ @~english -%CCUnit provides a @link CCUnitTestSuite TestSuite @endlink +CCUnit provides a @link CCUnitTestSuite TestSuite @endlink module that runs any number of TestCases together. @~japanese CCUnit ¤Ï¤¤¤¯¤Ä¤â¤Î @link CCUnitTestCase TestCases @endlink @@ -320,7 +359,7 @@ You saw, above, how to run test fixture. @~english To create a suite of two or more tests, you do the following: @~japanese -Æó¤Ä°Ê¾å¤Î¥Æ¥¹¥È¤ò´Þ¤à°ì¤Ä¤Î¥¹¥¤¡¼¥È¤òºî¤ë¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Þ¤¹¡£ +Æó¤Ä°Ê¾å¤Î¥Æ¥¹¥È¤ò´Þ¤à°ì¤Ä¤Î¥¹¡¼¥Ä¤òºî¤ë¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Þ¤¹¡£ @~ @code @@ -346,26 +385,35 @@ result = ccunit_runTestSuite (suite, NULL); contain @link CCUnitTestFixture TestFixtures @endlink. They can contain any object that implements the @link CCUnitTest Test @endlink interface. For example, you can create a -@link CCUnitTestSuite TestSuite @endlink in your code and I -can create one in mine, and we can run them together by +@link CCUnitTestSuite TestSuite @endlink +(complex_add_sub_suite ()) in your code and I +can create one in mine +(complex_mul_div_suite ()), and we can run them together by creating a @link CCUnitTestSuite TestSuite @endlink that contains both: @~japanese @link CCUnitTestSuite TestSuites @endlink ¤Ï @link CCUnitTestFixture TestFixtures @endlink ¤ò´Þ¤à¤À¤±¤Ç¤Ï¤¢¤ê¤Þ¤»¤ó¡£ +@link CCUnitTestSuite TestSuites @endlink ¼«¿È¤ò´Þ¤à¤³¤È¤â¤Ç¤­¤Þ¤¹¡£ + +Î㤨¤Ð¡¢¤¢¤Ê¤¿¤Ï¤¢¤Ê¤¿¤Î¥³¡¼¥É¤Ë @link CCUnitTestSuite TestSuite @endlink +(complex_add_sub_suite ()) +¤òºî¤ë¤³¤È¤¬¤Ç¤­¡¢ +¤½¤·¤Æ»ä¤Ï»ä¤Î¥¹¡¼¥Ä +(complex_mul_div_suite ()) +¤òºî¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡¢ ¤½¤·¤Æ»äã¤ÏξÊý¤È¤â¤ò´Þ¤ó¤Ç¤¤¤ë @link CCUnitTestSuite TestSuite @endlink -¤òºî¤Ã¤Æ°ì½ï¤Ë¸Ä¡¹¤Î¥¹¥¤¡¼¥È¤òÆ°¤«¤¹¤³¤È¤¬¤Ç¤­¤ë¤Î¤Ç¤¹¡£ +¤òºî¤Ã¤Æ°ì½ï¤Ë¤½¤ì¤¾¤ì¤Î¥¹¡¼¥Ä¤òÆ°¤«¤¹¤³¤È¤¬¤Ç¤­¤ë¤Î¤Ç¤¹¡£ @~ @code CCUnitTestSuite* suite; CCUnitTestResult* result; -suite = ccunit_newTestSuite ("suite"); +suite = ccunit_newTestSuite ("Complex add/sub/mul/div test suite"); ccunit_addTestSuite (suite, complex_add_sub_suite ()); ccunit_addTestSuite (suite, complex_mul_div_suite ()); result = ccunit_runTestSuite(suite, NULL); @@ -391,11 +439,11 @@ its results. You make your suite accessible to a @link CreatingTestSuite ccunit_makeSuite @endlink tool that generate a creating test suite code. @~japanese -°ì¤Ä¥Æ¥¹¥È¥¹¥¤¡¼¥È¤ò½ñ¤¤¤¿¤é¡¢ +°ì¤Ä¥Æ¥¹¥È¥¹¡¼¥Ä¤ò½ñ¤¤¤¿¤é¡¢ ¤½¤ì¤ò¼Â¹Ô¤·¤¿¤¤¤Ç¤·¤ç¤¦¡£ -CCUnit ¤Ï¥¹¥¤¡¼¥È¤ò¼Â¹Ô¤¹¤ë¤¿¤á¤ËÄêµÁ¤·¡¢ +CCUnit ¤Ï¥¹¡¼¥Ä¤ò¼Â¹Ô¤¹¤ë¤¿¤á¤ËÄêµÁ¤·¡¢ ·ë²Ì¤òɽ¼¨¤¹¤ë¤¿¤á¤Î¥Ä¡¼¥ë¤òÄ󶡤·¤Þ¤¹¡£ -¥¹¡¼¥Ä¤ò@link CreatingTestSuite ccunit_makeSuite @endlink +¥¹¡¼¥Ä¤ò @link CreatingTestSuite ccunit_makeSuite @endlink ¥Ä¡¼¥ë¤ËÆþÎϤǤ­¤ë¤è¤¦¤Ê·Á¼°¤Ç½ñ¤¯¤³¤È¤Ç¡¢ ¥Æ¥¹¥È¥¹¡¼¥Ä¤òºîÀ®¤¹¤ë¥³¡¼¥É¤ò¼«Æ°Åª¤ËÀ¸À®¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£ @~ @@ -404,24 +452,30 @@ CCUnit For example, to make a ComplexTest suite available to a @link CreatingTestSuite ccunit_makeSuite @endlink, excute the following tool to -ComplexTest.c: +testComplex.c: @~japanese -Î㤨¤Ð¡¢ComplexTest ¥¹¥¤¡¼¥È¤ò +Î㤨¤Ð¡¢ComplexTest ¥¹¡¼¥Ä¤ò @link CreatingTestSuite ccunit_makeSuite @endlink ¤ò»È¤Ã¤Æ»ÈÍѤǤ­¤ë¤è¤¦¤Ë¤¹¤ë¤Ë¤Ï¡¢ -°Ê²¼¤Î¥Ä¡¼¥ë¤ò ComplexTest.c ¤Ë¼Â¹Ô¤·¤Þ¤¹¡£ +°Ê²¼¤Î¥Ä¡¼¥ë¤ò testComplex.c ¤Ë¼Â¹Ô¤·¤Þ¤¹¡£ @~ @code -$ ccunit_makeSuite -f complex_suite -o suiteComplex.c ComplexTest.c +$ ccunit_makeSuite -f complex_suite -o suiteComplex.c testComplex.c @endcode @anchor test_runner_code @~english -To use the TestRunner, include the header files for the tests in Main.c: +@~japanese +complex_suite ¤È¤¤¤¦´Ø¿ô¤¬ÄêµÁ¤µ¤ì¤¿¡¢ +suiteComplex.c ¤È¤¤¤¦¥Õ¥¡¥¤¥ë¤¬ºîÀ®¤µ¤ì¤Þ¤¹¡£ +@~ + +@~english +To use the TestRunner, include the header files for the tests in runTest.c: @~japanese TestRunner ¤ò»ÈÍѤ¹¤ë¤Ë¤Ï¡¢ -Main.c¤Ç¥Æ¥¹¥È¤Î¤¿¤á¤Î¥Õ¥¡¥¤¥ë¤Î¥Ø¥Ã¥À¤ò¥¤¥ó¥¯¥ë¡¼¥É¤·¤Þ¤¹¡£ +Î㤨¤Ð runTest.c ¤Ç¥Æ¥¹¥È¤Î¤¿¤á¤Î¥Õ¥¡¥¤¥ë¤Î¥Ø¥Ã¥À¤ò¥¤¥ó¥¯¥ë¡¼¥É¤·¤Þ¤¹¡£ @~ @code @@ -468,22 +522,26 @@ If any fail, you'll get the following information: The name of the source file that contains the test @~japanese ¥Æ¥¹¥È¤ò´Þ¤ó¤Ç¤¤¤ë¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾ + @~
  • @~english The line number where the failure occurred @~japanese ¼ºÇÔ¤¬µ¯¤³¤Ã¤¿¹ÔÈÖ¹æ + @~
  • @~english The name of the test case that failed @~japanese ¼ºÇÔ¤·¤¿¥Æ¥¹¥È¥±¡¼¥¹¤Î̾Á° + @~
  • @~english All of the text inside the call to CCUNIT_ASSERT () which detected the failure @~japanese ¼ºÇÔ¤ò¸¡ÃΤ·¤¿CCUNIT_ASSERT ()¤¬¸Æ¤Ó½Ð¤µ¤ì¤¿»þ¤Î¾ò·ï¤Îʸ»úÎó¡£ + @~
  • @@ -515,7 +573,7 @@ The following code is a rewrite of ComplexTest using those command: @~ @code -#include +#include @endcode @~english @@ -526,7 +584,7 @@ C-style comment block starting with two *'s: ºÇ½é¤Ë¡¢¥Õ¥£¥¯¥¹¥Á¥ã¤òÀë¸À¤·¤Þ¤¹¡£ ¤³¤ì¤ÏjavaDoc¥¹¥¿¥¤¥ë¤Î¥³¥á¥ó¥ÈÆâ¤Ë¥Õ¥£¥¯¥¹¥Á¥ã¤Î̾Á°¤òµ­½Ò¤·¤Þ¤¹¡£ javaDoc¥¹¥¿¥¤¥ë¤Î¥³¥á¥ó¥È¤È¤Ï C ¥¹¥¿¥¤¥ë¤Î¥³¥á¥ó¥È¥Ö¥í¥Ã¥¯¤Î³«»Ï¤¬ -Æó¤Ä¤Î¥¢¥¹¥¿¥ê¥¹¥¯*¤Ë¤Ê¤Ã¤Æ¤¤¤ë¤â¤Î¤Ç¤¹¡£ +Æó¤Ä¤Î¥¢¥¹¥¿¥ê¥¹¥¯ ** ¤Ë¤Ê¤Ã¤Æ¤¤¤ë¤â¤Î¤Ç¤¹¡£ @~ @code @@ -616,7 +674,7 @@ Finally, you end the fixture declaration: To generate creating suite function code, run ccunit_makeSuite tool. @~japanese -¥¹¥¤¡¼¥ÈºîÀ®´Ø¿ô¤Î¥³¡¼¥É¤òÀ¸À®¤¹¤ë¤Ë¤Ï¡¢ +¥¹¡¼¥ÄºîÀ®´Ø¿ô¤Î¥³¡¼¥É¤òÀ¸À®¤¹¤ë¤Ë¤Ï¡¢ ccunit_makeSuite¥Ä¡¼¥ë¤ò¼Â¹Ô¤·¤Þ¤¹¡£ @~ @@ -754,10 +812,8 @@ int main (int argc, char** argv) Now, you need to run your application after compilation. The sample program made in the above is in the examples/complex directory. @~japanese -¤½¤ì¤Ç¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤ò¥³¥ó¥Ñ¥¤¥ë¤·¤¿¸å¤Ë¼Â¹Ô¤·¤Æ¤ß¤Þ¤·¤ç -¤¦¡£ -°Ê¾å¤ÇºîÀ®¤·¤¿¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ï examples/complex ¥Ç¥£¥ì¥¯ -¥È¥ê¤Ë¤¢¤ê¤Þ¤¹¡£ +¤½¤ì¤Ç¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤ò¥³¥ó¥Ñ¥¤¥ë¤·¤¿¸å¤Ë¼Â¹Ô¤·¤Æ¤ß¤Þ¤·¤ç¤¦¡£ +°Ê¾å¤ÇºîÀ®¤·¤¿¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ï examples/complex ¥Ç¥£¥ì¥¯¥È¥ê¤Ë¤¢¤ê¤Þ¤¹¡£ @~ */ diff --git a/doc/mainpage.dox b/doc/mainpage.dox index f1e6349..08a4209 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -1,12 +1,28 @@ /* -*- Indented-Text -*- */ +/* Copyright (C) 2003, 2010 TSUTSUMI Kikuo. + This file is part of the CCUnit Library. + + The CCUnit Library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public License + as published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + The CCUnit Library is distributed in the hope that it will be + useful, but WITHOUT ANY WARRANTY; without even the implied warranty + of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with the CCUnit Library; see the file COPYING.LESSER. + If not, see +*/ /* $Id$ */ /** @mainpage @~english CCUnit is a simple framework to write repeatable tests with C language. @~japanese -CCUnit ¤Ï C ¸À¸ì¤Ç·«¤êÊÖ¤·²Äǽ¤Ê¥Æ¥¹¥È¤ò½ñ¤¯¤¿¤á¤Î´Êñ¤Ê¥Õ¥ì -¡¼¥à¥ï¡¼¥¯¤Ç¤¹¡£ +CCUnit ¤Ï C ¸À¸ì¤Ç·«¤êÊÖ¤·²Äǽ¤Ê¥Æ¥¹¥È¤ò½ñ¤¯¤¿¤á¤Î´Êñ¤Ê¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç¤¹¡£ @~ @english [see also Japanese documents] @@ -24,6 +40,7 @@ CCUnit Below are the installation steps for installing CCUnit: @~japanese °Ê²¼¤Ë CCUnit¤ò¥¤¥ó¥¹¥È¡¼¥ë¤¹¤ë¼ê½ç¤ò¼¨¤·¤Þ¤¹¡£ +@~ @if English
      @@ -55,17 +72,35 @@ you a organized view of %CCUnit modules. @~japanese ¥â¥¸¥å¡¼¥ë ¥»¥¯¥·¥ç¥ó¤Ï CCUnit ¤Î¥â¥¸¥å¡¼¥ë¤òÀ°Íý¤·¤Æɽ¼¨¤·¤Æ¤¤¤Þ¤¹¡£ +@~ @~english You find additional samples in the examples directory. @~japanese examples ¥Ç¥£¥ì¥¯¥È¥ê¤Ë¤Ï¥µ¥ó¥×¥ë¥Õ¥¡¥¤¥ë¤¬¤¢¤ê¤Þ¤¹¡£ -@~english -- ComplexTest.c - some complex number library test cases -@~japanese -- ComplexTest.c - Ê£ÁÇ¿ô¥é¥¤¥Ö¥é¥ê¤Î¤¤¤¯¤Ä¤«¤Î¥Æ¥¹¥È¥±¡¼¥¹¤Ç¤¹ -@~ +- complex - @~english some complex number library test cases + @~japanese Ê£ÁÇ¿ô¤ò·×»»¤¹¤ë¥é¥¤¥Ö¥é¥ê¤È¤½¤Î¥Æ¥¹¥È¥±¡¼¥¹¤Î¥µ¥ó¥×¥ë¤Ç¤¹¡£@~ + - libcomplex.a - complex number library + - complex.c + - complex.h + - runTestFixture @~japanese - ¤â¤Ã¤È¤âñ½ã¤Ê¥Æ¥¹¥È¥±¡¼¥¹¤ò¼Â¹Ô¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~ + - runTestFixture.c - main program + - testComplex.c - test cases + - runTestSuite @~japanese - ¥Æ¥¹¥È¥¹¡¼¥Ä¤Î¥µ¥ó¥×¥ë¤Ç¤¹¡£@~ + - runTestSuite.c - main program + - testComplex.c - test cases + - testComplexMulDiv.c - test cases + - complexTestSuite.c - create test suite function + - runTestRunner @~japanese - ¥Æ¥¹¥È¥¹¡¼¥Ä¤ò¥Æ¥¹¥È¥é¥ó¥Ê¡¼¤Ç¼Â¹Ô¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~ + - runTestRunner.c - main program + - testComplex.c - test cases + - testComplexMulDiv.c - test cases + - complexTestSuite.c - create test suite function + - runTest @~japanese - ¥Æ¥¹¥È¥¹¡¼¥Ä¤ò¼«Æ°À¸À®¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~ + - runTest.c - main program + - testComplex.c - test cases + - suiteComplex.c - auto generated test suite from testComplex.c @english @section _documentation Documentation @@ -85,6 +120,7 @@ examples (see also Cookbook in English Edition) + @~ @english @@ -96,10 +132,11 @@ examples @~english This library is released under the GNU Lesser General Public License. +>Lesser General Public License version 2. @~japanese ¤³¤Î¥é¥¤¥Ö¥é¥ê¤Ï¡¢GNU Lesser General Public License ¤Î¸µ¤ÇÇÛÉÛ¤·¤Æ¤¤¤Þ¤¹¡£ +>Lesser General Public License ¥Ð¡¼¥¸¥ç¥ó 2 ¤Î¸µ¤ÇÇÛÉÛ¤·¤Æ¤¤¤Þ¤¹¡£ +@~ @english @section _links Related Links @@ -111,6 +148,7 @@ This library is released under the GNU - CUnit: @~english CUnit is Unit Testing Framework for 'C' language. @~japanese CUnit ¤Ï 'C' ¸À¸ì¤Î¥æ¥Ë¥Ã¥È¥Æ¥¹¥È¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç¤¹¡£ + @~ - EmbUnit, EmbUnit: @~english @@ -119,32 +157,36 @@ This library is released under the GNU more, and then adapted somewhat for Embedded C System. Embedded Unit does not require std C libs. All objects are allocated to const area. - @~japanese EmbeddedUnit ¤ÏC¸À¸ì¤ò»È¤Ã¤¿ÁȤ߹þ¤ß·Ï³«È¯¸þ¤± - ¤Î¥Æ¥¹¥È¥æ¥Ë¥Ã¥È¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç¤¹¡£Cɸ½à¥é¥¤¥Ö¥é¥ê¤ò»È - ¤ï¤Ê¤¤¤Î¤Ç¼Â¹Ô»ñ¸»¤Î¾¯¤Ê¤¤¥¿¡¼¥²¥Ã¥È´Ä¶­¤Ç¤âÆ°ºî²Äǽ¤Ç¤¹¡£ + @~japanese EmbeddedUnit ¤Ï + C ¸À¸ì¤ò»È¤Ã¤¿ÁȤ߹þ¤ß·Ï³«È¯¸þ¤±¤Î¥Æ¥¹¥È¥æ¥Ë¥Ã¥È¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç¤¹¡£ + C ɸ½à¥é¥¤¥Ö¥é¥ê¤ò»È¤ï¤Ê¤¤¤Î¤Ç¼Â¹Ô»ñ¸»¤Î¾¯¤Ê¤¤¥¿¡¼¥²¥Ã¥È´Ä¶­¤Ç¤âÆ°ºî²Äǽ¤Ç¤¹¡£ + @~ - JUnit: @~english JUnit is a regression testing framework written by Erich Gamma and Kent Beck. It is used by the developer who implements unit tests in Java. @~japanese JUnit¤Ï¥ê¥°¥ì¥Ã¥·¥ç¥ó¥Æ¥¹¥È¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç¤¢¤ê¡¢ - Erich Gamma ¤È Kent Beck ¤Ë¤è¤Ã¤Æ½ñ¤«¤ì¤Þ¤·¤¿¡£¤³¤ì¤Ï - Java¤Ç¥Æ¥¹¥È¥æ¥Ë¥Ã¥È¤ò¼ÂÁõ¤¹¤ë³«È¯¼Ô¤¬»ÈÍѤ·¤Þ¤¹¡£ + Erich Gamma ¤È Kent Beck ¤Ë¤è¤Ã¤Æ½ñ¤«¤ì¤Þ¤·¤¿¡£ + ¤³¤ì¤Ï Java ¤Ç¥Æ¥¹¥È¥æ¥Ë¥Ã¥È¤ò¼ÂÁõ¤¹¤ë³«È¯¼Ô¤¬»ÈÍѤ·¤Þ¤¹¡£ + @~ - C++ Test Units - CppUnit: @~english CppUnit is a C++ unit testing framework. @~japanese CppUnit ¤Ï C++ ¥æ¥Ë¥Ã¥È¥Æ¥¹¥È¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç¤¹¡£ + @~ - CxxTest: @~english CxxTest is a JUnit/CppUnit/xUnit-like framework for C++. - @~japanese CxxTest ¤Ï JUnit/CppUnit/xUnit ¥é¥¤¥¯¤Î C++ÍÑ - ¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç¤¹¡£ + @~japanese CxxTest ¤Ï JUnit/CppUnit/xUnit ¥é¥¤¥¯¤Î C++Íѥե졼¥à¥ï¡¼¥¯¤Ç¤¹¡£ + @~ - ccUnit: @~english ccUnit is a C++ unit testing framework. - @~japanese ccUnit ¤Ï C++ ¥æ¥Ë¥Ã¥È¥Æ¥¹¥È¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç - ¤¹¡£ + @~japanese ccUnit ¤Ï C++ ¥æ¥Ë¥Ã¥È¥Æ¥¹¥È¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç¤¹¡£ + @~ - eXtreme Programing - XProgramming.com: @~english an Extreme Programming Resources. @~japanese ¥¨¥¯¥¹¥È¥ê¡¼¥à¥×¥í¥°¥é¥ß¥ó¥°¤Î¥ê¥½¡¼¥¹½¸¤Ç¤¹¡£ + @~ - XPJUG: @~english Japan XP User Group. @~japanese ÆüËÜXP¥æ¡¼¥¶¥°¥ë¡¼¥× -- 2.11.0