base: fix some GIR annotations
authorMark Nauwelaerts <mnauw@users.sourceforge.net>
Fri, 13 Apr 2018 18:15:46 +0000 (20:15 +0200)
committerMark Nauwelaerts <mnauw@users.sourceforge.net>
Fri, 13 Apr 2018 18:16:45 +0000 (20:16 +0200)
Mostly related to out parameters and their transfer

libs/gst/base/gstbaseparse.c
libs/gst/base/gstbytereader.c
libs/gst/base/gstbytewriter.c
libs/gst/base/gstcollectpads.c
libs/gst/base/gstcollectpads.h
libs/gst/base/gsttypefindhelper.c
libs/gst/base/gsttypefindhelper.h

index 99283b8..8ac6a3f 100644 (file)
@@ -1649,7 +1649,7 @@ gst_base_parse_src_event_default (GstBaseParse * parse, GstEvent * event)
  * @src_format: #GstFormat describing the source format.
  * @src_value: Source value to be converted.
  * @dest_format: #GstFormat defining the converted format.
- * @dest_value: Pointer where the conversion result will be put.
+ * @dest_value: (out): Pointer where the conversion result will be put.
  *
  * Default implementation of "convert" vmethod in #GstBaseParse class.
  *
index 0045ce9..72f720a 100644 (file)
@@ -954,7 +954,7 @@ gst_byte_reader_masked_scan_uint32 (const GstByteReader * reader, guint32 mask,
  * @offset: offset from which to start scanning, relative to the current
  *     position
  * @size: number of bytes to scan from offset
- * @value: pointer to uint32 to return matching data
+ * @value: (out): pointer to uint32 to return matching data
  *
  * Scan for pattern @pattern with applied mask @mask in the byte reader data,
  * starting from offset @offset relative to the current position.
index 72364fc..705a35e 100644 (file)
@@ -624,8 +624,7 @@ CREATE_WRITE_STRING_FUNC (32, guint32);
 /**
  * gst_byte_writer_put_string_utf8:
  * @writer: #GstByteWriter instance
- * @data: (transfer none) (array zero-terminated=1) (type utf8): UTF8 string to
- *     write
+ * @data: (transfer none): UTF8 string to write
  *
  * Writes a NUL-terminated UTF8 string to @writer (including the terminator).
  *
index 7afe1db..13fe2e1 100644 (file)
@@ -482,7 +482,7 @@ gst_collect_pads_set_query_function (GstCollectPads * pads,
 * @pads: the collectpads to use
 * @cdata: collect data of corresponding pad
 * @buf: buffer being clipped
-* @outbuf: (allow-none): output buffer with running time, or NULL if clipped
+* @outbuf: (allow-none) (out): output buffer with running time, or NULL if clipped
 * @user_data: user data (unused)
 *
 * Convenience clipping function that converts incoming buffer's timestamp
index b843d5b..156e445 100644 (file)
@@ -253,7 +253,7 @@ typedef gboolean (*GstCollectPadsQueryFunction)        (GstCollectPads *pads, Gs
  * @pads: a #GstCollectPads
  * @data: a #GstCollectData
  * @inbuffer: (transfer full): the input #GstBuffer
- * @outbuffer: the output #GstBuffer
+ * @outbuffer: (out): the output #GstBuffer
  * @user_data: user data
  *
  * A function that will be called when @inbuffer is received on the pad managed
index 1b38325..1723f34 100644 (file)
@@ -493,8 +493,8 @@ buf_helper_find_suggest (gpointer data, guint probability, GstCaps * caps)
 /**
  * gst_type_find_helper_for_data:
  * @obj: (allow-none): object doing the typefinding, or %NULL (used for logging)
- * @data: (in) (transfer none): a pointer with data to typefind
- * @size: (in): the size of @data
+ * @data: (transfer none) (array length=size): * a pointer with data to typefind
+ * @size: the size of @data
  * @prob: (out) (allow-none): location to store the probability of the found
  *     caps, or %NULL
  *
index d350277..6f032ca 100644 (file)
@@ -51,7 +51,7 @@ GstCaps * gst_type_find_helper_for_extension (GstObject * obj,
  * @parent: (allow-none): the parent of @obj or %NULL
  * @offset: the offset of the range
  * @length: the length of the range
- * @buffer: a memory location to hold the result buffer
+ * @buffer: (out): a memory location to hold the result buffer
  *
  * This function will be called by gst_type_find_helper_get_range() when
  * typefinding functions request to peek at the data of a stream at certain