From 5b4f2ba20bd8d31a3bed67b072755a6405d9ba42 Mon Sep 17 00:00:00 2001 From: Sebastian Rasmussen Date: Sun, 2 Mar 2014 05:06:07 +0100 Subject: [PATCH] docs: Fix argument and annotation typos * colorbalance: Fix misspelled annotation * rtsp: Replace incorrectly documented function argument * sdp: Escape @ character to avoid gtk-doc warning * video-*: Add missing annotation colon * videodecoder/video-color: Fix function argument typos * videoutils: Remove unknown annotation field Fixes https://bugzilla.gnome.org/show_bug.cgi?id=725521 --- gst-libs/gst/rtsp/gstrtsptransport.c | 2 +- gst-libs/gst/sdp/gstsdpmessage.c | 2 +- gst-libs/gst/video/colorbalance.c | 2 +- gst-libs/gst/video/gstvideodecoder.h | 2 +- gst-libs/gst/video/gstvideoutils.h | 4 ++-- gst-libs/gst/video/navigation.c | 4 ++-- gst-libs/gst/video/video-color.c | 4 ++-- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/gst-libs/gst/rtsp/gstrtsptransport.c b/gst-libs/gst/rtsp/gstrtsptransport.c index 2d9d75e57b..08a4e667ec 100644 --- a/gst-libs/gst/rtsp/gstrtsptransport.c +++ b/gst-libs/gst/rtsp/gstrtsptransport.c @@ -273,7 +273,7 @@ gst_rtsp_transport_get_mime (GstRTSPTransMode trans, const gchar ** mime) /** * gst_rtsp_transport_get_media_type: * @transport: a #GstRTSPTransport - * @mime: location to hold the result + * @media_type: media type of @transport * * Get the media type of @transport. This media type is typically * used to generate #GstCaps events. diff --git a/gst-libs/gst/sdp/gstsdpmessage.c b/gst-libs/gst/sdp/gstsdpmessage.c index 3f5c2e8aa3..5582ab755e 100644 --- a/gst-libs/gst/sdp/gstsdpmessage.c +++ b/gst-libs/gst/sdp/gstsdpmessage.c @@ -692,7 +692,7 @@ static const gchar hex[16] = "0123456789ABCDEF"; * * Creates a uri from @msg with the given @scheme. The uri has the format: * - * @scheme:///[#type=value *[&type=value]] + * \@scheme:///[#type=value *[&type=value]] * * Where each value is url encoded. * diff --git a/gst-libs/gst/video/colorbalance.c b/gst-libs/gst/video/colorbalance.c index a0adacf098..b149a7f18e 100644 --- a/gst-libs/gst/video/colorbalance.c +++ b/gst-libs/gst/video/colorbalance.c @@ -117,7 +117,7 @@ gst_color_balance_base_init (GstColorBalanceInterface * iface) * * Retrieve a list of the available channels. * - * Returns: (element-type GstColorBalanceChannel) (tranfer none): A + * Returns: (element-type GstColorBalanceChannel) (transfer none): A * GList containing pointers to #GstColorBalanceChannel * objects. The list is owned by the #GstColorBalance * instance and must not be freed. diff --git a/gst-libs/gst/video/gstvideodecoder.h b/gst-libs/gst/video/gstvideodecoder.h index f3724b320c..b41ca30b23 100644 --- a/gst-libs/gst/video/gstvideodecoder.h +++ b/gst-libs/gst/video/gstvideodecoder.h @@ -392,7 +392,7 @@ GstFlowReturn gst_video_decoder_drop_frame (GstVideoDecoder *dec, void gst_video_decoder_release_frame (GstVideoDecoder * dec, GstVideoCodecFrame * frame); -void gst_video_decoder_merge_tags (GstVideoDecoder *dec, +void gst_video_decoder_merge_tags (GstVideoDecoder *decoder, const GstTagList *tags, GstTagMergeMode mode); diff --git a/gst-libs/gst/video/gstvideoutils.h b/gst-libs/gst/video/gstvideoutils.h index 1bbd010aee..6349b87455 100644 --- a/gst-libs/gst/video/gstvideoutils.h +++ b/gst-libs/gst/video/gstvideoutils.h @@ -42,8 +42,8 @@ typedef struct _GstVideoCodecFrame GstVideoCodecFrame; * GstVideoCodecState: * @info: The #GstVideoInfo describing the stream * @caps: The #GstCaps - * @codec_data: (optional) a #GstBuffer corresponding to the - * 'codec_data' field of a stream. + * @codec_data: a #GstBuffer corresponding to the + * 'codec_data' field of a stream, or NULL. * * Structure representing the state of an incoming or outgoing video * stream for encoders and decoders. diff --git a/gst-libs/gst/video/navigation.c b/gst-libs/gst/video/navigation.c index 90c4ce752f..2fc8836588 100644 --- a/gst-libs/gst/video/navigation.c +++ b/gst-libs/gst/video/navigation.c @@ -311,7 +311,7 @@ gst_navigation_query_set_commandsv (GstQuery * query, gint n_cmds, /** * gst_navigation_query_parse_commands_length: * @query: a #GstQuery - * @n_cmds: (out) the number of commands in this query. + * @n_cmds: (out): the number of commands in this query. * * Parse the number of commands in the #GstNavigation commands @query. * @@ -342,7 +342,7 @@ gst_navigation_query_parse_commands_length (GstQuery * query, guint * n_cmds) * gst_navigation_query_parse_commands_nth: * @query: a #GstQuery * @nth: the nth command to retrieve. - * @cmd: (out) a pointer to store the nth command into. + * @cmd: (out): a pointer to store the nth command into. * * Parse the #GstNavigation command query and retrieve the @nth command from * it into @cmd. If the list contains less elements than @nth, @cmd will be diff --git a/gst-libs/gst/video/video-color.c b/gst-libs/gst/video/video-color.c index 17272c5358..7a576d5de6 100644 --- a/gst-libs/gst/video/video-color.c +++ b/gst-libs/gst/video/video-color.c @@ -132,7 +132,7 @@ gst_video_colorimetry_to_string (GstVideoColorimetry * cinfo) /** * gst_video_colorimetry_matches: - * @info: a #GstVideoInfo + * @cinfo: a #GstVideoInfo * @color: a colorimetry string * * Check if the colorimetry information in @info matches that of the @@ -156,7 +156,7 @@ gst_video_colorimetry_matches (GstVideoColorimetry * cinfo, const gchar * color) * gst_video_color_range_offsets: * @range: a #GstVideoColorRange * @info: a #GstVideoFormatInfo - * @offsets: (out): output offsets + * @offset: (out): output offsets * @scale: (out): output scale * * Compute the offset and scale values for each component of @info. For each