Reinforce description of order type

[platform/core/api/media-content.git] / include_product / media_filter.h

diff --git a/include_product/media_filter.h b/include_product/media_filter.h
index 4a07385..387a3ca 100755 (executable)
--- a/include_product/media_filter.h
+++ b/include_product/media_filter.h
@@ -64,7 +64,7 @@ int media_filter_create(filter_h *filter);
 /**
  * @brief Destroys a media filter handle.
  * @details The function frees all resources related to the media filter handle. The filter
- *          handle no longer can be used to perform any operation. A new filter handle
+ *          handle no longer can be used to perform any operations. A new filter handle
  *          has to be created before the next usage.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@@ -127,6 +127,10 @@ int media_filter_set_condition(filter_h filter, const char *condition, media_con
  * @brief Sets the media filter content @a order_type and @a order_keyword i.e. either descending or ascending.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
+ * @remarks If @a order_type set to #MEDIA_CONTENT_ORDER_OTHER, media_filter sorts by referring only to the value of @a order_keyword. \n
+ *          Therefore, @a order_keyword must include collation type and order type. \n
+ *          e.g. MEDIA_DISPLAY_NAME COLLATE NOCASE DESC, MEDIA_MODIFIED_TIME DESC
+ *
  * @param[in] filter The handle to the media filter
  * @param[in] order_type The search order type
  * @param[in] order_keyword The search order keyword
@@ -144,6 +148,9 @@ int media_filter_set_condition(filter_h filter, const char *condition, media_con
 int media_filter_set_order(filter_h filter, media_content_order_e order_type, const char *order_keyword, media_content_collation_e collate_type);
 
 /**
+ * @deprecated Deprecated since 5.0. Use media_filter_set_condition() with MEDIA_PATH keyword instead. \n
+ *             See @ref CAPI_SYSTEM_STORAGE_MODULE for information about file system paths.
+ *
  * @brief Sets the @a storage_id for the given @a filter.
  * @details You can use this function when you want to search items only in the specific storage
  *
@@ -162,7 +169,7 @@ int media_filter_set_order(filter_h filter, media_content_order_e order_type, co
  * @see media_filter_create()
  * @see media_filter_destroy()
  */
-int media_filter_set_storage(filter_h filter, const char *storage_id);
+int media_filter_set_storage(filter_h filter, const char *storage_id) TIZEN_DEPRECATED_API;
 
 /**
  * @brief Gets the @a offset and @a count for the given @a filter used to limit the number of items returned.
@@ -225,9 +232,10 @@ int media_filter_get_condition(filter_h filter, char **condition, media_content_
  * @see media_filter_create()
  * @see media_filter_destroy()
  */
-int media_filter_get_order(filter_h filter, media_content_order_e* order_type, char **order_keyword, media_content_collation_e *collate_type);
+int media_filter_get_order(filter_h filter, media_content_order_e *order_type, char **order_keyword, media_content_collation_e *collate_type);
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @brief Gets the @a storage_id for given @a filter.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
@@ -245,7 +253,7 @@ int media_filter_get_order(filter_h filter, media_content_order_e* order_type, c
  * @see media_filter_create()
  * @see media_filter_destroy()
  */
-int media_filter_get_storage(filter_h filter, char **storage_id);
+int media_filter_get_storage(filter_h filter, char **storage_id) TIZEN_DEPRECATED_API;
 
 /**
  * @}