update documentation

Original commit message from CVS:
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* docs/libs/tmpl/gstaudio.sgml:
* docs/libs/tmpl/gstringbuffer.sgml:
* gst-libs/gst/interfaces/xoverlay.c:
* gst-libs/gst/video/gstvideofilter.c:
* gst-libs/gst/video/gstvideosink.c:
update documentation

diff --git a/ChangeLog b/ChangeLog
index e3fde6bd320b59e229045676a373857964378d11..479876765acf98cdc23f2850d73ed7c2f80675f4 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+2005-12-01  Thomas Vander Stichele  <thomas at apestaart dot org>
+
+       * docs/libs/gst-plugins-base-libs-docs.sgml:
+       * docs/libs/gst-plugins-base-libs-sections.txt:
+       * docs/libs/tmpl/gstaudio.sgml:
+       * docs/libs/tmpl/gstringbuffer.sgml:
+       * gst-libs/gst/interfaces/xoverlay.c:
+       * gst-libs/gst/video/gstvideofilter.c:
+       * gst-libs/gst/video/gstvideosink.c:
+         update documentation
+
 2005-12-01  Thomas Vander Stichele  <thomas at apestaart dot org>
 
        * gst/tcp/gstmultifdsink.c: (gst_multi_fd_sink_base_init),

diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml
index 736eb3903a64cb711c20a839d4c687d677766a96..05edf77f2f22a43db0391e6dfe606fb11dfcc78c 100644 (file)
--- a/docs/libs/gst-plugins-base-libs-docs.sgml
+++ b/docs/libs/gst-plugins-base-libs-docs.sgml
@@ -6,8 +6,8 @@
 
 <!ENTITY GstCompiling SYSTEM "compiling.sgml">
 <!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
-<!ENTITY GstVideoSink SYSTEM "xml/element-videosink.xml">
-<!ENTITY GstVideoFilter SYSTEM "xml/element-videofilter.xml">
+<!ENTITY GstVideoSink SYSTEM "xml/gstvideosink.xml">
+<!ENTITY GstVideoFilter SYSTEM "xml/gstvideofilter.xml">
 <!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
 <!ENTITY GstGConf SYSTEM "xml/gstgconf.xml">
 <!ENTITY GstMixer SYSTEM "xml/gstmixer.xml">

diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt
index f6558d9e3e678754a39c01ef28edd660e8061512..e789882ba7aa149d68caddf714f34f7b77f1a14e 100644 (file)
--- a/docs/libs/gst-plugins-base-libs-sections.txt
+++ b/docs/libs/gst-plugins-base-libs-sections.txt
@@ -4,9 +4,7 @@
 GstAudioFieldFlag
 gst_audio_frame_byte_size
 gst_audio_frame_length
-gst_audio_frame_rate
-gst_audio_length
-gst_audio_highest_sample_value
+gst_audio_duration_from_pad_buffer
 gst_audio_is_buffer_framed
 gst_audio_structure_set_int
 </SECTION>
@@ -58,24 +56,24 @@ gst_mixer_options_get_values
 GstRingBuffer
 GstRingBufferClass
 
-gst_ringbuffer_set_callback
+gst_ring_buffer_set_callback
 
-gst_ringbuffer_acquire
-gst_ringbuffer_release
-gst_ringbuffer_is_acquired
+gst_ring_buffer_acquire
+gst_ring_buffer_release
+gst_ring_buffer_is_acquired
 
-gst_ringbuffer_start
-gst_ringbuffer_pause
-gst_ringbuffer_stop
+gst_ring_buffer_start
+gst_ring_buffer_pause
+gst_ring_buffer_stop
 
-gst_ringbuffer_delay
-gst_ringbuffer_samples_done
-gst_ringbuffer_set_sample
-gst_ringbuffer_commit
+gst_ring_buffer_delay
+gst_ring_buffer_samples_done
+gst_ring_buffer_set_sample
+gst_ring_buffer_commit
 
-gst_ringbuffer_prepare_read
-gst_ringbuffer_clear
-gst_ringbuffer_advance
+gst_ring_buffer_prepare_read
+gst_ring_buffer_clear
+gst_ring_buffer_advance
 
 </SECTION>
 
@@ -116,7 +114,7 @@ gst_x_overlay_expose
 </SECTION>
 
 <SECTION>
-<FILE>element-videosink</FILE>
+<FILE>gstvideosink</FILE>
 <INCLUDE>gst/video/gstvideosink.h</INCLUDE>
 GstVideoSink
 GstVideoSinkClass
@@ -125,7 +123,7 @@ gst_video_sink_center_rect
 </SECTION>
 
 <SECTION>
