Changeset 4293 for trunk/psLib/src/psTest.h

Timestamp:

Jun 16, 2005, 2:11:08 PM (21 years ago)

Author:

drobbin

Message:

* empty log message *

File:

• trunk/psLib/src/psTest.h (modified) (3 diffs)

trunk/psLib/src/psTest.h

@@ -5 +5 @@
  *  @author Robert DeSonia, MHPCC
  *
- *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-08 23:40:45 $
+ *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-17 00:10:55 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -29 +29 @@
 p_printFooter(filePtr, __FILE__, packageName, testPointName, success)
 
+/** Specifies the format of a user-defined function for use with psTest functions. */
 typedef psS32 (*testFcn)(void);
 
+/** Defines a data structure containing test description information. */
 typedef struct
 {
-    testFcn     fcn;
-    psS32       testPointNumber;
-    const char* testPointName;
-    psS32       expectedReturn;
-    psBool      isDuplicateEntry;
+    testFcn     fcn;                   ///< Specified test function
+    psS32       testPointNumber;       ///< Test Point Number
+    const char* testPointName;         ///< Test Point Name
+    psS32       expectedReturn;        ///< Expected return value
+    psBool      isDuplicateEntry;      ///< Is the entry a duplicate?
 }
 testDescription;
@@ -50 +52 @@
 /////////////////////////// PRIVATE FUNCTIONS //////////////////////////////
 
+///XXX: Comments correct?
+
+/** Procedure used to run a test.
+ *  
+ *  @return psBool:    True if successful.
+ */
 psBool p_runTest(
-    FILE *fp,
-    const char* testPointFile,
-    const char* packageName,
-    const char* testPointName,
-    testFcn fcn,
-    psS32 expectedReturn,
-    psBool useFork
+    FILE *fp,                          ///< File to test
+    const char* testPointFile,         ///< Test point in file
+    const char* packageName,           ///< Package name
+    const char* testPointName,         ///< Test point name
+    testFcn fcn,                       ///< Function tested
+    psS32 expectedReturn,              ///< Expected return
+    psBool useFork                     ///< Fork to use
 );
 
+/** Procedure used to run the test suite.
+ *  
+ *  @return psBool:    True if successful. 
+ */
 psBool p_runTestSuite(
-    FILE *fp,
-    const char* testPointFile,
-    const char* packageName,
-    testDescription tests[],
-    psS32 argc,
-    char * const argv[]
+    FILE *fp,                          ///< File to test
+    const char* testPointFile,         ///< Test point in file
+    const char* packageName,           ///< Package name
+    testDescription tests[],           ///< Description of tests
+    psS32 argc,                        ///< Number of test arguments
+    char * const argv[]                ///< Test arguments
 );
 
+/** Prints a positive test header to file */
 void p_printPositiveTestHeader(
-    FILE *fp,
-    const char* testPointFile,
-    const char* packageName,
-    const char* testPointName
+    FILE *fp,                          ///< File to which to print
+    const char* testPointFile,         ///< Test point in file
+    const char* packageName,           ///< Package name
+    const char* testPointName          ///< Test point name
 );
 
+/** Prints a negative test header to file */
 void p_printNegativeTestHeader(
-    FILE *fp,
-    const char* testPointFile,
-    const char* packageName,
-    const char* testPointName,
-    const char* expectedError,
-    psS32 exitValue
+    FILE *fp,                          ///< File to which to print
+    const char* testPointFile,         ///< Test point in file
+    const char* packageName,           ///< Package name
+    const char* testPointName,         ///< Test point name
+    const char* expectedError,         ///< Expected error
+    psS32 exitValue                    ///< Exit value
 );
 
+/** Prints a footer to file */
 void p_printFooter(
-    FILE *fp,
-    const char* testPointFile,
-    const char* packageName,
-    const char* testPointName,
-    psBool success
+    FILE *fp,                          ///< File to which to print
+    const char* testPointFile,         ///< Test point in file
+    const char* packageName,           ///< Package name
+    const char* testPointName,         ///< Test point name
+    psBool success                     ///< True if successful
 );