unit-tests: Fix apidoc for libtest
authorTobias Brunner <tobias@strongswan.org>
Thu, 28 Nov 2013 16:54:06 +0000 (17:54 +0100)
committerAndreas Steffen <andreas.steffen@strongswan.org>
Wed, 4 Dec 2013 19:32:59 +0000 (20:32 +0100)
src/libstrongswan/tests/test_runner.h
src/libstrongswan/tests/test_suite.h

index fb4f52a..2651898 100644 (file)
  * 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 <plugins/plugin_feature.h>
@@ -53,8 +63,10 @@ struct test_configuration_t {
  *
  * 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
  * @return                             test result, EXIT_SUCCESS if all tests passed
  */
 int test_runner_run(test_configuration_t config[], test_runner_init_t init_cb);
+
+#endif /** TEST_RUNNER_H_ @}*/
index 11aca3b..c44f149 100644 (file)
  * 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
 #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
  *
- * @param tcase                test case to add test function to
- * @param cb           callback function to invoke for test
- * @param start                start of loop counter
- * @param end          end of loop counter
+ * @param suite                test suite to add test case to
+ * @param tcase                test case to add
  */
 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 END_TEARDOWN }
 
-#endif /** TEST_UTILS_H_ */
+#endif /** TEST_SUITE_H_ @}*/