summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2012-11-16 13:37:01 +0100
committerAndreas Schneider <asn@cryptomilk.org>2012-11-16 13:39:13 +0100
commitfa064f39f0c487605abeda3097ddec4fc19ed377 (patch)
tree4a8bf11aa0308fbc80e42dcb9dfc8c596ec38b4f /include
parent5e4d713d494e39350c765c0950036931a9195569 (diff)
downloadcmocka-fa064f39f0c487605abeda3097ddec4fc19ed377.tar.gz
cmocka-fa064f39f0c487605abeda3097ddec4fc19ed377.tar.bz2
cmocka-fa064f39f0c487605abeda3097ddec4fc19ed377.zip
doc: Document assert_in_set().
Diffstat (limited to 'include')
-rwxr-xr-xinclude/cmocka.h18
1 files changed, 17 insertions, 1 deletions
diff --git a/include/cmocka.h b/include/cmocka.h
index f016559..49af082 100755
--- a/include/cmocka.h
+++ b/include/cmocka.h
@@ -575,9 +575,25 @@ void assert_not_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 within a set. */
+#ifdef DOXYGEN
+/**
+ * @brief Assert that the specified value is within a set.
+ *
+ * The function prints an error message to standard error and terminates the
+ * test by calling fail() if value is not within a set.
+ *
+ * @param[in] value The value to look up
+ *
+ * @param[in] values[] The array to check for the value.
+ *
+ * @param[in] count The size of the values array.
+ */
+void assert_in_set(uintmax_t value, uintmax_t values[], size_t count);
+#else
#define assert_in_set(value, values, number_of_values) \
_assert_in_set(value, values, number_of_values, __FILE__, __LINE__)
+#endif
+
/* Assert that the specified value is not within a set. */
#define assert_not_in_set(value, values, number_of_values) \
_assert_not_in_set(value, values, number_of_values, __FILE__, __LINE__)