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

gst-libs/gst/video/gstvideometa.c
gst-libs/gst/video/video-anc.c
gst-libs/gst/video/video-color.c
gst-libs/gst/video/video-event.c
gst-libs/gst/video/video-info.c
gst-libs/gst/video/videoorientation.c

index 9b67ea2..c21a468 100644 (file)
@@ -342,8 +342,8 @@ gst_buffer_add_video_meta_full (GstBuffer * buffer,
  * @meta: a #GstVideoMeta
  * @plane: a plane
  * @info: a #GstMapInfo
- * @data: the data of @plane
- * @stride: the stride of @plane
+ * @data: (out): the data of @plane
+ * @stride: (out): the stride of @plane
  * @flags: @GstMapFlags
  *
  * Map the video plane with index @plane in @meta and return a pointer to the
index 32d075e..f3ae278 100644 (file)
@@ -389,7 +389,7 @@ convert_line_v210 (GstVideoVBIParser * parser, const guint8 * data)
 /**
  * gst_video_vbi_parser_add_line:
  * @parser: a #GstVideoVBIParser
- * @data: (transfer none): The line of data to parse
+ * @data: (array) (transfer none): The line of data to parse
  *
  * Provide a new line of data to the @parser. Call gst_video_vbi_parser_get_ancillary()
  * to get the Ancillary data that might be present on that line.
index d3a3e4d..6740207 100644 (file)
@@ -187,8 +187,8 @@ gst_video_colorimetry_matches (const GstVideoColorimetry * cinfo,
  * gst_video_color_range_offsets:
  * @range: a #GstVideoColorRange
  * @info: a #GstVideoFormatInfo
- * @offset: (out): output offsets
- * @scale: (out): output scale
+ * @offset: (out) (array fixed-size=4): output offsets
+ * @scale: (out) (array fixed-size=4): output scale
  *
  * Compute the offset and scale values for each component of @info. For each
  * component, (c[i] - offset[i]) / scale[i] will scale the component c[i] to the
@@ -310,8 +310,8 @@ gst_video_color_primaries_get_info (GstVideoColorPrimaries primaries)
 /**
  * gst_video_color_matrix_get_Kr_Kb:
  * @matrix: a #GstVideoColorMatrix
- * @Kr: result red channel coefficient
- * @Kb: result blue channel coefficient
+ * @Kr: (out): result red channel coefficient
+ * @Kb: (out): result blue channel coefficient
  *
  * Get the coefficients used to convert between Y'PbPr and R'G'B' using @matrix.
  *
index faf7adb..0cbd400 100644 (file)
@@ -52,7 +52,8 @@ gst_video_event_new_still_frame (gboolean in_still)
 /**
  * gst_video_event_parse_still_frame:
  * @event: A #GstEvent to parse
- * @in_still: A boolean to receive the still-frame status from the event, or NULL
+ * @in_still: (out):
+ *     A boolean to receive the still-frame status from the event, or NULL
  *
  * Parse a #GstEvent, identify if it is a Still Frame event, and
  * return the still-frame state from the event if it is.
index fb70ad3..25f7027 100644 (file)
@@ -1046,7 +1046,7 @@ fill_planes (GstVideoInfo * info)
  * @src_format: #GstFormat of the @src_value
  * @src_value: value to convert
  * @dest_format: #GstFormat of the @dest_value
- * @dest_value: pointer to destination value
+ * @dest_value: (out): pointer to destination value
  *
  * Converts among various #GstFormat types.  This function handles
  * GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT.  For
index 6ef407e..31c75e7 100644 (file)
@@ -62,7 +62,7 @@ G_DEFINE_INTERFACE (GstVideoOrientation, gst_video_orientation, 0)
 /**
  * gst_video_orientation_get_hflip:
  * @video_orientation: #GstVideoOrientation interface of a #GstElement
- * @flip: return location for the result
+ * @flip: (out): return location for the result
  *
  * Get the horizontal flipping state (%TRUE for flipped) from the given object.
  * Returns: %TRUE in case the element supports flipping
@@ -83,7 +83,7 @@ gst_video_orientation_get_hflip (GstVideoOrientation * video_orientation,
 /**
  * gst_video_orientation_get_vflip:
  * @video_orientation: #GstVideoOrientation interface of a #GstElement
- * @flip: return location for the result
+ * @flip: (out): return location for the result
  *
  * Get the vertical flipping state (%TRUE for flipped) from the given object.
  * Returns: %TRUE in case the element supports flipping
@@ -104,7 +104,7 @@ gst_video_orientation_get_vflip (GstVideoOrientation * video_orientation,
 /**
  * gst_video_orientation_get_hcenter:
  * @video_orientation: #GstVideoOrientation interface of a #GstElement
- * @center: return location for the result
+ * @center: (out): return location for the result
  *
  * Get the horizontal centering offset from the given object.
  * Returns: %TRUE in case the element supports centering
@@ -125,7 +125,7 @@ gst_video_orientation_get_hcenter (GstVideoOrientation * video_orientation,
 /**
  * gst_video_orientation_get_vcenter:
  * @video_orientation: #GstVideoOrientation interface of a #GstElement
- * @center: return location for the result
+ * @center: (out): return location for the result
  *
  * Get the vertical centering offset from the given object.
  * Returns: %TRUE in case the element supports centering