add doxycomment

[ccunit/ccunit.git] / src / ccunit / CCUnitTestSuite.h

diff --git a/src/ccunit/CCUnitTestSuite.h b/src/ccunit/CCUnitTestSuite.h
index 5ffd90a..6874e4a 100755 (executable)
--- a/src/ccunit/CCUnitTestSuite.h
+++ b/src/ccunit/CCUnitTestSuite.h
@@ -21,9 +21,8 @@
 /*
  * $Id$
  */
-/**
- * @file
- * Test suite class.
+/** @file
+ * TestSuite module.
  */
 #ifndef CCUNITTESTSUITE_H
 #define CCUNITTESTSUITE_H
@@ -31,19 +30,26 @@
 #include <ccunit/CCUnitConfig.h>
 #include <ccunit/CCUnitList.h>
 #include <ccunit/CCUnitTest.h>
-#include <ccunit/CCUnitTestCase.h>
+#include <ccunit/CCUnitTestFixture.h>
 
 /**
+ * @ingroup CCUnitTest
+ * @defgroup CCUnitTestSuite TestSuite
+ *
  * A <code>Composite</code> class of Tests.
  * It runs a collection of test cases. Here is an example.
  * <pre>
  *     CCUnitTestSuite* suite = ccunit_newTestSuite ();
- *     ccunit_addTestCase (suite, CREATE_TESTCASE_1 ());
- *     ccunit_addTestCase (suite, CREATE_TESTCASE_2 ());
+ *     ccunit_addTestCase (suite, <var>TESTCASE_1</var>);
+ *     ccunit_addTestCase (suite, <var>TESTCASE_2</var>);
  * </pre>
- *
- * @see CCUnitTest
- * @see CCUnitTestCase
+ * @{
+ */
+
+/**
+ * A <code>Composite</code> class of Tests.
+ * It runs a collection of test cases.
+ * @see CCUnitTest, CCUnitTestCase.
  */
 typedef struct CCUnitTestSuite
 {
@@ -81,12 +87,12 @@ extern inline void ccunit_addTestSuite (CCUnitTestSuite* suite,
                                        CCUnitTestSuite* testSuite);
 
 /**
- * Adds a test case to the suite.
+ * Adds a test fixture to the suite.
  * @param suite test suite.
- * @param testCase test to add.
+ * @param fixture test to add.
  */
-extern inline void ccunit_addTestCase (CCUnitTestSuite* suite,
-                                      CCUnitTestCase* testCase);
+extern inline void ccunit_addTestFixture (CCUnitTestSuite* suite,
+                                         CCUnitTestFixture* fixture);
 
 /**
  * Create a test suite from test source file.
@@ -95,4 +101,5 @@ extern inline void ccunit_addTestCase (CCUnitTestSuite* suite,
  */
 extern CCUnitTestSuite* ccunit_suite (const char* name);
 
+/** @} */
 #endif