Skip to content

Commit 4eac2bc

Browse files
author
David Lindelöf
committed
Document CHECK_COMPARE()
1 parent a31e1e9 commit 4eac2bc

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

manual.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ The failure of one of these macros causes the current test to immediately exit:
140140
* CHECK_FALSE(condition) - checks any boolean result
141141
* CHECK_FALSE_TEXT(condition, text) - checks any boolean result and prints text on failure.
142142
* CHECK_EQUAL(expected, actual) - checks for equality between entities using ==. So if you have a class that supports operator==() you can use this macro to compare two instances. You will also need to add a StringFrom() function like those found in SimpleString. This is for printing the objects when the check failed.
143+
* CHECK_COMPARE(first, relop, second) - checks thats a relational operator holds between two entities. On failure, prints what both operands evaluate to.
143144
* CHECK_THROWS(expected_exception, expression) - checks if expression throws expected_exception (e.g. std::exception). CHECK_THROWS is only available if CppUTest is built with the Standard C++ Library (default).
144145
* STRCMP_EQUAL(expected, actual) - checks const char* strings for equality using strcmp().
145146
* STRNCMP_EQUAL(expected, actual, length) - checks const char* strings for equality using strncmp().

0 commit comments

Comments
 (0)