/* -*- 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をインストールする手順を示します。
@~

@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
@section _sample_codes Sample Codes
@japanese
@section _sample_codes サンプルコード
@endif

@copydoc examples

@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, and test cases.
 * Test functions are packaged into a test case. Test cases packaged
 * into a suite. And suites are packaged into a suite.
 * Test case can have @c setUp and @c tearDown functions
 * which are called before and after running the test cases.
 * 
 * @japanese
 *
 * @defgroup Construction 構成
 * CCUnit はテストスーツ、テストケース、テスト関数から構成されます。
 *
 * 複数のテスト関数はテストケースにまとめられ、
 * いくつかのテストケースはテストスーツにまとめられます。
 * そしてテストスーツもまたテストスーツにまとめることができます。
 * テストスーツを実行すると、それにまとめられているテストスーツ、
 * テストケース、テスト関数が登録された順に実行されます。
 * 
 * テストケースには @c setUp と @c tearDown 関数を登録することができ、
 * テストケースが実行される際には、
 * それぞれのテスト関数を実行する前と後に、
 * @c setUp と @c teaDown が自動的に実行されます。
 * 
 * @endif
 *
 * @dotfile StructCollabo.dot @~english "CCUnit Structure Collaboration" 
 *  @~japanese "CCUnit 構造体構成図" @~
 *
 */

/**
 * @english
 * @defgroup Assertions Making assertions
 * @japanese
 * @defgroup Assertions アサートの宣言
 * テスト関数で使用するアサートマクロです。
 * @endif
 */

/**
 * @english
 * @defgroup WritingTestCase Writing test case
 * @japanese
 * @defgroup WritingTestCase テストケースを書く
 * @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
 */

/**
 * @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.
 */