codecs: Add/fix various annotations
authorSebastian Dröge <sebastian@centricular.com>
Mon, 17 Oct 2022 07:47:02 +0000 (10:47 +0300)
committerSebastian Dröge <sebastian@centricular.com>
Tue, 18 Oct 2022 10:51:17 +0000 (13:51 +0300)
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3194>

subprojects/gst-plugins-bad/gst-libs/gst/codecs/gsth264decoder.c
subprojects/gst-plugins-bad/gst-libs/gst/codecs/gsth264picture.c
subprojects/gst-plugins-bad/gst-libs/gst/codecs/gsth265decoder.c
subprojects/gst-plugins-bad/gst-libs/gst/codecs/gsth265picture.c
subprojects/gst-plugins-bad/gst-libs/gst/codecs/gstvp9decoder.h

index 0429ff6..7afe50b 100644 (file)
@@ -3260,7 +3260,7 @@ gst_h264_decoder_set_process_ref_pic_lists (GstH264Decoder * decoder,
  * Retrive DPB and return a #GstH264Picture corresponding to
  * the @system_frame_number
  *
- * Returns: (transfer full): a #GstH264Picture if successful, or %NULL otherwise
+ * Returns: (transfer full) (nullable): a #GstH264Picture if successful, or %NULL otherwise
  *
  * Since: 1.18
  */
index 1670732..abb4bfb 100644 (file)
@@ -66,7 +66,7 @@ gst_h264_picture_new (void)
 /**
  * gst_h264_picture_set_user_data:
  * @picture: a #GstH264Picture
- * @user_data: private data
+ * @user_data: (nullable): private data
  * @notify: (closure user_data): a #GDestroyNotify
  *
  * Sets @user_data on the picture and the #GDestroyNotify that will be called when
@@ -95,7 +95,7 @@ gst_h264_picture_set_user_data (GstH264Picture * picture, gpointer user_data,
  * Gets private data set on the picture via
  * gst_h264_picture_set_user_data() previously.
  *
- * Returns: (transfer none): The previously set user_data
+ * Returns: (transfer none) (nullable): The previously set user_data
  */
 gpointer
 gst_h264_picture_get_user_data (GstH264Picture * picture)
@@ -461,7 +461,7 @@ gst_h264_dpb_get_long_ref_by_long_term_pic_num (GstH264Dpb * dpb,
  *
  * Find a short term reference picture which has the lowest frame_num_wrap
  *
- * Returns: (transfer full): a #GstH264Picture
+ * Returns: (transfer full) (nullable): a #GstH264Picture
  */
 GstH264Picture *
 gst_h264_dpb_get_lowest_frame_num_short_ref (GstH264Dpb * dpb)
@@ -593,7 +593,7 @@ gst_h264_dpb_get_size (GstH264Dpb * dpb)
  * @dpb: a #GstH264Dpb
  * @system_frame_number The system frame number
  *
- * Returns: (transfer full): the picture identified with the specified
+ * Returns: (transfer full) (nullable): the picture identified with the specified
  * @system_frame_number, or %NULL if DPB does not contain a #GstH264Picture
  * corresponding to the @system_frame_number
  *
index b6da21f..3b7757c 100644 (file)
@@ -2043,7 +2043,7 @@ gst_h265_decoder_set_process_ref_pic_lists (GstH265Decoder * decoder,
  * Retrive DPB and return a #GstH265Picture corresponding to
  * the @system_frame_number
  *
- * Returns: (transfer full): a #GstH265Picture if successful, or %NULL otherwise
+ * Returns: (transfer full) (nullable): a #GstH265Picture if successful, or %NULL otherwise
  *
  * Since: 1.20
  */
index fee8a2a..995e4f9 100644 (file)
@@ -67,7 +67,7 @@ gst_h265_picture_new (void)
 /**
  * gst_h265_picture_set_user_data:
  * @picture: a #GstH265Picture
- * @user_data: private data
+ * @user_data: (nullable): private data
  * @notify: (closure user_data): a #GDestroyNotify
  *
  * Sets @user_data on the picture and the #GDestroyNotify that will be called when
@@ -96,7 +96,7 @@ gst_h265_picture_set_user_data (GstH265Picture * picture, gpointer user_data,
  * Gets private data set on the picture via
  * gst_h265_picture_set_user_data() previously.
  *
- * Returns: (transfer none): The previously set user_data
+ * Returns: (transfer none) (nullable): The previously set user_data
  */
 gpointer
 gst_h265_picture_get_user_data (GstH265Picture * picture)
@@ -454,7 +454,7 @@ gst_h265_dpb_get_size (GstH265Dpb * dpb)
  * @dpb: a #GstH265Dpb
  * @system_frame_number The system frame number
  *
- * Returns: (transfer full): the picture identified with the specified
+ * Returns: (transfer full) (nullable): the picture identified with the specified
  * @system_frame_number, or %NULL if DPB does not contain a #GstH265Picture
  * corresponding to the @system_frame_number
  *
index d68cb4a..1a6a79f 100644 (file)
@@ -113,7 +113,7 @@ struct _GstVp9DecoderClass
    * current #GstVideoCodecFrame without additional processing for the current
    * frame.
    *
-   * Returns: (transfer full): a #GstVp9Picture or %NULL if failed to duplicate
+   * Returns: (transfer full) (nullable): a #GstVp9Picture or %NULL if failed to duplicate
    * @picture.
    *
    * Since: 1.18