diff options
author | Andreas Schneider <asn@cryptomilk.org> | 2014-05-20 11:03:39 +0200 |
---|---|---|
committer | Andreas Schneider <asn@cryptomilk.org> | 2014-05-20 11:04:26 +0200 |
commit | 12b3daf6096b3fc6766b4c40a030fd3eb9b1f2e5 (patch) | |
tree | 2a7e327f244bbd4e7d5c5e4dea997ec1a17ddafb /include | |
parent | 9f0079df7e73e3ae2fde35fb371186e775d7b235 (diff) | |
download | cmocka-12b3daf6096b3fc6766b4c40a030fd3eb9b1f2e5.tar.gz cmocka-12b3daf6096b3fc6766b4c40a030fd3eb9b1f2e5.tar.bz2 cmocka-12b3daf6096b3fc6766b4c40a030fd3eb9b1f2e5.zip |
doc: Improve documentation for fail_msg().
BUG: https://open.cryptomilk.org/issues/29
Signed-off-by: Andreas Schneider <asn@cryptomilk.org>
Diffstat (limited to 'include')
-rw-r--r-- | include/cmocka.h | 11 |
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 |