summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWim Taymans <wim.taymans@collabora.co.uk>2009-08-31 20:38:07 +0200
committerWim Taymans <wim@metal.(none)>2009-08-31 20:38:07 +0200
commitf90a9a809220cb5c1702532fc62d2eb65650cee5 (patch)
treeee215da06cd27de04094f8522f6f57408e27fc8f
parent5dc534c642f845fa1ec52d4718276e6dc20a037d (diff)
iterator: fix docs for _new_single().
-rw-r--r--gst/gstiterator.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/gst/gstiterator.c b/gst/gstiterator.c
index bbef18586b..bdf5d5ec4f 100644
--- a/gst/gstiterator.c
+++ b/gst/gstiterator.c
@@ -695,25 +695,26 @@ gst_single_object_iterator_free (GstSingleObjectIterator * it)
if (it->object)
it->free (it->object);
g_free (it);
}
/**
- * gst_iterator_new:
+ * gst_iterator_new_single:
* @type: #GType of the passed object
* @object: object that this iterator should return
* @copy: Function that returns a copy of @object or increases its refcount
* @free: Function to be called for freeing @object
*
* This #GstIterator is a convenient iterator for the common
* case where a #GstIterator needs to be returned but only
* a single object has the be considered. This happens often
* for the #GstPadIterIntLinkFunction.
*
- * Since: 0.10.25
+ * Returns: the new #GstIterator for @object.
*
+ * Since: 0.10.25
*/
GstIterator *
gst_iterator_new_single (GType type, gpointer object, GstCopyFunction copy,
GFreeFunc free)
{
GstSingleObjectIterator *result;