modified the description about marker size APIs 57/89057/1
authorchanywa <cbible.kim@samsung.com>
Thu, 22 Sep 2016 02:39:16 +0000 (11:39 +0900)
committerchanywa <cbible.kim@samsung.com>
Thu, 22 Sep 2016 02:39:43 +0000 (11:39 +0900)
Change-Id: I124e988ce0d5ad103d2efdd28d03357cc7986d2c

include/maps_view_object.h
include/maps_view_object_plugin.h
src/api/maps_view_object.cpp

index eaecdfb..da1c0f9 100644 (file)
@@ -661,10 +661,13 @@ int maps_view_object_marker_set_coordinates(maps_view_object_h marker, maps_coor
  * @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     To make the marker size proportionally, use 0 as the value for the @a width or @a height paramter.
+ * For instance, to make the width of an marker 150 pixels, and change the height using the same proportion,
+ * use maps_view_object_marker_resize(marker, 150, 0).
  *
  * @param[in]  marker  The marker object handle
- * @param[in]  width   The marker pixels in width on the screen
- * @param[in]  height  The marker pixels in height on the screen
+ * @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
index 2cb193e..395c617 100644 (file)
@@ -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
index 6e4826b..a01ea67 100644 (file)
@@ -924,7 +924,7 @@ EXPORT_API int maps_view_object_marker_set_size(maps_view_object_h marker, int w
 {
        if (!maps_condition_check_maps_feature())
                return MAPS_ERROR_NOT_SUPPORTED;
-       if (!marker)
+       if (!marker || width < 0 || height < 0)
                return MAPS_ERROR_INVALID_PARAMETER;
        maps_view_marker_data_s *m = __get_marker_data(marker);
        if (!m)