Addition of detailed description of API location_bounds_contains_coordinates_on_edge

[platform/core/api/location-manager.git] / include / location_bounds.h

diff --git a/include/location_bounds.h b/include/location_bounds.h
index 8efcffa..6347ca5 100644 (file)
--- a/include/location_bounds.h
+++ b/include/location_bounds.h
@@ -189,11 +189,12 @@ bool location_bounds_contains_coordinates(location_bounds_h bounds, location_coo
 
 /**
  * @brief Checks whether the edges of the bounds contain the specified coordinates within tolerance.
+ * @since_tizen 6.0
  * @param[in] bounds The location bounds handle
  * @param[in] coords The coordinates
  * @param[in] tolerance tolerance in metres
- * @return @c true if the edges of the bounds contain the specified coordinates within tolerance,
- *         otherwise else @c false
+ * @return @c true if the distance between edges of @a bounds and point at @a coords are not farther than @a tolerance
+ *         otherwise @c false
  * @exception #LOCATION_BOUNDS_ERROR_NONE Successful
  * @exception #LOCATION_BOUNDS_ERROR_OUT_OF_MEMORY Out of memory
  * @exception #LOCATION_BOUNDS_ERROR_INVALID_PARAMETER Invalid parameter