From: Andreas Schneider <asn@cryptomilk.org>
Date: Mon, 15 Oct 2012 18:43:08 +0000 (+0200)
Subject: include: Add a group for mock objects.
X-Git-Tag: cmocka-1.1.1~286
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=400038f6cac93f9423dc3e8430e3029499b19061;p=platform%2Fupstream%2Fcmocka.git

include: Add a group for mock objects.
---

diff --git a/include/cmocka.h b/include/cmocka.h
index 743810d..6f0bacc 100755
--- a/include/cmocka.h
+++ b/include/cmocka.h
@@ -123,6 +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))
 
+/**
+ * @defgroup cmocka_mock Mock Objects
+ * @ingroup cmocka.
+ *
+ * Mock objects mock objects are simulated objects that mimic the behavior of
+ * real objects. Instead of calling the real objects, the tested object calls a
+ * mock object that merely asserts that the correct methods were called, with
+ * the expected parameters, in the correct order.
+ *
+ * @{
+ */
+
 #ifdef DOXYGEN
 /**
  * @brief Retrieve a return value of the current function.
@@ -189,6 +201,8 @@ void will_return_count(#function, void *value, int count);
                  cast_to_largest_integral_type(value), count)
 #endif
 
+/** @} */
+
 /*
  * Add a custom parameter checking function.  If the event parameter is NULL
  * the event structure is allocated internally by this function.  If event