[glib/fix-gnulib-msvc-isnan: 4/37] gtestutils: Clarify documentation for g_test_set_nonfatal_assertions()
- From: Chun-wei Fan <fanchunwei src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib/fix-gnulib-msvc-isnan: 4/37] gtestutils: Clarify documentation for g_test_set_nonfatal_assertions()
- Date: Tue, 9 Jun 2020 10:21:29 +0000 (UTC)
commit fb26dcee80c3bbdf7e7fdff8f541ddb20b63bbd8
Author: Philip Withnall <withnall endlessm com>
Date: Thu Oct 31 11:24:31 2019 +0000
gtestutils: Clarify documentation for g_test_set_nonfatal_assertions()
It seems a bit unhelpful to list every single `g_assert_*()` macro, to
rephrase the documentation to use globs instead.
Add a missing word below.
Signed-off-by: Philip Withnall <withnall endlessm com>
glib/gtestutils.c | 10 ++++------
1 file changed, 4 insertions(+), 6 deletions(-)
---
diff --git a/glib/gtestutils.c b/glib/gtestutils.c
index d9e9b5edd..e054cb7b7 100644
--- a/glib/gtestutils.c
+++ b/glib/gtestutils.c
@@ -2327,16 +2327,14 @@ g_test_failed (void)
/**
* g_test_set_nonfatal_assertions:
*
- * Changes the behaviour of g_assert_cmpstr(), g_assert_cmpint(),
- * g_assert_cmpuint(), g_assert_cmphex(), g_assert_cmpfloat(),
- * g_assert_true(), g_assert_false(), g_assert_null(), g_assert_no_error(),
- * g_assert_error(), g_test_assert_expected_messages() and the various
- * g_test_trap_assert_*() macros to not abort to program, but instead
+ * Changes the behaviour of the various `g_assert_*()` macros,
+ * g_test_assert_expected_messages() and the various
+ * `g_test_trap_assert_*()` macros to not abort to program, but instead
* call g_test_fail() and continue. (This also changes the behavior of
* g_test_fail() so that it will not cause the test program to abort
* after completing the failed test.)
*
- * Note that the g_assert_not_reached() and g_assert() are not
+ * Note that the g_assert_not_reached() and g_assert() macros are not
* affected by this.
*
* This function can only be called after g_test_init().
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]