summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
Diffstat (limited to 'include')
-rw-r--r--include/cmocka.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/include/cmocka.h b/include/cmocka.h
index c3a6dda..0f0e4e6 100644
--- a/include/cmocka.h
+++ b/include/cmocka.h
@@ -1294,6 +1294,17 @@ void fail(void);
#ifdef DOXYGEN
/**
* @brief Forces the test to fail immediately and quit, printing the reason.
+ *
+ * @code
+ * fail_msg("This is some error message for test");
+ * @endcode
+ *
+ * or
+ *
+ * @code
+ * char *error_msg = "This is some error message for test";
+ * fail_msg("%s", error_msg);
+ * @endcode
*/
void fail_msg(const char *msg, ...);
#else