Small documentation updates

Original commit message from CVS:
Small documentation updates

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index e8c5a82..200f071 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -218,6 +218,7 @@ gst_bin_destroy
 gst_bin_add
 gst_bin_add_many
 gst_bin_remove
+gst_bin_remove_many
 gst_bin_get_by_name
 gst_bin_get_by_name_recurse_up
 gst_bin_get_list

diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml
index b6eda53..96f7b17 100644 (file)
--- a/docs/gst/tmpl/gstbin.sgml
+++ b/docs/gst/tmpl/gstbin.sgml
@@ -127,6 +127,16 @@ Free the memory allocated by this bin
 @element: 
 
 
+<!-- ##### FUNCTION gst_bin_remove_many ##### -->
+<para>
+
+</para>
+
+@bin: 
+@element_1: 
+@Varargs: 
+
+
 <!-- ##### FUNCTION gst_bin_get_by_name ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml
index edcd883..421c763 100644 (file)
--- a/docs/gst/tmpl/gstevent.sgml
+++ b/docs/gst/tmpl/gstevent.sgml
@@ -24,7 +24,7 @@ gst_event_new_flush() creates a new flush event.
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
-#GstPad
+#GstPad, #GstElement
 </para>
 
 <!-- ##### ENUM GstEventType ##### -->
@@ -46,7 +46,8 @@ The different major types of events.
 @GST_EVENT_RATE: adjust the output rate of an element
 @GST_EVENT_FILLER: a dummy event that should be ignored by plugins
 @GST_EVENT_TS_OFFSET: an event to set the time offset on buffers
-@GST_EVENT_INTERRUPT: 
+@GST_EVENT_INTERRUPT: mainly used by _get based elements when they were interrupted
+                      while waiting for a buffer.
 
 <!-- ##### MACRO GST_EVENT_TYPE ##### -->
 <para>
@@ -82,7 +83,30 @@ Event flags are used when querying for supported events
 
 <!-- ##### ENUM GstSeekType ##### -->
 <para>
-The different types of seek events.
+The different types of seek events. When constructing a seek event a format,
+a seek method and optional flags are OR-ed together. The seek event is then
+inserted into the graph with #gst_pad_send_event() or #gst_element_send_event().
+
+ <informalexample>
+  Following example illustrates how to insert a seek event (1 second in the stream)
+  in a pipeline.
+ 
+  <programlisting>
+  gboolean res;
+  GstEvent *event;
+
+  event = gst_event_new_seek (
+            GST_FORMAT_TIME |          /* seek on time */
+           GST_SEEK_METHOD_SET |       /* set the absolute position */
+           GST_SEEK_FLAG_FLUSH,        /* flush any pending data */
+           1 * GST_SECOND);            /* the seek offset (1 second) */
+
+  res = gst_element_send_event (GST_ELEMENT (osssink), event);
+  if (!res) {
+    g_warning ("seek failed");
+  }
+  </programlisting>
+ </informalexample>
 </para>
 
 @GST_SEEK_METHOD_CUR: Seek to an relative position

diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml
index 32d00bc..73bfbd5 100644 (file)
--- a/docs/gst/tmpl/gstxml.sgml
+++ b/docs/gst/tmpl/gstxml.sgml
@@ -110,6 +110,10 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
 
 </para>
 
+@: 
+@: 
+@:
+
 @gstxml: the object which received the signal.
 @arg1: 
 @arg2: