summaryrefslogtreecommitdiff
path: root/girepository
diff options
context:
space:
mode:
authorPhilip Withnall <philip.withnall@collabora.co.uk>2013-12-10 15:59:24 +0000
committerColin Walters <walters@verbum.org>2015-09-26 11:37:15 -0400
commitdd4914d7122ef50b7cd1e0e907d85ce3abbf3a80 (patch)
tree4bf086a39af9de8ef8dcd9f02cb06e66ab76db76 /girepository
parent2a7515dc60c6cd3f360e3158b5913f0641ebe5c6 (diff)
downloadgobject-introspection-dd4914d7122ef50b7cd1e0e907d85ce3abbf3a80.tar.gz
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
Diffstat (limited to 'girepository')
-rw-r--r--girepository/gitypeinfo.c5
1 files changed, 5 insertions, 0 deletions
diff --git a/girepository/gitypeinfo.c b/girepository/gitypeinfo.c
index 1bc189cb..8b2e3ec9 100644
--- a/girepository/gitypeinfo.c
+++ b/girepository/gitypeinfo.c
@@ -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 function’s formal parameter is a pointer to a
+ * pointer).
+ *
* Returns: %TRUE if it is a pointer
*/
gboolean