Change deprecated to 8.0

[platform/core/api/maps-service.git] / include / maps_place_image_plugin.h

diff --git a/include/maps_place_image_plugin.h b/include/maps_place_image_plugin.h
index feb94c7..ae794d7 100644 (file)
--- a/include/maps_place_image_plugin.h
+++ b/include/maps_place_image_plugin.h
@@ -20,8 +20,8 @@
 #include <maps_place_image.h>
 
 /**
- * @ingroup    CAPI_MAPS_PLUGIN_PLACE_MODULE
- * @defgroup   CAPI_MAPS_PLUGIN_PLACE_IMAGE_MODULE Image
+ * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE
+ * @defgroup CAPI_MAPS_PLUGIN_PLACE_IMAGE_MODULE Image
  *
  * @file maps_place_image_plugin.h
  * @brief This file contains the functions related to Place Image
@@ -38,106 +38,118 @@ extern "C" {
 #endif
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Creates a new place image handle.
  * @details This function creates a new place image handle and allocates all
  * needed resources.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  * @remarks @a image must be released using maps_place_image_destroy().
  * \n @a image may be cloned using maps_place_image_clone().
  *
- * @param[out] image           A handle of a new place image on success
- * @return     0 on success, otherwise a negative error value
- * @retval     #MAPS_ERROR_NONE Successful
- * @retval     #MAPS_ERROR_OUT_OF_MEMORY Out of memory
- * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[out] image A handle of a new place image on success
+ * @return 0 on success, otherwise a negative error value
+ * @retval #MAPS_ERROR_NONE Successful
+ * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
  *
  * @see maps_place_image_destroy()
  * @see maps_place_image_clone()
  */
-int maps_place_image_create(maps_place_image_h *image);
+int maps_place_image_create(maps_place_image_h *image) TIZEN_DEPRECATED_API;
 
 /**
- * @brief      Sets the place image id.
- * @details This function sets the place image id.
- * @since_tizen 2.4
- *
- * @param[in]  image           The handle of place image
- * @param[in]  id              The place image id
- * @return     0 on success, otherwise a negative error value
- * @retval     #MAPS_ERROR_NONE Successful
- * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @deprecated Deprecated since 8.0.
+ * @brief Sets the place image ID.
+ * @details This function sets the place image ID.
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
+ *
+ * @param[in] image The handle of place image
+ * @param[in] id The place image Id
+ * @return 0 on success, otherwise a negative error value
+ * @retval #MAPS_ERROR_NONE Successful
+ * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
  *
  * @pre @a image is created using maps_place_image_create().
  *
  * @see maps_place_image_create()
  * @see maps_place_image_get_id()
  */
-int maps_place_image_set_id(maps_place_image_h image, const char *id);
+int maps_place_image_set_id(maps_place_image_h image, const char *id) TIZEN_DEPRECATED_API;
 
 /**
- * @brief      Sets the place image URL.
+ * @deprecated Deprecated since 8.0.
+ * @brief Sets the place image URL.
  * @details This function sets the place image URL.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  *
- * @param[in]  image           The handle of place image
- * @param[in]  url             The place image url
- * @return     0 on success, otherwise a negative error value
- * @retval     #MAPS_ERROR_NONE Successful
- * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] image The handle of place image
+ * @param[in] url The place image url
+ * @return 0 on success, otherwise a negative error value
+ * @retval #MAPS_ERROR_NONE Successful
+ * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
  *
  * @pre @a image is created using maps_place_image_create().
  *
  * @see maps_place_image_create()
  * @see maps_place_image_get_url()
  */
-int maps_place_image_set_url(maps_place_image_h image, const char *url);
+int maps_place_image_set_url(maps_place_image_h image, const char *url) TIZEN_DEPRECATED_API;
 
 /**
- * @brief      Sets the place image width.
+ * @deprecated Deprecated since 8.0.
+ * @brief Sets the place image width.
  * @details This function sets the place image width.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  *
- * @param[in]  image           The handle of place image
- * @param[in]  width           The place image width
- * @return     0 on success, otherwise a negative error value
- * @retval     #MAPS_ERROR_NONE Successful
- * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] image The handle of place image
+ * @param[in] width The place image width
+ * @return 0 on success, otherwise a negative error value
+ * @retval #MAPS_ERROR_NONE Successful
+ * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
  *
  * @pre @a image is created using maps_place_image_create().
  *
  * @see maps_place_image_create()
  * @see maps_place_image_get_width()
  */
