OSDN Git Service

add doxycomment
authortsutsumi <>
Tue, 9 Sep 2003 12:30:33 +0000 (12:30 +0000)
committertsutsumi <>
Tue, 9 Sep 2003 12:30:33 +0000 (12:30 +0000)
src/ccunit/CCUnitMakeSuite.h

index 38288ac..dd29737 100644 (file)
@@ -1,4 +1,4 @@
-/*
+/* -*- C -*-
  * $Id$
  */
 /* Copyright (C) 2003 TSUTSUMI Kikuo.
 #include <stdio.h>
 
 /**
- * Test Def.
+ * Test definition information.
  */
 typedef struct CCUnitTestDef
 {
-  CCUnitTestType_t type;
-  char* name;
+  CCUnitTestType_t type;                       /**< test type */
+  char* name;                                  /**< test name */
 } CCUnitTestDef;
 
 /**
- * Test Suite Def.
+ * Test suite definition information.
  */
 typedef struct CCUnitTestSuiteDef
 {
-  CCUnitTestDef super;
-  CCUnitList testdefs;
+  CCUnitTestDef super;                         /**< super class */
+  CCUnitList testdefs;                         /**< test defs list */
 } CCUnitTestSuiteDef;
 
 /**
- * Test Function Def
+ * Test function definition information.
  */
 typedef struct CCUnitTestFuncDef
 {
-  char* type;
-  char* name;
-  char* desc;
+  char* type;                                  /**< return type */
+  char* name;                                  /**< function name */
+  char* desc;                                  /**< description */
 } CCUnitTestFuncDef;
 
 /**
- * Test Case Def.
+ * Test case definition information.
  */
 typedef struct CCUnitTestCaseDef
 {
-  CCUnitTestDef super;
-  CCUnitList testFuncs;
-  CCUnitTestFuncDef* setUp;
-  CCUnitTestFuncDef* tearDown;
-  char* desc;
+  CCUnitTestDef super;                         /**< super class */
+  CCUnitTestFuncDef* runTest;                  /**< test run function */
+  CCUnitTestFuncDef* setUp;                    /**< test setup function */
+  CCUnitTestFuncDef* tearDown;                 /**< test tearDown function */
+  char* desc;                                  /**< test case description */
 } CCUnitTestCaseDef;
 
 /**