From 51ca8fe3e1f9c349596cdbc6b5c33c2cf07dcff2 Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Wed, 7 Jun 2006 11:03:03 +0000 Subject: [PATCH] move last template doc snippets to source code and delete them Original commit message from CVS: * docs/libs/tmpl/gstaudio.sgml: * docs/libs/tmpl/gstcolorbalance.sgml: * docs/libs/tmpl/gstmixer.sgml: * docs/libs/tmpl/gstringbuffer.sgml: * docs/libs/tmpl/gsttuner.sgml: * docs/libs/tmpl/gstxoverlay.sgml: * gst-libs/gst/audio/audio.c: * gst-libs/gst/audio/gstringbuffer.c: * gst-libs/gst/interfaces/colorbalance.c: * gst-libs/gst/interfaces/mixer.c: * gst-libs/gst/interfaces/tuner.c: * gst-libs/gst/interfaces/xoverlay.c: move last template doc snippets to source code and delete them --- ChangeLog | 16 +++ docs/libs/tmpl/gstaudio.sgml | 79 ------------- docs/libs/tmpl/gstcolorbalance.sgml | 86 -------------- docs/libs/tmpl/gstmixer.sgml | 164 -------------------------- docs/libs/tmpl/gstringbuffer.sgml | 208 --------------------------------- docs/libs/tmpl/gsttuner.sgml | 178 ---------------------------- docs/libs/tmpl/gstxoverlay.sgml | 68 ----------- gst-libs/gst/audio/audio.c | 5 + gst-libs/gst/audio/gstringbuffer.c | 7 +- gst-libs/gst/interfaces/colorbalance.c | 5 + gst-libs/gst/interfaces/mixer.c | 5 + gst-libs/gst/interfaces/tuner.c | 5 + gst-libs/gst/interfaces/xoverlay.c | 8 +- 13 files changed, 43 insertions(+), 791 deletions(-) delete mode 100644 docs/libs/tmpl/gstaudio.sgml delete mode 100644 docs/libs/tmpl/gstcolorbalance.sgml delete mode 100644 docs/libs/tmpl/gstmixer.sgml delete mode 100644 docs/libs/tmpl/gstringbuffer.sgml delete mode 100644 docs/libs/tmpl/gsttuner.sgml delete mode 100644 docs/libs/tmpl/gstxoverlay.sgml diff --git a/ChangeLog b/ChangeLog index 5ad529e..15b5871 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,19 @@ +2006-06-07 Thomas Vander Stichele + + * docs/libs/tmpl/gstaudio.sgml: + * docs/libs/tmpl/gstcolorbalance.sgml: + * docs/libs/tmpl/gstmixer.sgml: + * docs/libs/tmpl/gstringbuffer.sgml: + * docs/libs/tmpl/gsttuner.sgml: + * docs/libs/tmpl/gstxoverlay.sgml: + * gst-libs/gst/audio/audio.c: + * gst-libs/gst/audio/gstringbuffer.c: + * gst-libs/gst/interfaces/colorbalance.c: + * gst-libs/gst/interfaces/mixer.c: + * gst-libs/gst/interfaces/tuner.c: + * gst-libs/gst/interfaces/xoverlay.c: + move last template doc snippets to source code and delete them + 2006-06-06 Michael Smith * ext/theora/theoraparse.c: (theora_parse_drain_queue_prematurely), diff --git a/docs/libs/tmpl/gstaudio.sgml b/docs/libs/tmpl/gstaudio.sgml deleted file mode 100644 index 6663a45..0000000 --- a/docs/libs/tmpl/gstaudio.sgml +++ /dev/null @@ -1,79 +0,0 @@ - -gstaudio - - -a support library for audio elements - - - - - - - - - - - - - - - - - - - -@GST_AUDIO_FIELD_RATE: -@GST_AUDIO_FIELD_CHANNELS: -@GST_AUDIO_FIELD_ENDIANNESS: -@GST_AUDIO_FIELD_WIDTH: -@GST_AUDIO_FIELD_DEPTH: -@GST_AUDIO_FIELD_SIGNED: - - - - - - -@pad: -@Returns: - - - - - - - -@pad: -@buf: -@Returns: - - - - - - - -@pad: -@buf: -@Returns: - - - - - - - -@pad: -@buf: -@Returns: - - - - - - - -@structure: -@flag: - - diff --git a/docs/libs/tmpl/gstcolorbalance.sgml b/docs/libs/tmpl/gstcolorbalance.sgml deleted file mode 100644 index ccb0ae2..0000000 --- a/docs/libs/tmpl/gstcolorbalance.sgml +++ /dev/null @@ -1,86 +0,0 @@ - -gstcolorbalance - - -interface for adjusting color balance settings - - - - - - - - - - - - - - - - - - - - - - - - - -@gstcolorbalance: the object which received the signal. -@arg1: -@arg2: - - - - - - -@klass: -@balance_type: -@list_channels: -@set_value: -@get_value: -@value_changed: -@_gst_reserved: - - - - - - -@balance: -@Returns: - - - - - - - -@balance: -@channel: -@Returns: - - - - - - - -@balance: -@channel: -@value: - - - - - - - -@balance: -@channel: -@value: - - diff --git a/docs/libs/tmpl/gstmixer.sgml b/docs/libs/tmpl/gstmixer.sgml deleted file mode 100644 index 20afe10..0000000 --- a/docs/libs/tmpl/gstmixer.sgml +++ /dev/null @@ -1,164 +0,0 @@ - -gstmixer - - -interface for elements that provide mixer operations - - - - - - - - - - - - - - - - - - - - - - - - - -@klass: -@mixer_type: -@list_tracks: -@set_volume: -@get_volume: -@set_mute: -@set_record: -@mute_toggled: -@record_toggled: -@volume_changed: -@set_option: -@get_option: -@option_changed: - - - - - - - - - - - - - - - - - - -@mixer: -@Returns: - - - - - - - -@mixer: -@track: -@volumes: - - - - - - - -@mixer: -@track: -@volumes: - - - - - - - -@mixer: -@track: -@mute: - - - - - - - -@mixer: -@track: -@record: - - - - - - - -@mixer: -@opts: -@value: - - - - - - - -@mixer: -@track: -@mute: - - - - - - - -@mixer: -@track: -@record: - - - - - - - -@mixer: -@track: -@volumes: - - - - - - - -@mixer: -@opts: -@value: - - - - - - - -@mixer_options: -@Returns: - - diff --git a/docs/libs/tmpl/gstringbuffer.sgml b/docs/libs/tmpl/gstringbuffer.sgml deleted file mode 100644 index 52ea53c..0000000 --- a/docs/libs/tmpl/gstringbuffer.sgml +++ /dev/null @@ -1,208 +0,0 @@ - -gstringbuffer - - -an implementation of an audio ringbuffer - - - - - - - - - - - - - - - - - - - -@cond: -@open: -@acquired: -@data: -@spec: -@segstate: -@samples_per_seg: -@empty_seg: -@state: -@segdone: -@segbase: -@waiting: - - - - - - -@caps: -@type: -@format: -@sign: -@bigend: -@width: -@depth: -@rate: -@channels: -@latency_time: -@buffer_time: -@segsize: -@segtotal: -@bytes_per_sample: -@silence_sample: - - - - - - -@parent_class: -@open_device: -@acquire: -@release: -@close_device: -@start: -@pause: -@resume: -@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/docs/libs/tmpl/gsttuner.sgml b/docs/libs/tmpl/gsttuner.sgml deleted file mode 100644 index f01a16e..0000000 --- a/docs/libs/tmpl/gsttuner.sgml +++ /dev/null @@ -1,178 +0,0 @@ - -gsttuner - - -interface for elements that provide tuner operations - - - - - - - - - - - - - - - - - - - - - - - - - -@klass: -@list_channels: -@set_channel: -@get_channel: -@list_norms: -@set_norm: -@get_norm: -@set_frequency: -@get_frequency: -@signal_strength: -@channel_changed: -@norm_changed: -@frequency_changed: -@signal_changed: -@_gst_reserved: - - - - - - -@tuner: -@Returns: - - - - - - - -@tuner: -@Returns: - - - - - - - -@tuner: -@channel: - - - - - - - -@tuner: -@Returns: - - - - - - - -@tuner: -@Returns: - - - - - - - -@tuner: -@norm: - - - - - - - -@tuner: -@channel: -@frequency: - - - - - - - -@tuner: -@channel: -@Returns: - - - - - - - -@tuner: -@norm: -@Returns: - - - - - - - -@tuner: -@channel: -@Returns: - - - - - - - -@tuner: -@channel: - - - - - - - -@tuner: -@norm: - - - - - - - -@tuner: -@channel: -@frequency: - - - - - - - -@tuner: -@channel: -@signal: - - diff --git a/docs/libs/tmpl/gstxoverlay.sgml b/docs/libs/tmpl/gstxoverlay.sgml deleted file mode 100644 index af901f8..0000000 --- a/docs/libs/tmpl/gstxoverlay.sgml +++ /dev/null @@ -1,68 +0,0 @@ - -gstxoverlay - - -interface for setting/getting a Window on elements supporting it. - - - - - - - - - - - - - - - - - - - - - - - - - -@klass: -@set_xwindow_id: -@expose: - - - - - - -@overlay: -@xwindow_id: - - - - - - - -@overlay: -@xwindow_id: - - - - - - - -@overlay: - - - - - - - -@overlay: - - diff --git a/gst-libs/gst/audio/audio.c b/gst-libs/gst/audio/audio.c index b42ca76..c3b6c07 100644 --- a/gst-libs/gst/audio/audio.c +++ b/gst-libs/gst/audio/audio.c @@ -26,6 +26,11 @@ #include +/** + * SECTION:gstaudio + * @short_description: Support library for audio elements + */ + int gst_audio_frame_byte_size (GstPad * pad) { diff --git a/gst-libs/gst/audio/gstringbuffer.c b/gst-libs/gst/audio/gstringbuffer.c index 99ee587..b8468de 100644 --- a/gst-libs/gst/audio/gstringbuffer.c +++ b/gst-libs/gst/audio/gstringbuffer.c @@ -1,8 +1,6 @@ /* GStreamer * Copyright (C) 2005 Wim Taymans * - * gstringbuffer.c: - * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License as published by the Free Software Foundation; either @@ -18,6 +16,7 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ + /** * SECTION:gstringbuffer * @short_description: Base class for audio ringbuffer implementations @@ -30,9 +29,9 @@ * * * The ringbuffer abstracts a circular buffer of data. One reader and - * one writer can operate on the data from different threads in a lockfree + * one writer can operate on the data from different threads in a lockfree * manner. The base class is sufficiently flexible to be used as an - * abstraction for DMA based ringbuffers as well as a pure software + * abstraction for DMA based ringbuffers as well as a pure software * implementations. * * diff --git a/gst-libs/gst/interfaces/colorbalance.c b/gst-libs/gst/interfaces/colorbalance.c index 01fe035..5b09bb8 100644 --- a/gst-libs/gst/interfaces/colorbalance.c +++ b/gst-libs/gst/interfaces/colorbalance.c @@ -27,6 +27,11 @@ #include "colorbalance.h" #include "interfaces-marshal.h" +/** + * SECTION:gstcolorbalance + * @short_description: Interface for adjusting color balance settings + */ + enum { VALUE_CHANGED, diff --git a/gst-libs/gst/interfaces/mixer.c b/gst-libs/gst/interfaces/mixer.c index d7074d9..76a8a96 100644 --- a/gst-libs/gst/interfaces/mixer.c +++ b/gst-libs/gst/interfaces/mixer.c @@ -26,6 +26,11 @@ #include "mixer.h" #include "interfaces-marshal.h" +/** + * SECTION:gstmixer + * @short_description: Interface for elements that provide mixer operations + */ + enum { SIGNAL_MUTE_TOGGLED, diff --git a/gst-libs/gst/interfaces/tuner.c b/gst-libs/gst/interfaces/tuner.c index 9b24f62..604fbf0 100644 --- a/gst-libs/gst/interfaces/tuner.c +++ b/gst-libs/gst/interfaces/tuner.c @@ -28,6 +28,11 @@ #include +/** + * SECTION:gsttuner + * @short_description: Interface for elements providing tuner operations + */ + enum { NORM_CHANGED, diff --git a/gst-libs/gst/interfaces/xoverlay.c b/gst-libs/gst/interfaces/xoverlay.c index 25119e7..a35d1b3 100644 --- a/gst-libs/gst/interfaces/xoverlay.c +++ b/gst-libs/gst/interfaces/xoverlay.c @@ -38,10 +38,10 @@ * * * - * To force a redrawing of the latest video frame the video sink element + * To force a redrawing of the latest video frame the video sink element * displayed on the Window. Indeed if the #GstPipeline is in #GST_STATE_PAUSED * state, moving the Window around will damage its content. Application - * developers will want to handle the Expose events themselves and force the + * developers will want to handle the Expose events themselves and force the * video sink element to refresh the Window's content. * * @@ -49,7 +49,7 @@ * * * Using the Window created by the video sink is probably the simplest scenario, - * in some cases, though, it might not be flexible enough for application + * in some cases, though, it might not be flexible enough for application * developers if they need to catch events such as mouse moves and button * clicks. * @@ -58,7 +58,7 @@ * flexible solution but it has some issues. Indeed the application needs to set * its Window identifier at the right time to avoid internal Window creation * from the video sink element. To solve this issue a #GstMessage is posted on - * the bus to inform the application that it should set the Window identifier + * the bus to inform the application that it should set the Window identifier * immediately. Here is an example on how to do that correctly: * * static GstBusSyncReply -- 2.7.4