[glib] Remove erroneous markup in GError docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Remove erroneous markup in GError docs
- Date: Thu, 3 Mar 2016 00:07:14 +0000 (UTC)
commit 5efc8686ee5a12ea21d1562fddb83418d0c734b9
Author: Matthias Clasen <mclasen redhat com>
Date: Wed Mar 2 19:06:49 2016 -0500
Remove erroneous markup in GError docs
glib/gerror.c | 23 ++++++++++-------------
1 files changed, 10 insertions(+), 13 deletions(-)
---
diff --git a/glib/gerror.c b/glib/gerror.c
index 4d5c60b..7c72d2b 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.
- * <footnote><para>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.
- * </para></footnote>
- * If %FALSE is
- * returned, the error must be set to a non-%NULL value.
- * <footnote><para>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.</para></footnote>
+ * 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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]