From 7b56da2c30226b6d9124b7c984098b9fc775f752 Mon Sep 17 00:00:00 2001 From: Minje Ahn Date: Fri, 13 Sep 2024 11:47:53 +0900 Subject: [PATCH] Improve API description Change-Id: Id0f22c80ad47da7f95eed6fff646dfc971725354 Signed-off-by: Minje Ahn --- include/media_content_type.h | 2 ++ include/media_folder.h | 2 ++ include/media_group.h | 14 +++++++++++--- include_product/media_content_type.h | 2 ++ include_product/media_folder.h | 2 ++ include_product/media_group.h | 14 +++++++++++--- 6 files changed, 30 insertions(+), 6 deletions(-) diff --git a/include/media_content_type.h b/include/media_content_type.h index f2969a1..2656c11 100644 --- a/include/media_content_type.h +++ b/include/media_content_type.h @@ -41,6 +41,8 @@ extern "C" { /** * @ingroup CAPI_MEDIA_CONTENT_MODULE * @brief Enumeration for the media file format. + * @details The content type is determined based on the mime type. \n + * This type can also be used in the condition of the media filter. * @since_tizen 2.3 * @remarks Since 4.0, #MEDIA_CONTENT_TYPE_OTHERS is related to the following feature:\n * %http://tizen.org/feature/content.scanning.others\n diff --git a/include/media_folder.h b/include/media_folder.h index b868cbf..2e3acee 100644 --- a/include/media_folder.h +++ b/include/media_folder.h @@ -96,6 +96,8 @@ int media_folder_foreach_folder_from_db(filter_h filter, media_folder_cb callbac /** * @brief Gets the count of media files for the passed @a filter in the given @a folder_id from the media database. + * @details This function gets count of media files associated with the given folder and + * meeting desired filter option. If @c NULL is passed to the @a filter, no filtering is applied. * @since_tizen 2.3 * * @param[in] folder_id The ID of the media folder diff --git a/include/media_group.h b/include/media_group.h index e9819ad..6f11802 100644 --- a/include/media_group.h +++ b/include/media_group.h @@ -40,7 +40,9 @@ extern "C" { */ /** - * @brief Gets the number of the album for the passed @a filter from the media database. + * @brief Gets the count of the album for the passed @a filter from the media database. + * @details This function gets the count of the album associated with the given filter option. \n + * If @c NULL is passed to the @a filter, no filtering is applied. * @since_tizen 2.3 * * @param[in] filter The handle to the media filter @@ -91,7 +93,9 @@ int media_album_get_album_count_from_db(filter_h filter, int *album_count); int media_album_foreach_album_from_db(filter_h filter, media_album_cb callback, void *user_data); /** - * @brief Gets the number of media info for the given album present in the media database. + * @brief Gets the count of the media for the passed @a filter in the given @a album_id from the media database. + * @details This function gets the count of the media associated with the given @a album_id and + * meeting desired filter option. If @c NULL is passed to the @a filter, no filtering is applied. * @since_tizen 2.3 * * @param[in] album_id The ID of the media album @@ -303,7 +307,9 @@ int media_album_get_album_from_db(int album_id, media_album_h *album); */ /** - * @brief Gets the number of the group for the passed @a filter from the media database. + * @brief Gets the count of the given group for the passed @a filter from the media database. + * @details This function gets the count of the group associated with the given group and + * meeting desired filter option. If @c NULL is passed to the @a filter, no filtering is applied. * @since_tizen 2.3 * * @param[in] filter The handle to the media filter @@ -357,6 +363,8 @@ int media_group_foreach_group_from_db(filter_h filter, media_group_e group, medi /** * @brief Gets the count of the media info for the given media group present in the media database. + * @details This function gets the count of the group associated with the given @a group and + * meeting desired @a filter option. If @c NULL is passed to the @a filter, no filtering is applied. * @since_tizen 2.3 * * @param[in] group_name The name of the media group diff --git a/include_product/media_content_type.h b/include_product/media_content_type.h index d307f3d..a67213c 100644 --- a/include_product/media_content_type.h +++ b/include_product/media_content_type.h @@ -41,6 +41,8 @@ extern "C" { /** * @ingroup CAPI_MEDIA_CONTENT_MODULE * @brief Enumeration for the media file format. + * @details The content type is determined based on the mime type. \n + * This type can also be used in the condition of the media filter. * @since_tizen 2.3 * @remarks Since 4.0, #MEDIA_CONTENT_TYPE_OTHERS is related to the following feature:\n * %http://tizen.org/feature/content.scanning.others\n diff --git a/include_product/media_folder.h b/include_product/media_folder.h index b868cbf..2e3acee 100644 --- a/include_product/media_folder.h +++ b/include_product/media_folder.h @@ -96,6 +96,8 @@ int media_folder_foreach_folder_from_db(filter_h filter, media_folder_cb callbac /** * @brief Gets the count of media files for the passed @a filter in the given @a folder_id from the media database. + * @details This function gets count of media files associated with the given folder and + * meeting desired filter option. If @c NULL is passed to the @a filter, no filtering is applied. * @since_tizen 2.3 * * @param[in] folder_id The ID of the media folder diff --git a/include_product/media_group.h b/include_product/media_group.h index e9819ad..6f11802 100644 --- a/include_product/media_group.h +++ b/include_product/media_group.h @@ -40,7 +40,9 @@ extern "C" { */ /** - * @brief Gets the number of the album for the passed @a filter from the media database. + * @brief Gets the count of the album for the passed @a filter from the media database. + * @details This function gets the count of the album associated with the given filter option. \n + * If @c NULL is passed to the @a filter, no filtering is applied. * @since_tizen 2.3 * * @param[in] filter The handle to the media filter @@ -91,7 +93,9 @@ int media_album_get_album_count_from_db(filter_h filter, int *album_count); int media_album_foreach_album_from_db(filter_h filter, media_album_cb callback, void *user_data); /** - * @brief Gets the number of media info for the given album present in the media database. + * @brief Gets the count of the media for the passed @a filter in the given @a album_id from the media database. + * @details This function gets the count of the media associated with the given @a album_id and + * meeting desired filter option. If @c NULL is passed to the @a filter, no filtering is applied. * @since_tizen 2.3 * * @param[in] album_id The ID of the media album @@ -303,7 +307,9 @@ int media_album_get_album_from_db(int album_id, media_album_h *album); */ /** - * @brief Gets the number of the group for the passed @a filter from the media database. + * @brief Gets the count of the given group for the passed @a filter from the media database. + * @details This function gets the count of the group associated with the given group and + * meeting desired filter option. If @c NULL is passed to the @a filter, no filtering is applied. * @since_tizen 2.3 * * @param[in] filter The handle to the media filter @@ -357,6 +363,8 @@ int media_group_foreach_group_from_db(filter_h filter, media_group_e group, medi /** * @brief Gets the count of the media info for the given media group present in the media database. + * @details This function gets the count of the group associated with the given @a group and + * meeting desired @a filter option. If @c NULL is passed to the @a filter, no filtering is applied. * @since_tizen 2.3 * * @param[in] group_name The name of the media group -- 2.7.4