Skip to content

Commit

Permalink
Add missing parameter to the documented interface.
Browse files Browse the repository at this point in the history
cr_(assert/expect)_mem_(n)eq are implemented by calls to
cr_assert_mem_op_va_. But while the documentation of
cr_(assert/expect)_mem_neq contains the third parameter Size, the
documentation for cr_(assert/expect)_mem_eq does not.

This fix only touches the "declaration" and the documentation of
cr_assert_arr_eq and cr_expect_arr_eq.
  • Loading branch information
siebenschlaefer authored and Snaipe committed Aug 26, 2018
1 parent 3c1514b commit ccae2fb
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions include/criterion/assert.h
Expand Up @@ -1101,11 +1101,12 @@
*
* @param[in] Actual Array to test
* @param[in] Expected Expected array
* @param[in] Size Number of bytes to check
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_assert_arr_eq(Actual, Expected, FormatString, ...) internal
#define cr_assert_arr_eq(Actual, Expected, Size, FormatString, ...) internal

/**
* Passes if Actual is byte-to-byte equal to Expected
Expand All @@ -1120,11 +1121,12 @@
*
* @param[in] Actual Array to test
* @param[in] Expected Expected array
* @param[in] Size Number of bytes to check
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_expect_arr_eq(Actual, Expected, FormatString, ...) internal
#define cr_expect_arr_eq(Actual, Expected, Size, FormatString, ...) internal

/**
* Passes if Actual is not byte-to-byte equal to Expected
Expand Down

0 comments on commit ccae2fb

Please sign in to comment.