rtsp: fix some GIR annotations
authorMark Nauwelaerts <mnauw@users.sourceforge.net>
Fri, 20 Apr 2018 19:53:15 +0000 (21:53 +0200)
committerMark Nauwelaerts <mnauw@users.sourceforge.net>
Mon, 23 Apr 2018 17:33:17 +0000 (19:33 +0200)
Mostly related to out and array parameters.

gst-libs/gst/rtsp/gstrtspmessage.c
gst-libs/gst/rtsp/gstrtsprange.c
gst-libs/gst/rtsp/gstrtsptransport.c
gst-libs/gst/rtsp/gstrtspurl.c

index 06e60a1..67bdd49 100644 (file)
@@ -229,8 +229,8 @@ gst_rtsp_message_init_request (GstRTSPMessage * msg, GstRTSPMethod method,
  * gst_rtsp_message_parse_request:
  * @msg: a #GstRTSPMessage
  * @method: (out) (allow-none): location to hold the method
- * @uri: (out) (allow-none): location to hold the uri
- * @version: (out) (allow-none): location to hold the version
+ * @uri: (out) (allow-none) (transfer none): location to hold the uri
+ * @version: (out) (allow-none) (transfer none): location to hold the version
  *
  * Parse the request message @msg and store the values @method, @uri and
  * @version. The result locations can be %NULL if one is not interested in its
@@ -363,8 +363,8 @@ gst_rtsp_message_init_response (GstRTSPMessage * msg, GstRTSPStatusCode code,
  * gst_rtsp_message_parse_response:
  * @msg: a #GstRTSPMessage
  * @code: (out) (allow-none): location to hold the status code
- * @reason: (out) (allow-none): location to hold the status reason
- * @version: (out) (allow-none): location to hold the version
+ * @reason: (out) (allow-none) (transfer none): location to hold the status reason
+ * @version: (out) (allow-none) (transfer none): location to hold the version
  *
  * Parse the response message @msg and store the values @code, @reason and
  * @version. The result locations can be %NULL if one is not interested in its
@@ -1277,7 +1277,8 @@ parse_auth_credentials (GPtrArray * auth_credentials, const gchar * header,
  *
  * Parses the credentials given in a WWW-Authenticate or Authorization header.
  *
- * Returns: %NULL-terminated array of GstRTSPAuthCredential or %NULL.
+ * Returns: (array zero-terminated=1):
+ *     %NULL-terminated array of GstRTSPAuthCredential or %NULL.
  *
  * Since: 1.12
  */
index 33be288..624fc71 100644 (file)
@@ -254,7 +254,7 @@ done:
 /**
  * gst_rtsp_range_parse:
  * @rangestr: a range string to parse
- * @range: location to hold the #GstRTSPTimeRange result
+ * @range: (out): location to hold the #GstRTSPTimeRange result
  *
  * Parse @rangestr to a #GstRTSPTimeRange.
  *
@@ -562,8 +562,8 @@ get_time (GstRTSPRangeUnit unit, const GstRTSPTime * t1,
 /**
  * gst_rtsp_range_get_times:
  * @range: a #GstRTSPTimeRange
- * @min: result minimum #GstClockTime
- * @max: result maximum #GstClockTime
+ * @min: (out): result minimum #GstClockTime
+ * @max: (out): result maximum #GstClockTime
  *
  * Retrieve the minimum and maximum values from @range converted to
  * #GstClockTime in @min and @max.
index 4cf0b29..6de88a2 100644 (file)
@@ -276,7 +276,7 @@ get_default_lower_trans (GstRTSPTransport * transport)
 /**
  * gst_rtsp_transport_get_manager:
  * @trans: a #GstRTSPTransMode
- * @manager: location to hold the result
+ * @manager: (out) (nullable) (transfer none): location to hold the result
  * @option: option index.
  *
  * Get the #GstElement that can handle the buffers transported over @trans.
index 12be279..9ae15ca 100644 (file)
@@ -284,7 +284,7 @@ gst_rtsp_url_set_port (GstRTSPUrl * url, guint16 port)
 /**
  * gst_rtsp_url_get_port:
  * @url: a #GstRTSPUrl
- * @port: location to hold the port
+ * @port: (out): location to hold the port
  *
  * Get the port number of @url.
  *