modified the description about marker size APIs

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

diff --git a/include/maps_view_object_plugin.h b/include/maps_view_object_plugin.h
index 2cb193e..395c617 100644 (file)
--- a/include/maps_view_object_plugin.h
+++ b/include/maps_view_object_plugin.h
@@ -53,6 +53,26 @@ typedef enum _maps_view_object_operation_e {
        MAPS_VIEW_OBJECT_REMOVE,                /**< Indicates the remove object operation */
 } maps_view_object_operation_e;
 
+/**
+ * @brief      Sets the marker screen size.
+ * @details This function sets the marker screen size.
+ * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @remark     .
+ *
+ * @param[in]  marker  The marker object handle
+ * @param[in]  width   The resized marker pixels in width on the screen
+ * @param[in]  height  The resized marker pixels in height on the screen
+ * @return     0, 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 marker is created using maps_view_object_create_marker().
+ *
+ * @see maps_view_object_create_marker()
+ * @see maps_view_object_marker_get_size()
+ * @see maps_view_object_marker_resize()
+ */
 int maps_view_object_marker_set_size(const maps_view_object_h marker, int width, int height);
 
 #ifdef __cplusplus