gitypeinfo: Expand documentation for g_type_info_is_pointer()

Note that (direction [in]out) parameters are only pointers if the
underlying type being transferred is a pointer, i.e. if the formal
parameter is a pointer to a pointer or deeper.

https://bugzilla.gnome.org/show_bug.cgi?id=720201
This commit is contained in:
Philip Withnall 2013-12-10 15:59:24 +00:00 committed by Colin Walters
parent 02c64c25d2
commit ba2c4624da

View File

@ -58,6 +58,11 @@
*
* Obtain if the type is passed as a reference.
*
* Note that the types of %GI_DIRECTION_OUT and %GI_DIRECTION_INOUT parameters
* will only be pointers if the underlying type being transferred is a pointer
* (i.e. only if the type of the C functions formal parameter is a pointer to a
* pointer).
*
* Returns: %TRUE if it is a pointer
*/
gboolean