doc/mainpage.dox

   1 /* -*- Indented-Text -*- */
   2 /* $Id$ */
   3 /** @mainpage
   4
   5 CCUnit is a simple framework to write repeatable tests with C language.
   6
   7 @section _installation Installation
   8
   9 Below are the installation steps for installing CCUnit:
  10
  11 <ol>
  12 <li>expand the archive file.</li>
  13 <li>cd to expanded dir.</li>
  14 <li>run the `<code>./configure</code>' file.</li>
  15 <li>type <code>make</code> to create ccunit library. </li>
  16 <li>type <code>make install</code> to install.</li>
  17 </ol>
  18
  19 @section _usage Getting Started
  20
  21 <a href="modules.html">Modules</a> give
  22 you a organized view of %CCUnit modules.
  23
  24 <!--
  25 You find additional samples in the examples directory.
  26
  27 - SimpleTest.c - some simple test cases
  28 - ArrayTest.c - test case for array.
  29 -->
  30
  31 @section _documentation Documentation
  32
  33 <dl>
  34 <dt>CCUnit Cookbook</dt>
  35 <dd>A <a href="cookbook.html">cookbook</a> for implementing tests with CCUnit.
  36 </dl>
  37
  38 @section _license Lincense
  39
  40 This library is released under the GNU
  41 <a href="http://www.gnu.org/copyleft/lesser.html"
  42 >Lesser General Public License</a>.
  43
  44 */
  45
  46 /** @defgroup WritingTestFixture Writing test fixture
  47  */
  48
  49 /** @defgroup Assertions Making assertions
  50  */
  51
  52 /** @defgroup CreatingTestSuite Creating TestSuite
  53  */
  54
  55 /** @defgroup ExecutingTest Executing test
  56  */
  57
  58 /** @defgroup TrackingTestExecution Tracking test execution
  59  */
  60
  61 /** @defgroup BrowsingCollectedTestResult Browsing collected test result
  62  */
  63
  64 /** @defgroup ModuleHierarchy Module hierarchy
  65  */