From e392d993f7e77857329629466c1eac35ed5f1df3 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Mon, 15 Oct 2012 20:03:25 +0200 Subject: [PATCH] include: Document mock(). --- include/cmocka.h | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/include/cmocka.h b/include/cmocka.h index 5542696..969bb12 100755 --- a/include/cmocka.h +++ b/include/cmocka.h @@ -123,8 +123,18 @@ typedef unsigned int uintptr_t; #define cast_ptr_to_largest_integral_type(value) \ cast_to_largest_integral_type(cast_to_pointer_integral_type(value)) -/* Retrieves a return value for the current function. */ +#ifdef DOXYGEN +/** + * @brief Retrieve a return value of the current function. + * + * @return The value which was stored to return by this function. + * + * @see will_return() + */ +void *mock(void); +#else #define mock() _mock(__func__, __FILE__, __LINE__) +#endif /* * Stores a value to be returned by the specified function later. -- 2.7.4