codecs: Add/fix various annotations

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3194>
This commit is contained in:
Sebastian Dröge 2022-10-17 10:47:02 +03:00
parent 3d528b25d1
commit f821ddc108
5 changed files with 10 additions and 10 deletions

View file

@ -3260,7 +3260,7 @@ gst_h264_decoder_set_process_ref_pic_lists (GstH264Decoder * decoder,
* Retrive DPB and return a #GstH264Picture corresponding to * Retrive DPB and return a #GstH264Picture corresponding to
* the @system_frame_number * 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 * Since: 1.18
*/ */

View file

@ -66,7 +66,7 @@ gst_h264_picture_new (void)
/** /**
* gst_h264_picture_set_user_data: * gst_h264_picture_set_user_data:
* @picture: a #GstH264Picture * @picture: a #GstH264Picture
* @user_data: private data * @user_data: (nullable): private data
* @notify: (closure user_data): a #GDestroyNotify * @notify: (closure user_data): a #GDestroyNotify
* *
* Sets @user_data on the picture and the #GDestroyNotify that will be called when * 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 * Gets private data set on the picture via
* gst_h264_picture_set_user_data() previously. * 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 gpointer
gst_h264_picture_get_user_data (GstH264Picture * picture) 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 * 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 * GstH264Picture *
gst_h264_dpb_get_lowest_frame_num_short_ref (GstH264Dpb * dpb) 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 * @dpb: a #GstH264Dpb
* @system_frame_number The system frame number * @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 * @system_frame_number, or %NULL if DPB does not contain a #GstH264Picture
* corresponding to the @system_frame_number * corresponding to the @system_frame_number
* *

View file

@ -2043,7 +2043,7 @@ gst_h265_decoder_set_process_ref_pic_lists (GstH265Decoder * decoder,
* Retrive DPB and return a #GstH265Picture corresponding to * Retrive DPB and return a #GstH265Picture corresponding to
* the @system_frame_number * 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 * Since: 1.20
*/ */

View file

@ -67,7 +67,7 @@ gst_h265_picture_new (void)
/** /**
* gst_h265_picture_set_user_data: * gst_h265_picture_set_user_data:
* @picture: a #GstH265Picture * @picture: a #GstH265Picture
* @user_data: private data * @user_data: (nullable): private data
* @notify: (closure user_data): a #GDestroyNotify * @notify: (closure user_data): a #GDestroyNotify
* *
* Sets @user_data on the picture and the #GDestroyNotify that will be called when * 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 * Gets private data set on the picture via
* gst_h265_picture_set_user_data() previously. * 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 gpointer
gst_h265_picture_get_user_data (GstH265Picture * picture) gst_h265_picture_get_user_data (GstH265Picture * picture)
@ -454,7 +454,7 @@ gst_h265_dpb_get_size (GstH265Dpb * dpb)
* @dpb: a #GstH265Dpb * @dpb: a #GstH265Dpb
* @system_frame_number The system frame number * @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 * @system_frame_number, or %NULL if DPB does not contain a #GstH265Picture
* corresponding to the @system_frame_number * corresponding to the @system_frame_number
* *

View file

@ -113,7 +113,7 @@ struct _GstVp9DecoderClass
* current #GstVideoCodecFrame without additional processing for the current * current #GstVideoCodecFrame without additional processing for the current
* frame. * 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. * @picture.
* *
* Since: 1.18 * Since: 1.18