gmem: Clarify calling convention behaviour of g_clear_pointer() in docs

Signed-off-by: Philip Withnall <withnall@endlessm.com>

https://gitlab.gnome.org/GNOME/glib/issues/1494
This commit is contained in:
Philip Withnall 2018-08-22 10:28:47 +01:00
parent b2029fa9c7
commit 965bc6d857

View File

@ -210,7 +210,11 @@ g_free (gpointer mem)
* pointer is set to %NULL.
*
* A macro is also included that allows this function to be used without
* pointer casts.
* pointer casts. This will mask any warnings about incompatible function types
* or calling conventions, so you must ensure that your @destroy function is
* compatible with being called as `GDestroyNotify` using the standard calling
* convention for the platform that GLib was compiled for; otherwise the program
* will experience undefined behaviour.
*
* Since: 2.34
**/