From: chakradhar Date: Thu, 13 Aug 2020 04:30:01 +0000 (+0530) Subject: Addition of detailed description of API location_bounds_contains_coordinates_on_edge X-Git-Tag: accepted/tizen/unified/20200828.121525^0 X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fapi%2Flocation-manager.git;a=commitdiff_plain;h=56bb263c31db3acf1b7d2a7d2bdf09e616f853ce Addition of detailed description of API location_bounds_contains_coordinates_on_edge Change-Id: I66f1f1632534eb14545527d2e6a1340aa04fc251 --- diff --git a/include/location_bounds.h b/include/location_bounds.h index 8efcffa..6347ca5 100644 --- 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