-<FILE>element-videofilter</FILE>
+<FILE>gstvideofilter</FILE>
 <INCLUDE>gst/video/gstvideofilter.h</INCLUDE>
 GstVideoFilter
 GstVideoFilterClass

diff --git a/docs/libs/tmpl/gstaudio.sgml b/docs/libs/tmpl/gstaudio.sgml
index 326af51d0665bd425187ca86e0abd0b27cab876c..6663a454c87b337a8039874bcdb488f702c9d855 100644 (file)
--- a/docs/libs/tmpl/gstaudio.sgml
+++ b/docs/libs/tmpl/gstaudio.sgml
@@ -48,6 +48,16 @@ a support library for audio elements
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_audio_duration_from_pad_buffer ##### -->
+<para>
+
+</para>
+
+@pad: 
+@buf: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_audio_is_buffer_framed ##### -->
 <para>
 

diff --git a/docs/libs/tmpl/gstringbuffer.sgml b/docs/libs/tmpl/gstringbuffer.sgml
index 5a86bdff38a9939572342816df9d30900f15a4a9..4ff5c4b15b0281c1868b556733862971c8705566 100644 (file)
--- a/docs/libs/tmpl/gstringbuffer.sgml
+++ b/docs/libs/tmpl/gstringbuffer.sgml
@@ -51,3 +51,137 @@ an implementation of an audio ringbuffer
 @stop: 
 @delay: 
 
+<!-- ##### FUNCTION gst_ring_buffer_set_callback ##### -->
+<para>
+
+</para>
+
+@buf: 
+@cb: 
+@user_data: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_acquire ##### -->
+<para>
+
+</para>
+
+@buf: 
+@spec: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_release ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_is_acquired ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_start ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_pause ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_stop ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_delay ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_samples_done ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_set_sample ##### -->
+<para>
+
+</para>
+
+@buf: 
+@sample: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_commit ##### -->
+<para>
+
+</para>
+
+@buf: 
+@sample: 
+@data: 
+@len: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_prepare_read ##### -->
+<para>
+
+</para>
+
+@buf: 
+@segment: 
+@readptr: 
+@len: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_clear ##### -->
+<para>
+
+</para>
+
+@buf: 
+@segment: 
+
+
+<!-- ##### FUNCTION gst_ring_buffer_advance ##### -->
+<para>
+
+</para>
+
+@buf: 
+@advance: 
+
+

diff --git a/gst-libs/gst/interfaces/xoverlay.c b/gst-libs/gst/interfaces/xoverlay.c
index 4f4f17fc271e025b8e0b5bb4c723a88767a8bfcb..f31e2ebb05baaab57afd24b0068a3c3e7f2d4d9b 100644 (file)
--- a/gst-libs/gst/interfaces/xoverlay.c
+++ b/gst-libs/gst/interfaces/xoverlay.c
@@ -22,7 +22,7 @@
 /**
  * SECTION:gstxoverlay
  * @short_description: Interface for setting/getting a Window on elements
- * supporting it.
+ * supporting it
  *
  * <refsect2>
  * <para>

diff --git a/gst-libs/gst/video/gstvideofilter.c b/gst-libs/gst/video/gstvideofilter.c
index 6899b5363cbf4cdd7b663f647928297ae122e670..c1bb15d240394afde70cfe87ee1e6f4a7551922c 100644 (file)
--- a/gst-libs/gst/video/gstvideofilter.c
+++ b/gst-libs/gst/video/gstvideofilter.c
@@ -19,12 +19,12 @@
  */
 
  /**
- * SECTION:element-videofilter
- * @short_description: Base class for video filters.
+ * SECTION:gstvideofilter
+ * @short_description: Base class for video filters
  * 
  * <refsect2>
  * <para>
- * Provides useful functions and a base class for video filters. Right now it's 
+ * Provides useful functions and a base class for video filters. Right now it's
  * mostly used as a place holder for adding common code later on.
  * </para>
  * </refsect2>

diff --git a/gst-libs/gst/video/gstvideosink.c b/gst-libs/gst/video/gstvideosink.c
index 39075c1d23fbb56d86af3f8776906cc49edb0840..ba3d1e8f4f3919b3afd0c58930b10df3835f7f51 100644 (file)
--- a/gst-libs/gst/video/gstvideosink.c
+++ b/gst-libs/gst/video/gstvideosink.c
@@ -20,12 +20,12 @@
  */
 
 /**
- * SECTION:element-videosink
- * @short_description: Base class for video sinks.
+ * SECTION:gstvideosink
+ * @short_description: Base class for video sinks
  * 
  * <refsect2>
  * <para>
- * Provides useful functions and a base class for video sinks. Right now it's 
+ * Provides useful functions and a base class for video sinks. Right now it's
  * mostly used as a place holder for adding common code later on.
  * </para>
  * </refsect2>