OSDN Git Service

The convenient function to make TestRunner run was added.
authortsutsumi <>
Wed, 24 Sep 2003 10:44:31 +0000 (10:44 +0000)
committertsutsumi <>
Wed, 24 Sep 2003 10:44:31 +0000 (10:44 +0000)
src/ccunit/CCUnitTestRunner.h

index a04bc57..1feee55 100644 (file)
  */
 
 /**
- * @ingroup ExecutingTest
  * A command line based tool to run tests.  Runs a single test and
  * collects its results.  This method can be used to start a test run
  * from your program.
- * <pre>
+ * @code
  *     int main (int ac, char** av)
  *     {
  *       CCUnitTestRunner* runner = ccunit_newTestRunner (NULL);
  *       CCUnitTestSuite* suite = <var>CREATE_TESTSUITE</var> ();
  *       return runner->run (runner, suite);
  *     }
- * </pre>
+ * @endcode
  *
+ * @ingroup ExecutingTest
  * @see CCUnitTestSuite, CCUnitTestCase.
  */
 typedef struct CCUnitTestRunner CCUnitTestRunner;
@@ -74,20 +74,31 @@ struct CCUnitTestRunner
 };
 
 /**
- * @ingroup ExecutingTest
  * constructor.
+ * @ingroup ExecutingTest
  * @param output prints test result into this stream.
  * @return new CCUnitTestRunner object.
  */
 extern CCUnitTestRunner* ccunit_newTestRunner (FILE* output);
 
 /**
- * @ingroup ExecutingTest
  * destructor.
+ * @ingroup ExecutingTest
  * @param runner TestRunner object to destruct.
  */
 extern void ccunit_deleteTestRunner (CCUnitTestRunner* runner);
 
+/**
+ * Runs test suite.
+ *
+ * @param runner test runner
+ * @param suite test suite
+ * @return 0 if succeeded, -1 if error occurred.
+ * @ingroup ExecutingTest
+ */
+extern inline int ccunit_runTestRunner (CCUnitTestRunner* runner,
+                                       CCUnitTestSuite* suite);
+
 /** @} */
 
 #endif