From e3be532d7e0c3655d4536558a8f333f2093be4b5 Mon Sep 17 00:00:00 2001 From: Brad Hards Date: Mon, 18 Nov 2024 20:51:56 +1100 Subject: [PATCH] properties: update doxygen comments --- libheif/api/libheif/heif_properties.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/libheif/api/libheif/heif_properties.h b/libheif/api/libheif/heif_properties.h index 9acb88ed90..99acfed755 100644 --- a/libheif/api/libheif/heif_properties.h +++ b/libheif/api/libheif/heif_properties.h @@ -135,7 +135,7 @@ void heif_item_get_property_transform_crop_borders(const struct heif_context* co int* left, int* top, int* right, int* bottom); /** - * @param context + * @param context The heif_context for the file * @param itemId The image item id to which this property belongs. * @param fourcc_type The short four-cc type of the property to add. * @param uuid_type If fourcc_type=='uuid', this should point to a 16-byte UUID type. It is ignored otherwise and can be NULL. @@ -160,7 +160,7 @@ struct heif_error heif_item_get_property_raw_size(const struct heif_context* con size_t* out_size); /** - * @param data_out User-supplied array to write the property data to. The required size of the output array is given by heif_item_get_property_raw_size(). + * @param out_data User-supplied array to write the property data to. The required size of the output array is given by heif_item_get_property_raw_size(). */ LIBHEIF_API struct heif_error heif_item_get_property_raw_data(const struct heif_context* context, @@ -177,8 +177,8 @@ struct heif_error heif_item_get_property_raw_data(const struct heif_context* con * * @param context the heif_context containing the HEIF file * @param itemId the image item id to which this property belongs. - * @param propertyID the property index (1-based) to get the extended type for - * @param extended_type output of the call, must be a pointer to at least 16-bytes. + * @param propertyId the property index (1-based) to get the extended type for + * @param out_extended_type output of the call, must be a pointer to at least 16-bytes. * @return heif_error_success or an error indicating the failure */ LIBHEIF_API