/*----------------------------------------------------------------------------*/
/*
- * Geocode
+ * Geocoder
*/
/**
* \n To cancel the request use maps_plugin_cancel_request().
*
* @param[in] address The free-formed address
- * @param[in] preference The set of preferences for processing Geocode
+ * @param[in] preference The set of preferences for processing geocoding
* @param[in] callback The callback which will receive position
* coordinates
- * @param[in] user_data The user data to be passed to the callback
- * function
+ * @param[in] user_data The user data to be passed to the callback function
* @param[out] request_id The id of request
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @privilege %http://tizen.org/privilege/mapservice
* @remarks This function requires network access.
* \n Polygonal bounding box is not supported.
- * \n To cancel the request use maps_plugin_cancel_request().
- * \n To check if Maps Provider is capable of Geocoding and which Geocode
- * preferences are supported see the lists of capacities and preferences above.
+ * \n To cancel the request, use maps_plugin_cancel_request().
+ * \n To check if Maps Provider is capable of geocoding and which preferences
+ * of geocoding are supported, see the lists of capacities and preferences above.
*
* @param[in] address The free-formed address
* @param[in] bounds The bounding box
- * @param[in] preference The set of preferences for processing Geocode
+ * @param[in] preference The set of preferences for processing geocoding
* @param[in] callback The callback which will receive position
* coordinates
- * @param[in] user_data The user data to be passed to the callback
- * function
+ * @param[in] user_data The user data to be passed to the callback function
* @param[out] request_id The id of request
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @privilege %http://tizen.org/privilege/mapservice
* @remarks This function requires network access.
* \n To cancel the request use maps_plugin_cancel_request().
- * \n To check if Maps Provider is capable of Geocoding and which Geocode
+ * \n To check if Maps Provider is capable of Geocoding and which geocoding
* preferences are supported see the lists of capacities and preferences above.
*
* @param[in] address The structured address
- * @param[in] preference The set of preferences for processing Geocode
- * @param[in] callback The callback which will receive position
- * coordinates
- * @param[in] user_data The user data to be passed to the callback
- * function
+ * @param[in] preference The set of preferences for processing geocoding
+ * @param[in] callback The callback which will receive position coordinates
+ * @param[in] user_data The user data to be passed to the callback function
* @param[out] request_id The id of request
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @privilege %http://tizen.org/privilege/mapservice
* @remarks This function requires network access.
* \n To cancel the request use maps_plugin_cancel_request().
- * \n To check if Maps Provider is capable of Reverse Geocoding and which
- * Reverse Geocode preferences are supported see the lists of capacities and
+ * \n To check if Maps Provider is capable of reverse geocoding and which
+ * reverse geocoding preferences are supported see the lists of capacities and
* preferences above.
*
* @param[in] latitude The latitude [-90.0 ~ 90.0] (degrees)
* @param[in] longitude The longitude [-180.0 ~ 180.0] (degrees)
- * @param[in] preference The set of preferences for processing Reverse
- * Geocode
- * @param[in] callback The callback which will receive address
- * information
- * @param[in] user_data The user data to be passed to the callback
- * function
+ * @param[in] preference The set of preferences for processing reverse geocoding
+ * @param[in] callback The callback which will receive address information
+ * @param[in] user_data The user data to be passed to the callback function
* @param[out] request_id The id of request
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @param[in] filter The filter handle
* @param[in] preference The place preference handle
* @param[in] callback The result callback
- * @param[in] user_data The user data to be passed to the callback
- * function
- * @param[out] request_id A Request id, can be set to NULL if does not
- * require operation cancel
+ * @param[in] user_data The user data to be passed to the callback function
+ * @param[out] request_id The request id
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] filter The filter handle
* @param[in] preference The place preference handle
* @param[in] callback The result callback
- * @param[in] user_data The user data to be passed to the callback
- * function
- * @param[out] request_id A Request id, can be set to NULL if does not
- * required operation cancel
+ * @param[in] user_data The user data to be passed to the callback function
+ * @param[out] request_id The request id
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] filter The filter handle
* @param[in] preference The place preference handle
* @param[in] callback The result callback
- * @param[in] user_data The user data to be passed to the callback
- * function
- * @param[out] request_id A Request id, can be set to NULL if does not
- * required operation cancel
+ * @param[in] user_data The user data to be passed to the callback function
+ * @param[out] request_id The request id
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] destination The destination
* @param[in] preference The Route preference handle
* @param[in] callback The result callback
- * @param[in] user_data The user data to be passed to the callback
- * function
- * @param[out] request_id The request ID
+ * @param[in] user_data The user data to be passed to the callback function
+ * @param[out] request_id The request id
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory
* @param[in] waypoint_num The number of way points to go through
* @param[in] preference The Route preference handle
* @param[in] callback The result callback
- * @param[in] user_data The user data to be passed to the callback
- * function
- * @param[out] request_id The request ID
+ * @param[in] user_data The user data to be passed to the callback function
+ * @param[out] request_id The request id
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory
* @privilege %http://tizen.org/privilege/mapservice
* @remarks This function requires network access.
*
- * @param[in] request_id The id of request
+ * @param[in] request_id The request id
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @param[in] callback The callback function to receive available Maps Providers
* information
- * @param[out] user_data The user data to be passed to the callback
- * function
+ * @param[out] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
* @privilege %http://tizen.org/privilege/mapservice \n
* %http://tizen.org/privilege/network.get
*
- * @remarks @a maps service handle must be released using
- * maps_service_destroy().
+ * @remarks @a maps service handle must be released using maps_service_destroy().
* \n use maps_service_foreach_provider() to choose one of available Providers.
* \n use maps_service_set_provider_key() to set provider's key.
- * \n use use maps_service_set_preference() to set various options of Maps
- * Provider.
+ * \n use use maps_service_set_preference() to set various options of Maps Provider.
* \n use maps_service_provider_is_service_supported() and
* maps_service_provider_is_data_supported() to check the Maps Provider's
* capabilities
* @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available
* @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
* @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied
-*
+ *
* @pre Call maps_service_foreach_provider() to get a available Maps Providers.
*
* @see maps_service_foreach_provider()
/**
* @brief Sets the Maps Key to be used in the requests of Maps Service.
- * @details This function sets the Maps Provider's Key which will be used in
- * each Maps Service request to Maps Provider.
+ * @details This function sets the Maps Provider's Key which will be used in each Maps
+ * Service request to Maps Provider.
* \n Maps key can be obtained with maps_service_get_provider_key().
* @since_tizen 2.4
* @remarks To get the @a provider_key, refer to corresponding Maps Provider
/**
* @brief Checks if the Maps Service supports a request.
- * @details This function checks if the Maps Service supports a specified
- * request.
+ * @details This function checks if the Maps Service supports a specified request.
* @since_tizen 2.4
* @remarks @a maps_service_provider_is_service_supported is always synchronous
* function.
/**
* @brief Cancels the service request.
- * @details This function cancels the service request initiated by geocoder,
- * route or place search.
+ * @details This function cancels the service request initiated by geocoding
+ * and searching places and routes.
+
* @since_tizen 2.4
* @privlevel public
* @privilege %http://tizen.org/privilege/mapservice
* * maps_service_search_place_by_address()
* * maps_service_search_route()
* * maps_service_search_route_waypoints()
- * .
+ * .
* @pre Call maps_service_create() to create Maps Service and get its handle.
*
* @see maps_service_geocode()
* %http://tizen.org/privilege/internet \n
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
- * \n To cancel the request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Geocoding use
- * maps_service_provider_is_service_supported() with
+ * \n To cancel the request, use maps_service_cancel_request().
+ * \n To check if Maps Provider is capable of geocoding,
+ * use maps_service_provider_is_service_supported() with
* #MAPS_SERVICE_GEOCODE passed as @a service parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] address The free-formed address
- * @param[in] preference The set of preferences for processing Geocode
+ * @param[in] preference The set of preferences for processing geocoding
* @param[in] callback The callback which will receive position
* coordinates
- * @param[in] user_data The user data to be passed to the callback
- * function
+ * @param[in] user_data The user data to be passed to the callback function
* @param[out] request_id The id of request
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
* \n Polygonal bounding box is not supported.
- * \n To cancel the request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Geocoding Inside Area use
- * maps_service_provider_is_service_supported() with
+ * \n To cancel the request, use maps_service_cancel_request().
+ * \n To check if Maps Provider is capable of geocoding inside area,
+ * use maps_service_provider_is_service_supported() with
* #MAPS_SERVICE_GEOCODE_INSIDE_AREA passed as @a service parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] address The free-formed address
* @param[in] bounds The bounding box
- * @param[in] preference The set of preferences for processing Geocode
+ * @param[in] preference The set of preferences for processing geocoding
* @param[in] callback The callback which will receive position
* coordinates
- * @param[in] user_data The user data to be passed to the callback
- * function
+ * @param[in] user_data The user data to be passed to the callback function
* @param[out] request_id The id of request
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key
* @retval #MAPS_ERROR_UNKNOWN Unknown error
*
- * @pre Call maps_service_create() to create Maps Service and obtain its
- * handle.
+ * @pre Call maps_service_create() to create Maps Service and obtain its handle.
* @post It invokes maps_service_geocode_cb() to deliver obtained position
* coordinates.
*
* %http://tizen.org/privilege/internet \n
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
- * \n To cancel the request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Geocoding by Structured Address use
- * maps_service_provider_is_service_supported() with
+ * \n To cancel the request, use maps_service_cancel_request().
+ * \n To check if Maps Provider is capable of geocoding by structured address,
+ * use maps_service_provider_is_service_supported() with
* #MAPS_SERVICE_GEOCODE_BY_STRUCTURED_ADDRESS passed as @a service parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] address The structured address
- * @param[in] preference The set of preferences for processing Geocode
+ * @param[in] preference The set of preferences for processing geocoding
* @param[in] callback The callback which will receive position
* coordinates
- * @param[in] user_data The user data to be passed to the callback
- * function
+ * @param[in] user_data The user data to be passed to the callback function
* @param[out] request_id The id of request
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* %http://tizen.org/privilege/internet \n
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
- * \n To cancel the request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Reverse Geocoding use
- * maps_service_provider_is_service_supported() with
+ * \n To cancel the request, use maps_service_cancel_request().
+ * \n To check if Maps Provider is capable of reverse geocoding,
+ * use maps_service_provider_is_service_supported() with
* #MAPS_SERVICE_REVERSE_GEOCODE passed as @a service parameter.
*
* @param[in] maps The Maps Service handle
* @param[in] latitude The latitude [-90.0 ~ 90.0] (degrees)
* @param[in] longitude The longitude [-180.0 ~ 180.0] (degrees)
- * @param[in] preference The set of preferences for processing Reverse
- * Geocode
- * @param[in] callback The callback which will receive address
- * information
- * @param[in] user_data The user data to be passed to the callback
- * function
+ * @param[in] preference The set of preferences for processing reverse geocoding
+ * @param[in] callback The callback which will receive address information
+ * @param[in] user_data The user data to be passed to the callback function
* @param[out] request_id The id of request
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* %http://tizen.org/privilege/internet \n
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
- * \n To cancel the request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Multi Reverse Geocoding use
- * maps_service_provider_is_service_supported() with
+ * \n To cancel the request, use maps_service_cancel_request().
+ * \n To check if Maps Provider is capable of multi reverse geocoding,
+ * use maps_service_provider_is_service_supported() with
* #MAPS_SERVICE_MULTI_REVERSE_GEOCODE passed as @a service parameter.
*
* @param[in] maps The Maps Service handle
* %http://tizen.org/privilege/internet \n
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
- * \n To cancel the search request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Place Search use
+ * \n To cancel the search request, use maps_service_cancel_request().
+ * \n To check if Maps Provider is capable of searching places, use
* maps_service_provider_is_service_supported() with
* #MAPS_SERVICE_SEARCH_PLACE passed as @a service parameter.
* \n Check available data features in the search result using
* @param[in] filter The filter handle
* @param[in] preference The place preference handle
* @param[in] callback The result callback
- * @param[in] user_data The user data to be passed to the callback
- * function
- * @param[out] request_id A Request id, can be set to NULL if does not
- * require operation cancel
+ * @param[in] user_data The user data to be passed to the callback function
+ * @param[out] request_id The request id
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
* \n @a boundary is supporting only circle type bounds for search.
- * \n To cancel the search request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Place Search by coordinates
+ * \n To cancel the search request, use maps_service_cancel_request().
+ * \n To check if Maps Provider is capable of searching places by coordinates
* boundaries, use maps_service_provider_is_service_supported() with
* #MAPS_SERVICE_SEARCH_PLACE_BY_AREA passed as @a service parameter.
* \n Check available data features in the search result using
* @param[in] filter The filter handle
* @param[in] preference The place preference handle
* @param[in] callback The result callback
- * @param[in] user_data The user data to be passed to the callback
- * function
- * @param[out] request_id A Request id, can be set to NULL if does not
- * required operation cancel
+ * @param[in] user_data The user data to be passed to the callback function
+ * @param[out] request_id The request id
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
* \n @a boundary is supporting only circle type bounds for search.
- * \n To cancel the search request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Place Search by free-formed
- * address use maps_service_provider_is_service_supported() with
+ * \n To cancel the search request, use maps_service_cancel_request().
+ * \n To check if Maps Provider is capable of searching places by free-formed
+ * address, use maps_service_provider_is_service_supported() with
* #MAPS_SERVICE_SEARCH_PLACE_BY_ADDRESS passed as @a service parameter.
* \n Check available data features in the search result using
* maps_service_provider_is_data_supported() with values, listed in
* @param[in] filter The filter handle
* @param[in] preference The place preference handle
* @param[in] callback The result callback
- * @param[in] user_data The user data to be passed to the callback
- * function
- * @param[out] request_id A Request id, can be set to NULL if does not
- * required operation cancel
+ * @param[in] user_data The user data to be passed to the callback function
+ * @param[out] request_id The request id
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory
* @{
* @brief This provides APIs for Route Service
* @details The Maps Route API provides functions to calculate a route that
- * defines a path between a start and a destination and may, optionally, pass
+ * defines a path between a origin and a destination and may, optionally, pass
* through specific intermediate locations.
*
*/
/**
- * @brief Called when the requested Routes are found.
+ * @brief Called when the requested routes are found.
* @details The Maps Service invokes this callback while iterating through the
* set of obtained Routes.
* \n If search is failed, the value of @a total is 0 and @a route is NULL.
* %http://tizen.org/privilege/internet \n
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
- * \n To cancel the search request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of Route Search use
+ * \n To cancel the search request, use maps_service_cancel_request().
+ * \n To check if Maps Provider is capable of searching routes, use
* maps_service_provider_is_service_supported() with
* #MAPS_SERVICE_SEARCH_ROUTE passed as @a service parameter.
* \n Check available data features in the search result using
* @param[in] destination The destination
* @param[in] preference The Route preference handle
* @param[in] callback The result callback
- * @param[in] user_data The user data to be passed to the callback
- * function
- * @param[out] request_id The request ID
+ * @param[in] user_data The user data to be passed to the callback function
+ * @param[out] request_id The request id
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory
* %http://tizen.org/privilege/internet \n
* %http://tizen.org/privilege/network.get
* @remarks %http://tizen.org/privilege/internet is needed to access internet.
- * \n To cancel the search request use maps_service_cancel_request().
- * \n To check if Maps Provider is capable of searching the route, passing
+ * \n To cancel the search request, use maps_service_cancel_request().
+ * \n To check if Maps Provider is capable of searching the route passing
* through the specified way points, use
* maps_service_provider_is_service_supported() with
* #MAPS_SERVICE_SEARCH_ROUTE_WAYPOINTS passed as @a service parameter.
* @param[in] waypoint_num The number of way points to go through
* @param[in] preference The Route preference handle
* @param[in] callback The result callback
- * @param[in] user_data The user data to be passed to the callback
- * function
- * @param[out] request_id The request ID
+ * @param[in] user_data The user data to be passed to the callback function
+ * @param[out] request_id The request id
* @return 0 on success, otherwise a negative error value
* @retval #MAPS_ERROR_NONE Successful
* @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory