subsys/ztest: Documentation fix

Documentation moved to the right place.
The argument name of the macro is aligned between the macros.

Signed-off-by: Radoslaw Koppel <radoslaw.koppel@nordicsemi.no>
This commit is contained in:
Radoslaw Koppel 2019-05-23 10:49:32 +02:00 committed by Anas Nashif
commit bf7b97bdf5

View file

@ -126,21 +126,6 @@ static inline void unit_test_noop(void)
#define ztest_user_unit_test(fn) \ #define ztest_user_unit_test(fn) \
ztest_user_unit_test_setup_teardown(fn, unit_test_noop, unit_test_noop) ztest_user_unit_test_setup_teardown(fn, unit_test_noop, unit_test_noop)
/**
* @brief Define a test suite
*
* This function should be called in the following fashion:
* ```{.c}
* ztest_test_suite(test_suite_name,
* ztest_unit_test(test_function),
* ztest_unit_test(test_other_function)
* );
*
* ztest_run_test_suite(test_suite_name);
* ```
*
* @param name Name of the testing suite
*/
/* definitions for use with testing application shared memory */ /* definitions for use with testing application shared memory */
#ifdef CONFIG_USERSPACE #ifdef CONFIG_USERSPACE
@ -154,8 +139,24 @@ extern struct k_mem_domain ztest_mem_domain;
#define ZTEST_BMEM #define ZTEST_BMEM
#define ZTEST_SECTION .data #define ZTEST_SECTION .data
#endif #endif
#define ztest_test_suite(name, ...) \
static ZTEST_DMEM struct unit_test _##name[] = { \ /**
* @brief Define a test suite
*
* This function should be called in the following fashion:
* ```{.c}
* ztest_test_suite(test_suite_name,
* ztest_unit_test(test_function),
* ztest_unit_test(test_other_function)
* );
*
* ztest_run_test_suite(test_suite_name);
* ```
*
* @param suite Name of the testing suite
*/
#define ztest_test_suite(suite, ...) \
static ZTEST_DMEM struct unit_test _##suite[] = { \
__VA_ARGS__, { 0 } \ __VA_ARGS__, { 0 } \
} }
/** /**