mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-27 20:21:24 +00:00
Code Issues 1 Projects Releases Wiki Activity

gst-libs/gst/audio/audio.c: Fix doc comment syntax.

Browse source 
Original commit message from CVS:
* 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.
This commit is contained in:
Stefan Kost 2008-08-11 07:16:30 +00:00
parent b0e3d44956
commit 26ad0ba982
3 changed files with 45 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
ChangeLog
View file

@ -1,3 +1,11 @@
2008-08-11 Stefan Kost <ensonic@users.sf.net>
* 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 <sebastian.droege@collabora.co.uk>
* ext/ogg/gstoggmux.c: (gst_ogg_mux_sink_event),

2
gst-libs/gst/audio/audio.c
View file

@ -105,7 +105,7 @@ gst_audio_frame_length (GstPad * pad, GstBuffer * buf)
* 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)

47
gst-libs/gst/interfaces/propertyprobe.c
View file

@ -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 @@ gst_property_probe_iface_init (GstPropertyProbeInterface * iface)
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 @@ gst_property_probe_iface_init (GstPropertyProbeInterface * iface)
* 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 @@ gst_property_probe_get_properties (GstPropertyProbe * probe)
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_get_property (GstPropertyProbe * probe, const gchar * name)
return NULL;
}
/**
* 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 (GstPropertyProbe * probe,
/**
* gst_property_probe_probe_property_name:
* @probe: the #GstPropertyProbe to check.
* @name: name of the property to return.
* @name: name of the property.
*
* Runs a probe on the given property.
* Runs a probe on the property specified by %name.
*/
void
gst_property_probe_probe_property_name (GstPropertyProbe * probe,
const gchar * name)
@ -181,7 +212,6 @@ gst_property_probe_probe_property_name (GstPropertyProbe * probe,
*
* Returns: TRUE if the property needs a new probe, FALSE if not.
*/
gboolean
gst_property_probe_needs_probe (GstPropertyProbe * probe,
const GParamSpec * pspec)
@ -208,7 +238,6 @@ gst_property_probe_needs_probe (GstPropertyProbe * probe,
*
* Returns: TRUE if the property needs a new probe, FALSE if not.
*/
gboolean
gst_property_probe_needs_probe_name (GstPropertyProbe * probe,
const gchar * name)
@ -237,7 +266,6 @@ gst_property_probe_needs_probe_name (GstPropertyProbe * probe,
*
* Returns: A list of valid values for the given property.
*/
GValueArray *
gst_property_probe_get_values (GstPropertyProbe * probe,
const GParamSpec * pspec)
@ -264,7 +292,6 @@ gst_property_probe_get_values (GstPropertyProbe * probe,
*
* Returns: A list of valid values for the given property.
*/
GValueArray *
gst_property_probe_get_values_name (GstPropertyProbe * probe,
const gchar * name)
@ -294,7 +321,6 @@ gst_property_probe_get_values_name (GstPropertyProbe * probe,
*
* Returns: the list of valid values for this property.
*/
GValueArray *
gst_property_probe_probe_and_get_values (GstPropertyProbe * probe,
const GParamSpec * pspec)
@ -321,7 +347,6 @@ gst_property_probe_probe_and_get_values (GstPropertyProbe * probe,
*
* Returns: the list of valid values for this property.
*/
GValueArray *
gst_property_probe_probe_and_get_values_name (GstPropertyProbe * probe,
const gchar * name)