add related links

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

/* -*- Indented-Text -*- */
/* $Id$ */
/** @mainpage

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

@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 ¥Ç¥£¥ì¥¯¥È¥ê¤Ë¤Ï¥µ¥ó¥×¥ë¥Õ¥¡¥¤¥ë¤¬¤¢¤ê¤Þ¤¹¡£

@~english
- ComplexTest.c - some complex number library test cases
@~japanese
- ComplexTest.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>.
@~japanese
¤³¤Î¥é¥¤¥Ö¥é¥ê¤Ï¡¢GNU <a href="http://www.gnu.org/copyleft/lesser.html"
>Lesser General Public License</a> ¤Î¸µ¤ÇÇÛÉÛ¤·¤Æ¤¤¤Þ¤¹¡£

@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¥æ¡¼¥¶¥°¥ë¡¼¥×
    @~

*/

/** @defgroup WritingTestFixture Writing test fixture
 */

/** @defgroup Assertions Making assertions
 */

/** @defgroup CreatingTestSuite Creating TestSuite
 * @sa CCUnitMakeSuite
 */

/** @defgroup ExecutingTest Executing test
 */

/** @defgroup TrackingTestExecution Tracking test execution
 */

/** @defgroup BrowsingCollectedTestResult Browsing collected test result
 */

/** @defgroup ModuleHierarchy Module hierarchy
 */