summaryrefslogtreecommitdiff
path: root/gst/gstbufferlist.h
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim.muller@collabora.co.uk>2010-12-07 18:35:04 +0000
committerTim-Philipp Müller <tim.muller@collabora.co.uk>2010-12-07 18:37:04 +0000
commit3256c708be38f8eb2a66662c0c75f43ee2e314d2 (patch)
tree25ae44f03df50c423315fe282e36a27b45c216d2 /gst/gstbufferlist.h
parent0eaa25cbf5c0e4bf86545fb67c181a0ecd2f19c7 (diff)
downloadgstreamer-3256c708be38f8eb2a66662c0c75f43ee2e314d2.tar.gz
docs: gst: more gobject introspection annotations
Many of these are superfluous, added for clarity.
Diffstat (limited to 'gst/gstbufferlist.h')
-rw-r--r--gst/gstbufferlist.h17
1 files changed, 10 insertions, 7 deletions
diff --git a/gst/gstbufferlist.h b/gst/gstbufferlist.h
index f7de45658f..519063f6dd 100644
--- a/gst/gstbufferlist.h
+++ b/gst/gstbufferlist.h
@@ -41,7 +41,7 @@ typedef struct _GstBufferListIterator GstBufferListIterator;
/**
* GstBufferListDoFunction:
- * @buffer: the #GstBuffer
+ * @buffer: (transfer full): the #GstBuffer
* @user_data: user data
*
* A function for accessing the last buffer returned by
@@ -56,8 +56,8 @@ typedef struct _GstBufferListIterator GstBufferListIterator;
* unreffed. If NULL is returned, the buffer will be removed from the list. The
* list must be writable.
*
- * Returns: the buffer to replace @buffer in the list, or NULL to remove @buffer
- * from the list
+ * Returns: (transfer full): the buffer to replace @buffer in the list, or NULL
+ * to remove @buffer from the list
*
* Since: 0.10.24
*/
@@ -125,7 +125,7 @@ GstBufferList *gst_buffer_list_new (void);
* additional references to GstBufferList instances can potentially increase
* the number of memcpy operations in a pipeline.
*
- * Returns: @list
+ * Returns: (transfer full): @list
*
* Since: 0.10.24
*/
@@ -142,7 +142,7 @@ gst_buffer_list_ref (GstBufferList * list)
/**
* gst_buffer_list_unref:
- * @list: a #GstBufferList
+ * @list: (transfer full): a #GstBufferList
*
* Decreases the refcount of the buffer list. If the refcount reaches 0, the
* buffer list will be freed.
@@ -168,7 +168,7 @@ gst_buffer_list_unref (GstBufferList * list)
* allocated copy of the source list with copies of buffer pointers. The
* refcount of buffers pointed to will be increased by one.
*
- * Returns: a new copy of @list.
+ * Returns: (transfer full): a new copy of @list.
*
* Since: 0.10.24
*/
@@ -194,12 +194,15 @@ gst_buffer_list_copy (const GstBufferList * list)
/**
* gst_buffer_list_make_writable:
- * @list: a #GstBufferList
+ * @list: (transfer full): a #GstBufferList
*
* Makes a writable buffer list from the given buffer list. If the source buffer
* list is already writable, this will simply return the same buffer list. A
* copy will otherwise be made using gst_buffer_list_copy().
*
+ * Returns: (transfer full): a writable list, which may or may not be the
+ * same as @list
+ *
* Since: 0.10.24
*/
#define gst_buffer_list_make_writable(list) GST_BUFFER_LIST_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (list)))