A position of a declaration of @ingroup is changed.

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

diff --git a/src/ccunit/CCUnitTestSuite.h b/src/ccunit/CCUnitTestSuite.h
index ee07953..c38cdf3 100755 (executable)
--- a/src/ccunit/CCUnitTestSuite.h
+++ b/src/ccunit/CCUnitTestSuite.h
@@ -44,14 +44,16 @@
 
 /**
  * A <code>Composite</code> class of Tests.
- * @ingroup CreatingTestSuite
  * It runs a collection of test cases. Here is an example.
- * <pre>
- *     CCUnitTestSuite* suite = ccunit_newTestSuite ();
- *     ccunit_addTestCase (suite, <var>TESTCASE_1</var>);
- *     ccunit_addTestCase (suite, <var>TESTCASE_2</var>);
- * </pre>
+ *
+ * @code
+ * CCUnitTestSuite* suite = ccunit_newTestSuite ();
+ * ccunit_addTestCase (suite, TESTCASE_1);
+ * ccunit_addTestCase (suite, TESTCASE_2);
+ * @endcode
+ *
  * @see CCUnitTest, CCUnitTestCase.
+ * @ingroup CreatingTestSuite
  */
 typedef struct CCUnitTestSuite
 {
@@ -62,41 +64,41 @@ typedef struct CCUnitTestSuite
 
 /**
  * Constructs an empty TestSuite.
- * @ingroup CreatingTestSuite
  * @param name test suite name.
  * @return new test suite.
+ * @ingroup CreatingTestSuite
  */
 extern inline CCUnitTestSuite* ccunit_newTestSuite(const char* name);
 
 /**
  * Destructs test suite.
- * @ingroup CreatingTestSuite
  * @param suite deleting suite.
+ * @ingroup CreatingTestSuite
  */
 extern inline void ccunit_deleteTestSuite (CCUnitTestSuite* suite);
 
 /**
  * Adds a test to the suite.
- * @ingroup CreatingTestSuite
  * @param suite test suite.
  * @param test test to add.
+ * @ingroup CreatingTestSuite
  */
 extern inline void ccunit_addTest (CCUnitTestSuite* suite, CCUnitTest* test);
 
 /**
  * Adds a test suite to the suite.
- * @ingroup CreatingTestSuite
  * @param suite test suite.
  * @param testSuite test to add.
+ * @ingroup CreatingTestSuite
  */
 extern inline void ccunit_addTestSuite (CCUnitTestSuite* suite,
                                        CCUnitTestSuite* testSuite);
 
 /**
  * Adds a test fixture to the suite.
- * @ingroup CreatingTestSuite
  * @param suite test suite.
  * @param fixture test to add.
+ * @ingroup CreatingTestSuite
  */
 extern inline void ccunit_addTestFixture (CCUnitTestSuite* suite,
                                          CCUnitTestFixture* fixture);
@@ -106,15 +108,16 @@ extern inline void ccunit_addTestFixture (CCUnitTestSuite* suite,
  * @param suite test suite.
  * @param result test result. if NULL, create a new result object and return it.
  * @return test result.
+ * @ingroup ExecutingTest
  */
 extern inline CCUnitTestResult* ccunit_runTestSuite (CCUnitTestSuite* suite,
                                                     CCUnitTestResult* result);
 
 /**
  * Create a test suite from test source file.
- * @ingroup CreatingTestSuite
  * @param name test suite name.
  * @return new test suite.
+ * @ingroup CreatingTestSuite
  */
 extern CCUnitTestSuite* ccunit_suite (const char* name);