diff options
| author | Andreas Schneider <asn@cryptomilk.org> | 2012-11-16 10:48:42 +0100 |
|---|---|---|
| committer | Andreas Schneider <asn@cryptomilk.org> | 2012-11-16 13:39:13 +0100 |
| commit | 5e4d713d494e39350c765c0950036931a9195569 (patch) | |
| tree | 687fafccbc30a7b7a9dafef1b90bddba1002bfb5 /include | |
| parent | 11db9285b934d7be83bf810dd22e7ac542a5921b (diff) | |
| download | cmocka-5e4d713d494e39350c765c0950036931a9195569.tar.gz cmocka-5e4d713d494e39350c765c0950036931a9195569.tar.bz2 cmocka-5e4d713d494e39350c765c0950036931a9195569.zip | |
doc: Document assert_not_in_range().
Diffstat (limited to 'include')
| -rwxr-xr-x | include/cmocka.h | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/include/cmocka.h b/include/cmocka.h index c57cc21..f016559 100755 --- a/include/cmocka.h +++ b/include/cmocka.h @@ -552,12 +552,28 @@ void assert_in_range(uintmax_t value, uintmax_t minimum, uintmax_t maximum); cast_to_largest_integral_type(maximum), __FILE__, __LINE__) #endif -/* Assert that the specified value is < minumum or > maximum */ +#ifdef DOXYGEN +/** + * @brief Assert that the specified value is smaller than the minimum and + * bigger than the maximum. + * + * The function prints an error message to standard error and terminates the + * test by calling fail() if value is in range. + * + * @param[in] value The value to check. + * + * @param[in] minimum The minimum value to compare. + * + * @param[in] maximum The maximum value to compare. + */ +void assert_not_in_range(uintmax_t value, uintmax_t minimum, uintmax_t maximum); +#else #define assert_not_in_range(value, minimum, maximum) \ _assert_not_in_range( \ cast_to_largest_integral_type(value), \ cast_to_largest_integral_type(minimum), \ cast_to_largest_integral_type(maximum), __FILE__, __LINE__) +#endif /* Assert that the specified value is within a set. */ #define assert_in_set(value, values, number_of_values) \ |