From: a.shulga Date: Wed, 18 Nov 2015 03:27:57 +0000 (+0900) Subject: [Maps Service] Fixing doxygen of Maps Services X-Git-Tag: submit/tizen/20151119.032512^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=c43e9da86131684656e4e685a07dbadcc520bab1;p=platform%2Fcore%2Fapi%2Fmaps-service.git [Maps Service] Fixing doxygen of Maps Services Change-Id: I3e48851b3fe46a2d5f15ef746faef72dde9dee4d Signed-off-by: a.shulga --- diff --git a/include/maps_error.h b/include/maps_error.h index 948998c..3efec42 100644 --- a/include/maps_error.h +++ b/include/maps_error.h @@ -41,35 +41,48 @@ extern "C" { * @since_tizen 2.4 */ typedef enum _maps_error_e { + MAPS_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ + MAPS_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission Denied */ + MAPS_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ + MAPS_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ + MAPS_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ + MAPS_ERROR_CONNECTION_TIME_OUT = TIZEN_ERROR_CONNECTION_TIME_OUT,/**< Timeout error, no answer */ + MAPS_ERROR_NETWORK_UNREACHABLE = TIZEN_ERROR_NETWORK_UNREACHABLE,/**< Network unavailable*/ + MAPS_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Operation is not valid */ + MAPS_ERROR_KEY_NOT_AVAILABLE = TIZEN_ERROR_KEY_NOT_AVAILABLE, /**< Invalid key */ + MAPS_ERROR_RESOURCE_BUSY = TIZEN_ERROR_RESOURCE_BUSY, /**< Maps Service busy */ + MAPS_ERROR_CANCELED = - TIZEN_ERROR_CANCELED, /**< Maps Service - request aborted */ + TIZEN_ERROR_CANCELED, /**< Maps Service request aborted */ + MAPS_ERROR_UNKNOWN = TIZEN_ERROR_UNKNOWN, /**< Unknown error */ + MAPS_ERROR_SERVICE_NOT_AVAILABLE = - TIZEN_ERROR_MAPS_SERVICE | 0x01,/**< Service - unavailable */ + TIZEN_ERROR_MAPS_SERVICE | 0x01,/**< Service unavailable */ + MAPS_ERROR_NOT_FOUND = TIZEN_ERROR_MAPS_SERVICE | 0x02/**< Result not found */ + } maps_error_e; #ifdef __cplusplus diff --git a/include/maps_preference.h b/include/maps_preference.h index d9cbb95..9faf4af 100644 --- a/include/maps_preference.h +++ b/include/maps_preference.h @@ -43,21 +43,21 @@ extern "C" { * keys are following strings: * * * Place search preferences -* - MAPS_PLACE_FILTER_TYPE -* - MAPS_PLACE_FILTER_SORT_BY +* - #MAPS_PLACE_FILTER_TYPE +* - #MAPS_PLACE_FILTER_SORT_BY * * * Route search preferences -* - MAPS_ROUTE_FREEFORM_ADDR_TO_AVOID -* - MAPS_ROUTE_STRUCTED_ADDR_TO_AVOID -* - MAPS_ROUTE_CIRCLE_AREA_TO_AVOID -* - MAPS_ROUTE_RECT_AREA_TO_AVOID +* - #MAPS_ROUTE_FREEFORM_ADDR_TO_AVOID +* - #MAPS_ROUTE_STRUCTED_ADDR_TO_AVOID +* - #MAPS_ROUTE_CIRCLE_AREA_TO_AVOID +* - #MAPS_ROUTE_RECT_AREA_TO_AVOID * -* - MAPS_ROUTE_GEOMETRY_BOUNDING_BOX -* - MAPS_ROUTE_GEOMETRY_RETRIEVAL -* - MAPS_ROUTE_INSTRUCTION_GEOMETRY -* - MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX -* - MAPS_ROUTE_INSTRUCTION_RETRIEVAL -* - MAPS_ROUTE_REALTIME_TRAFFIC +* - #MAPS_ROUTE_GEOMETRY_BOUNDING_BOX +* - #MAPS_ROUTE_GEOMETRY_RETRIEVAL +* - #MAPS_ROUTE_INSTRUCTION_GEOMETRY +* - #MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX +* - #MAPS_ROUTE_INSTRUCTION_RETRIEVAL +* - #MAPS_ROUTE_REALTIME_TRAFFIC * . * . */ diff --git a/include/maps_service.h b/include/maps_service.h index eb7bac7..e262465 100644 --- a/include/maps_service.h +++ b/include/maps_service.h @@ -57,25 +57,35 @@ extern "C" { * @since_tizen 2.4 */ typedef enum _maps_service_e { - MAPS_SERVICE_GEOCODE, /** Indicates that - maps_service_geocode() service is allowed */ - MAPS_SERVICE_GEOCODE_INSIDE_AREA, /** Indicates that - maps_service_geocode_iside_area() service is allowed */ - MAPS_SERVICE_GEOCODE_BY_STRUCTURED_ADDRESS, /** Indicates that - maps_service_geocode_by_structured_address() service is allowed */ - MAPS_SERVICE_REVERSE_GEOCODE, /** Indicates that - maps_service_reverse_geocode() service is allowed */ - MAPS_SERVICE_SEARCH_PLACE, /** Indicates that - maps_service_place() service is allowed */ - MAPS_SERVICE_SEARCH_PLACE_BY_AREA, /** Indicates that + + MAPS_SERVICE_GEOCODE, /**< Indicates that maps_service_geocode() + service is allowed */ + + MAPS_SERVICE_GEOCODE_INSIDE_AREA, /**< Indicates that + maps_service_geocode_inside_area() service is allowed */ + + MAPS_SERVICE_GEOCODE_BY_STRUCTURED_ADDRESS, /**< Indicates that + maps_service_geocode_by_structured_address() service is + allowed */ + + MAPS_SERVICE_REVERSE_GEOCODE, /**< Indicates that + maps_service_reverse_geocode() service is allowed */ + + MAPS_SERVICE_SEARCH_PLACE, /**< Indicates that + maps_service_search_place() service is allowed */ + + MAPS_SERVICE_SEARCH_PLACE_BY_AREA, /**< Indicates that maps_service_search_place_by_area() service is allowed */ - MAPS_SERVICE_SEARCH_PLACE_BY_ADDRESS, /** Indicates that + + MAPS_SERVICE_SEARCH_PLACE_BY_ADDRESS, /**< Indicates that maps_service_search_place_by_address() service is allowed */ - MAPS_SERVICE_SEARCH_ROUTE, /** Indicates that - maps_service_search_route() service is allowed */ - MAPS_SERVICE_SEARCH_ROUTE_WAYPOINTS, /** Indicates that + + MAPS_SERVICE_SEARCH_ROUTE, /**< Indicates that + maps_service_search_route() service is allowed */ + + MAPS_SERVICE_SEARCH_ROUTE_WAYPOINTS, /**< Indicates that maps_service_search_route_waypoints() service is allowed */ - MAPS_SERVICE_CANCEL_REQUEST /** Indicates that + MAPS_SERVICE_CANCEL_REQUEST /**< Indicates that maps_service_cancel_request() service is allowed */ } maps_service_e; @@ -84,34 +94,48 @@ typedef enum _maps_service_e { * @since_tizen 2.4 */ typedef enum _maps_service_data_e { - MAPS_PLACE_ADDRESS, /**< Indicates the address value in the - Place data*/ - MAPS_PLACE_RATING, /**< Indicates the rating value in the - Place data*/ - MAPS_PLACE_CATEGORIES, /**< Indicates the place category list - in the Place data*/ - MAPS_PLACE_ATTRIBUTES, /**< Indicates the place attribute - list in the Place data*/ - MAPS_PLACE_CONTACTS, /**< Indicates the place contact list in - the Place data*/ - MAPS_PLACE_EDITORIALS, /**< Indicates the place editorial list - in the Place data*/ - MAPS_PLACE_REVIEWS, /**< Indicates the place review list in - the Place data*/ - MAPS_PLACE_IMAGE, /**< Indicates the place image in Place - the data*/ - MAPS_PLACE_SUPPLIER, /**< Indicates the place supplier link - value in the Place data*/ - MAPS_PLACE_RELATED, /**< Indicates the related place link in - the Place data*/ - MAPS_ROUTE_PATH, /**< Indicates that the Route Data - Structure is defined as a Path (a list of geographical coordinates) */ - MAPS_ROUTE_SEGMENTS_PATH, /**< Indicates that the Route Data - Structure is defined as a list of Segments while each segment is defined - as a Path*/ - MAPS_ROUTE_SEGMENTS_MANEUVERS /**< Indicates that the Route Data - Structure is defined as a list of Segments while each segment is defined - as a list of Maneuvers*/ + + MAPS_PLACE_ADDRESS, /**< Indicates the availability of address value + in the Place data */ + + MAPS_PLACE_RATING, /**< Indicates the availability of rating value in + the Place data */ + + MAPS_PLACE_CATEGORIES, /**< Indicates the availability of place category + list in the Place data */ + + MAPS_PLACE_ATTRIBUTES, /**< Indicates the availability of place + attribute list in the Place data */ + + MAPS_PLACE_CONTACTS, /**< Indicates the availability of place contact + list in the Place data */ + + MAPS_PLACE_EDITORIALS, /**< Indicates the availability of place + editorial list in the Place data */ + + MAPS_PLACE_REVIEWS, /**< Indicates the availability of place review list + in the Place data */ + + MAPS_PLACE_IMAGE, /**< Indicates the availability of place image in + Place the data */ + + MAPS_PLACE_SUPPLIER, /**< Indicates the availability of place supplier + link value in the Place data */ + + MAPS_PLACE_RELATED, /**< Indicates the availability of related place + link in the Place data */ + + MAPS_ROUTE_PATH, /**< Indicates that the Route Data Structure is defined + as a Path (a list of geographical coordinates) */ + + MAPS_ROUTE_SEGMENTS_PATH, /**< Indicates that the Route Data Structure + is defined as a list of Segments while each segment is defined + as a Path */ + + MAPS_ROUTE_SEGMENTS_MANEUVERS /**< Indicates that the Route Data + Structure is defined as a list of Segments while each segment is + defined as a list of Maneuvers*/ + } maps_service_data_e; /** @@ -181,12 +205,15 @@ 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 maps_service_provider_is_service_supported() and maps_service_provider_is_data_supported() - * to check the Maps Provider's capabilities + * \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 * * @param[in] maps_provider The name of Maps Provider * @param[out] maps A handle of the new Maps Service on success @@ -238,13 +265,14 @@ 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 * documentation. - * \n To get app_id and app_code of HERE, visit https://developer.here.com/, https://developer.here.com/rest-apis. + * \n To get app_id and app_code of HERE, visit https://developer.here.com/, + * https://developer.here.com/rest-apis. * * @param[in] maps The Maps Service handle * @param[in] provider_key The Maps Key to be used @@ -336,7 +364,8 @@ 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. @@ -388,7 +417,7 @@ 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 geocode, + * @details This function cancels the service request initiated by geocoder, * route or place search. * @since_tizen 2.4 * @privlevel public @@ -525,8 +554,8 @@ typedef void (*maps_service_reverse_geocode_cb) (maps_error_e result, void *user_data); /** - * @brief Gets the position coordinates for a given address. The request - * is asynchronous. + * @brief Gets the position coordinates for a given address. + * \n The request is asynchronous. * @details This function obtains position coordinates for a given free-formed * address string. * @since_tizen 2.4 @@ -536,8 +565,9 @@ typedef void (*maps_service_reverse_geocode_cb) (maps_error_e result, * %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 and which Geocode - * preferences are supported, see the lists of capacities and preferences above. + * \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 @@ -568,6 +598,7 @@ typedef void (*maps_service_reverse_geocode_cb) (maps_error_e result, * @see maps_service_geocode_cb() * @see maps_service_cancel_request() * @see maps_service_reverse_geocode() + * @see maps_service_provider_is_service_supported() */ int maps_service_geocode(const maps_service_h maps, const char *address, const maps_preference_h preference, @@ -576,7 +607,8 @@ int maps_service_geocode(const maps_service_h maps, const char *address, /** * @brief Gets the position for a given address, within the specified - * bounding box. The request is asynchronous. + * bounding box. + * \n The request is asynchronous. * @details This function obtains position coordinates for a given free-formed * address string within the specified bounding box. * @since_tizen 2.4 @@ -587,8 +619,9 @@ int maps_service_geocode(const maps_service_h maps, const char *address, * @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 and which Geocode - * preferences are supported, see the lists of capacities and preferences above. + * \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 @@ -624,6 +657,7 @@ int maps_service_geocode(const maps_service_h maps, const char *address, * @see maps_service_geocode() * @see maps_service_cancel_request() * @see maps_service_reverse_geocode() + * @see maps_service_provider_is_service_supported() */ int maps_service_geocode_inside_area(const maps_service_h maps, const char *address, @@ -633,8 +667,8 @@ int maps_service_geocode_inside_area(const maps_service_h maps, void *user_data, int *request_id); /** - * @brief Gets the position coordinates for a given address. The request - * is asynchronous. + * @brief Gets the position coordinates for a given address. + * \n The request is asynchronous. * @details This function obtains position coordinates for a given structured * address. * @since_tizen 2.4 @@ -644,8 +678,9 @@ int maps_service_geocode_inside_area(const maps_service_h maps, * %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 and which Geocode - * preferences are supported see the lists of capacities and preferences above. + * \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 @@ -677,6 +712,7 @@ int maps_service_geocode_inside_area(const maps_service_h maps, * @see maps_service_geocode_cb() * @see maps_service_cancel_request() * @see maps_service_reverse_geocode() + * @see maps_service_provider_is_service_supported() */ int maps_service_geocode_by_structured_address(const maps_service_h maps, const maps_address_h address, @@ -687,8 +723,8 @@ int maps_service_geocode_by_structured_address(const maps_service_h maps, int *request_id); /** - * @brief Gets the address for a given position coordinates. The request - * is asynchronous. + * @brief Gets the address for a given position coordinates. + * \n The request is asynchronous. * @details This function obtains structured address information for a given * position coordinates. * @since_tizen 2.4 @@ -698,9 +734,9 @@ int maps_service_geocode_by_structured_address(const maps_service_h maps, * %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 and which - * Reverse Geocode preferences are supported, see the lists of capacities and - * preferences above. + * \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) @@ -731,6 +767,7 @@ int maps_service_geocode_by_structured_address(const maps_service_h maps, * @see maps_service_reverse_geocode_cb() * @see maps_service_cancel_request() * @see maps_service_geocode() + * @see maps_service_provider_is_service_supported() */ int maps_service_reverse_geocode(const maps_service_h maps, double latitude, double longitude, @@ -793,7 +830,8 @@ typedef bool(*maps_service_search_place_cb) (maps_error_e error, /** * @brief Queries a Place information by a coordinates position and a - * distance. The request is asynchronous. + * distance. + * \n The request is asynchronous. * @details This function obtains the Place information for a specified distance * around a given coordinates position. * @since_tizen 2.4 @@ -803,12 +841,12 @@ typedef bool(*maps_service_search_place_cb) (maps_error_e error, * %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 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. + * \n To check if Maps Provider is capable of Place Search 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 + * maps_service_provider_is_data_supported() with values, listed in + * #maps_service_data_e passed as @a data parameter. * * @param[in] maps The Maps Service handle * @param[in] position The interested position @@ -843,6 +881,8 @@ typedef bool(*maps_service_search_place_cb) (maps_error_e error, * @see maps_service_search_place_by_address() * @see maps_service_cancel_request() * @see maps_service_search_place_cb() + * @see maps_service_provider_is_service_supported() + * @see maps_service_provider_is_data_supported() */ int maps_service_search_place(const maps_service_h maps, const maps_coordinates_h position, int distance, @@ -852,8 +892,8 @@ int maps_service_search_place(const maps_service_h maps, void *user_data, int *request_id); /** - * @brief Queries a Place information by a coordinates boundary. The - * request is asynchronous. + * @brief Queries a Place information by a coordinates boundary. + * \n The request is asynchronous. * @details This function obtains the Place information for a specified * coordinates boundary. * @since_tizen 2.4 @@ -864,11 +904,12 @@ int maps_service_search_place(const maps_service_h maps, * @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 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. + * \n To check if Maps Provider is capable of Place Search 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 + * maps_service_provider_is_data_supported() with values, listed in + * #maps_service_data_e passed as @a data parameter. * * @param[in] maps The Maps Service handle * @param[in] boundary The interested area @@ -903,6 +944,8 @@ int maps_service_search_place(const maps_service_h maps, * @see maps_service_search_place_by_address() * @see maps_service_cancel_request() * @see maps_service_search_place_cb() + * @see maps_service_provider_is_service_supported() + * @see maps_service_provider_is_data_supported() */ int maps_service_search_place_by_area(const maps_service_h maps, const maps_area_h boundary, @@ -913,9 +956,9 @@ int maps_service_search_place_by_area(const maps_service_h maps, /** * @brief Queries a Place information by a free-formed address string. - * The request is asynchronous. - * @details This function obtains the Place information for a specified free- - * formed address string. + * \n The request is asynchronous. + * @details This function obtains the Place information for a specified + * free-formed address string. * @since_tizen 2.4 * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n @@ -924,8 +967,12 @@ int maps_service_search_place_by_area(const maps_service_h maps, * @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 and which Place - * preferences are supported, see the lists of capacities and preferences above. + * \n To check if Maps Provider is capable of Place Search 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 + * #maps_service_data_e passed as @a data parameter. * * @param[in] maps The Maps Service handle * @param[in] address The interested address @@ -960,6 +1007,8 @@ int maps_service_search_place_by_area(const maps_service_h maps, * @see maps_service_search_place_by_area() * @see maps_service_cancel_request() * @see maps_service_search_place_cb() + * @see maps_service_provider_is_service_supported() + * @see maps_service_provider_is_data_supported() */ int maps_service_search_place_by_address(const maps_service_h maps, const char *address, @@ -985,10 +1034,10 @@ int maps_service_search_place_by_address(const maps_service_h maps, * * @addtogroup CAPI_MAPS_ROUTE_MODULE * @{ - * @brief This provides APIs for Rote Service - * @details The Maps Route API provides ways to calculate a route that defines a - * path between a start and a destination and may, - * optionally, pass through specific intermediate locations. + * @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 + * through specific intermediate locations. * */ @@ -1024,8 +1073,8 @@ typedef bool(*maps_service_search_route_cb) (maps_error_e error, void *user_data); /** - * @brief Queries the Route from origin coordinate to a destination. - * The request is asynchronous. + * @brief Queries the Route from origin coordinates to destination. + * \n The request is asynchronous. * @details This function gets the Route information for a specified origin and * destination coordinates. * @since_tizen 2.4 @@ -1035,8 +1084,12 @@ typedef bool(*maps_service_search_route_cb) (maps_error_e error, * %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 and which Route - * preferences are supported, see the lists of capacities and preferences above. + * \n To check if Maps Provider is capable of Route Search 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 + * maps_service_provider_is_data_supported() with values, listed in + * #maps_service_data_e passed as @a data parameter. * * @param[in] maps The Maps Service handle * @param[in] origin The starting point @@ -1065,6 +1118,8 @@ typedef bool(*maps_service_search_route_cb) (maps_error_e error, * @see maps_service_search_route_waypoints() * @see maps_service_cancel_request() * @see maps_service_search_route_cb() + * @see maps_service_provider_is_service_supported() + * @see maps_service_provider_is_data_supported() */ int maps_service_search_route(const maps_service_h maps, const maps_coordinates_h origin, @@ -1074,8 +1129,8 @@ int maps_service_search_route(const maps_service_h maps, void *user_data, int *request_id); /** - * @brief Queries the Route, passing through a specified way points. The - * request is asynchronous. + * @brief Queries the Route, passing through a specified way points. + * \n The request is asynchronous. * @details This function gets the Route information for the Route, passing * through a specified set of way points. * @since_tizen 2.4 @@ -1085,8 +1140,13 @@ int maps_service_search_route(const maps_service_h maps, * %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 and which Route - * preferences are supported, see the lists of capacities and preferences above. + * \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. + * \n Check available data features in the search result using + * maps_service_provider_is_data_supported() with values, listed in + * #maps_service_data_e passed as @a data parameter. * * @param[in] maps The Maps Service handle * @param[in] waypoint_list The list of way points to go through @@ -1115,6 +1175,8 @@ int maps_service_search_route(const maps_service_h maps, * @see maps_service_search_route() * @see maps_service_cancel_request() * @see maps_service_search_route_cb() + * @see maps_service_provider_is_service_supported() + * @see maps_service_provider_is_data_supported() */ int maps_service_search_route_waypoints(const maps_service_h maps, const maps_coordinates_h *