Skip to content

Commit b4081dd

Browse files
author
David Lindelöf
committed
Only CHECK() needs the CHECK_TEXT() version documented
1 parent 4eac2bc commit b4081dd

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

manual.markdown

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,6 @@ The failure of one of these macros causes the current test to immediately exit:
138138
* CHECK(boolean condition) - checks any boolean result.
139139
* CHECK_TEXT(boolean condition, text) - checks any boolean result and prints text on failure.
140140
* CHECK_FALSE(condition) - checks any boolean result
141-
* CHECK_FALSE_TEXT(condition, text) - checks any boolean result and prints text on failure.
142141
* 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.
143142
* CHECK_COMPARE(first, relop, second) - checks thats a relational operator holds between two entities. On failure, prints what both operands evaluate to.
144143
* 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).
@@ -151,12 +150,12 @@ The failure of one of these macros causes the current test to immediately exit:
151150
* BYTES_EQUAL(expected, actual) - compares two numbers, eight bits wide.
152151
* POINTERS_EQUAL(expected, actual) - compares two pointers.
153152
* DOUBLES_EQUAL(expected, actual, tolerance) - compares two floating point numbers within some tolerance
154-
* FUNCTIONPOINTERS_EQUAL_TEXT(expected, actual, text) - compares two void (*)() function pointers
153+
* FUNCTIONPOINTERS_EQUAL(expected, actual) - compares two void (*)() function pointers
155154
* MEMCMP_EQUAL(expected, actual, size) - compares two areas of memory
156155
* BITS_EQUAL(expected, actual, mask) - compares expected to actual bit by bit, applying mask
157156
* FAIL(text) - always fails
158157

159-
*NOTE* Many macros have _TEXT() equivalents, which are not explicitly listed here.
158+
*NOTE* Most macros have _TEXT() equivalents like CHECK_TEXT(), which are not explicitly listed here.
160159

161160
<a id="setup_teardown"> </a>
162161

0 commit comments

Comments
 (0)