Changed some descriptions for reference manual. 31/56431/5
authorYoung-Ae Kang <youngae.kang@samsung.com>
Fri, 8 Jan 2016 02:47:04 +0000 (11:47 +0900)
committerYoung-Ae Kang <youngae.kang@samsung.com>
Wed, 20 Jan 2016 08:38:13 +0000 (17:38 +0900)
Change-Id: I73bb517408e538f705f1492200290fb4d0842892

include/maps_plugin.h
include/maps_plugin_types.h
include/maps_service.h

index ae61174..406d30e 100755 (executable)
@@ -220,7 +220,7 @@ int maps_plugin_is_data_supported(maps_service_data_e data, bool *supported);
 
 /*----------------------------------------------------------------------------*/
 /*
- * Geocode
+ * Geocoder
  */
 
 /**
@@ -234,11 +234,10 @@ int maps_plugin_is_data_supported(maps_service_data_e data, bool *supported);
  * \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
@@ -277,17 +276,16 @@ int maps_plugin_geocode(const char *address,
  * @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
@@ -328,15 +326,13 @@ int maps_plugin_geocode_inside_area(const char *address,
  * @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
@@ -376,18 +372,15 @@ int maps_plugin_geocode_by_structured_address(const maps_address_h address,
  * @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
@@ -477,10 +470,8 @@ int maps_plugin_multi_reverse_geocode(const maps_coordinates_list_h geocode_list
  * @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
@@ -527,10 +518,8 @@ int maps_plugin_search_place(const maps_coordinates_h position, int distance,
  * @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
@@ -578,10 +567,8 @@ int maps_plugin_search_place_by_area(const maps_area_h boundary,
  * @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
@@ -633,9 +620,8 @@ int maps_plugin_search_place_by_address(const char *address,
  * @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
@@ -677,9 +663,8 @@ int maps_plugin_search_route(const maps_coordinates_h origin,
  * @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
@@ -719,7 +704,7 @@ int maps_plugin_search_route_waypoints(const maps_coordinates_h *waypoint_list,
  * @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
index 5b2ff1d..adef71d 100755 (executable)
 extern "C" {
 #endif
 
+/**
+ * @ingroup    CAPI_MAPS_CONTAINERS_MODULE
+ * @defgroup   CAPI_MAPS_CONTAINERS_MODULE_OBJECT_LIST Maps Object Lists
+ *
+ * @file maps_plugin_types.h
+ * @brief This section contains API for using list of maps objects
+ *
+ * @addtogroup CAPI_MAPS_CONTAINERS_MODULE_OBJECT_LIST
+ * @{
+ * @brief This provides API for using list of maps objects.
+ */
+
 #include <glib.h>
 
 /**
  * @brief      Structure of the coordinates list.
- * @since_tizen 2.4
+ * @since_tizen 3.0
  * @remarks #maps_coordinates_list_h is a void pointer to the #maps_coordinates_list_s.
+ *
+ * @see maps_coordinates_list_create()
+ * @see maps_coordinates_list_destroy()
  */
 typedef GList maps_coordinates_list_s;
 
 /**
  * @brief      Structure of the address list.
- * @since_tizen 2.4
+ * @since_tizen 3.0
  * @remarks #maps_address_list_h is a void pointer to the #maps_address_list_s.
+ *
+ * @see maps_address_list_create()
+ * @see maps_address_list_destroy()
  */
 typedef GList maps_address_list_s;
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif
index 088e7cf..9baa777 100644 (file)
@@ -180,8 +180,7 @@ typedef bool(*maps_service_provider_info_cb) (char *maps_provider,
  *
  * @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
@@ -207,12 +206,10 @@ int maps_service_foreach_provider(maps_service_provider_info_cb callback,
  * @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
@@ -226,7 +223,7 @@ int maps_service_foreach_provider(maps_service_provider_info_cb callback,
  * @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()
@@ -267,8 +264,8 @@ int maps_service_destroy(maps_service_h maps);
 
 /**
  * @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
@@ -366,8 +363,7 @@ int maps_service_get_preference(maps_service_h maps,
 
 /**
  * @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.
@@ -419,8 +415,9 @@ int maps_service_provider_is_data_supported(const maps_service_h maps,
 
 /**
  * @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
@@ -450,7 +447,7 @@ int maps_service_provider_is_data_supported(const maps_service_h maps,
  *  * 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()
@@ -566,18 +563,17 @@ typedef void (*maps_service_reverse_geocode_cb) (maps_error_e result,
  *            %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
@@ -620,19 +616,18 @@ int maps_service_geocode(const maps_service_h maps, const char *address,
  *            %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
@@ -648,8 +643,7 @@ int maps_service_geocode(const maps_service_h maps, const char *address,
  * @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.
  *
@@ -679,18 +673,17 @@ int maps_service_geocode_inside_area(const maps_service_h maps,
  *            %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
@@ -735,20 +728,17 @@ int maps_service_geocode_by_structured_address(const maps_service_h maps,
  *            %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
@@ -820,9 +810,9 @@ typedef bool (*maps_service_multi_reverse_geocode_cb) (maps_error_e result,
  *            %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
@@ -924,8 +914,8 @@ typedef bool(*maps_service_search_place_cb) (maps_error_e error,
  *            %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
@@ -938,10 +928,8 @@ typedef bool(*maps_service_search_place_cb) (maps_error_e error,
  * @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
@@ -987,8 +975,8 @@ int maps_service_search_place(const maps_service_h maps,
  *            %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
@@ -1000,10 +988,8 @@ int maps_service_search_place(const maps_service_h maps,
  * @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
@@ -1050,9 +1036,9 @@ int maps_service_search_place_by_area(const maps_service_h maps,
  *            %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
@@ -1064,10 +1050,8 @@ int maps_service_search_place_by_area(const maps_service_h maps,
  * @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
@@ -1120,13 +1104,13 @@ int maps_service_search_place_by_address(const maps_service_h maps,
  * @{
  * @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.
@@ -1167,8 +1151,8 @@ typedef bool(*maps_service_search_route_cb) (maps_error_e error,
  *            %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
@@ -1180,9 +1164,8 @@ typedef bool(*maps_service_search_route_cb) (maps_error_e error,
  * @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
@@ -1223,8 +1206,8 @@ int maps_service_search_route(const maps_service_h maps,
  *            %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.
@@ -1237,9 +1220,8 @@ int maps_service_search_route(const maps_service_h maps,
  * @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