diff -r e974640ec4e0 -r aa376dba1ba8 ucx/test.h --- a/ucx/test.h Wed Aug 14 16:07:49 2013 +0200 +++ b/ucx/test.h Fri Aug 16 13:40:10 2013 +0200 @@ -81,6 +81,7 @@ #endif #ifndef __FUNCTION__ + /** * Alias for the __func__ preprocessor macro. * Some compilers use __func__ and others use __FUNC__. @@ -92,15 +93,19 @@ /** Type for the UcxTestSuite. */ typedef struct UcxTestSuite UcxTestSuite; + /** Pointer to a test function. */ typedef void(*UcxTest)(UcxTestSuite*,FILE*); + /** Type for the internal list of test cases. */ typedef struct UcxTestList UcxTestList; /** Structure for the internal list of test cases. */ struct UcxTestList { + /** Test case. */ UcxTest test; + /** Pointer to the next list element. */ UcxTestList *next; }; @@ -109,10 +114,13 @@ * A test suite containing multiple test cases. */ struct UcxTestSuite { + /** The number of successful tests after the suite has been run. */ unsigned int success; + /** The number of failed tests after the suite has been run. */ unsigned int failure; + /** * Internal list of test cases. * Use ucx_test_register() to add tests to this list. @@ -125,6 +133,7 @@ * @return a new test suite */ UcxTestSuite* ucx_test_suite_new(); + /** * Destroys a test suite. * @param suite the test suite to destroy @@ -140,6 +149,7 @@ * EXIT_FAILURE on failure */ int ucx_test_register(UcxTestSuite* suite, UcxTest test); + /** * Runs a test suite and writes the test log to the specified stream. * @param suite the test suite to run