Write documentation for TEST_ASSERT

This commit is contained in:
Andrzej Kurek 2019-02-15 10:13:35 -05:00
parent 2d7926674d
commit 1b20be59e2

View file

@ -97,6 +97,14 @@ typedef enum
* This macro is not suitable for negative parameter validation tests,
* as it assumes the test step will not create an error.
*
* Failing the test means:
* - Mark this test case as failed.
* - Print a message identifying the failure.
* - Jump to the \c exit label.
*
* This macro expands to an instruction, not an expression.
* It may jump to the \c exit label.
*
* \param TEST The test expression to be tested.
*/
#define TEST_ASSERT( TEST ) \