mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-03 13:02:29 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Add annotations for return values

Browse source 
Rephrase and clarify some return value descriptions

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=725521
This commit is contained in:
Sebastian Rasmussen 2014-03-02 12:54:08 +01:00 committed by Tim-Philipp Müller
parent 5b4f2ba20b
commit 35bb1b3328
4 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
gst-libs/gst/rtsp/gstrtspconnection.c
View file

@ -2751,8 +2751,8 @@ gst_rtsp_connection_set_ip (GstRTSPConnection * conn, const gchar * ip)
* *
* Get the file descriptor for reading. * Get the file descriptor for reading.
* *
* Returns: the file descriptor used for reading or %NULL on error. The file * Returns: (transfer none): the file descriptor used for reading or %NULL on
* descriptor remains valid until the connection is closed. * error. The file descriptor remains valid until the connection is closed.
*/ */
GSocket * GSocket *
gst_rtsp_connection_get_read_socket (const GstRTSPConnection * conn) gst_rtsp_connection_get_read_socket (const GstRTSPConnection * conn)
@ -2769,8 +2769,8 @@ gst_rtsp_connection_get_read_socket (const GstRTSPConnection * conn)
* *
* Get the file descriptor for writing. * Get the file descriptor for writing.
* *
* Returns: the file descriptor used for writing or NULL on error. The file * Returns: (transfer none): the file descriptor used for writing or NULL on
* descriptor remains valid until the connection is closed. * error. The file descriptor remains valid until the connection is closed.
*/ */
GSocket * GSocket *
gst_rtsp_connection_get_write_socket (const GstRTSPConnection * conn) gst_rtsp_connection_get_write_socket (const GstRTSPConnection * conn)

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
* @media_type: media type of @transport * @media_type: (out): 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.

3
gst-libs/gst/rtsp/gstrtspurl.c
View file

@ -393,7 +393,8 @@ unescape_path_component (gchar * comp)
* Also note that since paths usually start with a slash, the first component * Also note that since paths usually start with a slash, the first component
* will usually be the empty string. * will usually be the empty string.
* *
* Returns: a string vector. g_strfreev() after usage. * Returns: (transfer full): %NULL-terminated array of URL components. Free with
* g_strfreev() when no longer needed.
*/ */
gchar ** gchar **
gst_rtsp_url_decode_path_components (const GstRTSPUrl * url) gst_rtsp_url_decode_path_components (const GstRTSPUrl * url)

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

@ -2776,8 +2776,8 @@ gst_video_format_get_info (GstVideoFormat format)
* Get the default palette of @format. This the palette used in the pack * Get the default palette of @format. This the palette used in the pack
* function for paletted formats. * function for paletted formats.
* *
* Returns: the default palette of @format or %NULL when @format does not have a * Returns: (transfer none): the default palette of @format or %NULL when
* palette. * @format does not have a palette.
* *
* Since: 1.2 * Since: 1.2
*/ */