fix doxygen command error

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

/* -*- 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 <http://www.gnu.org/licenses/>
*/
/* $Id$ */
/** @mainpage

@~english
CCUnit is a simple framework to write repeatable tests with C language.
</p>
<p>
[see also <a href="../ja/index.html">Japanese</a> documents]
</p>
@~japanese
CCUnit ¤Ï C ¸À¸ì¤Ç·«¤êÊÖ¤·²Äǽ¤Ê¥Æ¥¹¥È¤ò½ñ¤¯¤¿¤á¤Î´Êñ¤Ê¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç¤¹¡£
</p>
<p>
[see also <a href="../../index.html">English</a> documents]
</p>
@~

@english
@section _installation Installation
@japanese
@section _installation ¥¤¥ó¥¹¥È¡¼¥ë
@endif

@~english
Below are the installation steps for installing CCUnit:
@~japanese
°Ê²¼¤Ë CCUnit¤ò¥¤¥ó¥¹¥È¡¼¥ë¤¹¤ë¼ê½ç¤ò¼¨¤·¤Þ¤¹¡£
@~

@if English
<ol>
<li>expand the archive file.</li>
<li>cd to expanded dir. </li>
<li>run the `<code>./configure</code>' file. </li>
<li>type <code>make</code> to create ccunit library. </li>
<li>type <code>make install</code> to install.</li>
</ol>
@japanese
<ol>
<li>¥¢¡¼¥«¥¤¥Ö¥Õ¥¡¥¤¥ë¤òŸ³«¤·¤Þ¤¹¡£</li>
<li>Ÿ³«¤·¤¿¥Ç¥£¥ì¥¯¥È¥ê¤Ëcd¤·¤Þ¤¹¡£</li>
<li>`<code>./configure</code>' ¥Õ¥¡¥¤¥ë¤ò¼Â¹Ô¤·¤Þ¤¹¡£</li>
<li><code>make</code> ¤È¥¿¥¤¥×¤·¤Æ ccunit ¥é¥¤¥Ö¥é¥ê¤òºîÀ®¤·¤Þ¤¹¡£</li>
<li><code>make install</code> ¤È¤·¤Æ¥¤¥ó¥¹¥È¡¼¥ë¤·¤Þ¤¹¡£</li>
</ol>
@endif

@english
@section _usage Getting Started
@japanese
@section _usage ¤µ¤¢»Ï¤á¤Þ¤·¤ç¤¦
@endif

@~english
<a href="modules.html">Modules</a> give
you a organized view of %CCUnit modules.
@~japanese
<a href="modules.html">¥â¥¸¥å¡¼¥ë</a>
¥»¥¯¥·¥ç¥ó¤Ï CCUnit ¤Î¥â¥¸¥å¡¼¥ë¤òÀ°Íý¤·¤Æɽ¼¨¤·¤Æ¤¤¤Þ¤¹¡£
@~

@~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
  - 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
@japanese
@section _documentation ¥É¥­¥å¥á¥ó¥È
@endif

<dl>
<dt>CCUnit Cookbook</dt>
<dd>@~english
    A <a href="cookbook.html">cookbook</a> for implementing
    tests with CCUnit. (and <a
    href="../ja/cookbook.html">cookbook in
    japanese</a>)
    @~japanese
    CCUnit¤Ç¥Æ¥¹¥È¤ò¼ÂÁõ¤¹¤ë¤¿¤á¤Î<a href="cookbook.html">¥¯¥Ã¥¯¥Ö¥Ã¥¯</a>
    (see also <a
    href="../../cookbook.html">Cookbook in
    English</a> Edition)
    @~
</dl>

@english
@section _license Lincense
@japanese
@section _license ¥é¥¤¥»¥ó¥¹
@endif

@~english
This library is released under the GNU
<a href="http://www.gnu.org/copyleft/lesser.html"
>Lesser General Public License</a> version 2.
@~japanese
¤³¤Î¥é¥¤¥Ö¥é¥ê¤Ï¡¢GNU <a href="http://www.gnu.org/copyleft/lesser.html"
>Lesser General Public License</a> ¥Ð¡¼¥¸¥ç¥ó 2 ¤Î¸µ¤ÇÇÛÉÛ¤·¤Æ¤¤¤Þ¤¹¡£
@~

@english
@section _links Related Links
@japanese 
@section _links ´ØÏ¢¥ê¥ó¥¯
@endif

- C Test Units
  - <a href="http://cunit.sourceforge.net/">CUnit</a>:
    @~english CUnit is Unit Testing Framework for 'C' language.
    @~japanese CUnit ¤Ï 'C' ¸À¸ì¤Î¥æ¥Ë¥Ã¥È¥Æ¥¹¥È¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç¤¹¡£
    @~
  - <a href="http://sourceforge.net/projects/embunit/">EmbUnit</a>,
    <a href="http://sourceforge.jp/projects/embunit/">EmbUnit</a>:
    @~english
    Embedded Unit is unit testing framework for Embedded C
    System. Its design was copied from JUnit and CUnit and
    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 ɸ½à¥é¥¤¥Ö¥é¥ê¤ò»È¤ï¤Ê¤¤¤Î¤Ç¼Â¹Ô»ñ¸»¤Î¾¯¤Ê¤¤¥¿¡¼¥²¥Ã¥È´Ä¶­¤Ç¤âÆ°ºî²Äǽ¤Ç¤¹¡£
    @~
- <a href="http://junit.org/index.htm">JUnit</a>:
  @~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 ¤Ç¥Æ¥¹¥È¥æ¥Ë¥Ã¥È¤ò¼ÂÁõ¤¹¤ë³«È¯¼Ô¤¬»ÈÍѤ·¤Þ¤¹¡£
  @~
- C++ Test Units
  - <a href="http://cppunit.sourceforge.net/cgi-bin/moin.cgi">CppUnit</a>:
    @~english CppUnit is a C++ unit testing framework.
    @~japanese CppUnit ¤Ï C++ ¥æ¥Ë¥Ã¥È¥Æ¥¹¥È¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç¤¹¡£
    @~
  - <a href="http://cxxtest.sourceforge.net/">CxxTest</a>:
    @~english CxxTest is a JUnit/CppUnit/xUnit-like framework for C++.
    @~japanese CxxTest ¤Ï JUnit/CppUnit/xUnit ¥é¥¤¥¯¤Î C++Íѥե졼¥à¥ï¡¼¥¯¤Ç¤¹¡£
    @~
  - <a href="http://sourceforge.net/projects/ccunit">ccUnit</a>:
    @~english ccUnit is a C++ unit testing framework.
    @~japanese ccUnit ¤Ï C++ ¥æ¥Ë¥Ã¥È¥Æ¥¹¥È¥Õ¥ì¡¼¥à¥ï¡¼¥¯¤Ç¤¹¡£
    @~
- eXtreme Programing
  - <a href="http://www.xprogramming.com/index.htm">XProgramming.com</a>:
    @~english an Extreme Programming Resources.
    @~japanese ¥¨¥¯¥¹¥È¥ê¡¼¥à¥×¥í¥°¥é¥ß¥ó¥°¤Î¥ê¥½¡¼¥¹½¸¤Ç¤¹¡£
    @~
  - <a href="http://xp.medinfo.m.ehime-u.ac.jp/">XPJUG</a>:
    @~english Japan XP User Group. 
    @~japanese ÆüËÜXP¥æ¡¼¥¶¥°¥ë¡¼¥×
    @~

*/

