Add doc for GstBin::iterate signal
authorDavid Schleef <ds@schleef.org>
Thu, 16 Oct 2003 02:00:07 +0000 (02:00 +0000)
committerDavid Schleef <ds@schleef.org>
Thu, 16 Oct 2003 02:00:07 +0000 (02:00 +0000)
Original commit message from CVS:
Add doc for GstBin::iterate signal

docs/gst/tmpl/gstbin.sgml
docs/gst/tmpl/gstpad.sgml

index 985b02b..68c62da 100644 (file)
@@ -240,3 +240,15 @@ gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function().
 @gstbin: the object which received the signal.
 @arg1: the element that was removed from the bin
 
+<!-- ##### SIGNAL GstBin::iterate ##### -->
+<para>
+This signal is emitted when a bin iterates, either automatically or
+due to a #gst_bin_iterate() call.  The return value is used to
+determine if the object method handler processed any data.
+In most normal cases, a user-provided signal handler should return
+FALSE.
+</para>
+
+@gstbin: the object which received the signal.
+@Returns: TRUE if the state of the bin was advanced.
+
index a557ac6..49342f1 100644 (file)
@@ -191,6 +191,8 @@ A function that will be called when chaining buffers.
 </para>
 
 @pad: the #GstPad that performed the chain.
+@data: 
+<!-- # Unused Parameters # -->
 @buf: the #GstBuffer that is chained.
 
 
@@ -680,6 +682,8 @@ Flags for the pad.
 </para>
 
 @pad: 
+@data: 
+<!-- # Unused Parameters # -->
 @buf: