mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-06-07 07:58:51 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Fix argument and annotation typos

Browse source 
* 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
This commit is contained in:
Sebastian Rasmussen 2014-03-02 05:06:07 +01:00 committed by Tim-Philipp Müller
parent 53aab8eefa
commit 5b4f2ba20b
7 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
gst-libs/gst/rtsp/gstrtsptransport.c
View file

@ -273,7 +273,7 @@ gst_rtsp_transport_get_mime (GstRTSPTransMode trans, const gchar ** mime)
/** /**
* gst_rtsp_transport_get_media_type: * gst_rtsp_transport_get_media_type:
* @transport: a #GstRTSPTransport * @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 * Get the media type of @transport. This media type is typically
* used to generate #GstCaps events. * used to generate #GstCaps events.

2
gst-libs/gst/sdp/gstsdpmessage.c
View file

@ -692,7 +692,7 @@ static const gchar hex[16] = "0123456789ABCDEF";
* *
* Creates a uri from @msg with the given @scheme. The uri has the format: * 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. * Where each value is url encoded.
* *

2
gst-libs/gst/video/colorbalance.c
View file

@ -117,7 +117,7 @@ gst_color_balance_base_init (GstColorBalanceInterface * iface)
* *
* Retrieve a list of the available channels. * 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 * GList containing pointers to #GstColorBalanceChannel
* objects. The list is owned by the #GstColorBalance * objects. The list is owned by the #GstColorBalance
* instance and must not be freed. * instance and must not be freed.

2
gst-libs/gst/video/gstvideodecoder.h
View file

@ -392,7 +392,7 @@ GstFlowReturn gst_video_decoder_drop_frame (GstVideoDecoder *dec,
void gst_video_decoder_release_frame (GstVideoDecoder * dec, void gst_video_decoder_release_frame (GstVideoDecoder * dec,
GstVideoCodecFrame * frame); GstVideoCodecFrame * frame);
void gst_video_decoder_merge_tags (GstVideoDecoder *dec, void gst_video_decoder_merge_tags (GstVideoDecoder *decoder,
const GstTagList *tags, const GstTagList *tags,
GstTagMergeMode mode); GstTagMergeMode mode);

4
gst-libs/gst/video/gstvideoutils.h
View file

@ -42,8 +42,8 @@ typedef struct _GstVideoCodecFrame GstVideoCodecFrame;
* GstVideoCodecState: * GstVideoCodecState:
* @info: The #GstVideoInfo describing the stream * @info: The #GstVideoInfo describing the stream
* @caps: The #GstCaps * @caps: The #GstCaps
* @codec_data: (optional) a #GstBuffer corresponding to the * @codec_data: a #GstBuffer corresponding to the
* 'codec_data' field of a stream. * 'codec_data' field of a stream, or NULL.
* *
* Structure representing the state of an incoming or outgoing video * Structure representing the state of an incoming or outgoing video
* stream for encoders and decoders. * stream for encoders and decoders.

4
gst-libs/gst/video/navigation.c
View file

@ -311,7 +311,7 @@ gst_navigation_query_set_commandsv (GstQuery * query, gint n_cmds,
/** /**
* gst_navigation_query_parse_commands_length: * gst_navigation_query_parse_commands_length:
* @query: a #GstQuery * @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. * 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: * gst_navigation_query_parse_commands_nth:
* @query: a #GstQuery * @query: a #GstQuery
* @nth: the nth command to retrieve. * @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 * 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 * it into @cmd. If the list contains less elements than @nth, @cmd will be

4
gst-libs/gst/video/video-color.c
View file

@ -132,7 +132,7 @@ gst_video_colorimetry_to_string (GstVideoColorimetry * cinfo)
/** /**
* gst_video_colorimetry_matches: * gst_video_colorimetry_matches:
* @info: a #GstVideoInfo * @cinfo: a #GstVideoInfo
* @color: a colorimetry string * @color: a colorimetry string
* *
* Check if the colorimetry information in @info matches that of the * 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: * gst_video_color_range_offsets:
* @range: a #GstVideoColorRange * @range: a #GstVideoColorRange
* @info: a #GstVideoFormatInfo * @info: a #GstVideoFormatInfo
* @offsets: (out): output offsets * @offset: (out): output offsets
* @scale: (out): output scale * @scale: (out): output scale
* *
* Compute the offset and scale values for each component of @info. For each * Compute the offset and scale values for each component of @info. For each