OSDN Git Service

add doxycomment
authortsutsumi <>
Tue, 9 Sep 2003 12:54:05 +0000 (12:54 +0000)
committertsutsumi <>
Tue, 9 Sep 2003 12:54:05 +0000 (12:54 +0000)
src/ccunit/CCUnitTestRunner.h

index 489ff67..953d0ba 100644 (file)
@@ -38,19 +38,22 @@ typedef int (*ccunit_runsuite_func_t)(CCUnitTestRunner*, CCUnitTestSuite*);
  * collects its results.  This method can be used to start a test run
  * from your program.
  * <pre>
- * int main (int ac, char** av)
- * {
- *     CCUnitTestRunner* runner = ccunit_newTestRunner (NULL);
- *     CCUnitTestSuite* suite = create_testSuite ();
- *     return runner->run (runner, suite);
- * }
+ *     int main (int ac, char** av)
+ *     {
+ *         CCUnitTestRunner* runner = ccunit_newTestRunner (NULL);
+ *         CCUnitTestSuite* suite = CREATE_TESTSUITE ();
+ *         return runner->run (runner, suite);
+ *     }
+ * </pre>
+ * @see CCUnitTestSuite
+ * @see CCUnitTestCase
  */
 struct CCUnitTestRunner
 {
-  CCUnitTestListener listener;
-  CCUnitTestResult* result;
-  ccunit_runsuite_func_t run;
-  FILE* ofp;
+  CCUnitTestListener listener;                 /**< test listeners */
+  CCUnitTestResult* result;                    /**< test result container */
+  ccunit_runsuite_func_t run;                  /**< test run function */
+  FILE* ofp;                                   /**< result output stream */
 };
 
 /**