luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-09-21 09:46:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

Remove erroneous markup in GError docs

Browse Source
This commit is contained in:
Matthias Clasen 2016-03-02 19:06:49 -05:00
parent 5a894c3232
commit 5efc8686ee
1 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
glib/gerror.c
View File

@ -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