stv0g/Criterion
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Added doxygen docs for abort.h

Browse source
This commit is contained in:
Snaipe 2015-12-07 15:03:27 +01:00
parent dbe2894b88
commit 00ca6cfc67
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
include/criterion/abort.h
View file

@ -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