diff options
Diffstat (limited to 'Source/charon/tester.h')
-rw-r--r-- | Source/charon/tester.h | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/Source/charon/tester.h b/Source/charon/tester.h index 3a90baae6..8d174fb25 100644 --- a/Source/charon/tester.h +++ b/Source/charon/tester.h @@ -1,8 +1,8 @@ /** * @file tester.h - * + * * @brief Test module for automatic testing - * + * */ /* @@ -21,7 +21,7 @@ */ #ifndef TESTER_H_ -#define TESTER_H_ +#define TESTER_H_ #include <stdio.h> @@ -44,55 +44,55 @@ struct test_s{ }; struct tester_s { - + /** * @brief Tests all testcases in array tests with specific tester object - * + * * @param tester tester object * @param pointer to a array of test_t-pointers. * the last item has to be NULL. * @return SUCCESSFUL if succeeded, FAILED otherwise */ status_t (*perform_tests) (tester_t *tester,test_t **tests); - + /** * @brief run a specific test case - * + * * @param this tester object - * @param test pointer to a test_t-object which will be performed + * @param test pointer to a test_t object which will be performed * @param Name of the Test */ status_t (*perform_test) (tester_t *tester, test_t *test); - + /** * @brief is called in a testcase to check a specific situation for TRUE - * + * * Log-Values to the tester output are protected from multiple access - * + * * @warning this function should only be called in a test_function - * + * * @param this tester object * @param to_be_true assert which has to be TRUE * @param Name of the assertion */ - void (*assert_true) (tester_t *tester, bool to_be_true, char *assert_name); + void (*assert_true) (tester_t *tester, bool to_be_true, char *assert_name); /** * @brief is called in a testcase to check a specific situation for FALSE - * + * * Log-Values to the tester output are protected from multiple access - * + * * @warning this function should only be called in a test_function - * + * * @param this tester object * @param to_be_false assert which has to be FALSE * @param Name of the assertion */ - void (*assert_false) (tester_t *tester, bool to_be_false, char *assert_name); + void (*assert_false) (tester_t *tester, bool to_be_false, char *assert_name); /** * @brief Destroys a tester object - * + * * @param tester tester object * @return SUCCESSFUL if succeeded, FAILED otherwise */ @@ -105,7 +105,7 @@ struct tester_s { * @param output test output is written to this output * @param display_succeeded_asserts has to be TRUE, if all asserts should be displayed, * else otherwise - * + * * @return tester object */ tester_t *tester_create(FILE *output, bool display_succeeded_asserts); |