From 00ca6cfc6742d03fe30776befd9bb9e753a4c507 Mon Sep 17 00:00:00 2001 From: Snaipe Date: Mon, 7 Dec 2015 15:03:27 +0100 Subject: [PATCH] Added doxygen docs for abort.h --- include/criterion/abort.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/include/criterion/abort.h b/include/criterion/abort.h index d6a649e..77d841e 100644 --- a/include/criterion/abort.h +++ b/include/criterion/abort.h @@ -28,7 +28,18 @@ CR_BEGIN_C_API +/** + * Aborts the current test, marking it as failed. + * + * This function does not return. + */ CR_API CR_NORETURN void criterion_abort_test(void); + +/** + * Continues the current test. + * + * Used as a counterpart to criterion_abort_test. + */ CR_INLINE static void criterion_continue_test(void) {} CR_END_C_API