[TNEF-6516] Fixing doxygen for Map Area units

Change-Id: Id8b70e517da38c9dcdf0c410f3f64f355912a776
Signed-off-by: a.shulga <a.shulga@samsung.com>

diff --git a/include/maps_area.h b/include/maps_area.h
index f122d84..b327dc4 100644 (file)
--- a/include/maps_area.h
+++ b/include/maps_area.h
@@ -160,8 +160,10 @@ int maps_area_create_rectangle(const maps_coordinates_h top_left,
  * Geographical Area with a specified center coordinates and a radius.
  * @since_tizen 2.4
  * @remarks @a area must be released using maps_area_destroy().
- * \n @a top_left and @a bottom_right must be released using
- * maps_coordinates_destroy().
+ * \n @a center must be released using maps_coordinates_destroy().
+ * \n The @a radius is specified in units, listed in #maps_distance_unit_e.
+ * \n To get and set distance units use maps_preference_get_distance_unit() and
+ * maps_preference_set_distance_unit() respectively.
  *
  * @param[in]  center          The central position of the area
  * @param[in]  radius          The radius of the area
@@ -179,6 +181,8 @@ int maps_area_create_rectangle(const maps_coordinates_h top_left,
  * @see maps_area_s
  * @see maps_coordinates_create()
  * @see maps_coordinates_destroy()
+ * @see maps_preference_get_distance_unit()
+ * @see maps_preference_set_distance_unit()
  */
 int maps_area_create_circle(const maps_coordinates_h center,
                            const double radius, maps_area_h *area);

diff --git a/include/maps_place.h b/include/maps_place.h
index 13f9ec6..b79c079 100644 (file)
--- a/include/maps_place.h
+++ b/include/maps_place.h
@@ -347,7 +347,7 @@ int maps_place_get_location(const maps_place_h place,
  * @since_tizen 2.4
  *
  * @param[in]  place                   The place handle
- * @param[out] distance                The place distance
+ * @param[out] distance                The place distance in meters
  * @return     0 on success, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful
  * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter

diff --git a/include/maps_place_plugin.h b/include/maps_place_plugin.h
index a1e71a4..93ae1a8 100644 (file)
--- a/include/maps_place_plugin.h
+++ b/include/maps_place_plugin.h
@@ -124,7 +124,7 @@ int maps_place_set_location(maps_place_h place,
  * @since_tizen 2.4
  *
  * @param[in]  place           The handle to place
- * @param[in]  distance        The place distance
+ * @param[in]  distance        The place distance in meters
  * @return     0 on success, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful
  * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter

diff --git a/include/maps_service.h b/include/maps_service.h
index 0fa61df..eb7bac7 100644 (file)
--- a/include/maps_service.h
+++ b/include/maps_service.h
@@ -805,10 +805,14 @@ typedef bool(*maps_service_search_place_cb) (maps_error_e error,
  * \n To cancel the search request use maps_service_cancel_request().
  * \n To check if Maps Provider is capable of Place Search and which Place
  * preferences are supported, see the lists of capacities and preferences above.
+ * \n The distance unit for searching places supports metric
+ * but doesn't support imperial.
+ * Even though applications set #maps_distance_unit_e using maps_preference_set_distance_unit(),
+ * the unit of distance is meter.
  *
  * @param[in]  maps            The Maps Service handle
  * @param[in]  position        The interested position
- * @param[in]  distance        The search area distance
+ * @param[in]  distance        The search area distance in meters
  * @param[in]  filter          The filter handle
  * @param[in]  preference      The place preference handle
  * @param[in]  callback        The result callback
@@ -862,6 +866,9 @@ int maps_service_search_place(const maps_service_h maps,
  * \n To cancel the search request use maps_service_cancel_request().
  * \n To check if Maps Provider is capable of Place Search and which Place
  * preferences are supported, see the lists of capacities and preferences above.
+ * \n The distance unit for searching places doesn't support imperial but supports metric.
+ * Even though applications set maps_distance_unit_e using maps_preference_set_distance_unit(),
+ * the unit of radius of boundary is meter.
  *
  * @param[in]  maps            The Maps Service handle
  * @param[in]  boundary        The interested area