Fix description

[platform/core/api/media-content.git] / include / media_info.h

diff --git a/include/media_info.h b/include/media_info.h
index 18a82a5..c7d081f 100755 (executable)
--- a/include/media_info.h
+++ b/include/media_info.h
@@ -43,7 +43,10 @@ extern "C" {
 /**
  * @brief  Inserts the content file into the media database.
  * @details In general, you can use this function to insert content files into the media database. \n
- *                You can use media_content_scan_file()/media_content_scan_folder() function instead of this function.
+ *          You can use media_content_scan_file()/media_content_scan_folder() function instead of this function. \n
+ *          If media information exists in the media database, this function returns information stored in the database.\n
+ *          Since 5.5, if media information already exists in the media database,
+ *          this function returns the updated latest information. (Media database will be updated if necessary).
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
@@ -53,14 +56,14 @@ extern "C" {
  *                   %http://tizen.org/privilege/externalstorage
  *
  * @remarks The @a info should be released using media_info_destroy(). \n
- *                   You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
+ *                   You must add the privilege http://tizen.org/privilege/content.write. You need to add more privileges depending on your choice of contents path. \n
  *                   If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
- *                   Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
- *                   If you can access both storage, you must add all privilege. \n
- *                   Since 4.0, This function does not allow a symbolic link. \n
+ *                   If you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ *                   If you want to access storages of both types, you must add all privileges. \n
+ *                   Since 4.0, this function does not accept symbolic links. \n
  * @remarks Since 4.0, this function is related to the following feature:\n
  *              %http://tizen.org/feature/content.scanning.others\n
- *              If this feature is not supported on the device, MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
+ *              If this feature is not supported on the device, #MEDIA_CONTENT_TYPE_OTHERS type files are not scanned.
  *
  * @param[in] path The path of the content file to add
  * @param[out] info The handle of the inserted content file
@@ -1039,7 +1042,7 @@ int media_info_create_thumbnail(media_info_h media, media_thumbnail_completed_cb
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
  *
- * @remarks If you request cancel for the already thumbnail created media, this function return MEDIA_CONTENT_ERROR_INVALID_OPERATION
+ * @remarks If you request cancel for the already thumbnail created media, this function returns #MEDIA_CONTENT_ERROR_INVALID_OPERATION
  *
  * @param[in] media The handle to the media info
  *
@@ -1094,7 +1097,8 @@ int media_info_generate_thumbnail(media_info_h media);
  * @brief Starts face detection for the given image, asynchronously.
  * @details This function detects faces for given image item and calls the given callback function when the detection is completed. \n
  *          The given callback function is called when the detection is completed. \n
- *          To obtain the detected faces, call the media_info_foreach_face_from_db() function.
+ *          To obtain the detected faces, call the media_info_foreach_face_from_db() function. \n
+ *          Supported image formats are jpg, png, and bmp.
  *
  * @since_tizen 3.0
  *
@@ -1103,9 +1107,10 @@ int media_info_generate_thumbnail(media_info_h media);
  *                   %http://tizen.org/privilege/mediastorage \n
  *                   %http://tizen.org/privilege/externalstorage
  *
- * @remarks If you want to destroy the media handle before callback invoked, you must cancel the face detection request by using media_info_cancel_face_detection(). \n
- *          If face detection fails, the face_count argument in media_face_detection_completed_cb() will be set to 0.
- *          Media items in external storage are not supported, with the exception of MMC items.
+ * @remarks If you want to destroy the media handle before the callback invoked, you must cancel the face detection request using media_info_cancel_face_detection(). \n
+ *          If the face detection fails, the @a face_count argument in media_face_detection_completed_cb() will be set to 0. \n
+ *          The face detection of media items in external storage except MMC is not supported. \n
+ *          Since 5.5, if the format of media data is unsupported, this function returns an error and the callback will not be invoked.
  *
  * @param[in] media The handle to the media info
  * @param[in] callback The callback function to be invoked when detection is completed
@@ -1142,7 +1147,7 @@ int media_info_start_face_detection(media_info_h media, media_face_detection_com
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
  *
- * @remarks If face detection is already done when you request the cancellation, this function return MEDIA_CONTENT_ERROR_INVALID_OPERATION
+ * @remarks If face detection is already done when you request the cancellation, this function returns #MEDIA_CONTENT_ERROR_INVALID_OPERATION
  *
  * @param[in] media The handle to the media info
  *