Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Fix cr_assert/expect_arr_*_cmp assertions documentation #551

Open
wants to merge 1 commit into
base: bleeding
Choose a base branch
from
Open

docs: Fix cr_assert/expect_arr_*_cmp assertions documentation #551

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions include/criterion/assert.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1196,13 +1196,13 @@
*
* @param[in] Actual Array to test
* @param[in] Expected Expected array
* @param[in] Size Number of bytes to check
* @param[in] Length Count of array elements to compare
* @param[in] Cmp The comparator to use
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_assert_arr_eq_cmp(Actual, Expected, Size, Cmp, FormatString, ...) internal
#define cr_assert_arr_eq_cmp(Actual, Expected, Length, Cmp, FormatString, ...) internal

/**
* Passes if Actual is comparatively equal to Expected (C++ / GNU C99 only)
Expand All @@ -1220,13 +1220,13 @@
*
* @param[in] Actual Array to test
* @param[in] Expected Expected array
* @param[in] Size Number of bytes to check
* @param[in] Length Count of array elements to compare
* @param[in] Cmp The comparator to use
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_expect_arr_eq_cmp(Actual, Expected, Size, Cmp, FormatString, ...) internal
#define cr_expect_arr_eq_cmp(Actual, Expected, Length, Cmp, FormatString, ...) internal

/**
* Passes if Actual is not comparatively equal to Unexpected (C++ / GNU C99
Expand All @@ -1246,13 +1246,13 @@
*
* @param[in] Actual Array to test
* @param[in] Unexpected Unexpected array
* @param[in] Size Number of bytes to check
* @param[in] Length Count of array elements to compare
* @param[in] Cmp The comparator to use
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_assert_arr_neq_cmp(Actual, Unexpected, Size, Cmp, FormatString, ...) internal
#define cr_assert_arr_neq_cmp(Actual, Unexpected, Length, Cmp, FormatString, ...) internal

/**
* Passes if Actual is not comparatively equal to Unexpected (C++ / GNU C99
Expand All @@ -1271,13 +1271,13 @@
*
* @param[in] Actual Array to test
* @param[in] Unexpected Unexpected array
* @param[in] Size Number of bytes to check
* @param[in] Length Count of array elements to compare
* @param[in] Cmp The comparator to use
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_expect_arr_neq_cmp(Actual, Unexpected, Size, Cmp, FormatString, ...) internal
#define cr_expect_arr_neq_cmp(Actual, Unexpected, Length, Cmp, FormatString, ...) internal

/**
* Passes if Actual is comparatively less than Reference (C++ / GNU C99 only)
Expand All @@ -1296,13 +1296,13 @@
*
* @param[in] Actual Array to test
* @param[in] Reference Reference array
* @param[in] Size Number of bytes to check
* @param[in] Length Count of array elements to compare
* @param[in] Cmp The comparator to use
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_assert_arr_lt_cmp(Actual, Reference, Size, Cmp, FormatString, ...) internal
#define cr_assert_arr_lt_cmp(Actual, Reference, Length, Cmp, FormatString, ...) internal

/**
* Passes if Actual is comparatively less than Reference (C++ / GNU C99 only)
Expand All @@ -1320,13 +1320,13 @@
*
* @param[in] Actual Array to test
* @param[in] Reference Reference array
* @param[in] Size Number of bytes to check
* @param[in] Length Count of array elements to compare
* @param[in] Cmp The comparator to use
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_expect_arr_lt_cmp(Actual, Reference, Size, Cmp, FormatString, ...) internal
#define cr_expect_arr_lt_cmp(Actual, Reference, Length, Cmp, FormatString, ...) internal

/**
* Passes if Actual is comparatively less or equal to Reference (C++ / GNU C99
Expand All @@ -1346,13 +1346,13 @@
*
* @param[in] Actual Array to test
* @param[in] Reference Reference array
* @param[in] Size Number of bytes to check
* @param[in] Length Count of array elements to compare
* @param[in] Cmp The comparator to use
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_assert_arr_leq_cmp(Actual, Reference, Size, Cmp, FormatString, ...) internal
#define cr_assert_arr_leq_cmp(Actual, Reference, Length, Cmp, FormatString, ...) internal

/**
* Passes if Actual is comparatively less or equal to Reference (C++ / GNU C99
Expand All @@ -1371,13 +1371,13 @@
*
* @param[in] Actual Array to test
* @param[in] Reference Reference array
* @param[in] Size Number of bytes to check
* @param[in] Length Count of array elements to compare
* @param[in] Cmp The comparator to use
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_expect_arr_leq_cmp(Actual, Reference, Size, Cmp, FormatString, ...) internal
#define cr_expect_arr_leq_cmp(Actual, Reference, Length, Cmp, FormatString, ...) internal

/**
* Passes if Actual is comparatively greater than Reference (C++ / GNU C99 only)
Expand All @@ -1396,13 +1396,13 @@
*
* @param[in] Actual Array to test
* @param[in] Reference Reference array
* @param[in] Size Number of bytes to check
* @param[in] Length Count of array elements to compare
* @param[in] Cmp The comparator to use
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_assert_arr_gt_cmp(Actual, Reference, Size, Cmp, FormatString, ...) internal
#define cr_assert_arr_gt_cmp(Actual, Reference, Length, Cmp, FormatString, ...) internal

/**
* Passes if Actual is comparatively greater than Reference (C++ / GNU C99 only)
Expand All @@ -1420,13 +1420,13 @@
*
* @param[in] Actual Array to test
* @param[in] Reference Reference array
* @param[in] Size Number of bytes to check
* @param[in] Length Count of array elements to compare
* @param[in] Cmp The comparator to use
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_expect_arr_gt_cmp(Actual, Reference, Size, Cmp, FormatString, ...) internal
#define cr_expect_arr_gt_cmp(Actual, Reference, Length, Cmp, FormatString, ...) internal

/**
* Passes if Actual is comparatively greater or equal to Reference (C++ / GNU
Expand All @@ -1446,13 +1446,13 @@
*
* @param[in] Actual Array to test
* @param[in] Reference Reference array
* @param[in] Size Number of bytes to check
* @param[in] Length Count of array elements to compare
* @param[in] Cmp The comparator to use
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_assert_arr_geq_cmp(Actual, Reference, Size, Cmp, FormatString, ...) internal
#define cr_assert_arr_geq_cmp(Actual, Reference, Length, Cmp, FormatString, ...) internal

/**
* Passes if Actual is comparatively greater or equal to Reference (C++ / GNU
Expand All @@ -1471,13 +1471,13 @@
*
* @param[in] Actual Array to test
* @param[in] Reference Reference array
* @param[in] Size Number of bytes to check
* @param[in] Length Count of array elements to compare
* @param[in] Cmp The comparator to use
* @param[in] FormatString (optional) printf-like format string
* @param[in] ... (optional) format string parameters
*
*****************************************************************************/
#define cr_expect_arr_geq_cmp(Actual, Reference, Size, Cmp, FormatString, ...) internal
#define cr_expect_arr_geq_cmp(Actual, Reference, Length, Cmp, FormatString, ...) internal

/**@}*/

Expand Down