GBytes: Add missing annotations
authorMartin Pitt <martinpitt@gnome.org>
Fri, 9 Nov 2012 08:02:22 +0000 (09:02 +0100)
committerMartin Pitt <martinpitt@gnome.org>
Fri, 9 Nov 2012 08:09:39 +0000 (09:09 +0100)
Annotate g_bytes_new*()'s data argument to be a guint8 array, as
introspection clients cannot deal with raw gconstpointers. This makes
GBytes' behaviour similar to GByteArray whose API already uses guint8.

Add missing transfer annotation to g_bytes_get_data() to make it
introspectable.

This is covered by test cases in PyGObject.

glib/gbytes.c

index 93f74ddf21dfd4074d597e3a00bfa67f74b4b5a4..4d1f6c69a795329c45516c7e081fac9bff94bfed 100644 (file)
@@ -77,7 +77,8 @@ struct _GBytes
 
 /**
  * g_bytes_new:
- * @data: (array length=size): the data to be used for the bytes
+ * @data: (transfer none) (array length=size) (element-type guint8):
+ *        the data to be used for the bytes
  * @size: the size of @data
  *
  * Creates a new #GBytes from @data.
@@ -97,7 +98,8 @@ g_bytes_new (gconstpointer data,
 
 /**
  * g_bytes_new_take:
- * @data: (transfer full) (array length=size): the data to be used for the bytes
+ * @data: (transfer full) (array length=size) (element-type guint8):
+          the data to be used for the bytes
  * @size: the size of @data
  *
  * Creates a new #GBytes from @data.
@@ -124,8 +126,9 @@ g_bytes_new_take (gpointer data,
 
 
 /**
- * g_bytes_new_static:
- * @data: (array length=size): the data to be used for the bytes
+ * g_bytes_new_static: (skip)
+ * @data: (transfer full) (array length=size) (element-type guint8):
+          the data to be used for the bytes
  * @size: the size of @data
  *
  * Creates a new #GBytes from static data.
@@ -218,7 +221,8 @@ g_bytes_new_from_bytes (GBytes  *bytes,
  *
  * This function will always return the same pointer for a given #GBytes.
  *
- * Returns: (array length=size) (type guint8): a pointer to the byte data
+ * Returns: (transfer none) (array length=size) (type guint8): a pointer to the
+ *          byte data
  *
  * Since: 2.32
  */