docs: get rid of 'Since: 0.10.x' markers

And some gtk-doc markup fixes.
This commit is contained in:
Tim-Philipp Müller 2013-11-18 14:44:36 +00:00
parent 548e756e0a
commit d506409af5
33 changed files with 100 additions and 233 deletions

View file

@ -41,8 +41,6 @@
* Overlays the image in image.png onto the test video picture produced by
* videotestsrc.
* </refsect2>
*
* Since: 0.10.33
*/
#ifdef HAVE_CONFIG_H

View file

@ -19,7 +19,6 @@
/**
* SECTION:element-gdkpixbufsink
* @Since: 0.10.8
*
* This sink element takes RGB or RGBA images as input and wraps them into
* #GdkPixbuf objects, for easy saving to file via the
@ -160,8 +159,6 @@ gst_gdk_pixbuf_sink_class_init (GstGdkPixbufSinkClass * klass)
* GstGdkPixbuf:post-messages:
*
* Post messages on the bus containing pixbufs.
*
* Since: 0.10.17
*/
g_object_class_install_property (gobject_class, PROP_POST_MESSAGES,
g_param_spec_boolean ("post-messages", "Post Messages",

View file

@ -736,11 +736,9 @@ gst_jack_audio_sink_class_init (GstJackAudioSinkClass * klass)
DEFAULT_PROP_SERVER, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstJackAudioSink:client-name
* GstJackAudioSink:client-name:
*
* The client name to use.
*
* Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_CLIENT_NAME,
g_param_spec_string ("client-name", "Client name",
@ -755,11 +753,9 @@ gst_jack_audio_sink_class_init (GstJackAudioSinkClass * klass)
G_PARAM_STATIC_STRINGS));
/**
* GstJackAudioSink:transport
* GstJackAudioSink:transport:
*
* The jack transport behaviour for the client.
*
* Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_TRANSPORT,
g_param_spec_flags ("transport", "Transport mode",

View file

@ -758,11 +758,9 @@ gst_jack_audio_src_class_init (GstJackAudioSrcClass * klass)
DEFAULT_PROP_SERVER, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstJackAudioSrc:client-name
* GstJackAudioSrc:client-name:
*
* The client name to use.
*
* Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_CLIENT_NAME,
g_param_spec_string ("client-name", "Client name",
@ -777,11 +775,9 @@ gst_jack_audio_src_class_init (GstJackAudioSrcClass * klass)
G_PARAM_STATIC_STRINGS));
/**
* GstJackAudioSink:transport
* GstJackAudioSink:transport:
*
* The jack transport behaviour for the client.
*
* Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_TRANSPORT,
g_param_spec_flags ("transport", "Transport mode",

View file

@ -144,13 +144,11 @@ gst_jpeg_dec_class_init (GstJpegDecClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstJpegDec:max-errors
* GstJpegDec:max-errors:
*
* Error out after receiving N consecutive decoding errors
* (-1 = never error out, 0 = automatic, 1 = fail on first error, etc.)
*
* Since: 0.10.27
**/
*/
g_object_class_install_property (gobject_class, PROP_MAX_ERRORS,
g_param_spec_int ("max-errors", "Maximum Consecutive Decoding Errors",
"Error out after receiving N consecutive decoding errors "

View file

@ -1899,7 +1899,7 @@ gst_pulsesink_class_init (GstPulseSinkClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstPulseSink:client-name
* GstPulseSink:client-name:
*
* The PulseAudio client name to use.
*/
@ -1913,7 +1913,7 @@ gst_pulsesink_class_init (GstPulseSinkClass * klass)
g_free (clientname);
/**
* GstPulseSink:stream-properties
* GstPulseSink:stream-properties:
*
* List of pulseaudio stream properties. A list of defined properties can be
* found in the <ulink url="http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html">pulseaudio api docs</ulink>.
@ -1926,8 +1926,6 @@ gst_pulsesink_class_init (GstPulseSinkClass * klass)
* g_object_set (pulse, "stream-properties", props, NULL);
* gst_structure_free
* ]|
*
* Since: 0.10.26
*/
g_object_class_install_property (gobject_class,
PROP_STREAM_PROPERTIES,

View file

@ -184,7 +184,7 @@ gst_pulsesrc_class_init (GstPulseSrcClass * klass)
g_free (clientname);
/**
* GstPulseSrc:stream-properties
* GstPulseSrc:stream-properties:
*
* List of pulseaudio stream properties. A list of defined properties can be
* found in the <ulink href="http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html">pulseaudio api docs</ulink>.
@ -197,8 +197,6 @@ gst_pulsesrc_class_init (GstPulseSrcClass * klass)
* g_object_set (pulse, "stream-properties", props, NULL);
* gst_structure_free (props);
* ]|
*
* Since: 0.10.26
*/
g_object_class_install_property (gobject_class,
PROP_STREAM_PROPERTIES,
@ -206,11 +204,9 @@ gst_pulsesrc_class_init (GstPulseSrcClass * klass)
"list of pulseaudio stream properties",
GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstPulseSrc:source-output-index
* GstPulseSrc:source-output-index:
*
* The index of the PulseAudio source output corresponding to this element.
*
* Since: 0.10.31
*/
g_object_class_install_property (gobject_class,
PROP_SOURCE_OUTPUT_INDEX,
@ -227,7 +223,7 @@ gst_pulsesrc_class_init (GstPulseSrcClass * klass)
gst_static_pad_template_get (&pad_template));
/**
* GstPulseSrc:volume
* GstPulseSrc:volume:
*
* The volume of the record stream.
*/
@ -238,7 +234,7 @@ gst_pulsesrc_class_init (GstPulseSrcClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstPulseSrc:mute
* GstPulseSrc:mute:
*
* Whether the stream is muted or not.
*/

View file

@ -201,12 +201,10 @@ gst_dv1394src_class_init (GstDV1394SrcClass * klass)
"like 0xhhhhhhhhhhhhhhhh. (0 = no guid)", 0, G_MAXUINT64,
DEFAULT_GUID, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstDV1394Src:device-name
* GstDV1394Src:device-name:
*
* Descriptive name of the currently opened device
*
* Since: 0.10.7
**/
*/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DEVICE_NAME,
g_param_spec_string ("device-name", "device name",
"user-friendly name of the device", "Default",

View file

@ -152,12 +152,10 @@ gst_hdv1394src_class_init (GstHDV1394SrcClass * klass)
"like 0xhhhhhhhhhhhhhhhh. (0 = no guid)", 0, G_MAXUINT64,
DEFAULT_GUID, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstHDV1394Src:device-name
* GstHDV1394Src:device-name:
*
* Descriptive name of the currently opened device
*
* Since: 0.10.7
**/
*/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DEVICE_NAME,
g_param_spec_string ("device-name", "device name",
"user-friendly name of the device", "Default",

View file

@ -20,7 +20,6 @@
/**
* SECTION:element-audioecho
* @Since: 0.10.14
*
* audioecho adds an echo or (simple) reverb effect to an audio stream. The echo
* delay, intensity and the percentage of feedback can be configured.

View file

@ -543,12 +543,10 @@ gst_audio_fx_base_fir_filter_class_init (GstAudioFXBaseFIRFilterClass * klass)
gobject_class->get_property = gst_audio_fx_base_fir_filter_get_property;
/**
* GstAudioFXBaseFIRFilter::low-latency:
* GstAudioFXBaseFIRFilter:low-latency:
*
* Work in low-latency mode. This mode is much slower for large filter sizes
* but the latency is always only the pre-latency of the filter.
*
* Since: 0.10.18
*/
g_object_class_install_property (gobject_class, PROP_LOW_LATENCY,
g_param_spec_boolean ("low-latency", "Low latency",
@ -558,14 +556,12 @@ gst_audio_fx_base_fir_filter_class_init (GstAudioFXBaseFIRFilterClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstAudioFXBaseFIRFilter::drain-on-changes:
* GstAudioFXBaseFIRFilter:drain-on-changes:
*
* Whether the filter should be drained when its coeficients change
*
* Note: Currently this only works if the kernel size is not changed!
* Support for drainless kernel size changes will be added in the future.
*
* Since: 0.10.18
*/
g_object_class_install_property (gobject_class, PROP_DRAIN_ON_CHANGES,
g_param_spec_boolean ("drain-on-changes", "Drain on changes",

View file

@ -181,14 +181,12 @@ gst_audio_panorama_class_init (GstAudioPanoramaClass * klass)
0.0,
G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE | G_PARAM_STATIC_STRINGS));
/**
* GstAudioPanorama:method
* GstAudioPanorama:method:
*
* Panning method: psychoacoustic mode keeps the same perceived loudness,
* while simple mode just controls the volume of one channel. It's merely
* a matter of taste which method should be chosen.
*
* Since: 0.10.6
**/
*/
g_object_class_install_property (gobject_class, PROP_METHOD,
g_param_spec_enum ("method", "Panning method",
"Psychoacoustic mode keeps same perceived loudness, "

View file

@ -90,16 +90,14 @@ gst_auto_audio_sink_class_init (GstAutoAudioSinkClass * klass)
eklass->change_state = GST_DEBUG_FUNCPTR (gst_auto_audio_sink_change_state);
/**
* GstAutoAudioSink:filter-caps
* GstAutoAudioSink:filter-caps:
*
* This property will filter out candidate sinks that can handle the specified
* caps. By default only audio sinks that support raw floating point and
* integer audio are selected.
*
* This property can only be set before the element goes to the READY state.
*
* Since: 0.10.7
**/
*/
g_object_class_install_property (gobject_class, PROP_CAPS,
g_param_spec_boxed ("filter-caps", "Filter caps",
"Filter sink candidates using these caps.", GST_TYPE_CAPS,

View file

@ -86,16 +86,14 @@ gst_auto_audio_src_class_init (GstAutoAudioSrcClass * klass)
eklass->change_state = GST_DEBUG_FUNCPTR (gst_auto_audio_src_change_state);
/**
* GstAutoAudioSrc:filter-caps
* GstAutoAudioSrc:filter-caps:
*
* This property will filter out candidate sinks that can handle the specified
* caps. By default only audio sinks that support raw floating point and
* integer audio are selected.
*
* This property can only be set before the element goes to the READY state.
*
* Since: 0.10.14
**/
*/
g_object_class_install_property (gobject_class, PROP_CAPS,
g_param_spec_boxed ("filter-caps", "Filter caps",
"Filter sink candidates using these caps.", GST_TYPE_CAPS,

View file

@ -88,16 +88,14 @@ gst_auto_video_sink_class_init (GstAutoVideoSinkClass * klass)
eklass->change_state = GST_DEBUG_FUNCPTR (gst_auto_video_sink_change_state);
/**
* GstAutoVideoSink:filter-caps
* GstAutoVideoSink:filter-caps:
*
* This property will filter out candidate sinks that can handle the specified
* caps. By default only video sinks that support raw rgb and yuv video
* are selected.
*
* This property can only be set before the element goes to the READY state.
*
* Since: 0.10.7
**/
*/
g_object_class_install_property (gobject_class, PROP_CAPS,
g_param_spec_boxed ("filter-caps", "Filter caps",
"Filter sink candidates using these caps.", GST_TYPE_CAPS,

View file

@ -85,16 +85,14 @@ gst_auto_video_src_class_init (GstAutoVideoSrcClass * klass)
eklass->change_state = GST_DEBUG_FUNCPTR (gst_auto_video_src_change_state);
/**
* GstAutoVideoSrc:filter-caps
* GstAutoVideoSrc:filter-caps:
*
* This property will filter out candidate sources that can handle the specified
* caps. By default only video sources that support raw rgb and yuv video
* are selected.
*
* This property can only be set before the element goes to the READY state.
*
* Since: 0.10.14
**/
*/
g_object_class_install_property (gobject_class, PROP_CAPS,
g_param_spec_boxed ("filter-caps", "Filter caps",
"Filter src candidates using these caps.", GST_TYPE_CAPS,

View file

@ -501,12 +501,11 @@ gst_deinterlace_class_init (GstDeinterlaceClass * klass)
gobject_class->finalize = gst_deinterlace_finalize;
/**
* GstDeinterlace:mode
* GstDeinterlace:mode:
*
* This selects whether the deinterlacing methods should
* always be applied or if they should only be applied
* on content that has the "interlaced" flag on the caps.
*
*/
g_object_class_install_property (gobject_class, PROP_MODE,
g_param_spec_enum ("mode",
@ -517,7 +516,7 @@ gst_deinterlace_class_init (GstDeinterlaceClass * klass)
);
/**
* GstDeinterlace:method
* GstDeinterlace:method:
*
* Selects the different deinterlacing algorithms that can be used.
* These provide different quality and CPU usage.
@ -599,11 +598,10 @@ gst_deinterlace_class_init (GstDeinterlaceClass * klass)
);
/**
* GstDeinterlace:fields
* GstDeinterlace:fields:
*
* This selects which fields should be output. If "all" is selected
* the output framerate will be double.
*
*/
g_object_class_install_property (gobject_class, PROP_FIELDS,
g_param_spec_enum ("fields",
@ -614,7 +612,7 @@ gst_deinterlace_class_init (GstDeinterlaceClass * klass)
);
/**
* GstDeinterlace:layout
* GstDeinterlace:layout:
*
* This selects which fields is the first in time.
*
@ -628,14 +626,11 @@ gst_deinterlace_class_init (GstDeinterlaceClass * klass)
);
/**
* GstDeinterlace:locking
* GstDeinterlace:locking:
*
* This selects which approach to pattern locking is used which affects
* processing latency and accuracy of timestamp adjustment for telecine
* streams.
*
* Since: 0.10.31
*
*/
g_object_class_install_property (gobject_class, PROP_LOCKING,
g_param_spec_enum ("locking", "locking", "Pattern locking mode",
@ -643,13 +638,10 @@ gst_deinterlace_class_init (GstDeinterlaceClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstDeinterlace:ignore-obscure
* GstDeinterlace:ignore-obscure:
*
* This selects whether to ignore obscure/rare telecine patterns.
* NTSC 2:3 pulldown variants are the only really common patterns.
*
* Since: 0.10.31
*
*/
g_object_class_install_property (gobject_class, PROP_IGNORE_OBSCURE,
g_param_spec_boolean ("ignore-obscure", "ignore-obscure",
@ -658,13 +650,10 @@ gst_deinterlace_class_init (GstDeinterlaceClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstDeinterlace:drop-orphans
* GstDeinterlace:drop-orphans:
*
* This selects whether to drop orphan fields at the beginning of telecine
* patterns in active locking mode.
*
* Since: 0.10.31
*
*/
g_object_class_install_property (gobject_class, PROP_DROP_ORPHANS,
g_param_spec_boolean ("drop-orphans", "drop-orphans",

View file

@ -174,9 +174,7 @@ gst_flv_mux_class_init (GstFlvMuxClass * klass)
*
* If True, the output will be streaming friendly. (ie without indexes and
* duration)
*
* Since: 0.10.24
**/
*/
g_object_class_install_property (gobject_class, PROP_STREAMABLE,
g_param_spec_boolean ("streamable", "streamable",
"If set to true, the output should be as if it is to be streamed "

View file

@ -217,22 +217,18 @@ gst_multi_file_sink_class_init (GstMultiFileSinkClass * klass)
0, G_MAXINT, DEFAULT_INDEX,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstMultiFileSink:post-messages
* GstMultiFileSink:post-messages:
*
* Post a message on the GstBus for each file.
*
* Since: 0.10.17
*/
g_object_class_install_property (gobject_class, PROP_POST_MESSAGES,
g_param_spec_boolean ("post-messages", "Post Messages",
"Post a message for each file with information of the buffer",
DEFAULT_POST_MESSAGES, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstMultiFileSink:next-file
* GstMultiFileSink:next-file:
*
* When to start a new file.
*
* Since: 0.10.17
*/
g_object_class_install_property (gobject_class, PROP_NEXT_FILE,
g_param_spec_enum ("next-file", "Next File",
@ -242,12 +238,10 @@ gst_multi_file_sink_class_init (GstMultiFileSinkClass * klass)
/**
* GstMultiFileSink:max-files
* GstMultiFileSink:max-files:
*
* Maximum number of files to keep on disk. Once the maximum is reached, old
* files start to be deleted to make room for new ones.
*
* Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_MAX_FILES,
g_param_spec_uint ("max-files", "Max files",
@ -257,11 +251,9 @@ gst_multi_file_sink_class_init (GstMultiFileSinkClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstMultiFileSink:max-file-size
* GstMultiFileSink:max-file-size:
*
* Maximum file size before starting a new file in max-size mode.
*
* Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_MAX_FILE_SIZE,
g_param_spec_uint64 ("max-file-size", "Maximum File Size",

View file

@ -59,9 +59,9 @@ typedef struct _GstMultiFileSinkClass GstMultiFileSinkClass;
* @GST_MULTI_FILE_SINK_NEXT_KEY_FRAME: New file at each key frame
* (Useful for MPEG-TS segmenting)
* @GST_MULTI_FILE_SINK_NEXT_KEY_UNIT_EVENT: New file after a force key unit
* event (Since: 0.10.31)
* event
* @GST_MULTI_FILE_SINK_NEXT_MAX_SIZE: New file when the configured maximum file
* size would be exceeded with the next buffer or buffer list (Since: 0.10.31)
* size would be exceeded with the next buffer or buffer list
*
* File splitting modes.
*/

View file

@ -38,8 +38,6 @@
* gst-launch-1.0 playbin uri="splitfile://path/to/foo.avi.*"
* ]| Plays the different parts as if they were one single AVI file.
* </refsect2>
*
* Since: 0.10.31
*/
#ifdef HAVE_CONFIG_H

View file

@ -140,13 +140,11 @@ gst_multipart_demux_class_init (GstMultipartDemuxClass * klass)
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
/**
* GstMultipartDemux::single-stream:
* GstMultipartDemux:single-stream:
*
* Assume that there is only one stream whose content-type will
* not change and emit no-more-pads as soon as the first boundary
* content is parsed, decoded, and pads are linked.
*
* Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_SINGLE_STREAM,
g_param_spec_boolean ("single-stream", "Single Stream",

View file

@ -1607,8 +1607,6 @@ gst_rtp_bin_class_init (GstRtpBinClass * klass)
* @pt: the pt
*
* Signal that the current payload type changed to @pt in @session.
*
* Since: 0.10.17
*/
gst_rtp_bin_signals[SIGNAL_PAYLOAD_TYPE_CHANGE] =
g_signal_new ("payload-type-change", G_TYPE_FROM_CLASS (klass),
@ -1814,26 +1812,22 @@ gst_rtp_bin_class_init (GstRtpBinClass * klass)
DEFAULT_USE_PIPELINE_CLOCK,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpBin::buffer-mode:
* GstRtpBin:buffer-mode:
*
* Control the buffering and timestamping mode used by the jitterbuffer.
*
* Since: 0.10.17
*/
g_object_class_install_property (gobject_class, PROP_BUFFER_MODE,
g_param_spec_enum ("buffer-mode", "Buffer Mode",
"Control the buffering algorithm in use", RTP_TYPE_JITTER_BUFFER_MODE,
DEFAULT_BUFFER_MODE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpBin::ntp-sync:
* GstRtpBin:ntp-sync:
*
* Set the NTP time from the sender reports as the running-time on the
* buffers. When both the sender and receiver have sychronized
* running-time, i.e. when the clock and base-time is shared
* between the receivers and the and the senders, this option can be
* used to synchronize receivers on multiple machines.
*
* Since: 0.10.21
*/
g_object_class_install_property (gobject_class, PROP_NTP_SYNC,
g_param_spec_boolean ("ntp-sync", "Sync on NTP clock",
@ -1841,12 +1835,10 @@ gst_rtp_bin_class_init (GstRtpBinClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpBin::rtcp-sync:
* GstRtpBin:rtcp-sync:
*
* If not synchronizing (directly) to the NTP clock, determines how to sync
* the various streams.
*
* Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_RTCP_SYNC,
g_param_spec_enum ("rtcp-sync", "RTCP Sync",
@ -1854,11 +1846,9 @@ gst_rtp_bin_class_init (GstRtpBinClass * klass)
DEFAULT_RTCP_SYNC, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpBin::rtcp-sync-interval:
* GstRtpBin:rtcp-sync-interval:
*
* Determines how often to sync streams using RTCP data.
*
* Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_RTCP_SYNC_INTERVAL,
g_param_spec_uint ("rtcp-sync-interval", "RTCP Sync Interval",

View file

@ -420,7 +420,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
gobject_class->get_property = gst_rtp_jitter_buffer_get_property;
/**
* GstRtpJitterBuffer::latency:
* GstRtpJitterBuffer:latency:
*
* The maximum latency of the jitterbuffer. Packets will be kept in the buffer
* for at most this time.
@ -430,7 +430,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
"Amount of ms to buffer", 0, G_MAXUINT, DEFAULT_LATENCY_MS,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpJitterBuffer::drop-on-latency:
* GstRtpJitterBuffer:drop-on-latency:
*
* Drop oldest buffers when the queue is completely filled.
*/
@ -440,7 +440,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
"Tells the jitterbuffer to never exceed the given latency in size",
DEFAULT_DROP_ON_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpJitterBuffer::ts-offset:
* GstRtpJitterBuffer:ts-offset:
*
* Adjust GStreamer output buffer timestamps in the jitterbuffer with offset.
* This is mainly used to ensure interstream synchronisation.
@ -452,7 +452,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpJitterBuffer::do-lost:
* GstRtpJitterBuffer:do-lost:
*
* Send out a GstRTPPacketLost event downstream when a packet is considered
* lost.
@ -463,7 +463,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpJitterBuffer::mode:
* GstRtpJitterBuffer:mode:
*
* Control the buffering and timestamping mode used by the jitterbuffer.
*/
@ -472,18 +472,16 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
"Control the buffering algorithm in use", RTP_TYPE_JITTER_BUFFER_MODE,
DEFAULT_MODE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpJitterBuffer::percent:
* GstRtpJitterBuffer:percent:
*
* The percent of the jitterbuffer that is filled.
*
* Since: 0.10.19
*/
g_object_class_install_property (gobject_class, PROP_PERCENT,
g_param_spec_int ("percent", "percent",
"The buffer filled percent", 0, 100,
0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpJitterBuffer::do-retransmission:
* GstRtpJitterBuffer:do-retransmission:
*
* Send out a GstRTPRetransmission event upstream when a packet is considered
* late and should be retransmitted.
@ -497,7 +495,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpJitterBuffer::rtx-delay:
* GstRtpJitterBuffer:rtx-delay:
*
* When a packet did not arrive at the expected time, wait this extra amount
* of time before sending a retransmission event.
@ -512,7 +510,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
"event (-1 automatic)", -1, G_MAXINT, DEFAULT_RTX_DELAY,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpJitterBuffer::rtx-delay-reorder:
* GstRtpJitterBuffer:rtx-delay-reorder:
*
* Assume that a retransmission event should be sent when we see
* this much packet reordering.
@ -544,7 +542,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
"ms (-1 automatic)", -1, G_MAXINT, DEFAULT_RTX_RETRY_TIMEOUT,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpJitterBuffer::rtx-retry-period:
* GstRtpJitterBuffer:rtx-retry-period:
*
* The amount of time to try to get a retransmission.
*
@ -559,7 +557,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
"(-1 automatic)", -1, G_MAXINT, DEFAULT_RTX_RETRY_PERIOD,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRtpJitterBuffer::stats:
* GstRtpJitterBuffer:stats:
*
* Various jitterbuffer statistics. This property returns a GstStructure
* with name application/x-rtp-jitterbuffer-stats with the following fields:
@ -602,7 +600,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
G_TYPE_NONE, 1, GST_TYPE_STRUCTURE | G_SIGNAL_TYPE_STATIC_SCOPE);
/**
* GstRtpJitterBuffer::on-npt-stop
* GstRtpJitterBuffer::on-npt-stop:
* @buffer: the object which received the signal
*
* Signal that the jitterbufer has pushed the RTP packet that corresponds to
@ -635,8 +633,6 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
* useful in buffering mode.
*
* Returns: the time of the last pushed packet.
*
* Since: 0.10.19
*/
gst_rtp_jitter_buffer_signals[SIGNAL_SET_ACTIVE] =
g_signal_new ("set-active", G_TYPE_FROM_CLASS (klass),

View file

@ -416,12 +416,10 @@ gst_rtspsrc_class_init (GstRTSPSrcClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTSPSrc::do-rtcp
* GstRTSPSrc:do-rtcp:
*
* Enable RTCP support. Some old server don't like RTCP and then this property
* needs to be set to FALSE.
*
* Since: 0.10.15
*/
g_object_class_install_property (gobject_class, PROP_DO_RTCP,
g_param_spec_boolean ("do-rtcp", "Do RTCP",
@ -429,12 +427,10 @@ gst_rtspsrc_class_init (GstRTSPSrcClass * klass)
DEFAULT_DO_RTCP, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTSPSrc::do-rtsp-keep-alive
* GstRTSPSrc:do-rtsp-keep-alive:
*
* Enable RTSP keep laive support. Some old server don't like RTSP
* Enable RTSP keep alive support. Some old server don't like RTSP
* keep alive and then this property needs to be set to FALSE.
*
* Since: 0.10.32
*/
g_object_class_install_property (gobject_class, PROP_DO_RTSP_KEEP_ALIVE,
g_param_spec_boolean ("do-rtsp-keep-alive", "Do RTSP Keep Alive",
@ -443,19 +439,17 @@ gst_rtspsrc_class_init (GstRTSPSrcClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTSPSrc::proxy
* GstRTSPSrc:proxy:
*
* Set the proxy parameters. This has to be a string of the format
* [http://][user:passwd@]host[:port].
*
* Since: 0.10.15
*/
g_object_class_install_property (gobject_class, PROP_PROXY,
g_param_spec_string ("proxy", "Proxy",
"Proxy settings for HTTP tunneling. Format: [http://][user:passwd@]host[:port]",
DEFAULT_PROXY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTSPSrc::proxy-id
* GstRTSPSrc:proxy-id:
*
* Sets the proxy URI user id for authentication. If the URI set via the
* "proxy" property contains a user-id already, that will take precedence.
@ -467,7 +461,7 @@ gst_rtspsrc_class_init (GstRTSPSrcClass * klass)
"HTTP proxy URI user id for authentication", "",
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTSPSrc::proxy-pw
* GstRTSPSrc:proxy-pw:
*
* Sets the proxy URI password for authentication. If the URI set via the
* "proxy" property contains a password already, that will take precedence.
@ -480,11 +474,9 @@ gst_rtspsrc_class_init (GstRTSPSrcClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTSPSrc::rtp_blocksize
* GstRTSPSrc:rtp-blocksize:
*
* RTP package size to suggest to server.
*
* Since: 0.10.16
*/
g_object_class_install_property (gobject_class, PROP_RTP_BLOCKSIZE,
g_param_spec_uint ("rtp-blocksize", "RTP Blocksize",
@ -503,11 +495,9 @@ gst_rtspsrc_class_init (GstRTSPSrcClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTSPSrc::buffer-mode:
* GstRTSPSrc:buffer-mode:
*
* Control the buffering and timestamping mode used by the jitterbuffer.
*
* Since: 0.10.22
*/
g_object_class_install_property (gobject_class, PROP_BUFFER_MODE,
g_param_spec_enum ("buffer-mode", "Buffer Mode",
@ -516,12 +506,10 @@ gst_rtspsrc_class_init (GstRTSPSrcClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTSPSrc::port-range:
* GstRTSPSrc:port-range:
*
* Configure the client port numbers that can be used to recieve RTP and
* RTCP.
*
* Since: 0.10.25
*/
g_object_class_install_property (gobject_class, PROP_PORT_RANGE,
g_param_spec_string ("port-range", "Port range",
@ -530,11 +518,9 @@ gst_rtspsrc_class_init (GstRTSPSrcClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTSPSrc::udp-buffer-size:
* GstRTSPSrc:udp-buffer-size:
*
* Size of the kernel UDP receive buffer in bytes.
*
* Since: 0.10.26
*/
g_object_class_install_property (gobject_class, PROP_UDP_BUFFER_SIZE,
g_param_spec_int ("udp-buffer-size", "UDP Buffer Size",
@ -543,11 +529,9 @@ gst_rtspsrc_class_init (GstRTSPSrcClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTSPSrc::short-header:
* GstRTSPSrc:short-header:
*
* Only send the basic RTSP headers for broken encoders.
*
* Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_SHORT_HEADER,
g_param_spec_boolean ("short-header", "Short Header",

View file

@ -191,8 +191,6 @@ gst_smpte_alpha_class_init (GstSMPTEAlphaClass * klass)
* GstSMPTEAlpha:invert:
*
* Set to TRUE to invert the transition mask (ie. flip it horizontally).
*
* Since: 0.10.23
*/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_INVERT,
g_param_spec_boolean ("invert", "Invert",

View file

@ -309,7 +309,7 @@ gst_multiudpsink_class_init (GstMultiUDPSinkClass * klass)
" FALSE = disable", DEFAULT_LOOP,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstMultiUDPSink::force-ipv4
* GstMultiUDPSink::force-ipv4:
*
* Force the use of an IPv4 socket.
*
@ -326,12 +326,10 @@ gst_multiudpsink_class_init (GstMultiUDPSinkClass * klass)
-1, 63, DEFAULT_QOS_DSCP,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstMultiUDPSink::send-duplicates
* GstMultiUDPSink::send-duplicates:
*
* When a host/port pair is added mutliple times, send the packet to the host
* multiple times as well.
*
* Since: 0.10.26
*/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEND_DUPLICATES,
g_param_spec_boolean ("send-duplicates", "Send Duplicates",

View file

@ -2501,13 +2501,11 @@ gst_video_box_class_init (GstVideoBoxClass * klass)
"Alpha value of the border", 0.0, 1.0, DEFAULT_BORDER_ALPHA,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
/**
* GstVideoBox:autocrop
* GstVideoBox:autocrop:
*
* If set to %TRUE videobox will automatically crop/pad the input
* video to be centered in the output.
*
* Since: 0.10.16
**/
*/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_AUTOCROP,
g_param_spec_boolean ("autocrop", "Auto crop",
"Auto crop", FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));

View file

@ -158,15 +158,13 @@ gst_wavparse_class_init (GstWavParseClass * klass)
object_class->get_property = gst_wavparse_get_property;
/**
* GstWavParse:ignore-length
* GstWavParse:ignore-length:
*
* This selects whether the length found in a data chunk
* should be ignored. This may be useful for streamed audio
* where the length is unknown until the end of streaming,
* and various software/hardware just puts some random value
* in there and hopes it doesn't break too much.
*
* Since: 0.10.36
*/
g_object_class_install_property (object_class, PROP_IGNORE_LENGTH,
g_param_spec_boolean ("ignore-length",

View file

@ -38,8 +38,6 @@
* ]| will play an Ogg/Vorbis audio file and output it using the Open Sound System
* version 4.
* </refsect2>
*
* Since: 0.10.7
*/
#ifdef HAVE_CONFIG_H

View file

@ -31,8 +31,6 @@
* Ogg/Vorbis file (this will only work if your mixer settings are right
* and the right inputs areenabled etc.)
* </refsect2>
*
* Since: 0.10.7
*/
/* FIXME: make sure we're not doing ioctls from the app thread (e.g. via the

View file

@ -421,11 +421,9 @@ gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
/**
* GstV4l2Src:brightness
* GstV4l2Src:brightness:
*
* Picture brightness, or more precisely, the black level
*
* Since: 0.10.26
*/
g_object_class_install_property (gobject_class, PROP_BRIGHTNESS,
g_param_spec_int ("brightness", "Brightness",
@ -433,11 +431,9 @@ gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
G_MAXINT, 0,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
/**
* GstV4l2Src:contrast
* GstV4l2Src:contrast:
*
* Picture contrast or luma gain
*
* Since: 0.10.26
*/
g_object_class_install_property (gobject_class, PROP_CONTRAST,
g_param_spec_int ("contrast", "Contrast",
@ -445,11 +441,9 @@ gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
G_MAXINT, 0,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
/**
* GstV4l2Src:saturation
* GstV4l2Src:saturation:
*
* Picture color saturation or chroma gain
*
* Since: 0.10.26
*/
g_object_class_install_property (gobject_class, PROP_SATURATION,
g_param_spec_int ("saturation", "Saturation",
@ -457,11 +451,9 @@ gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
G_MAXINT, 0,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
/**
* GstV4l2Src:hue
* GstV4l2Src:hue:
*
* Hue or color balance
*
* Since: 0.10.26
*/
g_object_class_install_property (gobject_class, PROP_HUE,
g_param_spec_int ("hue", "Hue",
@ -470,11 +462,9 @@ gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
/**
* GstV4l2Src:norm
* GstV4l2Src:norm:
*
* TV norm
*
* Since: 0.10.31
*/
g_object_class_install_property (gobject_class, PROP_TV_NORM,
g_param_spec_enum ("norm", "TV norm",
@ -483,7 +473,7 @@ gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstV4l2Src:io-mode
* GstV4l2Src:io-mode:
*
* IO Mode
*/
@ -494,7 +484,7 @@ gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstV4l2Src:extra-controls
* GstV4l2Src:extra-controls:
*
* Additional v4l2 controls for the device. The controls are identified
* by the control name (lowercase with '_' for any non-alphanumeric
@ -508,7 +498,7 @@ gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstV4l2Src:pixel-aspect-ratio
* GstV4l2Src:pixel-aspect-ratio:
*
* The pixel aspect ratio of the device. This overwrites the pixel aspect
* ratio queried from the device.
@ -521,7 +511,7 @@ gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstV4l2Src:force-aspect-ratio
* GstV4l2Src:force-aspect-ratio:
*
* When enabled, the pixel aspect ratio queried from the device or set
* with the pixel-aspect-ratio property will be enforced.

View file

@ -1153,95 +1153,79 @@ gst_ximage_src_class_init (GstXImageSrcClass * klass)
"Show mouse pointer (if XFixes extension enabled)", TRUE,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstXImageSrc:use-damage
* GstXImageSrc:use-damage:
*
* Use XDamage (if the XDamage extension is enabled)
*
* Since: 0.10.4
**/
*/
g_object_class_install_property (gc, PROP_USE_DAMAGE,
g_param_spec_boolean ("use-damage", "Use XDamage",
"Use XDamage (if XDamage extension enabled)", TRUE,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstXImageSrc:startx
* GstXImageSrc:startx:
*
* X coordinate of top left corner of area to be recorded
* (0 for top left of screen)
*
* Since: 0.10.4
**/
*/
g_object_class_install_property (gc, PROP_STARTX,
g_param_spec_uint ("startx", "Start X co-ordinate",
"X coordinate of top left corner of area to be recorded (0 for top left of screen)",
0, G_MAXINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstXImageSrc:starty
* GstXImageSrc:starty:
*
* Y coordinate of top left corner of area to be recorded
* (0 for top left of screen)
*
* Since: 0.10.4
**/
*/
g_object_class_install_property (gc, PROP_STARTY,
g_param_spec_uint ("starty", "Start Y co-ordinate",
"Y coordinate of top left corner of area to be recorded (0 for top left of screen)",
0, G_MAXINT, 0, G_PARAM_READWRITE));
/**
* GstXImageSrc:endx
* GstXImageSrc:endx:
*
* X coordinate of bottom right corner of area to be recorded
* (0 for bottom right of screen)
*
* Since: 0.10.4
**/
*/
g_object_class_install_property (gc, PROP_ENDX,
g_param_spec_uint ("endx", "End X",
"X coordinate of bottom right corner of area to be recorded (0 for bottom right of screen)",
0, G_MAXINT, 0, G_PARAM_READWRITE));
/**
* GstXImageSrc:endy
* GstXImageSrc:endy:
*
* Y coordinate of bottom right corner of area to be recorded
* (0 for bottom right of screen)
*
* Since: 0.10.4
**/
*/
g_object_class_install_property (gc, PROP_ENDY,
g_param_spec_uint ("endy", "End Y",
"Y coordinate of bottom right corner of area to be recorded (0 for bottom right of screen)",
0, G_MAXINT, 0, G_PARAM_READWRITE));
/**
* GstXImageSrc:remote
* GstXImageSrc:remote:
*
* Whether the X display is remote. The element will try to use alternate calls
* known to work better with remote displays.
*
* Since: 0.10.26
**/
*/
g_object_class_install_property (gc, PROP_REMOTE,
g_param_spec_boolean ("remote", "Remote dispay",
"Whether the display is remote", FALSE,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstXImageSrc:xid
* GstXImageSrc:xid:
*
* The XID of the window to capture. 0 for the root window (default).
*
* Since: 0.10.31
**/
*/
g_object_class_install_property (gc, PROP_XID,
g_param_spec_uint64 ("xid", "Window XID",
"Window XID to capture from", 0, G_MAXUINT64, 0,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstXImageSrc:xname
* GstXImageSrc:xname:
*
* The name of the window to capture, if any.
*
* Since: 0.10.31
**/
*/
g_object_class_install_property (gc, PROP_XNAME,
g_param_spec_string ("xname", "Window name",
"Window name to capture from", NULL,