Commit d506409a authored by Tim-Philipp Müller's avatar Tim-Philipp Müller
Browse files

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

And some gtk-doc markup fixes.
parent 548e756e
......@@ -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
......
......@@ -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",
......
......@@ -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",
......
......@@ -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",
......
......@@ -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 "
......
......@@ -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,
......
......@@ -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.
*/
......
......@@ -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",
......
......@@ -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",
......
......@@ -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.
......
......@@ -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",
......
......@@ -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, "
......
......@@ -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,
......
......@@ -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,
......
......@@ -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,
......
......@@ -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,
......
......@@ -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",
......
......@@ -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 "
......
......@@ -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",
......
......@@ -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.
*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment