add mainpage comment

diff --git a/src/ccunit/CCUnit.h b/src/ccunit/CCUnit.h
index af47a1f..b219b69 100644 (file)
--- a/src/ccunit/CCUnit.h
+++ b/src/ccunit/CCUnit.h
@@ -21,12 +21,17 @@
 /*
  * $Id$
  */
+
+/** @file
+ * Include all CCUnit header file for convenience.
+ */
+
 #ifndef CCUNIT_H
 #define CCUNIT_H
 
 #include <ccunit/CCUnitConfig.h>
 #include <ccunit/CCUnitAssert.h>
-#include <ccunit/CCUnitFailure.h>
+#include <ccunit/CCUnitTestFailure.h>
 #include <ccunit/CCUnitList.h>
 #include <ccunit/CCUnitTest.h>
 #include <ccunit/CCUnitTestCase.h>
@@ -36,4 +41,28 @@
 #include <ccunit/CCUnitLogMessage.h>
 #include <ccunit/CCUnitMakeSuite.h>
 
+/** @mainpage
+
+CCUnit is a simple framework to write repeatable tests with C language.
+
+@section Installation
+
+Below are the installation steps for installing CCUnit:
+
+<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>
+
+@section Lincense
+
+This library is released under the GNU
+<a href="http://www.gnu.org/copyleft/lesser.html"
+>Lesser General Public License</a>.
+
+*/
+
 #endif