unit-tests: Fix apidoc for libtest

This commit is contained in:
Tobias Brunner
2013-12-04 20:32:59 +01:00
committed by Andreas Steffen
parent 3e8a44c2aa
commit 6354466a5b
2 changed files with 23 additions and 8 deletions
+13 -1
View File
@@ -13,6 +13,16 @@
* for more details. * for more details.
*/ */
/**
* @defgroup libtest libtest
*
* @defgroup test_runner test_runner
* @{ @ingroup libtest
*/
#ifndef TEST_RUNNER_H_
#define TEST_RUNNER_H_
#include "test_suite.h" #include "test_suite.h"
#include <plugins/plugin_feature.h> #include <plugins/plugin_feature.h>
@@ -53,8 +63,10 @@ struct test_configuration_t {
* *
* The configs array must be terminated with a NULL element. * The configs array must be terminated with a NULL element.
* *
* @param configs test suite constructors with dependencies * @param config test suite constructors with dependencies
* @param init_cb init/deinit callback * @param init_cb init/deinit callback
* @return test result, EXIT_SUCCESS if all tests passed * @return test result, EXIT_SUCCESS if all tests passed
*/ */
int test_runner_run(test_configuration_t config[], test_runner_init_t init_cb); int test_runner_run(test_configuration_t config[], test_runner_init_t init_cb);
#endif /** TEST_RUNNER_H_ @}*/
+10 -7
View File
@@ -15,8 +15,13 @@
* for more details. * for more details.
*/ */
#ifndef TEST_UTILS_H_ /**
#define TEST_UTILS_H_ * @defgroup test_suite test_suite
* @{ @ingroup libtest
*/
#ifndef TEST_SUITE_H_
#define TEST_SUITE_H_
#define _GNU_SOURCE #define _GNU_SOURCE
#include <setjmp.h> #include <setjmp.h>
@@ -161,10 +166,8 @@ void test_case_set_timeout(test_case_t *tcase, int s);
/** /**
* Add a test function to a test case, looped several times * Add a test function to a test case, looped several times
* *
* @param tcase test case to add test function to * @param suite test suite to add test case to
* @param cb callback function to invoke for test * @param tcase test case to add
* @param start start of loop counter
* @param end end of loop counter
*/ */
void test_suite_add_case(test_suite_t *suite, test_case_t *tcase); void test_suite_add_case(test_suite_t *suite, test_case_t *tcase);
@@ -326,4 +329,4 @@ void test_fail_msg(const char *file, int line, char *fmt, ...);
#define START_TEARDOWN(name) static void name() { #define START_TEARDOWN(name) static void name() {
#define END_TEARDOWN } #define END_TEARDOWN }
#endif /** TEST_UTILS_H_ */ #endif /** TEST_SUITE_H_ @}*/