Write documentation for TEST_ASSERT

This commit is contained in:
Gilles Peskine 2018-09-27 13:51:25 +02:00
parent 159ebf3b8e
commit 8954d0c274

View file

@ -69,6 +69,18 @@ typedef struct data_tag
/*----------------------------------------------------------------------------*/
/* Macros */
/** Evaluate an expression and fail the test case if it is false.
*
* 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 expression to evaluate.
*/
#define TEST_ASSERT( TEST ) \
do { \
if( ! (TEST) ) \