From: Tim-Philipp Müller Date: Mon, 15 Mar 2010 23:46:39 +0000 (+0000) Subject: docs: more helper libraries docs fixes X-Git-Tag: RELEASE-0.10.29~113 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e8361510093e49f71b9c725b91d4be369883afee;p=platform%2Fupstream%2Fgst-plugins-base.git docs: more helper libraries docs fixes Quieten gtk-doc a bit more. --- diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt index add8550..ce30917 100644 --- a/docs/libs/gst-plugins-base-libs-sections.txt +++ b/docs/libs/gst-plugins-base-libs-sections.txt @@ -1362,6 +1362,7 @@ gst_rtp_buffer_list_set_timestamp gstrtspdefs gst/rtsp/gstrtspdefs.h GST_RTSP_CHECK +GstRTSPEvent GstRTSPResult GstRTSPFamily GstRTSPState @@ -1386,6 +1387,7 @@ gst_rtsp_find_method gst/rtsp/gstrtsptransport.h GstRTSPTransMode GstRTSPProfile +GstRTSPRange GstRTSPLowerTrans GstRTSPTransport gst_rtsp_transport_new diff --git a/gst-libs/gst/audio/audio.h b/gst-libs/gst/audio/audio.h index 12a12e0..43bf594 100644 --- a/gst-libs/gst/audio/audio.h +++ b/gst-libs/gst/audio/audio.h @@ -152,6 +152,12 @@ gboolean gst_audio_is_buffer_framed (GstPad* pad, GstBuffer* buf); /* functions useful for _getcaps functions */ /** * GstAudioFieldFlag: + * @GST_AUDIO_FIELD_RATE: add rate field to caps + * @GST_AUDIO_FIELD_CHANNELS: add channels field to caps + * @GST_AUDIO_FIELD_ENDIANNESS: add endianness field to caps + * @GST_AUDIO_FIELD_WIDTH: add width field to caps + * @GST_AUDIO_FIELD_DEPTH: add depth field to caps + * @GST_AUDIO_FIELD_SIGNED: add signed field to caps * * Do not use anymore. * diff --git a/gst-libs/gst/audio/multichannel.c b/gst-libs/gst/audio/multichannel.c index 7b319b8..bd26f1c 100644 --- a/gst-libs/gst/audio/multichannel.c +++ b/gst-libs/gst/audio/multichannel.c @@ -44,7 +44,7 @@ * * Either all or none of the channel positions are %GST_AUDIO_CHANNEL_POSITION_NONE. * - * %GST_AUDIO_CHANNEL_POSITION_FRONT_MONO and %GST_AUDIO_CHANNEL_POSITION_LEFT or %GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT don't appear together in the given positions. + * %GST_AUDIO_CHANNEL_POSITION_FRONT_MONO and %GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT or %GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT don't appear together in the given positions. * * * diff --git a/gst-libs/gst/audio/multichannel.h b/gst-libs/gst/audio/multichannel.h index 75dbf29..2d9685d 100644 --- a/gst-libs/gst/audio/multichannel.h +++ b/gst-libs/gst/audio/multichannel.h @@ -25,6 +25,24 @@ G_BEGIN_DECLS +/** + * GstAudioChannelPosition: + * @GST_AUDIO_CHANNEL_POSITION_FRONT_MONO: front mono + * @GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT: front left + * @GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT: front right + * @GST_AUDIO_CHANNEL_POSITION_REAR_CENTER: rear center + * @GST_AUDIO_CHANNEL_POSITION_REAR_LEFT: rear left + * @GST_AUDIO_CHANNEL_POSITION_REAR_RIGHT: rear right + * @GST_AUDIO_CHANNEL_POSITION_LFE: subwoofer + * @GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER: front center + * @GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER: front left of center + * @GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER: front right of center + * @GST_AUDIO_CHANNEL_POSITION_SIDE_LEFT: side left + * @GST_AUDIO_CHANNEL_POSITION_SIDE_RIGHT: side right + * @GST_AUDIO_CHANNEL_POSITION_NONE: used for position-less channels, e.g. + * from a sound card that records 1024 channels; mutually exclusive with + * any other channel position + */ typedef enum { GST_AUDIO_CHANNEL_POSITION_INVALID = -1, diff --git a/gst-libs/gst/interfaces/propertyprobe.c b/gst-libs/gst/interfaces/propertyprobe.c index fb896a1..64d0d39 100644 --- a/gst-libs/gst/interfaces/propertyprobe.c +++ b/gst-libs/gst/interfaces/propertyprobe.c @@ -165,7 +165,7 @@ gst_property_probe_get_property (GstPropertyProbe * probe, const gchar * name) * @probe: the #GstPropertyProbe to check. * @pspec: #GParamSpec of the property. * - * Runs a probe on the property specified by %pspec + * Runs a probe on the property specified by @pspec */ void gst_property_probe_probe_property (GstPropertyProbe * probe, @@ -188,7 +188,7 @@ gst_property_probe_probe_property (GstPropertyProbe * probe, * @probe: the #GstPropertyProbe to check. * @name: name of the property. * - * Runs a probe on the property specified by %name. + * Runs a probe on the property specified by @name. */ void gst_property_probe_probe_property_name (GstPropertyProbe * probe, diff --git a/gst-libs/gst/interfaces/tuner.c b/gst-libs/gst/interfaces/tuner.c index a7ba61a..2684517 100644 --- a/gst-libs/gst/interfaces/tuner.c +++ b/gst-libs/gst/interfaces/tuner.c @@ -338,7 +338,7 @@ gst_tuner_get_norm (GstTuner * tuner) /** * gst_tuner_set_frequency: - * @tuner: The #Gsttuner (a #GstElement) that owns the given channel. + * @tuner: The #GstTuner (a #GstElement) that owns the given channel. * @channel: The #GstTunerChannel to set the frequency on. * @frequency: The frequency to tune in to. * diff --git a/gst-libs/gst/pbutils/install-plugins.c b/gst-libs/gst/pbutils/install-plugins.c index 7ca19de..60a4263 100644 --- a/gst-libs/gst/pbutils/install-plugins.c +++ b/gst-libs/gst/pbutils/install-plugins.c @@ -88,7 +88,7 @@ * * * The application will then call gst_install_plugins_async(), passing a - * #NULL-terminated array of installer detail strings, and a function that + * NULL-terminated array of installer detail strings, and a function that * should be called when the installation of the plugins has finished * (successfully or not). Optionally, a #GstInstallPluginsContext created * with gst_install_plugins_context_new() may be passed as well. This way diff --git a/gst-libs/gst/rtp/gstrtpbuffer.c b/gst-libs/gst/rtp/gstrtpbuffer.c index b050b08..a11bf32 100644 --- a/gst-libs/gst/rtp/gstrtpbuffer.c +++ b/gst-libs/gst/rtp/gstrtpbuffer.c @@ -178,8 +178,8 @@ gst_rtp_buffer_new_copy_data (gpointer data, guint len) * @pad_len: the amount of padding * @csrc_count: the number of CSRC entries * - * Allocate a new #Gstbuffer with enough data to hold an RTP packet with @csrc_count CSRCs, - * a payload length of @payload_len and padding of @pad_len. + * Allocate a new #GstBuffer with enough data to hold an RTP packet with + * @csrc_count CSRCs, a payload length of @payload_len and padding of @pad_len. * All other RTP header fields will be set to 0/FALSE. * * Returns: A newly allocated buffer that can hold an RTP packet with given diff --git a/gst-libs/gst/rtsp/gstrtsptransport.h b/gst-libs/gst/rtsp/gstrtsptransport.h index 389abd9..71c1c5b 100644 --- a/gst-libs/gst/rtsp/gstrtsptransport.h +++ b/gst-libs/gst/rtsp/gstrtsptransport.h @@ -94,7 +94,7 @@ typedef enum { } GstRTSPLowerTrans; /** - * RTSPRange: + * GstRTSPRange: * @min: minimum value of the range * @max: maximum value of the range *