Skip to content

Commit 1b20be5

Browse files
committed
Write documentation for TEST_ASSERT
1 parent 2d79266 commit 1b20be5

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

tests/suites/helpers.function

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,14 @@ typedef enum
9797
* This macro is not suitable for negative parameter validation tests,
9898
* as it assumes the test step will not create an error.
9999
*
100+
* Failing the test means:
101+
* - Mark this test case as failed.
102+
* - Print a message identifying the failure.
103+
* - Jump to the \c exit label.
104+
*
105+
* This macro expands to an instruction, not an expression.
106+
* It may jump to the \c exit label.
107+
*
100108
* \param TEST The test expression to be tested.
101109
*/
102110
#define TEST_ASSERT( TEST ) \

0 commit comments

Comments
 (0)