doc: Document assert_memory_not_equal().
authorAndreas Schneider <asn@cryptomilk.org>
Sat, 10 Nov 2012 15:38:22 +0000 (16:38 +0100)
committerAndreas Schneider <asn@cryptomilk.org>
Sat, 10 Nov 2012 15:38:22 +0000 (16:38 +0100)
include/cmocka.h

index 18f26f3..1549328 100755 (executable)
@@ -507,10 +507,27 @@ void assert_memory_equal(const void *a, const void *b, size_t size);
                          __LINE__)
 #endif
 
-/* Assert that the two given areas of memory are not equal, otherwise fail. */
+#ifdef DOXYGEN
+/**
+ * @brief Assert that the two given areas of memory are not equal.
+ *
+ * The function prints an error message to standard error and terminates the
+ * test by calling fail() if the memory is equal.
+ *
+ * @param[in]  a  The first memory area to compare
+ *                (interpreted as unsigned char).
+ *
+ * @param[in]  b  The second memory area to compare
+ *                (interpreted as unsigned char).
+ *
+ * @param[in]  size  The first n bytes of the memory areas to compare.
+ */
+void assert_memory_not_equal(const void *a, const void *b, size_t size);
+#else
 #define assert_memory_not_equal(a, b, size) \
-    _assert_memory_not_equal((const char*)(a), (const char*)(b), size, \
+    _assert_memory_not_equal((const void*)(a), (const void*)(b), size, \
                              __FILE__, __LINE__)
+#endif
 
 /* Assert that the specified value is >= minimum and <= maximum. */
 #define assert_in_range(value, minimum, maximum) \