-int maps_place_image_set_width(maps_place_image_h image, const int width);
+int maps_place_image_set_width(maps_place_image_h image, const int width) TIZEN_DEPRECATED_API;
 
 /**
- * @brief      Sets the place image height.
+ * @deprecated Deprecated since 8.0.
+ * @brief Sets the place image height.
  * @details This function sets the place image height.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  *
- * @param[in]  image           The handle of place image
- * @param[in]  height          The place image height
- * @return     0 on success, otherwise a negative error value
- * @retval     #MAPS_ERROR_NONE Successful
- * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] image The handle of place image
+ * @param[in] height The place image height
+ * @return 0 on success, otherwise a negative error value
+ * @retval #MAPS_ERROR_NONE Successful
+ * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
  *
  * @pre @a image is created using maps_place_image_create().
  *
  * @see maps_place_image_create()
  * @see maps_place_image_get_height()
  */
-int maps_place_image_set_height(maps_place_image_h image, const int height);
+int maps_place_image_set_height(maps_place_image_h image, const int height) TIZEN_DEPRECATED_API;
 
 /**
- * @brief      Sets the place image user link.
+ * @deprecated Deprecated since 8.0.
+ * @brief Sets the place image user link.
  * @details This function sets the place image user link.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  *
- * @param[in]  image           The handle of place image
- * @param[in]  user            The place image user link
- * @return     0 on success, otherwise a negative error value
- * @retval     #MAPS_ERROR_NONE Successful
- * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] image The handle of place image
+ * @param[in] user The place image user link
+ * @return 0 on success, otherwise a negative error value
+ * @retval #MAPS_ERROR_NONE Successful
+ * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
  *
  * @pre @a image is created using maps_place_image_create().
  *
@@ -145,19 +157,20 @@ int maps_place_image_set_height(maps_place_image_h image, const int height);
  * @see maps_place_image_get_user_link()
  * @see #maps_place_link_object_h
  */
-int maps_place_image_set_user_link(maps_place_image_h image,
-                                  const maps_place_link_object_h user);
+int maps_place_image_set_user_link(maps_place_image_h image, const maps_place_link_object_h user) TIZEN_DEPRECATED_API;
 
 /**
- * @brief      Sets the place image media.
+ * @deprecated Deprecated since 8.0.
+ * @brief Sets the place image media.
  * @details This function sets the place image media.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  *
- * @param[in]  image           The handle of place image
- * @param[in]  media           The place image media
- * @return     0 on success, otherwise a negative error value
- * @retval     #MAPS_ERROR_NONE Successful
- * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] image The handle of place image
+ * @param[in] media The place image media
+ * @return 0 on success, otherwise a negative error value
+ * @retval #MAPS_ERROR_NONE Successful
+ * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
  *
  * @pre @a image is created using maps_place_image_create().
  *
@@ -165,8 +178,7 @@ int maps_place_image_set_user_link(maps_place_image_h image,
  * @see maps_place_image_get_media()
  * @see #maps_place_media_h
  */
-int maps_place_image_set_media(maps_place_image_h image,
-                              const maps_place_media_h media);
+int maps_place_image_set_media(maps_place_image_h image, const maps_place_media_h media) TIZEN_DEPRECATED_API;
 
 #ifdef __cplusplus
 }
@@ -174,4 +186,4 @@ int maps_place_image_set_media(maps_place_image_h image,
 /**
  * @}
  */
-#endif                         /* __MAPS_PLACE_IMAGE_PLUGIN_H__ */
+#endif /* __MAPS_PLACE_IMAGE_PLUGIN_H__ */