From dc0f45d20cbefad8e07cb5fc77f59c9ae49ceeb2 Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Thu, 1 Dec 2005 01:29:46 +0000 Subject: [PATCH] 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 --- ChangeLog | 11 ++ docs/libs/gst-plugins-base-libs-docs.sgml | 4 +- docs/libs/gst-plugins-base-libs-sections.txt | 36 +++-- docs/libs/tmpl/gstaudio.sgml | 10 ++ docs/libs/tmpl/gstringbuffer.sgml | 134 +++++++++++++++++++ gst-libs/gst/interfaces/xoverlay.c | 2 +- gst-libs/gst/video/gstvideofilter.c | 6 +- gst-libs/gst/video/gstvideosink.c | 6 +- 8 files changed, 181 insertions(+), 28 deletions(-) diff --git a/ChangeLog b/ChangeLog index e3fde6bd32..479876765a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,14 @@ +2005-12-01 Thomas Vander Stichele + + * 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 * 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 736eb3903a..05edf77f2f 100644 --- a/docs/libs/gst-plugins-base-libs-docs.sgml +++ b/docs/libs/gst-plugins-base-libs-docs.sgml @@ -6,8 +6,8 @@ - - + + diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt index f6558d9e3e..e789882ba7 100644 --- 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 @@ -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 @@ -116,7 +114,7 @@ gst_x_overlay_expose
-element-videosink +gstvideosink gst/video/gstvideosink.h GstVideoSink GstVideoSinkClass @@ -125,7 +123,7 @@ gst_video_sink_center_rect
-element-videofilter +gstvideofilter gst/video/gstvideofilter.h GstVideoFilter GstVideoFilterClass diff --git a/docs/libs/tmpl/gstaudio.sgml b/docs/libs/tmpl/gstaudio.sgml index 326af51d06..6663a454c8 100644 --- a/docs/libs/tmpl/gstaudio.sgml +++ b/docs/libs/tmpl/gstaudio.sgml @@ -48,6 +48,16 @@ a support library for audio elements @Returns: + + + + + +@pad: +@buf: +@Returns: + + diff --git a/docs/libs/tmpl/gstringbuffer.sgml b/docs/libs/tmpl/gstringbuffer.sgml index 5a86bdff38..4ff5c4b15b 100644 --- a/docs/libs/tmpl/gstringbuffer.sgml +++ b/docs/libs/tmpl/gstringbuffer.sgml @@ -51,3 +51,137 @@ an implementation of an audio ringbuffer @stop: @delay: + + + + + +@buf: +@cb: +@user_data: + + + + + + + +@buf: +@spec: +@Returns: + + + + + + + +@buf: +@Returns: + + + + + + + +@buf: +@Returns: + + + + + + + +@buf: +@Returns: + + + + + + + +@buf: +@Returns: + + + + + + + +@buf: +@Returns: + + + + + + + +@buf: +@Returns: + + + + + + + +@buf: +@Returns: + + + + + + + +@buf: +@sample: + + + + + + + +@buf: +@sample: +@data: +@len: +@Returns: + + + + + + + +@buf: +@segment: +@readptr: +@len: +@Returns: + + + + + + + +@buf: +@segment: + + + + + + + +@buf: +@advance: + + diff --git a/gst-libs/gst/interfaces/xoverlay.c b/gst-libs/gst/interfaces/xoverlay.c index 4f4f17fc27..f31e2ebb05 100644 --- 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 * * * diff --git a/gst-libs/gst/video/gstvideofilter.c b/gst-libs/gst/video/gstvideofilter.c index 6899b5363c..c1bb15d240 100644 --- 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 * * * - * 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. * * diff --git a/gst-libs/gst/video/gstvideosink.c b/gst-libs/gst/video/gstvideosink.c index 39075c1d23..ba3d1e8f4f 100644 --- 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 * * * - * 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. * *