aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2020-10-05 18:01:13 +0200
committerAndreas Schneider <asn@cryptomilk.org>2020-10-05 18:01:13 +0200
commit314602bce45e79ed7da168d00e79e028da716b98 (patch)
treef9aed106f73c1e03b47c311d692409b8a0efd442
parente31967fbedc76ed6c14f1b864e9ae7a74863bbcd (diff)
downloadcmocka-314602bce45e79ed7da168d00e79e028da716b98.tar.gz
cmocka-314602bce45e79ed7da168d00e79e028da716b98.tar.xz
cmocka-314602bce45e79ed7da168d00e79e028da716b98.zip
include: Improve documentation for expect_value()
-rw-r--r--include/cmocka.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/include/cmocka.h b/include/cmocka.h
index 4b7724c..8791701 100644
--- a/include/cmocka.h
+++ b/include/cmocka.h
@@ -680,7 +680,7 @@ void expect_not_in_range_count(#function, #parameter, LargestIntegralType minimu
#ifdef DOXYGEN
/**
- * @brief Add an event to check if a parameter is the given value.
+ * @brief Add an event to check if a parameter is the given integer based value.
*
* The event is triggered by calling check_expected() in the mocked function.
*
@@ -690,7 +690,10 @@ void expect_not_in_range_count(#function, #parameter, LargestIntegralType minimu
*
* @param[in] value The value to check.
*
- * @see check_expected().
+ * @see check_expected()
+ * @see expect_string()
+ * @see expect_memory()
+ * @see expect_any()
*/
void expect_value(#function, #parameter, LargestIntegralType value);
#else
@@ -700,7 +703,8 @@ void expect_value(#function, #parameter, LargestIntegralType value);
#ifdef DOXYGEN
/**
- * @brief Add an event to repeatedly check if a parameter is the given value.
+ * @brief Add an event to repeatedly check if a parameter is the given integer
+ * based value.
*
* The event is triggered by calling check_expected() in the mocked function.
*
@@ -715,6 +719,8 @@ void expect_value(#function, #parameter, LargestIntegralType value);
* to -1 the value will always be returned.
*
* @see check_expected().
+ * @see expect_not_string()
+ * @see expect_not_memory()
*/
void expect_value_count(#function, #parameter, LargestIntegralType value, size_t count);
#else