Functions descriptions fix.

Change-Id: I3b5c562e8666b18cd8786f2ed71587c8cdd44027
Signed-off-by: Marcin Masternak <m.masternak@samsung.com>

diff --git a/include/maps_area.h b/include/maps_area.h
index a996ad5..66813bc 100644 (file)
--- a/include/maps_area.h
+++ b/include/maps_area.h
@@ -95,7 +95,7 @@ typedef struct _maps_area_circle_s {
  * type, circular or rectangular, and appropriate coordinates and radius.
  * @warning Do not use #maps_area_s directly
  * if you are an application developer.
- * Using #maps_area_h is recommanded.
+ * Using #maps_area_h is recommended.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  */
 typedef struct _maps_area_s {

diff --git a/include/maps_coordinates.h b/include/maps_coordinates.h
index 189d0bd..97285a1 100644 (file)
--- a/include/maps_coordinates.h
+++ b/include/maps_coordinates.h
@@ -51,7 +51,7 @@ typedef void *maps_coordinates_h;
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  * @remarks #maps_coordinates_h is a void pointer to the #maps_coordinates_h.
  * @warning Do not use #maps_coordinates_s directly if you are an application developer.
- * Using #maps_coordinates_h is recommanded.
+ * Using #maps_coordinates_h is recommended.
  *
  * @see maps_coordinates_h
  */
@@ -61,8 +61,8 @@ typedef struct _maps_coordinates_s {
 } maps_coordinates_s;
 
 /**
- * @brief      The coorinates list handle.
- * @details The coorindates list handle can be obtained via calling of maps_coordinates_list_create().
+ * @brief      The coordinates list handle.
+ * @details The coordinates list handle can be obtained via calling of maps_coordinates_list_create().
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  */
 typedef void *maps_coordinates_list_h;

diff --git a/include/maps_extra_types.h b/include/maps_extra_types.h
index 74f1fd3..81b345e 100644 (file)
--- a/include/maps_extra_types.h
+++ b/include/maps_extra_types.h
@@ -664,7 +664,7 @@ int maps_int_hashtable_create(maps_int_hashtable_h *table);
 int maps_int_hashtable_destroy(maps_int_hashtable_h table);
 
 /*
- * @brief      Clones the Hash Table of integerss.
+ * @brief      Clones the Hash Table of integers.
  * @details This function clones the Hash Table of integers @a origin and all
  * its resources.
  * \n The list handle @a origin may be created using

diff --git a/include/maps_plugin.h b/include/maps_plugin.h
index 1eec453..05be1f7 100644 (file)
--- a/include/maps_plugin.h
+++ b/include/maps_plugin.h
@@ -802,8 +802,8 @@ int maps_plugin_cancel_request(int request_id);
 /*----------------------------------------------------------------------------*/
 
 /**
- * @brief      Called when the map initialzing is finished.
- * @details The Plugin invokes this callback when the initialzing of map is finished.
+ * @brief      Called when the map initializing is finished.
+ * @details The Plugin invokes this callback when the initializing of map is finished.
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  *
  * @param[in]  view            The maps view
@@ -832,7 +832,7 @@ int maps_plugin_create_map_view(maps_view_h view, maps_plugin_map_view_ready_cb
 
 /**
  * @brief      Destroy a maps view.
- * @details This function destory a maps view to the plugin.
+ * @details This function destroy a maps view to the plugin.
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  *
  * @param[in]  view            The maps view
@@ -926,11 +926,11 @@ int maps_plugin_set_scalebar(maps_view_h view, bool enable);
 int maps_plugin_get_scalebar(maps_view_h view, bool *enabled);
 
 /**
- * @brief      Notifyes that the visual object is changed.
- * @details This function notifyes the Plugin that the visual object is
+ * @brief      Notifies that the visual object is changed.
+ * @details This function notifies the Plugin that the visual object is
  * changed. The possible causes of changes are enumerated in
- * #maps_view_object_operation_e ind nclude object adding, moving, removing,
- * visibility modificating or editing object specific properties.
+ * #maps_view_object_operation_e including in object adding, moving, removing,
+ * visibility modifying or editing object specific properties.
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  *
  * @param[in]  view            The handle of maps_view

diff --git a/include/maps_service.h b/include/maps_service.h
index 06f10e8..0ca6830 100644 (file)
--- a/include/maps_service.h
+++ b/include/maps_service.h
@@ -755,7 +755,7 @@ int maps_service_reverse_geocode(const maps_service_h maps, double latitude,
 
 
 /**
- * @brief      Called when responsed the request of multi reverse geocoding.
+ * @brief      Called when respond to a request of multi reverse geocoding.
  * @details The Maps Service invokes this callback once when gets the response
  * from map service provider.
  * \n The value of @a total is same with requested coordinates list size.
@@ -942,7 +942,7 @@ typedef void(*maps_service_search_place_list_cb) (maps_error_e error,
                                             int request_id, int total, maps_place_list_h place_list, void *user_data);
 
 /**
- * @brief      Called for Place datail information of Place Search request
+ * @brief      Called for Place detail information of Place Search request
  * @details The Maps Service invokes this callback when the Place detail data
  * obtained from the specified uri.
  * \n If search is failed, @a place is NULL

diff --git a/include/maps_view_object.h b/include/maps_view_object.h
index f66d050..baceecb 100644 (file)
--- a/include/maps_view_object.h
+++ b/include/maps_view_object.h
@@ -729,15 +729,15 @@ int maps_view_object_marker_get_coordinates(const maps_view_object_h marker, map
  *
  * @param[in]  marker          The marker object handle
  * @param[out] width           The pointer to an integer in which to store the
- * marker pixels in width on the screen
+ * marker width on the screen in pixels
  * @param[out] height          The pointer to an integer in which to store the
- * marker pixels in height on the screen
+ * marker height on the screen in pixels
  * @return     0, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful
  * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
  *
  * @pre @a marker is created using maps_view_object_create_marker().
- * @pre @a width ind @a height may be set previously using maps_view_object_marker_resize().
+ * @pre @a width and @a height may be set previously using maps_view_object_marker_resize().
  *
  * @see maps_view_object_marker_resize()
  * @see maps_view_object_create_marker()