gst: More introspection annotations
authorEdward Hervey <edward.hervey@collabora.co.uk>
Thu, 10 Nov 2011 12:53:33 +0000 (13:53 +0100)
committerEdward Hervey <edward.hervey@collabora.co.uk>
Thu, 10 Nov 2011 12:54:03 +0000 (13:54 +0100)
gst/gstbuffer.c
gst/gstbufferpool.c
gst/gstmemory.c

index 2236a7d..0400c48 100644 (file)
@@ -888,8 +888,8 @@ gst_buffer_resize (GstBuffer * buffer, gssize offset, gsize size)
 /**
  * gst_buffer_map:
  * @buffer: a #GstBuffer.
- * @size: a location for the size
- * @maxsize: a location for the max size
+ * @size: (out) (allow-none): a location for the size
+ * @maxsize: (out) (allow-none): a location for the max size
  * @flags: flags for the mapping
  *
  * This function return a pointer to the memory in @buffer. @flags describe the
@@ -907,7 +907,7 @@ gst_buffer_resize (GstBuffer * buffer, gssize offset, gsize size)
  * When the buffer contains multiple memory blocks, the returned pointer will be
  * a concatenation of the memory blocks.
  *
- * Returns: a pointer to the memory for the buffer.
+ * Returns: (transfer none): a pointer to the memory for the buffer.
  */
 gpointer
 gst_buffer_map (GstBuffer * buffer, gsize * size, gsize * maxsize,
@@ -1497,7 +1497,7 @@ gst_buffer_get_meta (GstBuffer * buffer, const GstMetaInfo * info)
  *
  * Add metadata for @info to @buffer using the parameters in @params.
  *
- * Returns: the metadata for the api in @info on @buffer.
+ * Returns: (transfer none): the metadata for the api in @info on @buffer.
  */
 GstMeta *
 gst_buffer_add_meta (GstBuffer * buffer, const GstMetaInfo * info,
index f4237e8..66b6e05 100644 (file)
@@ -147,7 +147,7 @@ gst_buffer_pool_finalize (GObject * object)
  *
  * Creates a new #GstBufferPool instance.
  *
- * Returns: a new #GstBufferPool instance
+ * Returns: (transfer full): a new #GstBufferPool instance
  */
 GstBufferPool *
 gst_buffer_pool_new (void)
@@ -430,7 +430,7 @@ wrong_config:
 /**
  * gst_buffer_pool_set_config:
  * @pool: a #GstBufferPool
- * @config: a #GstStructure
+ * @config: (transfer full): a #GstStructure
  *
  * Set the configuration of the pool. The pool must be inactive and all buffers
  * allocated form this pool must be returned or else this function will do
@@ -503,7 +503,7 @@ have_outstanding:
  * can either be modified and used for the gst_buffer_pool_set_config() call
  * or it must be freed after usage.
  *
- * Returns: a copy of the current configuration of @pool. use
+ * Returns: (transfer full): a copy of the current configuration of @pool. use
  * gst_structure_free() after usage or gst_buffer_pool_set_config().
  */
 GstStructure *
@@ -748,13 +748,13 @@ gst_buffer_pool_config_has_option (GstStructure * config, const gchar * option)
 
 /**
  * gst_buffer_pool_config_get:
- * @config: a #GstBufferPool configuration
- * @caps: the caps of buffers
- * @size: the size of each buffer, not including prefix
- * @min_buffers: the minimum amount of buffers to allocate.
- * @max_buffers: the maximum amount of buffers to allocate or 0 for unlimited.
- * @prefix: prefix each buffer with this many bytes
- * @align: alignment of the buffer data.
+ * @config: (transfer none): a #GstBufferPool configuration
+ * @caps: (out): the caps of buffers
+ * @size: (out): the size of each buffer, not including prefix
+ * @min_buffers: (out): the minimum amount of buffers to allocate.
+ * @max_buffers: (out): the maximum amount of buffers to allocate or 0 for unlimited.
+ * @prefix: (out): prefix each buffer with this many bytes
+ * @align: (out): alignment of the buffer data.
  *
  * Get the configuration values from @config.
  */
@@ -864,8 +864,8 @@ default_reset_buffer (GstBufferPool * pool, GstBuffer * buffer,
 /**
  * gst_buffer_pool_acquire_buffer:
  * @pool: a #GstBufferPool
- * @buffer: a location for a #GstBuffer
- * @params: parameters.
+ * @buffer: (out): a location for a #GstBuffer
+ * @params: (transfer none) (allow-none) parameters.
  *
  * Acquire a buffer from @pool. @buffer should point to a memory location that
  * can hold a pointer to the new buffer.
@@ -922,7 +922,7 @@ default_release_buffer (GstBufferPool * pool, GstBuffer * buffer)
 /**
  * gst_buffer_pool_release_buffer:
  * @pool: a #GstBufferPool
- * @buffer: a #GstBuffer
+ * @buffer: (transfer none): a #GstBuffer
  *
  * Release @buffer to @pool. @buffer should have previously been allocated from
  * @pool with gst_buffer_pool_acquire_buffer().
index 7ea2380..e709396 100644 (file)
@@ -439,8 +439,8 @@ gst_memory_resize (GstMemory * mem, gssize offset, gsize size)
 /**
  * gst_memory_map:
  * @mem: a #GstMemory
- * @size: pointer for size
- * @maxsize: pointer for maxsize
+ * @size: (out) (allow-none): pointer for size
+ * @maxsize: (out) (allow-none): pointer for maxsize
  * @flags: mapping flags
  *
  * Get a pointer to the memory of @mem that can be accessed according to @flags.
@@ -448,7 +448,7 @@ gst_memory_resize (GstMemory * mem, gssize offset, gsize size)
  * @size and @maxsize will contain the size of the memory and the maximum
  * allocated memory of @mem respectively. They can be set to NULL.
  *
- * Returns: a pointer to the memory of @mem.
+ * Returns: (transfer none): a pointer to the memory of @mem.
  */
 gpointer
 gst_memory_map (GstMemory * mem, gsize * size, gsize * maxsize,
@@ -652,7 +652,7 @@ gst_allocator_set_default (const GstAllocator * allocator)
 
 /**
  * gst_allocator_alloc:
- * @allocator: a #GstAllocator to use
+ * @allocator: (transfer none) (allow-none): a #GstAllocator to use
  * @maxsize: allocated size of @data
  * @align: alignment for the data
  *
@@ -664,7 +664,7 @@ gst_allocator_set_default (const GstAllocator * allocator)
  * @align is given as a bitmask so that @align + 1 equals the amount of bytes to
  * align to. For example, to align to 8 bytes, use an alignment of 7.
  *
- * Returns: a new #GstMemory.
+ * Returns: (transfer full): a new #GstMemory.
  */
 GstMemory *
 gst_allocator_alloc (const GstAllocator * allocator, gsize maxsize, gsize align)