From 1b20be59e2a1056425e92969504eb4a94fa72595 Mon Sep 17 00:00:00 2001 From: Andrzej Kurek Date: Fri, 15 Feb 2019 10:13:35 -0500 Subject: [PATCH] Write documentation for TEST_ASSERT --- tests/suites/helpers.function | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/tests/suites/helpers.function b/tests/suites/helpers.function index 1255ff4be..269cdad2f 100644 --- a/tests/suites/helpers.function +++ b/tests/suites/helpers.function @@ -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 ) \