update check.h.in with new check API, and remove reference to deprecated API

git-svn-id: svn+ssh://svn.code.sf.net/p/check/code/trunk@651 64e312b2-a51f-0410-8e61-82d0ca0eb02a

diff --git a/src/check.h.in b/src/check.h.in
index 92ba0d9d36c77622616ea92e13e65460a7f57bfe..2c612a090c851c80f0fa87562b7d6c3c6c2081fa 100644 (file)
--- a/src/check.h.in
+++ b/src/check.h.in
@@ -35,9 +35,30 @@
    can be used within source code editors and IDEs.
 
    Unit tests are created with the START_TEST/END_TEST macro
-   pair. The fail_unless and fail macros are used for creating
-   checks within unit tests; the mark_point macro is useful for
-   trapping the location of signals and/or early exits.
+   pair. The mark_point macro is useful for trapping the location 
+   of signals and/or early exits. The following calls are used for
+   creating checks within unit tests, where ... represents arguments
+   given to a printf:
+      Asserting an expression:
+         ck_assert(expr)
+         ck_assert_msg(expr, ...)
+      Aborting a test:
+         ck_abort()
+         ck_abort_msg(...)
+      Check the relationship between two integers:
+         ck_assert_int_eq
+         ck_assert_int_ne
+         ck_assert_int_lt
+         ck_assert_int_le
+         ck_assert_int_gt
+         ck_assert_int_ge
+      Check the relationship between two strings:
+         ck_assert_str_eq
+         ck_assert_str_ne
+         ck_assert_str_lt
+         ck_assert_str_le
+         ck_assert_str_gt
+         ck_assert_str_ge
 
 
    Test cases are created with tcase_create, unit tests are added