/**
 * @english
 * @defgroup Construction Construction
 * CCUnit manages test suites, test fixtures, test cases.
 * @japanese
 * @defgroup Construction ¹½À®
 * CCUnit ¤Ï¥Æ¥¹¥È¥¹¡¼¥Ä¡¢¥Æ¥¹¥È¥Õ¥£¥¯¥¹¥Á¥ã¡¢¥Æ¥¹¥È¥±¡¼¥¹¤ò´ÉÍý¤·¤Þ¤¹¡£
 * @endif
 * @dot
digraph CCUnitTestStructure {
  node [ fontsize=9, fontname=Helvetica ];
  edge [ dir=back, fontsize=9 ];
  TestSuite -> TestSuite [ label="1..n" ];
  TestSuite -> TestFixture [ label="1..n" ];
  TestFixture -> setUp [ label="0..1" ];
  TestFixture -> TestCase [ label="1..n" ];
  TestFixture -> tearDown [ label="0..1" ];
}
 * @enddot
 *
 * @english
 * Test cases are packaged into a fixture. Fixtures packaged
 * into a suite. And suites are packaged into a suite.
 * Fixtures can have @c setUp and @c tearDown functions
 * which are called before and after running the test cases.
 * @japanese
 * ¤¤¤¯¤Ä¤«¤Î¥Æ¥¹¥È¥±¡¼¥¹¤Ï¥Æ¥¹¥È¥Õ¥£¥¯¥¹¥Á¥ã¤Ë¤Þ¤È¤á¤é¤ì¡¢
 * ¤Þ¤¿¤¤¤¯¤Ä¤«¤Î¥Æ¥¹¥È¥Õ¥£¥¯¥¹¥Á¥ã¤Ï¥Æ¥¹¥È¥¹¡¼¥Ä¤Ë¤Þ¤È¤á¤é¤ì¤Þ¤¹¡£
 * ¤½¤·¤Æ¥Æ¥¹¥È¥¹¡¼¥Ä¤â¤Þ¤¿¥Æ¥¹¥È¥¹¡¼¥Ä¤Ë¤Þ¤È¤á¤é¤ì¤Þ¤¹¡£
 * ¥Æ¥¹¥È¥¹¡¼¥Ä¤ò¼Â¹Ô¤¹¤ë¤È¡¢¤½¤ì¤Ë¤Þ¤È¤á¤é¤ì¤Æ¤¤¤ë¥Æ¥¹¥È¥¹¡¼¥Ä¡¢
 * ¥Æ¥¹¥È¥Õ¥£¥¯¥¹¥Á¥ã¤¬½çÈ֤˼¹Ԥµ¤ì¤Þ¤¹¡£
 * ¥Æ¥¹¥È¥Õ¥£¥¯¥¹¥Á¥ã¤Ë¤Ï @c setUp ¤È @c tearDown ´Ø¿ô¤òÅÐÏ¿¤¹¤ë¤³¤È¤¬¤Ç¤­¡¢
 * ¥Æ¥¹¥È¥Õ¥£¥¯¥¹¥Á¥ã¤¬¼Â¹Ô¤µ¤ì¤ëºÝ¤Ë¤Ï¡¢
 * ¤½¤ì¤¾¤ì¤Î¥Æ¥¹¥È¥±¡¼¥¹¤ò¼Â¹Ô¤¹¤ëÁ°¤È¸å¤Ë¡¢
 * @c setUp ¤È @c teaDown ¤¬¼«Æ°Åª¤Ë¼Â¹Ô¤µ¤ì¤Þ¤¹¡£
 * @endif
 */

