From 5efc8686ee5a12ea21d1562fddb83418d0c734b9 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 2 Mar 2016 19:06:49 -0500 Subject: [PATCH] Remove erroneous markup in GError docs --- glib/gerror.c | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/glib/gerror.c b/glib/gerror.c index 4d5c60bce..7c72d2bc1 100644 --- a/glib/gerror.c +++ b/glib/gerror.c @@ -341,22 +341,19 @@ * g_set_error() will complain if you pile up errors. * * - By convention, if you return a boolean value indicating success - * then %TRUE means success and %FALSE means failure. - * Avoid creating functions which have a boolean - * return value and a GError parameter, but where the boolean does - * something other than signal whether the GError is set. Among other - * problems, it requires C callers to allocate a temporary error. Instead, - * provide a "gboolean *" out parameter. There are functions in GLib - * itself such as g_key_file_has_key() that are deprecated because of this. - * - * If %FALSE is - * returned, the error must be set to a non-%NULL value. - * One exception to this is that in situations that are - * already considered to be undefined behaviour (such as when a + * then %TRUE means success and %FALSE means failure. Avoid creating + * functions which have a boolean return value and a GError parameter, + * but where the boolean does something other than signal whether the + * GError is set. Among other problems, it requires C callers to allocate + * a temporary error. Instead, provide a "gboolean *" out parameter. + * There are functions in GLib itself such as g_key_file_has_key() that + * are deprecated because of this. If %FALSE is returned, the error must + * be set to a non-%NULL value. One exception to this is that in situations + * that are already considered to be undefined behaviour (such as when a * g_return_val_if_fail() check fails), the error need not be set. * Instead of checking separately whether the error is set, callers * should ensure that they do not provoke undefined behaviour, then - * assume that the error will be set on failure. + * assume that the error will be set on failure. * * - A %NULL return value is also frequently used to mean that an error * occurred. You should make clear in your documentation whether %NULL