Update rcbox annotations for acquire/release functions822b511cb660feca4bb73598dd49d418d42f97c592/head
commit822b511cb660feca4bb73598dd49d418d42f97c5
authorEmmanuele Bassi <ebassi@gnome.org>
Mon, 9 Jul 2018 09:07:07 +0000 (9 10:07 +0100)
committerEmmanuele Bassi <ebassi@gnome.org>
Mon, 9 Jul 2018 09:11:42 +0000 (9 10:11 +0100)
tree5bfd0a3a2f2cefd5c416843db26f9e48fa224fa3
parent0d00667d01169b766dd0fd2fa6c06631bc88e340
Update rcbox annotations for acquire/release functions

The accepted behaviour for reference counting functions can be described
as such:

 - acquire: takes a pointer to a memory area and returns the same
   pointer with its reference count increased; this means that the
   returned value's ownership is fully transfered from the callee
   to the caller
 - release: takes a pointer to a memory area and drops the reference
   count; this means that the caller transfers the ownership of the
   argument to the callee

These annotations are mostly meant for documentation purposes: high
level language bindings are unlikely to use them, as they have their own
reference counting semantics on top of GLib's own, and they should not
expose this API to their own consumers.
glib/garcbox.c
glib/grcbox.c