From: <en...@ke...> - 2008-08-11 07:16:34
|
CVS Root: /cvs/gstreamer Module: gst-plugins-base Changes by: ensonic Date: Mon Aug 11 2008 07:16:45 UTC Log message: * gst-libs/gst/audio/audio.c: Fix doc comment syntax. * gst-libs/gst/interfaces/propertyprobe.c: Add more doc-comments and a FIXME: for the signal. Modified files: . : ChangeLog gst-libs/gst/audio: audio.c gst-libs/gst/interfaces: propertyprobe.c Links: http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-base/ChangeLog.diff?r1=1.4084&r2=1.4085 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-base/gst-libs/gst/audio/audio.c.diff?r1=1.36&r2=1.37 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-base/gst-libs/gst/interfaces/propertyprobe.c.diff?r1=1.11&r2=1.12 ====Begin Diffs==== Index: ChangeLog =================================================================== RCS file: /cvs/gstreamer/gst-plugins-base/ChangeLog,v retrieving revision 1.4084 retrieving revision 1.4085 diff -u -d -r1.4084 -r1.4085 --- ChangeLog 7 Aug 2008 16:11:12 -0000 1.4084 +++ ChangeLog 11 Aug 2008 07:16:29 -0000 1.4085 @@ -1,3 +1,11 @@ +2008-08-11 Stefan Kost <en...@us...> + + * gst-libs/gst/audio/audio.c: + Fix doc comment syntax. + * gst-libs/gst/interfaces/propertyprobe.c: + Add more doc-comments and a FIXME: for the signal. 2008-08-07 Sebastian Dröge <seb...@co...> * ext/ogg/gstoggmux.c: (gst_ogg_mux_sink_event), Index: audio.c RCS file: /cvs/gstreamer/gst-plugins-base/gst-libs/gst/audio/audio.c,v retrieving revision 1.36 retrieving revision 1.37 diff -u -d -r1.36 -r1.37 --- audio.c 3 Mar 2008 06:03:45 -0000 1.36 +++ audio.c 11 Aug 2008 07:16:30 -0000 1.37 @@ -105,7 +105,7 @@ * Calculate length in nanoseconds of audio buffer @buf based on capabilities of * @pad. * - * Return: the length. + * Returns: the length. */ GstClockTime gst_audio_duration_from_pad_buffer (GstPad * pad, GstBuffer * buf) Index: propertyprobe.c RCS file: /cvs/gstreamer/gst-plugins-base/gst-libs/gst/interfaces/propertyprobe.c,v retrieving revision 1.11 retrieving revision 1.12 diff -u -d -r1.11 -r1.12 --- propertyprobe.c 10 Jul 2007 20:46:41 -0000 1.11 +++ propertyprobe.c 11 Aug 2008 07:16:30 -0000 1.12 @@ -18,7 +18,15 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. - +/** + * SECTION:gstpropertyprobe + * @short_description: Interface for probing possible property values + * + * The property probe is a way to autodetect allowed values for a GObject + * property. It's primary use is to autodetect device-names in several elements. + * The interface is implemented by many hardware sources and sinks. + */ #ifdef HAVE_CONFIG_H #include "config.h" #endif @@ -69,6 +77,15 @@ static gboolean initialized = FALSE; if (!initialized) { + /** + * GstPropertyProbe::probe-needed + * %pspec: #GParamSpec that needs a probe + * + */ + /* FIXME: + * what is the purpose of this signal, I can't find any usage of it + * according to proto n *.h, it should be g_cclosure_marshal_VOID__PARAM gst_property_probe_signals[SIGNAL_PROBE_NEEDED] = g_signal_new ("probe-needed", G_TYPE_FROM_CLASS (iface), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstPropertyProbeInterface, @@ -91,7 +108,6 @@ * Returns: the list of properties for which probing is supported * by this element. const GList * gst_property_probe_get_properties (GstPropertyProbe * probe) { @@ -107,6 +123,15 @@ return NULL; } + * gst_property_probe_get_property: + * @probe: the #GstPropertyProbe to get the properties for. + * @name: name of the property. + * Get #GParamSpec for a property for which probing is supported. + * Returns: the #GParamSpec of %NULL. const GParamSpec * gst_property_probe_get_property (GstPropertyProbe * probe, const gchar * name) @@ -127,6 +152,13 @@ + * gst_property_probe_probe_property: + * @probe: the #GstPropertyProbe to check. + * @pspec: #GParamSpec of the property. + * Runs a probe on the property specified by %pspec void gst_property_probe_probe_property (GstPropertyProbe * probe, const GParamSpec * pspec) @@ -145,11 +177,10 @@ /** * gst_property_probe_probe_property_name: * @probe: the #GstPropertyProbe to check. - * @name: name of the property to return. - * Runs a probe on the given property. + * Runs a probe on the property specified by %name. gst_property_probe_probe_property_name (GstPropertyProbe * probe, const gchar * name) @@ -181,7 +212,6 @@ * Returns: TRUE if the property needs a new probe, FALSE if not. gboolean gst_property_probe_needs_probe (GstPropertyProbe * probe, @@ -208,7 +238,6 @@ gst_property_probe_needs_probe_name (GstPropertyProbe * probe, @@ -237,7 +266,6 @@ * Returns: A list of valid values for the given property. GValueArray * gst_property_probe_get_values (GstPropertyProbe * probe, @@ -264,7 +292,6 @@ gst_property_probe_get_values_name (GstPropertyProbe * probe, @@ -294,7 +321,6 @@ * Returns: the list of valid values for this property. gst_property_probe_probe_and_get_values (GstPropertyProbe * probe, @@ -321,7 +347,6 @@ gst_property_probe_probe_and_get_values_name (GstPropertyProbe * probe, |