/**
 * @english
 * @defgroup Assertions Making assertions
 * @japanese
 * @defgroup Assertions ¥¢¥µ¡¼¥È¤ÎÀë¸À
 * ¥Æ¥¹¥È¥±¡¼¥¹¤Ç»ÈÍѤ¹¤ë¥¢¥µ¡¼¥È¥Þ¥¯¥í¤Ç¤¹¡£
 * @endif
 */

/**
 * @english
 * @defgroup WritingTestFixture Writing test fixture
 * @japanese
 * @defgroup WritingTestFixture ¥Æ¥¹¥È¥Õ¥£¥¯¥¹¥Á¥ã¤ò½ñ¤¯
 * °ìÏ¢¤Î¥Æ¥¹¥È¥±¡¼¥¹¤ò¡¢
 * ½àÈ÷¤ò¤¹¤ë´Ø¿ô¤È¸å½èÍý¤ò¤¹¤ë´Ø¿ô¤Ç¤Þ¤È¤á¤¿¤â¤Î¤ò¥Õ¥£¥¯¥¹¥Á¥ã¤È¸Æ¤Ó¤Þ¤¹¡£
 * @endif
 */

/**
 * @english
 * @defgroup CreatingTestSuite Creating TestSuite
 * @japanese
 * @defgroup CreatingTestSuite ¥Æ¥¹¥È¥¹¡¼¥Ä¤ÎÀ¸À®
 * ¤¤¤¯¤Ä¤«¤Î¥Æ¥¹¥È¥Õ¥£¥¯¥¹¥Á¥ã¤ä¥Æ¥¹¥È¥¹¡¼¥Ä¤ò¤Þ¤È¤á¤Æ¡¢
 * ¤Ò¤È¤Ä¤Î¥Æ¥¹¥È¥¹¡¼¥Ä¤Ë¤·¤Þ¤¹¡£
 * @endif
 * @sa CCUnitMakeSuite
 */

/**
 * @english
 * @defgroup ExecutingTest Executing test
 * @japanese
 * @defgroup ExecutingTest ¥Æ¥¹¥È¤Î¼Â¹Ô
 * ¥Æ¥¹¥È¥¹¡¼¥Ä¤ò¼Â¹Ô¤·¤Þ¤¹¡£
 * @endif
 */

/**
 * @english
 * @defgroup TrackingTestExecution Tracking test execution
 * @japanese
 * @defgroup TrackingTestExecution ¥Æ¥¹¥È¤Î¼Â¹Ô¤ÎÄÉÀ×
 * ¥Æ¥¹¥È¤Î¼Â¹Ô¤òÄÉÀפ·¤Þ¤¹¡£
 * @endif
 */

/**
 * @english
 * @defgroup BrowsingCollectedTestResult Browsing collected test result
 * @japanese
 * @defgroup BrowsingCollectedTestResult ¥Æ¥¹¥È·ë²Ì¤Î»²¾È
 * ¥Æ¥¹¥È·ë²Ì¤ò»²¾È¤·¤Þ¤¹¡£
 * @endif
 */

/**
 * @english
 * @defgroup ModuleHierarchy Module hierarchy
 * @japanese
 * @defgroup ModuleHierarchy ¥â¥¸¥å¡¼¥ë³¬ÁØ
 * @endif
 */