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
parent 3a19c68a
2006-06-07 Thomas Vander Stichele <thomas at apestaart dot org>
* 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 <msmith@fluendo.com>
* ext/theora/theoraparse.c: (theora_parse_drain_queue_prematurely),
......
<!-- ##### SECTION Title ##### -->
gstaudio
<!-- ##### SECTION Short_Description ##### -->
a support library for audio elements
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM GstAudioFieldFlag ##### -->
<para>
</para>
@GST_AUDIO_FIELD_RATE:
@GST_AUDIO_FIELD_CHANNELS:
@GST_AUDIO_FIELD_ENDIANNESS:
@GST_AUDIO_FIELD_WIDTH:
@GST_AUDIO_FIELD_DEPTH:
@GST_AUDIO_FIELD_SIGNED:
<!-- ##### FUNCTION gst_audio_frame_byte_size ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_audio_frame_length ##### -->
<para>
</para>
@pad:
@buf:
@Returns:
<!-- ##### FUNCTION gst_audio_duration_from_pad_buffer ##### -->
<para>
</para>
@pad:
@buf:
@Returns:
<!-- ##### FUNCTION gst_audio_is_buffer_framed ##### -->
<para>
</para>
@pad:
@buf:
@Returns:
<!-- ##### FUNCTION gst_audio_structure_set_int ##### -->
<para>
</para>
@structure:
@flag:
<!-- ##### SECTION Title ##### -->
gstcolorbalance
<!-- ##### SECTION Short_Description ##### -->
interface for adjusting color balance settings
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstColorBalance ##### -->
<para>
</para>
<!-- ##### SIGNAL GstColorBalance::value-changed ##### -->
<para>
</para>
@gstcolorbalance: the object which received the signal.
@arg1:
@arg2:
<!-- ##### STRUCT GstColorBalanceClass ##### -->
<para>
</para>
@klass:
@balance_type:
@list_channels:
@set_value:
@get_value:
@value_changed:
@_gst_reserved:
<!-- ##### FUNCTION gst_color_balance_list_channels ##### -->
<para>
</para>
@balance:
@Returns:
<!-- ##### FUNCTION gst_color_balance_get_value ##### -->
<para>
</para>
@balance:
@channel:
@Returns:
<!-- ##### FUNCTION gst_color_balance_set_value ##### -->
<para>
</para>
@balance:
@channel:
@value:
<!-- ##### FUNCTION gst_color_balance_value_changed ##### -->
<para>
</para>
@balance:
@channel:
@value:
<!-- ##### SECTION Title ##### -->
gstmixer
<!-- ##### SECTION Short_Description ##### -->
interface for elements that provide mixer operations
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstMixer ##### -->
<para>
</para>
<!-- ##### STRUCT GstMixerClass ##### -->
<para>
</para>
@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:
<!-- ##### STRUCT GstMixerOptions ##### -->
<para>
</para>
<!-- ##### STRUCT GstMixerTrack ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_mixer_list_tracks ##### -->
<para>
</para>
@mixer:
@Returns:
<!-- ##### FUNCTION gst_mixer_get_volume ##### -->
<para>
</para>
@mixer:
@track:
@volumes:
<!-- ##### FUNCTION gst_mixer_set_volume ##### -->
<para>
</para>
@mixer:
@track:
@volumes:
<!-- ##### FUNCTION gst_mixer_set_mute ##### -->
<para>
</para>
@mixer:
@track:
@mute:
<!-- ##### FUNCTION gst_mixer_set_record ##### -->
<para>
</para>
@mixer:
@track:
@record:
<!-- ##### FUNCTION gst_mixer_set_option ##### -->
<para>
</para>
@mixer:
@opts:
@value:
<!-- ##### FUNCTION gst_mixer_mute_toggled ##### -->
<para>
</para>
@mixer:
@track:
@mute:
<!-- ##### FUNCTION gst_mixer_record_toggled ##### -->
<para>
</para>
@mixer:
@track:
@record:
<!-- ##### FUNCTION gst_mixer_volume_changed ##### -->
<para>
</para>
@mixer:
@track:
@volumes:
<!-- ##### FUNCTION gst_mixer_option_changed ##### -->
<para>
</para>
@mixer:
@opts:
@value:
<!-- ##### FUNCTION gst_mixer_options_get_values ##### -->
<para>
</para>
@mixer_options:
@Returns:
<!-- ##### SECTION Title ##### -->
gstringbuffer
<!-- ##### SECTION Short_Description ##### -->
an implementation of an audio ringbuffer
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstRingBuffer ##### -->
<para>
</para>
@cond:
@open:
@acquired:
@data:
@spec:
@segstate:
@samples_per_seg:
@empty_seg:
@state:
@segdone:
@segbase:
@waiting:
<!-- ##### STRUCT GstRingBufferSpec ##### -->
<para>
</para>
@caps:
@type:
@format:
@sign:
@bigend:
@width:
@depth:
@rate:
@channels:
@latency_time:
@buffer_time:
@segsize:
@segtotal:
@bytes_per_sample:
@silence_sample:
<!-- ##### STRUCT GstRingBufferClass ##### -->
<para>
</para>
@parent_class:
@open_device:
@acquire:
@release:
@close_device:
@start:
@pause:
@resume:
@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:
<!-- ##### SECTION Title ##### -->
gsttuner
<!-- ##### SECTION Short_Description ##### -->
interface for elements that provide tuner operations
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstTuner ##### -->
<para>
</para>
<!-- ##### STRUCT GstTunerClass ##### -->
<para>
</para>
@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:
<!-- ##### FUNCTION gst_tuner_list_channels ##### -->
<para>
</para>
@tuner:
@Returns:
<!-- ##### FUNCTION gst_tuner_get_channel ##### -->
<para>
</para>
@tuner:
@Returns:
<!-- ##### FUNCTION gst_tuner_set_channel ##### -->
<para>
</para>
@tuner:
@channel:
<!-- ##### FUNCTION gst_tuner_list_norms ##### -->
<para>
</para>
@tuner:
@Returns:
<!-- ##### FUNCTION gst_tuner_get_norm ##### -->
<para>
</para>
@tuner:
@Returns:
<!-- ##### FUNCTION gst_tuner_set_norm ##### -->