From: chanywa Date: Wed, 8 Feb 2017 11:52:57 +0000 (+0900) Subject: Merge tizen branch into devel X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fheads%2Fdevel;p=platform%2Fcore%2Fapi%2Fmaps-service.git Merge tizen branch into devel Change-Id: Ia74729f9c0dfc8f1c9a1ee297578484df19139ac --- diff --git a/CMakeLists.txt b/CMakeLists.txt index 43ffc6d..d7cf1e3 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -61,10 +61,6 @@ IF("${ARCH}" STREQUAL "arm") ADD_DEFINITIONS("-DTARGET") ENDIF("${ARCH}" STREQUAL "arm") -IF("${PROFILE}" STREQUAL "wearable") - ADD_DEFINITIONS("-DTIZEN_WEARABLE") -ENDIF("${PROFILE}" STREQUAL "wearable") - ADD_DEFINITIONS("-DPREFIX=\"${CMAKE_INSTALL_PREFIX}\"") ADD_DEFINITIONS("-DEXPORT_API=__attribute__((visibility(\"default\")))") #ADD_DEFINITIONS("-DTIZEN_DEBUG") diff --git a/capi-maps-service.changes b/capi-maps-service.changes index a04a5a7..4b6508e 100644 --- a/capi-maps-service.changes +++ b/capi-maps-service.changes @@ -1,3 +1,8 @@ +[Version] capi-maps-service_0.6.9 +[Date] 24 Nov 2016 +[Title] added an api for plugins to get length of maps_item_list_h +[Developer] Seechan Kim + [Version] capi-maps-service_0.6.8 [Date] 11 Nov 2016 [Title] fixed some bugs and improved gestures diff --git a/doc/maps_plugin_doc.h b/doc/maps_plugin_doc.h index 244014c..be295ae 100644 --- a/doc/maps_plugin_doc.h +++ b/doc/maps_plugin_doc.h @@ -18,21 +18,21 @@ #ifndef __MAPS_PLUGIN_DOC_H__ #define __MAPS_PLUGIN_DOC_H__ /** - * @ingroup CAPI_LOCATION_FRAMEWORK - * @defgroup CAPI_MAPS_PLUGIN_MODULE Maps Plugin + * @ingroup CAPI_LOCATION_FRAMEWORK + * @defgroup CAPI_MAPS_PLUGIN_MODULE Maps Plugin * - * @brief The Maps Plugin provides maps service providers with interfaces + * @brief The Maps Plugin provides maps service providers with interfaces * to realize Maps Service APIs. * - * @section CAPI_MAPS_PLUGIN_MODULE_HEADER Required Header + * @section CAPI_MAPS_PLUGIN_MODULE_HEADER Required Header * \#include - * @section CAPI_MAPS_PLUGIN_MODULE_OVERVIEW Overview + * @section CAPI_MAPS_PLUGIN_MODULE_OVERVIEW Overview * * The Maps Plugin provides maps service providers with interfaces to realize * Maps Service APIs. * - * @section CAPI_MAPS_SERVICE_MODULE_FEATURE Related Feature + * @section CAPI_MAPS_SERVICE_MODULE_FEATURE Related Feature * This API is related with the following feature:\n * - http://tizen.org/feature/maps\n */ diff --git a/doc/maps_service_doc.h b/doc/maps_service_doc.h index 2af7937..5253f48 100644 --- a/doc/maps_service_doc.h +++ b/doc/maps_service_doc.h @@ -18,30 +18,23 @@ #ifndef __MAPS_SERVICE_DOC_H__ #define __MAPS_SERVICE_DOC_H__ + /** - * @ingroup CAPI_LOCATION_FRAMEWORK - * @defgroup CAPI_MAPS_SERVICE_MODULE Maps Service - * - * @brief The Maps Service provides an Application Developer with Maps - * Service APIs - * - * @section CAPI_MAPS_SERVICE_MODULE_HEADER Required Header + * @ingroup CAPI_LOCATION_FRAMEWORK + * @defgroup CAPI_MAPS_SERVICE_MODULE Maps Service + * @brief The Maps Service provides an Application Developer with Maps Service APIs. + * @section CAPI_MAPS_SERVICE_MODULE_HEADER Required Header * \#include * - * @section CAPI_MAPS_SERVICE_MODULE_OVERVIEW Overview - * - * Maps API provides a developer with a set of functions, helping to create Maps - * aware applications\n - * Maps API comprises following features: - * - Geocoding and reverse geocoding - * - Discovering Place information - * - Calculating Route - * - View - * . - * - * Maps API allows a Developer to choose one of Map Providers which are being - * included as plugins - * + * @section CAPI_MAPS_SERVICE_MODULE_OVERVIEW Overview + * Maps API provides a developer with a set of functions, helping to create Maps aware applications.\n + * Maps API comprises of the following features: + * - Geocoding and reverse geocoding + * - Discovering Place information + * - Calculating Route + * - View + * . + * Maps API allows a Developer to choose one of Map Providers which are being included as plugins. * Geocoding * - The Maps Geocoding API allows translating an address to its geographical * location defined in terms of latitude and longitude; the input can be a @@ -56,13 +49,11 @@ * - state=Berlin * . * . - * * Reverse Geocoding * - The Maps Reverse Geocoding API allows to inverse translating a geographical * location (longitude, latitude) to an address; it can be used to answer the * question "Where am I?". * . - * * Route * - 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 @@ -81,69 +72,51 @@ * . * . * Places - * - The Maps Place API allows you to find place information + * - The Maps Place API allows you to find place information. * - Place search * - Depending on the location context, the number of relevant places might * be large. Therefore this query may not only return places, but also * suggestions for additional filter criteria that allow users to interactively * refine the classes of places they are interested in. - * * - Nearby Search: search for places within a specified area. * You can refine your search request by supplying keywords, Name of Points - * of Interests, or Proximity - * - * - Category Search: search for popular places for the given location context - * and matching the category filter criteria. - * You can refine your search request by specifying the categories of place - * you are searching for. - * + * of Interests, or Proximity. + * - Category Search: search for popular places for the given location context and matching the category filter criteria. + * You can refine your search request by specifying the categories of place you are searching for. * - Result item type of searching - * - id, name, location, distance, URI, rating, category. - * - * - Place information allows to fetch details about a place. The following - * place content is supported: - * - Base Attribute includes name, location, categories, contacts, id, ratings, - * icon path, image content, review content, and editorial content. - * - Extended Attribute refers to opening hours, payment methods, annual - * closings, disabled access. + * - ID, name, location, distance, URI, rating, category. + * - Place information allows to fetch details about a place. The following place content is supported: + * - Base Attribute includes name, location, categories, contacts, ID, ratings, icon path, image content, review content, and editorial content. + * - Extended Attribute refers to opening hours, payment methods, annual closings, disabled access. * . * . * View * - The Maps View API provides a developer with a set of functions, bringing * basic interactive visual user interface in maps applications. - * - * - View widget : Drawing a map image on the map port, the specified rectangular + * - View widget: Drawing a map image on the map port, the specified rectangular * area of the maps application GUI. - * - * - Zoom and rotation : Changing zoom and orientation of the view in response - * on user gestures, such as scrolling, tapping, zooming, rotating, etc. - * + * - Zoom and rotation: Changing zoom and orientation of the view in response + * to user gestures, such as scrolling, tapping, zooming, rotating, etc. * - Conversion of screen coordinates to geographical and vise versa. - * - * - User's gesture support. + * - User's gesture support: * - Receive the event of the user gesture. * - Enable or disable the specified gesture. - * - Re-assign the action, which should be taken in response on the user's gesture. - * - * - Various Properties. + * - Re-assign the action, which should be taken in response to the user's gesture. + * - Various Properties: * - Visibility and size on the screen. - * - Theme : Day, satellite or terrain. - * - Language : English, Russian, Chinese, Italian, German, Spanish, etc. + * - Theme: Day, satellite, or terrain. + * - Language: English, Russian, Chinese, Italian, German, Spanish, etc. * . * . - * The developer is allowed to choose one of map providers by manipulating map - * plug-ins. - * + * The developer is allowed to choose one of the map providers by manipulating map plugins. * * @section CAPI_MAPS_SERVICE_MODULE_FEATURE Related Features * This API is related with the following features:\n * - http://tizen.org/feature/maps\n - * * It is recommended to design feature related codes in your application for reliability.\n * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n * More details on featuring your application can be found from Feature Element. - * */ #endif /*__MAPS_SERVICE_DOC_H__ */ diff --git a/include/maps_address.h b/include/maps_address.h index 6aff829..2396d4a 100644 --- a/include/maps_address.h +++ b/include/maps_address.h @@ -14,618 +14,589 @@ * limitations under the License. */ + #ifndef __MAPS_ADDRESS_H__ #define __MAPS_ADDRESS_H__ + /** - * @ingroup CAPI_MAPS_SERVICE_MODULE - * @defgroup CAPI_MAPS_ADDRESS_MODULE Address - * + * @ingroup CAPI_MAPS_SERVICE_MODULE + * @defgroup CAPI_MAPS_ADDRESS_MODULE Address * @file maps_address.h * @brief This file contains the functions related to address information. - * * @addtogroup CAPI_MAPS_ADDRESS_MODULE * @{ - * @brief This provides APIs related to Address information used in Geocoding - * and Reverse Geocoding + * @brief This provides APIs related to Address information used in Geocoding and Reverse Geocoding. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The address handle. - * @details The address handle can be obtained via calling of maps_address_create() + * @brief The address handle. + * @details The address handle can be obtained via calling of maps_address_create(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ typedef void *maps_address_h; + /** - * @brief The address list handle + * @brief The address list handle. * @details The address list handle can be obtained via calling of maps_address_list_create(). * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif */ typedef void *maps_address_list_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Creates a new address handle. - * @details This function creates a new address handle and allocates all - * needed resources. + * @brief Creates a new address handle. + * @details This function creates a new address handle and allocates all needed resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a address must be released using maps_address_destroy(). - * \n @a address may be cloned using maps_address_clone(). - * - * @param[out] address The address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a address must be released using maps_address_destroy().\n + * @a address may be cloned using maps_address_clone(). + * @param[out] address The address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_address_destroy() * @see maps_address_clone() */ int maps_address_create(maps_address_h *address); + /** - * @brief Destroys the address handle and releases all its resources. - * @details This function destroys the address handle and releases all its - * resources. + * @brief Destroys the address handle and releases all its resources. + * @details This function destroys the address handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address The address handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_create() * @see maps_address_clone() */ int maps_address_destroy(maps_address_h address); + /** - * @brief Clones the address handle. - * @details This function clones the address handle @a origin and all its - * resources. - * \n Address handle @a origin may be created using maps_address_create(). + * @brief Clones the address handle. + * @details This function clones the address handle @a origin and all its resources.\n + * Address handle @a origin may be created using maps_address_create(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_address_destroy(). - * - * @param[in] origin The original address handle - * @param[out] cloned A cloned address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original address handle + * @param[out] cloned A cloned address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a origin is created using maps_address_create(). - * * @see maps_address_create() * @see maps_address_destroy() */ int maps_address_clone(const maps_address_h origin, maps_address_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the building number of the address handle. + * @brief Gets the building number of the address handle. * @details This function gets the building number of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a building_number must be released using free(). - * - * @param[in] address The address handle - * @param[out] building_number The building number of the address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[out] building_number The building number of the address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_set_building_number() * @see maps_address_create() */ -int maps_address_get_building_number(const maps_address_h address, - char **building_number); +int maps_address_get_building_number(const maps_address_h address, char **building_number); + /** - * @brief Gets the street name of the address handle. + * @brief Gets the street name of the address handle. * @details This function gets the street name of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a street must be released using free(). - * - * @param[in] address The address handle - * @param[out] street The street name of the address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[out] street The street name of the address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_set_street() * @see maps_address_create() */ int maps_address_get_street(const maps_address_h address, char **street); + /** - * @brief Gets the district name of the address handle. + * @brief Gets the district name of the address handle. * @details This function gets the district name of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a district must be released using free(). - * - * @param[in] address The address handle - * @param[out] district The district name of the address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[out] district The district name of the address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_set_district() * @see maps_address_create() */ int maps_address_get_district(const maps_address_h address, char **district); + /** - * @brief Gets the city name of the address handle. + * @brief Gets the city name of the address handle. * @details This function gets the city name of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a city must be released using free(). - * - * @param[in] address The address handle - * @param[out] city The city name of the address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[out] city The city name of the address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_set_city() * @see maps_address_create() */ int maps_address_get_city(const maps_address_h address, char **city); + /** - * @brief Gets the state name of the address handle + * @brief Gets the state name of the address handle. * @details This function gets the state name of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a state must be released using free(). - * - * @param[in] address The address handle - * @param[out] state The state name of the address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[out] state The state name of the address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_set_state() * @see maps_address_create() */ int maps_address_get_state(const maps_address_h address, char **state); + /** - * @brief Gets the country name of the address handle. + * @brief Gets the country name of the address handle. * @details This function gets the country name of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a country must be released using free(). - * - * @param[in] address The address handle - * @param[out] country The country name of the address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[out] country The country name of the address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_set_country() * @see maps_address_create() */ int maps_address_get_country(const maps_address_h address, char **country); + /** - * @brief Gets the country code of the address handle. + * @brief Gets the country code of the address handle. * @details This function gets the country code of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a country_code must be released using free(). - * - * @param[in] address The address handle - * @param[out] country_code The country code of the address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[out] country_code The country code of the address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_set_country_code() * @see maps_address_create() */ -int maps_address_get_country_code(const maps_address_h address, - char **country_code); +int maps_address_get_country_code(const maps_address_h address, char **country_code); + /** - * @brief Gets the county of the address handle. + * @brief Gets the county of the address handle. * @details This function gets the county of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a county must be released using free(). - * - * @param[in] address The address handle - * @param[out] county The county of the address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[out] county The county of the address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_set_county() * @see maps_address_create() */ int maps_address_get_county(const maps_address_h address, char **county); + /** - * @brief Gets the postal code of the address handle. + * @brief Gets the postal code of the address handle. * @details This function gets the postal code of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a postal_code must be released using free(). - * - * @param[in] address The address handle - * @param[out] postal_code The postal code of the address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[out] postal_code The postal code of the address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_set_postal_code() * @see maps_address_create() */ -int maps_address_get_postal_code(const maps_address_h address, - char **postal_code); +int maps_address_get_postal_code(const maps_address_h address, char **postal_code); + /** - * @brief Gets the free text of the address handle. + * @brief Gets the free text of the address handle. * @details This function gets the free text of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a freetext must be released using free(). - * - * @param[in] address The address handle - * @param[out] freetext The free text of the address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[out] freetext The free text of the address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_set_freetext() * @see maps_address_create() */ int maps_address_get_freetext(const maps_address_h address, char **freetext); + /*----------------------------------------------------------------------------*/ + /** - * @brief Sets the building number of the address handle. + * @brief Sets the building number of the address handle. * @details This function sets the building number of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address The address handle - * @param[in] building_number The building number to be set - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[in] building_number The building number to be set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_create() * @see maps_address_get_number() */ -int maps_address_set_building_number(maps_address_h address, - const char *building_number); +int maps_address_set_building_number(maps_address_h address, const char *building_number); + /** - * @brief Sets the street name of the address handle. + * @brief Sets the street name of the address handle. * @details This function sets the street name of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address The address handle - * @param[in] street The street name to be set - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[in] street The street name to be set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_create() * @see maps_address_get_street() */ int maps_address_set_street(maps_address_h address, const char *street); + /** - * @brief Sets the district name of the address handle. + * @brief Sets the district name of the address handle. * @details This function sets the district name of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address The address handle - * @param[in] district The district name to be set - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[in] district The district name to be set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_create() * @see maps_address_get_district() */ int maps_address_set_district(maps_address_h address, const char *district); + /** - * @brief Sets the city name of the address handle. + * @brief Sets the city name of the address handle. * @details This function sets the city name of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address The address handle - * @param[in] city The city name to be set - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[in] city The city name to be set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_create() * @see maps_address_get_city() */ int maps_address_set_city(maps_address_h address, const char *city); + /** - * @brief Sets the state name of the address handle. + * @brief Sets the state name of the address handle. * @details This function sets the state name of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address The address handle - * @param[in] state The state name to be set - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[in] state The state name to be set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_create() * @see maps_address_get_state() */ int maps_address_set_state(maps_address_h address, const char *state); + /** - * @brief Sets the country name of the address handle. + * @brief Sets the country name of the address handle. * @details This function sets the country name of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address The address handle - * @param[in] country The country name to be set - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[in] country The country name to be set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_create() * @see maps_address_get_country() */ int maps_address_set_country(maps_address_h address, const char *country); + /** - * @brief Sets the country code of the address handle. + * @brief Sets the country code of the address handle. * @details This function sets the country code of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address The address handle - * @param[in] country_code The country code to be set - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[in] country_code The country code to be set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_create() * @see maps_address_get_country_code() */ -int maps_address_set_country_code(maps_address_h address, - const char *country_code); +int maps_address_set_country_code(maps_address_h address, const char *country_code); + /** - * @brief Sets the county of the address handle. + * @brief Sets the county of the address handle. * @details This function sets the county of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address The address handle - * @param[in] county The county to be set - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[in] county The county to be set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_create() * @see maps_address_get_county() */ int maps_address_set_county(maps_address_h address, const char *county); + /** - * @brief Sets the postal code of the address handle. + * @brief Sets the postal code of the address handle. * @details This function sets the postal code of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address The address handle - * @param[in] postal_code The postal code to be set - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[in] postal_code The postal code to be set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_create() * @see maps_address_get_postal_code() */ -int maps_address_set_postal_code(maps_address_h address, - const char *postal_code); +int maps_address_set_postal_code(maps_address_h address, const char *postal_code); + /** - * @brief Sets the free text of the address handle. + * @brief Sets the free text of the address handle. * @details This function sets the free text of the address handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address The address handle - * @param[in] freetext The free text to be set - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address The address handle + * @param[in] freetext The free text to be set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a address is created using maps_address_create(). - * * @see maps_address_create() * @see maps_address_get_freetext() */ int maps_address_set_freetext(maps_address_h address, const char *freetext); + /** - * @brief Creates a address list having a set of addresses. + * @brief Creates an address list having a set of addresses. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[out] address_list The address list handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[out] address_list The address list handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_address_list_destroy() */ int maps_address_list_create(maps_address_list_h *address_list); + /** - * @brief Appends an address to an address list. + * @brief Appends an address to an address list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks Don't release @a address before removed from the list using maps_address_list_remove(). - * - * @param[in] address_list The address list handle - * @param[in] address The address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks Don't release @a address before removed from the list using maps_address_list_remove(). + * @param[in] address_list The address list handle + * @param[in] address The address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_address_list_create() * @see maps_address_list_destroy() * @see maps_address_create() */ int maps_address_list_append(maps_address_list_h address_list, maps_address_h address); + /** - * @brief Removes an address from an address list. + * @brief Removes an address from an address list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks @a address is just excepted from the list.\n - * It must be released using maps_address_destroy(). - * - * @param[in] address_list The address list handle - * @param[in] address The address handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a address is just excepted from the list.\n + * It must be released using maps_address_destroy(). + * @param[in] address_list The address list handle + * @param[in] address The address handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_address_list_create() * @see maps_address_list_destroy() * @see maps_address_destroy() */ int maps_address_list_remove(maps_address_list_h address_list, maps_address_h address); + /** - * @brief Gets the number of elements in an address list. + * @brief Gets the number of elements in an address list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address_list The address list handle - * @param[out] length The number of elements in the address list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address_list The address list handle + * @param[out] length The number of elements in the address list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_address_list_create() * @see maps_address_list_destroy() */ int maps_address_list_get_length(maps_address_list_h address_list, int *length); + /** - * @brief Called iteratively to get address information. + * @brief Called iteratively to get address information. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] index The index of iteration - * @param[in] address The address handle - * @param[in] user_data The user data passed from the foreach function - * + * @param[in] index The index of iteration + * @param[in] address The address handle + * @param[in] user_data The user data passed from the foreach function * @return @c true to continue with the next iteration of the loop, \n * @c false to break out of the loop - * * @see maps_address_list_foreach() * @see maps_address_list_destroy() */ typedef bool (*maps_address_cb)(int index, maps_address_h address, void *user_data); + /** * @brief Retrieves all addresses by invoking a specific callback for each address of address list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address_list The address list handle - * @param[in] callback The iteration callback - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address_list The address list handle + * @param[in] callback The iteration callback + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_address_list_create() * @see maps_address_list_destroy() * @see maps_address_list_get_length() */ -int maps_address_list_foreach(maps_address_list_h address_list, - maps_address_cb callback, void *user_data); +int maps_address_list_foreach(maps_address_list_h address_list, maps_address_cb callback, void *user_data); + /** - * @brief Frees all of the memory used by a address list. + * @brief Frees all of the memory used by an address list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] address_list The address list handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] address_list The address list handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_address_list_create() */ int maps_address_list_destroy(maps_address_list_h address_list); @@ -637,4 +608,4 @@ int maps_address_list_destroy(maps_address_list_h address_list); /** * @} */ -#endif /* __MAPS_ADDRESS_H__ */ +#endif /* __MAPS_ADDRESS_H__ */ diff --git a/include/maps_area.h b/include/maps_area.h index b4362a5..98724de 100644 --- a/include/maps_area.h +++ b/include/maps_area.h @@ -14,36 +14,36 @@ * limitations under the License. */ + #ifndef __MAPS_GEOAREA_H__ #define __MAPS_GEOAREA_H__ + #include + /** - * @ingroup CAPI_MAPS_SERVICE_MODULE - * @defgroup CAPI_MAPS_GEOAREA_MODULE Area - * + * @ingroup CAPI_MAPS_SERVICE_MODULE + * @defgroup CAPI_MAPS_GEOAREA_MODULE Area * @file maps_area.h - * @brief This file contains the definitions, structures, and functions related - * to area information. - * + * @brief This file contains the definitions, structures, and functions related to area information. * @addtogroup CAPI_MAPS_GEOAREA_MODULE * @{ * @brief This provides APIs related to geographical area. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief Handle of the Geographical Area. - * @details The Geographical Area handle can be obtained via call of - * maps_area_create_rectangle() or maps_area_create_circle(). + * @brief Handle of the Geographical Area. + * @details The Geographical Area handle can be obtained via call of maps_area_create_rectangle() or maps_area_create_circle().\n + * To release the handle use maps_area_destroy().\n + * To clone the handle use maps_area_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * \n To release the handle use maps_area_destroy(). - * \n To clone the handle use maps_area_clone(). - * * @see maps_area_create_rectangle() * @see maps_area_create_circle() * @see maps_area_destroy() @@ -51,119 +51,106 @@ extern "C" { */ typedef void *maps_area_h; + /** - * @brief Enumeration of supported types of the Geographical Area. - * @details This enumeration represents allowed geographical type of - * Geographical Area: rectangular and circular. + * @brief Enumeration for supported types of the Geographical Area. + * @details This enumeration represents allowed geographical type of Geographical Area: rectangular and circular. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ typedef enum { - MAPS_AREA_NONE = 0, /**< Undefined geographical area type. */ - MAPS_AREA_RECTANGLE, /**< Rectangular geographical area type. */ - MAPS_AREA_CIRCLE, /**< Circle geographical area type. */ + MAPS_AREA_NONE = 0, /**< Undefined geographical area type. */ + MAPS_AREA_RECTANGLE, /**< Rectangular geographical area type. */ + MAPS_AREA_CIRCLE, /**< Circle geographical area type. */ } maps_area_type_e; + /** - * @brief Structure of the rectangular Geographical Area. - * @details This structure represents a rectangular Geographical Area, - * specified with left top and right bottom coordinates. - * @warning Do not use #maps_area_rectangle_s directly - * if you are an application developer. + * @brief Structure of the rectangular Geographical Area. + * @details This structure represents a rectangular Geographical Area, specified with left top and right bottom coordinates. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif + * @remarks Do not use #maps_area_rectangle_s directly if you are an application developer. */ typedef struct _maps_area_rectangle_s { - maps_coordinates_s top_left; /**< The top left position of rectangle. */ - maps_coordinates_s bottom_right; /**< The bottom right position of rectangle. */ + maps_coordinates_s top_left; /**< The top left position of rectangle. */ + maps_coordinates_s bottom_right; /**< The bottom right position of rectangle. */ } maps_area_rectangle_s; + /** - * @brief Structure of the circular Geographical Area, specified with a - * center coordinates and a radius. + * @brief Structure of the circular Geographical Area, specified with a center coordinates and a radius. * @details This structure represents a circular Geographical Area. - * @warning Do not use #maps_area_circle_s directly - * if you are an application developer. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif + * @remarks Do not use #maps_area_circle_s directly if you are an application developer. */ typedef struct _maps_area_circle_s { - maps_coordinates_s center; /**< The center position of a circle. */ - double radius; /**< The radius of a circle. */ + maps_coordinates_s center; /**< The center position of a circle. */ + double radius; /**< The radius of a circle. */ } maps_area_circle_s; + /** - * @brief Structure of the Geographical Area. - * @details This structure represents a Geographical Area, specified with a - * type, circular or rectangular, and appropriate coordinates and radius. - * @warning Do not use #maps_area_s directly - * if you are an application developer. - * Using #maps_area_h is recommended. + * @brief Structure of the Geographical Area. + * @details This structure represents a Geographical Area, specified with a type, circular or rectangular, and appropriate coordinates and radius. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif + * @remarks Do not use #maps_area_s directly if you are an application developer. + * Using #maps_area_h is recommended. */ typedef struct _maps_area_s { - maps_area_type_e type; /**< The area type of this information. */ + maps_area_type_e type; /**< The area type of this information. */ union { - maps_area_rectangle_s rect; /**< The geographical information of a rectangle. */ - maps_area_circle_s circle; /**< The geographical information of a circle. */ + maps_area_rectangle_s rect; /**< The geographical information of a rectangle. */ + maps_area_circle_s circle; /**< The geographical information of a circle. */ }; } maps_area_s; + /*----------------------------------------------------------------------------*/ + /** - * @brief Creates a rectangular type of new Geographical Area with a - * specified information. - * @details This function creates a rectangular type of new #maps_area_h with a - * specified left top and right bottom coordinates. + * @brief Creates a rectangular type of new Geographical Area with a specified information. + * @details This function creates a rectangular type of new #maps_area_h with a specified left top and right bottom coordinates. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a area must be released using maps_area_destroy(). - * \n @a area may be cloned using maps_area_clone(). - * \n @a top_left and @a bottom_right must be released using - * maps_coordinates_destroy(). - * - * @param[in] top_left The left top position - * @param[in] bottom_right The right bottom position - * @param[out] area The area handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a top_left and @a bottom_right are created using - * maps_coordinates_create(). - * + * @remarks @a area must be released using maps_area_destroy().\n + * @a area may be cloned using maps_area_clone().\n + * @a top_left and @a bottom_right must be released using maps_coordinates_destroy(). + * @param[in] top_left The left top position + * @param[in] bottom_right The right bottom position + * @param[out] area The area handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a top_left and @a bottom_right are created using maps_coordinates_create(). * @see maps_area_clone() * @see maps_area_destroy() * @see maps_area_create_circle() * @see maps_coordinates_create() * @see maps_coordinates_destroy() */ -int maps_area_create_rectangle(const maps_coordinates_h top_left, - const maps_coordinates_h bottom_right, - maps_area_h *area); +int maps_area_create_rectangle(const maps_coordinates_h top_left, const maps_coordinates_h bottom_right, maps_area_h *area); + /** - * @brief Creates a circular type of new Geographical Area with a - * specified information. - * @details This function creates a circular type of new #maps_area_h - * Geographical Area with a specified center coordinates and a radius. + * @brief Creates a circular type of new Geographical Area with a specified information. + * @details This function creates a circular type of new #maps_area_h Geographical Area with a specified center coordinates and a radius. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a area must be released using maps_area_destroy(). - * \n @a center must be released using maps_coordinates_destroy(). - * \n The @a radius is specified in units, listed in #maps_distance_unit_e. - * \n To get and set distance units use maps_preference_get_distance_unit() and - * maps_preference_set_distance_unit() respectively. - * - * @param[in] center The central position of the area - * @param[in] radius The radius of the area - * @param[out] area The area handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a area must be released using maps_area_destroy().\n + * @a center must be released using maps_coordinates_destroy().\n + * The @a radius is specified in units, listed in #maps_distance_unit_e.\n + * To get and set distance units use maps_preference_get_distance_unit() and maps_preference_set_distance_unit() respectively. + * @param[in] center The central position of the area + * @param[in] radius The radius of the area + * @param[out] area The area handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a center is created using maps_coordinates_create(). - * * @see maps_area_clone() * @see maps_area_destroy() * @see maps_area_create_rectangle() @@ -172,58 +159,52 @@ int maps_area_create_rectangle(const maps_coordinates_h top_left, * @see maps_preference_get_distance_unit() * @see maps_preference_set_distance_unit() */ -int maps_area_create_circle(const maps_coordinates_h center, - const double radius, maps_area_h *area); +int maps_area_create_circle(const maps_coordinates_h center, const double radius, maps_area_h *area); + /** - * @brief Destroys the Geographical Area and releases all its resources. - * @details This function destroys the Geographical Area #maps_area_h and - * releases all its resources. + * @brief Destroys the Geographical Area and releases all its resources. + * @details This function destroys the Geographical Area #maps_area_h and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] area The area #maps_area_h - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a area can be created using maps_area_create_rectangle() or - * maps_area_create_circle(). - * + * @param[in] area The area #maps_area_h + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a area can be created using maps_area_create_rectangle() or maps_area_create_circle(). * @see maps_area_create_rectangle() * @see maps_area_create_circle() */ int maps_area_destroy(maps_area_h area); + /** - * @brief Clones the Geographical Area. - * @details This function makes a clone of the @a origin Geographical Area of - * type #maps_area_h. + * @brief Clones the Geographical Area. + * @details This function makes a clone of the @a origin Geographical Area of type #maps_area_h. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_area_destroy(). - * - * @param[in] origin The area #maps_area_h to be copied - * @param[out] cloned The cloned area #maps_area_h handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a origin is created using maps_area_create_rectangle() or - * maps_area_create_circle(). - * + * @param[in] origin The area #maps_area_h to be copied + * @param[out] cloned The cloned area #maps_area_h handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a origin is created using maps_area_create_rectangle() or maps_area_create_circle(). * @see maps_area_create_rectangle() * @see maps_area_create_circle() * @see maps_area_destroy() */ int maps_area_clone(const maps_area_h origin, maps_area_h *cloned); + #ifdef __cplusplus } #endif /** * @} */ -#endif /* __MAPS_GOEAREA_H__ */ +#endif /* __MAPS_GOEAREA_H__ */ diff --git a/include/maps_coordinates.h b/include/maps_coordinates.h index fa2f7d5..44d7633 100644 --- a/include/maps_coordinates.h +++ b/include/maps_coordinates.h @@ -14,15 +14,17 @@ * limitations under the License. */ + #ifndef __MAPS_COORDINATES_H__ #define __MAPS_COORDINATES_H__ + #include + /** - * @ingroup CAPI_MAPS_SERVICE_MODULE - * @defgroup CAPI_MAPS_COORDS_MODULE Coordinates - * + * @ingroup CAPI_MAPS_SERVICE_MODULE + * @defgroup CAPI_MAPS_COORDS_MODULE Coordinates * @file maps_coordinates.h * @brief This file contains the functions related to Geographical Coordinates. * @addtogroup CAPI_MAPS_COORDS_MODULE @@ -30,356 +32,328 @@ * @brief This provides APIs related to Geographical Coordinates */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief Handle of the Geographical Coordinates. - * @details The Geographical Coordinates handle can be obtained via call of - * maps_coordinates_create(). + * @brief Handle of the Geographical Coordinates. + * @details The Geographical Coordinates handle can be obtained via call of maps_coordinates_create(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks To release the handle use maps_coordinates_destroy(). - * \n To clone the handle use maps_coordinates_clone(). + * @remarks To release the handle use maps_coordinates_destroy().\n + * To clone the handle use maps_coordinates_clone(). */ typedef void *maps_coordinates_h; + /** - * @brief Structure of the Geographical Coordinates. - * @details This structure represents a Geographical Coordinates, specified with - * a @a latitude and @a longitude values. - * \n The @a latitude must be in range of [-90.0, 90.0]. - * \n The @a longitude must be in range of [-180.0, 180.0]. + * @brief Structure of the Geographical Coordinates. + * @details This structure represents a Geographical Coordinates, specified with a @a latitude and @a longitude values.\n + * The @a latitude must be in range of [-90.0, 90.0].\n + * The @a longitude must be in range of [-180.0, 180.0]. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks #maps_coordinates_h is a void pointer to the #maps_coordinates_h. - * @warning Do not use #maps_coordinates_s directly if you are an application developer. - * Using #maps_coordinates_h is recommended. - * + * @remarks Do not use #maps_coordinates_s directly if you are an application developer. + * Using #maps_coordinates_h is recommended. * @see maps_coordinates_h */ typedef struct _maps_coordinates_s { - double latitude; /**< The latitude [-90.0 ~ 90.0] (degrees) */ - double longitude; /**< The longitude [-180.0 ~ 180.0] (degrees) */ + double latitude; /**< The latitude [-90.0 ~ 90.0] (degrees) */ + double longitude; /**< The longitude [-180.0 ~ 180.0] (degrees) */ } maps_coordinates_s; + /** - * @brief The coordinates list handle. + * @brief The coordinates list handle. * @details The coordinates list handle can be obtained via calling of maps_coordinates_list_create(). * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif */ typedef void *maps_coordinates_list_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Creates a new instance of Geographical Coordinates and initiates - * a handle with it. - * @details This function creates @a coordinates, a new instance of Geographical - * Coordinates of type #maps_coordinates_h - * with a specified @a latitude and @a longitude. - * \n New handle is assigned with this instance. + * @brief Creates a new instance of Geographical Coordinates and initiates a handle with it. + * @details This function creates @a coordinates, a new instance of Geographical Coordinates of type #maps_coordinates_h with a specified @a latitude and @a longitude.\n + * New handle is assigned with this instance. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a coordinates must be released using maps_coordinates_destroy(). - * \n @a coordinates may be cloned using maps_coordinates_clone(). - * - * @param[in] latitude The latitude [-90.0 ~ 90.0] (degrees) - * @param[in] longitude The longitude [-180.0 ~ 180.0] (degrees) - * @param[out] coordinates The coordinates handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a coordinates must be released using maps_coordinates_destroy().\n + * @a coordinates may be cloned using maps_coordinates_clone(). + * @param[in] latitude The latitude [-90.0 ~ 90.0] (degrees) + * @param[in] longitude The longitude [-180.0 ~ 180.0] (degrees) + * @param[out] coordinates The coordinates handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_coordinates_clone() * @see maps_coordinates_destroy() */ -int maps_coordinates_create(const double latitude, const double longitude, - maps_coordinates_h *coordinates); +int maps_coordinates_create(const double latitude, const double longitude, maps_coordinates_h *coordinates); + /** - * @brief Destroys the Geographical Coordinates and releases all its - * resources. - * @details This function destroys the Geographical Coordinates - * #maps_coordinates_h and releases all its resources. + * @brief Destroys the Geographical Coordinates and releases all its resources. + * @details This function destroys the Geographical Coordinates #maps_coordinates_h and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] coordinates The coordinate handle to destroy - * @return 0 on coordinates, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] coordinates The coordinate handle to destroy + * @return @c 0 on coordinates, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a coordinates are created using maps_coordinates_create_rectangle(). - * * @see maps_coordinates_create() * @see maps_coordinates_clone() */ int maps_coordinates_destroy(maps_coordinates_h coordinates); + /** - * @brief Clones the Geographical Coordinates. - * @details This function makes a clone of the @a origin Geographical - * Coordinates of type #maps_coordinates_h. + * @brief Clones the Geographical Coordinates. + * @details This function makes a clone of the @a origin Geographical Coordinates of type #maps_coordinates_h. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_coordinates_destroy(). - * - * @param[in] origin The original coordinate handle - * @param[out] cloned A cloned coordinate handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original coordinate handle + * @param[out] cloned A cloned coordinate handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a origin is created using maps_coordinates_create(). - * * @see maps_coordinates_create() * @see maps_coordinates_destroy() */ -int maps_coordinates_clone(const maps_coordinates_h origin, - maps_coordinates_h *cloned); +int maps_coordinates_clone(const maps_coordinates_h origin, maps_coordinates_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the latitude of the coordinates. + * @brief Gets the latitude of the coordinates. * @details This function gets the @a latitude value of the coordinates handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] coordinates The coordinate handle - * @param[out] latitude The latitude of the coordinate handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] coordinates The coordinate handle + * @param[out] latitude The latitude of the coordinate handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a coordinates are created using maps_coordinates_create(). - * * @see maps_coordinates_create() * @see maps_coordinates_set_latitude() */ -int maps_coordinates_get_latitude(const maps_coordinates_h coordinates, - double *latitude); +int maps_coordinates_get_latitude(const maps_coordinates_h coordinates, double *latitude); + /** - * @brief Gets the longitude of the coordinates. + * @brief Gets the longitude of the coordinates. * @details This function gets the @a longitude value of the coordinates handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] coordinates The coordinate handle - * @param[out] longitude The longitude of the coordinate handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] coordinates The coordinate handle + * @param[out] longitude The longitude of the coordinate handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a coordinates are created using maps_coordinates_create(). - * * @see maps_coordinates_create() * @see maps_coordinates_set_longitude() */ -int maps_coordinates_get_longitude(const maps_coordinates_h coordinates, - double *longitude); +int maps_coordinates_get_longitude(const maps_coordinates_h coordinates, double *longitude); + /** - * @brief Gets the latitude and longitude of the coordinates. - * @details This function gets the @a longitude and @a longitude value of the - * coordinates handle. + * @brief Gets the latitude and longitude of the coordinates. + * @details This function gets the @a longitude and @a longitude value of the coordinates handle. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] coordinates The coordinate handle - * @param[out] latitude The latitude of the coordinate handle - * @param[out] longitude The longitude of the coordinate handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] coordinates The coordinate handle + * @param[out] latitude The latitude of the coordinate handle + * @param[out] longitude The longitude of the coordinate handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a coordinates are created using maps_coordinates_create(). - * * @see maps_coordinates_create() * @see maps_coordinates_set_latitude_longitude() */ -int maps_coordinates_get_latitude_longitude(const maps_coordinates_h coordinates, - double *latitude, - double *longitude); +int maps_coordinates_get_latitude_longitude(const maps_coordinates_h coordinates, double *latitude, double *longitude); + + /*----------------------------------------------------------------------------*/ + /** - * @brief Sets the latitude of the coordinates. + * @brief Sets the latitude of the coordinates. * @details This function sets the @a latitude value of the coordinates handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] coordinates The coordinate handle - * @param[in] latitude The latitude of the coordinate handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] coordinates The coordinate handle + * @param[in] latitude The latitude of the coordinate handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a coordinates are created using maps_coordinates_create(). - * * @see maps_coordinates_create() * @see maps_coordinates_get_latitude() */ -int maps_coordinates_set_latitude(maps_coordinates_h coordinates, - const double latitude); +int maps_coordinates_set_latitude(maps_coordinates_h coordinates, const double latitude); + /** - * @brief Sets the longitude of the coordinates. + * @brief Sets the longitude of the coordinates. * @details This function sets the @a longitude value of the coordinates handle. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] coordinates The coordinate handle - * @param[out] longitude The longitude of the coordinate handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] coordinates The coordinate handle + * @param[out] longitude The longitude of the coordinate handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a coordinates are created using maps_coordinates_create(). - * * @see maps_coordinates_create() * @see maps_coordinates_get_longitude() */ -int maps_coordinates_set_longitude(maps_coordinates_h coordinates, - const double longitude); +int maps_coordinates_set_longitude(maps_coordinates_h coordinates, const double longitude); + /** - * @brief Sets the latitude and longitude of the coordinates. - * @details This function sets the @a latitude and @a latitude value of the - * coordinates handle. + * @brief Sets the latitude and longitude of the coordinates. + * @details This function sets the @a latitude and @a latitude value of the coordinates handle. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] coordinates The coordinates handle - * @param[in] latitude The latitude [-90.0 ~ 90.0] (degrees) - * @param[in] longitude The longitude [-180.0 ~ 180.0] (degrees) - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] coordinates The coordinates handle + * @param[in] latitude The latitude [-90.0 ~ 90.0] (degrees) + * @param[in] longitude The longitude [-180.0 ~ 180.0] (degrees) + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a coordinates are created using maps_coordinates_create(). - * * @see maps_coordinates_create() * @see maps_coordinates_get_latitude_longitude() */ -int maps_coordinates_set_latitude_longitude(maps_coordinates_h coordinates, - const double latitude, - const double longitude); +int maps_coordinates_set_latitude_longitude(maps_coordinates_h coordinates, const double latitude, const double longitude); + /** - * @brief Creates a coordinates list having a set of coordinates. + * @brief Creates a coordinates list having a set of coordinates. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[out] coordinates_list The coordinates list handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[out] coordinates_list The coordinates list handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_coordinates_list_destroy() */ int maps_coordinates_list_create(maps_coordinates_list_h *coordinates_list); + /** - * @brief Frees all of the memory used by a coordinates list. + * @brief Frees all of the memory used by a coordinates list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] coordinates_list coordinates list handle - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] coordinates_list The coordinates list handle + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_coordinates_list_create() */ int maps_coordinates_list_destroy(maps_coordinates_list_h coordinates_list); + /** - * @brief Appends a coordinates to a coordinates list. + * @brief Appends a coordinates to a coordinates list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] coordinates_list The coordinates list handle - * @param[in] coordinates The coordinates handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] coordinates_list The coordinates list handle + * @param[in] coordinates The coordinates handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_coordinates_list_create() * @see maps_coordinates_list_destroy() */ -int maps_coordinates_list_append(maps_coordinates_list_h coordinates_list, - maps_coordinates_h coordinates); +int maps_coordinates_list_append(maps_coordinates_list_h coordinates_list, maps_coordinates_h coordinates); + /** - * @brief Removes a coordinates from a coordinates list. + * @brief Removes a coordinates from a coordinates list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] coordinates_list The coordinates list handle - * @param[in] coordinates The coordinates handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] coordinates_list The coordinates list handle + * @param[in] coordinates The coordinates handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_coordinates_list_create() * @see maps_coordinates_list_destroy() */ -int maps_coordinates_list_remove(maps_coordinates_list_h coordinates_list, - maps_coordinates_h coordinates); +int maps_coordinates_list_remove(maps_coordinates_list_h coordinates_list, maps_coordinates_h coordinates); + /** - * @brief Gets the number of elements in an coordinates list. + * @brief Gets the number of elements in a coordinates list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] coordinates_list The coordinates list handle - * @param[out] length The number of elements in the coordinates list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] coordinates_list The coordinates list handle + * @param[out] length The number of elements in the coordinates list + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_coordinates_list_create() * @see maps_coordinates_list_destroy() */ -int maps_coordinates_list_get_length(maps_coordinates_list_h coordinates_list, - int *length); +int maps_coordinates_list_get_length(maps_coordinates_list_h coordinates_list, int *length); + /** - * @brief Called iteratively to get a coordinates information. + * @brief Called iteratively to get a coordinates information. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] index The index of iteration - * @param[in] coordinates The handle of coordinates - * @param[in] user_data The user data passed from the foreach function - * @return @c true to continue with the next iteration of the loop, \n + * @param[in] index The index of iteration + * @param[in] coordinates The handle of coordinates + * @param[in] user_data The user data passed from the foreach function + * @return @c true to continue with the next iteration of the loop,\n * @c false to break out of the loop - * * @see batch_coordinates_foreach_coordinates() */ typedef bool (*maps_coordinates_cb) (int index, maps_coordinates_h coordinates, void *user_data); + /** * @brief Retrieves all coordinates by invoking a specific callback for each coordinates of coordinates list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] coordinates_list The coordinates list handle - * @param[in] callback The iteration callback - * @param[in] user_data The user data to be passed to the callback function - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] coordinates_list The coordinates list handle + * @param[in] callback The iteration callback + * @param[in] user_data The user data to be passed to the callback function + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_coordinates_list_create() * @see maps_coordinates_list_destroy() * @see maps_coordinates_list_get_length() */ -int maps_coordinates_list_foreach(maps_coordinates_list_h coordinates_list, - maps_coordinates_cb callback, void *user_data); +int maps_coordinates_list_foreach(maps_coordinates_list_h coordinates_list, maps_coordinates_cb callback, void *user_data); #ifdef __cplusplus @@ -388,4 +362,4 @@ int maps_coordinates_list_foreach(maps_coordinates_list_h coordinates_list, /** * @} */ -#endif /* __MAPS_COORDINATES_H__ */ +#endif /* __MAPS_COORDINATES_H__ */ diff --git a/include/maps_error.h b/include/maps_error.h index 91b93be..2f21c9e 100644 --- a/include/maps_error.h +++ b/include/maps_error.h @@ -14,85 +14,90 @@ * limitations under the License. */ + #ifndef __MAPS_ERROR_H__ #define __MAPS_ERROR_H__ + #include #include + /** - * @ingroup CAPI_MAPS_SERVICE_MODULE - * + * @ingroup CAPI_MAPS_SERVICE_MODULE * @file maps_error.h - * @brief This file contains the list of errors of Maps API - * + * @brief This file contains the list of errors of Maps API. * @addtogroup CAPI_MAPS_SERVICE_AND_PREFERENCE_MODULE * @{ - * @brief This provides a list of Maps API errors + * @brief This provides a list of Maps API errors. */ + #ifdef __cplusplus extern "C" { #endif + #ifndef TIZEN_ERROR_MAPS_SERVICE -#define TIZEN_ERROR_MAPS_SERVICE -0x02C20000 +#define TIZEN_ERROR_MAPS_SERVICE -0x02C20000 #endif + /** - * @brief Enumerations of error codes for Maps Service and Plug-ins + * @brief Enumeration for error codes for Maps Service and Plug-ins. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ typedef enum _maps_error_e { - MAPS_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ + MAPS_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ MAPS_ERROR_PERMISSION_DENIED = - TIZEN_ERROR_PERMISSION_DENIED, /**< Permission Denied */ + TIZEN_ERROR_PERMISSION_DENIED, /**< Permission Denied */ MAPS_ERROR_OUT_OF_MEMORY = - TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ + TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ MAPS_ERROR_INVALID_PARAMETER = - TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ + TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ MAPS_ERROR_NOT_SUPPORTED = - TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ + TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ MAPS_ERROR_CONNECTION_TIME_OUT = - TIZEN_ERROR_CONNECTION_TIME_OUT,/**< Timeout error, no answer */ + TIZEN_ERROR_CONNECTION_TIME_OUT, /**< Timeout error, no answer */ MAPS_ERROR_NETWORK_UNREACHABLE = - TIZEN_ERROR_NETWORK_UNREACHABLE,/**< Network unavailable*/ + TIZEN_ERROR_NETWORK_UNREACHABLE, /**< Network unavailable*/ MAPS_ERROR_INVALID_OPERATION = - TIZEN_ERROR_INVALID_OPERATION, /**< Operation is not valid */ + TIZEN_ERROR_INVALID_OPERATION, /**< Operation is not valid */ MAPS_ERROR_KEY_NOT_AVAILABLE = - TIZEN_ERROR_KEY_NOT_AVAILABLE, /**< Invalid key */ + TIZEN_ERROR_KEY_NOT_AVAILABLE, /**< Invalid key */ MAPS_ERROR_RESOURCE_BUSY = - TIZEN_ERROR_RESOURCE_BUSY, /**< Maps Service 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 */ + TIZEN_ERROR_UNKNOWN, /**< Unknown error */ MAPS_ERROR_USER_NOT_CONSENTED = - TIZEN_ERROR_USER_NOT_CONSENTED, /**< Not Consented (Since @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif) */ + TIZEN_ERROR_USER_NOT_CONSENTED, /**< Not Consented (Since @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif) */ 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 */ + TIZEN_ERROR_MAPS_SERVICE | 0x02 /**< Result not found */ } maps_error_e; + #ifdef __cplusplus } #endif /** * @} */ -#endif /* __MAPS_ERROR_H__ */ +#endif /* __MAPS_ERROR_H__ */ diff --git a/include/maps_extra_types.h b/include/maps_extra_types.h index f166d28..a5d1067 100644 --- a/include/maps_extra_types.h +++ b/include/maps_extra_types.h @@ -20,8 +20,8 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_AND_PROVIDERS_MODULE - * @defgroup CAPI_MAPS_CONTAINERS_MODULE Container Data Types + * @ingroup CAPI_MAPS_PLUGIN_AND_PROVIDERS_MODULE + * @defgroup CAPI_MAPS_CONTAINERS_MODULE Container Data Types * * @file maps_extra_types.h * @brief This file contains definitions and functions of useful data types. @@ -37,8 +37,8 @@ extern "C" { #endif /** - * @ingroup CAPI_MAPS_CONTAINERS_MODULE - * @defgroup CAPI_MAPS_CONTAINERS_MODULE_ITEM_LIST Maps Item Lists + * @ingroup CAPI_MAPS_CONTAINERS_MODULE + * @defgroup CAPI_MAPS_CONTAINERS_MODULE_ITEM_LIST Maps Item Lists * * @file maps_extra_types.h * @brief This section contains API for using List of item pointers. @@ -49,7 +49,7 @@ extern "C" { */ /** - * @brief Item List handle. + * @brief Item List handle. * @details The Item List handle can be obtained via call of * maps_item_list_create(). * @remarks To release the handle use maps_item_list_destroy(). @@ -66,19 +66,19 @@ extern "C" { typedef void *maps_item_list_h; /** - * @brief Creates a new list of item pointers. + * @brief Creates a new list of item pointers. * @details This function creates a new instance of item pointer list, associate * a new handle with it and allocates all needed resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a list must be released using maps_item_list_destroy(). * \n @a list may be cloned using maps_item_list_clone(). * - * @param[out] list The handle of newly created list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] list The handle of newly created list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_item_list_destroy() * @see maps_item_list_clone() @@ -86,16 +86,16 @@ typedef void *maps_item_list_h; int maps_item_list_create(maps_item_list_h *list); /** - * @brief Destroys the list handle and releases all its resources. + * @brief Destroys the list handle and releases all its resources. * @details This function destroys the list handle and releases all its * resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] list The handle of list to be deleted - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] list The handle of list to be deleted + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a list is created using maps_item_list_create(). * @@ -105,19 +105,19 @@ int maps_item_list_create(maps_item_list_h *list); int maps_item_list_destroy(maps_item_list_h list); /** - * @brief Clone function, making a copy of a list item. + * @brief Clone function, making a copy of a list item. * @details This function is called once for each item of the given list while * the list is being cloned during the maps_item_list_clone() procedure. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks If this function returns the value different from MAPS_ERROR_NONE, * the cloned item will not be appended to the list. * - * @param[in] origin The pointer to the item which is to be cloned - * @param[out] cloned The pointer to the clone of the specified item - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @param[in] origin The pointer to the item which is to be cloned + * @param[out] cloned The pointer to the clone of the specified item + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * * @pre maps_item_list_clone() will invoke this callback. * @@ -126,22 +126,22 @@ int maps_item_list_destroy(maps_item_list_h list); typedef int (*maps_item_list_clone_cb) (void *origin, void **cloned); /** - * @brief Clones the list of item pointers. + * @brief Clones the list of item pointers. * @details This function clones the list of item pointers @a origin and all its * resources. * \n The list handle @a origin may be created using maps_item_list_create(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_item_list_destroy(). * - * @param[in] origin The handle of list to be cloned - * @param[in] clone_func The #maps_item_list_clone_cb function used to + * @param[in] origin The handle of list to be cloned + * @param[in] clone_func The #maps_item_list_clone_cb function used to * clone an element of a list - * @param[out] cloned The handle of the newly cloned list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] cloned The handle of the newly cloned list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a origin is created using maps_item_list_create(). * @post #maps_item_list_clone_cb is used to clone each item of the list. @@ -149,24 +149,22 @@ typedef int (*maps_item_list_clone_cb) (void *origin, void **cloned); * @see maps_item_list_create() * @see maps_item_list_destroy() */ -int maps_item_list_clone(const maps_item_list_h origin, - maps_item_list_clone_cb clone_func, - maps_item_list_h *cloned); +int maps_item_list_clone(const maps_item_list_h origin, maps_item_list_clone_cb clone_func, maps_item_list_h *cloned); /** - * @brief Appends an item to the list. + * @brief Appends an item to the list. * @details This function appends an item @a data to the list of item pointers * @a list. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks If @a clone_func is null, @a data will not be cloned. * - * @param[in] list The handle of list - * @param[in] data The item pointer to be pointed to the list - * @param[in] clone_func The function for cloning the added list value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] list The handle of list + * @param[in] data The item pointer to be pointed to the list + * @param[in] clone_func The function for cloning the added list value + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a list is created using maps_item_list_create(). * @@ -174,11 +172,10 @@ int maps_item_list_clone(const maps_item_list_h origin, * @see maps_item_list_remove_all() * @see maps_item_list_create() */ -int maps_item_list_append(maps_item_list_h list, const void *data, - maps_item_list_clone_cb clone_func); +int maps_item_list_append(maps_item_list_h list, const void *data, maps_item_list_clone_cb clone_func); /** - * @brief Called once for each item while iterating through the given + * @brief Called once for each item while iterating through the given * list. * @details This function is called once for each item of the given list while * the list is being iterated @@ -186,38 +183,37 @@ int maps_item_list_append(maps_item_list_h list, const void *data, * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The @a data must be released by you. * - * @param[in] index The current index of item - * @param[in] total The total amount of items - * @param[in] data The pointer to the list item - * @param[in] user_data The user data passed from + * @param[in] index The current index of item + * @param[in] total The total amount of items + * @param[in] data The pointer to the list item + * @param[in] user_data The user data passed from * maps_item_list_foreach() - * @return @c true to continue with the next iteration of the loop, \n @c + * @return @c true to continue with the next iteration of the loop, \n @c * false to break out of the loop * * @pre maps_item_list_foreach() will invoke this callback. * * @see maps_item_list_foreach() */ -typedef bool(*maps_item_list_foreach_cb) (int index, int total, void *data, - void *user_data); +typedef bool(*maps_item_list_foreach_cb) (int index, int total, void *data, void *user_data); /** - * @brief Gets the items of the specified list. + * @brief Gets the items of the specified list. * @details This function delivers items of a specified list via * maps_item_list_foreach_cb() callback. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] list The handle of list - * @param[in] clone_func The function for cloning the list values - * @param[in] callback The callback to be invoked for delivering each + * @param[in] list The handle of list + * @param[in] clone_func The function for cloning the list values + * @param[in] callback The callback to be invoked for delivering each * list item - * @param[in] user_data The user data to be passed to the callback + * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a list is created using maps_item_list_create(). * @post This function invokes maps_item_list_foreach_cb() to deliver list @@ -227,24 +223,21 @@ typedef bool(*maps_item_list_foreach_cb) (int index, int total, void *data, * @see maps_item_list_append() * @see maps_service_create() */ -int maps_item_list_foreach(maps_item_list_h list, - maps_item_list_clone_cb clone_func, - maps_item_list_foreach_cb callback, - void *user_data); +int maps_item_list_foreach(maps_item_list_h list, maps_item_list_clone_cb clone_func, maps_item_list_foreach_cb callback, void *user_data); /** - * @brief Free function, destroying a list item. + * @brief Free function, destroying a list item. * @details This function is called once for each item of the given list while * the list is being destroyed * during the maps_item_list_remove_all() procedures. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The return of this function is ignored. * - * @param[in] data The pointer to the list item which is to be + * @param[in] data The pointer to the list item which is to be * destroyed - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * * @pre maps_item_list_remove_all() will invoke this callback. * @@ -253,21 +246,21 @@ int maps_item_list_foreach(maps_item_list_h list, typedef int (*maps_item_list_free_cb) (void *data); /** - * @brief Removes and destroys list item. + * @brief Removes and destroys list item. * @details This function removes the given items from the @a list and releases * resources, assigned with it. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks The @a item is destroyed with #maps_item_list_free_cb. If this * callback is NULL, item will not be destroyed. * - * @param[in] list The handle of list - * @param[in] item The to remove - * @param[in] free_func The callback to be invoked for destroying each + * @param[in] list The handle of list + * @param[in] item The to remove + * @param[in] free_func The callback to be invoked for destroying each * list item - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a list is created using maps_item_list_create(). * @post #maps_item_list_free_cb is used to destroy the item of the list. @@ -276,25 +269,23 @@ typedef int (*maps_item_list_free_cb) (void *data); * @see maps_item_list_create() * @see maps_item_list_remove_all() */ -int maps_item_list_remove(maps_item_list_h list, - void *item, - maps_item_list_free_cb free_func); +int maps_item_list_remove(maps_item_list_h list, void *item, maps_item_list_free_cb free_func); /** - * @brief Removes and destroys all list items. + * @brief Removes and destroys all list items. * @details This function removes all items of the @a list and releases * resources, assigned with them. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks Each item is destroyed with #maps_item_list_free_cb. If this * callback is NULL, items will not be destroyed. * - * @param[in] list The handle of list - * @param[in] free_func The callback to be invoked for destroying each + * @param[in] list The handle of list + * @param[in] free_func The callback to be invoked for destroying each * list item - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a list is created using maps_item_list_create(). * @post #maps_item_list_free_cb is used to destroy each item of the list. @@ -302,19 +293,18 @@ int maps_item_list_remove(maps_item_list_h list, * @see maps_item_list_free_cb() * @see maps_item_list_create() */ -int maps_item_list_remove_all(maps_item_list_h list, - maps_item_list_free_cb free_func); +int maps_item_list_remove_all(maps_item_list_h list, maps_item_list_free_cb free_func); /** - * @brief Called once for each item while iterating through the given list. + * @brief Called once for each item while iterating through the given list. * @details This function is called once for each item of the given list while * the list is being iterated during the maps_item_list_foreach_noclone() procedure. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] index The current index of item - * @param[in] data The pointer to the list item - * @param[in] user_data The user data passed from maps_item_list_foreach_noclone() - * @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop + * @param[in] index The current index of item + * @param[in] data The pointer to the list item + * @param[in] user_data The user data passed from maps_item_list_foreach_noclone() + * @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop * * @pre maps_item_list_foreach_noclone() will invoke this callback. * @@ -323,20 +313,20 @@ int maps_item_list_remove_all(maps_item_list_h list, typedef bool(*maps_item_list_foreach_noclone_cb) (int index, void *data, void *user_data); /** - * @brief Gets the items of the specified list. + * @brief Gets the items of the specified list. * @details This function delivers items of a specified list via maps_item_list_foreach_noclone_cb() callback. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks This function is useful while adding to the list an item of arbitrary type without cloning it. * \n maps_item_list_foreach() is useful when cloning the value is required while adding to the list. * - * @param[in] list The handle of list - * @param[in] callback The callback to be invoked for delivering each list item - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] list The handle of list + * @param[in] callback The callback to be invoked for delivering each list item + * @param[in] 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 + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a list is created using maps_item_list_create(). * @post This function invokes maps_item_list_foreach_noclone_cb() to deliver list items. @@ -348,6 +338,23 @@ typedef bool(*maps_item_list_foreach_noclone_cb) (int index, void *data, void *u */ int maps_item_list_foreach_noclone(maps_item_list_h list, maps_item_list_foreach_noclone_cb callback, void *user_data); +/** + * @brief Gets the number of elements in the specified list. + * @since_tizen 3.0 + * + * @param[in] list The handle of list + * @param[out] length The number of elements in the specified list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * + * @pre @a list is created using maps_item_list_create(). + * + * @see maps_item_list_create() + * @see maps_item_list_append() + */ +int maps_item_list_get_length(maps_item_list_h list, int *length); + /** * @} */ @@ -355,8 +362,8 @@ int maps_item_list_foreach_noclone(maps_item_list_h list, maps_item_list_foreach /*----------------------------------------------------------------------------*/ /** - * @ingroup CAPI_MAPS_CONTAINERS_MODULE - * @defgroup CAPI_MAPS_CONTAINERS_MODULE_STRING_HASHTABLE Maps String Hash Tables + * @ingroup CAPI_MAPS_CONTAINERS_MODULE + * @defgroup CAPI_MAPS_CONTAINERS_MODULE_STRING_HASHTABLE Maps String Hash Tables * * @file maps_extra_types.h * @brief This section contains API for using Hash Table of strings. @@ -367,7 +374,7 @@ int maps_item_list_foreach_noclone(maps_item_list_h list, maps_item_list_foreach */ /** - * @brief The handle of Hash Table of strings. + * @brief The handle of Hash Table of strings. * @details The handle of Hash Table of strings can be obtained via call of * maps_string_hashtable_create(). * @remarks To release the handle use maps_string_hashtable_destroy(). @@ -390,19 +397,19 @@ int maps_item_list_foreach_noclone(maps_item_list_h list, maps_item_list_foreach typedef void *maps_string_hashtable_h; /** - * @brief Creates a new Hash Table of strings. + * @brief Creates a new Hash Table of strings. * @details This function creates a new instance of Hash Table of strings, * associate a new handle with it and allocates all needed resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a table must be released using maps_string_hashtable_destroy(). * \n @a table may be cloned using maps_string_hashtable_clone(). * - * @param[out] table The handle of newly created table - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] table The handle of newly created table + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_string_hashtable_clone() * @see maps_string_hashtable_destroy() @@ -410,18 +417,18 @@ typedef void *maps_string_hashtable_h; int maps_string_hashtable_create(maps_string_hashtable_h *table); /** - * @brief Destroys the Hash Table of strings and releases all its + * @brief Destroys the Hash Table of strings and releases all its * resources. * @details This function destroys the Hash Table handle and releases all its * resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks All strings stored in the table will be released. * - * @param[in] table The handle of table to be destroyed - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of table to be destroyed + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_string_hashtable_create(). * @@ -431,7 +438,7 @@ int maps_string_hashtable_create(maps_string_hashtable_h *table); int maps_string_hashtable_destroy(maps_string_hashtable_h table); /** - * @brief Clones the Hash Table of strings. + * @brief Clones the Hash Table of strings. * @details This function clones the Hash Table of strings @a origin and all its * resources. * \n The list handle @a origin may be created using @@ -439,35 +446,34 @@ int maps_string_hashtable_destroy(maps_string_hashtable_h table); * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_string_hashtable_destroy(). * - * @param[in] origin The handle of the table to be cloned - * @param[out] cloned The handle of the cloned table - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] origin The handle of the table to be cloned + * @param[out] cloned The handle of the cloned table + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_string_hashtable_create(). * * @see maps_string_hashtable_create() * @see maps_string_hashtable_destroy() */ -int maps_string_hashtable_clone(const maps_string_hashtable_h origin, - maps_string_hashtable_h *cloned); +int maps_string_hashtable_clone(const maps_string_hashtable_h origin, maps_string_hashtable_h *cloned); /** - * @brief Sets the association between string key and value in the table. + * @brief Sets the association between string key and value in the table. * @details This function sets the association between string key and value in * the Hash Table. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @param[in] value The string value of "value" - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @param[in] value The string value of "value" + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_string_hashtable_create(). * @@ -475,23 +481,22 @@ int maps_string_hashtable_clone(const maps_string_hashtable_h origin, * @see maps_string_hashtable_remove() * @see maps_string_hashtable_create() */ -int maps_string_hashtable_set(maps_string_hashtable_h table, const char *key, - const char *value); +int maps_string_hashtable_set(maps_string_hashtable_h table, const char *key, const char *value); /** - * @brief Gets the string value associated with a string key in the table. + * @brief Gets the string value associated with a string key in the table. * @details This function gets the string value associated with a string key in * the Hash Table. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remark The @a value must be released using free(). + * @remarks The @a value must be released using free(). * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @param[out] value The string value of "value" - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @param[out] value The string value of "value" + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_string_hashtable_create(). * @@ -499,21 +504,20 @@ int maps_string_hashtable_set(maps_string_hashtable_h table, const char *key, * @see maps_string_hashtable_remove() * @see maps_string_hashtable_create() */ -int maps_string_hashtable_get(maps_string_hashtable_h table, const char *key, - char **value); +int maps_string_hashtable_get(maps_string_hashtable_h table, const char *key, char **value); /** - * @brief Removes the key-value pair from the table. + * @brief Removes the key-value pair from the table. * @details This function removes the key-value pair from the Hash Table. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The resources, used by item will be released automatically. * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_string_hashtable_create(). * @@ -521,11 +525,10 @@ int maps_string_hashtable_get(maps_string_hashtable_h table, const char *key, * @see maps_string_hashtable_get() * @see maps_string_hashtable_create() */ -int maps_string_hashtable_remove(maps_string_hashtable_h table, - const char *key); +int maps_string_hashtable_remove(maps_string_hashtable_h table, const char *key); /** - * @brief Called once for each key-value pair while iterating through + * @brief Called once for each key-value pair while iterating through * the given table. * @details This function is called once for each key-value pair of the given * table while the table is being iterated @@ -533,39 +536,37 @@ int maps_string_hashtable_remove(maps_string_hashtable_h table, * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The @a key and @a value must be released using free(). * - * @param[in] index The current index of item - * @param[in] total The total amount of items - * @param[in] key The string value of "key" - * @param[in] value The string value of "value" - * @param[in] user_data The user data passed from + * @param[in] index The current index of item + * @param[in] total The total amount of items + * @param[in] key The string value of "key" + * @param[in] value The string value of "value" + * @param[in] user_data The user data passed from * maps_string_hashtable_foreach() - * @return @c true to continue with the next iteration of the loop, \n @c + * @return @c true to continue with the next iteration of the loop, \n @c * false to break out of the loop * * @pre maps_string_hashtable_foreach() will invoke this callback. * * @see maps_string_hashtable_foreach() */ -typedef bool(*maps_string_hashtable_foreach_cb) (int index, int total, - char *key, char *value, - void *user_data); +typedef bool(*maps_string_hashtable_foreach_cb) (int index, int total, char *key, char *value, void *user_data); /** - * @brief Gets the key-value pairs of the specified table. + * @brief Gets the key-value pairs of the specified table. * @details This function delivers key-value pairs of a specified table via * maps_string_hashtable_foreach_cb() callback. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] table The handle of table - * @param[in] callback The callback to be invoked for delivering each + * @param[in] table The handle of table + * @param[in] callback The callback to be invoked for delivering each * key-value pair - * @param[in] user_data The user data to be passed to the callback + * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_string_hashtable_create(). * @post This function invokes maps_string_hashtable_foreach_cb() to deliver @@ -576,23 +577,21 @@ typedef bool(*maps_string_hashtable_foreach_cb) (int index, int total, * @see maps_string_hashtable_get() * @see maps_string_hashtable_create() */ -int maps_string_hashtable_foreach(maps_string_hashtable_h table, - maps_string_hashtable_foreach_cb callback, - void *user_data); +int maps_string_hashtable_foreach(maps_string_hashtable_h table, maps_string_hashtable_foreach_cb callback, void *user_data); /** - * @brief Checks if key is in hash_table. + * @brief Checks if key is in hash_table. * @details This function checks if the specified key is in the Hash Table of * strings. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @param[out] contains The flag of key presence - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @param[out] contains The flag of key presence + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_string_hashtable_create(). * @@ -600,8 +599,7 @@ int maps_string_hashtable_foreach(maps_string_hashtable_h table, * @see maps_string_hashtable_get() * @see maps_string_hashtable_create() */ -int maps_string_hashtable_contains(maps_string_hashtable_h table, - const char *key, bool *contains); +int maps_string_hashtable_contains(maps_string_hashtable_h table, const char *key, bool *contains); /** * @} @@ -610,8 +608,8 @@ int maps_string_hashtable_contains(maps_string_hashtable_h table, /*----------------------------------------------------------------------------*/ /* - * @ingroup CAPI_MAPS_CONTAINERS_MODULE - * @defgroup CAPI_MAPS_CONTAINERS_MODULE_INT_HASHTABLE Maps Integer Hash Tables + * @ingroup CAPI_MAPS_CONTAINERS_MODULE + * @defgroup CAPI_MAPS_CONTAINERS_MODULE_INT_HASHTABLE Maps Integer Hash Tables * * @file maps_extra_types.h * @brief This section contains API for using Hash Table of integers. @@ -622,7 +620,7 @@ int maps_string_hashtable_contains(maps_string_hashtable_h table, */ /* - * @brief The handle of Hash Table of integers. + * @brief The handle of Hash Table of integers. * @details The handle of Hash Table of integers can be obtained via call of * maps_int_hashtable_create(). * @remarks To release the handle use maps_int_hashtable_destroy(). @@ -641,19 +639,19 @@ int maps_string_hashtable_contains(maps_string_hashtable_h table, typedef void *maps_int_hashtable_h; /* - * @brief Creates a new Hash Table of integers. + * @brief Creates a new Hash Table of integers. * @details This function creates a new instance of Hash Table of integers, * associate a new handle with it and allocates all needed resources. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks @a table must be released using maps_int_hashtable_destroy(). * \n @a table may be cloned using maps_int_hashtable_clone(). * - * @param[out] table The handle of newly created table - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] table The handle of newly created table + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_int_hashtable_clone() * @see maps_int_hashtable_destroy() @@ -661,18 +659,18 @@ typedef void *maps_int_hashtable_h; int maps_int_hashtable_create(maps_int_hashtable_h *table); /* - * @brief Destroys the Hash Table of integers and releases all its + * @brief Destroys the Hash Table of integers and releases all its * resources. * @details This function destroys the Hash Table handle and releases all its * resources. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks All integers stored in the table will be released. * - * @param[in] table The handle of table to be destroyed - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of table to be destroyed + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_int_hashtable_create(). * @@ -682,7 +680,7 @@ int maps_int_hashtable_create(maps_int_hashtable_h *table); int maps_int_hashtable_destroy(maps_int_hashtable_h table); /* - * @brief Clones the Hash Table of integers. + * @brief Clones the Hash Table of integers. * @details This function clones the Hash Table of integers @a origin and all * its resources. * \n The list handle @a origin may be created using @@ -690,35 +688,34 @@ int maps_int_hashtable_destroy(maps_int_hashtable_h table); * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_int_hashtable_destroy(). * - * @param[in] origin The handle of the table to be cloned - * @param[out] cloned The handle of the cloned table - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] origin The handle of the table to be cloned + * @param[out] cloned The handle of the cloned table + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_int_hashtable_create(). * * @see maps_int_hashtable_create() * @see maps_int_hashtable_destroy() */ -int maps_int_hashtable_clone(const maps_int_hashtable_h origin, - maps_int_hashtable_h *cloned); +int maps_int_hashtable_clone(const maps_int_hashtable_h origin, maps_int_hashtable_h *cloned); /* - * @brief Sets the association between integer key and value in the table. + * @brief Sets the association between integer key and value in the table. * @details This function sets the association between int key and value in * the Hash Table. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] table The handle of the table - * @param[in] key The integer value of "key" - * @param[in] value The integer value of "value" - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The integer value of "key" + * @param[in] value The integer value of "value" + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_int_hashtable_create(). * @@ -726,23 +723,22 @@ int maps_int_hashtable_clone(const maps_int_hashtable_h origin, * @see maps_int_hashtable_remove() * @see maps_int_hashtable_create() */ -int maps_int_hashtable_set(maps_int_hashtable_h table, const int key, - const int value); +int maps_int_hashtable_set(maps_int_hashtable_h table, const int key, const int value); /* - * @brief Gets the integer value associated with an integer key in the + * @brief Gets the integer value associated with an integer key in the * table. * @details This function gets the integer value associated with a integer key * in the Hash Table. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] table The handle of the table - * @param[in] key The integer value of "key" - * @param[out] value The integer value of "value" - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The integer value of "key" + * @param[out] value The integer value of "value" + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_int_hashtable_create(). * @@ -750,21 +746,20 @@ int maps_int_hashtable_set(maps_int_hashtable_h table, const int key, * @see maps_int_hashtable_remove() * @see maps_int_hashtable_create() */ -int maps_int_hashtable_get(maps_int_hashtable_h table, const int key, - int *value); +int maps_int_hashtable_get(maps_int_hashtable_h table, const int key, int *value); /* - * @brief Removes the key-value pair from the table. + * @brief Removes the key-value pair from the table. * @details This function removes the key-value pair from the Hash Table. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks The resources, used by item will be released automatically. * - * @param[in] table The handle of the table - * @param[in] key The integer value of "key" - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The integer value of "key" + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_int_hashtable_create(). * @@ -772,50 +767,47 @@ int maps_int_hashtable_get(maps_int_hashtable_h table, const int key, * @see maps_int_hashtable_get() * @see maps_int_hashtable_create() */ -int maps_int_hashtable_remove(maps_int_hashtable_h table, - const int key); +int maps_int_hashtable_remove(maps_int_hashtable_h table, const int key); /* - * @brief Called once for each key-value pair while iterating through + * @brief Called once for each key-value pair while iterating through * the given table. * @details This function is called once for each key-value pair of the given * table while the table is being iterated * during the maps_int_hashtable_foreach() procedure. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] index The current index of item - * @param[in] total The total amount of items - * @param[in] key The integer value of "key" - * @param[in] value The integer value of "value" - * @param[in] user_data The user data passed from + * @param[in] index The current index of item + * @param[in] total The total amount of items + * @param[in] key The integer value of "key" + * @param[in] value The integer value of "value" + * @param[in] user_data The user data passed from * maps_int_hashtable_foreach() - * @return @c true to continue with the next iteration of the loop, \n @c + * @return @c true to continue with the next iteration of the loop, \n @c * false to break out of the loop * * @pre maps_int_hashtable_foreach() will invoke this callback. * * @see maps_int_hashtable_foreach() */ -typedef bool(*maps_int_hashtable_foreach_cb) (int index, int total, - const int key, const int value, - void *user_data); +typedef bool(*maps_int_hashtable_foreach_cb) (int index, int total, const int key, const int value, void *user_data); /* - * @brief Gets the key-value pairs of the specified table. + * @brief Gets the key-value pairs of the specified table. * @details This function delivers key-value pairs of a specified table via * maps_int_hashtable_foreach_cb() callback. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] table The handle of table - * @param[in] callback The callback to be invoked for delivering each + * @param[in] table The handle of table + * @param[in] callback The callback to be invoked for delivering each * key-value pair - * @param[in] user_data The user data to be passed to the callback + * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_int_hashtable_create(). * @post This function invokes maps_int_hashtable_foreach_cb() to deliver @@ -826,23 +818,21 @@ typedef bool(*maps_int_hashtable_foreach_cb) (int index, int total, * @see maps_int_hashtable_get() * @see maps_int_hashtable_create() */ -int maps_int_hashtable_foreach(maps_int_hashtable_h table, - maps_int_hashtable_foreach_cb callback, - void *user_data); +int maps_int_hashtable_foreach(maps_int_hashtable_h table, maps_int_hashtable_foreach_cb callback, void *user_data); /* - * @brief Checks if key is in hash_table. + * @brief Checks if key is in hash_table. * @details This function checks if the specified key is in the Hash Table of * integers. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] table The handle of the table - * @param[in] key The integer value of "key" - * @param[out] contains The flag of key presence - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The integer value of "key" + * @param[out] contains The flag of key presence + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_int_hashtable_create(). * @@ -850,8 +840,7 @@ int maps_int_hashtable_foreach(maps_int_hashtable_h table, * @see maps_int_hashtable_get() * @see maps_int_hashtable_create() */ -int maps_int_hashtable_contains(maps_int_hashtable_h table, - const int key, bool *contains); +int maps_int_hashtable_contains(maps_int_hashtable_h table, const int key, bool *contains); /* * @} @@ -860,8 +849,8 @@ int maps_int_hashtable_contains(maps_int_hashtable_h table, /*----------------------------------------------------------------------------*/ /** - * @ingroup CAPI_MAPS_CONTAINERS_MODULE - * @defgroup CAPI_MAPS_CONTAINERS_MODULE_ITEM_HASHTABLE Maps Item Hash Tables + * @ingroup CAPI_MAPS_CONTAINERS_MODULE + * @defgroup CAPI_MAPS_CONTAINERS_MODULE_ITEM_HASHTABLE Maps Item Hash Tables * * @file maps_extra_types.h * @brief This section contains API for using Hash Table of arbitrary items. @@ -872,7 +861,7 @@ int maps_int_hashtable_contains(maps_int_hashtable_h table, */ /** - * @brief The handle of Hash Table of arbitrary items. + * @brief The handle of Hash Table of arbitrary items. * @details The handle of Hash Table of arbitrary items can be obtained via call * of maps_item_hashtable_create(). * @remarks To release the handle use maps_item_hashtable_destroy(). @@ -895,19 +884,19 @@ int maps_int_hashtable_contains(maps_int_hashtable_h table, typedef void *maps_item_hashtable_h; /** - * @brief Creates a new Hash Table of arbitrary items. + * @brief Creates a new Hash Table of arbitrary items. * @details This function creates a new instance of Hash Table of arbitrary * items, associate a new handle with it and allocates all needed resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a table must be released using maps_item_hashtable_destroy(). * \n @a table may be cloned using maps_item_hashtable_clone(). * - * @param[out] table The handle of newly created table - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] table The handle of newly created table + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_item_hashtable_clone() * @see maps_item_hashtable_destroy() @@ -915,7 +904,7 @@ typedef void *maps_item_hashtable_h; int maps_item_hashtable_create(maps_item_hashtable_h *table); /** -* @brief Destroys the Hash Table of arbitrary items and releases all its +* @brief Destroys the Hash Table of arbitrary items and releases all its * resources. * @details This function destroys the Hash Table handle and releases all its * resources. @@ -923,11 +912,11 @@ int maps_item_hashtable_create(maps_item_hashtable_h *table); * @remarks All items stored in the table will be released with corresponding * functions, specified during maps_item_hashtable_set(). * - * @param[in] table The handle of table to be destroyed - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of table to be destroyed + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * @@ -937,7 +926,7 @@ int maps_item_hashtable_create(maps_item_hashtable_h *table); int maps_item_hashtable_destroy(maps_item_hashtable_h table); /** - * @brief Clones the Hash Table of arbitrary items. + * @brief Clones the Hash Table of arbitrary items. * @details This function clones the Hash Table of arbitrary items @a origin and * all its resources. * \n The list handle @a origin may be created using @@ -945,24 +934,23 @@ int maps_item_hashtable_destroy(maps_item_hashtable_h table); * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_item_hashtable_destroy(). * - * @param[in] origin The handle of the table to be cloned - * @param[out] cloned The handle of the cloned table - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] origin The handle of the table to be cloned + * @param[out] cloned The handle of the cloned table + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * * @see maps_item_hashtable_create() * @see maps_item_hashtable_destroy() */ -int maps_item_hashtable_clone(const maps_item_hashtable_h origin, - maps_item_hashtable_h *cloned); +int maps_item_hashtable_clone(const maps_item_hashtable_h origin, maps_item_hashtable_h *cloned); /** - * @brief Clone function, making a copy of a Hash Table item. + * @brief Clone function, making a copy of a Hash Table item. * @details This function is called once for each item of the given Hash Table * while it is being cloned during the maps_item_hashtable_clone() procedure. * \n This function must be assigned while adding new item to the table using @@ -971,12 +959,12 @@ int maps_item_hashtable_clone(const maps_item_hashtable_h origin, * @remarks If this function returns the value different from MAPS_ERROR_NONE, * the cloned item will not be appended to the list. * - * @param[in] origin The pointer to the item which is to be cloned - * @param[out] cloned The pointer to the clone of the specified item - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @param[in] origin The pointer to the item which is to be cloned + * @param[out] cloned The pointer to the clone of the specified item + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * * @pre maps_item_hashtable_clone() will invoke this callback. * @pre This function must be passed as parameter of using @@ -988,7 +976,7 @@ int maps_item_hashtable_clone(const maps_item_hashtable_h origin, typedef int (*maps_item_hashtable_clone_cb) (void *origin, void **cloned); /** - * @brief Free function, destroying an item of the Hash Table. + * @brief Free function, destroying an item of the Hash Table. * @details This function is called once for each item of the given Hash Table * while this item is to be destroyed during maps_item_hashtable_destroy(). * \n It is also called while the item is removed with @@ -997,11 +985,11 @@ typedef int (*maps_item_hashtable_clone_cb) (void *origin, void **cloned); * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The return of this function is ignored. * - * @param[in] data The pointer to the table item which is to be + * @param[in] data The pointer to the table item which is to be * destroyed - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * * @pre maps_item_hashtable_destroy(), maps_item_hashtable_remove() or * maps_item_hashtable_set() will invoke this callback. @@ -1013,7 +1001,7 @@ typedef int (*maps_item_hashtable_clone_cb) (void *origin, void **cloned); typedef int (*maps_item_hashtable_free_cb) (void *data); /** - * @brief Clones the table item of string type (char*). + * @brief Clones the table item of string type (char*). * @details This is a helper function of type #maps_item_hashtable_clone_cb, * which is useful while adding to the table an item of string type (char*). * This function is intended to be passed as the @a clone_func argument in the @@ -1022,13 +1010,13 @@ typedef int (*maps_item_hashtable_free_cb) (void *data); * @remarks This function will be called implicitly in the * maps_item_hashtable_clone() procedure. * - * @param[in] origin The pointer of the item to be cloned - * @param[out] cloned The pointer of the clone - * @return void pointer of a copy string - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] origin The pointer of the item to be cloned + * @param[out] cloned The pointer of the clone + * @return void pointer of a copy string + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre maps_item_hashtable_clone() will invoke this callback. * @@ -1040,7 +1028,7 @@ typedef int (*maps_item_hashtable_free_cb) (void *data); int maps_item_hashtable_clone_string(void *origin, void **cloned); /** - * @brief Destroys the table item of string type (char*). + * @brief Destroys the table item of string type (char*). * @details This is a helper function of type #maps_item_hashtable_free_cb, * which is useful while adding to the table an item of string type (char*). * This function is intended to be passed as the @a free_func argument in the @@ -1051,11 +1039,11 @@ int maps_item_hashtable_clone_string(void *origin, void **cloned); * maps_item_hashtable_set() procedures. * \n The return of this function is ignored. * - * @param[in] data The pointer of the item - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] data The pointer of the item + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre maps_item_hashtable_destroy(), maps_item_hashtable_remove() or * maps_item_hashtable_set() will invoke this callback. @@ -1069,7 +1057,7 @@ int maps_item_hashtable_clone_string(void *origin, void **cloned); int maps_item_hashtable_free_string(void *data); /** - * @brief Clones the table item of integer type (int*). + * @brief Clones the table item of integer type (int*). * @details This is a helper function of type #maps_item_hashtable_clone_cb, * which is useful while adding to the table an item of integer type (int*). * This function is intended to be passed as the @a clone_func argument in the @@ -1078,13 +1066,13 @@ int maps_item_hashtable_free_string(void *data); * @remarks This function will be called implicitly in the * maps_item_hashtable_clone() procedure. * - * @param[in] origin The pointer of the item to be cloned - * @param[out] cloned The pointer of the clone - * @return void pointer of a copy integer - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] origin The pointer of the item to be cloned + * @param[out] cloned The pointer of the clone + * @return void pointer of a copy integer + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre maps_item_hashtable_clone() will invoke this callback. * @@ -1095,7 +1083,7 @@ int maps_item_hashtable_free_string(void *data); int maps_item_hashtable_clone_int(void *origin, void **cloned); /** - * @brief Destroys the table item of integer type (int*). + * @brief Destroys the table item of integer type (int*). * @details This is a helper function of type #maps_item_hashtable_free_cb, * which is useful while adding to the table an item of integer type (int*). * This function is intended to be passed as the @a free_func argument in the @@ -1106,11 +1094,11 @@ int maps_item_hashtable_clone_int(void *origin, void **cloned); * maps_item_hashtable_set() procedures. * \n The return of this function is ignored. * - * @param[in] data The pointer of the item - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] data The pointer of the item + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre maps_item_hashtable_destroy(), maps_item_hashtable_remove() or * maps_item_hashtable_set() will invoke this callback. @@ -1124,7 +1112,7 @@ int maps_item_hashtable_clone_int(void *origin, void **cloned); int maps_item_hashtable_free_int(void *data); /** -* @brief Clones the table item of floating point numeric type (double*). +* @brief Clones the table item of floating point numeric type (double*). * @details This is a helper function of type #maps_item_hashtable_clone_cb, * which is useful while adding to the table an item of floating point numeric * type (double*). This function is intended to be passed as the @a @@ -1133,13 +1121,13 @@ int maps_item_hashtable_free_int(void *data); * @remarks This function will be called implicitly in the * maps_item_hashtable_clone() procedure. * - * @param[in] origin The pointer of the item to be cloned - * @param[out] cloned The pointer of the clone - * @return void pointer of a copy floating point number - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] origin The pointer of the item to be cloned + * @param[out] cloned The pointer of the clone + * @return void pointer of a copy floating point number + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre maps_item_hashtable_clone() will invoke this callback. * @@ -1150,7 +1138,7 @@ int maps_item_hashtable_free_int(void *data); int maps_item_hashtable_clone_float(void *origin, void **cloned); /** - * @brief Destroys the table item of floating point numeric type + * @brief Destroys the table item of floating point numeric type * (double*). * @details This is a helper function of type #maps_item_hashtable_free_cb, * which is useful while adding to the table an item of floating point numeric @@ -1163,11 +1151,11 @@ int maps_item_hashtable_clone_float(void *origin, void **cloned); * maps_item_hashtable_set() procedures. * \n The return of this function is ignored. * - * @param[in] data The pointer of the item - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] data The pointer of the item + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre maps_item_hashtable_destroy(), maps_item_hashtable_remove() or * maps_item_hashtable_set() will invoke this callback. @@ -1181,23 +1169,23 @@ int maps_item_hashtable_clone_float(void *origin, void **cloned); int maps_item_hashtable_free_float(void *data); /** - * @brief Sets the association between string key and string (char*) + * @brief Sets the association between string key and string (char*) * value in the table. * @details This function sets the association between string key and string * value in the Hash Table. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remark New instances of key and value will be put to the table. The key and + * @remarks New instances of key and value will be put to the table. The key and * value must be released. * \n This function uses implicitly maps_item_hashtable_clone_string() and * maps_item_hashtable_free_string(). * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @param[in] value The string (char*) value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @param[in] value The string (char*) value + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * @@ -1208,27 +1196,26 @@ int maps_item_hashtable_free_float(void *data); * @see maps_item_hashtable_clone_string() * @see maps_item_hashtable_free_string() */ -int maps_item_hashtable_set_string(maps_item_hashtable_h table, - const char *key, const char *value); +int maps_item_hashtable_set_string(maps_item_hashtable_h table, const char *key, const char *value); /** - * @brief Sets the association between string key and integer value in the + * @brief Sets the association between string key and integer value in the * table. * @details This function sets the association between string key and integer * value in the Hash Table. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remark New instances of key and value will be put to the table. The key and + * @remarks New instances of key and value will be put to the table. The key and * value must be released. * \n This function uses implicitly maps_item_hashtable_clone_int() and * maps_item_hashtable_free_int(). * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @param[in] value The integer value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @param[in] value The integer value + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * @@ -1239,27 +1226,26 @@ int maps_item_hashtable_set_string(maps_item_hashtable_h table, * @see maps_item_hashtable_clone_int() * @see maps_item_hashtable_free_int() */ -int maps_item_hashtable_set_int(maps_item_hashtable_h table, const char *key, - const int value); +int maps_item_hashtable_set_int(maps_item_hashtable_h table, const char *key, const int value); /** - * @brief Sets the association between string key and floating point + * @brief Sets the association between string key and floating point * numeric value in the table. * @details This function sets the association between string key and floating * point numeric value in the Hash Table. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remark New instances of key and value will be put to the table. The key and + * @remarks New instances of key and value will be put to the table. The key and * value must be released. * \n This function uses implicitly maps_item_hashtable_clone_int() and * maps_item_hashtable_free_int(). * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @param[in] value The floating point numeric value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @param[in] value The floating point numeric value + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * @@ -1270,11 +1256,10 @@ int maps_item_hashtable_set_int(maps_item_hashtable_h table, const char *key, * @see maps_item_hashtable_clone_float() * @see maps_item_hashtable_free_float() */ -int maps_item_hashtable_set_float(maps_item_hashtable_h table, - const char *key, const double value); +int maps_item_hashtable_set_float(maps_item_hashtable_h table, const char *key, const double value); /** - * @brief Sets the association between key and value in the table. + * @brief Sets the association between key and value in the table. * @details This function sets the association between string key and * arbitrary typed value in the Hash Table. * \n To allow the Hash Table manage arbitrary types properly, @a clone_func of @@ -1298,18 +1283,18 @@ int maps_item_hashtable_set_float(maps_item_hashtable_h table, * - maps_item_hashtable_set_float() * . * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remark New instances of key and value will be put to the table. The @a key + * @remarks New instances of key and value will be put to the table. The @a key * and @a value must be released. * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @param[in] value The value - * @param[in] clone_func The function for cloning the value - * @param[in] free_func The function for freeing the value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @param[in] value The value + * @param[in] clone_func The function for cloning the value + * @param[in] free_func The function for freeing the value + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * @@ -1326,26 +1311,23 @@ int maps_item_hashtable_set_float(maps_item_hashtable_h table, * @see maps_item_hashtable_set_float() * @see maps_item_hashtable_create() */ -int maps_item_hashtable_set(maps_item_hashtable_h table, const char *key, - const void *value, - maps_item_hashtable_clone_cb clone_func, - maps_item_hashtable_free_cb free_func); +int maps_item_hashtable_set(maps_item_hashtable_h table, const char *key, const void *value, maps_item_hashtable_clone_cb clone_func, maps_item_hashtable_free_cb free_func); /** - * @brief Gets the association between string key and string (char*) + * @brief Gets the association between string key and string (char*) * value in the table. * @details This function gets the association between string key and string * value in the Hash Table. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remark @a value must be released using free(). + * @remarks @a value must be released using free(). * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @param[out] value The string (char*) value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @param[out] value The string (char*) value + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * @@ -1356,23 +1338,22 @@ int maps_item_hashtable_set(maps_item_hashtable_h table, const char *key, * @see maps_item_hashtable_clone_string() * @see maps_item_hashtable_free_string() */ -int maps_item_hashtable_get_string(maps_item_hashtable_h table, - const char *key, char **value); +int maps_item_hashtable_get_string(maps_item_hashtable_h table, const char *key, char **value); /** - * @brief Gets the association between string key and integer value in the + * @brief Gets the association between string key and integer value in the * table. * @details This function gets the association between string key and integer * value in the Hash Table. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @param[out] value The integer value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @param[out] value The integer value + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * @@ -1383,23 +1364,22 @@ int maps_item_hashtable_get_string(maps_item_hashtable_h table, * @see maps_item_hashtable_clone_int() * @see maps_item_hashtable_free_int() */ -int maps_item_hashtable_get_int(maps_item_hashtable_h table, const char *key, - int *value); +int maps_item_hashtable_get_int(maps_item_hashtable_h table, const char *key, int *value); /** - * @brief Gets the association between string key and floating point + * @brief Gets the association between string key and floating point * numeric value in the table. * @details This function gets the association between string key and floating * point numeric value in the Hash Table. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @param[out] value The floating point numeric value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @param[out] value The floating point numeric value + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * @@ -1410,23 +1390,22 @@ int maps_item_hashtable_get_int(maps_item_hashtable_h table, const char *key, * @see maps_item_hashtable_clone_float() * @see maps_item_hashtable_free_float() */ -int maps_item_hashtable_get_float(maps_item_hashtable_h table, - const char *key, double *value); +int maps_item_hashtable_get_float(maps_item_hashtable_h table, const char *key, double *value); /** - * @brief Gets the value associated with a string key in the table. + * @brief Gets the value associated with a string key in the table. * @details This function gets the value associated with a string key in the * Hash Table. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remark Th @a value must be released by you. + * @remarks @a value must be released by you. * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @param[out] value The corresponding value of "value" - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @param[out] value The corresponding value of "value" + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * @@ -1434,21 +1413,20 @@ int maps_item_hashtable_get_float(maps_item_hashtable_h table, * @see maps_item_hashtable_remove() * @see maps_item_hashtable_create() */ -int maps_item_hashtable_get(maps_item_hashtable_h table, const char *key, - void **value); +int maps_item_hashtable_get(maps_item_hashtable_h table, const char *key, void **value); /** - * @brief Removes the key-value pair from the table. + * @brief Removes the key-value pair from the table. * @details This function removes the key-value pair from the Hash Table. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The resources, used by item will be released automatically. * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * @@ -1460,7 +1438,7 @@ int maps_item_hashtable_get(maps_item_hashtable_h table, const char *key, int maps_item_hashtable_remove(maps_item_hashtable_h table, const char *key); /** - * @brief Called once for each key-value pair while iterating through the + * @brief Called once for each key-value pair while iterating through the * given table. * @details This function is called once for each key-value pair of the given * table while the table is being iterated @@ -1468,38 +1446,36 @@ int maps_item_hashtable_remove(maps_item_hashtable_h table, const char *key); * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The @a key and @a value must be released by you. * - * @param[in] index The current index of item - * @param[in] total The total amount of items - * @param[in] key The string value of "key" - * @param[in] value The corresponding value of "value" - * @param[in] user_data The user data passed from + * @param[in] index The current index of item + * @param[in] total The total amount of items + * @param[in] key The string value of "key" + * @param[in] value The corresponding value of "value" + * @param[in] user_data The user data passed from * maps_item_hashtable_foreach() - * @return @c true to continue with the next iteration of the loop, \n @c + * @return @c true to continue with the next iteration of the loop, \n @c * false to break out of the loop * * @pre maps_item_hashtable_foreach() will invoke this callback. * * @see maps_item_hashtable_foreach() */ -typedef bool(*maps_item_hashtable_foreach_cb) (int index, int total, - char *key, void *value, - void *user_data); +typedef bool(*maps_item_hashtable_foreach_cb) (int index, int total, char *key, void *value, void *user_data); /** - * @brief Gets the key-value pairs of the specified table. + * @brief Gets the key-value pairs of the specified table. * @details This function delivers key-value pairs of a specified table via * maps_item_hashtable_foreach_cb() callback. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] table The handle of table - * @param[in] callback The callback to be invoked for delivering each key-value pair - * @param[in] user_data The user data to be passed to the callback + * @param[in] table The handle of table + * @param[in] callback The callback to be invoked for delivering each key-value pair + * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * @post This function invokes maps_item_hashtable_foreach_cb() to deliver @@ -1510,22 +1486,20 @@ typedef bool(*maps_item_hashtable_foreach_cb) (int index, int total, * @see maps_item_hashtable_get() * @see maps_item_hashtable_create() */ -int maps_item_hashtable_foreach(maps_item_hashtable_h table, - maps_item_hashtable_foreach_cb callback, - void *user_data); +int maps_item_hashtable_foreach(maps_item_hashtable_h table, maps_item_hashtable_foreach_cb callback, void *user_data); /** - * @brief Checks if key is in hash_table. + * @brief Checks if key is in hash_table. * @details This function checks if the specified key is in the Hash Table. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] table The handle of the table - * @param[in] key The string value of "key" - * @param[out] contains The flag of key presence - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] table The handle of the table + * @param[in] key The string value of "key" + * @param[out] contains The flag of key presence + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a table is created using maps_item_hashtable_create(). * @@ -1534,8 +1508,7 @@ int maps_item_hashtable_foreach(maps_item_hashtable_h table, * @see maps_item_hashtable_create() */ -int maps_item_hashtable_contains(maps_item_hashtable_h table, const char *key, - bool *contains); +int maps_item_hashtable_contains(maps_item_hashtable_h table, const char *key, bool *contains); /** * @} @@ -1549,4 +1522,4 @@ int maps_item_hashtable_contains(maps_item_hashtable_h table, const char *key, /** * @} */ -#endif /* __MAPS_SERVICE_API_EXTRA_TYPES_H__ */ +#endif /* __MAPS_SERVICE_API_EXTRA_TYPES_H__ */ diff --git a/include/maps_place.h b/include/maps_place.h index ad56c22..59c2074 100644 --- a/include/maps_place.h +++ b/include/maps_place.h @@ -14,9 +14,11 @@ * limitations under the License. */ + #ifndef __MAPS_PLACE_H__ #define __MAPS_PLACE_H__ + #include #include #include @@ -29,246 +31,190 @@ #include #include + /** - * @ingroup CAPI_MAPS_PLACE_MODULE - * @defgroup CAPI_MAPS_PLACE_DATA_MODULE Place - * + * @ingroup CAPI_MAPS_PLACE_MODULE + * @defgroup CAPI_MAPS_PLACE_DATA_MODULE Place * @file maps_place.h * @brief This file contains the functions related to Place information. - * * @addtogroup CAPI_MAPS_PLACE_DATA_MODULE * @{ - * @brief This provides APIs related to Place information, used in Place - * Discovery and Search. + * @brief This provides APIs related to Place information, used in Place Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The Place handle + * @brief The Place handle. * @details The handle of Place instance. - * @remarks To release the handle use maps_place_destroy(). - * \n To clone the handle use maps_place_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_place_destroy().\n + * To clone the handle use maps_place_clone(). * @see maps_place_destroy() * @see maps_place_clone() */ typedef void *maps_place_h; + /** - * @brief The Place list handle + * @brief The Place list handle. * @details The handle of Place list instance. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * * @see maps_place_list_foreach() * @see maps_place_list_destroy() */ typedef void *maps_place_list_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Called when requesting the list of Place Properties. - * @details This callback is invoked while iterating through the list of Place - * Properties. + * @brief Called when requesting the list of Place Properties. + * @details This callback is invoked while iterating through the list of Place Properties. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a key and @a value must be released using free() and corresponding - * release method for property value correspondingly. - * - * @param[in] index The current index of property - * @param[in] total The total amount of properties - * @param[in] key The key of property - * @param[in] value The value of property - * @param[in] user_data The user data passed from - * maps_place_foreach_property() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a key and @a value must be released using free() and corresponding release method for property value correspondingly. + * @param[in] index The current index of property + * @param[in] total The total amount of properties + * @param[in] key The key of property + * @param[in] value The value of property + * @param[in] user_data The user data passed from maps_place_foreach_property() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_place_foreach_property() will invoke this callback. - * * @see maps_place_foreach_property() */ -typedef bool(*maps_place_properties_cb) (int index, int total, char *key, - void *value, void *user_data); +typedef bool(*maps_place_properties_cb) (int index, int total, char *key, void *value, void *user_data); + /** - * @brief Called when requesting the list of Place Categories. - * @details This callback is invoked while iterating through the list of Place - * Categories. + * @brief Called when requesting the list of Place Categories. + * @details This callback is invoked while iterating through the list of Place Categories. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a category is valid only in this function and must be released - * using maps_place_category_destroy(). - * \n To use @a category outside this function, clone it with - * maps_place_category_clone(). - * - * @param[in] index The current index of category - * @param[in] total The total amount of categories - * @param[in] category The place category handle - * @param[in] user_data The user data passed from - * maps_place_foreach_category() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a category is valid only in this function and must be released using maps_place_category_destroy().\n + * To use @a category outside this function, clone it with maps_place_category_clone(). + * @param[in] index The current index of category + * @param[in] total The total amount of categories + * @param[in] category The place category handle + * @param[in] user_data The user data passed from maps_place_foreach_category() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_place_foreach_category() will invoke this callback. - * * @see maps_place_foreach_category() * @see #maps_place_category_h */ -typedef bool(*maps_place_categories_cb) (int index, int total, - maps_place_category_h category, - void *user_data); +typedef bool(*maps_place_categories_cb) (int index, int total, maps_place_category_h category, void *user_data); + /** - * @brief Called when requesting the list of Place Attributes. - * @details This callback is invoked while iterating through the list of Place - * Attributes. + * @brief Called when requesting the list of Place Attributes. + * @details This callback is invoked while iterating through the list of Place Attributes. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a attribute is valid only in this function and must be released - * using maps_place_attribute_destroy(). - * \n To use @a attribute outside this function, clone it with - * maps_place_attribute_clone(). - * - * @param[in] index The current index of attribute - * @param[in] total The total amount of attributes - * @param[in] attribute The place attribute handle - * @param[in] user_data The user data passed from the - * maps_place_foreach_attribute() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a attribute is valid only in this function and must be released using maps_place_attribute_destroy().\n + * To use @a attribute outside this function, clone it with maps_place_attribute_clone(). + * @param[in] index The current index of attribute + * @param[in] total The total amount of attributes + * @param[in] attribute The place attribute handle + * @param[in] user_data The user data passed from the maps_place_foreach_attribute() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_place_foreach_attribute() will invoke this callback. - * * @see maps_place_foreach_attribute() * @see #maps_place_attribute_h */ -typedef bool(*maps_place_attributes_cb) (int index, int total, - maps_place_attribute_h attribute, - void *user_data); +typedef bool(*maps_place_attributes_cb) (int index, int total, maps_place_attribute_h attribute, void *user_data); + /** - * @brief Called when requesting the list of Place Contacts. - * @details This callback is invoked while iterating through the list of Place - * Contacts. + * @brief Called when requesting the list of Place Contacts. + * @details This callback is invoked while iterating through the list of Place Contacts. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a contact is valid only in this function and must be released using - * maps_place_contact_destroy(). - * \n To use @a contact outside this function, clone it with - * maps_place_contact_clone(). - * - * @param[in] index The current index of contact - * @param[in] total The total amount of contacts - * @param[in] contact The place contact handle - * @param[in] user_data The user data passed from the - * maps_place_foreach_contact() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a contact is valid only in this function and must be released using maps_place_contact_destroy().\n + * To use @a contact outside this function, clone it with maps_place_contact_clone(). + * @param[in] index The current index of contact + * @param[in] total The total amount of contacts + * @param[in] contact The place contact handle + * @param[in] user_data The user data passed from the maps_place_foreach_contact() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_place_foreach_contact() will invoke this callback. - * * @see maps_place_foreach_contact() * @see #maps_place_contact_h */ -typedef bool(*maps_place_contacts_cb) (int index, int total, - maps_place_contact_h contact, - void *user_data); +typedef bool(*maps_place_contacts_cb) (int index, int total, maps_place_contact_h contact, void *user_data); + /** - * @brief Called when requesting the list of Place Editorial. - * @details This callback is invoked while iterating through the list of Place - * Editorials. + * @brief Called when requesting the list of Place Editorial. + * @details This callback is invoked while iterating through the list of Place Editorials. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a editorial is valid only in this function and must be released - * using maps_place_editorial_destroy(). - * \n To use @a editorial outside this function, clone it with - * maps_place_editorial_clone(). - * - * @param[in] index The current index of editorial - * @param[in] total The total amount of editorials - * @param[in] editorial The place editorial handle - * @param[in] user_data The user data passed from the - * maps_place_foreach_editorial() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a editorial is valid only in this function and must be released using maps_place_editorial_destroy().\n + * To use @a editorial outside this function, clone it with maps_place_editorial_clone(). + * @param[in] index The current index of editorial + * @param[in] total The total amount of editorials + * @param[in] editorial The place editorial handle + * @param[in] user_data The user data passed from the maps_place_foreach_editorial() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_place_foreach_editorial() will invoke this callback. - * * @see maps_place_foreach_editorial() * @see #maps_place_editorial_h */ +typedef bool(*maps_place_editorials_cb) (int index, int total, maps_place_editorial_h editorial, void *user_data); + -typedef bool(*maps_place_editorials_cb) (int index, int total, - maps_place_editorial_h editorial, - void *user_data); /** - * @brief Called when requesting the list of Place Image. - * @details This callback is invoked while iterating through the list of Place - * Images. + * @brief Called when requesting the list of Place Image. + * @details This callback is invoked while iterating through the list of Place Images. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a image is valid only in this function and must be released using - * maps_place_image_destroy(). - * \n To use @a image outside this function, clone it with - * maps_place_image_clone(). - * - * @param[in] index The current index of image - * @param[in] total The total amount of images - * @param[in] image The place image handle - * @param[in] user_data The user data passed from the - * maps_place_foreach_image() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a image is valid only in this function and must be released using maps_place_image_destroy().\n + * To use @a image outside this function, clone it with maps_place_image_clone(). + * @param[in] index The current index of image + * @param[in] total The total amount of images + * @param[in] image The place image handle + * @param[in] user_data The user data passed from the maps_place_foreach_image() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_place_foreach_image() will invoke this callback. - * * @see maps_place_foreach_image() * @see #maps_place_image_h */ -typedef bool(*maps_place_images_cb) (int index, int total, - maps_place_image_h image, - void *user_data); +typedef bool(*maps_place_images_cb) (int index, int total, maps_place_image_h image, void *user_data); + /** - * @brief Called when requesting the list of Place Review. - * @details This callback is invoked while iterating through the list of Place - * Reviews. + * @brief Called when requesting the list of Place Review. + * @details This callback is invoked while iterating through the list of Place Reviews. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a review is valid only in this function and must be released using - * maps_place_review_destroy(). - * \n To use @a review outside this function, clone it with - * maps_place_review_clone(). - * - * @param[in] index The current index of review - * @param[in] total The total amount of reviews - * @param[in] review The place review handle - * @param[in] user_data The user data passed from the - * maps_place_foreach_review() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a review is valid only in this function and must be released using maps_place_review_destroy().\n + * To use @a review outside this function, clone it with maps_place_review_clone(). + * @param[in] index The current index of review + * @param[in] total The total amount of reviews + * @param[in] review The place review handle + * @param[in] user_data The user data passed from the maps_place_foreach_review() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_place_foreach_review() will invoke this callback. - * * @see maps_place_foreach_review() * @see #maps_place_image_h */ -typedef bool(*maps_place_reviews_cb) (int index, int total, - maps_place_review_h review, - void *user_data); +typedef bool(*maps_place_reviews_cb) (int index, int total, maps_place_review_h review, void *user_data); + /** - * @brief Called when requesting the list of Place. + * @brief Called when requesting the list of Place. * @details This callback is invoked while iterating through the list of Place. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] index The current index of review - * @param[in] place The place handle - * @param[in] user_data The user data passed from the maps_place_list_foreach() - * @return @c true to continue with the next iteration of the loop, - * \n @c false to break out of the loop - * + * @param[in] index The current index of review + * @param[in] place The place handle + * @param[in] user_data The user data passed from the maps_place_list_foreach() + * @return @c true to continue with the next iteration of the loop, \n + * @c false to break out of the loop * @pre maps_place_list_foreach() will invoke this callback. - * * @see maps_place_list_foreach() * @see maps_place_get_id() * @see maps_place_get_name() @@ -280,400 +226,368 @@ typedef bool(*maps_place_reviews_cb) (int index, int total, */ typedef bool(*maps_place_cb) (int index, maps_place_h place, void *user_data); + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the place handle and releases all its resources. - * @details This function destroys the place handle and releases all its - * resources. + * @brief Destroys the place handle and releases all its resources. + * @details This function destroys the place handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] place The place handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] place The place handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_clone() */ int maps_place_destroy(maps_place_h place); + /** - * @brief Clones the place handle. - * @details This function clones the place handle @a origin and all its - * resources. + * @brief Clones the place handle. + * @details This function clones the place handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_place_destroy(). - * - * @param[in] origin The original place handle - * @param[out] cloned A cloned place handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original place handle + * @param[out] cloned A cloned place handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_destroy() */ int maps_place_clone(const maps_place_h origin, maps_place_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the place id. - * @details This function gets the place id. + * @brief Gets the place ID. + * @details This function gets the place ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a id must be released using free(). - * - * @param[in] place The place handle - * @param[out] id The place id - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The place handle + * @param[out] id The place ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_place_get_id(const maps_place_h place, char **id); + /** - * @brief Gets the place name. + * @brief Gets the place name. * @details This function gets the place name. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a name must be released using free(). - * - * @param[in] place The place handle - * @param[out] name The place name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The place handle + * @param[out] name The place name + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_place_get_name(const maps_place_h place, char **name); + /** - * @brief Gets the place view URI. + * @brief Gets the place view URI. * @details This function gets the place view URI. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a uri must be released using free(). - * - * @param[in] place The place handle - * @param[out] uri The place view URI - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The place handle + * @param[out] uri The place view URI + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_place_get_uri(const maps_place_h place, char **uri); + /** - * @brief Gets the place location. + * @brief Gets the place location. * @details This function gets the place location. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a location must be released using maps_coordinates_destroy(). - * - * @param[in] place The place handle - * @param[out] location The place location - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The place handle + * @param[out] location The place location + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_get_location(const maps_place_h place, - maps_coordinates_h *location); +int maps_place_get_location(const maps_place_h place, maps_coordinates_h *location); + /** - * @brief Gets the place distance from the center of the location. - * @details This function gets the place distance from the center of the - * location. + * @brief Gets the place distance from the center of the location. + * @details This function gets the place distance from the center of the location. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] place The place handle - * @param[out] distance The place distance in meters - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The place handle + * @param[out] distance The place distance in meters + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_place_get_distance(const maps_place_h place, int *distance); + /** - * @brief Gets the place address. + * @brief Gets the place address. * @details This function gets the place address. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a address must be released using maps_address_destroy(). - * - * @param[in] place The place handle - * @param[out] address The place address - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The place handle + * @param[out] address The place address + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_get_address(const maps_place_h place, - maps_address_h *address); +int maps_place_get_address(const maps_place_h place, maps_address_h *address); /** - * @brief Gets the place rating. + * @brief Gets the place rating. * @details This function gets the place rating. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a rating must be released using maps_place_rating_destroy(). - * - * @param[in] place The place handle - * @param[out] rating The place rating handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The place handle + * @param[out] rating The place rating handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_get_rating(const maps_place_h place, - maps_place_rating_h *rating); +int maps_place_get_rating(const maps_place_h place, maps_place_rating_h *rating); + /** - * @brief Retrieves all properties. + * @brief Retrieves all properties. * @details This function retrieves all place properties. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The properties will be delivered via maps_place_properties_cb(). - * - * @param[in] place The place handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_place_properties_cb() repeatedly to retrieve - * each property. - * + * @param[in] place The place handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_place_properties_cb() repeatedly to retrieve each property. * @see maps_place_properties_cb() */ -int maps_place_foreach_property(const maps_place_h place, - maps_place_properties_cb callback, - void *user_data); +int maps_place_foreach_property(const maps_place_h place, maps_place_properties_cb callback, void *user_data); + /** - * @brief Retrieves all categories + * @brief Retrieves all categories * @details This function retrieves all place categories. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The categories will be delivered via maps_place_categories_cb(). - * - * @param[in] place The place handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_place_categories_cb() repeatedly to retrieve - * each category. - * + * @param[in] place The place handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_place_categories_cb() repeatedly to retrieve each category. * @see maps_place_categories_cb() */ -int maps_place_foreach_category(const maps_place_h place, - maps_place_categories_cb callback, - void *user_data); +int maps_place_foreach_category(const maps_place_h place, maps_place_categories_cb callback, void *user_data); + /** - * @brief Retrieves all attributes. + * @brief Retrieves all attributes. * @details This function retrieves all place attributes. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The attributes will be delivered via maps_place_attributes_cb(). - * - * @param[in] place The place handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_place_attributes_cb() repeatedly to retrieve - * each attribute. - * + * @param[in] place The place handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_place_attributes_cb() repeatedly to retrieve each attribute. * @see maps_place_attributes_cb() */ -int maps_place_foreach_attribute(const maps_place_h place, - maps_place_attributes_cb callback, - void *user_data); +int maps_place_foreach_attribute(const maps_place_h place, maps_place_attributes_cb callback, void *user_data); + /** - * @brief Retrieves all contacts. + * @brief Retrieves all contacts. * @details This function retrieves all place contacts. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The contacts will be delivered via maps_place_contacts_cb(). - * - * @param[in] place The place handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_place_contacts_cb() repeatedly to retrieve - * each contact. - * + * @param[in] place The place handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_place_contacts_cb() repeatedly to retrieve each contact. * @see maps_place_contacts_cb() */ -int maps_place_foreach_contact(const maps_place_h place, - maps_place_contacts_cb callback, - void *user_data); +int maps_place_foreach_contact(const maps_place_h place, maps_place_contacts_cb callback, void *user_data); + /** - * @brief Retrieves all editorials. + * @brief Retrieves all editorials. * @details This function retrieves all place editorials. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The editorials will be delivered via maps_place_editorials_cb(). - * - * @param[in] place The place handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_place_editorials_cb() repeatedly to retrieve - * each editorial. - * + * @param[in] place The place handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_place_editorials_cb() repeatedly to retrieve each editorial. * @see maps_place_editorials_cb() */ -int maps_place_foreach_editorial(const maps_place_h place, - maps_place_editorials_cb callback, - void *user_data); +int maps_place_foreach_editorial(const maps_place_h place, maps_place_editorials_cb callback, void *user_data); + /** - * @brief Retrieves all images. + * @brief Retrieves all images. * @details This function retrieves all place images. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The images will be delivered via maps_place_images_cb(). - * - * @param[in] place The place handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_place_images_cb() repeatedly to retrieve - * each image. - * + * @param[in] place The place handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_place_images_cb() repeatedly to retrieve each image. * @see maps_place_images_cb() */ -int maps_place_foreach_image(const maps_place_h place, - maps_place_images_cb callback, void *user_data); +int maps_place_foreach_image(const maps_place_h place, maps_place_images_cb callback, void *user_data); + /** - * @brief Retrieves all reviews. + * @brief Retrieves all reviews. * @details This function retrieves all place reviews. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The reviews will be delivered via maps_place_reviews_cb(). - * - * @param[in] place The place handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_place_reviews_cb() repeatedly to retrieve - * each review. - * + * @param[in] place The place handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_place_reviews_cb() repeatedly to retrieve each review. * @see maps_place_reviews_cb() */ -int maps_place_foreach_review(const maps_place_h place, - maps_place_reviews_cb callback, - void *user_data); +int maps_place_foreach_review(const maps_place_h place, maps_place_reviews_cb callback, void *user_data); + /** - * @brief Gets the place supplier link. + * @brief Gets the place supplier link. * @details This function gets the place supplier link. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a supplier must be released using maps_place_link_object_destroy(). - * - * @param[in] place The place handle image - * @param[out] supplier The place supplier link - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The place handle + * @param[out] supplier The place supplier link + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_get_supplier_link(const maps_place_image_h place, - maps_place_link_object_h *supplier); +int maps_place_get_supplier_link(const maps_place_h place, maps_place_link_object_h *supplier); + /** - * @brief Gets the place related link. + * @brief Gets the place related link. * @details This function gets the place related link. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a related must be released using maps_place_link_object_destroy(). - * - * @param[in] place The place handle image - * @param[out] related The place related link - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The place handle + * @param[out] related The place related link + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_get_related_link(const maps_place_image_h place, - maps_place_link_object_h *related); +int maps_place_get_related_link(const maps_place_h place, maps_place_link_object_h *related); + /** - * @brief Retrieves all places. + * @brief Retrieves all places. * @details This function retrieves all places. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks The places will be delivered via maps_place_cb(). - * \n @a place_list must be released using maps_place_list_destroy(). - * - * @param[in] place_list The place list handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks The places will be delivered via maps_place_cb().\n + * @a place_list must be released using maps_place_list_destroy(). + * @param[in] place_list The place list handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @post This function invokes maps_place_cb() repeatedly to retrieve each place. - * * @see maps_place_cb() * @see maps_place_list_destroy() */ int maps_place_list_foreach(const maps_place_list_h place_list, maps_place_cb callback, void *user_data); + /** - * @brief Frees all of the memory used by a place list. + * @brief Frees all of the memory used by a place list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] place_list The place list handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] place_list The place list handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_list_foreach() */ int maps_place_list_destroy(maps_place_list_h place_list); + #ifdef __cplusplus } #endif /** * @} */ -#endif /* __MAPS_PLACE_H__ */ +#endif /* __MAPS_PLACE_H__ */ diff --git a/include/maps_place_attribute.h b/include/maps_place_attribute.h index bb8d39d..a5ba044 100644 --- a/include/maps_place_attribute.h +++ b/include/maps_place_attribute.h @@ -14,127 +14,125 @@ * limitations under the License. */ + #ifndef __MAPS_PLACE_ATTRIBUTE_H__ #define __MAPS_PLACE_ATTRIBUTE_H__ + /** - * @ingroup CAPI_MAPS_PLACE_MODULE - * @defgroup CAPI_MAPS_PLACE_ATTRIBUTE_MODULE Attribute - * + * @ingroup CAPI_MAPS_PLACE_MODULE + * @defgroup CAPI_MAPS_PLACE_ATTRIBUTE_MODULE Attribute * @file maps_place_attribute.h - * @brief This file contains the functions related to Place Attributes - * information. - * + * @brief This file contains the functions related to Place Attributes information. * @addtogroup CAPI_MAPS_PLACE_ATTRIBUTE_MODULE * @{ - * @brief This provides APIs related to Place Attributes information, used in - * Place Discovery and Search. + * @brief This provides APIs related to Place Attributes information, used in Place Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The Place Attribute handle + * @brief The Place Attribute handle. * @details The handle of Place Attribute instance. - * @remarks To release the handle use maps_place_attribute_destroy(). - * \n To clone the handle use maps_place_attribute_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_place_attribute_destroy().\n + * To clone the handle use maps_place_attribute_clone(). * @see maps_place_attribute_destroy() * @see maps_place_attribute_clone() */ typedef void *maps_place_attribute_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the place attribute handle and releases all its - * resources. - * @details This function destroys the place attribute handle and releases all - * its resources. + * @brief Destroys the place attribute handle and releases all its resources. + * @details This function destroys the place attribute handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] attribute The place attribute handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] attribute The place attribute handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_attribute_clone() */ int maps_place_attribute_destroy(maps_place_attribute_h attribute); + /** - * @brief Clones the place attribute handle. - * @details This function clones the place attribute handle @a origin and all - * its resources. + * @brief Clones the place attribute handle. + * @details This function clones the place attribute handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_place_attribute_destroy(). - * - * @param[in] origin The original place attribute handle - * @param[out] cloned A cloned place attribute handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original place attribute handle + * @param[out] cloned A cloned place attribute handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_attribute_destroy() */ -int maps_place_attribute_clone(const maps_place_attribute_h origin, - maps_place_attribute_h *cloned); +int maps_place_attribute_clone(const maps_place_attribute_h origin, maps_place_attribute_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the place attribute id. - * @details This function gets the place attribute id. + * @brief Gets the place attribute ID. + * @details This function gets the place attribute ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a id must be released using free(). - * - * @param[in] attribute The handle to place attribute - * @param[out] id The place attribute id - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] attribute The handle to place attribute + * @param[out] id The place attribute ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_attribute_get_id(const maps_place_attribute_h attribute, - char **id); +int maps_place_attribute_get_id(const maps_place_attribute_h attribute, char **id); + /** - * @brief Gets the place attribute label. + * @brief Gets the place attribute label. * @details This function gets the place attribute label. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a label must be released using free(). - * - * @param[in] attribute The handle to place attribute - * @param[out] label The place attribute label - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] attribute The handle to place attribute + * @param[out] label The place attribute label + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_attribute_get_label(const maps_place_attribute_h attribute, - char **label); +int maps_place_attribute_get_label(const maps_place_attribute_h attribute, char **label); + /** - * @brief Gets the place attribute text. + * @brief Gets the place attribute text. * @details This function gets the place attribute text. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a text must be released using free(). - * - * @param[in] attribute The handle to place attribute - * @param[out] text The place attribute text - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] attribute The handle to place attribute + * @param[out] text The place attribute text + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_attribute_get_text(const maps_place_attribute_h attribute, - char **text); +int maps_place_attribute_get_text(const maps_place_attribute_h attribute, char **text); + #ifdef __cplusplus } @@ -142,4 +140,4 @@ int maps_place_attribute_get_text(const maps_place_attribute_h attribute, /** * @} */ -#endif /* __MAPS_PLACE_ATTRIBUTE_H__ */ +#endif /* __MAPS_PLACE_ATTRIBUTE_H__ */ diff --git a/include/maps_place_attribute_plugin.h b/include/maps_place_attribute_plugin.h index a45a4a8..da30034 100644 --- a/include/maps_place_attribute_plugin.h +++ b/include/maps_place_attribute_plugin.h @@ -20,8 +20,8 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_PLACE_ATTRIBUTE_MODULE Attribute + * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_PLACE_ATTRIBUTE_MODULE Attribute * * @file maps_place_attribute_plugin.h * @brief This file contains the functions related to Place Attributes @@ -46,12 +46,12 @@ extern "C" { * maps_place_attribute_destroy(). * \n @a attribute may be cloned using maps_place_attribute_clone(). * - * @param[out] attribute A handle of a new place attribute on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] attribute A handle of a new place attribute on success + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_place_attribute_destroy() * @see maps_place_attribute_clone() @@ -59,64 +59,61 @@ extern "C" { int maps_place_attribute_create(maps_place_attribute_h *attribute); /** - * @brief Sets the place attribute id. - * @details This function sets the place attribute id. + * @brief Sets the place attribute ID. + * @details This function sets the place attribute ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] attribute The handle to place attribute - * @param[in] id The place attribute id - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] attribute The handle to place attribute + * @param[in] id The place attribute ID + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a attribute is created using maps_place_attribute_create(). * * @see maps_place_attribute_create() * @see maps_place_attribute_get_id() */ -int maps_place_attribute_set_id(maps_place_attribute_h attribute, - const char *id); +int maps_place_attribute_set_id(maps_place_attribute_h attribute, const char *id); /** - * @brief Sets the place attribute label. + * @brief Sets the place attribute label. * @details This function sets the place attribute label. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] attribute The handle to place attribute - * @param[in] label The place attribute label - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] attribute The handle to place attribute + * @param[in] label The place attribute label + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a attribute is created using maps_place_attribute_create(). * * @see maps_place_attribute_create() * @see maps_place_attribute_get_label() */ -int maps_place_attribute_set_label(maps_place_attribute_h attribute, - const char *label); +int maps_place_attribute_set_label(maps_place_attribute_h attribute, const char *label); /** - * @brief Sets the place attribute text. + * @brief Sets the place attribute text. * @details This function sets the place attribute text. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] attribute The handle to place attribute - * @param[in] text The place attribute text - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] attribute The handle to place attribute + * @param[in] text The place attribute text + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a attribute is created using maps_place_attribute_create(). * * @see maps_place_attribute_create() * @see maps_place_attribute_get_text() */ -int maps_place_attribute_set_text(maps_place_attribute_h attribute, - const char *text); +int maps_place_attribute_set_text(maps_place_attribute_h attribute, const char *text); #ifdef __cplusplus } @@ -124,4 +121,4 @@ int maps_place_attribute_set_text(maps_place_attribute_h attribute, /** * @} */ -#endif /* __MAPS_PLACE_ATTRIBUTE_PLUGIN_H__ */ +#endif /* __MAPS_PLACE_ATTRIBUTE_PLUGIN_H__ */ diff --git a/include/maps_place_category.h b/include/maps_place_category.h index dd707ee..9edbcb2 100644 --- a/include/maps_place_category.h +++ b/include/maps_place_category.h @@ -14,57 +14,55 @@ * limitations under the License. */ + #ifndef __MAPS_PLACE_CATEGORY_H__ #define __MAPS_PLACE_CATEGORY_H__ + /** - * @ingroup CAPI_MAPS_PLACE_MODULE - * @defgroup CAPI_MAPS_PLACE_CATEGORY_MODULE Category - * + * @ingroup CAPI_MAPS_PLACE_MODULE + * @defgroup CAPI_MAPS_PLACE_CATEGORY_MODULE Category * @file maps_place_category.h - * @brief This file contains the functions related to Place Category - * information. - * + * @brief This file contains the functions related to Place Category information. * @addtogroup CAPI_MAPS_PLACE_CATEGORY_MODULE * @{ - * @brief This provides APIs related to place Category information, used in - * Place Discovery and Search. + * @brief This provides APIs related to place Category information, used in Place Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The place category handle - * @details The handle of place category instance. - * @remarks To release the handle use maps_place_category_destroy(). - * \n To clone the handle use maps_place_category_clone(). + * @brief The Place Category handle. + * @details The handle of Place Category instance. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_place_category_destroy().\n + * To clone the handle use maps_place_category_clone(). * @see maps_place_category_destroy() * @see maps_place_category_clone() */ typedef void *maps_place_category_h; + /*----------------------------------------------------------------------------*/ /** - * @brief Creates a new place category handle. - * @details This function creates a new place category handle and allocates all - * needed resources. + * @brief Creates a new place category handle. + * @details This function creates a new place category handle and allocates all needed resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a category must be released using maps_place_category_destroy(). - * \n @a category may be cloned using maps_place_category_clone(). - * - * @param[out] category A handle of a new place category on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a category must be released using maps_place_category_destroy().\n + * @a category may be cloned using maps_place_category_clone(). + * @param[out] category A handle of a new place category on success + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_category_destroy() * @see maps_place_category_clone() */ @@ -72,39 +70,33 @@ int maps_place_category_create(maps_place_category_h *category); /** - * @brief Clones the place category handle. - * @details This function clones the place category handle @a origin and all its - * resources. + * @brief Clones the place category handle. + * @details This function clones the place category handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_place_category_destroy(). - * - * @param[in] origin The original place category handle - * @param[out] cloned A cloned place category handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original place category handle + * @param[out] cloned A cloned place category handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_category_destroy() */ -int maps_place_category_clone(const maps_place_category_h origin, - maps_place_category_h *cloned); +int maps_place_category_clone(const maps_place_category_h origin, maps_place_category_h *cloned); /** - * @brief Destroys the place category handle and releases all its - * resources. - * @details This function destroys the place category handle and releases all - * its resources. + * @brief Destroys the place category handle and releases all its resources. + * @details This function destroys the place category handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] category The place category handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] category The place category handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_category_clone() */ int maps_place_category_destroy(maps_place_category_h category); @@ -112,118 +104,108 @@ int maps_place_category_destroy(maps_place_category_h category); /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the place category id. - * @details This function gets the place category id. + * @brief Gets the place category ID. + * @details This function gets the place category ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a id must be released using free(). - * - * @param[in] category The handle of place category - * @param[out] id The place category id - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] category The handle of place category + * @param[out] id The place category ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_category_get_id(const maps_place_category_h category, - char **id); +int maps_place_category_get_id(const maps_place_category_h category, char **id); /** - * @brief Gets the place category name. + * @brief Gets the place category name. * @details This function gets the place category name. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a name must be released using free(). - * - * @param[in] category The handle of place category - * @param[out] name The place category name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] category The handle of place category + * @param[out] name The place category name + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_category_get_name(const maps_place_category_h category, - char **name); +int maps_place_category_get_name(const maps_place_category_h category, char **name); /** - * @brief Gets the place category URL. + * @brief Gets the place category URL. * @details This function gets the place category URL. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a url must be released using free(). - * - * @param[in] category The handle of place category - * @param[out] url The place category URL - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] category The handle of place category + * @param[out] url The place category URL + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_category_get_url(const maps_place_category_h category, - char **url); +int maps_place_category_get_url(const maps_place_category_h category, char **url); /** - * @brief Sets the place category id. - * @details This function sets the place category id. + * @brief Sets the place category ID. + * @details This function sets the place category ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] category The handle of place category - * @param[in] id The place category id - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] category The handle of place category + * @param[in] id The place category ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a category is created using maps_place_category_create(). - * * @see maps_place_category_create() * @see maps_place_category_get_id() */ -int maps_place_category_set_id(maps_place_category_h category, - const char *id); +int maps_place_category_set_id(maps_place_category_h category, const char *id); /** - * @brief Sets the place category name. + * @brief Sets the place category name. * @details This function sets the place category name. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] category The handle of place category - * @param[in] name The place category name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] category The handle of place category + * @param[in] name The place category name + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a category is created using maps_place_category_create(). - * * @see maps_place_category_create() * @see maps_place_category_get_name() */ -int maps_place_category_set_name(maps_place_category_h category, - const char *name); +int maps_place_category_set_name(maps_place_category_h category, const char *name); /** - * @brief Sets the place category URL. + * @brief Sets the place category URL. * @details This function sets the place category URL. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] category The handle of place category - * @param[in] url The place category URL - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] category The handle of place category + * @param[in] url The place category URL + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a category is created using maps_place_category_create(). - * * @see maps_place_category_create() * @see maps_place_category_get_url() */ -int maps_place_category_set_url(maps_place_category_h category, - const char *url); +int maps_place_category_set_url(maps_place_category_h category, const char *url); + #ifdef __cplusplus } @@ -231,4 +213,4 @@ int maps_place_category_set_url(maps_place_category_h category, /** * @} */ -#endif /* __MAPS_PLACE_CATEGORY_H__ */ +#endif /* __MAPS_PLACE_CATEGORY_H__ */ diff --git a/include/maps_place_contact.h b/include/maps_place_contact.h index 46badfa..af20993 100644 --- a/include/maps_place_contact.h +++ b/include/maps_place_contact.h @@ -14,126 +14,125 @@ * limitations under the License. */ + #ifndef __MAPS_PLACE_CONTACT_H__ #define __MAPS_PLACE_CONTACT_H__ + /** - * @ingroup CAPI_MAPS_PLACE_MODULE - * @defgroup CAPI_MAPS_PLACE_CONTACT_MODULE Contact - * + * @ingroup CAPI_MAPS_PLACE_MODULE + * @defgroup CAPI_MAPS_PLACE_CONTACT_MODULE Contact * @file maps_place_contact.h * @brief This file contains the functions related to Place Contact information. - * * @addtogroup CAPI_MAPS_PLACE_CONTACT_MODULE * @{ - * @brief This provides APIs related to Place Contact, used in Place Discovery - * and Search. + * @brief This provides APIs related to Place Contact, used in Place Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The Place Contact handle + * @brief The Place Contact handle. * @details The handle of Place Contact instance. - * @remarks To release the handle use maps_place_contact_destroy(). - * \n To clone the handle use maps_place_contact_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_place_contact_destroy().\n + * To clone the handle use maps_place_contact_clone(). * @see maps_place_contact_destroy() * @see maps_place_contact_clone() */ typedef void *maps_place_contact_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the place contact handle and releases all its - * resources. - * @details This function destroys the place contact handle and releases all its - * resources. + * @brief Destroys the place contact handle and releases all its resources. + * @details This function destroys the place contact handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] contact The place contact handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] contact The place contact handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_contact_clone() */ int maps_place_contact_destroy(maps_place_contact_h contact); + /** - * @brief Clones the place contact handle. - * @details This function clones the place contact handle @a origin and all its - * resources. + * @brief Clones the place contact handle. + * @details This function clones the place contact handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_place_contact_destroy(). - * - * @param[in] origin The original place contact handle - * @param[out] cloned A cloned place contact handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original place contact handle + * @param[out] cloned A cloned place contact handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_contact_destroy() */ -int maps_place_contact_clone(const maps_place_contact_h origin, - maps_place_contact_h *cloned); +int maps_place_contact_clone(const maps_place_contact_h origin, maps_place_contact_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the place contact label. + * @brief Gets the place contact label. * @details This function gets the place contact label. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a label must be released using free(). - * - * @param[in] contact The handle to place contact - * @param[out] label The place contact label - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] contact The handle to place contact + * @param[out] label The place contact label + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_contact_get_label(const maps_place_contact_h contact, - char **label); +int maps_place_contact_get_label(const maps_place_contact_h contact, char **label); + /** - * @brief Gets the place contact type. + * @brief Gets the place contact type. * @details This function gets the place contact type. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a type must be released using free(). - * - * @param[in] contact The handle to place contact - * @param[out] type The place contact type - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] contact The handle to place contact + * @param[out] type The place contact type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_contact_get_type(const maps_place_contact_h contact, - char **type); +int maps_place_contact_get_type(const maps_place_contact_h contact, char **type); + /** - * @brief Gets the place contact value. + * @brief Gets the place contact value. * @details This function gets the place contact value. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a value must be released using free(). - * - * @param[in] contact The handle to place contact - * @param[out] value The place contact value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] contact The handle to place contact + * @param[out] value The place contact value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_contact_get_value(const maps_place_contact_h contact, - char **value); +int maps_place_contact_get_value(const maps_place_contact_h contact, char **value); + #ifdef __cplusplus } @@ -141,4 +140,4 @@ int maps_place_contact_get_value(const maps_place_contact_h contact, /** * @} */ -#endif /* __MAPS_PLACE_CONTACT_H__ */ +#endif /* __MAPS_PLACE_CONTACT_H__ */ diff --git a/include/maps_place_contact_plugin.h b/include/maps_place_contact_plugin.h index c335cac..c3b632d 100644 --- a/include/maps_place_contact_plugin.h +++ b/include/maps_place_contact_plugin.h @@ -20,8 +20,8 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_PLACE_CONTACT_MODULE Contact + * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_PLACE_CONTACT_MODULE Contact * * @file maps_place_contact_plugin.h * @brief This file contains the functions related to Place Contact @@ -46,12 +46,12 @@ extern "C" { * maps_place_contact_destroy(). * \n @a contact may be cloned using maps_place_contact_clone(). * - * @param[out] contact A handle of a new place contact on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] contact A handle of a new place contact on success + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see place_contact_destroy() * @see maps_place_contact_clone() @@ -59,64 +59,61 @@ extern "C" { int maps_place_contact_create(maps_place_contact_h *contact); /** - * @brief Sets the place contact label + * @brief Sets the place contact label * @details This function sets the place contact label. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] contact The handle of contact contact - * @param[in] label The place contact label - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] contact The handle of contact contact + * @param[in] label The place contact label + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a contact is created using maps_place_contact_create(). * * @see maps_place_contact_create() * @see maps_place_contact_get_label() */ -int maps_place_contact_set_label(maps_place_contact_h contact, - const char *label); +int maps_place_contact_set_label(maps_place_contact_h contact, const char *label); /** - * @brief Sets the place contact type + * @brief Sets the place contact type * @details This function sets the place contact type. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] contact The handle to place contact - * @param[in] type The place contact type - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] contact The handle to place contact + * @param[in] type The place contact type + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a contact is created using maps_place_contact_create(). * * @see maps_place_contact_create() * @see maps_place_contact_get_type() */ -int maps_place_contact_set_type(maps_place_contact_h contact, - const char *type); +int maps_place_contact_set_type(maps_place_contact_h contact, const char *type); /** - * @brief Sets the place contact value + * @brief Sets the place contact value * @details This function sets the place contact value. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] contact The handle to place contact - * @param[in] value The place contact value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] contact The handle to place contact + * @param[in] value The place contact value + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a contact is created using maps_place_contact_create(). * * @see maps_place_contact_create() * @see maps_place_contact_get_value() */ -int maps_place_contact_set_value(maps_place_contact_h contact, - const char *value); +int maps_place_contact_set_value(maps_place_contact_h contact, const char *value); #ifdef __cplusplus } @@ -124,4 +121,4 @@ int maps_place_contact_set_value(maps_place_contact_h contact, /** * @} */ -#endif /* __MAPS_PLACE_CONTACT_PLUGIN_H__ */ +#endif /* __MAPS_PLACE_CONTACT_PLUGIN_H__ */ diff --git a/include/maps_place_editorial.h b/include/maps_place_editorial.h index 28a8f66..5353eb5 100644 --- a/include/maps_place_editorial.h +++ b/include/maps_place_editorial.h @@ -14,131 +14,129 @@ * limitations under the License. */ + #ifndef __MAPS_PLACE_EDITORIAL_H__ #define __MAPS_PLACE_EDITORIAL_H__ + #include + /** - * @ingroup CAPI_MAPS_PLACE_MODULE - * @defgroup CAPI_MAPS_PLACE_EDITORIAL_MODULE Editorial - * + * @ingroup CAPI_MAPS_PLACE_MODULE + * @defgroup CAPI_MAPS_PLACE_EDITORIAL_MODULE Editorial * @file maps_place_editorial.h - * @brief This file contains the functions related to Place Editorial - * information. - * + * @brief This file contains the functions related to Place Editorial information. * @addtogroup CAPI_MAPS_PLACE_EDITORIAL_MODULE * @{ - * @brief This provides APIs related to Place Editorial information, used in - * Place Discovery and Search. + * @brief This provides APIs related to Place Editorial information, used in Place Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The Place Editorial handle + * @brief The Place Editorial handle. * @details The handle of Place Editorial instance. - * @remarks To release the handle use maps_place_editorial_destroy(). - * \n To clone the handle use maps_place_editorial_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_place_editorial_destroy().\n + * To clone the handle use maps_place_editorial_clone(). * @see maps_place_editorial_destroy() * @see maps_place_editorial_clone() */ typedef void *maps_place_editorial_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the place editorial handle and releases all its - * resources. - * @details This function destroys the place editorial handle and releases all - * its resources. + * @brief Destroys the place editorial handle and releases all its resources. + * @details This function destroys the place editorial handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] editorial The place editorial handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] editorial The place editorial handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_editorial_clone() */ int maps_place_editorial_destroy(maps_place_editorial_h editorial); + /** - * @brief Clones the place editorial handle. - * @details This function clones the place editorial handle @a origin and all - * its resources. + * @brief Clones the place editorial handle. + * @details This function clones the place editorial handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_place_editorial_destroy(). - * - * @param[in] origin The original place editorial handle - * @param[out] cloned A cloned place editorial handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original place editorial handle + * @param[out] cloned A cloned place editorial handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_editorial_destroy() */ -int maps_place_editorial_clone(const maps_place_editorial_h origin, - maps_place_editorial_h *cloned); +int maps_place_editorial_clone(const maps_place_editorial_h origin, maps_place_editorial_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the place editorial description. + * @brief Gets the place editorial description. * @details This function gets the place editorial description. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a description must be released using free(). - * - * @param[in] editorial The handle of place editorial - * @param[out] description The place editorial description - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] editorial The handle of place editorial + * @param[out] description The place editorial description + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_editorial_get_description(const maps_place_editorial_h - editorial, char **description); +int maps_place_editorial_get_description(const maps_place_editorial_h editorial, char **description); + /** - * @brief Gets the place editorial language. + * @brief Gets the place editorial language. * @details This function gets the place editorial language. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a language must be released using free(). - * - * @param[in] editorial The handle of place editorial - * @param[out] language The place editorial language - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] editorial The handle of place editorial + * @param[out] language The place editorial language + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_editorial_get_language(const maps_place_editorial_h editorial, - char **language); +int maps_place_editorial_get_language(const maps_place_editorial_h editorial, char **language); + /** - * @brief Gets the place editorial media. + * @brief Gets the place editorial media. * @details This function gets the place editorial media. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a media must be released using maps_place_media_destroy(). - * - * @param[in] editorial The handle of place editorial - * @param[out] media The place editorial media - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] editorial The handle of place editorial + * @param[out] media The place editorial media + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_place_media_h */ -int maps_place_editorial_get_media(const maps_place_editorial_h editorial, - maps_place_media_h *media); +int maps_place_editorial_get_media(const maps_place_editorial_h editorial, maps_place_media_h *media); + #ifdef __cplusplus } @@ -146,4 +144,4 @@ int maps_place_editorial_get_media(const maps_place_editorial_h editorial, /** * @} */ -#endif /* __MAPS_PLACE_EDITORIAL_H__ */ +#endif /* __MAPS_PLACE_EDITORIAL_H__ */ diff --git a/include/maps_place_editorial_plugin.h b/include/maps_place_editorial_plugin.h index 1ead082..18eb16e 100644 --- a/include/maps_place_editorial_plugin.h +++ b/include/maps_place_editorial_plugin.h @@ -20,8 +20,8 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_PLACE_EDITORIAL_MODULE Editorial + * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_PLACE_EDITORIAL_MODULE Editorial * * @file maps_place_editorial_plugin.h * @brief This file contains the functions related to Place Editorial @@ -45,12 +45,12 @@ extern "C" { * @remarks @a editorial must be released using maps_place_editorial_destroy(). * \n @a editorial may be cloned using maps_place_editorial_clone(). * - * @param[out] editorial A handle of a new place editorial on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] editorial A handle of a new place editorial on success + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_place_editorial_destroy() * @see maps_place_editorial_clone() @@ -58,56 +58,54 @@ extern "C" { int maps_place_editorial_create(maps_place_editorial_h *editorial); /** - * @brief Sets the place editorial description. + * @brief Sets the place editorial description. * @details This function sets the place editorial description. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] editorial The handle of place editorial - * @param[in] description The place editorial description - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] editorial The handle of place editorial + * @param[in] description The place editorial description + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a editorial is created using maps_place_editorial_create(). * * @see maps_place_editorial_create() * @see maps_place_editorial_get_description() */ -int maps_place_editorial_set_description(maps_place_editorial_h editorial, - const char *description); +int maps_place_editorial_set_description(maps_place_editorial_h editorial, const char *description); /** - * @brief Sets the place editorial language. + * @brief Sets the place editorial language. * @details This function sets the place editorial language. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] editorial The handle of place editorial - * @param[in] language The place editorial language - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] editorial The handle of place editorial + * @param[in] language The place editorial language + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a editorial is created using maps_place_editorial_create(). * * @see maps_place_editorial_create() * @see maps_place_editorial_get_language() */ -int maps_place_editorial_set_language(maps_place_editorial_h editorial, - const char *language); +int maps_place_editorial_set_language(maps_place_editorial_h editorial, const char *language); /** - * @brief Sets the place editorial media. + * @brief Sets the place editorial media. * @details This function sets the place editorial media. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] editorial The handle of place editorial - * @param[in] media The place editorial media - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] editorial The handle of place editorial + * @param[in] media The place editorial media + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a editorial is created using maps_place_editorial_create(). * @@ -115,8 +113,7 @@ int maps_place_editorial_set_language(maps_place_editorial_h editorial, * @see maps_place_editorial_get_media() * @see maps_place_media_destroy */ -int maps_place_editorial_set_media(maps_place_editorial_h editorial, - const maps_place_media_h media); +int maps_place_editorial_set_media(maps_place_editorial_h editorial, const maps_place_media_h media); #ifdef __cplusplus } @@ -124,4 +121,4 @@ int maps_place_editorial_set_media(maps_place_editorial_h editorial, /** * @} */ -#endif /* __MAPS_PLACE_EDITORIAL_PLUGIN_H__ */ +#endif /* __MAPS_PLACE_EDITORIAL_PLUGIN_H__ */ diff --git a/include/maps_place_filter.h b/include/maps_place_filter.h index c759e50..72d62f5 100644 --- a/include/maps_place_filter.h +++ b/include/maps_place_filter.h @@ -14,376 +14,340 @@ * limitations under the License. */ + #ifndef __MAPS_PLACE_FILTER_H__ #define __MAPS_PLACE_FILTER_H__ + #include + /** - * @ingroup CAPI_MAPS_PLACE_MODULE - * @defgroup CAPI_MAPS_PLACE_FILTER_MODULE Filter - * + * @ingroup CAPI_MAPS_PLACE_MODULE + * @defgroup CAPI_MAPS_PLACE_FILTER_MODULE Filter * @file maps_place_filter.h * @brief This file contains the functions related to Place Filter information. - * * @addtogroup CAPI_MAPS_PLACE_FILTER_MODULE * @{ * @brief This provides APIs related to Place Filter information, used in Place * Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The Place Filter handle + * @brief The Place Filter handle. * @details The handle of Place Filter instance. - * @remarks To release the handle use maps_place_filter_destroy(). - * \n To clone the handle use maps_place_filter_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_place_filter_destroy().\n + * To clone the handle use maps_place_filter_clone(). * @see maps_place_filter_destroy() * @see maps_place_filter_clone() */ typedef void *maps_place_filter_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Called when requesting the list of Place Filter Properties. - * @details This callback is invoked while iterating through the list of Place - * Filter Properties. + * @brief Called when requesting the list of Place Filter Properties. + * @details This callback is invoked while iterating through the list of Place Filter Properties. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a key and @a value must be released using free() and corresponding - * release method for property value correspondingly. - * - * @param[in] index The current index of property - * @param[in] total The total amount of properties - * @param[in] key The key of property - * @param[in] value The value of property - * @param[in] uesr_data The user data passed from the - * maps_place_filter_foreach_property() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a key and @a value must be released using free() and corresponding release method for property value correspondingly. + * @param[in] index The current index of property + * @param[in] total The total amount of properties + * @param[in] key The key of property + * @param[in] value The value of property + * @param[in] uesr_data The user data passed from the maps_place_filter_foreach_property() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_place_filter_foreach_property() will invoke this callback. - * * @see maps_place_filter_foreach_property() */ -typedef bool(*maps_place_filter_properties_cb) (int index, int total, - char *key, void *value, - void *user_data); +typedef bool(*maps_place_filter_properties_cb) (int index, int total, char *key, void *value, void *user_data); + /*----------------------------------------------------------------------------*/ + /** - * @brief Creates a new place filter handle. - * @details This function creates a new place filter handle and allocates all - * needed resources. + * @brief Creates a new Place Filter handle. + * @details This function creates a new place filter handle and allocates all needed resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a filter must be released using maps_place_filter_destroy(). - * \n @a filter may be cloned using maps_place_filter_clone(). - * - * @param[out] filter A handle of a new place filter on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a filter must be released using maps_place_filter_destroy().\n + * @a filter may be cloned using maps_place_filter_clone(). + * @param[out] filter A handle of a new place filter on success + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_filter_destroy() * @see maps_place_filter_clone() */ int maps_place_filter_create(maps_place_filter_h *filter); + /** - * @brief Destroys the place filter handle and releases all its resources. - * @details This function destroys the place filter handle and releases all its - * resources. + * @brief Destroys the place filter handle and releases all its resources. + * @details This function destroys the place filter handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] filter The place filter handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The place filter handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a filter is created using maps_place_filter_create(). - * * @see maps_place_filter_create() * @see maps_place_filter_clone() */ int maps_place_filter_destroy(maps_place_filter_h filter); + /** - * @brief Clones the place filter handle. - * @details This function clones the place filter handle @a origin and all its - * resources. - * \n Place filter handle @a origin may be created using - * maps_place_filter_create(). + * @brief Clones the place filter handle. + * @details This function clones the place filter handle @a origin and all its resources.\n + * Place filter handle @a origin may be created using maps_place_filter_create(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_place_filter_destroy(). - * - * @param[in] origin The place filter handle to be cloned - * @param[out] cloned A handle of a newly cloned place filter on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The place filter handle to be cloned + * @param[out] cloned A handle of a newly cloned place filter on success + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a origin is created using maps_place_filter_create(). - * * @see maps_place_filter_create() * @see maps_place_filter_destroy() */ -int maps_place_filter_clone(const maps_place_filter_h origin, - maps_place_filter_h *cloned); +int maps_place_filter_clone(const maps_place_filter_h origin, maps_place_filter_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the value of the specified key in the place filter. - * @details This function gets the value of the specified key in the place - * filter. + * @brief Gets the value of the specified key in the place filter. + * @details This function gets the value of the specified key in the place filter. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a value must be released using free(). - * - * @param[in] filter The handle of the place filter - * @param[in] key The key of filter - * @param[out] value The filter value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The handle of the place filter + * @param[in] key The key of filter + * @param[out] value The filter value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a filter is created using maps_place_filter_create(). - * * @see maps_place_filter_set() * @see maps_place_filter_create() */ -int maps_place_filter_get(const maps_place_filter_h filter, const char *key, - char **value); +int maps_place_filter_get(const maps_place_filter_h filter, const char *key, char **value); + /** - * @brief Gets the value of keyword. + * @brief Gets the value of keyword. * @details This function gets the value of keyword. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a keyword must be released using free(). - * - * @param[in] filter The handle of the place filter - * @param[out] keyword The key of filter - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The handle of the place filter + * @param[out] keyword The key of filter + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a filter is created using maps_place_filter_create(). - * * @see maps_place_filter_set_keyword() * @see maps_place_filter_create() */ -int maps_place_filter_get_keyword(const maps_place_filter_h filter, - char **keyword); +int maps_place_filter_get_keyword(const maps_place_filter_h filter, char **keyword); + /** - * @brief Gets the place name. + * @brief Gets the place name. * @details This function gets the place name. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a place_name must be released using free(). - * - * @param[in] filter The handle of the place filter - * @param[out] place_name The place name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The handle of the place filter + * @param[out] place_name The place name + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a filter is created using maps_place_filter_create(). - * * @see maps_place_filter_set_place_name() * @see maps_place_filter_create() */ -int maps_place_filter_get_place_name(const maps_place_filter_h filter, - char **place_name); +int maps_place_filter_get_place_name(const maps_place_filter_h filter, char **place_name); + /** - * @brief Gets the category. - * @details This function gets the category. - * \n For allowed values of keys, see the macros above. + * @brief Gets the category. + * @details This function gets the category.\n + * For allowed values of keys, see the macros above. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a category must be released using maps_place_category_destroy(). - * - * @param[in] filter The handle of the place filter - * @param[out] category The category - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The handle of the place filter + * @param[out] category The category + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a filter is created using maps_place_filter_create(). - * * @see maps_place_filter_set_category() * @see maps_place_filter_create() */ -int maps_place_filter_get_category(const maps_place_filter_h filter, - maps_place_category_h *category); +int maps_place_filter_get_category(const maps_place_filter_h filter, maps_place_category_h *category); + /** * @brief Retrieves all filter properties. * @details This function retrieves all place filter properties. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] filter The handle of the place filter - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The handle of the place filter + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a filter is created using maps_place_filter_create(). - * - * @post This function invokes maps_place_filter_properties_cb() repeatedly to - * retrieve each available filter keys. - * + * @post This function invokes maps_place_filter_properties_cb() repeatedly to retrieve each available filter keys. * @see maps_place_filter_properties_cb() * @see maps_place_filter_get() * @see maps_place_filter_set() * @see maps_place_filter_create() */ -int maps_place_filter_foreach_property(const maps_place_filter_h filter, - maps_place_filter_properties_cb - callback, void *user_data); +int maps_place_filter_foreach_property(const maps_place_filter_h filter, maps_place_filter_properties_cb callback, void *user_data); + /** - * @brief Gets the place address. + * @brief Gets the place address. * @details This function gets the place address. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks @a place_address must be released using free(). - * - * @param[in] filter The handle of the place filter - * @param[out] place_address The place address - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The handle of the place filter + * @param[out] place_address The place address + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a filter is created using maps_place_filter_create(). - * * @see maps_place_filter_set_place_address() * @see maps_place_filter_create() */ -int maps_place_filter_get_place_address(const maps_place_filter_h filter, - char **place_address); +int maps_place_filter_get_place_address(const maps_place_filter_h filter, char **place_address); + /*----------------------------------------------------------------------------*/ + /** - * @brief Sets the filter value. - * @details This function sets the filter value in an assignment with a - * specified string key. + * @brief Sets the filter value. + * @details This function sets the filter value in an assignment with a specified string key. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] filter The handle of the place filter - * @param[in] key The key of filter - * @param[in] value The filter value to set, could be NULL if want remove - * value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The handle of the place filter + * @param[in] key The key of filter + * @param[in] value The filter value to set, could be NULL if want remove value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a filter is created using maps_place_filter_create(). - * * @see maps_place_filter_get() * @see maps_place_filter_create() */ -int maps_place_filter_set(maps_place_filter_h filter, const char *key, - const char *value); +int maps_place_filter_set(maps_place_filter_h filter, const char *key, const char *value); + /** - * @brief Sets the keyword. + * @brief Sets the keyword. * @details This function sets the keyword. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] filter The handle of the place filter - * @param[in] keyword The keyword - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The handle of the place filter + * @param[in] keyword The keyword + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a filter is created using maps_place_filter_create(). - * * @see maps_place_filter_get_keyword() * @see maps_place_filter_create() */ -int maps_place_filter_set_keyword(maps_place_filter_h filter, - const char *keyword); +int maps_place_filter_set_keyword(maps_place_filter_h filter, const char *keyword); + /** - * @brief Sets the place name. + * @brief Sets the place name. * @details This function sets the place name. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] filter The handle of the place filter - * @param[in] place_name The place name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The handle of the place filter + * @param[in] place_name The place name + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a filter is created using maps_place_filter_create(). - * * @see maps_place_filter_get_place_name() * @see maps_place_filter_create() */ -int maps_place_filter_set_place_name(maps_place_filter_h filter, - const char *place_name); +int maps_place_filter_set_place_name(maps_place_filter_h filter, const char *place_name); + /** - * @brief Sets the category. + * @brief Sets the category. * @details This function sets the place name. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] filter The handle of the place filter - * @param[in] category The category - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The handle of the place filter + * @param[in] category The category + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a filter is created using maps_place_filter_create(). - * * @see maps_place_filter_get_category() * @see maps_place_filter_create() */ -int maps_place_filter_set_category(maps_place_filter_h filter, - const maps_place_category_h category); +int maps_place_filter_set_category(maps_place_filter_h filter, const maps_place_category_h category); + /** - * @brief Sets the place address. + * @brief Sets the place address. * @details This function sets the place address. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] filter The handle of the place filter - * @param[in] place_address The place address - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] filter The handle of the place filter + * @param[in] place_address The place address + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a filter is created using maps_place_filter_create(). - * * @see maps_place_filter_get_place_address() * @see maps_place_filter_create() */ -int maps_place_filter_set_place_address(maps_place_filter_h filter, - const char *place_address); +int maps_place_filter_set_place_address(maps_place_filter_h filter, const char *place_address); + #ifdef __cplusplus } @@ -391,4 +355,4 @@ int maps_place_filter_set_place_address(maps_place_filter_h filter, /** * @} */ -#endif /* __MAPS_PLACE_FILTER_H__ */ +#endif /* __MAPS_PLACE_FILTER_H__ */ diff --git a/include/maps_place_image.h b/include/maps_place_image.h index e497c72..aac1c51 100644 --- a/include/maps_place_image.h +++ b/include/maps_place_image.h @@ -14,174 +14,177 @@ * limitations under the License. */ + #ifndef __MAPS_PLACE_IMAGE_H__ #define __MAPS_PLACE_IMAGE_H__ + #include #include + /** - * @ingroup CAPI_MAPS_PLACE_MODULE - * @defgroup CAPI_MAPS_PLACE_IMAGE_MODULE Image - * + * @ingroup CAPI_MAPS_PLACE_MODULE + * @defgroup CAPI_MAPS_PLACE_IMAGE_MODULE Image * @file maps_place_image.h - * @brief This function sets the place category id. - * + * @brief This function sets the place category ID. * @addtogroup CAPI_MAPS_PLACE_IMAGE_MODULE * @{ - * @brief This provides APIs related to Place Image information, used in Place - * Discovery and Search. + * @brief This provides APIs related to Place Image information, used in Place Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The Place Image handle + * @brief The Place Image handle. * @details The handle of Place Image instance. - * @remarks To release the handle use maps_place_image_destroy(). - * \n To clone the handle use maps_place_image_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_place_image_destroy().\n + * To clone the handle use maps_place_image_clone(). * @see maps_place_image_destroy() * @see maps_place_image_clone() */ typedef void *maps_place_image_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the place image handle and releases all its resources. - * @details This function destroys the place image handle and releases all its - * resources. + * @brief Destroys the place image handle and releases all its resources. + * @details This function destroys the place image handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] image The place image handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] image The place image handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_image_clone() */ int maps_place_image_destroy(maps_place_image_h image); + /** - * @brief Clones the place image handle. - * @details This function clones the place image handle @a origin and all its - * resources. + * @brief Clones the place image handle. + * @details This function clones the place image handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_place_image_destroy(). - * - * @param[in] origin The original place image handle - * @param[out] cloned A cloned place image handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original place image handle + * @param[out] cloned A cloned place image handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_image_destroy() */ -int maps_place_image_clone(const maps_place_image_h origin, - maps_place_image_h *cloned); +int maps_place_image_clone(const maps_place_image_h origin, maps_place_image_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the place image id. - * @details This function gets the place image id. + * @brief Gets the place image ID. + * @details This function gets the place image ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a id must be released using free(). - * - * @param[in] image The handle of place image - * @param[out] id The place image id - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] image The handle of place image + * @param[out] id The place image ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_place_image_get_id(const maps_place_image_h image, char **id); + /** - * @brief Gets the place image URL. + * @brief Gets the place image URL. * @details This function gets the place image URL. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a url must be released using free(). - * - * @param[in] image The handle of place image - * @param[out] url The place image url - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] image The handle of place image + * @param[out] url The place image url + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_place_image_get_url(const maps_place_image_h image, char **url); + /** - * @brief Gets the place image width. + * @brief Gets the place image width. * @details This function gets the place image width. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] image The handle of place image - * @param[out] width The place image width - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] image The handle of place image + * @param[out] width The place image width + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_place_image_get_width(const maps_place_image_h image, int *width); + /** - * @brief Gets the place image height. + * @brief Gets the place image height. * @details This function gets the place image height. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] image The handle of place image - * @param[out] height The place image height - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] image The handle of place image + * @param[out] height The place image height + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_place_image_get_height(const maps_place_image_h image, int *height); + /** - * @brief Gets the place image user link. + * @brief Gets the place image user link. * @details This function gets the place image user link. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a user must be released using maps_place_link_object_destroy(). - * - * @param[in] image The handle of place image - * @param[out] user The place image user link - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] image The handle of place image + * @param[out] user The place image user link + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_place_link_object_h */ -int maps_place_image_get_user_link(const maps_place_image_h image, - maps_place_link_object_h *user); +int maps_place_image_get_user_link(const maps_place_image_h image, maps_place_link_object_h *user); + /** - * @brief Gets the place image media. + * @brief Gets the place image media. * @details This function gets the place image media. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a media must be released using maps_place_media_destroy(). - * - * @param[in] image The handle of place image - * @param[out] media The place image media - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] image The handle of place image + * @param[out] media The place image media + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_place_media_h */ -int maps_place_image_get_media(const maps_place_image_h image, - maps_place_media_h *media); +int maps_place_image_get_media(const maps_place_image_h image, maps_place_media_h *media); + #ifdef __cplusplus } @@ -189,4 +192,4 @@ int maps_place_image_get_media(const maps_place_image_h image, /** * @} */ -#endif /* __MAPS_PLACE_IMAGE_H__ */ +#endif /* __MAPS_PLACE_IMAGE_H__ */ diff --git a/include/maps_place_image_plugin.h b/include/maps_place_image_plugin.h index c263a2a..ae9c00d 100644 --- a/include/maps_place_image_plugin.h +++ b/include/maps_place_image_plugin.h @@ -20,8 +20,8 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_PLACE_IMAGE_MODULE Image + * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_PLACE_IMAGE_MODULE Image * * @file maps_place_image_plugin.h * @brief This file contains the functions related to Place Image @@ -45,12 +45,12 @@ extern "C" { * @remarks @a image must be released using maps_place_image_destroy(). * \n @a image may be cloned using maps_place_image_clone(). * - * @param[out] image A handle of a new place image on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] image A handle of a new place image on success + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_place_image_destroy() * @see maps_place_image_clone() @@ -58,16 +58,16 @@ extern "C" { int maps_place_image_create(maps_place_image_h *image); /** - * @brief Sets the place image id. - * @details This function sets the place image id. + * @brief Sets the place image ID. + * @details This function sets the place image ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] image The handle of place image - * @param[in] id The place image id - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] image The handle of place image + * @param[in] id The place image Id + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a image is created using maps_place_image_create(). * @@ -77,16 +77,16 @@ int maps_place_image_create(maps_place_image_h *image); int maps_place_image_set_id(maps_place_image_h image, const char *id); /** - * @brief Sets the place image URL. + * @brief Sets the place image URL. * @details This function sets the place image URL. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] image The handle of place image - * @param[in] url The place image url - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] image The handle of place image + * @param[in] url The place image url + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a image is created using maps_place_image_create(). * @@ -96,16 +96,16 @@ int maps_place_image_set_id(maps_place_image_h image, const char *id); int maps_place_image_set_url(maps_place_image_h image, const char *url); /** - * @brief Sets the place image width. + * @brief Sets the place image width. * @details This function sets the place image width. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] image The handle of place image - * @param[in] width The place image width - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] image The handle of place image + * @param[in] width The place image width + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a image is created using maps_place_image_create(). * @@ -115,16 +115,16 @@ int maps_place_image_set_url(maps_place_image_h image, const char *url); int maps_place_image_set_width(maps_place_image_h image, const int width); /** - * @brief Sets the place image height. + * @brief Sets the place image height. * @details This function sets the place image height. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] image The handle of place image - * @param[in] height The place image height - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] image The handle of place image + * @param[in] height The place image height + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a image is created using maps_place_image_create(). * @@ -134,16 +134,16 @@ int maps_place_image_set_width(maps_place_image_h image, const int width); int maps_place_image_set_height(maps_place_image_h image, const int height); /** - * @brief Sets the place image user link. + * @brief Sets the place image user link. * @details This function sets the place image user link. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] image The handle of place image - * @param[in] user The place image user link - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] image The handle of place image + * @param[in] user The place image user link + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a image is created using maps_place_image_create(). * @@ -151,20 +151,19 @@ int maps_place_image_set_height(maps_place_image_h image, const int height); * @see maps_place_image_get_user_link() * @see #maps_place_link_object_h */ -int maps_place_image_set_user_link(maps_place_image_h image, - const maps_place_link_object_h user); +int maps_place_image_set_user_link(maps_place_image_h image, const maps_place_link_object_h user); /** - * @brief Sets the place image media. + * @brief Sets the place image media. * @details This function sets the place image media. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] image The handle of place image - * @param[in] media The place image media - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] image The handle of place image + * @param[in] media The place image media + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a image is created using maps_place_image_create(). * @@ -172,8 +171,7 @@ int maps_place_image_set_user_link(maps_place_image_h image, * @see maps_place_image_get_media() * @see #maps_place_media_h */ -int maps_place_image_set_media(maps_place_image_h image, - const maps_place_media_h media); +int maps_place_image_set_media(maps_place_image_h image, const maps_place_media_h media); #ifdef __cplusplus } @@ -181,4 +179,4 @@ int maps_place_image_set_media(maps_place_image_h image, /** * @} */ -#endif /* __MAPS_PLACE_IMAGE_PLUGIN_H__ */ +#endif /* __MAPS_PLACE_IMAGE_PLUGIN_H__ */ diff --git a/include/maps_place_link_object.h b/include/maps_place_link_object.h index 9d0411d..a9aeae4 100644 --- a/include/maps_place_link_object.h +++ b/include/maps_place_link_object.h @@ -14,21 +14,19 @@ * limitations under the License. */ + #ifndef __MAPS_PLACE_LINK_OBJECT_H__ #define __MAPS_PLACE_LINK_OBJECT_H__ + /** - * @ingroup CAPI_MAPS_PLACE_MODULE - * @defgroup CAPI_MAPS_PLACE_LINK_MODULE Link - * + * @ingroup CAPI_MAPS_PLACE_MODULE + * @defgroup CAPI_MAPS_PLACE_LINK_MODULE Link * @file maps_place_link_object.h - * @brief This file contains the functions related to Place Link Object - * information. - * + * @brief This file contains the functions related to Place Link Object information. * @addtogroup CAPI_MAPS_PLACE_LINK_MODULE * @{ - * @brief This provides APIs related to Place Link Object information, used in - * Place Discovery and Search. + * @brief This provides APIs related to Place Link Object information, used in Place Discovery and Search. */ #ifdef __cplusplus @@ -37,121 +35,119 @@ extern "C" { /** - * @brief The Place Link Object handle + * @brief The Place Link Object handle. * @details The handle of Place Link Object instance. - * @remarks To release the handle use maps_place_link_object_destroy(). - * \n To clone the handle use maps_place_link_object_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_place_link_object_destroy().\n + * To clone the handle use maps_place_link_object_clone(). * @see maps_place_link_object_destroy() * @see maps_place_link_object_clone() */ typedef void *maps_place_link_object_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the place link object handle and releases all its - * resources. - * @details This function destroys the place link object handle and releases all - * its resources. + * @brief Destroys the place link object handle and releases all its resources. + * @details This function destroys the place link object handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] link The place link object handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] link The place link object handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_link_object_clone() */ int maps_place_link_object_destroy(maps_place_link_object_h link); + /** - * @brief Clones the place link object handle. - * @details This function clones the place link object handle @a origin and all - * its resources. + * @brief Clones the place link object handle. + * @details This function clones the place link object handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_place_link_object_destroy(). - * - * @param[in] origin The original place link object handle - * @param[out] cloned A cloned place link object handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original place link object handle + * @param[out] cloned A cloned place link object handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_link_object_destroy() */ -int maps_place_link_object_clone(const maps_place_link_object_h origin, - maps_place_link_object_h *cloned); +int maps_place_link_object_clone(const maps_place_link_object_h origin, maps_place_link_object_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the place link object id. - * @details This function gets the place link object id. + * @brief Gets the place link object ID. + * @details This function gets the place link object ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a id must be released using free(). - * - * @param[in] link The handle of place link object - * @param[out] id The place link object id - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] link The handle of place link object + * @param[out] id The place link object ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_link_object_get_id(const maps_place_link_object_h link, - char **id); +int maps_place_link_object_get_id(const maps_place_link_object_h link, char **id); + /** - * @brief Gets the place link object name. + * @brief Gets the place link object name. * @details This function gets the place link object name. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a name must be released using free(). - * - * @param[in] link The handle of place link object - * @param[out] name The place link object name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] link The handle of place link object + * @param[out] name The place link object name + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_link_object_get_name(const maps_place_link_object_h link, - char **name); +int maps_place_link_object_get_name(const maps_place_link_object_h link, char **name); + /** - * @brief Gets the place link object string. + * @brief Gets the place link object string. * @details This function gets the place link object string. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a string must be released using free(). - * - * @param[in] link The handle of place link object - * @param[out] string The place link object string - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] link The handle of place link object + * @param[out] string The place link object string + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_link_object_get_string(const maps_place_link_object_h link, - char **string); +int maps_place_link_object_get_string(const maps_place_link_object_h link, char **string); + /** - * @brief Gets the place link object type. + * @brief Gets the place link object type. * @details This function gets the place link object type. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a type must be released using free(). - * - * @param[in] link The handle of place link object - * @param[out] type The place link object type - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] link The handle of place link object + * @param[out] type The place link object type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_link_object_get_type(const maps_place_link_object_h link, - char **type); +int maps_place_link_object_get_type(const maps_place_link_object_h link, char **type); + #ifdef __cplusplus } @@ -159,4 +155,4 @@ int maps_place_link_object_get_type(const maps_place_link_object_h link, /** * @} */ -#endif /* __MAPS_PLACE_LINK_OBJECT_H__ */ +#endif /* __MAPS_PLACE_LINK_OBJECT_H__ */ diff --git a/include/maps_place_link_object_plugin.h b/include/maps_place_link_object_plugin.h index b504ba1..ba643fa 100644 --- a/include/maps_place_link_object_plugin.h +++ b/include/maps_place_link_object_plugin.h @@ -20,8 +20,8 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_PLACE_LINK_MODULE Link + * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_PLACE_LINK_MODULE Link * * @file maps_place_link_object_plugin.h * @brief This file contains the functions related to Place Link Object @@ -45,12 +45,12 @@ extern "C" { * @remarks @a link must be released using maps_place_link_object_destroy(). * \n @a link may be cloned using maps_place_link_object_clone(). * - * @param[out] link A handle of a new place link object on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] link A handle of a new place link object on success + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_place_link_object_destroy() * @see maps_place_link_object_clone() @@ -58,84 +58,80 @@ extern "C" { int maps_place_link_object_create(maps_place_link_object_h *link); /** - * @brief Sets the place link object id. - * @details This function sets the place link object id. + * @brief Sets the place link object ID. + * @details This function sets the place link object ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] link The handle of place link object - * @param[in] id The place link object id - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] link The handle of place link object + * @param[in] id The place link object ID + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a link is created using maps_place_link_object_create(). * * @see maps_place_link_object_create() * @see maps_place_link_object_get_id() */ -int maps_place_link_object_set_id(maps_place_link_object_h link, - const char *id); +int maps_place_link_object_set_id(maps_place_link_object_h link, const char *id); /** - * @brief Sets the place link object string. + * @brief Sets the place link object string. * @details This function sets the place link object string. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] link The handle of place link object - * @param[in] string The place link object string - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] link The handle of place link object + * @param[in] string The place link object string + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a link is created using maps_place_link_object_create(). * * @see maps_place_link_object_create() * @see maps_place_link_object_get_string() */ -int maps_place_link_object_set_string(maps_place_link_object_h link, - const char *string); +int maps_place_link_object_set_string(maps_place_link_object_h link, const char *string); /** - * @brief Sets the place link object type. + * @brief Sets the place link object type. * @details This function sets the place link object type. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] link The handle of place link object - * @param[in] type The place link object type - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] link The handle of place link object + * @param[in] type The place link object type + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a link is created using maps_place_link_object_create(). * * @see maps_place_link_object_create() * @see maps_place_link_object_get_type() */ -int maps_place_link_object_set_type(maps_place_link_object_h link, - const char *type); +int maps_place_link_object_set_type(maps_place_link_object_h link, const char *type); /** - * @brief Sets the place link object name. + * @brief Sets the place link object name. * @details This function sets the place link object name. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] link The handle of place link object - * @param[in] name The place link object name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] link The handle of place link object + * @param[in] name The place link object name + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a link is created using maps_place_link_object_create(). * * @see maps_place_link_object_create() * @see maps_place_link_object_get_name() */ -int maps_place_link_object_set_name(maps_place_link_object_h link, - const char *name); +int maps_place_link_object_set_name(maps_place_link_object_h link, const char *name); #ifdef __cplusplus } @@ -143,4 +139,4 @@ int maps_place_link_object_set_name(maps_place_link_object_h link, /** * @} */ -#endif /* __MAPS_PLACE_LINK_OBJECT_PLUGIN_H__ */ +#endif /* __MAPS_PLACE_LINK_OBJECT_PLUGIN_H__ */ diff --git a/include/maps_place_media.h b/include/maps_place_media.h index f9c03a4..8347782 100644 --- a/include/maps_place_media.h +++ b/include/maps_place_media.h @@ -14,131 +14,130 @@ * limitations under the License. */ + #ifndef __MAPS_PLACE_MEDIA_H__ #define __MAPS_PLACE_MEDIA_H__ + #include + /** - * @ingroup CAPI_MAPS_PLACE_MODULE - * @defgroup CAPI_MAPS_PLACE_MEDIA_MODULE Media - * + * @ingroup CAPI_MAPS_PLACE_MODULE + * @defgroup CAPI_MAPS_PLACE_MEDIA_MODULE Media * @file maps_place_media.h * @brief This file contains the functions related to Place Media information. - * * @addtogroup CAPI_MAPS_PLACE_MEDIA_MODULE * @{ - * @brief This provides APIs related to Place Media information, used in Place - * Discovery and Search. + * @brief This provides APIs related to Place Media information, used in Place Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The Place Media handle + * @brief The Place Media handle. * @details The handle of Place Media instance. - * @remarks To release the handle use maps_place_media_destroy(). - * \n To clone the handle use maps_place_media_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_place_media_destroy().\n + * To clone the handle use maps_place_media_clone(). * @see maps_place_media_destroy() * @see maps_place_media_clone() */ typedef void *maps_place_media_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the place media handle and releases all its resources. - * @details This function destroys the place media handle and releases all its - * resources. + * @brief Destroys the place media handle and releases all its resources. + * @details This function destroys the place media handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] media The place media handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] media The place media handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_media_clone() */ int maps_place_media_destroy(maps_place_media_h media); + /** - * @brief Clones the place media handle. - * @details This function clones the place media handle @a origin and all its - * resources. + * @brief Clones the place media handle. + * @details This function clones the place media handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_place_media_destroy(). - * - * @param[in] origin The original place media handle - * @param[out] cloned A cloned place media handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original place media handle + * @param[out] cloned A cloned place media handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_media_destroy() */ -int maps_place_media_clone(const maps_place_media_h origin, - maps_place_media_h *cloned); +int maps_place_media_clone(const maps_place_media_h origin, maps_place_media_h *cloned); + /*---------------------------------------------------------------------------*/ + /** - * @brief Gets the place media attribution. + * @brief Gets the place media attribution. * @details This function gets the place media attribution. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a attribution must be released using free(). - * - * @param[in] media The handle of place media - * @param[out] attribution The place media attribution - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] media The handle of place media + * @param[out] attribution The place media attribution + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_media_get_attribution(const maps_place_media_h media, - char **attribution); +int maps_place_media_get_attribution(const maps_place_media_h media, char **attribution); + /** - * @brief Gets the place media supplier link. + * @brief Gets the place media supplier link. * @details This function gets the place media supplier link. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a supplier must be released using maps_place_link_object_destroy(). - * - * @param[in] media The handle of place media - * @param[out] supplier The place media supplier link - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] media The handle of place media + * @param[out] supplier The place media supplier link + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_place_link_object_h */ -int maps_place_media_get_supplier(const maps_place_media_h media, - maps_place_link_object_h *supplier); +int maps_place_media_get_supplier(const maps_place_media_h media, maps_place_link_object_h *supplier); + /** - * @brief Gets the place media "via" link. + * @brief Gets the place media "via" link. * @details This function gets the place media "via" link. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a via must be released using maps_place_link_object_destroy(). - * - * @param[in] media The handle of place media - * @param[out] via The place media via link - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] media The handle of place media + * @param[out] via The place media via link + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_place_link_object_h */ -int maps_place_media_get_via(const maps_place_media_h media, - maps_place_link_object_h *via); +int maps_place_media_get_via(const maps_place_media_h media, maps_place_link_object_h *via); + #ifdef __cplusplus } @@ -146,4 +145,4 @@ int maps_place_media_get_via(const maps_place_media_h media, /** * @} */ -#endif /* __MAPS_PLACE_MEDIA_H__ */ +#endif /* __MAPS_PLACE_MEDIA_H__ */ diff --git a/include/maps_place_media_plugin.h b/include/maps_place_media_plugin.h index 131eec2..2fe61ff 100644 --- a/include/maps_place_media_plugin.h +++ b/include/maps_place_media_plugin.h @@ -20,8 +20,8 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_PLACE_MEDIA_MODULE Media + * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_PLACE_MEDIA_MODULE Media * * @file maps_place_media_plugin.h * @brief This file contains the functions related to Place Media @@ -45,12 +45,12 @@ extern "C" { * @remarks @a media must be released using maps_place_media_destroy(). * \n @a media may be cloned using maps_place_media_clone(). * - * @param[out] media A handle of a new place media on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] media A handle of a new place media on success + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_place_media_destroy() * @see maps_place_media_clone() @@ -58,64 +58,61 @@ extern "C" { int maps_place_media_create(maps_place_media_h *media); /** - * @brief Sets the place media attribution. + * @brief Sets the place media attribution. * @details This function sets the place media attribution. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] media The handle of place media - * @param[in] attribution The place media attribution - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] media The handle of place media + * @param[in] attribution The place media attribution + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a media is created using maps_place_media_create(). * * @see maps_place_media_create() * @see maps_place_media_get_attribution() */ -int maps_place_media_set_attribution(maps_place_media_h media, - const char *attribution); +int maps_place_media_set_attribution(maps_place_media_h media, const char *attribution); /** - * @brief Sets the place media supplier link. + * @brief Sets the place media supplier link. * @details This function sets the place media supplier link. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] media The handle of place media - * @param[in] supplier The place media supplier link - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] media The handle of place media + * @param[in] supplier The place media supplier link + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a media is created using maps_place_media_create(). * * @see maps_place_media_create() * @see maps_place_media_get_supplier() */ -int maps_place_media_set_supplier(maps_place_media_h media, - const maps_place_link_object_h supplier); +int maps_place_media_set_supplier(maps_place_media_h media, const maps_place_link_object_h supplier); /** - * @brief Sets the place media via link. + * @brief Sets the place media via link. * @details This function sets the place media via link. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] media The handle of place media - * @param[in] via The place media via link - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] media The handle of place media + * @param[in] via The place media via link + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a media is created using maps_place_media_create(). * * @see maps_place_media_create() * @see maps_place_media_get_via() */ -int maps_place_media_set_via(maps_place_media_h media, - const maps_place_link_object_h via); +int maps_place_media_set_via(maps_place_media_h media, const maps_place_link_object_h via); #ifdef __cplusplus } @@ -123,4 +120,4 @@ int maps_place_media_set_via(maps_place_media_h media, /** * @} */ -#endif /* __MAPS_PLACE_MEDIA_PLUGIN_H__ */ +#endif /* __MAPS_PLACE_MEDIA_PLUGIN_H__ */ diff --git a/include/maps_place_plugin.h b/include/maps_place_plugin.h index fc17462..36663ed 100644 --- a/include/maps_place_plugin.h +++ b/include/maps_place_plugin.h @@ -21,13 +21,13 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_MODULE - * @defgroup CAPI_MAPS_PLUGIN_PLACE_MODULE Places + * @ingroup CAPI_MAPS_PLUGIN_MODULE + * @defgroup CAPI_MAPS_PLUGIN_PLACE_MODULE Places */ /** - * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_PLACE_DATA_MODULE Place + * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_PLACE_DATA_MODULE Place * * @file maps_place_plugin.h * @brief This file contains the functions related to Place @@ -44,19 +44,19 @@ extern "C" { #endif /** - * @brief Creates a new place handle. + * @brief Creates a new place handle. * @details This function creates a new place handle and allocates all needed * resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a place must be released using maps_place_destroy(). * \n @a place may be cloned using maps_place_clone(). * - * @param[in] place A handle of a new place on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place A handle of a new place on success + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_place_destroy() * @see maps_place_clone() @@ -64,16 +64,16 @@ extern "C" { int maps_place_create(maps_place_h *place); /** - * @brief Sets the place id. - * @details This function sets the place id. + * @brief Sets the place ID. + * @details This function sets the place ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] id The place id - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] id The place ID + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * @@ -83,16 +83,16 @@ int maps_place_create(maps_place_h *place); int maps_place_set_id(maps_place_h place, const char *id); /** - * @brief Sets the place name. + * @brief Sets the place name. * @details This function sets the place name. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] name The place name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] name The place name + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * @@ -102,37 +102,36 @@ int maps_place_set_id(maps_place_h place, const char *id); int maps_place_set_name(maps_place_h place, const char *name); /** - * @brief Sets the place location. + * @brief Sets the place location. * @details This function sets the place location. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] location The place location - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] location The place location + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * * @see maps_place_create() * @see maps_place_get_location() */ -int maps_place_set_location(maps_place_h place, - const maps_coordinates_h location); +int maps_place_set_location(maps_place_h place, const maps_coordinates_h location); /** - * @brief Sets the place distance from the center of the location. + * @brief Sets the place distance from the center of the location. * @details This function sets the place distance from the center of the * location. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] distance The place distance in meters - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] distance The place distance in meters + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * @@ -142,16 +141,16 @@ int maps_place_set_location(maps_place_h place, int maps_place_set_distance(maps_place_h place, const int distance); /** - * @brief Sets the place address. + * @brief Sets the place address. * @details This function sets the place address. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] address The place address - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] address The place address + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * @@ -161,36 +160,35 @@ int maps_place_set_distance(maps_place_h place, const int distance); int maps_place_set_address(maps_place_h place, const maps_address_h address); /** - * @brief Sets the place categories. + * @brief Sets the place categories. * @details This function sets the place categories. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] categories The place category list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] categories The place category list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * * @see maps_place_create() * @see maps_place_foreach_category() */ -int maps_place_set_categories(maps_place_h place, - const maps_item_list_h categories); +int maps_place_set_categories(maps_place_h place, const maps_item_list_h categories); /** - * @brief Sets the place view URI. + * @brief Sets the place view URI. * @details This function sets the place URI. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] uri The place view uri - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] uri The place view uri + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * @@ -200,76 +198,73 @@ int maps_place_set_categories(maps_place_h place, int maps_place_set_uri(maps_place_h place, const char *uri); /** - * @brief Sets the place attributes. + * @brief Sets the place attributes. * @details This function sets the place attributes. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] attributes The place attribute list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] attributes The place attribute list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * * @see maps_place_create() * @see maps_place_foreach_attribute() */ -int maps_place_set_attributes(maps_place_h place, - const maps_item_list_h attributes); +int maps_place_set_attributes(maps_place_h place, const maps_item_list_h attributes); /** - * @brief Sets the place contacts. + * @brief Sets the place contacts. * @details This function sets the place contacts. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] contacts The place contact list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] contacts The place contact list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * * @see maps_place_create() * @see maps_place_foreach_contact() */ -int maps_place_set_contacts(maps_place_h place, - const maps_item_list_h contacts); +int maps_place_set_contacts(maps_place_h place, const maps_item_list_h contacts); /** - * @brief Sets the place editorials. + * @brief Sets the place editorials. * @details This function sets the place editorials. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] editorials The place editorial list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] editorials The place editorial list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * * @see maps_place_create() * @see maps_place_foreach_editorial() */ -int maps_place_set_editorials(maps_place_h place, - const maps_item_list_h editorials); +int maps_place_set_editorials(maps_place_h place, const maps_item_list_h editorials); /** - * @brief Sets the place images. + * @brief Sets the place images. * @details This function sets the place images. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] images The place image list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] images The place image list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * @@ -279,115 +274,110 @@ int maps_place_set_editorials(maps_place_h place, int maps_place_set_images(maps_place_h place, const maps_item_list_h images); /** - * @brief Sets the place review. + * @brief Sets the place review. * @details This function sets the place reviews. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] reviews The place review list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] reviews The place review list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * * @see maps_place_create() * @see maps_place_foreach_review() */ -int maps_place_set_reviews(maps_place_h place, - const maps_item_list_h reviews); +int maps_place_set_reviews(maps_place_h place, const maps_item_list_h reviews); /** - * @brief Sets the place properties. + * @brief Sets the place properties. * @details This function sets the place properties. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place - * @param[in] properties The place properties list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place + * @param[in] properties The place properties list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * * @see maps_place_create() * @see maps_place_foreach_property() */ -int maps_place_set_properties(maps_place_h place, - const maps_item_hashtable_h properties); +int maps_place_set_properties(maps_place_h place, const maps_item_hashtable_h properties); /** - * @brief Sets the place rating. + * @brief Sets the place rating. * @details This function sets the place rating. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place image - * @param[in] rating The place rating - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place image + * @param[in] rating The place rating + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * * @see maps_place_create() * @see maps_place_get_rating() */ -int maps_place_set_rating(maps_place_h place, - const maps_place_rating_h rating); +int maps_place_set_rating(maps_place_h place, const maps_place_rating_h rating); /** - * @brief Sets the place supplier link. + * @brief Sets the place supplier link. * @details This function sets the place supplier link. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place image - * @param[in] supplier The place supplier link - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place image + * @param[in] supplier The place supplier link + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * * @see maps_place_create() * @see maps_place_get_supplier_link() */ -int maps_place_set_supplier_link(maps_place_h place, - const maps_place_link_object_h supplier); +int maps_place_set_supplier_link(maps_place_h place, const maps_place_link_object_h supplier); /** - * @brief Sets the place related link. + * @brief Sets the place related link. * @details This function sets the place related link. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] place The handle to place image - * @param[in] related The place related link - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] place The handle to place image + * @param[in] related The place related link + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a place is created using maps_place_create(). * * @see maps_place_create() * @see maps_place_get_related_link() */ -int maps_place_set_related_link(maps_place_h place, - const maps_place_link_object_h related); +int maps_place_set_related_link(maps_place_h place, const maps_place_link_object_h related); /** - * @brief Creates a place list having a set of places. + * @brief Creates a place list having a set of places. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[out] place_list The place list handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] place_list The place list handle + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_place_list_destroy() */ @@ -399,4 +389,4 @@ int maps_place_list_create(maps_place_list_h *place_list); /** * @} */ -#endif /* __MAPS_PLACE_PLUGIN_H__ */ +#endif /* __MAPS_PLACE_PLUGIN_H__ */ diff --git a/include/maps_place_rating.h b/include/maps_place_rating.h index 897dce4..8f37f15 100644 --- a/include/maps_place_rating.h +++ b/include/maps_place_rating.h @@ -14,108 +14,110 @@ * limitations under the License. */ + #ifndef __MAPS_PLACE_RATING_H__ #define __MAPS_PLACE_RATING_H__ + #include + /** - * @ingroup CAPI_MAPS_PLACE_MODULE - * @defgroup CAPI_MAPS_PLACE_RATING_MODULE Rating - * + * @ingroup CAPI_MAPS_PLACE_MODULE + * @defgroup CAPI_MAPS_PLACE_RATING_MODULE Rating * @file maps_place_rating.h * @brief This file contains the functions related to Place Rating information. - * * @addtogroup CAPI_MAPS_PLACE_RATING_MODULE * @{ - * @brief This provides APIs related to Place Rating information, used in Place - * Discovery and Search. + * @brief This provides APIs related to Place Rating information, used in Place Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The Place Rating handle + * @brief The Place Rating handle. * @details The handle of Place Rating instance. - * @remarks To release the handle use maps_place_rating_destroy(). - * \n To clone the handle use maps_place_rating_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_place_rating_destroy(). + * \n To clone the handle use maps_place_rating_clone(). * @see maps_place_rating_destroy() * @see maps_place_rating_clone() */ typedef void *maps_place_rating_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the place rating handle and releases all its resources. - * @details This function destroys the place rating handle and releases all its - * resources. + * @brief Destroys the place rating handle and releases all its resources. + * @details This function destroys the place rating handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] rating The place rating handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] rating The place rating handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_rating_clone() */ int maps_place_rating_destroy(maps_place_rating_h rating); + /** - * @brief Clones the place rating handle. - * @details This function clones the place rating handle @a origin and all its - * resources. + * @brief Clones the place rating handle. + * @details This function clones the place rating handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_place_rating_destroy(). - * - * @param[in] origin The original place rating handle - * @param[out] cloned A cloned place rating handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original place rating handle + * @param[out] cloned A cloned place rating handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_rating_destroy() */ -int maps_place_rating_clone(const maps_place_rating_h origin, - maps_place_rating_h *cloned); +int maps_place_rating_clone(const maps_place_rating_h origin, maps_place_rating_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the place rating count. + * @brief Gets the place rating count. * @details This function gets the place rating count. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] rating The handle to place rating handle - * @param[out] count The place rating count - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] rating The handle to place rating handle + * @param[out] count The place rating count + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_place_rating_get_count(const maps_place_rating_h rating, int *count); + /** - * @brief Gets the place rating average. + * @brief Gets the place rating average. * @details This function gets the place rating average. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] rating The handle to place rating handle - * @param[out] average The place average rating - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] rating The handle to place rating handle + * @param[out] average The place average rating + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_rating_get_average(const maps_place_rating_h rating, - double *average); +int maps_place_rating_get_average(const maps_place_rating_h rating, double *average); + #ifdef __cplusplus } @@ -123,4 +125,4 @@ int maps_place_rating_get_average(const maps_place_rating_h rating, /** * @} */ -#endif /* __MAPS_PLACE_RATING_H__ */ +#endif /* __MAPS_PLACE_RATING_H__ */ diff --git a/include/maps_place_rating_plugin.h b/include/maps_place_rating_plugin.h index c4cdf9f..df18515 100644 --- a/include/maps_place_rating_plugin.h +++ b/include/maps_place_rating_plugin.h @@ -20,8 +20,8 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_PLACE_RATING_MODULE Rating + * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_PLACE_RATING_MODULE Rating * * @file maps_place_rating_plugin.h * @brief This file contains the functions related to Place Rating @@ -45,12 +45,12 @@ extern "C" { * @remarks @a rating must be released using maps_place_rating_destroy(). * \n @a rating may be cloned using maps_place_rating_clone(). * - * @param[out] rating A handle of a new place rating on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] rating A handle of a new place rating on success + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_place_rating_destroy() * @see maps_place_rating_clone() @@ -58,16 +58,16 @@ extern "C" { int maps_place_rating_create(maps_place_rating_h *rating); /** - * @brief Sets the place rating count. + * @brief Sets the place rating count. * @details This function sets the place rating count. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] rating The handle of place rating - * @param[in] count The place rating count - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] rating The handle of place rating + * @param[in] count The place rating count + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a rating is created using maps_place_rating_create(). * @@ -77,24 +77,23 @@ int maps_place_rating_create(maps_place_rating_h *rating); int maps_place_rating_set_count(maps_place_rating_h rating, const int count); /** - * @brief Sets the place rating average. + * @brief Sets the place rating average. * @details This function sets the place rating average. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] rating The handle of place rating - * @param[in] average The place rating average - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] rating The handle of place rating + * @param[in] average The place rating average + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a rating is created using maps_place_rating_create(). * * @see maps_place_rating_create() * @see maps_place_rating_get_average() */ -int maps_place_rating_set_average(maps_place_rating_h rating, - const double average); +int maps_place_rating_set_average(maps_place_rating_h rating, const double average); #ifdef __cplusplus } @@ -102,4 +101,4 @@ int maps_place_rating_set_average(maps_place_rating_h rating, /** * @} */ -#endif /* __MAPS_PLACE_RATING_PLUGIN_H__ */ +#endif /* __MAPS_PLACE_RATING_PLUGIN_H__ */ diff --git a/include/maps_place_review.h b/include/maps_place_review.h index f809187..fdda91b 100644 --- a/include/maps_place_review.h +++ b/include/maps_place_review.h @@ -14,194 +14,194 @@ * limitations under the License. */ + #ifndef __MAPS_PLACE_REVIEW_H__ #define __MAPS_PLACE_REVIEW_H__ + #include #include + /** - * @ingroup CAPI_MAPS_PLACE_MODULE - * @defgroup CAPI_MAPS_PLACE_REVIEW_MODULE Review - * + * @ingroup CAPI_MAPS_PLACE_MODULE + * @defgroup CAPI_MAPS_PLACE_REVIEW_MODULE Review * @file maps_place_review.h * @brief This file contains the functions related to Place Review information. - * * @addtogroup CAPI_MAPS_PLACE_REVIEW_MODULE * @{ - * @brief This provides APIs related to Place Review information, used in Place - * Discovery and Search. + * @brief This provides APIs related to Place Review information, used in Place Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The Place Review handle + * @brief The Place Review handle. * @details The handle of Place Review instance. - * @remarks To release the handle use maps_place_review_destroy(). - * \n To clone the handle use maps_place_review_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_place_review_destroy().\n + * To clone the handle use maps_place_review_clone(). * @see maps_place_review_destroy() * @see maps_place_review_clone() */ typedef void *maps_place_review_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the place review handle and releases all its resources. - * @details This function destroys the place review handle and releases all its - * resources. + * @brief Destroys the place review handle and releases all its resources. + * @details This function destroys the place review handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] review The place review handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] review The place review handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_review_clone() */ int maps_place_review_destroy(maps_place_review_h review); + /** - * @brief Clones the place review handle. - * @details This function clones the place review handle @a origin and all its - * resources. + * @brief Clones the place review handle. + * @details This function clones the place review handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_place_review_destroy(). - * - * @param[in] origin The original place review handle - * @param[out] cloned A cloned place review handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original place review handle + * @param[out] cloned A cloned place review handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_review_destroy() */ -int maps_place_review_clone(const maps_place_review_h origin, - maps_place_review_h *cloned); +int maps_place_review_clone(const maps_place_review_h origin, maps_place_review_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the place review date. + * @brief Gets the place review date. * @details This function gets the place review date. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a date must be released using free(). - * - * @param[in] review The handle to place review - * @param[out] date The place review date - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] review The handle to place review + * @param[out] date The place review date + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_place_review_get_date(const maps_place_review_h review, char **date); + /** - * @brief Gets the place review title. + * @brief Gets the place review title. * @details This function gets the place review title. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a title must be released using free(). - * - * @param[in] review The handle to place review - * @param[out] title The place review title - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] review The handle to place review + * @param[out] title The place review title + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_review_get_title(const maps_place_review_h review, - char **title); +int maps_place_review_get_title(const maps_place_review_h review, char **title); + /** - * @brief Gets the place review rating. + * @brief Gets the place review rating. * @details This function gets the place review rating. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] review The handle to place review - * @param[out] rating The place review rating - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] review The handle to place review + * @param[out] rating The place review rating + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_review_get_rating(const maps_place_review_h review, - double *rating); +int maps_place_review_get_rating(const maps_place_review_h review, double *rating); + /** - * @brief Gets the place review description. + * @brief Gets the place review description. * @details This function gets the place review description. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a description must be released using free(). - * - * @param[in] review The handle to place review - * @param[out] description The place review description - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] review The handle to place review + * @param[out] description The place review description + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_review_get_description(const maps_place_review_h review, - char **description); +int maps_place_review_get_description(const maps_place_review_h review, char **description); + /** - * @brief Gets the place review language. + * @brief Gets the place review language. * @details This function gets the place review language. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a language must be released using free(). - * - * @param[in] review The handle to place review - * @param[out] language The place review language - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] review The handle to place review + * @param[out] language The place review language + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_place_review_get_language(const maps_place_review_h review, - char **language); +int maps_place_review_get_language(const maps_place_review_h review, char **language); + /** - * @brief Gets the place review media. + * @brief Gets the place review media. * @details This function gets the place review media. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a media must be released using maps_place_media_destroy(). - * - * @param[in] review The handle to place review - * @param[out] media The place review media - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] review The handle to place review + * @param[out] media The place review media + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_place_media_h */ -int maps_place_review_get_media(const maps_place_review_h review, - maps_place_media_h *media); +int maps_place_review_get_media(const maps_place_review_h review, maps_place_media_h *media); + /** - * @brief Gets the place review user link. + * @brief Gets the place review user link. * @details This function gets the place review user link. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a user must be released using maps_place_link_object_destroy(). - * - * @param[in] review The handle to place review - * @param[out] user The place review user link - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] review The handle to place review + * @param[out] user The place review user link + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_place_link_object_h */ -int maps_place_review_get_user_link(const maps_place_review_h review, - maps_place_link_object_h *user); +int maps_place_review_get_user_link(const maps_place_review_h review, maps_place_link_object_h *user); + #ifdef __cplusplus } @@ -209,4 +209,4 @@ int maps_place_review_get_user_link(const maps_place_review_h review, /** * @} */ -#endif /* __MAPS_PLACE_REVIEW_H__ */ +#endif /* __MAPS_PLACE_REVIEW_H__ */ diff --git a/include/maps_place_review_plugin.h b/include/maps_place_review_plugin.h index 79be72e..698695d 100644 --- a/include/maps_place_review_plugin.h +++ b/include/maps_place_review_plugin.h @@ -23,8 +23,8 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_PLACE_REVIEW_MODULE Review + * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_PLACE_REVIEW_MODULE Review * * @file maps_place_review_plugin.h * @brief This file contains the functions related to Place Review @@ -48,12 +48,12 @@ extern "C" { * @remarks @a review must be released using maps_place_review_destroy(). * \n @a review may be cloned using maps_place_review_clone(). * - * @param[out] review A handle of a new place review on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] review A handle of a new place review on success + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_place_review_destroy() * @see maps_place_review_clone() @@ -61,16 +61,16 @@ extern "C" { int maps_place_review_create(maps_place_review_h *review); /** - * @brief Sets the place review date. + * @brief Sets the place review date. * @details This function sets the place review date. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] review The handle to place review - * @param[in] date The place review date - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] review The handle to place review + * @param[in] date The place review date + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a review is created using maps_place_review_create(). * @@ -80,96 +80,92 @@ int maps_place_review_create(maps_place_review_h *review); int maps_place_review_set_date(maps_place_review_h review, const char *date); /** - * @brief Sets the place review title. + * @brief Sets the place review title. * @details This function sets the place review title. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] review The handle to place review - * @param[in] title The place review title - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] review The handle to place review + * @param[in] title The place review title + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a review is created using maps_place_review_create(). * * @see maps_place_review_create() * @see maps_place_review_get_title() */ -int maps_place_review_set_title(maps_place_review_h review, - const char *title); +int maps_place_review_set_title(maps_place_review_h review, const char *title); /** - * @brief Sets the place review rating. + * @brief Sets the place review rating. * @details This function sets the place review rating. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] review The handle to place review - * @param[in] rating The place review rating - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] review The handle to place review + * @param[in] rating The place review rating + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a review is created using maps_place_review_create(). * * @see maps_place_review_create() * @see maps_place_review_get_rating() */ -int maps_place_review_set_rating(maps_place_review_h review, - const double rating); +int maps_place_review_set_rating(maps_place_review_h review, const double rating); /** - * @brief Sets the place review description. + * @brief Sets the place review description. * @details This function sets the place review description. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] review The handle to place review - * @param[in] description The place review description - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] review The handle to place review + * @param[in] description The place review description + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a review is created using maps_place_review_create(). * * @see maps_place_review_create() * @see maps_place_review_get_description() */ -int maps_place_review_set_description(maps_place_review_h review, - const char *description); +int maps_place_review_set_description(maps_place_review_h review, const char *description); /** - * @brief Sets the place review language. + * @brief Sets the place review language. * @details This function sets the place review language. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] review The handle to place review - * @param[in] language The place review language - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] review The handle to place review + * @param[in] language The place review language + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a review is created using maps_place_review_create(). * * @see maps_place_review_create() * @see maps_place_review_get_language() */ -int maps_place_review_set_language(maps_place_review_h review, - const char *language); +int maps_place_review_set_language(maps_place_review_h review, const char *language); /** - * @brief Sets the place review media. + * @brief Sets the place review media. * @details This function sets the place review media. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] review The handle to place review - * @param[in] media The place review media - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] review The handle to place review + * @param[in] media The place review media + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a review is created using maps_place_review_create(). * @@ -177,20 +173,19 @@ int maps_place_review_set_language(maps_place_review_h review, * @see maps_place_review_get_media() * @see #maps_place_media_h */ -int maps_place_review_set_media(maps_place_review_h review, - const maps_place_media_h media); +int maps_place_review_set_media(maps_place_review_h review, const maps_place_media_h media); /** - * @brief Sets the place review user link. + * @brief Sets the place review user link. * @details This function sets the place review user link. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] review The handle to place review - * @param[in] user The place review user link - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] review The handle to place review + * @param[in] user The place review user link + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a review is created using maps_place_review_create(). * @@ -198,8 +193,7 @@ int maps_place_review_set_media(maps_place_review_h review, * @see maps_place_review_get_user_link() * @see #maps_place_link_object_h */ -int maps_place_review_set_user_link(maps_place_review_h review, - const maps_place_link_object_h user); +int maps_place_review_set_user_link(maps_place_review_h review, const maps_place_link_object_h user); #ifdef __cplusplus } @@ -207,4 +201,4 @@ int maps_place_review_set_user_link(maps_place_review_h review, /** * @} */ -#endif /* __MAPS_PLACE_REVIEW_PLUGIN_H__ */ +#endif /* __MAPS_PLACE_REVIEW_PLUGIN_H__ */ diff --git a/include/maps_place_url.h b/include/maps_place_url.h index 05c429c..3a2d1d1 100644 --- a/include/maps_place_url.h +++ b/include/maps_place_url.h @@ -14,113 +14,114 @@ * limitations under the License. */ + #ifndef __MAPS_PLACE_URL_H__ #define __MAPS_PLACE_URL_H__ + /** - * @ingroup CAPI_MAPS_PLACE_MODULE - * @defgroup CAPI_MAPS_PLACE_URL_MODULE URL - * + * @ingroup CAPI_MAPS_PLACE_MODULE + * @defgroup CAPI_MAPS_PLACE_URL_MODULE URL * @file maps_place_url.h * @brief This file contains the functions related to Place URL information. - * * @addtogroup CAPI_MAPS_PLACE_URL_MODULE * @{ - * @brief This provides APIs related to Place URL information, used in Place - * Discovery and Search. + * @brief This provides APIs related to Place URL information, used in Place Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif /** - * @brief The Place URL handle + * @brief The Place URL handle. * @details The handle of Place URL instance. - * @remarks To release the handle use maps_place_url_destroy(). - * \n To clone the handle use maps_place_url_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_place_url_destroy().\n + * To clone the handle use maps_place_url_clone(). * @see maps_place_url_destroy() * @see maps_place_url_clone() */ typedef void *maps_place_url_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the place URL handle and releases all its resources. - * @details This function destroys the place URL handle and releases all its - * resources. + * @brief Destroys the place URL handle and releases all its resources. + * @details This function destroys the place URL handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] url The place URL handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] url The place URL handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_url_clone() */ int maps_place_url_destroy(maps_place_url_h url); + /** - * @brief Clones the place URL handle. - * @details This function clones the place URL handle @a origin and all its - * resources. + * @brief Clones the place URL handle. + * @details This function clones the place URL handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_place_url_destroy(). - * - * @param[in] origin The original place url handle - * @param[out] cloned A cloned place url handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original place url handle + * @param[out] cloned A cloned place url handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_place_url_destroy() */ -int maps_place_url_clone(const maps_place_url_h origin, - maps_place_url_h *cloned); +int maps_place_url_clone(const maps_place_url_h origin, maps_place_url_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the place URL path. + * @brief Gets the place URL path. * @details This function gets the place URL path. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a path must be released using free(). - * - * @param[in] url The handle to place url handle - * @param[out] path The place url path - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] url The handle to place url handle + * @param[out] path The place url path + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_place_url_get_path(const maps_place_url_h url, char **path); + /** - * @brief Gets the place URL description. + * @brief Gets the place URL description. * @details This function gets the place URL description. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a desc must be released using free(). - * - * @param[in] url The handle to place url handle - * @param[out] desc The place url description - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] url The handle to place url handle + * @param[out] desc The place url description + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_place_url_get_description(const maps_place_url_h url, char **desc); + #ifdef __cplusplus } #endif /** * @} */ -#endif /* __MAPS_PLACE_URL_H__ */ +#endif /* __MAPS_PLACE_URL_H__ */ diff --git a/include/maps_place_url_plugin.h b/include/maps_place_url_plugin.h index 6b43868..6d03a8c 100644 --- a/include/maps_place_url_plugin.h +++ b/include/maps_place_url_plugin.h @@ -20,8 +20,8 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_PLACE_URL_MODULE URL + * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_PLACE_URL_MODULE URL * * @file maps_place_url_plugin.h * @brief This file contains the functions related to Place URL @@ -45,12 +45,12 @@ extern "C" { * @remarks @a url must be released using maps_place_url_destroy(). * \n @a url may be cloned using maps_place_url_clone(). * - * @param[out] url A handle of a new place URL on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] url A handle of a new place URL on success + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_place_url_destroy() * @see maps_place_url_clone() @@ -58,16 +58,16 @@ extern "C" { int maps_place_url_create(maps_place_url_h *url); /** - * @brief Sets the place URL path. + * @brief Sets the place URL path. * @details This function sets the place URL path. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] url The handle of place URL - * @param[in] path The place URL path - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] url The handle of place URL + * @param[in] path The place URL path + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a url is created using maps_place_url_create(). * @@ -77,24 +77,23 @@ int maps_place_url_create(maps_place_url_h *url); int maps_place_url_set_path(maps_place_url_h url, const char *path); /** - * @brief Sets the place URL description. + * @brief Sets the place URL description. * @details This function sets the place URL description. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] url The handle of place URL - * @param[in] description The place URL description - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] url The handle of place URL + * @param[in] description The place URL description + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a url is created using maps_place_url_create(). * * @see maps_place_url_create() * @see maps_place_url_get_description() */ -int maps_place_url_set_description(maps_place_url_h url, - const char *description); +int maps_place_url_set_description(maps_place_url_h url, const char *description); #ifdef __cplusplus } @@ -102,4 +101,4 @@ int maps_place_url_set_description(maps_place_url_h url, /** * @} */ -#endif /* __MAPS_PLACE_URL_PLUGIN_H__ */ +#endif /* __MAPS_PLACE_URL_PLUGIN_H__ */ diff --git a/include/maps_plugin.h b/include/maps_plugin.h index c39682f..80b92d0 100644 --- a/include/maps_plugin.h +++ b/include/maps_plugin.h @@ -26,8 +26,8 @@ /** * - * @ingroup CAPI_MAPS_PLUGIN_MODULE - * @defgroup CAPI_MAPS_PLUGIN_AND_PROVIDERS_MODULE Maps Plugin and Providers + * @ingroup CAPI_MAPS_PLUGIN_MODULE + * @defgroup CAPI_MAPS_PLUGIN_AND_PROVIDERS_MODULE Maps Plugin and Providers * * @file maps_plugin.h * @brief This file contains the top level functions of Maps Plugin API @@ -42,7 +42,7 @@ extern "C" { #endif /** - * @brief The Maps Plugin handle. + * @brief The Maps Plugin handle. * @details The handle of Maps Plugin instance. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ @@ -54,52 +54,52 @@ typedef void *maps_plugin_h; */ /** - * @brief Initialize a new Maps Plugin. + * @brief Initialize a new Maps Plugin. * @details A maps plugin handle can be used to access a specified plugin. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a plugin and it resources must be released in * maps_plugin_shutdown(). * - * @param[out] plugin A handle of a new plugin on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] plugin A handle of a new plugin on success + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_shutdown() */ int maps_plugin_init(maps_plugin_h *plugin); /** - * @brief Destroys the Maps Plugin handle. + * @brief Destroys the Maps Plugin handle. * @details This function destroys the maps plugin handle and releases all its * resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] plugin The maps plugin handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] plugin The maps plugin handle to destroy + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_init() */ int maps_plugin_shutdown(maps_plugin_h plugin); /** - * @brief Returns a plugin info. + * @brief Returns a plugin info. * @details This function returns a plugin info. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[out] info A plugin info - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] info A plugin info + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_init() */ @@ -111,7 +111,7 @@ int maps_plugin_get_info(maps_plugin_info_h *info); */ /** - * @brief Sets the Maps Key to be used in the Maps Plugin requests. + * @brief Sets the Maps Key to be used in the Maps Plugin requests. * @details This function sets the Maps Key which will be used in each Maps * Plugin request to Maps Provider. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif @@ -121,18 +121,18 @@ int maps_plugin_get_info(maps_plugin_info_h *info); * https://developer.here.com/, * https://developer.here.com/rest-apis. * - * @param[in] provider_key The Maps Key to be used - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] provider_key The Maps Key to be used + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_get_provider_key() */ int maps_plugin_set_provider_key(const char *provider_key); /** - * @brief Gets the Maps Key which is to be used in the Maps Service + * @brief Gets the Maps Key which is to be used in the Maps Service * requests * @details This function gets the Maps Key which is to be used in each Maps * Service request to Maps Provider. @@ -140,62 +140,62 @@ int maps_plugin_set_provider_key(const char *provider_key); * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The string @a provider_key must be released using free(). * - * @param[out] provider_key The Maps Key - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] provider_key The Maps Key + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_set_provider_key() */ int maps_plugin_get_provider_key(char **provider_key); /** - * @brief Sets the Maps Preference. + * @brief Sets the Maps Preference. * @details This function sets the Maps Preferences which are used in each Maps * Plugin request to Maps Provider. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] preference The handle of Maps Preference - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @param[in] preference The handle of Maps Preference + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied * * @see maps_plugin_get_preference() */ int maps_plugin_set_preference(maps_item_hashtable_h preference); /** - * @brief Gets the Maps Preference. + * @brief Gets the Maps Preference. * @details This function gets the Maps Preferences which are used in each Maps * Plugin request to Maps Provider. * \n Preferences can be set with maps_plugin_set_preference(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a preference must be released using maps_preference_destroy(). * - * @param[out] preference The handle of Maps Preference - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] preference The handle of Maps Preference + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_set_preference() */ int maps_plugin_get_preference(maps_item_hashtable_h *preference); /** - * @brief Checks if the Maps Plugin supports a request. + * @brief Checks if the Maps Plugin supports a request. * @details This function checks if the Maps Plugin supports a specified request. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] service The service to be checked - * @param[out] supported Is the service supported - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] service The service to be checked + * @param[out] supported Is the service supported + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre Call maps_service_create() to create Maps Service and obtain its handle. * @@ -204,16 +204,16 @@ int maps_plugin_get_preference(maps_item_hashtable_h *preference); int maps_plugin_is_service_supported(maps_service_e service, bool *supported); /** - * @brief Checks if the Maps Plugin supports a data feature. + * @brief Checks if the Maps Plugin supports a data feature. * @details This function checks if the Maps Plugin supports a specified data feature. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] data The data feature to be checked - * @param[out] supported Is the data feature supported - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] data The data feature to be checked + * @param[out] supported Is the data feature supported + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre Call maps_service_create() to create Maps Service and obtain its handle. * @@ -227,32 +227,32 @@ int maps_plugin_is_data_supported(maps_service_data_e data, bool *supported); */ /** - * @brief Gets the position coordinates for a given address. + * @brief Gets the position coordinates for a given address. * @details This function obtains position coordinates for a given free-formed * address string. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks This function requires network access. * \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 geocoding - * @param[in] callback The callback which will receive position + * @param[in] address The free-formed address + * @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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @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_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @post It invokes maps_service_geocode_cb() to deliver obtained position * coordinates. @@ -262,13 +262,10 @@ int maps_plugin_is_data_supported(maps_service_data_e data, bool *supported); * @see maps_plugin_cancel_request() * @see maps_plugin_reverse_geocode() */ -int maps_plugin_geocode(const char *address, - const maps_item_hashtable_h preference, - maps_service_geocode_cb callback, void *user_data, - int *request_id); +int maps_plugin_geocode(const char *address, const maps_item_hashtable_h preference, maps_service_geocode_cb callback, void *user_data, int *request_id); /** - * @brief Gets the position for a given address, within the specified + * @brief Gets the position for a given address, within the specified * bounding box. * @details This function obtains position coordinates for a given free-formed * address string within the specified bounding box. @@ -279,26 +276,26 @@ int maps_plugin_geocode(const char *address, * \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 geocoding - * @param[in] callback The callback which will receive position + * @param[in] address The free-formed address + * @param[in] bounds The bounding box + * @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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @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_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @post It invokes maps_service_geocode_cb() to deliver obtained position * coordinates. @@ -310,14 +307,10 @@ int maps_plugin_geocode(const char *address, * @see maps_plugin_cancel_request() * @see maps_plugin_reverse_geocode() */ -int maps_plugin_geocode_inside_area(const char *address, - const maps_area_h bounds, - const maps_item_hashtable_h preference, - maps_service_geocode_cb callback, - void *user_data, int *request_id); +int maps_plugin_geocode_inside_area(const char *address, const maps_area_h bounds, const maps_item_hashtable_h preference, maps_service_geocode_cb callback, void *user_data, int *request_id); /** - * @brief Gets the position coordinates for a given address. + * @brief Gets the position coordinates for a given address. * @details This function obtains position coordinates for a given structured * address. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif @@ -326,23 +319,23 @@ int maps_plugin_geocode_inside_area(const char *address, * \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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @param[in] address The structured address + * @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 + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @post It invokes maps_service_geocode_cb() to deliver obtained position * coordinates. @@ -353,14 +346,10 @@ int maps_plugin_geocode_inside_area(const char *address, * @see maps_plugin_cancel_request() * @see maps_plugin_reverse_geocode() */ -int maps_plugin_geocode_by_structured_address(const maps_address_h address, - const maps_preference_h preference, - maps_service_geocode_cb callback, - void *user_data, - int *request_id); +int maps_plugin_geocode_by_structured_address(const maps_address_h address, const maps_preference_h preference, maps_service_geocode_cb callback, void *user_data, int *request_id); /** - * @brief Gets the address for a given position coordinates. + * @brief Gets the address for a given position coordinates. * @details This function obtains structured address information for a given * position coordinates. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif @@ -370,24 +359,24 @@ int maps_plugin_geocode_by_structured_address(const maps_address_h address, * 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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @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 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 + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @post This function invokes maps_service_reverse_geocode_cb(). * @@ -395,13 +384,10 @@ int maps_plugin_geocode_by_structured_address(const maps_address_h address, * @see maps_plugin_cancel_request() * @see maps_plugin_geocode() */ -int maps_plugin_reverse_geocode(double latitude, double longitude, - const maps_item_hashtable_h preference, - maps_service_reverse_geocode_cb callback, - void *user_data, int *request_id); +int maps_plugin_reverse_geocode(double latitude, double longitude, const maps_item_hashtable_h preference, maps_service_reverse_geocode_cb callback, void *user_data, int *request_id); /** - * @brief Gets the address list for a given position coordinates list. + * @brief Gets the address list for a given position coordinates list. * @details This function obtains structured address information for a given * position coordinates. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif @@ -411,32 +397,30 @@ int maps_plugin_reverse_geocode(double latitude, double longitude, * Reverse Geocode preferences are supported see the lists of capacities and * preferences above. * - * @param[in] geocode_list The position coordinates list - * @param[in] preference The set of preferences for processing Reverse Geocode - * @param[in] callback The callback which will receive address informations - * @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_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @param[in] geocode_list The position coordinates list + * @param[in] preference The set of preferences for processing Reverse Geocode + * @param[in] callback The callback which will receive address informations + * @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_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @post This function invokes maps_service_multi_reverse_geocode_cb(). * * @see maps_service_multi_reverse_geocode_cb() * @see maps_plugin_cancel_request() */ -int maps_plugin_multi_reverse_geocode(const maps_coordinates_list_h geocode_list, - const maps_preference_h preference, maps_service_multi_reverse_geocode_cb callback, - void *user_data, int *request_id); +int maps_plugin_multi_reverse_geocode(const maps_coordinates_list_h geocode_list, const maps_preference_h preference, maps_service_multi_reverse_geocode_cb callback, void *user_data, int *request_id); /*----------------------------------------------------------------------------*/ @@ -445,7 +429,7 @@ int maps_plugin_multi_reverse_geocode(const maps_coordinates_list_h geocode_list */ /** - * @brief Queries a Place information by a coordinates position and a + * @brief Queries a Place information by a coordinates position and a * distance. * @details This function obtains the Place information for a specified distance * around a given coordinates position. @@ -455,27 +439,27 @@ int maps_plugin_multi_reverse_geocode(const maps_coordinates_list_h geocode_list * \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. * - * @param[in] position The interested position - * @param[in] distance The search area 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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy - * @retval #MAPS_ERROR_CANCELED Places service aborted - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @param[in] position The interested position + * @param[in] distance The search area 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 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 + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy + * @retval #MAPS_ERROR_CANCELED Places service aborted + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @post It invokes maps_service_search_place_cb() to deliver obtained Place * information. @@ -485,14 +469,10 @@ int maps_plugin_multi_reverse_geocode(const maps_coordinates_list_h geocode_list * @see maps_plugin_cancel_request() * @see maps_service_search_place_cb() */ -int maps_plugin_search_place(const maps_coordinates_h position, int distance, - const maps_place_filter_h filter, - maps_preference_h preference, - maps_service_search_place_cb callback, - void *user_data, int *request_id); +int maps_plugin_search_place(const maps_coordinates_h position, int distance, const maps_place_filter_h filter, maps_preference_h preference, maps_service_search_place_cb callback, void *user_data, int *request_id); /** - * @brief Queries a Place information by a coordinates boundary. + * @brief Queries a Place information by a coordinates boundary. * @details This function obtains the Place information for a specified * coordinates boundary. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif @@ -502,26 +482,26 @@ int maps_plugin_search_place(const maps_coordinates_h position, int distance, * \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. * - * @param[in] boundary The interested area - * @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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy - * @retval #MAPS_ERROR_CANCELED Places service aborted - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @param[in] boundary The interested area + * @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 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 + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy + * @retval #MAPS_ERROR_CANCELED Places service aborted + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @post It invokes maps_service_search_place_cb() to deliver obtained Place * information. @@ -531,14 +511,10 @@ int maps_plugin_search_place(const maps_coordinates_h position, int distance, * @see maps_plugin_cancel_request() * @see maps_service_search_place_cb() */ -int maps_plugin_search_place_by_area(const maps_area_h boundary, - const maps_place_filter_h filter, - maps_preference_h preference, - maps_service_search_place_cb callback, - void *user_data, int *request_id); +int maps_plugin_search_place_by_area(const maps_area_h boundary, const maps_place_filter_h filter, maps_preference_h preference, maps_service_search_place_cb callback, void *user_data, int *request_id); /** - * @brief Queries a Place information by a free-formed address string. + * @brief Queries a Place information by a free-formed address string. * @details This function obtains the Place information for a specified free- * formed address string. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif @@ -548,27 +524,27 @@ int maps_plugin_search_place_by_area(const maps_area_h boundary, * \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. * - * @param[in] address The interested address - * @param[in] boundary The interested area - * @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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy - * @retval #MAPS_ERROR_CANCELED Places service aborted - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @param[in] address The interested address + * @param[in] boundary The interested area + * @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 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 + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy + * @retval #MAPS_ERROR_CANCELED Places service aborted + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @post It invokes maps_service_search_place_cb() to deliver obtained Place * information. @@ -578,15 +554,10 @@ int maps_plugin_search_place_by_area(const maps_area_h boundary, * @see maps_plugin_cancel_request() * @see maps_service_search_place_cb() */ -int maps_plugin_search_place_by_address(const char *address, - const maps_area_h boundary, - const maps_place_filter_h filter, - maps_preference_h preference, - maps_service_search_place_cb callback, - void *user_data, int *request_id); +int maps_plugin_search_place_by_address(const char *address, const maps_area_h boundary, const maps_place_filter_h filter, maps_preference_h preference, maps_service_search_place_cb callback, void *user_data, int *request_id); /** - * @brief Queries a brief Place information by a coordinates boundary. + * @brief Queries a brief Place information by a coordinates boundary. * @details This function obtains the brief Place information for a specified coordinates boundary. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks This function requires network access. @@ -594,40 +565,36 @@ int maps_plugin_search_place_by_address(const char *address, * \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. * - * @param[in] boundary The interested area - * @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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy - * @retval #MAPS_ERROR_CANCELED Places service aborted - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @param[in] boundary The interested area + * @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 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 + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy + * @retval #MAPS_ERROR_CANCELED Places service aborted + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @post It invokes maps_service_search_place_list_cb() to deliver obtained Place information. * * @see maps_plugin_cancel_request() * @see maps_service_search_place_list_cb() */ -int maps_plugin_search_place_list(const maps_area_h boundary, - const maps_place_filter_h filter, - maps_preference_h preference, - maps_service_search_place_list_cb callback, - void *user_data, int *request_id); +int maps_plugin_search_place_list(const maps_area_h boundary, const maps_place_filter_h filter, maps_preference_h preference, maps_service_search_place_list_cb callback, void *user_data, int *request_id); /** - * @brief Queries a Detail place information by a place uri. + * @brief Queries a Detail place information by a place uri. * @details This function obtains the Detail place information for a specified place uri * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks This function requires network access. @@ -635,24 +602,24 @@ int maps_plugin_search_place_list(const maps_area_h boundary, * \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. * - * @param[in] url The interested place url - * @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 - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy - * @retval #MAPS_ERROR_CANCELED Places service aborted - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @param[in] url The interested place url + * @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 + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy + * @retval #MAPS_ERROR_CANCELED Places service aborted + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @pre @a uri is obtained from maps_plugin_search_place_list() * @post It invokes maps_service_get_place_details_cb() to deliver obtained Place information. @@ -661,9 +628,7 @@ int maps_plugin_search_place_list(const maps_area_h boundary, * @see maps_plugin_cancel_request() * @see maps_service_get_place_details_cb() */ -int maps_plugin_get_place_details(const char *url, - maps_service_get_place_details_cb callback, - void *user_data, int *request_id); +int maps_plugin_get_place_details(const char *url, maps_service_get_place_details_cb callback, void *user_data, int *request_id); /*----------------------------------------------------------------------------*/ /* @@ -671,7 +636,7 @@ int maps_plugin_get_place_details(const char *url, */ /** - * @brief Queries the Route from origin coordinate to a destination. + * @brief Queries the Route from origin coordinate to a destination. * @details This function obtains the Route information for a specified origin * and destination coordinates. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif @@ -680,23 +645,23 @@ int maps_plugin_get_place_details(const char *url, * \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. * - * @param[in] origin The starting point - * @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 - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Service unavailable - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @param[in] origin The starting point + * @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 + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Service unavailable + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @post It invokes maps_service_search_route_cb() to deliver obtained Route * information. @@ -705,14 +670,10 @@ int maps_plugin_get_place_details(const char *url, * @see maps_plugin_cancel_request() * @see maps_service_search_route_cb() */ -int maps_plugin_search_route(const maps_coordinates_h origin, - const maps_coordinates_h destination, - maps_preference_h preference, - maps_service_search_route_cb callback, - void *user_data, int *request_id); +int maps_plugin_search_route(const maps_coordinates_h origin, const maps_coordinates_h destination, maps_preference_h preference, maps_service_search_route_cb callback, void *user_data, int *request_id); /** - * @brief Queries the Route, passing through a specified way points. + * @brief Queries the Route, passing through a specified way points. * @details This function obtains the Route information for the Route, passing * through a specified set of way points. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif @@ -721,23 +682,23 @@ int maps_plugin_search_route(const maps_coordinates_h origin, * \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. * - * @param[in] waypoint_list The list of way points to go through - * @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 - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Service unavailable - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @param[in] waypoint_list The list of way points to go through + * @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 + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Service unavailable + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @post It invokes maps_service_search_route_cb() to deliver obtained Route * information. @@ -746,11 +707,7 @@ int maps_plugin_search_route(const maps_coordinates_h origin, * @see maps_plugin_cancel_request() * @see maps_service_search_route_cb() */ -int maps_plugin_search_route_waypoints(const maps_coordinates_h *waypoint_list, - int waypoint_num, - maps_preference_h preference, - maps_service_search_route_cb callback, - void *user_data, int *request_id); +int maps_plugin_search_route_waypoints(const maps_coordinates_h *waypoint_list, int waypoint_num, maps_preference_h preference, maps_service_search_route_cb callback, void *user_data, int *request_id); /*----------------------------------------------------------------------------*/ /* @@ -758,25 +715,25 @@ int maps_plugin_search_route_waypoints(const maps_coordinates_h *waypoint_list, */ /** - * @brief Cancels the service request. + * @brief Cancels the service request. * @details This function cancels the service request initiated by geocode, * route or place search. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks This function requires network access. * - * @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 - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @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 + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_UNKNOWN Unknown error * * @pre @a request_id is obtained from one of following: * - maps_plugin_geocode() @@ -806,11 +763,11 @@ int maps_plugin_cancel_request(int request_id); /*----------------------------------------------------------------------------*/ /** - * @brief Called when the map initializing is finished. + * @brief Called when the map initializing is finished. * @details The Plugin invokes this callback when the initializing of map is finished. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] view The maps view + * @param[in] view The maps view * * @pre maps_plugin_render_map() will invoke this callback. * @@ -819,16 +776,16 @@ int maps_plugin_cancel_request(int request_id); typedef void(*maps_plugin_map_view_ready_cb) (maps_view_h view); /** - * @brief Create a maps view. + * @brief Create a maps view. * @details This function create a maps view to the plugin. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] view The maps view - * @param[in] callback The result callback - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The maps view + * @param[in] callback The result callback + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see #maps_view_h * @see maps_plugin_destroy_map_view() @@ -836,15 +793,15 @@ typedef void(*maps_plugin_map_view_ready_cb) (maps_view_h view); int maps_plugin_create_map_view(maps_view_h view, maps_plugin_map_view_ready_cb callback); /** - * @brief Destroy a maps view. + * @brief Destroy a maps view. * @details This function destroy a maps view to the plugin. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] view The maps view - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The maps view + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see #maps_view_h * @see maps_plugin_create_map_view() @@ -852,19 +809,19 @@ int maps_plugin_create_map_view(maps_view_h view, maps_plugin_map_view_ready_cb int maps_plugin_destroy_map_view(maps_view_h view); /** - * @brief Request a map rendering. + * @brief Request a map rendering. * @details This function request a draw routine of the map location with a * specified zoom factor and rotation angle. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] view The handle of maps_view - * @param[in] coordinates The coordinates of location to draw - * @param[in] zoom_factor The zoom factor - * @param[in] rotation_angle The rotation factor - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The handle of maps_view + * @param[in] coordinates The coordinates of location to draw + * @param[in] zoom_factor The zoom factor + * @param[in] rotation_angle The rotation factor + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @post It invokes maps_plugin_render_map_cb() to notify that the rendering is * finished @@ -873,23 +830,22 @@ int maps_plugin_destroy_map_view(maps_view_h view); * @see maps_plugin_render_map_cb() * @see maps_plugin_draw_map() */ -int maps_plugin_render_map(maps_view_h view, const maps_coordinates_h coordinates, - double zoom_factor, double rotation_angle); +int maps_plugin_render_map(maps_view_h view, const maps_coordinates_h coordinates, double zoom_factor, double rotation_angle); /** - * @brief Request the Plugin to move a map on a given delta. + * @brief Request the Plugin to move a map on a given delta. * @details This function request the Plugin to move a map on a given delta * screen coordinates. The current values of zoom or orientation are * remaining same. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] view The handle of maps_view - * @param[in] delta_x The delta x - * @param[in] delta_y The delta y - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The handle of maps_view + * @param[in] delta_x The delta x + * @param[in] delta_y The delta y + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @post It invokes maps_plugin_render_map_cb() to notify that the rendering is * finished @@ -902,145 +858,142 @@ int maps_plugin_render_map(maps_view_h view, const maps_coordinates_h coordinate int maps_plugin_move_center(maps_view_h view, int delta_x, int delta_y); /** - * @brief Enables or disables the scalebar. + * @brief Enables or disables the scalebar. * @details This function enables or disables the scalebar. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks This function requires network access. * - * @param[in] view The handle of maps_view - * @param[in] enable The enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The handle of maps_view + * @param[in] enable The enable status + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_get_scalebar() */ int maps_plugin_set_scalebar(maps_view_h view, bool enable); /** - * @brief Checks whether the scalebar is enabled or not. + * @brief Checks whether the scalebar is enabled or not. * @details This function checks whether the scalebar is enabled or not. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] view The handle of maps_view - * @param[out] enabled The pointer to a boolean in which to store the enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The handle of maps_view + * @param[out] enabled The pointer to a boolean in which to store the enable status + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_set_scalebar() */ int maps_plugin_get_scalebar(maps_view_h view, bool *enabled); /** - * @brief Notifies that the visual object is changed. + * @brief Notifies that the visual object is changed. * @details This function notifies the Plugin that the visual object is * changed. The possible causes of changes are enumerated in * #maps_view_object_operation_e including in object adding, moving, removing, * visibility modifying or editing object specific properties. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] view The handle of maps_view - * @param[in] object The object handle - * @param[in] operation The operation over the object - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The handle of maps_view + * @param[in] object The object handle + * @param[in] operation The operation over the object + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_create() */ -int maps_plugin_on_object(maps_view_h view, const maps_view_object_h object, - maps_view_object_operation_e operation); +int maps_plugin_on_object(maps_view_h view, const maps_view_object_h object, maps_view_object_operation_e operation); /** - * @brief Converts screen coordinates to the geographical coordinates. + * @brief Converts screen coordinates to the geographical coordinates. * @details This function converts screen coordinates to the geographical * coordinates accordingly to the current maps settings. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] view The handle of maps_view - * @param[in] x The x coordinate on the screen - * @param[in] y The y coordinate on the screen - * @param[out] coordinates The corresponding geographical coordinates - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The handle of maps_view + * @param[in] x The x coordinate on the screen + * @param[in] y The y coordinate on the screen + * @param[out] coordinates The corresponding geographical coordinates + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_create() * @see maps_plugin_geography_to_screen() * @see #maps_coordinates_h */ -int maps_plugin_screen_to_geography(maps_view_h view, int x, int y, - maps_coordinates_h* coordinates); +int maps_plugin_screen_to_geography(maps_view_h view, int x, int y, maps_coordinates_h* coordinates); /** - * @brief Converts geographical coordinates to the screen coordinates. + * @brief Converts geographical coordinates to the screen coordinates. * @details This function converts geographical coordinates to the screen * coordinates accordingly to the current maps settings. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] view The handle of maps_view - * @param[in] coordinates The geographical coordinates - * @param[out] x The corresponding x coordinate on the screen - * @param[out] y The corresponding y coordinate on the screen - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The handle of maps_view + * @param[in] coordinates The geographical coordinates + * @param[out] x The corresponding x coordinate on the screen + * @param[out] y The corresponding y coordinate on the screen + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_create() * @see maps_plugin_screen_to_geography() * @see #maps_coordinates_h */ -int maps_plugin_geography_to_screen(maps_view_h view, const maps_coordinates_h coordinates, - int* x, int* y); +int maps_plugin_geography_to_screen(maps_view_h view, const maps_coordinates_h coordinates, int* x, int* y); /** - * @brief Gets the minimal zooms level of the Map. + * @brief Gets the minimal zooms level of the Map. * @details This function gets the minimally available zoom level of the Map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] view The handle of maps_view - * @param[out] min_zoom_level The minimally available zoom level - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The handle of maps_view + * @param[out] min_zoom_level The minimally available zoom level + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_plugin_get_min_zoom_level(maps_view_h view, int *min_zoom_level); /** - * @brief Gets the maximal zooms level of the Map. + * @brief Gets the maximal zooms level of the Map. * @details This function gets the maximally available zoom level of the Map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] view The handle of maps_view - * @param[out] max_zoom_level The maximally available zoom level - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The handle of maps_view + * @param[out] max_zoom_level The maximally available zoom level + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_plugin_get_max_zoom_level(maps_view_h view, int *max_zoom_level); /** - * @brief Gets the central coordinates of a Map. + * @brief Gets the central coordinates of a Map. * @details This function gets the central coordinates of a Map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks @a coordinates must be released using maps_coordinates_destroy(). * - * @param[in] view The handle of maps_view - * @param[out] coordinates The pointer to #maps_coordinates_h in which to + * @param[in] view The handle of maps_view + * @param[out] coordinates The pointer to #maps_coordinates_h in which to * store the geographical coordinates of the central position of the Map - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_get_min_zoom_level() * @see maps_plugin_get_max_zoom_level @@ -1048,22 +1001,21 @@ int maps_plugin_get_max_zoom_level(maps_view_h view, int *max_zoom_level); int maps_plugin_get_center(maps_view_h view, maps_coordinates_h *coordinates); /** - * @brief Gets raw pixels of the Map. + * @brief Gets raw pixels of the Map. * @details This function gets raw pixels of the Map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * - * @param[in] view The view handle - * @param[out] data The pixels of the Map - * @param[out] width The width of @a data - * @param[out] height The height of @a data - * @param[out] cs The color space of @a data - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The view handle + * @param[out] data The pixels of the Map + * @param[out] width The width of @a data + * @param[out] height The height of @a data + * @param[out] cs The color space of @a data + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_plugin_capture_snapshot(maps_view_h view, void **data, int *width, int *height, - maps_view_colorspace_type_e *cs); +int maps_plugin_capture_snapshot(maps_view_h view, void **data, int *width, int *height, maps_view_colorspace_type_e *cs); #ifdef __cplusplus } @@ -1071,4 +1023,4 @@ int maps_plugin_capture_snapshot(maps_view_h view, void **data, int *width, int /** * @} */ -#endif /* __MAPS_PLUGIN_H__ */ +#endif /* __MAPS_PLUGIN_H__ */ diff --git a/include/maps_plugin_info.h b/include/maps_plugin_info.h index b4ad70b..e61dfbb 100644 --- a/include/maps_plugin_info.h +++ b/include/maps_plugin_info.h @@ -19,8 +19,8 @@ /** * - * @ingroup CAPI_MAPS_PLUGIN_AND_PROVIDERS_MODULE - * @defgroup CAPI_MAPS_PLUGIN_INFO_MODULE Plugin info + * @ingroup CAPI_MAPS_PLUGIN_AND_PROVIDERS_MODULE + * @defgroup CAPI_MAPS_PLUGIN_INFO_MODULE Plugin info * * @file maps_plugin_info.h * @brief This file contains the Maps Plugin Info interface @@ -35,7 +35,7 @@ extern "C" { #endif /** - * @brief The Maps Plugin Info handle + * @brief The Maps Plugin Info handle * @details The handle of Maps Plugin Info instance. * @remarks To create the handle use maps_plugin_info_create(). * \n To release the handle use maps_plugin_info_destroy(). @@ -51,19 +51,19 @@ typedef void *maps_plugin_info_h; /*----------------------------------------------------------------------------*/ /** - * @brief Creates a new plugin info handle. + * @brief Creates a new plugin info handle. * @details This function creates a new plugin info handle and allocates all * needed resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a info must be released using maps_plugin_info_destroy(). * \n @a info may be cloned using maps_plugin_info_clone(). * - * @param[out] info A handle of a new plugin info on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] info A handle of a new plugin info on success + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_plugin_info_destroy() * @see maps_plugin_info_clone() @@ -71,16 +71,16 @@ typedef void *maps_plugin_info_h; int maps_plugin_info_create(maps_plugin_info_h *info); /** - * @brief Destroys the plugin info handle and releases all its resources. + * @brief Destroys the plugin info handle and releases all its resources. * @details This function destroys the plugin info handle and releases all its * resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] info The plugin info handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] info The plugin info handle to destroy + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a info is created using maps_plugin_info_create(). * @@ -90,68 +90,65 @@ int maps_plugin_info_create(maps_plugin_info_h *info); int maps_plugin_info_destroy(maps_plugin_info_h info); /** - * @brief Clones the plugin info handle. + * @brief Clones the plugin info handle. * @details This function clones the plugin info handle @a origin and all its * resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_plugin_info_destroy(). * - * @param[in] origin The original plugin info handle - * @param[out] cloned A cloned plugin info handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] origin The original plugin info handle + * @param[out] cloned A cloned plugin info handle + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a info is created using maps_plugin_info_create(). * * @see maps_plugin_info_create() * @see maps_plugin_info_destroy() */ -int maps_plugin_info_clone(const maps_plugin_info_h origin, - maps_plugin_info_h *cloned); +int maps_plugin_info_clone(const maps_plugin_info_h origin, maps_plugin_info_h *cloned); /*----------------------------------------------------------------------------*/ /** - * @brief Gets the plugin provider name. + * @brief Gets the plugin provider name. * @details This function gets the plugin provider name. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a provider_name must be released using free(). * - * @param[in] info The handle of plugin info - * @param[out] provider_name The plugin info name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] info The handle of plugin info + * @param[out] provider_name The plugin info name + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a info is created using maps_plugin_info_create(). * * @see maps_plugin_info_create() */ -int maps_plugin_info_get_provider_name(const maps_plugin_info_h info, - char **provider_name); +int maps_plugin_info_get_provider_name(const maps_plugin_info_h info, char **provider_name); /** - * @brief Sets the plugin provider name. + * @brief Sets the plugin provider name. * @details This function sets the plugin provider name. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] info The handle of plugin info - * @param[in] provider_name The plugin info name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] info The handle of plugin info + * @param[in] provider_name The plugin info name + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a info is created using maps_plugin_info_create(). * * @see maps_plugin_info_create() */ -int maps_plugin_info_set_provider_name(maps_plugin_info_h info, - const char *provider_name); +int maps_plugin_info_set_provider_name(maps_plugin_info_h info, const char *provider_name); #ifdef __cplusplus } diff --git a/include/maps_plugin_types.h b/include/maps_plugin_types.h index d5f4d71..c8b30b2 100644 --- a/include/maps_plugin_types.h +++ b/include/maps_plugin_types.h @@ -22,8 +22,8 @@ extern "C" { #endif /** - * @ingroup CAPI_MAPS_CONTAINERS_MODULE - * @defgroup CAPI_MAPS_CONTAINERS_MODULE_OBJECT_LIST Maps Object Lists + * @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 @@ -36,7 +36,7 @@ extern "C" { #include /** - * @brief Structure of the coordinates list. + * @brief Structure of the coordinates list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks #maps_coordinates_list_h is a void pointer to the #maps_coordinates_list_s. * @@ -46,7 +46,7 @@ extern "C" { typedef GList maps_coordinates_list_s; /** - * @brief Structure of the address list. + * @brief Structure of the address list. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks #maps_address_list_h is a void pointer to the #maps_address_list_s. * @@ -63,6 +63,6 @@ typedef GList maps_address_list_s; } #endif -#endif /* __MAPS_PLUGIN_TYPES_H__ */ +#endif /* __MAPS_PLUGIN_TYPES_H__ */ diff --git a/include/maps_preference.h b/include/maps_preference.h index e1eb653..221c3ac 100644 --- a/include/maps_preference.h +++ b/include/maps_preference.h @@ -14,751 +14,705 @@ * limitations under the License. */ + #ifndef __MAPS_PREFERENCE_H__ #define __MAPS_PREFERENCE_H__ + #include + #ifdef __cplusplus extern "C" { #endif + /** - * @ingroup CAPI_MAPS_SERVICE_MODULE - * @defgroup CAPI_MAPS_PREFERENCE_MODULE Preference - * + * @ingroup CAPI_MAPS_SERVICE_MODULE + * @defgroup CAPI_MAPS_PREFERENCE_MODULE Preference * @file maps_preference.h - * @brief This file contains the enumerations of Maps API preferences - * + * @brief This file contains the enumerations of Maps API preferences. * @addtogroup CAPI_MAPS_PREFERENCE_MODULE * @{ - * @brief This provides enumerations of Maps API preferences + * @brief This provides enumerations of Maps API preferences. + * The Preferences are organized as a key-value table where available Preference keys are following strings: + * * Place search preferences + * - #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_GEOMETRY_BOUNDING_BOX + * - #MAPS_ROUTE_GEOMETRY_RETRIEVAL + * - #MAPS_ROUTE_INSTRUCTION_GEOMETRY + * - #MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX + * - #MAPS_ROUTE_INSTRUCTION_RETRIEVAL + * - #MAPS_ROUTE_REALTIME_TRAFFIC + * . + */ -* -* The Preferences are organized as a key-value table where available Preference -* keys are following strings: -* -* * Place search preferences -* - #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_GEOMETRY_BOUNDING_BOX -* - #MAPS_ROUTE_GEOMETRY_RETRIEVAL -* - #MAPS_ROUTE_INSTRUCTION_GEOMETRY -* - #MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX -* - #MAPS_ROUTE_INSTRUCTION_RETRIEVAL -* - #MAPS_ROUTE_REALTIME_TRAFFIC -* . -*/ /** - * @brief The name of the preference indicating place type while searching - * the place + * @brief Definition for the name of the preference indicating place type while searching the place. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ -#define MAPS_PLACE_FILTER_TYPE "MAPS_PLACE_FILTER_TYPE" +#define MAPS_PLACE_FILTER_TYPE "MAPS_PLACE_FILTER_TYPE" + /** - * @brief The name of the preference indicating sorting key while - * searching the place + * @brief Definition for the name of the preference indicating sorting key while searching the place. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ #define MAPS_PLACE_FILTER_SORT_BY "MAPS_PLACE_FILTER_SORT_BY" + /** - * @brief The name of the preference indicating free-form address to avoid - * while computing the route + * @brief Definition for the name of the preference indicating free-form address to avoid while computing the route. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ #define MAPS_ROUTE_FREEFORM_ADDR_TO_AVOID "MAPS_ROUTE_FREEFORM_ADDR_TO_AVOID" + /** - * @brief The name of the preference indicating structured address to - * avoid while computing the route + * @brief Definition for the name of the preference indicating structured address to avoid while computing the route. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ #define MAPS_ROUTE_STRUCTED_ADDR_TO_AVOID "MAPS_ROUTE_STRUCTED_ADDR_TO_AVOID" + /** - * @brief The name of the preference indicating circular geographical area - * to avoid while computing the route + * @brief Definition for the name of the preference indicating circular geographical area to avoid while computing the route. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ #define MAPS_ROUTE_CIRCLE_AREA_TO_AVOID "MAPS_ROUTE_CIRCLE_AREA_TO_AVOID" + /** - * @brief The name of the preference indicating rectangular geographical - * area to avoid while computing the route + * @brief Definition for the name of the preference indicating rectangular geographical area to avoid while computing the route. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remark The values are consist of top-left and bottom-right geo-coordinates, - * and comma or semicolon are used to delimit each value. - * \n Format : {top-left latitude};{top-left longitude};{bottom-right latitude};{bottom-right longitude} - * \n Example : "37.125;127.0572;37.37.102;127.0672" + * @remarks The values are consist of top-left and bottom-right geo-coordinates, and comma or semicolon are used to delimit each value.\n + * Format : {top-left latitude};{top-left longitude};{bottom-right latitude};{bottom-right longitude}\n + * Example : "37.125;127.0572;37.37.102;127.0672" */ #define MAPS_ROUTE_RECT_AREA_TO_AVOID "MAPS_ROUTE_RECT_AREA_TO_AVOID" + /** - * @brief The name of the preference indicating that route should be - * computed within a specified bounding box + * @brief Definition for the name of the preference indicating that route should be computed within a specified bounding box. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ #define MAPS_ROUTE_GEOMETRY_BOUNDING_BOX "MAPS_ROUTE_GEOMETRY_BOUNDING_BOX" + /** - * @brief The name of the preference indicating that geometry parameters - * should be retrieved while route processing + * @brief Definition for the name of the preference indicating that geometry parameters should be retrieved while route processing. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ #define MAPS_ROUTE_GEOMETRY_RETRIEVAL "MAPS_ROUTE_GEOMETRY_RETRIEVAL" + /** - * @brief The name of the preference indicating that route should be - * computed with geometry instructions + * @brief Definition for the name of the preference indicating that route should be computed with geometry instructions. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ #define MAPS_ROUTE_INSTRUCTION_GEOMETRY "MAPS_ROUTE_INSTRUCTION_GEOMETRY" + /** - * @brief The name of the preference indicating that route should be - * computed with bounding box instructions + * @brief Definition for the name of the preference indicating that route should be computed with bounding box instructions. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ #define MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX "MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX" + /** - * @brief The name of the preference indicating that route should be - * computed correspondingly to retrieval instructions + * @brief Definition for the name of the preference indicating that route should be computed correspondingly to retrieval instructions. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ #define MAPS_ROUTE_INSTRUCTION_RETRIEVAL "MAPS_ROUTE_INSTRUCTION_RETRIEVAL" + /** - * @brief The name of the preference indicating that route should be - * computed in accordance to real time traffic + * @brief Definition for the name of the preference indicating that route should be computed in accordance to real time traffic. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remark To enable realtime traffic, set the value to "true". - * Otherwise, set it to "false". + * @remarks To enable realtime traffic, set the value to "true". + * Otherwise, set it to "false". */ #define MAPS_ROUTE_REALTIME_TRAFFIC "MAPS_ROUTE_REALTIME_TRAFFIC" + /** - * @brief The Maps Preference handle. - * @details The Maps Preference handle can be obtained via call of - * maps_preference_create(). - * \n To release the handle use maps_preference_destroy(). - * \n To clone the handle use maps_preference_clone(). + * @brief The Maps Preference handle. + * @details The Maps Preference handle can be obtained via call of maps_preference_create().\n + * To release the handle use maps_preference_destroy().\n + * To clone the handle use maps_preference_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * * @see maps_preference_create() * @see maps_preference_destroy() * @see maps_preference_clone() */ typedef void *maps_preference_h; + /** - * @brief Enumeration of allowed distance units. - * @details This enumeration represents allowed distance units used in Maps - * Services. + * @brief Enumeration for allowed distance units. + * @details This enumeration represents allowed distance units used in Maps Services. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * * @see #maps_preference_h */ typedef enum _maps_distance_unit_e { - MAPS_DISTANCE_UNIT_M, /**< for Meter */ - MAPS_DISTANCE_UNIT_KM, /**< for Kilometer */ - MAPS_DISTANCE_UNIT_FT, /**< for Foot */ - MAPS_DISTANCE_UNIT_YD /**< for Yard */ + MAPS_DISTANCE_UNIT_M, /**< for Meter */ + MAPS_DISTANCE_UNIT_KM, /**< for Kilometer */ + MAPS_DISTANCE_UNIT_FT, /**< for Foot */ + MAPS_DISTANCE_UNIT_YD /**< for Yard */ } maps_distance_unit_e; + /** - * @brief Enumeration of allowed route optimization option. - * @details This enumeration represents allowed route optimization option used - * in Route Service. + * @brief Enumeration for allowed route optimization option. + * @details This enumeration represents allowed route optimization option used in Route Service. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * * @see #_maps_route_transport_mode_e * @see #_maps_route_feature_weight_e * @see #_maps_route_request_feature_e */ typedef enum _maps_route_optimization_e { - MAPS_ROUTE_TYPE_FASTEST, /**< Indicates the fastest route */ - MAPS_ROUTE_TYPE_SHORTEST, /**< Indicates the shortest route (car mode only) */ - MAPS_ROUTE_TYPE_ECONOMIC, /**< Indicates the most economic route (car mode only) */ - MAPS_ROUTE_TYPE_SCENIC, /**< Indicates the most scenic route */ + MAPS_ROUTE_TYPE_FASTEST, /**< Indicates the fastest route */ + MAPS_ROUTE_TYPE_SHORTEST, /**< Indicates the shortest route (car mode only) */ + MAPS_ROUTE_TYPE_ECONOMIC, /**< Indicates the most economic route (car mode only) */ + MAPS_ROUTE_TYPE_SCENIC, /**< Indicates the most scenic route */ MAPS_ROUTE_TYPE_FASTESTNOW, /**< Indicates the most fastest route now */ MAPS_ROUTE_TYPE_DIRECTDRIVE /**< Indicates direct drive */ } maps_route_optimization_e; + /** - * @brief Enumeration of preferable route types. - * @details This enumeration represents allowed route types used in Route - * Service. + * @brief Enumeration for preferable route types. + * @details This enumeration represents allowed route types used in Route Service. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * * @see #_maps_distance_unit_e * @see #_maps_route_feature_weight_e * @see #_maps_route_request_feature_e */ typedef enum _maps_route_transport_mode_e { - MAPS_ROUTE_TRANSPORT_MODE_CAR, /**< Indicates that the route is to be traveled by car. */ - MAPS_ROUTE_TRANSPORT_MODE_PEDESTRIAN, /**< Indicates that the route is for a pedestrian. */ - MAPS_ROUTE_TRANSPORT_MODE_BICYCLE, /**< Indicates that the route is for a cyclist. */ - MAPS_ROUTE_TRANSPORT_MODE_PUBLICTRANSIT, /**< Indicates that the route - is to be traveled using public transport. */ - MAPS_ROUTE_TRANSPORT_MODE_TRUCK /**< Indicates that the route is for a truck. */ + MAPS_ROUTE_TRANSPORT_MODE_CAR, /**< Indicates that the route is to be traveled by car. */ + MAPS_ROUTE_TRANSPORT_MODE_PEDESTRIAN, /**< Indicates that the route is for a pedestrian. */ + MAPS_ROUTE_TRANSPORT_MODE_BICYCLE, /**< Indicates that the route is for a cyclist. */ + MAPS_ROUTE_TRANSPORT_MODE_PUBLICTRANSIT, /**< Indicates that the route is to be traveled using public transport. */ + MAPS_ROUTE_TRANSPORT_MODE_TRUCK /**< Indicates that the route is for a truck. */ } maps_route_transport_mode_e; + /** - * @brief Enumeration of route feature weights. - * @details This enumeration represents allowed route feature weights used in - * Route Service. + * @brief Enumeration for route feature weights. + * @details This enumeration represents allowed route feature weights used in Route Service. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * * @see #_maps_distance_unit_e * @see #_maps_route_transport_mode_e * @see #_maps_route_request_feature_e */ typedef enum _maps_route_feature_weight_e { - MAPS_ROUTE_FEATURE_WEIGHT_NORMAL, /**< Indicates normal weighting. */ - MAPS_ROUTE_FEATURE_WEIGHT_PREFER, /**< Indicates that a feature is preferred. */ - MAPS_ROUTE_FEATURE_WEIGHT_AVOID, /**< Indicates that a feature is to be avoided. */ - MAPS_ROUTE_FEATURE_WEIGHT_SOFTEXCLUDE, /**< Indicates that soft-exclude applies to the feature. */ + MAPS_ROUTE_FEATURE_WEIGHT_NORMAL, /**< Indicates normal weighting. */ + MAPS_ROUTE_FEATURE_WEIGHT_PREFER, /**< Indicates that a feature is preferred. */ + MAPS_ROUTE_FEATURE_WEIGHT_AVOID, /**< Indicates that a feature is to be avoided. */ + MAPS_ROUTE_FEATURE_WEIGHT_SOFTEXCLUDE, /**< Indicates that soft-exclude applies to the feature. */ MAPS_ROUTE_FEATURE_WEIGHT_STRICTEXCLUDE /**< Indicates that the feature is to be strictly excluded. */ } maps_route_feature_weight_e; + /** - * @brief Enumeration of route features. - * @details This enumeration represents allowed route features used in Route - * Service. + * @brief Enumeration for route features. + * @details This enumeration represents allowed route features used in Route Service. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * * @see #_maps_distance_unit_e * @see #_maps_route_transport_mode_e * @see #_maps_route_feature_weight_e */ typedef enum _maps_route_request_feature_e { - MAPS_ROUTE_FEATURE_NO, /**< Indicates no route features (are selected). */ - MAPS_ROUTE_FEATURE_TOLL, /**< Indicates toll roads (toll gates/booths). */ - MAPS_ROUTE_FEATURE_MOTORWAY, /**< Indicates motorway. */ - MAPS_ROUTE_FEATURE_BOATFERRY, /**< Indicates a boat ferry. */ - MAPS_ROUTE_FEATURE_RAILFERRY, /**< Indicates rail (train) ferry. */ + MAPS_ROUTE_FEATURE_NO, /**< Indicates no route features (are selected). */ + MAPS_ROUTE_FEATURE_TOLL, /**< Indicates toll roads (toll gates/booths). */ + MAPS_ROUTE_FEATURE_MOTORWAY, /**< Indicates motorway. */ + MAPS_ROUTE_FEATURE_BOATFERRY, /**< Indicates a boat ferry. */ + MAPS_ROUTE_FEATURE_RAILFERRY, /**< Indicates rail (train) ferry. */ MAPS_ROUTE_FEATURE_PUBLICTTRANSIT, /**< Indicates public transport. */ - MAPS_ROUTE_FEATURE_TUNNEL, /**< Indicates tunnel. */ - MAPS_ROUTE_FEATURE_DIRTROAD, /**< Indicates dirt road. */ - MAPS_ROUTE_FEATURE_PARKS, /**< Indicates park. */ - MAPS_ROUTE_FEATURE_HOVLANE, /**< Indicates a high-occupancy vehicle lane. */ - MAPS_ROUTE_FEATURE_STAIRS /**< Indicates stairs. */ + MAPS_ROUTE_FEATURE_TUNNEL, /**< Indicates tunnel. */ + MAPS_ROUTE_FEATURE_DIRTROAD, /**< Indicates dirt road. */ + MAPS_ROUTE_FEATURE_PARKS, /**< Indicates park. */ + MAPS_ROUTE_FEATURE_HOVLANE, /**< Indicates a high-occupancy vehicle lane. */ + MAPS_ROUTE_FEATURE_STAIRS /**< Indicates stairs. */ } maps_route_feature_e; + /*----------------------------------------------------------------------------*/ + /** - * @brief Called when requesting the list of Maps Properties. - * @details This callback is invoked while iterating through the list of Maps - * Properties. + * @brief Called when requesting the list of Maps Properties. + * @details This callback is invoked while iterating through the list of Maps Properties. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a key and @a value must be released using free() and corresponding - * release method for property value correspondingly. - * - * @param[in] index The current index of property - * @param[in] total The total amount of properties - * @param[in] key The key of property - * @param[in] value The value of property - * @param[in] user_data The user data passed from - * maps_preference_foreach_property() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a key and @a value must be released using free() and corresponding release method for property value correspondingly. + * @param[in] index The current index of property + * @param[in] total The total amount of properties + * @param[in] key The key of property + * @param[in] value The value of property + * @param[in] user_data The user data passed from maps_preference_foreach_property() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_preference_foreach_property() will invoke this callback. - * * @see maps_preference_foreach_property() */ -typedef bool(*maps_preference_properties_cb) (int index, int total, char *key, - char *value, void *user_data); +typedef bool(*maps_preference_properties_cb) (int index, int total, char *key, char *value, void *user_data); + /*----------------------------------------------------------------------------*/ + /** - * @brief Creates a new maps preference handle. - * @details This function creates a new maps preference handle and allocates all - * needed resources. + * @brief Creates a new maps preference handle. + * @details This function creates a new maps preference handle and allocates all needed resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a preference must be released using maps_preference_destroy(). - * \n @a preference may be cloned using maps_preference_clone(). - * - * @param[out] preference A newly created preference handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a preference must be released using maps_preference_destroy().\n + * @a preference may be cloned using maps_preference_clone(). + * @param[out] preference A newly created preference handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_preference_destroy() * @see maps_preference_clone() */ int maps_preference_create(maps_preference_h *preference); + /** - * @brief Destroys the maps preference handle and releases all its - * resources. - * @details This function destroys the maps preference handle and releases all - * its resources. + * @brief Destroys the maps preference handle and releases all its resources. + * @details This function destroys the maps preference handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] preference The preference handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_preference_clone() */ int maps_preference_destroy(maps_preference_h preference); + /** - * @brief Clones the maps preference handle. - * @details This function clones the maps preference handle @a origin and all - * its resources. + * @brief Clones the maps preference handle. + * @details This function clones the maps preference handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_preference_destroy(). - * - * @param[in] origin The original preference handle - * @param[out] cloned A cloned preference handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original preference handle + * @param[out] cloned A cloned preference handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_preference_destroy() */ -int maps_preference_clone(const maps_preference_h origin, - maps_preference_h *cloned); +int maps_preference_clone(const maps_preference_h origin, maps_preference_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the distance unit. + * @brief Gets the distance unit. * @details This function gets the maps distance unit. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[out] unit The distance unit - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] preference The preference handle + * @param[out] unit The distance unit + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_preference_get_distance_unit(const maps_preference_h preference, - maps_distance_unit_e *unit); +int maps_preference_get_distance_unit(const maps_preference_h preference, maps_distance_unit_e *unit); + /** - * @brief Gets the language. + * @brief Gets the language. * @details This function gets the maps language. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a language must be released using free(). - * - * @param[in] preference The preference handle - * @param[out] language The language - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] preference The preference handle + * @param[out] language The language + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_preference_get_language(const maps_preference_h preference, - char **language); +int maps_preference_get_language(const maps_preference_h preference, char **language); + /** - * @brief Gets the max amount of results. + * @brief Gets the max amount of results. * @details This function gets the max amount of results. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[out] max_results The max amount of results - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] preference The preference handle + * @param[out] max_results The max amount of results + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_preference_get_max_results(const maps_preference_h preference, - int *max_results); +int maps_preference_get_max_results(const maps_preference_h preference, int *max_results); + /** - * @brief Gets the country code. + * @brief Gets the country code. * @details This function gets the country code. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a country_code must be released using free(). - * - * @param[in] preference The preference handle - * @param[out] country_code The country code - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] preference The preference handle + * @param[out] country_code The country code + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_preference_get_country_code(const maps_preference_h preference, - char **country_code); +int maps_preference_get_country_code(const maps_preference_h preference, char **country_code); + /** - * @brief Gets the route optimization. + * @brief Gets the route optimization. * @details This function gets the route optimization. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[out] optimization The route optimization - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] preference The preference handle + * @param[out] optimization The route optimization + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_preference_get_route_optimization(const maps_preference_h preference, - maps_route_optimization_e * optimization); +int maps_preference_get_route_optimization(const maps_preference_h preference, maps_route_optimization_e * optimization); + /** - * @brief Gets the route transport mode. + * @brief Gets the route transport mode. * @details This function gets the route transport mode. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[out] transport_mode The transport mode - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] preference The preference handle + * @param[out] transport_mode The transport mode + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_preference_get_route_transport_mode(const maps_preference_h preference, - maps_route_transport_mode_e *transport_mode); +int maps_preference_get_route_transport_mode(const maps_preference_h preference, maps_route_transport_mode_e *transport_mode); + /** - * @brief Gets the route feature weight. + * @brief Gets the route feature weight. * @details This function gets the route feature weight. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[out] feature_weight The feature weight - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] preference The preference handle + * @param[out] feature_weight The feature weight + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_preference_get_route_feature_weight(const maps_preference_h preference, - maps_route_feature_weight_e *feature_weight); +int maps_preference_get_route_feature_weight(const maps_preference_h preference, maps_route_feature_weight_e *feature_weight); + /** - * @brief Gets the route feature. + * @brief Gets the route feature. * @details This function gets the route feature. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[out] feature The feature - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] preference The preference handle + * @param[out] feature The feature + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_preference_get_route_feature(const maps_preference_h preference, - maps_route_feature_e *feature); +int maps_preference_get_route_feature(const maps_preference_h preference, maps_route_feature_e *feature); + /** - * @brief Gets the enable status of alternative routes. + * @brief Gets the enable status of alternative routes. * @details This function retrieves the enable status of alternative route. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[out] enable The enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] preference The preference handle + * @param[out] enable The enable status + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_preference_get_route_alternatives_enabled(const maps_preference_h preference, - bool *enable); +int maps_preference_get_route_alternatives_enabled(const maps_preference_h preference, bool *enable); + /** - * @brief Gets the departure time of a route. + * @brief Gets the departure time of a route. * @details This function retrieves the departure time of a route. - * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[out] time The departure time - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @since_tizen 4.0 + * @param[in] preference The preference handle + * @param[out] time The departure time + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter */ -int maps_preference_get_route_departure_time(const maps_preference_h preference, - time_t *time); +int maps_preference_get_route_departure_time(const maps_preference_h preference, time_t *time); + /** - * @brief Gets the maps preference value by key. + * @brief Gets the maps preference value by key. * @details This function gets the maps preference value by key. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a value must be released using free(). - * - * @param[in] preference The preference handle - * @param[in] key The preference key - * @param[out] value The preference value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] preference The preference handle + * @param[in] key The preference key + * @param[out] value The preference value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_preference_get(const maps_preference_h preference, - const char *key, char **value); +int maps_preference_get(const maps_preference_h preference, const char *key, char **value); + /** - * @brief Retrieves all maps properties. + * @brief Retrieves all maps properties. * @details This function retrieves all maps properties. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks The properties will be delivered via - * maps_preference_properties_cb(). - * - * @param[in] preference The preference handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_preference_properties_cb() repeatedly to - * retrieve each property. - * + * @remarks The properties will be delivered via maps_preference_properties_cb(). + * @param[in] preference The preference handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_preference_properties_cb() repeatedly to retrieve each property. * @see maps_preference_properties_cb() */ -int maps_preference_foreach_property(const maps_preference_h preference, - maps_preference_properties_cb callback, void *user_data); +int maps_preference_foreach_property(const maps_preference_h preference, maps_preference_properties_cb callback, void *user_data); + /*----------------------------------------------------------------------------*/ + /** - * @brief Sets the maps distance unit. + * @brief Sets the maps distance unit. * @details This function sets the maps distance unit. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[in] unit The distance unit - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] preference The preference handle + * @param[in] unit The distance unit + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a preference is created using maps_preference_create(). - * * @see maps_preference_create() * @see maps_preference_get_distance_unit() */ -int maps_preference_set_distance_unit(maps_preference_h preference, - const maps_distance_unit_e unit); +int maps_preference_set_distance_unit(maps_preference_h preference, const maps_distance_unit_e unit); + /** - * @brief Sets the maps language. + * @brief Sets the maps language. * @details This function sets the maps language. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[in] language The maps language. - * A language is specified as an ISO 3166 alpha-2 two letter country-code - * followed by ISO 639-1 for the two-letter language code. - * Each language tag is composed of one or more "subtags" separated by hyphens (-). - * Each subtag is composed of basic Latin letters or digits only. - * For example, "ko-KR" for Korean, "en-US" for American English. - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] preference The preference handle + * @param[in] language The maps language. + * A language is specified as an ISO 3166 alpha-2 two letter country-code + * followed by ISO 639-1 for the two-letter language code. + * Each language tag is composed of one or more "subtags" separated by hyphens (-). + * Each subtag is composed of basic Latin letters or digits only. + * For example, "ko-KR" for Korean, "en-US" for American English. + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a preference is created using maps_preference_create(). - * * @see maps_preference_create() * @see maps_preference_get_language() */ -int maps_preference_set_language(maps_preference_h preference, - const char *language); +int maps_preference_set_language(maps_preference_h preference, const char *language); + /** - * @brief Sets the max amount of results. + * @brief Sets the max amount of results. * @details This function sets the max amount of results. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[in] max_results The max amount of results - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] preference The preference handle + * @param[in] max_results The max amount of results + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a preference is created using maps_preference_create(). - * * @see maps_preference_create() * @see maps_preference_get_max_results() */ -int maps_preference_set_max_results(maps_preference_h preference, - const int max_results); +int maps_preference_set_max_results(maps_preference_h preference, const int max_results); + /** - * @brief Sets the maps country code. + * @brief Sets the maps country code. * @details This function sets the maps country code. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[in] country_code The maps country code - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] preference The preference handle + * @param[in] country_code The maps country code + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a preference is created using maps_preference_create(). - * * @see maps_preference_create() * @see maps_preference_get_country_code() */ -int maps_preference_set_country_code(maps_preference_h preference, - const char *country_code); +int maps_preference_set_country_code(maps_preference_h preference, const char *country_code); + /** - * @brief Sets the route optimization. + * @brief Sets the route optimization. * @details This function sets the route optimization. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[in] optimization The route optimization - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] preference The preference handle + * @param[in] optimization The route optimization + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a preference is created using maps_preference_create(). - * * @see maps_preference_create() * @see maps_preference_get_route_optimization() */ -int maps_preference_set_route_optimization(maps_preference_h preference, - const maps_route_optimization_e optimization); +int maps_preference_set_route_optimization(maps_preference_h preference, const maps_route_optimization_e optimization); + /** - * @brief Sets the route transport mode. + * @brief Sets the route transport mode. * @details This function sets the route transport mode. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[in] transport_mode The route transport mode - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] preference The preference handle + * @param[in] transport_mode The route transport mode + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a preference is created using maps_preference_create(). - * * @see maps_preference_create() * @see maps_preference_get_route_optimization() */ -int maps_preference_set_route_transport_mode(maps_preference_h preference, - const maps_route_transport_mode_e transport_mode); +int maps_preference_set_route_transport_mode(maps_preference_h preference, const maps_route_transport_mode_e transport_mode); + /** - * @brief Sets the route feature weight. + * @brief Sets the route feature weight. * @details This function sets the route feature weight. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[in] feature_weight The route feature weight - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] preference The preference handle + * @param[in] feature_weight The route feature weight + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a preference is created using maps_preference_create(). - * * @see maps_preference_create() * @see maps_preference_get_route_feature_weight() */ -int maps_preference_set_route_feature_weight(maps_preference_h preference, - const maps_route_feature_weight_e feature_weight); +int maps_preference_set_route_feature_weight(maps_preference_h preference, const maps_route_feature_weight_e feature_weight); + /** - * @brief Sets the route feature. + * @brief Sets the route feature. * @details This function sets the route feature. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[in] feature The route feature - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] preference The preference handle + * @param[in] feature The route feature + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a preference is created using maps_preference_create(). - * * @see maps_preference_create() * @see maps_preference_get_route_feature() */ -int maps_preference_set_route_feature(maps_preference_h preference, - const maps_route_feature_e feature); +int maps_preference_set_route_feature(maps_preference_h preference, const maps_route_feature_e feature); + /** - * @brief Sets the enable status of alternative routes. + * @brief Sets the enable status of alternative routes. * @details This function sets the alternative routes status. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[in] enable The value to set - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] preference The preference handle + * @param[in] enable The value to set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a preference is created using maps_preference_create(). - * * @see maps_preference_create() * @see maps_preference_get_route_alternatives_enabled() */ -int maps_preference_set_route_alternatives_enabled(maps_preference_h preference, - bool enable); +int maps_preference_set_route_alternatives_enabled(maps_preference_h preference, bool enable); + /** * @brief Sets the departure time of a route. * @details This function sets the departure time of a route. - * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[in] time The departure time - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @since_tizen 4.0 + * @param[in] preference The preference handle + * @param[in] time The departure time + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter */ -int maps_preference_set_route_departure_time(const maps_preference_h preference, - time_t time); +int maps_preference_set_route_departure_time(const maps_preference_h preference, time_t time); + /** - * @brief Sets the preference value by key. - * @details This function sets the preference value assigned with a specified - * key. + * @brief Sets the preference value by key. + * @details This function sets the preference value assigned with a specified key. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] preference The preference handle - * @param[in] key The key - * @param[in] value The value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] preference The preference handle + * @param[in] key The key + * @param[in] value The value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a preference is created using maps_preference_create(). - * * @see maps_preference_create() * @see maps_preference_get_property() * @see maps_preference_foreach_property() */ -int maps_preference_set_property(maps_preference_h preference, - const char *key, const char *value); +int maps_preference_set_property(maps_preference_h preference, const char *key, const char *value); + #ifdef __cplusplus } @@ -766,4 +720,4 @@ int maps_preference_set_property(maps_preference_h preference, /** * @} */ -#endif /* __MAPS_PREFERENCE_H__ */ +#endif /* __MAPS_PREFERENCE_H__ */ diff --git a/include/maps_route.h b/include/maps_route.h index 458b2dd..411d011 100644 --- a/include/maps_route.h +++ b/include/maps_route.h @@ -14,376 +14,337 @@ * limitations under the License. */ + #ifndef __MAPS_ROUTE_H__ #define __MAPS_ROUTE_H__ -#include + #include #include #include #include #include + /** - * @ingroup CAPI_MAPS_ROUTE_MODULE - * @defgroup CAPI_MAPS_ROUTE_DATA_MODULE Route - * + * @ingroup CAPI_MAPS_ROUTE_MODULE + * @defgroup CAPI_MAPS_ROUTE_DATA_MODULE Route * @file maps_route.h * @brief This file contains the functions related to Route information. - * * @addtogroup CAPI_MAPS_ROUTE_DATA_MODULE * @{ * @brief This provides APIs related to Route information, used in Route Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The Route handle + * @brief The Route handle. * @details The handle of Route instance. - * @remarks To release the handle use maps_route_destroy(). - * \n To clone the handle use maps_route_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_route_destroy().\n + * To clone the handle use maps_route_clone(). * @see maps_route_destroy() * @see maps_route_clone() */ typedef void *maps_route_h; + /*----------------------------------------------------------------------------*/ + /** - * @brief Called when requesting the path of the Route. - * @details This callback is invoked while iterating through the list of - * coordinates, composing the Route. + * @brief Called when requesting the path of the Route. + * @details This callback is invoked while iterating through the list of coordinates, composing the Route. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a coordinates must be released using maps_coordinates_destroy(). - * \n To use @a coordinates outside this function, clone it with - * maps_coordinates_clone(). - * - * @param[in] index The current index of path point - * @param[in] total The total amount of path points - * @param[in] coordinates The coordinates - * @param[in] user_data The user data passed from - * maps_route_foreach_path() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a coordinates must be released using maps_coordinates_destroy().\n + * To use @a coordinates outside this function, clone it with maps_coordinates_clone(). + * @param[in] index The current index of path point + * @param[in] total The total amount of path points + * @param[in] coordinates The coordinates + * @param[in] user_data The user data passed from maps_route_foreach_path() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_route_foreach_path() will invoke this callback. - * * @see maps_route_foreach_path() * @see #maps_coordinates_h */ -typedef bool(*maps_route_path_cb) (int index, int total, - maps_coordinates_h coordinates, - void *user_data); +typedef bool(*maps_route_path_cb) (int index, int total, maps_coordinates_h coordinates, void *user_data); + /** - * @brief Called when requesting the segments of the Route. - * @details This callback is invoked while iterating through the list of - * segments, composing the Route. + * @brief Called when requesting the segments of the Route. + * @details This callback is invoked while iterating through the list of segments, composing the Route. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a segment is valid only in this function and must be released using - * maps_route_segment_destroy(). - * \n To use @a segment outside this function, clone it with - * maps_route_segment_clone(). - * - * @param[in] index The current index of segment - * @param[in] total The total amount of segments - * @param[in] segment The segment or leg of route - * @param[in] user_data The user data passed from - * maps_route_foreach_segment() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a segment is valid only in this function and must be released using maps_route_segment_destroy().\n + * To use @a segment outside this function, clone it with maps_route_segment_clone(). + * @param[in] index The current index of segment + * @param[in] total The total amount of segments + * @param[in] segment The segment or leg of route + * @param[in] user_data The user data passed from maps_route_foreach_segment() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_route_foreach_segment() will invoke this callback. - * * @see maps_route_foreach_segment() * @see #maps_route_segment_h */ -typedef bool(*maps_route_segment_cb) (int index, int total, - maps_route_segment_h segment, - void *user_data); +typedef bool(*maps_route_segment_cb) (int index, int total, maps_route_segment_h segment, void *user_data); + /** - * @brief Called when requesting the list of Route Properties. - * @details This callback is invoked while iterating through the list of Route - * Properties. + * @brief Called when requesting the list of Route Properties. + * @details This callback is invoked while iterating through the list of Route Properties. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a key and @a value must be released using free() and corresponding - * release method for property value correspondingly. - * \n To use @a key and @a value outside this function, you should clone it. - * - * @param[in] index The current index of property - * @param[in] total The total amount of properties - * @param[in] key The key of property - * @param[in] value The value of property - * @param[in] user_data The user data passed from - * maps_route_foreach_property() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a key and @a value must be released using free() and corresponding release method for property value correspondingly.\n + * To use @a key and @a value outside this function, you should clone it. + * @param[in] index The current index of property + * @param[in] total The total amount of properties + * @param[in] key The key of property + * @param[in] value The value of property + * @param[in] user_data The user data passed from maps_route_foreach_property() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_route_foreach_property() will invoke this callback. - * * @see maps_route_foreach_property() */ -typedef bool(*maps_route_properties_cb) (int index, int total, char *key, - void *value, void *user_data); +typedef bool(*maps_route_properties_cb) (int index, int total, char *key, void *value, void *user_data); + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the route handle and releases all its resources. - * @details This function destroys the route handle and releases all its - * resources. + * @brief Destroys the route handle and releases all its resources. + * @details This function destroys the route handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] route The route handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] route The route handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_route_clone() */ int maps_route_destroy(maps_route_h route); + /** - * @brief Clones the route handle. - * @details This function clones the route handle @a origin and all its - * resources. + * @brief Clones the route handle. + * @details This function clones the route handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_route_destroy(). - * - * @param[in] origin The original route handle - * @param[out] cloned A cloned route handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original route handle + * @param[out] cloned A cloned route handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_route_destroy() */ int maps_route_clone(const maps_route_h origin, maps_route_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the route id. - * @details This function gets the route id. + * @brief Gets the route ID. + * @details This function gets the route ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a id must be released using free(). - * - * @param[in] route The route handle - * @param[out] route_id The id of route - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] route The route handle + * @param[out] route_id The ID of route + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ int maps_route_get_route_id(const maps_route_h route, char **route_id); + /** - * @brief Gets the route origin. + * @brief Gets the route origin. * @details This function gets the route origin. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a origin must be released using maps_coordinates_destroy(). - * - * @param[in] route The route handle - * @param[out] origin The origin of route - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] route The route handle + * @param[out] origin The origin of route + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_route_get_destination() * @see #maps_coordinates_h */ -int maps_route_get_origin(const maps_route_h route, - maps_coordinates_h *origin); +int maps_route_get_origin(const maps_route_h route, maps_coordinates_h *origin); + /** - * @brief Gets the route destination. + * @brief Gets the route destination. * @details This function gets the route destination. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a destination must be released using maps_coordinates_destroy(). - * - * @param[in] route The route handle - * @param[out] destination The destination of route - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] route The route handle + * @param[out] destination The destination of route + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_route_get_origin() * @see #maps_coordinates_h */ -int maps_route_get_destination(const maps_route_h route, - maps_coordinates_h *destination); +int maps_route_get_destination(const maps_route_h route, maps_coordinates_h *destination); + /** - * @brief Gets the route bounding box. + * @brief Gets the route bounding box. * @details This function gets the route bounding box. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a bounding_box must be released using maps_area_destroy(). - * - * @param[in] route The route handle - * @param[out] bounding_box The bounding box of route - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] route The route handle + * @param[out] bounding_box The bounding box of route + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_area_h */ -int maps_route_get_bounding_box(const maps_route_h route, - maps_area_h *bounding_box); +int maps_route_get_bounding_box(const maps_route_h route, maps_area_h *bounding_box); + /** - * @brief Gets the route transport mode. + * @brief Gets the route transport mode. * @details This function gets the route transport mode. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] route The route handle - * @param[out] transport_mode The transport mode - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] route The route handle + * @param[out] transport_mode The transport mode + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_route_transport_mode_e */ -int maps_route_get_transport_mode(const maps_route_h route, - maps_route_transport_mode_e *transport_mode); +int maps_route_get_transport_mode(const maps_route_h route, maps_route_transport_mode_e *transport_mode); + /** - * @brief Gets the route total distance. + * @brief Gets the route total distance. * @details This function gets the route total distance. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] route The route handle - * @param[out] total_distance The distance of route. You can get the distance - * unit by route_get_distance_unit() - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] route The route handle + * @param[out] total_distance The distance of route. You can get the distance unit by route_get_distance_unit() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_route_get_total_duration() */ -int maps_route_get_total_distance(const maps_route_h route, - double *total_distance); +int maps_route_get_total_distance(const maps_route_h route, double *total_distance); + /** - * @brief Gets the route total duration. + * @brief Gets the route total duration. * @details This function gets the route total duration. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] route The route handle - * @param[out] total_duration The duration - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] route The route handle + * @param[out] total_duration The duration + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_route_get_total_distance() */ -int maps_route_get_total_duration(const maps_route_h route, - long *total_duration); +int maps_route_get_total_duration(const maps_route_h route, long *total_duration); + /** - * @brief Gets the route distance units. + * @brief Gets the route distance units. * @details This function gets the route distance units. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] route The route handle - * @param[out] distance_unit The distance units - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] route The route handle + * @param[out] distance_unit The distance units + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_distance_unit_e */ -int maps_route_get_distance_unit(const maps_route_h route, - maps_distance_unit_e *distance_unit); +int maps_route_get_distance_unit(const maps_route_h route, maps_distance_unit_e *distance_unit); + /** - * @brief Retrieves all properties. + * @brief Retrieves all properties. * @details This function retrieves all route properties. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The properties will be delivered via maps_route_properties_cb(). - * - * @param[in] route The route handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_route_properties_cb() repeatedly to retrieve - * each property. - * + * @param[in] route The route handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_route_properties_cb() repeatedly to retrieve each property. * @see maps_route_properties_cb() */ -int maps_route_foreach_property(const maps_route_h route, - maps_route_properties_cb callback, - void *user_data); +int maps_route_foreach_property(const maps_route_h route, maps_route_properties_cb callback, void *user_data); + /** - * @brief Retrieves all coordinates of the path. + * @brief Retrieves all coordinates of the path. * @details This function retrieves all coordinates of the route path. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The coordinates will be delivered via maps_route_path_cb(). - * - * @param[in] route The route handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_route_path_cb() repeatedly to retrieve each - * coordinate point. - * + * @param[in] route The route handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_route_path_cb() repeatedly to retrieve each coordinate point. * @see maps_route_path_cb() */ -int maps_route_foreach_path(const maps_route_h route, - maps_route_path_cb callback, void *user_data); +int maps_route_foreach_path(const maps_route_h route, maps_route_path_cb callback, void *user_data); + /** - * @brief Retrieves all segments of the route. + * @brief Retrieves all segments of the route. * @details This function retrieves all segments of the route. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The segments will be delivered via maps_route_path_cb(). - * - * @param[in] route The route handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_route_segment_cb() repeatedly to retrieve - * each segment. - * + * @param[in] route The route handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_route_segment_cb() repeatedly to retrieve each segment. * @see maps_route_segment_cb() */ -int maps_route_foreach_segment(const maps_route_h route, - maps_route_segment_cb callback, - void *user_data); +int maps_route_foreach_segment(const maps_route_h route, maps_route_segment_cb callback, void *user_data); + #ifdef __cplusplus } @@ -391,4 +352,4 @@ int maps_route_foreach_segment(const maps_route_h route, /** * @} */ -#endif /* __MAPS_ROUTE_H__ */ +#endif /* __MAPS_ROUTE_H__ */ diff --git a/include/maps_route_maneuver.h b/include/maps_route_maneuver.h index e14aafd..5dd6085 100644 --- a/include/maps_route_maneuver.h +++ b/include/maps_route_maneuver.h @@ -14,260 +14,248 @@ * limitations under the License. */ + #ifndef __MAPS_MANEUVER_H__ #define __MAPS_MANEUVER_H__ + #include + /** - * @ingroup CAPI_MAPS_ROUTE_MODULE - * @defgroup CAPI_MAPS_ROUTE_MANEUVER_MODULE Maneuver - * + * @ingroup CAPI_MAPS_ROUTE_MODULE + * @defgroup CAPI_MAPS_ROUTE_MANEUVER_MODULE Maneuver * @file maps_route_maneuver.h - * @brief This file contains the functions related to Route Maneuver - * information. + * @brief This file contains the functions related to Route Maneuver information. * @addtogroup CAPI_MAPS_ROUTE_MANEUVER_MODULE * @{ - * @brief This provides APIs related to Place Maneuver information, used in - * Route Search. + * @brief This provides APIs related to Place Maneuver information, used in Route Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The Route Maneuver handle + * @brief The Route Maneuver handle. * @details The handle of Route Maneuver instance. - * @remarks To release the handle use maps_route_maneuver_destroy(). - * \n To clone the handle use maps_route_maneuver_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_route_maneuver_destroy().\n + * To clone the handle use maps_route_maneuver_clone(). * @see maps_route_maneuver_destroy() * @see maps_route_maneuver_clone() */ typedef void *maps_route_maneuver_h; + /** - * @brief The enumeration of direction type. + * @brief Enumeration for direction type. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ typedef enum { - MAPS_ROUTE_DIRECTION_NONE, /**< Indicates unknown direction */ - MAPS_ROUTE_DIRECTION_NORTH, /**< Indicates north direction */ - MAPS_ROUTE_DIRECTION_NORTHWEST, /**< Indicates north-west direction */ - MAPS_ROUTE_DIRECTION_NORTHEAST, /**< Indicates north-east direction */ - MAPS_ROUTE_DIRECTION_SOUTH, /**< Indicates south direction */ - MAPS_ROUTE_DIRECTION_SOUTHEAST, /**< Indicates south-east direction */ - MAPS_ROUTE_DIRECTION_SOUTHWEST, /**< Indicates south-west direction */ - MAPS_ROUTE_DIRECTION_WEST, /**< Indicates west direction */ - MAPS_ROUTE_DIRECTION_EAST /**< Indicates east direction */ + MAPS_ROUTE_DIRECTION_NONE, /**< Indicates unknown direction */ + MAPS_ROUTE_DIRECTION_NORTH, /**< Indicates north direction */ + MAPS_ROUTE_DIRECTION_NORTHWEST, /**< Indicates north-west direction */ + MAPS_ROUTE_DIRECTION_NORTHEAST, /**< Indicates north-east direction */ + MAPS_ROUTE_DIRECTION_SOUTH, /**< Indicates south direction */ + MAPS_ROUTE_DIRECTION_SOUTHEAST, /**< Indicates south-east direction */ + MAPS_ROUTE_DIRECTION_SOUTHWEST, /**< Indicates south-west direction */ + MAPS_ROUTE_DIRECTION_WEST, /**< Indicates west direction */ + MAPS_ROUTE_DIRECTION_EAST /**< Indicates east direction */ } maps_route_direction_e; + /** - * @brief The enumeration of turn type. + * @brief Enumeration for the turn type. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ typedef enum { - MAPS_ROUTE_TURN_TYPE_NONE, /**< Indicates unknown instruction. */ - MAPS_ROUTE_TURN_TYPE_STRAIGHT, /**< Indicates instruction to move straight */ - MAPS_ROUTE_TURN_TYPE_BEAR_RIGHT, /**< Indicates instruction to bear right. */ - MAPS_ROUTE_TURN_TYPE_LIGHT_RIGHT, /**< Indicates instruction slightly to the right. */ - MAPS_ROUTE_TURN_TYPE_RIGHT, /**< Indicates instruction to turn right. */ - MAPS_ROUTE_TURN_TYPE_HARD_RIGHT, /**< Indicates instruction to turn hard to the right. */ - MAPS_ROUTE_TURN_TYPE_UTURN_RIGHT, /**< Indicates instruction to u-turn to the right. */ - MAPS_ROUTE_TURN_TYPE_UTURN_LEFT, /**< Indicates instruction to u-turn to the left. */ - MAPS_ROUTE_TURN_TYPE_HARD_LEFT, /**< Indicates instruction to turn hard to the left. */ - MAPS_ROUTE_TURN_TYPE_LEFT, /**< Indicates instruction to turn left. */ - MAPS_ROUTE_TURN_TYPE_LIGHT_LEFT, /**< Indicates instruction to turn lightly to the left. */ - MAPS_ROUTE_TURN_TYPE_BEAR_LEFT, /**< Indicates instruction to bear left. */ - MAPS_ROUTE_TURN_TYPE_RIGHT_FORK, /**< Indicates right fork instruction. */ - MAPS_ROUTE_TURN_TYPE_LEFT_FORK, /**< Indicates left fork instruction. */ - MAPS_ROUTE_TURN_TYPE_STRAIGHT_FORK /**< Indicates straight fork instruction. */ + MAPS_ROUTE_TURN_TYPE_NONE, /**< Indicates unknown instruction. */ + MAPS_ROUTE_TURN_TYPE_STRAIGHT, /**< Indicates instruction to move straight */ + MAPS_ROUTE_TURN_TYPE_BEAR_RIGHT, /**< Indicates instruction to bear right. */ + MAPS_ROUTE_TURN_TYPE_LIGHT_RIGHT, /**< Indicates instruction slightly to the right. */ + MAPS_ROUTE_TURN_TYPE_RIGHT, /**< Indicates instruction to turn right. */ + MAPS_ROUTE_TURN_TYPE_HARD_RIGHT, /**< Indicates instruction to turn hard to the right. */ + MAPS_ROUTE_TURN_TYPE_UTURN_RIGHT, /**< Indicates instruction to u-turn to the right. */ + MAPS_ROUTE_TURN_TYPE_UTURN_LEFT, /**< Indicates instruction to u-turn to the left. */ + MAPS_ROUTE_TURN_TYPE_HARD_LEFT, /**< Indicates instruction to turn hard to the left. */ + MAPS_ROUTE_TURN_TYPE_LEFT, /**< Indicates instruction to turn left. */ + MAPS_ROUTE_TURN_TYPE_LIGHT_LEFT, /**< Indicates instruction to turn lightly to the left. */ + MAPS_ROUTE_TURN_TYPE_BEAR_LEFT, /**< Indicates instruction to bear left. */ + MAPS_ROUTE_TURN_TYPE_RIGHT_FORK, /**< Indicates right fork instruction. */ + MAPS_ROUTE_TURN_TYPE_LEFT_FORK, /**< Indicates left fork instruction. */ + MAPS_ROUTE_TURN_TYPE_STRAIGHT_FORK /**< Indicates straight fork instruction. */ } maps_route_turn_type_e; + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the route maneuver handle and releases all its - * resources. - * @details This function destroys the route maneuver handle and releases all - * its resources. + * @brief Destroys the route Maneuver handle and releases all its resources. + * @details This function destroys the route Maneuver handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] maneuver The maneuver handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] maneuver The Maneuver handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_route_maneuver_clone() */ int maps_route_maneuver_destroy(maps_route_maneuver_h maneuver); + /** - * @brief Clones the route maneuver handle. - * @details This function clones the route maneuver handle @a origin and all its - * resources. + * @brief Clones the route Maneuver handle. + * @details This function clones the route Maneuver handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_route_maneuver_destroy(). - * - * @param[in] origin The original maneuver handle - * @param[out] cloned A cloned maneuver handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original Maneuver handle + * @param[out] cloned A cloned Maneuver handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_route_maneuver_destroy() */ -int maps_route_maneuver_clone(const maps_route_maneuver_h origin, - maps_route_maneuver_h *cloned); +int maps_route_maneuver_clone(const maps_route_maneuver_h origin, maps_route_maneuver_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the route maneuver direction id. - * @details This function gets the route maneuver direction id. + * @brief Gets the route Maneuver direction ID. + * @details This function gets the route Maneuver direction ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] maneuver The maneuver handle - * @param[out] direction_id The direction ID - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] maneuver The Maneuver handle + * @param[out] direction_id The direction ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_route_direction_e */ -int maps_route_maneuver_get_direction_id(const maps_route_maneuver_h maneuver, - maps_route_direction_e *direction_id); +int maps_route_maneuver_get_direction_id(const maps_route_maneuver_h maneuver, maps_route_direction_e *direction_id); + /** - * @brief Gets the route maneuver turn type. - * @details This function gets the route maneuver turn type. + * @brief Gets the route Maneuver turn type. + * @details This function gets the route Maneuver turn type. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] maneuver The maneuver handle - * @param[out] turn_type The turn type - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] maneuver The Maneuver handle + * @param[out] turn_type The turn type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_route_turn_type_e */ -int maps_route_maneuver_get_turn_type(const maps_route_maneuver_h maneuver, - maps_route_turn_type_e *turn_type); +int maps_route_maneuver_get_turn_type(const maps_route_maneuver_h maneuver, maps_route_turn_type_e *turn_type); + /** - * @brief Gets the route maneuver position. - * @details This function gets the route maneuver position. + * @brief Gets the route Maneuver position. + * @details This function gets the route Maneuver position. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a position must be released using maps_coordinates_destroy(). - * - * @param[in] maneuver The maneuver handle - * @param[out] position The start position of the maneuver - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] maneuver The Maneuver handle + * @param[out] position The start position of the Maneuver + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_coordinates_h */ -int maps_route_maneuver_get_position(const maps_route_maneuver_h maneuver, - maps_coordinates_h *position); +int maps_route_maneuver_get_position(const maps_route_maneuver_h maneuver, maps_coordinates_h *position); + /** - * @brief Gets the road name of the route maneuver. - * @details This function gets the road name of the route maneuver. + * @brief Gets the road name of the route Maneuver. + * @details This function gets the road name of the route Maneuver. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a road_name must be released using free(). - * - * @param[in] maneuver The maneuver handle - * @param[out] road_name The current road name of the maneuver handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The Maneuver handle + * @param[out] road_name The current road name of the Maneuver handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_route_maneuver_get_road_name(const maps_route_maneuver_h maneuver, - char **road_name); +int maps_route_maneuver_get_road_name(const maps_route_maneuver_h maneuver, char **road_name); + /** * - * @brief Gets the instruction text (narrative) of the route maneuver. - * @details This function gets the instruction text (narrative) of the route - * maneuver. + * @brief Gets the instruction text (narrative) of the route Maneuver. + * @details This function gets the instruction text (narrative) of the route Maneuver. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a instruction_text must be released using free(). - * - * @param[in] maneuver The maneuver handle - * @param[in] instruction_text The instruction text - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The Maneuver handle + * @param[in] instruction_text The instruction text + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_route_maneuver_get_instruction_text(const maps_route_maneuver_h - maneuver, - char **instruction_text); +int maps_route_maneuver_get_instruction_text(const maps_route_maneuver_h maneuver, char **instruction_text); + /** - * @brief Gets the route maneuver locale. - * @details This function gets the route maneuver locale. + * @brief Gets the route Maneuver locale. + * @details This function gets the route Maneuver locale. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a locale must be released using free(). - * - * @param[in] maneuver The maneuver handle - * @param[out] locale The languages of instruction text and street - * name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The Maneuver handle + * @param[out] locale The languages of instruction text and street name + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_route_maneuver_get_locale(const maps_route_maneuver_h maneuver, - char **locale); +int maps_route_maneuver_get_locale(const maps_route_maneuver_h maneuver, char **locale); + /** - * @brief Gets the time to next instruction of the route maneuver. - * @details This function gets the time to next instruction of the route - * maneuver. + * @brief Gets the time to next instruction of the route Maneuver. + * @details This function gets the time to next instruction of the route Maneuver. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] maneuver The maneuver handle - * @param[out] time_to_next_instruction The time to next instruction on the - * given maneuver - * handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The Maneuver handle + * @param[out] time_to_next_instruction The time to next instruction on the given Maneuver handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_route_maneuver_get_time_to_next_instruction(const maps_route_maneuver_h - maneuver, - int *time_to_next_instruction); +int maps_route_maneuver_get_time_to_next_instruction(const maps_route_maneuver_h maneuver, int *time_to_next_instruction); + /** - * @brief Gets the distance to next instruction of the route maneuver. - * @details This function gets the distance to next instruction of the route - * maneuver. + * @brief Gets the distance to next instruction of the route Maneuver. + * @details This function gets the distance to next instruction of the route Maneuver. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] maneuver The maneuver handle - * @param[out] distance_to_next_instruction The distance from the current - * maneuver to the next maneuver - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The Maneuver handle + * @param[out] distance_to_next_instruction The distance from the current Maneuver to the next Maneuver + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_route_maneuver_get_distance_to_next_instruction(const - maps_route_maneuver_h - maneuver, - double *distance_to_next_instruction); +int maps_route_maneuver_get_distance_to_next_instruction(const maps_route_maneuver_h maneuver, double *distance_to_next_instruction); + #ifdef __cplusplus } @@ -275,4 +263,4 @@ int maps_route_maneuver_get_distance_to_next_instruction(const /** * @} */ -#endif /* __MAPS_MANEUVER_H__ */ +#endif /* __MAPS_MANEUVER_H__ */ diff --git a/include/maps_route_maneuver_plugin.h b/include/maps_route_maneuver_plugin.h index 35c4609..495446e 100644 --- a/include/maps_route_maneuver_plugin.h +++ b/include/maps_route_maneuver_plugin.h @@ -20,8 +20,8 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_ROUTE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_ROUTE_MANEUVER_MODULE Maneuver + * @ingroup CAPI_MAPS_PLUGIN_ROUTE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_ROUTE_MANEUVER_MODULE Maneuver * * @file maps_route_maneuver_plugin.h * @brief This file contains the functions related to Route Maneuver @@ -37,19 +37,19 @@ extern "C" { #endif /** - * @brief Creates a new route maneuver handle. + * @brief Creates a new route maneuver handle. * @details This function creates a new route maneuver handle and allocates all * needed resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a maneuver must be released using maps_route_maneuver_destroy(). * \n @a maneuver may be cloned using maps_route_maneuver_clone(). * - * @param[out] maneuver The maneuver handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] maneuver The maneuver handle + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_route_maneuver_destroy() * @see maps_route_maneuver_clone() @@ -57,16 +57,16 @@ extern "C" { int maps_route_maneuver_create(maps_route_maneuver_h *maneuver); /** - * @brief Sets the route maneuver direction id. - * @details This function sets the route maneuver direction id. + * @brief Sets the route maneuver direction ID. + * @details This function sets the route maneuver direction ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] maneuver The maneuver handle - * @param[in] direction_id The direction ID - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The maneuver handle + * @param[in] direction_id The direction ID + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a maneuver is created using maps_route_maneuver_create(). * @@ -74,21 +74,19 @@ int maps_route_maneuver_create(maps_route_maneuver_h *maneuver); * @see maps_route_maneuver_get_direction_id() * @see #maps_route_direction_e */ -int maps_route_maneuver_set_direction_id(maps_route_maneuver_h maneuver, - const maps_route_direction_e - direction_id); +int maps_route_maneuver_set_direction_id(maps_route_maneuver_h maneuver, const maps_route_direction_e direction_id); /** - * @brief Sets the route maneuver turn type. + * @brief Sets the route maneuver turn type. * @details This function sets the route maneuver turn type. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] maneuver The maneuver handle - * @param[in] turn_type The turn type - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The maneuver handle + * @param[in] turn_type The turn type + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a maneuver is created using maps_route_maneuver_create(). * @@ -96,133 +94,123 @@ int maps_route_maneuver_set_direction_id(maps_route_maneuver_h maneuver, * @see maps_route_maneuver_get_turn_type() * @see #maps_route_turn_type_e */ -int maps_route_maneuver_set_turn_type(maps_route_maneuver_h maneuver, - const maps_route_turn_type_e turn_type); +int maps_route_maneuver_set_turn_type(maps_route_maneuver_h maneuver, const maps_route_turn_type_e turn_type); /** - * @brief Sets the route maneuver road name. + * @brief Sets the route maneuver road name. * @details This function sets the route maneuver road name. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] maneuver The maneuver handle - * @param[in] road_name The current road name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The maneuver handle + * @param[in] road_name The current road name + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a maneuver is created using maps_route_maneuver_create(). * * @see maps_route_maneuver_create() * @see maps_route_maneuver_get_road_name() */ -int maps_route_maneuver_set_road_name(maps_route_maneuver_h maneuver, - const char *road_name); +int maps_route_maneuver_set_road_name(maps_route_maneuver_h maneuver, const char *road_name); /** - * @brief Sets the route maneuver instruction text. + * @brief Sets the route maneuver instruction text. * @details This function sets the route maneuver instruction text. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] maneuver The maneuver handle - * @param[in] instruction_text The current road name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The maneuver handle + * @param[in] instruction_text The current road name + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a maneuver is created using maps_route_maneuver_create(). * * @see maps_route_maneuver_create() * @see maps_route_maneuver_get_instruction_text() */ -int maps_route_maneuver_set_instruction_text(maps_route_maneuver_h maneuver, - const char *instruction_text); +int maps_route_maneuver_set_instruction_text(maps_route_maneuver_h maneuver, const char *instruction_text); /** - * @brief Sets the route maneuver locale. + * @brief Sets the route maneuver locale. * @details This function sets the route maneuver locale. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] maneuver The maneuver handle - * @param[in] locale The languages of instruction text and street - * name - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The maneuver handle + * @param[in] locale The languages of instruction text and street name + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a maneuver is created using maps_route_maneuver_create(). * * @see maps_route_maneuver_create() * @see maps_route_maneuver_get_locale() */ -int maps_route_maneuver_set_locale(maps_route_maneuver_h maneuver, - const char *locale); +int maps_route_maneuver_set_locale(maps_route_maneuver_h maneuver, const char *locale); /** - * @brief Sets the route maneuver position. + * @brief Sets the route maneuver position. * @details This function sets the route maneuver position. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] maneuver The maneuver handle - * @param[in] position The geographical position of maneuver - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The maneuver handle + * @param[in] position The geographical position of maneuver + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a maneuver is created using maps_route_maneuver_create(). * * @see maps_route_maneuver_create() * @see maps_route_maneuver_get_position() */ -int maps_route_maneuver_set_position(maps_route_maneuver_h maneuver, - const maps_coordinates_h position); +int maps_route_maneuver_set_position(maps_route_maneuver_h maneuver, const maps_coordinates_h position); /** - * @brief Sets the time to next instruction in route maneuver. + * @brief Sets the time to next instruction in route maneuver. * @details This function sets the time to next instruction in route maneuver. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] maneuver The maneuver handle - * @param[in] time_to_next_instruction The time to next instruction - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The maneuver handle + * @param[in] time_to_next_instruction The time to next instruction + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a maneuver is created using maps_route_maneuver_create(). * * @see maps_route_maneuver_create() * @see maps_route_maneuver_get_time_to_next_instruction() */ -int maps_route_maneuver_set_time_to_next_instruction(maps_route_maneuver_h - maneuver, - const int time_to_next_instruction); +int maps_route_maneuver_set_time_to_next_instruction(maps_route_maneuver_h maneuver, const int time_to_next_instruction); /** - * @brief Sets the distance to next instruction in route maneuver. + * @brief Sets the distance to next instruction in route maneuver. * @details This function sets the distance to next instruction in route * maneuver. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] maneuver The maneuver handle - * @param[in] distance_to_next_instruction The distance from the current + * @param[in] maneuver The maneuver handle + * @param[in] distance_to_next_instruction The distance from the current * maneuver to the next maneuver - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a maneuver is created using maps_route_maneuver_create(). * * @see maps_route_maneuver_create() * @see maps_route_maneuver_get_distance_to_next_instruction() */ -int maps_route_maneuver_set_distance_to_next_instruction(maps_route_maneuver_h - maneuver, - const double distance_to_next_instruction); +int maps_route_maneuver_set_distance_to_next_instruction(maps_route_maneuver_h maneuver, const double distance_to_next_instruction); #ifdef __cplusplus } @@ -230,4 +218,4 @@ int maps_route_maneuver_set_distance_to_next_instruction(maps_route_maneuver_h /** * @} */ -#endif /* __MAPS_MANEUVER_PLUGIN_H__ */ +#endif /* __MAPS_MANEUVER_PLUGIN_H__ */ diff --git a/include/maps_route_plugin.h b/include/maps_route_plugin.h index 6cd08b6..219ede4 100644 --- a/include/maps_route_plugin.h +++ b/include/maps_route_plugin.h @@ -21,14 +21,14 @@ #include /** - * @ingroup CAPI_MAPS_PLUGIN_MODULE - * @defgroup CAPI_MAPS_PLUGIN_ROUTE_MODULE Routes + * @ingroup CAPI_MAPS_PLUGIN_MODULE + * @defgroup CAPI_MAPS_PLUGIN_ROUTE_MODULE Routes */ /** * - * @ingroup CAPI_MAPS_PLUGIN_ROUTE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_ROUTE_DATA_MODULE Route + * @ingroup CAPI_MAPS_PLUGIN_ROUTE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_ROUTE_DATA_MODULE Route * * @file maps_route_plugin.h * @brief This file contains the functions related to Route @@ -45,19 +45,19 @@ extern "C" { #endif /** - * @brief Creates a new route handle. + * @brief Creates a new route handle. * @details This function creates a new route handle and allocates all needed * resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a route must be released using maps_route_destroy(). * \n @a route may be cloned using maps_route_clone(). * - * @param[out] route A newly created route handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] route A newly created route handle + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_route_destroy() * @see maps_route_clone() @@ -65,16 +65,16 @@ extern "C" { int maps_route_create(maps_route_h *route); /** - * @brief Sets the route id. - * @details This function sets the route id. + * @brief Sets the route ID. + * @details This function sets the route ID. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] route The route handle - * @param[in] id The route ID - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] route The route handle + * @param[in] id The route ID + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a route is created using maps_route_create(). * @@ -84,16 +84,16 @@ int maps_route_create(maps_route_h *route); int maps_route_set_route_id(maps_route_h route, const char *id); /** - * @brief Sets the route origin. + * @brief Sets the route origin. * @details This function sets the route origin. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] route The route handle - * @param[in] origin The origin of route - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] route The route handle + * @param[in] origin The origin of route + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a route is created using maps_route_create(). * @@ -101,20 +101,19 @@ int maps_route_set_route_id(maps_route_h route, const char *id); * @see maps_route_get_origin() * @see maps_route_set_destination() */ -int maps_route_set_origin(maps_route_h route, - const maps_coordinates_h origin); +int maps_route_set_origin(maps_route_h route, const maps_coordinates_h origin); /** - * @brief Sets the route destination. + * @brief Sets the route destination. * @details This function sets the route destination. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] route The route handle - * @param[in] destination The destination of route - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] route The route handle + * @param[in] destination The destination of route + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a route is created using maps_route_create(). * @@ -122,80 +121,76 @@ int maps_route_set_origin(maps_route_h route, * @see maps_route_get_destination() * @see maps_route_set_origin() */ -int maps_route_set_destination(maps_route_h route, - const maps_coordinates_h destination); +int maps_route_set_destination(maps_route_h route, const maps_coordinates_h destination); /** - * @brief Sets the route bounding box. + * @brief Sets the route bounding box. * @details This function sets the route bounding box. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] route The route handle - * @param[in] bounding_box The top bounding box - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] route The route handle + * @param[in] bounding_box The top bounding box + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a route is created using maps_route_create(). * * @see maps_route_create() * @see maps_route_get_bounding_box() */ -int maps_route_set_bounding_box(maps_route_h route, - const maps_area_h bounding_box); +int maps_route_set_bounding_box(maps_route_h route, const maps_area_h bounding_box); /** - * @brief Sets the route total distance. + * @brief Sets the route total distance. * @details This function sets the route total distance. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] route The route handle - * @param[in] total_distance The distance of route in meters - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] route The route handle + * @param[in] total_distance The distance of route in meters + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a route is created using maps_route_create(). * * @see maps_route_create() * @see maps_route_get_total_distance() */ -int maps_route_set_total_distance(maps_route_h route, - const double total_distance); +int maps_route_set_total_distance(maps_route_h route, const double total_distance); /** - * @brief Sets the route total duration. + * @brief Sets the route total duration. * @details This function sets the route total duration. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] route The route handle - * @param[in] total_duration The duration - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] route The route handle + * @param[in] total_duration The duration + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a route is created using maps_route_create(). * * @see maps_route_create() * @see maps_route_get_total_duration() */ -int maps_route_set_total_duration(maps_route_h route, - const long total_duration); +int maps_route_set_total_duration(maps_route_h route, const long total_duration); /** - * @brief Sets the route transport mode. + * @brief Sets the route transport mode. * @details This function sets the route transport mode. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] route The route handle - * @param[in] transport_mode The transportation mode - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] route The route handle + * @param[in] transport_mode The transportation mode + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a route is created using maps_route_create(). * @@ -203,21 +198,19 @@ int maps_route_set_total_duration(maps_route_h route, * @see maps_route_get_transport_mode() * @see #maps_route_transport_mode_e */ -int maps_route_set_transport_mode(maps_route_h route, - const maps_route_transport_mode_e - transport_mode); +int maps_route_set_transport_mode(maps_route_h route, const maps_route_transport_mode_e transport_mode); /** - * @brief Sets the route distance units. + * @brief Sets the route distance units. * @details This function sets the route distance units. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] maneuver The maneuver handle - * @param[in] distance_unit The distance units - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] maneuver The maneuver handle + * @param[in] distance_unit The distance units + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a route is created using maps_route_create(). * @@ -225,20 +218,19 @@ int maps_route_set_transport_mode(maps_route_h route, * @see maps_route_get_distance_unit() * @see #maps_distance_unit_e */ -int maps_route_set_distance_unit(maps_route_maneuver_h maneuver, - const maps_distance_unit_e distance_unit); +int maps_route_set_distance_unit(maps_route_maneuver_h maneuver, const maps_distance_unit_e distance_unit); /** - * @brief Sets the route path. + * @brief Sets the route path. * @details This function sets the route path. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] route The route handle - * @param[in] path The coordinates list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] route The route handle + * @param[in] path The coordinates list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a route is created using maps_route_create(). * @@ -248,16 +240,16 @@ int maps_route_set_distance_unit(maps_route_maneuver_h maneuver, int maps_route_set_path(maps_route_h route, const maps_item_list_h path); /** - * @brief Sets the route segment list. + * @brief Sets the route segment list. * @details This function sets the route segment list. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] route The route handle - * @param[in] segments The maneuvers list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] route The route handle + * @param[in] segments The maneuvers list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a route is created using maps_route_create(). * @@ -265,28 +257,26 @@ int maps_route_set_path(maps_route_h route, const maps_item_list_h path); * @see maps_route_foreach_segment() */ -int maps_route_set_segments(maps_route_h route, - const maps_item_list_h segments); +int maps_route_set_segments(maps_route_h route, const maps_item_list_h segments); /** - * @brief Sets the route properties. + * @brief Sets the route properties. * @details This function sets the route properties. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] route The route handle - * @param[in] properties The table of properties - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] route The route handle + * @param[in] properties The table of properties + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a route is created using maps_route_create(). * * @see maps_route_create() * @see maps_route_foreach_property() */ -int maps_route_set_properties(maps_route_h route, - const maps_item_hashtable_h properties); +int maps_route_set_properties(maps_route_h route, const maps_item_hashtable_h properties); #ifdef __cplusplus } @@ -294,4 +284,4 @@ int maps_route_set_properties(maps_route_h route, /** * @} */ -#endif /* __MAPS_ROUTE_PLUGIN_H__ */ +#endif /* __MAPS_ROUTE_PLUGIN_H__ */ diff --git a/include/maps_route_segment.h b/include/maps_route_segment.h index 2ab28ae..592e2b0 100644 --- a/include/maps_route_segment.h +++ b/include/maps_route_segment.h @@ -14,18 +14,20 @@ * limitations under the License. */ + #ifndef __MAPS_SEGMENT_H__ #define __MAPS_SEGMENT_H__ + #include #include #include #include + /** - * @ingroup CAPI_MAPS_ROUTE_MODULE - * @defgroup CAPI_MAPS_ROUTE_SEGMENT_MODULE Segment - * + * @ingroup CAPI_MAPS_ROUTE_MODULE + * @defgroup CAPI_MAPS_ROUTE_SEGMENT_MODULE Segment * @file maps_route_segment.h * @brief This file contains the functions related to Route Segment information. * @addtogroup CAPI_MAPS_ROUTE_SEGMENT_MODULE @@ -34,249 +36,221 @@ * Search. */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The Route Segment handle + * @brief The Route Segment handle. * @details The handle of Route Segment instance. - * @remarks To release the handle use maps_route_segment_destroy(). - * \n To clone the handle use maps_route_segment_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_route_segment_destroy().\n + * To clone the handle use maps_route_segment_clone(). * @see maps_route_segment_destroy() * @see maps_route_segment_clone() */ typedef void *maps_route_segment_h; + /** - * @brief Called when requesting the path of the Route Segment. - * @details This callback is invoked while iterating through the list of - * coordinates, composing the Route Segment. + * @brief Called when requesting the path of the Route Segment. + * @details This callback is invoked while iterating through the list of coordinates, composing the Route Segment. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a coordinates must be released using maps_coordinates_destroy(). - * \n To use @a coordinates outside this function, clone it with - * maps_coordinates_clone(). - * - * @param[in] index The current index of coordinates list - * @param[in] total The total amount of coordinates - * @param[in] coordinates The current coordinates - * @param[in] user_data The user data passed from - * maps_route_segment_foreach_path() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a coordinates must be released using maps_coordinates_destroy().\n + * To use @a coordinates outside this function, clone it with maps_coordinates_clone(). + * @param[in] index The current index of coordinates list + * @param[in] total The total amount of coordinates + * @param[in] coordinates The current coordinates + * @param[in] user_data The user data passed from maps_route_segment_foreach_path() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_route_segment_foreach_path() will invoke this callback. - * * @see maps_route_segment_foreach_path() * @see #maps_coordinates_h */ -typedef bool(*maps_route_segment_path_cb) (int index, int total, - maps_coordinates_h coordinates, - void *user_data); +typedef bool(*maps_route_segment_path_cb) (int index, int total, maps_coordinates_h coordinates, void *user_data); + /** - * @brief Called when requesting the maneuvers of the Route Segment. - * @details This callback is invoked while iterating through the list of - * maneuvers, composing the Route Segment. + * @brief Called when requesting the Maneuvers of the Route Segment. + * @details This callback is invoked while iterating through the list of Maneuvers, composing the Route Segment. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a maneuver is valid only in this function and must be released - * using maps_route_maneuver_destroy(). - * \n To use @a maneuver outside this function, clone it with - * maps_route_maneuver_clone(). - * - * @param[in] index The current index of maneuvers list - * @param[in] total The total amount of maneuvers - * @param[in] maneuver The maneuver of route - * @param[in] user_data The user data passed from - * maps_route_segment_foreach_maneuver() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a Maneuver is valid only in this function and must be released using maps_route_maneuver_destroy().\n + * To use @a Maneuver outside this function, clone it with maps_route_maneuver_clone(). + * @param[in] index The current index of Maneuvers list + * @param[in] total The total amount of Maneuvers + * @param[in] maneuver The Maneuver of route + * @param[in] user_data The user data passed from maps_route_segment_foreach_maneuver() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_route_segment_foreach_maneuver() will invoke this callback. - * * @see maps_route_segment_foreach_maneuver() * @see #maps_route_maneuver_h */ -typedef bool(*maps_route_segment_maneuver_cb) (int index, int total, - maps_route_maneuver_h maneuver, - void *user_data); +typedef bool(*maps_route_segment_maneuver_cb) (int index, int total, maps_route_maneuver_h maneuver, void *user_data); + /*----------------------------------------------------------------------------*/ + /** - * @brief Destroys the route segment handle and releases all its resources. - * @details This function destroys the route segment handle and releases all its - * resources. + * @brief Destroys the route segment handle and releases all its resources. + * @details This function destroys the route segment handle and releases all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] segment The segment handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] segment The segment handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_route_segment_clone() */ int maps_route_segment_destroy(maps_route_segment_h segment); + /** - * @brief Clones the route segment handle. - * @details This function clones the route handle @a origin and all its - * resources. + * @brief Clones the route segment handle. + * @details This function clones the route handle @a origin and all its resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_route_segment_destroy(). - * - * @param[in] origin The original segment handle - * @param[out] cloned A cloned segment handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] origin The original segment handle + * @param[out] cloned A cloned segment handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see maps_route_segment_destroy() */ -int maps_route_segment_clone(const maps_route_segment_h origin, - maps_route_segment_h *cloned); +int maps_route_segment_clone(const maps_route_segment_h origin, maps_route_segment_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the route segment origin. + * @brief Gets the route segment origin. * @details This function gets the route segment origin. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a origin must be released using maps_coordinates_destroy(). - * - * @param[in] segment The segment handle - * @param[out] origin The origin of segment - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] segment The segment handle + * @param[out] origin The origin of segment + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_coordinates_h */ -int maps_route_segment_get_origin(const maps_route_segment_h segment, - maps_coordinates_h *origin); +int maps_route_segment_get_origin(const maps_route_segment_h segment, maps_coordinates_h *origin); + /** - * @brief Gets the route segment destination. + * @brief Gets the route segment destination. * @details This function gets the route segment destination. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a destination must be released using maps_coordinates_destroy(). - * - * @param[in] segment The segment handle - * @param[out] destination The destination of segment - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] segment The segment handle + * @param[out] destination The destination of segment + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_coordinates_h */ -int maps_route_segment_get_destination(const maps_route_segment_h segment, - maps_coordinates_h *destination); +int maps_route_segment_get_destination(const maps_route_segment_h segment, maps_coordinates_h *destination); + /** - * @brief Gets the route segment bounding box. + * @brief Gets the route segment bounding box. * @details This function gets the route segment bounding box. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a bounding_box must be released using maps_area_destroy(). - * - * @param[in] segment The segment handle - * @param[out] bounding_box The bounding box of segment - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] segment The segment handle + * @param[out] bounding_box The bounding box of segment + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_area_h */ -int maps_route_segment_get_bounding_box(const maps_route_segment_h segment, - maps_area_h *bounding_box); +int maps_route_segment_get_bounding_box(const maps_route_segment_h segment, maps_area_h *bounding_box); + /** - * @brief Gets the route segment distance. + * @brief Gets the route segment distance. * @details This function gets the route segment distance. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] segment The segment handle - * @param[out] distance The distance of segment - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] segment The segment handle + * @param[out] distance The distance of segment + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_route_segment_get_distance(const maps_route_segment_h segment, - double *distance); +int maps_route_segment_get_distance(const maps_route_segment_h segment, double *distance); + /** - * @brief Gets the route segment duration. + * @brief Gets the route segment duration. * @details This function gets the route segment duration. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] segment The segment handle - * @param[out] duration The distance of segment - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] segment The segment handle + * @param[out] duration The distance of segment + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported */ -int maps_route_segment_get_duration(const maps_route_segment_h segment, - long *duration); +int maps_route_segment_get_duration(const maps_route_segment_h segment, long *duration); + /** - * @brief Retrieves all coordinates of the path. + * @brief Retrieves all coordinates of the path. * @details This function retrieves all coordinates of the route segment path. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The coordinates will be delivered via maps_route_segment_path_cb(). - * - * @param[in] segment The segment handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_route_segment_path_cb() repeatedly to - * retrieve each coordinate point. - * + * @param[in] segment The segment handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_route_segment_path_cb() repeatedly to retrieve each coordinate point. * @see maps_route_segment_path_cb() */ -int maps_route_segment_foreach_path(const maps_route_segment_h segment, - maps_route_segment_path_cb callback, - void *user_data); +int maps_route_segment_foreach_path(const maps_route_segment_h segment, maps_route_segment_path_cb callback, void *user_data); + /** - * @brief Retrieves all maneuvers of the path. - * @details This function retrieves all maneuvers of the route segment path. + * @brief Retrieves all Maneuvers of the path. + * @details This function retrieves all Maneuvers of the route segment path. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks The coordinates will be delivered via - * maps_route_segment_maneuver_cb(). - * - * @param[in] segment The segment handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_route_segment_maneuver_cb() repeatedly to - * retrieve each coordinate point. - * + * @remarks The coordinates will be delivered via maps_route_segment_maneuver_cb(). + * @param[in] segment The segment handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_route_segment_maneuver_cb() repeatedly to retrieve each coordinate point. * @see maps_route_segment_maneuver_cb() */ -int maps_route_segment_foreach_maneuver(const maps_route_segment_h segment, - maps_route_segment_maneuver_cb - callback, void *user_data); +int maps_route_segment_foreach_maneuver(const maps_route_segment_h segment, maps_route_segment_maneuver_cb callback, void *user_data); + #ifdef __cplusplus } @@ -284,4 +258,4 @@ int maps_route_segment_foreach_maneuver(const maps_route_segment_h segment, /** * @} */ -#endif /* __MAPS_SEGMENT_H__ */ +#endif /* __MAPS_SEGMENT_H__ */ diff --git a/include/maps_route_segment_plugin.h b/include/maps_route_segment_plugin.h index 5f3f739..2c4ad9e 100644 --- a/include/maps_route_segment_plugin.h +++ b/include/maps_route_segment_plugin.h @@ -20,8 +20,8 @@ #include #include /** - * @ingroup CAPI_MAPS_PLUGIN_ROUTE_MODULE - * @defgroup CAPI_MAPS_PLUGIN_ROUTE_SEGMENT_MODULE Segment + * @ingroup CAPI_MAPS_PLUGIN_ROUTE_MODULE + * @defgroup CAPI_MAPS_PLUGIN_ROUTE_SEGMENT_MODULE Segment * * @file maps_route_segment_plugin.h * @brief This file contains the functions related to Route Segment @@ -37,19 +37,19 @@ extern "C" { #endif /** - * @brief Creates a new route segment handle. + * @brief Creates a new route segment handle. * @details This function creates a new route segment handle and allocates all * needed resources. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks @a segment must be released using maps_route_segment_destroy(). * \n @a segment may be cloned using maps_route_segment_clone(). * - * @param[out] segment The segment handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[out] segment The segment handle + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @see maps_route_segment_destroy() * @see maps_route_segment_clone() @@ -57,144 +57,137 @@ extern "C" { int maps_route_segment_create(maps_route_segment_h *segment); /** - * @brief Sets the route segment origin. + * @brief Sets the route segment origin. * @details This function sets the route segment origin. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] segment The segment handle - * @param[in] origin The origin of segment - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] segment The segment handle + * @param[in] origin The origin of segment + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a segment is created using maps_route_segment_create(). * * @see maps_route_segment_create() * @see maps_route_segment_get_origin() */ -int maps_route_segment_set_origin(maps_route_segment_h segment, - const maps_coordinates_h origin); +int maps_route_segment_set_origin(maps_route_segment_h segment, const maps_coordinates_h origin); /** - * @brief Sets the route segment destination. + * @brief Sets the route segment destination. * @details This function sets the route segment destination. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] segment The segment handle - * @param[in] destination The destination of segment - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] segment The segment handle + * @param[in] destination The destination of segment + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a segment is created using maps_route_segment_create(). * * @see maps_route_segment_create() * @see maps_route_segment_get_destination() */ -int maps_route_segment_set_destination(maps_route_segment_h segment, - const maps_coordinates_h destination); +int maps_route_segment_set_destination(maps_route_segment_h segment, const maps_coordinates_h destination); /** - * @brief Sets the route segment bounding box. + * @brief Sets the route segment bounding box. * @details This function sets the route segment bounding box. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] segment The segment handle - * @param[in] bounding_box The start angle of the segment - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] segment The segment handle + * @param[in] bounding_box The start angle of the segment + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a segment is created using maps_route_segment_create(). * * @see maps_route_segment_create() * @see maps_route_segment_get_bounding_box() */ -int maps_route_segment_set_bounding_box(maps_route_segment_h segment, - const maps_area_h bounding_box); +int maps_route_segment_set_bounding_box(maps_route_segment_h segment, const maps_area_h bounding_box); /** - * @brief Sets the route segment distance. + * @brief Sets the route segment distance. * @details This function sets the route segment distance. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] segment The segment handle - * @param[in] distance The distance of the segment - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] segment The segment handle + * @param[in] distance The distance of the segment + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a segment is created using maps_route_segment_create(). * * @see maps_route_segment_create() * @see maps_route_segment_get_distance() */ -int maps_route_segment_set_distance(maps_route_segment_h segment, - const double distance); +int maps_route_segment_set_distance(maps_route_segment_h segment, const double distance); /** - * @brief Sets the route segment duration. + * @brief Sets the route segment duration. * @details This function sets the route segment duration. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] segment The segment handle - * @param[in] duration The duration of the segment - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] segment The segment handle + * @param[in] duration The duration of the segment + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a segment is created using maps_route_segment_create(). * * @see maps_route_segment_create() * @see maps_route_segment_get_duration() */ -int maps_route_segment_set_duration(maps_route_segment_h segment, - const long duration); +int maps_route_segment_set_duration(maps_route_segment_h segment, const long duration); /** - * @brief Sets the route segment path. + * @brief Sets the route segment path. * @details This function sets the route segment path. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] segment The segment handle - * @param[in] path The maneuver list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] segment The segment handle + * @param[in] path The maneuver list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a segment is created using maps_route_segment_create(). * * @see maps_route_segment_create() * @see maps_route_segment_foreach_path() */ -int maps_route_segment_set_path(maps_route_segment_h segment, - const maps_item_list_h path); +int maps_route_segment_set_path(maps_route_segment_h segment, const maps_item_list_h path); /** - * @brief Sets the route segment maneuver list. + * @brief Sets the route segment maneuver list. * @details This function sets the route segment maneuver list. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * - * @param[in] segment The segment handle - * @param[in] maneuvers The maneuver list - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] segment The segment handle + * @param[in] maneuvers The maneuver list + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a segment is created using maps_route_segment_create(). * * @see maps_route_segment_create() * @see maps_route_segment_foreach_maneuver() */ -int maps_route_segment_set_maneuvers(maps_route_segment_h segment, - const maps_item_list_h maneuvers); +int maps_route_segment_set_maneuvers(maps_route_segment_h segment, const maps_item_list_h maneuvers); #ifdef __cplusplus } @@ -202,4 +195,4 @@ int maps_route_segment_set_maneuvers(maps_route_segment_h segment, /** * @} */ -#endif /* __MAPS_SEGMENT_PLUGIN_H__ */ +#endif /* __MAPS_SEGMENT_PLUGIN_H__ */ diff --git a/include/maps_service.h b/include/maps_service.h index 6d25bb5..1f29ffe 100644 --- a/include/maps_service.h +++ b/include/maps_service.h @@ -14,9 +14,11 @@ * limitations under the License. */ + #ifndef __MAPS_SERVICE_H__ #define __MAPS_SERVICE_H__ + #include #include #include @@ -28,6 +30,7 @@ #include #include + /** * * @file maps_service.h @@ -35,202 +38,182 @@ * */ + #ifdef __cplusplus extern "C" { #endif + /*----------------------------------------------------------------------------*/ /* * Maps Service and Preference */ + /** - * @ingroup CAPI_MAPS_SERVICE_MODULE - * @defgroup CAPI_MAPS_SERVICE_AND_PREFERENCE_MODULE Service and Providers - * + * @ingroup CAPI_MAPS_SERVICE_MODULE + * @defgroup CAPI_MAPS_SERVICE_AND_PREFERENCE_MODULE Service and Providers * @addtogroup CAPI_MAPS_SERVICE_AND_PREFERENCE_MODULE * @{ * @brief This provides APIs related Search and Preference. - * */ + /** - * @brief Enumerations of maps requests available in the Maps Service + * @brief Enumeration for maps requests available in the Maps Service. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ 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_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() 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_waypoints() service is allowed */ - MAPS_SERVICE_CANCEL_REQUEST, /**< Indicates that maps_service_cancel_request() service is allowed */ - MAPS_SERVICE_MULTI_REVERSE_GEOCODE, /**< Indicates that maps_service_multi_reverse_geocode() service is allowed @if MOBILE (Since 3.0) @endif */ - MAPS_SERVICE_SEARCH_PLACE_LIST, /**< Indicates that maps_service_search_place_list() service is allowed @if MOBILE (Since 3.0) @endif */ - MAPS_SERVICE_SEARCH_GET_PLACE_DETAILS, /**< Indicates that maps_service_search_get_place_details() service is allowed @if MOBILE (Since 3.0) @endif */ - MAPS_SERVICE_GET_PLACE_CATEGORIES, /**< Indicates that maps_service_get_place_categories() service is allowed @if MOBILE (Since 3.0) @endif */ - - MAPS_SERVICE_VIEW = 0x100, /**< Indicates that maps view service is allowed @if MOBILE (Since 3.0) @endif */ - MAPS_SERVICE_VIEW_SNAPSHOT /**< Indicates that maps view snapshot service is allowed @if MOBILE (Since 3.0) @endif */ + 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() 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_waypoints() service is allowed */ + MAPS_SERVICE_CANCEL_REQUEST, /**< Indicates that maps_service_cancel_request() service is allowed */ + MAPS_SERVICE_MULTI_REVERSE_GEOCODE, /**< Indicates that maps_service_multi_reverse_geocode() service is allowed @if MOBILE (Since 3.0) @endif */ + MAPS_SERVICE_SEARCH_PLACE_LIST, /**< Indicates that maps_service_search_place_list() service is allowed @if MOBILE (Since 3.0) @endif */ + MAPS_SERVICE_SEARCH_GET_PLACE_DETAILS, /**< Indicates that maps_service_search_get_place_details() service is allowed @if MOBILE (Since 3.0) @endif */ + MAPS_SERVICE_GET_PLACE_CATEGORIES, /**< Indicates that maps_service_get_place_categories() service is allowed (Since 4.0) */ + + MAPS_SERVICE_VIEW = 0x100, /**< Indicates that maps view service is allowed @if MOBILE (Since 3.0) @endif */ + MAPS_SERVICE_VIEW_SNAPSHOT /**< Indicates that maps view snapshot service is allowed @if MOBILE (Since 3.0) @endif */ } maps_service_e; + /** - * @brief Enumerations of maps features available in the Maps Service + * @brief Enumeration for maps features available in the Maps Service. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ typedef enum _maps_service_data_e { - 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_VIEW_TRAFFIC = 0x100, /**< Indicates the availability of traffic information on the Map @if MOBILE (Since 3.0) @endif */ - MAPS_VIEW_PUBLIC_TRANSIT, /**< Indicates the availability of public transit information on the Map @if MOBILE (Since 3.0) @endif */ - MAPS_VIEW_BUILDING, /**< Indicates the availability of 3D building drawable on the Map @if MOBILE (Since 3.0) @endif */ - MAPS_VIEW_SCALEBAR /**< Indicates the availability of scale bar on the Map @if MOBILE (Since 3.0) @endif */ + 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_VIEW_TRAFFIC = 0x100, /**< Indicates the availability of traffic information on the Map @if MOBILE (Since 3.0) @endif */ + MAPS_VIEW_PUBLIC_TRANSIT, /**< Indicates the availability of public transit information on the Map @if MOBILE (Since 3.0) @endif */ + MAPS_VIEW_BUILDING, /**< Indicates the availability of 3D building drawable on the Map @if MOBILE (Since 3.0) @endif */ + MAPS_VIEW_SCALEBAR /**< Indicates the availability of scale bar on the Map @if MOBILE (Since 3.0) @endif */ } maps_service_data_e; /** - * @brief Called when requesting available Maps Providers. + * @brief Called when requesting available Maps Providers. * @details A Maps Service invokes this callback iteratively as long as available Maps Providers exist. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @remarks The string @a maps_provider must be released using free(). - * - * @param[in] maps_provider The info of Maps Provider - * @param[in] user_data The user data passed from - * maps_service_foreach_provider() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @param[in] maps_provider The info of Maps Provider + * @param[in] user_data The user data passed from maps_service_foreach_provider() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_service_foreach_provider() will invoke this callback. - * * @see maps_service_foreach_provider() * @see maps_service_create() */ -typedef bool(*maps_service_provider_info_cb) (char *maps_provider, - void *user_data); +typedef bool(*maps_service_provider_info_cb) (char *maps_provider, void *user_data); + /** - * @brief Gets available Maps Providers. - * @details This function delivers available Maps Providers via - * maps_service_provider_info_cb() callback. + * @brief Gets available Maps Providers. + * @details This function delivers available Maps Providers via maps_service_provider_info_cb() callback. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @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 - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @post This function invokes maps_service_provider_info_cb() to deliver Maps - * Provider information. - * + * @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 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @post This function invokes maps_service_provider_info_cb() to deliver Maps Provider information. * @see maps_service_provider_info_cb() * @see maps_service_create() */ -int maps_service_foreach_provider(maps_service_provider_info_cb callback, - void *user_data); +int maps_service_foreach_provider(maps_service_provider_info_cb callback, void *user_data); + /** - * @brief Called with the information about user's consent. + * @brief Called with the information about user's consent. * @details The Maps Service invokes this callback when the information about user's consent is obtained. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] consented The value of User Consent - * @param[in] maps_provider The name of Maps Provider - * @param[in] user_data The user data passed from maps_service_request_user_consent() - * + * @param[in] consented The value of User Consent + * @param[in] maps_provider The name of Maps Provider + * @param[in] user_data The user data passed from maps_service_request_user_consent() * @pre maps_service_request_user_consent() will invoke this callback. - * * @see maps_service_request_user_consent() * @see maps_service_create() */ -typedef void(*maps_service_request_user_consent_cb) (bool consented, - const char *maps_provider, void *user_data); +typedef void(*maps_service_request_user_consent_cb) (bool consented, const char *maps_provider, void *user_data); + /** - * @brief Gets the user's consent to use maps data. + * @brief Gets the user's consent to use maps data. * @details The function gets information whether the user agreed that the application can use maps data. - * If maps_service_request_user_consent() is called when the user didn't agree yet, a popup is shown and - * the user can decide whether to agree or not. Then the result is saved and maps_service_request_user_consent_cb() - * is called. If the user has already agreed, the popup is not shown and only the callback is called. - * The request is asynchronous. + * If maps_service_request_user_consent() is called when the user didn't agree yet, a popup is shown and + * the user can decide whether to agree or not. Then the result is saved and maps_service_request_user_consent_cb() + * is called. If the user has already agreed, the popup is not shown and only the callback is called. + * The request is asynchronous. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice - * * @remarks Available map providers can be obtained with maps_service_foreach_provider(). - * - * @param[in] maps_provider The name of Maps Provider - * @param[in] callback The callback which receives the user's consent decision - * @param[in] 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 - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * - * @post This function invokes maps_service_request_user_consent_cb() to provide information - * about user consent. - * + * @param[in] maps_provider The name of Maps Provider + * @param[in] callback The callback which receives the user's consent decision + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @post This function invokes maps_service_request_user_consent_cb() to provide information about user consent. * @see maps_service_foreach_provider() * @see maps_service_request_user_consent_cb() * @see maps_service_create() */ -int maps_service_request_user_consent(const char *maps_provider, - maps_service_request_user_consent_cb callback, void *user_data); +int maps_service_request_user_consent(const char *maps_provider, maps_service_request_user_consent_cb callback, void *user_data); + /** - * @brief Creates a new Maps Service and assigns it with a handle. - * @details While Maps Service is being created, a Maps Provider is initialized - * and linked with Maps Service handle. - * \n A Maps Service handle is used to query Maps Provider performing services, - * such as Geocoding, Searching Places and Routing. + * @brief Creates a new Maps Service and assigns it with a handle. + * @details While Maps Service is being created, a Maps Provider is initialized and linked with Maps Service handle. + * A Maps Service handle is used to query Maps Provider performing services, such as Geocoding, Searching Places, and Routing. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @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(). - * \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 - * - * @param[in] maps_provider The name of Maps Provider - * @param[out] maps A handle of the new Maps Service on success - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_USER_NOT_CONSENTED The user did not consent - * + * @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 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 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_USER_NOT_CONSENTED The user did not consent * @pre Call maps_service_foreach_provider() to get a available Maps Providers. - * * @see maps_service_foreach_provider() * @see maps_service_destroy() * @see maps_service_geocode() @@ -248,172 +231,148 @@ int maps_service_request_user_consent(const char *maps_provider, */ int maps_service_create(const char *maps_provider, maps_service_h *maps); + /** - * @brief Destroys the Maps Service handle and releases all its resources. + * @brief Destroys the Maps Service handle and releases all its resources. * @details This function releases all used resources of the Maps Service and Maps Provider. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice - * - * @param[in] maps The Maps Service handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * + * @param[in] maps The Maps Service handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied * @pre Call maps_service_create() to create Maps Service and get its handle. - * * @see maps_service_create() */ 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. - * \n Maps key can be obtained with maps_service_get_provider_key(). + * @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.\n + * Maps Key can be obtained with maps_service_get_provider_key(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @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. - * - * @param[in] maps The Maps Service handle - * @param[in] provider_key The Maps Key to be used - * \n In case of combining two more strings, use slash("/") as a delimiter. - * \n e.g. For HERE "app_id/app_code" - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @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. + * @param[in] maps The Maps Service handle + * @param[in] provider_key The Maps Key to be used.\n + * In case of combining two more strings, use slash("/") as a delimiter.\n + * e.g. For HERE "app_id/app_code" + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre Call maps_service_create() to create Maps Service and get its handle. - * * @see maps_service_create() * @see maps_service_get_provider_key() */ -int maps_service_set_provider_key(maps_service_h maps, - const char *provider_key); +int maps_service_set_provider_key(maps_service_h maps, const char *provider_key); + /** - * @brief Gets the Maps Key which is to be used in the Maps Service - * requests - * @details This function gets the Maps Key which is to be used in each Maps - * Service request to Maps Provider. - * \n Maps key can be set with maps_service_set_provider_key(). + * @brief Gets the Maps Key which is to be used in the Maps Service requests + * @details This function gets the Maps Key which is to be used in each Maps Service request to Maps Provider.\n + * Maps Key can be set with maps_service_set_provider_key(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks The string @a provider_key must be released using free(). - * \n @a maps_service_get_provider_key is always synchronous function. - * - * @param[in] maps The Maps Service handle - * @param[out] provider_key The Maps Key - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks The string @a provider_key must be released using free().\n + * @a maps_service_get_provider_key is always synchronous function. + * @param[in] maps The Maps Service handle + * @param[out] provider_key The Maps Key + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre Call maps_service_create() to create Maps Service and get its handle. - * * @see maps_service_set_provider_key() * @see maps_service_create() */ -int maps_service_get_provider_key(const maps_service_h maps, - char **provider_key); +int maps_service_get_provider_key(const maps_service_h maps, char **provider_key); + /** - * @brief Sets the Maps Preference. - * @details This function sets the Maps Preferences which are used in each Maps - * Service request to Maps Provider. + * @brief Sets the Maps Preference. + * @details This function sets the Maps Preferences which are used in each Maps Service request to Maps Provider. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] maps The handle of Maps Service - * @param[in] preference The handle of Maps Preference - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * + * @param[in] maps The handle of Maps Service + * @param[in] preference The handle of Maps Preference + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied * @pre Call maps_service_create() to create Maps Service and get its handle. - * * @see maps_service_get_preference() * @see maps_service_create() */ -int maps_service_set_preference(maps_service_h maps, - maps_preference_h preference); +int maps_service_set_preference(maps_service_h maps, maps_preference_h preference); + /** - * @brief Gets the Maps Preference. - * @details This function gets the Maps Preferences which are used in each Maps - * Service request to Maps Provider. - * \n Preferences can be set with maps_service_set_preference(). + * @brief Gets the Maps Preference. + * @details This function gets the Maps Preferences which are used in each Maps Service request to Maps Provider.\n + * Preferences can be set with maps_service_set_preference(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a preference must be released using maps_preference_destroy(). - * \n @a maps_service_get_preference is always synchronous function. - * - * @param[in] maps The handle of Maps Service - * @param[out] preference The handle of Maps Preference - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a preference must be released using maps_preference_destroy().\n + * @a maps_service_get_preference is always synchronous function. + * @param[in] maps The handle of Maps Service + * @param[out] preference The handle of Maps Preference + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre Call maps_service_create() to create Maps Service and get its handle. - * * @see maps_service_set_preference() * @see maps_service_create() */ -int maps_service_get_preference(maps_service_h maps, - maps_preference_h *preference); +int maps_service_get_preference(maps_service_h maps, maps_preference_h *preference); + /** - * @brief Checks if the Maps Service supports a request. + * @brief Checks if the Maps Service supports a request. * @details This function checks if the Maps Service supports a specified request. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a maps_service_provider_is_service_supported is always synchronous - * function. - * - * @param[in] maps The handle of Maps Service - * @param[in] service The service to be checked - * @param[out] supported Is the service supported - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a maps_service_provider_is_service_supported is always synchronous function. + * @param[in] maps The handle of Maps Service + * @param[in] service The service to be checked + * @param[out] supported Is the service supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre Call maps_service_create() to create Maps Service and get its handle. - * * @see maps_service_create() */ -int maps_service_provider_is_service_supported(const maps_service_h maps, - maps_service_e service, - bool *supported); +int maps_service_provider_is_service_supported(const maps_service_h maps, maps_service_e service, bool *supported); + /** - * @brief Checks if the Maps Service supports a data feature. - * @details This function checks if the Maps Service supports a specified data - * feature. + * @brief Checks if the Maps Service supports a data feature. + * @details This function checks if the Maps Service supports a specified data feature. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks @a maps_service_provider_is_data_supported is always synchronous - * function. - * - * @param[in] maps The handle of Maps Service - * @param[in] data The data feature to be checked - * @param[out] supported Is the data feature supported - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a maps_service_provider_is_data_supported is always a synchronous function. + * @param[in] maps The handle of Maps Service + * @param[in] data The data feature to be checked + * @param[out] supported Is the data feature supported + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre Call maps_service_create() to create Maps Service and get its handle. - * * @see maps_service_create() */ -int maps_service_provider_is_data_supported(const maps_service_h maps, - maps_service_data_e data, - bool *supported); +int maps_service_provider_is_data_supported(const maps_service_h maps, maps_service_data_e data, bool *supported); /*----------------------------------------------------------------------------*/ @@ -421,43 +380,39 @@ int maps_service_provider_is_data_supported(const maps_service_h maps, * Cancel Service Request */ -/** - * @brief Cancels the service request. - * @details This function cancels the service request initiated by geocoding - * and searching places and routes. +/** + * @brief Cancels the service request. + * @details This function cancels the service request initiated by geocoding and searching places and routes. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice - * - * @param[in] maps The Maps Service handle - * @param[in] request_id The id of request - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @param[in] maps The Maps Service handle + * @param[in] request_id The ID of request + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_UNKNOWN Unknown error * @pre @a request_id is obtained from one of followings: - * - maps_service_geocode() - * - maps_service_geocode_inside_area() - * - maps_service_geocode_by_structured_address() - * - maps_service_reverse_geocode() - * - maps_service_search_place() - * - maps_service_search_place_by_area() - * - maps_service_search_place_by_address() - * - maps_service_search_route() - * - maps_service_search_route_waypoints() - * . + * - maps_service_geocode() + * - maps_service_geocode_inside_area() + * - maps_service_geocode_by_structured_address() + * - maps_service_reverse_geocode() + * - maps_service_search_place() + * - maps_service_search_place_by_area() + * - 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() * @see maps_service_geocode_inside_area() * @see maps_service_geocode_by_structured_address() @@ -470,216 +425,177 @@ int maps_service_provider_is_data_supported(const maps_service_h maps, */ int maps_service_cancel_request(const maps_service_h maps, int request_id); + /** * @} */ + /*----------------------------------------------------------------------------*/ /* * Geocoder Service */ + /** - * - * @ingroup CAPI_MAPS_SERVICE_MODULE - * @defgroup CAPI_MAPS_GEOCODER_MODULE Geocoder - * + * @ingroup CAPI_MAPS_SERVICE_MODULE + * @defgroup CAPI_MAPS_GEOCODER_MODULE Geocoder * @if WEARABLE - * @section CAPI_MAPS_SERVICE_MODULE_FEATURE Related Features - * This API is related with the following features:\n - * - http://tizen.org/feature/network.internet\n - * - * It is recommended to design feature related codes in your application for reliability.\n - * - * You can check if a device supports the related features for this API by using - * @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n - * - * To ensure your application is only running on the device with specific features, - * please define the features in your manifest file using the manifest editor in the SDK.\n - * - * More details on featuring your application can be found from - * Feature List. + * @section CAPI_MAPS_SERVICE_MODULE_FEATURE Related Features + * This API is related with the following features:\n + * - http://tizen.org/feature/network.internet\n + * It is recommended to design feature related codes in your application for reliability.\n + * You can check if a device supports the related features for this API by using + * @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n + * To ensure your application is only running on the device with specific features, + * please define the features in your manifest file using the manifest editor in the SDK.\n + * More details on featuring your application can be found from + * Feature List. * @endif - * - * @addtogroup CAPI_MAPS_GEOCODER_MODULE + * @addtogroup CAPI_MAPS_GEOCODER_MODULE * @{ - * @brief This provides APIs for Geocoder Service + * @brief This provides APIs for Geocoder Service. * @details The Maps Geocoding API allows translating an address to its - * geographical location defined in terms of latitude and longitude; - * the input can be a qualified, structured address or a free form single search - * text with full or partial address information. - * \n The Maps Reverse Geocoding API allows to inverse translating a - * geographical location (longitude, latitude) to an address; - * it can be used to answer the question "Where am I?". - * + * geographical location defined in terms of latitude and longitude; + * the input can be a qualified, structured address or a free form single search + * text with full or partial address information.\n + * The Maps Reverse Geocoding API allows to inverse translating a + * geographical location (longitude, latitude) to an address; + * it can be used to answer the question "Where am I?". */ + /** - * @brief Called once for each position coordinates converted from the - * given address information. - * @details The Maps Service invokes this callback while iterating through the - * list of obtained coordinates of the specified place. - * \n If search is failed, the value of @a total is 0 and @a coordinates is NULL + * @brief Called once for each position coordinates converted from the given address information. + * @details The Maps Service invokes this callback while iterating through the list of obtained coordinates of the specified place.\n + * If search is failed, the value of @a total is 0 and @a coordinates is NULL. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks The parameter @a coordinates must be released using - * maps_coordinates_destroy(). - * \n This error code will be reported. \n - * #MAPS_ERROR_NONE \n - * #MAPS_ERROR_OUT_OF_MEMORY \n - * #MAPS_ERROR_INVALID_PARAMETER \n - * #MAPS_ERROR_NOT_FOUND. - * - * @param[in] result The result of request - * @param[in] request_id The id of request - * @param[in] index The current index of coordinates in result set, - * start from 0 - * @param[in] total The total number of results - * @param[in] coordinates The coordinates of the place - * @param[in] user_data The user data passed from maps_service_geocode() - * or maps_service_geocode_inside_area() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * - * @pre maps_service_geocode() or maps_service_geocode_inside_area() will invoke - * this callback. - * + * @remarks The parameter @a coordinates must be released using maps_coordinates_destroy().\n + * This error code will be reported.\n + * #MAPS_ERROR_NONE \n + * #MAPS_ERROR_OUT_OF_MEMORY \n + * #MAPS_ERROR_INVALID_PARAMETER \n + * #MAPS_ERROR_NOT_FOUND. + * @param[in] result The result of request + * @param[in] request_id The ID of request + * @param[in] index The current index of coordinates in result set, start from 0 + * @param[in] total The total number of results + * @param[in] coordinates The coordinates of the place + * @param[in] user_data The user data passed from maps_service_geocode() or maps_service_geocode_inside_area() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop + * @pre maps_service_geocode() or maps_service_geocode_inside_area() will invoke this callback. * @see maps_service_geocode() * @see maps_service_geocode_inside_area() * @see maps_service_cancel_request() */ -typedef bool(*maps_service_geocode_cb) (maps_error_e result, int request_id, - int index, int total, - maps_coordinates_h coordinates, - void *user_data); +typedef bool(*maps_service_geocode_cb) (maps_error_e result, int request_id, int index, int total, maps_coordinates_h coordinates, void *user_data); + /** - * @brief Called when the address information is converted from position - * information. - * @details The Maps Service invokes this callback when the address is obtained - * from the specified coordinates. - * \n If search is failed, the value of @a total is 0 and @a address is NULL - * @remarks The parameter @a address must be released using - * maps_address_destroy(). - * \n This error code will be reported. \n - * #MAPS_ERROR_NONE \n - * #MAPS_ERROR_OUT_OF_MEMORY \n - * #MAPS_ERROR_INVALID_PARAMETER \n - * #MAPS_ERROR_NOT_FOUND. + * @brief Called when the address information is converted from position information. + * @details The Maps Service invokes this callback when the address is obtained from the specified coordinates.\n + * If search is failed, the value of @a total is 0 and @a address is NULL. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] result The result of request - * @param[in] request_id The id of request - * @param[in] index The current index of address data in result set, - * start from 0 - * @param[in] total The total number of results - * @param[in] address The requested address information - * @param[in] user_data The user data passed from - * maps_service_reverse_geocode() - * + * @remarks The parameter @a address must be released using maps_address_destroy().\n + * This error code will be reported. \n + * #MAPS_ERROR_NONE \n + * #MAPS_ERROR_OUT_OF_MEMORY \n + * #MAPS_ERROR_INVALID_PARAMETER \n + * #MAPS_ERROR_NOT_FOUND. + * @param[in] result The result of request + * @param[in] request_id The ID of request + * @param[in] index The current index of address data in result set, start from 0 + * @param[in] total The total number of results + * @param[in] address The requested address information + * @param[in] user_data The user data passed from maps_service_reverse_geocode() * @pre maps_service_reverse_geocode() will invoke this callback. - * * @see maps_service_reverse_geocode() * @see maps_service_cancel_request() */ -typedef void (*maps_service_reverse_geocode_cb) (maps_error_e result, - int request_id, int index, - int total, - maps_address_h address, - void *user_data); +typedef void (*maps_service_reverse_geocode_cb) (maps_error_e result, int request_id, int index, int total, maps_address_h address, void *user_data); + /** - * @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. + * @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 @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks 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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @remarks 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 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 @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @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. - * @post It invokes maps_service_geocode_cb() to deliver obtained position - * coordinates. - * + * @post It invokes maps_service_geocode_cb() to deliver obtained position coordinates. * @see maps_service_geocode_inside_area() * @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, - maps_service_geocode_cb callback, void *user_data, - int *request_id); +int maps_service_geocode(const maps_service_h maps, const char *address, const maps_preference_h preference, maps_service_geocode_cb callback, void *user_data, int *request_id); + /** - * @brief Gets the position for a given address, within the specified - * 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. + * @brief Gets the position for a given address within the specified 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 @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks 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 - * #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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @remarks 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 + * #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 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 @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @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. - * @post It invokes maps_service_geocode_cb() to deliver obtained position - * coordinates. - * + * @post It invokes maps_service_geocode_cb() to deliver obtained position coordinates. * @see maps_service_geocode_by_structured_address() * @see maps_service_geocode_inside_area() * @see maps_service_geocode_cb() @@ -688,52 +604,43 @@ int maps_service_geocode(const maps_service_h maps, const char *address, * @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, - const maps_area_h bounds, - const maps_preference_h preference, - maps_service_geocode_cb callback, - void *user_data, int *request_id); +int maps_service_geocode_inside_area(const maps_service_h maps, const char *address, const maps_area_h bounds, const maps_preference_h preference, maps_service_geocode_cb callback, void *user_data, int *request_id); + /** - * @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. + * @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 @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks 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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @remarks 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 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 @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @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. - * @post It invokes maps_service_geocode_cb() to deliver obtained position - * coordinates. - + * @post It invokes maps_service_geocode_cb() to deliver obtained position coordinates. * @see maps_service_geocode() * @see maps_service_geocode_inside_area() * @see maps_service_geocode_cb() @@ -741,322 +648,266 @@ int maps_service_geocode_inside_area(const maps_service_h maps, * @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, - const maps_preference_h - preference, - maps_service_geocode_cb - callback, void *user_data, - int *request_id); +int maps_service_geocode_by_structured_address(const maps_service_h maps, const maps_address_h address, const maps_preference_h preference, maps_service_geocode_cb callback, void *user_data, int *request_id); + /** - * @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. + * @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 @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks 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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @remarks 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 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 @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @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. * @post This function invokes maps_service_reverse_geocode_cb(). - * * @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, - const maps_preference_h preference, - maps_service_reverse_geocode_cb callback, - void *user_data, int *request_id); +int maps_service_reverse_geocode(const maps_service_h maps, double latitude, double longitude, const maps_preference_h preference, maps_service_reverse_geocode_cb callback, void *user_data, int *request_id); /** - * @brief Called when respond to a request of multi reverse geocoding. - * @details The Maps Service invokes this callback once when gets the response - * from map service provider. - * \n The value of @a total is same with requested coordinates list size. - * Even though one of address is not provided valid address handle is retrieved. + * @brief Called when respond to a request of multi reverse geocoding. + * @details The Maps Service invokes this callback once when gets the response from map service provider.\n + * The value of @a total is same with requested coordinates list size. + * Even though one of address is not provided valid address handle is retrieved. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks You can get the respective address information of @a address_list - * using maps_address_list_foreach(). - * \n This error code will be reported. \n - * #MAPS_ERROR_NONE \n - * #MAPS_ERROR_OUT_OF_MEMORY \n - * #MAPS_ERROR_INVALID_PARAMETER \n - * #MAPS_ERROR_NOT_FOUND. - * - * @param[in] result The result of request - * @param[in] request_id The id of request - * @param[in] total The total number of results - * @param[in] address_list The converted address list from the - * requested coordinates list - * @param[in] user_data The user data pointer passed from - * maps_service_multi_reverse_geocode() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks You can get the respective address information of @a address_list using maps_address_list_foreach().\n + * This error code will be reported. \n + * #MAPS_ERROR_NONE \n + * #MAPS_ERROR_OUT_OF_MEMORY \n + * #MAPS_ERROR_INVALID_PARAMETER \n + * #MAPS_ERROR_NOT_FOUND. + * @param[in] result The result of request + * @param[in] request_id The ID of request + * @param[in] total The total number of results + * @param[in] address_list The converted address list from the requested coordinates list + * @param[in] user_data The user data pointer passed from maps_service_multi_reverse_geocode() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_service_multi_reverse_geocode() will invoke this callback. - * * @see maps_service_multi_reverse_geocode() * @see maps_address_list_foreach() * @see maps_service_cancel_request() */ -typedef bool (*maps_service_multi_reverse_geocode_cb) (maps_error_e result, - int request_id, - int total, - maps_address_list_h address_list, - void *user_data); +typedef bool (*maps_service_multi_reverse_geocode_cb) (maps_error_e result, int request_id, int total, maps_address_list_h address_list, void *user_data); + /** - * @brief Gets the address list for a given position coordinates list. - * \n The request is asynchronous. + * @brief Gets the address list for a given position coordinates list.\n + * The request is asynchronous. * @details This function obtains structured address information. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks 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 - * @param[in] coordinates_list The coordinates list [2 ~ 100] (a set of coordinates) - * @param[in] preference The set of preferences for processing Reverse - * Geocode - * @param[in] callback The callback which will retrieve address list - * @param[in] user_data The user data pointer to be passed to the - * callback - * @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_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @remarks 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 + * @param[in] coordinates_list The coordinates list [2 ~ 100] (a set of coordinates) + * @param[in] preference The set of preferences for processing Reverse Geocode + * @param[in] callback The callback which will retrieve address list + * @param[in] user_data The user data pointer to be passed to the callback + * @param[out] request_id The ID of request + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network connection failed + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @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. * @post This function invokes maps_service_multi_reverse_geocode_cb(). - * * @see maps_service_multi_reverse_geocode_cb() * @see maps_service_cancel_request() * @see maps_service_reverse_geocode() * @see maps_service_provider_is_service_supported() */ -int maps_service_multi_reverse_geocode(const maps_service_h maps, - maps_coordinates_list_h coordinates_list, - const maps_preference_h preference, - maps_service_multi_reverse_geocode_cb callback, - void *user_data, int *request_id); +int maps_service_multi_reverse_geocode(const maps_service_h maps, maps_coordinates_list_h coordinates_list, const maps_preference_h preference, maps_service_multi_reverse_geocode_cb callback, void *user_data, int *request_id); /** * @} */ + /*----------------------------------------------------------------------------*/ /* * Place Service */ + /** - * @ingroup CAPI_MAPS_SERVICE_MODULE - * @defgroup CAPI_MAPS_PLACE_MODULE Places - * + * @ingroup CAPI_MAPS_SERVICE_MODULE + * @defgroup CAPI_MAPS_PLACE_MODULE Places * @if WEARABLE - * @section CAPI_MAPS_SERVICE_MODULE_FEATURE Related Features - * This API is related with the following features:\n - * - http://tizen.org/feature/network.internet\n - * - * It is recommended to design feature related codes in your application for reliability.\n - * - * You can check if a device supports the related features for this API by using - * @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n - * - * To ensure your application is only running on the device with specific features, - * please define the features in your manifest file using the manifest editor in the SDK.\n - * - * More details on featuring your application can be found from - * Feature List. + * @section CAPI_MAPS_SERVICE_MODULE_FEATURE Related Features + * This API is related with the following features:\n + * - http://tizen.org/feature/network.internet\n + * It is recommended to design feature related codes in your application for reliability.\n + * You can check if a device supports the related features for this API by using + * @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n + * To ensure your application is only running on the device with specific features, + * please define the features in your manifest file using the manifest editor in the SDK.\n + * More details on featuring your application can be found from + * Feature List. * @endif - * - * @addtogroup CAPI_MAPS_PLACE_MODULE + * @addtogroup CAPI_MAPS_PLACE_MODULE * @{ - * @brief This provides APIs for Place Service - * @details The Maps Place API allows to find places that are relevant to user - * discovery context. + * @brief This provides APIs for Place Service. + * @details The Maps Place API allows to find places that are relevant to user discovery context. * */ + /** - * @brief Called for each result of Place Search request - * @details The Maps Service invokes this callback while iterating through the - * set of obtained Place data. - * \n If search is failed, the value of @a total is 0 and @a place is NULL + * @brief Called for each result of Place Search request. + * @details The Maps Service invokes this callback while iterating through the set of obtained Place data.\n + * If search is failed, the value of @a total is 0 and @a place is NULL. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks The parameter @a place must be released using maps_place_destroy(). - * \n This error code will be reported. \n - * #MAPS_ERROR_NONE \n - * #MAPS_ERROR_OUT_OF_MEMORY \n - * #MAPS_ERROR_INVALID_PARAMETER \n - * #MAPS_ERROR_NOT_FOUND. - * - * @param[in] error The result of request - * @param[in] request_id The request id - * @param[in] index The current index of place data in result set, - * start from 0 - * @param[in] total The total number of results - * @param[in] place The resulting Place data - * @param[in] user_data The user data passed from - * maps_service_search_place(), maps_service_search_place_by_area() or - * maps_service_search_place_by_address() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * - * @pre maps_service_search_place(), maps_service_search_place_by_area() or - * maps_service_search_place_by_address() will invoke this callback. - * + * @remarks The parameter @a place must be released using maps_place_destroy().\n + * This error code will be reported.\n + * #MAPS_ERROR_NONE \n + * #MAPS_ERROR_OUT_OF_MEMORY \n + * #MAPS_ERROR_INVALID_PARAMETER \n + * #MAPS_ERROR_NOT_FOUND. + * @param[in] error The result of request + * @param[in] request_id The request ID + * @param[in] index The current index of place data in result set, start from 0 + * @param[in] total The total number of results + * @param[in] place The resulting Place data + * @param[in] user_data The user data passed from maps_service_search_place(), maps_service_search_place_by_area() or + * maps_service_search_place_by_address() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop + * @pre maps_service_search_place(), maps_service_search_place_by_area() or maps_service_search_place_by_address() will invoke this callback. * @see maps_service_search_place() * @see maps_service_search_place_by_area() * @see maps_service_search_place_by_address() */ -typedef bool(*maps_service_search_place_cb) (maps_error_e error, - int request_id, int index, - int total, maps_place_h place, - void *user_data); +typedef bool(*maps_service_search_place_cb) (maps_error_e error, int request_id, int index, int total, maps_place_h place, void *user_data); + /** - * @brief Called for Place list of Place Search request - * @details The Maps Service invokes this callback when the Place data obtained - * from the specified coordinates. - * \n If search is failed, the value of @a total is 0 and @a place_list is NULL + * @brief Called for Place list of Place Search request. + * @details The Maps Service invokes this callback when the Place data obtained from the specified coordinates.\n + * If search is failed, the value of @a total is 0 and @a place_list is NULL. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks The parameter @a place_list must be released using maps_place_list_destroy(). - * \n This error code will be reported. \n - * #MAPS_ERROR_NONE \n - * #MAPS_ERROR_OUT_OF_MEMORY \n - * #MAPS_ERROR_INVALID_PARAMETER \n - * #MAPS_ERROR_NOT_FOUND. - * - * @param[in] error The result of request - * @param[in] request_id The request id - * @param[in] total The total number of results - * @param[in] place_list The resulting Place list data - * @param[in] user_data The user data passed from maps_service_search_place_list() - * + * @remarks The parameter @a place_list must be released using maps_place_list_destroy().\n + * This error code will be reported.\n + * #MAPS_ERROR_NONE \n + * #MAPS_ERROR_OUT_OF_MEMORY \n + * #MAPS_ERROR_INVALID_PARAMETER \n + * #MAPS_ERROR_NOT_FOUND. + * @param[in] error The result of request + * @param[in] request_id The request ID + * @param[in] total The total number of results + * @param[in] place_list The resulting Place list data + * @param[in] user_data The user data passed from maps_service_search_place_list() * @pre maps_service_search_place_list() will invoke this callback. - * * @see maps_service_search_place_list() * @see maps_place_list_foreach() */ -typedef void(*maps_service_search_place_list_cb) (maps_error_e error, - int request_id, int total, maps_place_list_h place_list, void *user_data); +typedef void(*maps_service_search_place_list_cb) (maps_error_e error, int request_id, int total, maps_place_list_h place_list, void *user_data); + /** - * @brief Called for Place detail information of Place Search request - * @details The Maps Service invokes this callback when the Place detail data - * obtained from the specified uri. - * \n If search is failed, @a place is NULL + * @brief Called for Place detail information of Place Search request. + * @details The Maps Service invokes this callback when the Place detail data obtained from the specified uri.\n + * If search is failed, @a place is NULL. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks The parameter @a place must be released using maps_place_destroy(). - * \n This error code will be reported. \n - * #MAPS_ERROR_NONE \n - * #MAPS_ERROR_OUT_OF_MEMORY \n - * #MAPS_ERROR_INVALID_PARAMETER \n - * #MAPS_ERROR_NOT_FOUND. - * - * @param[in] error The result of request - * @param[in] request_id The request id - * @param[in] place The resulting Place data - * @param[in] user_data The user data passed from maps_service_get_place_details() - * + * @remarks The parameter @a place must be released using maps_place_destroy().\n + * This error code will be reported.\n + * #MAPS_ERROR_NONE \n + * #MAPS_ERROR_OUT_OF_MEMORY \n + * #MAPS_ERROR_INVALID_PARAMETER \n + * #MAPS_ERROR_NOT_FOUND. + * @param[in] error The result of request + * @param[in] request_id The request ID + * @param[in] place The resulting Place data + * @param[in] user_data The user data passed from maps_service_get_place_details() * @pre maps_service_get_place_details() will invoke this callback. - * * @see maps_service_get_place_details() */ -typedef void(*maps_service_get_place_details_cb) (maps_error_e error, - int request_id, maps_place_h place, void *user_data); +typedef void(*maps_service_get_place_details_cb) (maps_error_e error, int request_id, maps_place_h place, void *user_data); + /** - * @brief Queries a Place information by a coordinates position and a - * distance. - * \n The request is asynchronous. - * @details This function obtains the Place information for a specified distance - * around a given coordinates position. + * @brief Queries a Place information by a coordinates position and a distance.\n + * The request is asynchronous. + * @details This function obtains the Place information for a specified distance around a given coordinates position. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks 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 - * 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 - * @param[in] distance The search area 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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy - * @retval #MAPS_ERROR_CANCELED Places service aborted - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @remarks 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 + * 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 + * @param[in] distance The search area 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 The request ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy + * @retval #MAPS_ERROR_CANCELED Places service aborted + * @retval #MAPS_ERROR_UNKNOWN Unknown error * @pre Call maps_service_create() to create Maps Service and obtain its handle. - * @post It invokes maps_service_search_place_cb() to deliver obtained Place - * information. - * + * @post It invokes maps_service_search_place_cb() to deliver obtained Place information. * @see maps_service_search_place_by_area() * @see maps_service_search_place_by_address() * @see maps_service_cancel_request() @@ -1064,60 +915,50 @@ typedef void(*maps_service_get_place_details_cb) (maps_error_e error, * @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, - const maps_place_filter_h filter, - maps_preference_h preference, - maps_service_search_place_cb callback, - void *user_data, int *request_id); +int maps_service_search_place(const maps_service_h maps, const maps_coordinates_h position, int distance, const maps_place_filter_h filter, maps_preference_h preference, maps_service_search_place_cb callback, void *user_data, int *request_id); + /** - * @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. + * @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 @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks @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 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 - * 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 - * @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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy - * @retval #MAPS_ERROR_CANCELED Places service aborted - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * - * @pre Call maps_service_create() to create Maps Service and obtain its - * handle. - * @post It invokes maps_service_search_place_cb() to deliver obtained Place - * information. - * + * @remarks @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 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 + * 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 + * @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 The request ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy + * @retval #MAPS_ERROR_CANCELED Places service aborted + * @retval #MAPS_ERROR_UNKNOWN Unknown error + * @pre Call maps_service_create() to create Maps Service and obtain its handle. + * @post It invokes maps_service_search_place_cb() to deliver obtained Place information. * @see maps_service_search_place() * @see maps_service_search_place_by_address() * @see maps_service_cancel_request() @@ -1125,59 +966,51 @@ int maps_service_search_place(const maps_service_h maps, * @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, - const maps_place_filter_h filter, - maps_preference_h preference, - maps_service_search_place_cb callback, - void *user_data, int *request_id); +int maps_service_search_place_by_area(const maps_service_h maps, const maps_area_h boundary, const maps_place_filter_h filter, maps_preference_h preference, maps_service_search_place_cb callback, void *user_data, int *request_id); + /** - * @brief Queries a Place information by a free-formed address string. - * \n The request is asynchronous. - * @details This function obtains the Place information for a specified - * free-formed address string. + * @brief Queries a Place information by a 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 @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks @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 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 - * #maps_service_data_e passed as @a data parameter. - * - * @param[in] maps The Maps Service handle - * @param[in] address The interested address - * @param[in] boundary The interested area - * @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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy - * @retval #MAPS_ERROR_CANCELED Places service aborted - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @remarks @a boundary supports 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 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 + * #maps_service_data_e passed as @a data parameter. + * @param[in] maps The Maps Service handle + * @param[in] address The interested address + * @param[in] boundary The interested area + * @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 The request ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy + * @retval #MAPS_ERROR_CANCELED Places service aborted + * @retval #MAPS_ERROR_UNKNOWN Unknown error * @pre Call maps_service_create() to create Maps Service and obtain its handle. - * @post It invokes maps_service_search_place_cb() to deliver obtained Place - * information. - * + * @post It invokes maps_service_search_place_cb() to deliver obtained Place information. * @see maps_service_search_place() * @see maps_service_search_place_by_area() * @see maps_service_cancel_request() @@ -1185,132 +1018,114 @@ int maps_service_search_place_by_area(const maps_service_h maps, * @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, - const maps_area_h boundary, - const maps_place_filter_h filter, - maps_preference_h preference, - maps_service_search_place_cb - callback, void *user_data, - int *request_id); +int maps_service_search_place_by_address(const maps_service_h maps, const char *address, const maps_area_h boundary, const maps_place_filter_h filter, maps_preference_h preference, maps_service_search_place_cb callback, void *user_data, int *request_id); + /** - * @brief Queries a brief Place information by a coordinates boundary. - * /n The request is asynchronous. + * @brief Queries a brief Place information by a coordinates boundary./n + * The request is asynchronous. * @details This function obtains the brief Place information for a specified coordinates boundary. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks 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. - * - * @param[in] maps The Maps Service handle - * @param[in] boundary The interested area - * @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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy - * @retval #MAPS_ERROR_CANCELED Places service aborted - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @remarks 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. + * @param[in] maps The Maps Service handle + * @param[in] boundary The interested area + * @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 The request ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy + * @retval #MAPS_ERROR_CANCELED Places service aborted + * @retval #MAPS_ERROR_UNKNOWN Unknown error * @pre Call maps_service_create() to create Maps Service and obtain its handle. * @post It invokes maps_service_search_place_list_cb() to deliver obtained Place information. - * * @see maps_service_get_place_details() * @see maps_service_search_place_list_cb() * @see maps_service_cancel_request() * @see maps_service_provider_is_service_supported() */ -int maps_service_search_place_list(const maps_service_h maps, - const maps_area_h boundary, - const maps_place_filter_h filter, - maps_preference_h preference, - maps_service_search_place_list_cb callback, - void *user_data, int *request_id); +int maps_service_search_place_list(const maps_service_h maps, const maps_area_h boundary, const maps_place_filter_h filter, maps_preference_h preference, maps_service_search_place_list_cb callback, void *user_data, int *request_id); + /** - * @brief Queries a Detail place information by a place uri. - * \n The request is asynchronous. - * @details This function obtains the Detail place information for a specified place uri + * @brief Queries a Detail Place information by a place uri.\n + * The request is asynchronous. + * @details This function obtains the Detail Place information for a specified place uri. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks 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. - * - * @param[in] maps The Maps Service handle - * @param[in] uri The interested place uri - * @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 - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy - * @retval #MAPS_ERROR_CANCELED Places service aborted - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @remarks 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. + * @param[in] maps The Maps Service handle + * @param[in] uri The interested place uri + * @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 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy + * @retval #MAPS_ERROR_CANCELED Places service aborted + * @retval #MAPS_ERROR_UNKNOWN Unknown error * @pre Call maps_service_create() to create Maps Service and obtain its handle. * @pre @a uri is obtained from maps_service_search_place_list() * @post It invokes maps_service_get_place_details_cb() to deliver obtained Place information. - * * @see maps_service_search_place_list() * @see maps_service_get_place_details_cb() * @see maps_service_cancel_request() * @see maps_service_provider_is_service_supported() */ -int maps_service_get_place_details(const maps_service_h maps, - const char *uri, maps_service_get_place_details_cb callback, - void *user_data, int *request_id); +int maps_service_get_place_details(const maps_service_h maps, const char *uri, maps_service_get_place_details_cb callback, void *user_data, int *request_id); + /** - * @brief Called for Place Categories information + * @brief Called for Place Categories information * @details The Maps Service invokes this callback when the Place Category obtained. - * \n If search is failed, the value of @a category is NULL - * @since_tizen 3.0 + * If search is failed, the value of @a category is NULL + * @since_tizen 4.0 * @remarks The parameter @a category must be released using maps_place_category_destroy(). - * \n This error code will be reported. \n - * #MAPS_ERROR_NONE \n - * #MAPS_ERROR_OUT_OF_MEMORY \n - * #MAPS_ERROR_INVALID_PARAMETER \n - * #MAPS_ERROR_NOT_FOUND. - * - * @param[in] error The result of request - * @param[in] request_id The request id - * @param[in] index The current index of place category data in result set, start from 0 - * @param[in] total The total number of results - * @param[in] category The resulting Place Category data - * @param[in] user_data The user data passed from maps_service_get_place_categories() - * + * This error code will be reported. \n + * #MAPS_ERROR_NONE \n + * #MAPS_ERROR_OUT_OF_MEMORY \n + * #MAPS_ERROR_INVALID_PARAMETER \n + * #MAPS_ERROR_NOT_FOUND. + * @param[in] error The result of request + * @param[in] request_id The request id + * @param[in] index The current index of place category data in result set, start from 0 + * @param[in] total The total number of results + * @param[in] category The resulting Place Category data + * @param[in] user_data The user data passed from maps_service_get_place_categories() * @pre maps_service_get_place_categories() will invoke this callback. - * * @see maps_service_get_place_categories() * @see maps_place_category_destroy() */ @@ -1319,11 +1134,12 @@ typedef bool(*maps_service_get_place_categories_cb) (maps_error_e error, maps_place_category_h category, void *user_data); + /** - * @brief Queries Place Categories information supported by current map provider. - * /n The request is asynchronous. + * @brief Queries Place Categories information supported by current map provider.\n + * The request is asynchronous. * @details This function obtains the brief Place Categories information. - * @since_tizen 3.0 + * @since_tizen 4.0 * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n @@ -1331,221 +1147,186 @@ typedef bool(*maps_service_get_place_categories_cb) (maps_error_e error, * @remarks 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. - * - * @param[in] maps The Maps Service 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 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 - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy - * @retval #MAPS_ERROR_CANCELED Places service aborted - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @param[in] maps The Maps Service 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 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 + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_RESOURCE_BUSY Places service busy + * @retval #MAPS_ERROR_CANCELED Places service aborted + * @retval #MAPS_ERROR_UNKNOWN Unknown error * @pre Call maps_service_create() to create Maps Service and obtain its handle. * @post It invokes maps_service_get_place_categories_cb() to deliver obtained Place information. - * * @see maps_service_cancel_request() * @see maps_service_provider_is_service_supported() */ -int maps_service_get_place_categories(const maps_service_h maps, - maps_preference_h preference, - maps_service_get_place_categories_cb callback, - void *user_data, int *request_id); +int maps_service_get_place_categories(const maps_service_h maps, maps_preference_h preference, maps_service_get_place_categories_cb callback, void *user_data, int *request_id); + /** * @} */ + /*----------------------------------------------------------------------------*/ /* * Route Service */ + /** - * @ingroup CAPI_MAPS_SERVICE_MODULE - * @defgroup CAPI_MAPS_ROUTE_MODULE Routes - * + * @ingroup CAPI_MAPS_SERVICE_MODULE + * @defgroup CAPI_MAPS_ROUTE_MODULE Routes * @if WEARABLE - * @section CAPI_MAPS_SERVICE_MODULE_FEATURE Related Features - * This API is related with the following features:\n - * - http://tizen.org/feature/network.internet\n - * - * It is recommended to design feature related codes in your application for reliability.\n - * - * You can check if a device supports the related features for this API by using - * @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n - * - * To ensure your application is only running on the device with specific features, - * please define the features in your manifest file using the manifest editor in the SDK.\n - * - * More details on featuring your application can be found from - * Feature List. + * @section CAPI_MAPS_SERVICE_MODULE_FEATURE Related Features + * This API is related with the following features:\n + * - http://tizen.org/feature/network.internet\n + * It is recommended to design feature related codes in your application for reliability.\n + * You can check if a device supports the related features for this API by using + * @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n + * To ensure your application is only running on the device with specific features, + * please define the features in your manifest file using the manifest editor in the SDK.\n + * More details on featuring your application can be found from + * Feature List. * @endif - * - * @addtogroup CAPI_MAPS_ROUTE_MODULE + * @addtogroup CAPI_MAPS_ROUTE_MODULE * @{ - * @brief This provides APIs for Route Service + * @brief This provides APIs for Route Service. * @details The Maps Route API provides functions to calculate a route that - * defines a path between a origin and a destination and may, optionally, pass - * through specific intermediate locations. - * + * 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. - * @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. + * @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. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @remarks The parameter @a route must be released using maps_route_destroy(). - * \n This error code will be reported. \n - * #MAPS_ERROR_NONE \n - * #MAPS_ERROR_OUT_OF_MEMORY \n - * #MAPS_ERROR_INVALID_PARAMETER \n - * #MAPS_ERROR_NOT_FOUND. - * - * @param[in] error The result of request - * @param[in] request_id The id of request - * @param[in] index The current index of Route in result set, start - * from 0 - * @param[in] total The total number of result - * @param[in] route The Route data - * @param[in] user_data The user data passed from - * maps_service_search_route() or maps_service_search_route_waypoints() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * - * @pre maps_service_search_route() or maps_service_search_route_waypoints() - * will invoke this callback. - * + * @remarks The parameter @a route must be released using maps_route_destroy().\n + * This error code will be reported. \n + * #MAPS_ERROR_NONE \n + * #MAPS_ERROR_OUT_OF_MEMORY \n + * #MAPS_ERROR_INVALID_PARAMETER \n + * #MAPS_ERROR_NOT_FOUND. + * @param[in] error The result of request + * @param[in] request_id The ID of request + * @param[in] index The current index of Route in result set, start from 0 + * @param[in] total The total number of result + * @param[in] route The Route data + * @param[in] user_data The user data passed from maps_service_search_route() or maps_service_search_route_waypoints() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop + * @pre maps_service_search_route() or maps_service_search_route_waypoints() will invoke this callback. * @see maps_service_search_route() * @see maps_service_search_route_waypoints() * @see maps_service_cancel_request() */ -typedef bool(*maps_service_search_route_cb) (maps_error_e error, - int request_id, int index, - int total, maps_route_h route, - void *user_data); +typedef bool(*maps_service_search_route_cb) (maps_error_e error, int request_id, int index, int total, maps_route_h route, void *user_data); + /** - * @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. + * @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 @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks 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 - * 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 - * @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 - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @remarks 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 + * 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 + * @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 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_UNKNOWN Unknown error * @pre Call maps_service_create() to create Maps Service and get its handle. - * @post It invokes maps_service_search_route_cb() to deliver obtained Route - * information. - * + * @post It invokes maps_service_search_route_cb() to deliver obtained Route information. * @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, - const maps_coordinates_h destination, - maps_preference_h preference, - maps_service_search_route_cb callback, - void *user_data, int *request_id); +int maps_service_search_route(const maps_service_h maps, const maps_coordinates_h origin, const maps_coordinates_h destination, maps_preference_h preference, maps_service_search_route_cb callback, void *user_data, int *request_id); + /** - * @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. + * @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 @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks 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. - * \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 - * @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 - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Service unavailable - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key - * @retval #MAPS_ERROR_UNKNOWN Unknown error - * + * @remarks 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.\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 + * @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 + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Service unavailable + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_KEY_NOT_AVAILABLE Invalid key + * @retval #MAPS_ERROR_UNKNOWN Unknown error * @pre Call maps_service_create() to create Maps Service and get its handle. - * @post It invokes maps_service_search_route_cb() to deliver obtained Route - * information. - * + * @post It invokes maps_service_search_route_cb() to deliver obtained Route information. * @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 * - waypoint_list, int waypoint_num, - maps_preference_h preference, - maps_service_search_route_cb callback, - void *user_data, int *request_id); +int maps_service_search_route_waypoints(const maps_service_h maps, const maps_coordinates_h * waypoint_list, int waypoint_num, maps_preference_h preference, maps_service_search_route_cb callback, void *user_data, int *request_id); /** * @} @@ -1554,4 +1335,4 @@ int maps_service_search_route_waypoints(const maps_service_h maps, #ifdef __cplusplus } #endif -#endif /* __MAPS_SERVICE_H__ */ +#endif /* __MAPS_SERVICE_H__ */ diff --git a/include/maps_types.h b/include/maps_types.h index 7a85a5a..05caf13 100644 --- a/include/maps_types.h +++ b/include/maps_types.h @@ -14,37 +14,35 @@ * limitations under the License. */ + #ifndef __MAPS_TYPES_H__ #define __MAPS_TYPES_H__ + /** - * * @file maps_types.h - * @brief This file contains the top level functions of Maps API - * + * @brief This file contains the top level functions of Maps API. */ #ifdef __cplusplus extern "C" { #endif + /** - * @ingroup CAPI_MAPS_SERVICE_MODULE - * @defgroup CAPI_MAPS_SERVICE_TYPES_MODULE Primary types - * + * @ingroup CAPI_MAPS_SERVICE_MODULE + * @defgroup CAPI_MAPS_SERVICE_TYPES_MODULE Primary types * @addtogroup CAPI_MAPS_SERVICE_TYPES_MODULE * @{ * @brief This provides definitions of primary types. - * */ /** - * @brief The Maps Service handle - * @details The Maps Service handle can be created by calling of maps_service_create(). - * \n To release the handle use maps_service_destroy(). + * @brief The Maps Service handle + * @details The Maps Service handle can be created by calling of maps_service_create().\n + * To release the handle use maps_service_destroy(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * * @see maps_service_create() * @see maps_service_destroy() */ @@ -52,23 +50,22 @@ typedef void *maps_service_h; /** - * @brief The View handle + * @brief The View handle * @details The handle of View instance. - * @remarks To release the handle use maps_view_destroy(). * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_view_destroy(). * @see maps_view_create() * @see maps_view_destroy() */ typedef void *maps_view_h; + /** * @} */ - #ifdef __cplusplus } #endif -#endif /* __MAPS_TYPES_H__ */ +#endif /* __MAPS_TYPES_H__ */ diff --git a/include/maps_view.h b/include/maps_view.h index e3b8728..646a299 100644 --- a/include/maps_view.h +++ b/include/maps_view.h @@ -14,52 +14,46 @@ * limitations under the License. */ + #ifndef __MAPS_VIEW_H__ #define __MAPS_VIEW_H__ + #include #include #include #include + /** - * - * @ingroup CAPI_MAPS_SERVICE_MODULE - * @defgroup CAPI_MAPS_VIEW_MODULE View - * + * @ingroup CAPI_MAPS_SERVICE_MODULE + * @defgroup CAPI_MAPS_VIEW_MODULE View * @if WEARABLE - * @section CAPI_MAPS_SERVICE_MODULE_FEATURE Related Features - * This API is related with the following features:\n - * - http://tizen.org/feature/network.internet\n - * - * It is recommended to design feature related codes in your application for reliability.\n - * - * You can check if a device supports the related features for this API by using - * @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n - * - * To ensure your application is only running on the device with specific features, - * please define the features in your manifest file using the manifest editor in the SDK.\n - * - * More details on featuring your application can be found from - * Feature List. + * @section CAPI_MAPS_SERVICE_MODULE_FEATURE Related Features + * This API is related with the following features:\n + * - http://tizen.org/feature/network.internet\n + * It is recommended to design feature related codes in your application for reliability.\n + * You can check if a device supports the related features for this API by using + * @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n + * To ensure your application is only running on the device with specific features, + * please define the features in your manifest file using the manifest editor in the SDK.\n + * More details on featuring your application can be found from + * Feature List. * @endif - * * @file maps_view.h - * @brief This file contains the top level functions of View API - * + * @brief This file contains the top level functions of View API. * @addtogroup CAPI_MAPS_VIEW_MODULE * @{ * @brief This provides APIs related to operations, used in View. * @details Supported View API features include: - * - Creating and destroying the View port, moving and resizing it - * - Changing zoom, and orientation - * - Changing properties: theme (day, satellite, terrain), - * language (English, Russian, Chinese, Italian, German, Spanish, etc.) - * - Converting screen coordinates to geographical and vise versa - * - Managing user's gestures: receiving user's gesture events, enabling or - * disabling specified user gestures, assigning View actions, which must be - * taken in response on user gestures - * . + * - Creating and destroying the View port, moving and resizing it + * - Changing zoom, and orientation + * - Changing properties: theme (day, satellite, terrain), + * language (English, Russian, Chinese, Italian, German, Spanish, etc.) + * - Converting screen coordinates to geographical and vise versa + * - Managing user's gestures: receiving user's gesture events, enabling or + * disabling specified user gestures, assigning View actions, which must be + * taken in response on user gestures. */ @@ -69,53 +63,48 @@ extern "C" { /** - * @brief Enumeration of View types (themes) + * @brief Enumeration for View types (themes). * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif */ typedef enum _maps_view_type_e { - MAPS_VIEW_TYPE_NORMAL, /**< Indicates the normal street theme */ + MAPS_VIEW_TYPE_NORMAL, /**< Indicates the normal street theme */ MAPS_VIEW_TYPE_SATELLITE, /**< Indicates the satellite theme */ - MAPS_VIEW_TYPE_TERRAIN, /**< Indicates the terrain theme */ - MAPS_VIEW_TYPE_HYBRID, /**< Indicates the hybrid theme which is the satellite and normal street theme */ + MAPS_VIEW_TYPE_TERRAIN, /**< Indicates the terrain theme */ + MAPS_VIEW_TYPE_HYBRID, /**< Indicates the hybrid theme which is the satellite and normal street theme */ } maps_view_type_e; + /** - * @brief Called when requesting the list of visual objects of the View. - * @details This callback is invoked while iterating through the list of - * visual objects, added to the View. + * @brief Called when requesting the list of visual objects of the View. + * @details This callback is invoked while iterating through the list of visual objects added to the View. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] index The current index of the visual object, start from 0 - * @param[in] total The total amount of visual objects - * @param[in] object The visual object - * @param[in] user_data The user data pointer passed from maps_view_foreach_object() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @param[in] index The current index of the visual object starts from 0 + * @param[in] total The total amount of visual objects + * @param[in] object The visual object + * @param[in] user_data The user data pointer passed from maps_view_foreach_object() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_view_foreach_object() will invoke this callback. - * * @see #maps_view_object_h * @see maps_view_foreach_object() */ typedef bool(*maps_view_object_cb) (int index, int total, maps_view_object_h object, void *user_data); + /** - * @brief Called when the View event occurs. + * @brief Called when the View event occurs. * @details The View Panel invokes this callback when the map event occurs. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks @a event_data will be released automatically after this callback is terminated. - * \n To use @a event_data outside this function, clone it with maps_view_event_data_clone(). - * - * @param[in] type The new type of callback, listed in #maps_view_event_type_e - * @param[in] event_data The event data - * @param[in] user_data The user data pointer registered in maps_view_set_event_cb() - * + * @remarks @a event_data will be released automatically after this callback is terminated.\n + * To use @a event_data outside this function, clone it with maps_view_event_data_clone(). + * @param[in] type The new type of callback, listed in #maps_view_event_type_e + * @param[in] event_data The event data + * @param[in] user_data The user data pointer registered in maps_view_set_event_cb() * @pre maps_view_set_event_cb() sets the callback. * @pre maps_view_set_center(), - * maps_view_set_zoom_level(), - * maps_view_set_orientation(), - * invoke the callback with the type #MAPS_VIEW_EVENT_ACTION. - * + * maps_view_set_zoom_level(), + * maps_view_set_orientation(), + * invoke the callback with the type #MAPS_VIEW_EVENT_ACTION. * @see maps_view_set_event_cb() * @see maps_view_set_center() * @see maps_view_set_zoom_level() @@ -123,38 +112,36 @@ typedef bool(*maps_view_object_cb) (int index, int total, maps_view_object_h obj */ typedef void(*maps_view_on_event_cb) (maps_view_event_type_e type, maps_view_event_data_h event_data, void *user_data); + /* ----------------------CREATE AND DESTROY-----------------------------------*/ + /** - * @brief Creates the View and link it to the instance of maps service. - * @details This function creates a new View widget, allocates all needed - * resources and issues its handle. - * \n The newly created View is linked to the specified maps service. - * \n The View by default is resized to fill whole parent area. - * \n To center the map on a specifies geographical coordinates with a desired - * zoom level and rotation angle use maps_view_set_center(), - * maps_view_set_zoom_level() and maps_view_set_orientation() respectively. - * \n To change View theme, size and visibility properties use - * maps_view_set_type() and maps_view_set_visibility() respectively. + * @brief Creates the View and link it to the instance of maps service. + * @details This function creates a new View widget, allocates all needed resources and issues its handle.\n + * The newly created View is linked to the specified map's service.\n + * The View by default is resized to fill whole parent area.\n + * To center the map on a specific geographical coordinates with a desired + * zoom level and rotation angle, use maps_view_set_center(), + * maps_view_set_zoom_level() and maps_view_set_orientation() respectively.\n + * To change View theme, size and visibility properties use + * maps_view_set_type() and maps_view_set_visibility() respectively. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice * @remarks The @a View must be released using maps_view_destroy(). - * - * @param[in] maps The maps service handle - * @param[in] obj The evas object to be drawn - * @param[out] view The handle pointer to a maps_view_h, - * in which to store the newly created View handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] maps The maps service handle + * @param[in] obj The evas object to be drawn + * @param[out] view The handle pointer to a maps_view_h, in which to store the newly created View handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a maps is created using maps_service_create(). * @pre @a obj is recommended using a smart object. - * * @see maps_view_destroy() * @see maps_service_create() * @see maps_view_set_center() @@ -166,55 +153,49 @@ typedef void(*maps_view_on_event_cb) (maps_view_event_type_e type, maps_view_eve */ int maps_view_create(maps_service_h maps, Evas_Object *obj, maps_view_h *view); + /** - * @brief Destroys the View. - * @details This function destroys the View, releases its handle and - * all allocated resources, unlinks the View from the instance of maps service. + * @brief Destroys the View. + * @details This function destroys the View, releases its handle and all allocated resources, unlinks the View from the instance of maps service. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice - * - * @param[in] view The View handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The View handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a View is created using maps_view_create(). - * * @see maps_view_create() - * */ int maps_view_destroy(maps_view_h view); /*----------------------MAP ZOOM, ROTATE, SET CENTER--------------------------*/ + /** - * @brief Centers the map on a given geographical coordinates. - * @details This function centers the map on a given geographical coordinates - * using current zoom and orientation. + * @brief Centers the map on a given geographical coordinates. + * @details This function centers the map on a given geographical coordinates using current zoom and orientation. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * - * @param[in] view The view handle - * @param[in] coordinates The geographical coordinates of the position to - * be centered on the View - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] coordinates The geographical coordinates of the position to be centered on the View + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). * @pre @a coordinates are created using maps_coordinates_create(). - * * @see maps_view_get_center() * @see maps_view_set_zoom_level() * @see maps_view_set_orientation() @@ -223,23 +204,22 @@ int maps_view_destroy(maps_view_h view); */ int maps_view_set_center(maps_view_h view, maps_coordinates_h coordinates); + /** - * @brief Gets the central coordinates of a map. + * @brief Gets the central coordinates of a map. * @details This function gets the current central coordinates of a map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks The @a coordinates must be released using maps_coordinates_destroy(). - * - * @param[in] view The view handle - * @param[out] coordinates The pointer to #maps_coordinates_h in which to - * store the geographical coordinates of the central position of the map - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] coordinates The pointer to #maps_coordinates_h in which to + * store the geographical coordinates of the central position of the map + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_set_center() * @see maps_view_get_zoom_level() * @see maps_view_get_orientation() @@ -248,31 +228,30 @@ int maps_view_set_center(maps_view_h view, maps_coordinates_h coordinates); */ int maps_view_get_center(const maps_view_h view, maps_coordinates_h *coordinates); + /** - * @brief Sets zoom level of the map. - * @details This function sets the integer zoom level of the map. - * \n If the specified zoom level exceeds the maps Provider allowed zoom range, - * the function returns #MAPS_ERROR_INVALID_PARAMETER error. - * \n To check the range of allowed zoom level use maps_view_get_min_zoom_level() - * and maps_view_get_max_zoom_level(). + * @brief Sets zoom level of the map. + * @details This function sets the integer zoom level of the map.\n + * If the specified zoom level exceeds the maps Provider allowed zoom range, + * the function returns #MAPS_ERROR_INVALID_PARAMETER error.\n + * To check the range of allowed zoom level use maps_view_get_min_zoom_level() + * and maps_view_get_max_zoom_level(). * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * - * @param[in] view The view handle - * @param[in] level The new zoom level - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] level The new zoom level + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_get_zoom_level() * @see maps_view_set_orientation() * @see maps_view_get_min_zoom_level() @@ -281,21 +260,19 @@ int maps_view_get_center(const maps_view_h view, maps_coordinates_h *coordinates */ int maps_view_set_zoom_level(maps_view_h view, int level); + /** - * @brief Gets zoom level of the map. + * @brief Gets zoom level of the map. * @details This function gets the current integer zoom level of the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] level The pointer to an integer in which to store the - * current zoom level - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] level The pointer to an integer in which to store the current zoom level + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_set_zoom_level() * @see maps_view_get_min_zoom_level() * @see maps_view_get_max_zoom_level() @@ -303,24 +280,23 @@ int maps_view_set_zoom_level(maps_view_h view, int level); */ int maps_view_get_zoom_level(const maps_view_h view, int *level); + /** - * @brief Sets the minimal zoom level of the map. + * @brief Sets the minimal zoom level of the map. * @details This function sets the minimally allowed zoom level of the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice - * - * @param[in] view The view handle - * @param[out] level The new minimal zoom level - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] level The new minimal zoom level + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_get_min_zoom_level() * @see maps_view_set_max_zoom_level() * @see maps_view_get_max_zoom_level() @@ -330,22 +306,20 @@ int maps_view_get_zoom_level(const maps_view_h view, int *level); */ int maps_view_set_min_zoom_level(maps_view_h view, int level); + /** - * @brief Gets the minimal zoom level of the map. + * @brief Gets the minimal zoom level of the map. * @details This function gets the minimally allowed zoom level of the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] min_zoom_level The pointer to an integer in which to store the - * minimally allowed zoom level - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] min_zoom_level The pointer to an integer in which to store the minimally allowed zoom level + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_get_max_zoom_level() * @see maps_view_get_zoom_level() * @see maps_view_set_zoom_level() @@ -353,24 +327,23 @@ int maps_view_set_min_zoom_level(maps_view_h view, int level); */ int maps_view_get_min_zoom_level(const maps_view_h view, int *min_zoom_level); + /** - * @brief Sets the maximal zoom level of the map. + * @brief Sets the maximal zoom level of the map. * @details This function sets the maximally allowed zoom level of the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice - * - * @param[in] view The view handle - * @param[out] level The new maximal zoom level - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] level The new maximal zoom level + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_set_min_zoom_level() * @see maps_view_get_min_zoom_level() * @see maps_view_get_max_zoom_level() @@ -380,22 +353,20 @@ int maps_view_get_min_zoom_level(const maps_view_h view, int *min_zoom_level); */ int maps_view_set_max_zoom_level(maps_view_h view, int level); + /** - * @brief Gets the maximal zoom level of the map. + * @brief Gets the maximal zoom level of the map. * @details This function gets the maximally allowed zoom level of the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] max_zoom_level The pointer to an integer in which to store the - * maximally allowed zoom level - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] max_zoom_level The pointer to an integer in which to store the maximally allowed zoom level + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_get_min_zoom_level() * @see maps_view_get_zoom_level() * @see maps_view_set_zoom_level() @@ -403,50 +374,47 @@ int maps_view_set_max_zoom_level(maps_view_h view, int level); */ int maps_view_get_max_zoom_level(const maps_view_h view, int *max_zoom_level); + /** - * @brief Sets the orientation on the View. - * @details This function sets the rotation angle of the View. - * \n If the specified rotation angle exceeds the [0..360] range, the - * function returns #MAPS_ERROR_INVALID_PARAMETER error. + * @brief Sets the orientation on the View. + * @details This function sets the rotation angle of the View.\n + * If the specified rotation angle exceeds the [0..360] range, + * the function returns #MAPS_ERROR_INVALID_PARAMETER error. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * - * @param[in] view The view handle - * @param[in] angle The new orientation angle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] angle The new orientation angle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_get_orientation() * @see maps_view_set_zoom_level() * @see maps_view_create() */ int maps_view_set_orientation(maps_view_h view, double angle); + /** - * @brief Gets the orientation. + * @brief Gets the orientation. * @details This function gets the current map rotation angle on the View. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] rotation_angle The pointer to a double in which to store the - * current rotation angle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] rotation_angle The pointer to a double in which to store the current rotation angle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_set_orientation() * @see maps_view_get_zoom_level() * @see maps_view_create() @@ -456,95 +424,86 @@ int maps_view_get_orientation(const maps_view_h view, double *rotation_angle); /*----------------------SCREEN <--> GEOGRAPHY---------------------------------*/ + /** - * @brief Converts screen coordinates to the geographical coordinates. - * @details This function converts screen coordinates to the geographical - * coordinates accordingly to the current map zoom and orientation. + * @brief Converts screen coordinates to the geographical coordinates. + * @details This function converts screen coordinates to the geographical coordinates accordingly to the current map zoom and orientation. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice * @remarks The @a coordinates must be released using maps_coordinates_destroy(). - * - * @param[in] view The view handle - * @param[in] x The x coordinate on the screen - * @param[in] y The y coordinate on the screen - * @param[out] coordinates The pointer to a #maps_coordinates_h in which to - * store the handle of geographical coordinates, corresponding to given screen - * coordinates - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] x The x coordinate on the screen + * @param[in] y The y coordinate on the screen + * @param[out] coordinates The pointer to a #maps_coordinates_h in which to store the handle of geographical coordinates, + * corresponding to given screen coordinates + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_geolocation_to_screen() * @see #maps_coordinates_h * @see maps_coordinates_destroy() * @see maps_view_create() */ -int maps_view_screen_to_geolocation(maps_view_h view, - int x, int y, maps_coordinates_h *coordinates); +int maps_view_screen_to_geolocation(maps_view_h view, int x, int y, maps_coordinates_h *coordinates); + /** - * @brief Converts geographical coordinates to the screen coordinates. + * @brief Converts geographical coordinates to the screen coordinates. * @details This function converts geographical coordinates to the screen - * coordinates accordingly to the current map zoom and orientation. + * coordinates accordingly to the current map zoom and orientation. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice - * - * @param[in] view The view handle - * @param[in] coordinates The geographical coordinates - * @param[out] x The pointer to an integer in which to store the - * x coordinate on the screen, corresponding to given geographical coordinates - * @param[out] y The pointer to an integer in which to store the - * y coordinate on the screen, corresponding to given geographical coordinates - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] coordinates The geographical coordinates + * @param[out] x The pointer to an integer in which to store the x coordinate on the screen, + * corresponding to given geographical coordinates + * @param[out] y The pointer to an integer in which to store the y coordinate on the screen, + * corresponding to given geographical coordinates + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). * @pre @a coordinates is created using maps_coordinates_create(). - * * @see maps_view_screen_to_geolocation() * @see #maps_coordinates_h * @see maps_coordinates_create() * @see maps_view_create() */ -int maps_view_geolocation_to_screen(maps_view_h view, - const maps_coordinates_h coordinates, int *x, int *y); +int maps_view_geolocation_to_screen(maps_view_h view, const maps_coordinates_h coordinates, int *x, int *y); /* --------------------VIEW PREFERENCES----------------------------------*/ /** - * @brief Sets View type. - * @details This function switches the View to a specified type, one of - * listed in #maps_view_type_e enumeration. + * @brief Sets View type. + * @details This function switches the View to a specified type, one of listed in #maps_view_type_e enumeration. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * - * @param[in] view The view handle - * @param[in] type The view type, one of listed in #maps_view_type_e - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] type The view type, one of listed in #maps_view_type_e + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see #maps_view_type_e * @see maps_view_get_type() * @see maps_view_set_language() @@ -552,22 +511,20 @@ int maps_view_geolocation_to_screen(maps_view_h view, */ int maps_view_set_type(maps_view_h view, maps_view_type_e type); + /** - * @brief Gets View type. - * @details This function gets the type of the given View. - * \n The type options are defined in the #maps_view_type_e enumeration. + * @brief Gets View type. + * @details This function gets the type of the given View.\n + * The type options are defined in the #maps_view_type_e enumeration. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] type The pointer to a #maps_view_type_e in which to - * store current view type - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] type The pointer to a #maps_view_type_e in which to store current view type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see #maps_view_type_e * @see maps_view_set_type() * @see maps_view_get_language() @@ -575,263 +532,245 @@ int maps_view_set_type(maps_view_h view, maps_view_type_e type); */ int maps_view_get_type(const maps_view_h view, maps_view_type_e *type); + /** - * @brief Indicates whether the map should show the 3D buildings layer. - * @details This function is called to indicate whether 3D buildings - * should be shown as a layer on the map. + * @brief Indicates whether the map should show the 3D buildings layer. + * @details This function is called to indicate whether 3D buildings should be shown as a layer on the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks To check if Maps Provider is capable of drawing 3D buildings, - * use maps_service_provider_is_data_supported() with - * #MAPS_VIEW_BUILDING passed as a service data parameter. - * - * @param[in] view The view handle - * @param[in] enable The enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks To check if Maps Provider is capable of drawing 3D buildings, + * use maps_service_provider_is_data_supported() with + * #MAPS_VIEW_BUILDING passed as a service data parameter. + * @param[in] view The view handle + * @param[in] enable The enable status + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_create() * @see maps_view_get_buildings_enabled() * @see maps_service_provider_is_data_supported() */ int maps_view_set_buildings_enabled(maps_view_h view, bool enable); + /** - * @brief Queries whether the map has the 3D buildings layer enabled. - * @details This function checks whether the map is set to show the 3D buildings layer. + * @brief Queries whether the map has the 3D buildings layer enabled. + * @details This function checks whether the map is set to show the 3D buildings layer. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] enable The pointer to a boolean in which to store the enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] enable The pointer to a boolean in which to store the enable status + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_create() * @see maps_view_set_buildings_enabled() * @see maps_service_provider_is_data_supported() */ int maps_view_get_buildings_enabled(const maps_view_h view, bool *enable); + /** - * @brief Indicates whether the map should show the traffic layer. - * @details This function is called to indicate whether traffic conditions - * should be shown as a layer on the map. + * @brief Indicates whether the map should show the traffic layer. + * @details This function is called to indicate whether traffic conditions should be shown as a layer on the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks To check if Maps Provider is capable of drawing traffic conditions, - * use maps_service_provider_is_data_supported() with - * #MAPS_VIEW_TRAFFIC passed as a service data parameter. - * - * @param[in] view The view handle - * @param[in] enable The enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks To check if Maps Provider is capable of drawing traffic conditions, + * use maps_service_provider_is_data_supported() with + * #MAPS_VIEW_TRAFFIC passed as a service data parameter. + * @param[in] view The view handle + * @param[in] enable The enable status + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_create() * @see maps_view_get_traffic_enabled() * @see maps_service_provider_is_data_supported() */ int maps_view_set_traffic_enabled(maps_view_h view, bool enable); + /** - * @brief Queries whether the map has the traffic layer enabled. - * @details This function checks whether the map is set to show the traffic layer. + * @brief Queries whether the map has the traffic layer enabled. + * @details This function checks whether the map is set to show the traffic layer. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] enable The pointer to a boolean in which to store the enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] enable The pointer to a boolean in which to store the enable status + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_create() * @see maps_view_set_traffic_enabled() * @see maps_service_provider_is_data_supported() */ int maps_view_get_traffic_enabled(const maps_view_h view, bool *enable); + /** - * @brief Indicates whether the map should show the public transit layer. - * @details This function is called to indicate whether public transit routes - * should be shown as a layer on the map. + * @brief Indicates whether the map should show the public transit layer. + * @details This function is called to indicate whether public transit routes should be shown as a layer on the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks To check if Maps Provider is capable of drawing public transit routes, - * use maps_service_provider_is_data_supported() with - * #MAPS_VIEW_PUBLIC_TRANSIT passed as a service data parameter. - * - * @param[in] view The view handle - * @param[in] enable The enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks To check if Maps Provider is capable of drawing public transit routes, + * use maps_service_provider_is_data_supported() with + * #MAPS_VIEW_PUBLIC_TRANSIT passed as a service data parameter. + * @param[in] view The view handle + * @param[in] enable The enable status + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_create() * @see maps_view_get_public_transit_enabled() * @see maps_service_provider_is_data_supported() */ int maps_view_set_public_transit_enabled(maps_view_h view, bool enable); + /** - * @brief Queries whether the map has the public transit layer enabled. - * @details This function checks whether the map is set to show the public transit routes layer. + * @brief Queries whether the map has the public transit layer enabled. + * @details This function checks whether the map is set to show the public transit routes layer. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] enable The pointer to a boolean in which to store the enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] enable The pointer to a boolean in which to store the enable status + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_create() * @see maps_view_set_public_transit_enabled() * @see maps_service_provider_is_data_supported() */ int maps_view_get_public_transit_enabled(const maps_view_h view, bool *enable); + /** - * @brief Sets View language. - * @details This function sets the language to the given View. - * \n Note that map display language is different from places and route - * language. + * @brief Sets View language. + * @details This function sets the language to the given View.\n + * Note that map display language is different from places and route language. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * - * @remarks If specific language wasn't set explicitly or map tile doesn't - * support the requested language, the default language of your Maps Provider - * is used. - * \n In general, Map Provider set the - * default language as the mother tongue of the country or English. - * - * @param[in] view The view handle - * @param[in] language The display language in the map. - * A language is specified as an ISO 3166 alpha-2 two letter country-code - * followed by ISO 639-1 for the two-letter language code. - * Each language tag is composed of one or more "subtags" separated by hyphens (-). - * Each subtag is composed of basic Latin letters or digits only. - * For example, "ko-KR" for Korean, "en-US" for American English. - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks If specific language wasn't set explicitly or map tile doesn't support the requested language, + * the default language of your Maps Provider is used.\n + * In general, Map Provider set the default language as the mother tongue of the country or English. + * @param[in] view The view handle + * @param[in] language The display language in the map. + * A language is specified as an ISO 3166 alpha-2 two letter country-code + * followed by ISO 639-1 for the two-letter language code. + * Each language tag is composed of one or more "subtags" separated by hyphens (-). + * Each subtag is composed of basic Latin letters or digits only. + * For example, "ko-KR" for Korean, "en-US" for American English + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_get_language() * @see maps_view_set_type() * @see maps_view_create() */ int maps_view_set_language(maps_view_h view, const char *language); + /** - * @brief Gets View language. - * @details This function gets the language set to the View. - * \n Note that map display language is different from places and route language. - * @remarks The @a language should be freed using free(). + * @brief Gets View language. + * @details This function gets the language set to the View.\n + * Note that map display language is different from places and route language. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] language The pointer to a char* in which to store the - * language string value - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks The @a language should be freed using free(). + * @param[in] view The view handle + * @param[out] language The pointer to a char* in which to store the language string value + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_set_language() * @see maps_view_get_type() * @see maps_view_create() */ int maps_view_get_language(const maps_view_h view, char **language); + /** - * @brief Enables or disables scalebar. + * @brief Enables or disables scalebar. * @details This function enables or disables scalebar. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * - * @param[in] view The view handle - * @param[in] enable The enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] enable The enable status + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_create() * @see maps_view_get_scalebar_enabled() */ int maps_view_set_scalebar_enabled(maps_view_h view, bool enable); + /** - * @brief Gets whether the scalebar is enabled or not. - * @details This function gets whether the scale bar is enabled or not. + * @brief Gets whether the scalebar is enabled or not. + * @details This function gets whether the scalebar is enabled or not. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] enabled The pointer to a boolean in which to store the enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] enabled The pointer to a boolean in which to store the enable status + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_create() * @see maps_view_set_scalebar_enabled() */ @@ -842,52 +781,46 @@ int maps_view_get_scalebar_enabled(const maps_view_h view, bool *enabled); /** - * @brief Gets the View port. + * @brief Gets the View port. * @details This function gets the View port as a pointer on Evas_Object. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] viewport The pointer to Evas_Object in which to store - * the View port - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] viewport The pointer to Evas_Object in which to store the View port + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_create() * @see Evas_Object */ int maps_view_get_viewport(const maps_view_h view, Evas_Object **viewport); + /** - * @brief Sets geometry of View port. - * @details This function set the position and (rectangular) size of the given - * View. - * \n The position, naturally, will be relative to the top left corner of the - * parent window. + * @brief Sets geometry of View port. + * @details This function set the position and (rectangular) size of the given View.\n + * The position, naturally, will be relative to the top left corner of the parent window. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * - * @param[in] view The view handle - * @param[in] x X screen coordinate for the top left corner of View - * @param[in] y Y screen coordinate for the top left corner of View - * @param[in] width The new width of View, in screen units - * @param[in] height The new height of View, in screen units - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] x X screen coordinate for the top left corner of View + * @param[in] y Y screen coordinate for the top left corner of View + * @param[in] width The new width of View in screen units + * @param[in] height The new height of View in screen units + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_get_screen_location() * @see maps_view_resize() * @see maps_view_set_visibility() @@ -895,26 +828,24 @@ int maps_view_get_viewport(const maps_view_h view, Evas_Object **viewport); */ int maps_view_set_screen_location(maps_view_h view, int x, int y, int width, int height); + /** - * @brief Gets geometry of View port. - * @details This function retrieves the position and (rectangular) size of the given View. - * \n The position, naturally, will be relative to the top left corner of the parent window. - * @remarks Use NULL pointers on the geometry components you're not - * interested in. + * @brief Gets geometry of View port. + * @details This function retrieves the position and (rectangular) size of the given View.\n + * The position, naturally, will be relative to the top left corner of the parent window. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] x X screen coordinate for the top left corner of View - * @param[out] y Y screen coordinate for the left top corner of View - * @param[out] width The pointer to an integer in which to store the width of the view - * @param[out] height The pointer to an integer in which to store the height of the view - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks Use NULL pointers on the geometry components you're not interested in. + * @param[in] view The view handle + * @param[out] x X screen coordinate for the top left corner of View + * @param[out] y Y screen coordinate for the left top corner of View + * @param[out] width The pointer to an integer in which to store the width of the view + * @param[out] height The pointer to an integer in which to store the height of the view + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_set_screen_location() * @see maps_view_resize() * @see maps_view_get_visibility() @@ -922,22 +853,21 @@ int maps_view_set_screen_location(maps_view_h view, int x, int y, int width, int */ int maps_view_get_screen_location(const maps_view_h view, int *x, int *y, int *width, int *height); + /** - * @brief Moves the View. + * @brief Moves the View. * @details This function moves View. - * @remarks Newly created View port has the size of its parent. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[in] x The new x position, in screen units - * @param[in] y The new y position, in screen units - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks Newly created View port has the size of its parent. + * @param[in] view The view handle + * @param[in] x The new x position, in screen units + * @param[in] y The new y position, in screen units + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_set_screen_location() * @see maps_view_get_screen_location() * @see maps_view_set_visibility() @@ -945,29 +875,28 @@ int maps_view_get_screen_location(const maps_view_h view, int *x, int *y, int *w */ int maps_view_move(maps_view_h view, int x, int y); + /** - * @brief Resizes the View. + * @brief Resizes the View. * @details This function changes the size of the given View. - * @remarks Newly created View port has the size of its parent. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif + * @remarks Newly created View port has the size of its parent. * @privlevel public * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * - * @param[in] view The view handle - * @param[in] width The new new width, in screen units - * @param[in] height The new new height, in screen units - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer - * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] width The new new width in screen units + * @param[in] height The new new height in screen units + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_CONNECTION_TIME_OUT Timeout error, no answer + * @retval #MAPS_ERROR_NETWORK_UNREACHABLE Network unavailable + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_set_screen_location() * @see maps_view_get_screen_location() * @see maps_view_set_visibility() @@ -975,41 +904,38 @@ int maps_view_move(maps_view_h view, int x, int y); */ int maps_view_resize(maps_view_h view, int width, int height); + /** - * @brief Shows or hides the View. + * @brief Shows or hides the View. * @details This function changes the visibility of View on the screen. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[in] visible The new visibility of the View - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] visible The new visibility of the View + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_get_visibility() * @see maps_view_set_screen_location() * @see maps_view_create() */ int maps_view_set_visibility(maps_view_h view, bool visible); + /** - * @brief Gets the View visibility. + * @brief Gets the View visibility. * @details This function retrieves whether or not the given View is visible. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[out] visible The pointer to a boolean in which to store the - * visibility of the View - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[out] visible The pointer to a boolean in which to store the visibility of the View + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_set_visibility() * @see maps_view_set_screen_location() * @see maps_view_create() @@ -1019,91 +945,85 @@ int maps_view_get_visibility(const maps_view_h view, bool *visible); /* ---------------------UI CONTROL------------------------------------------*/ + /** - * @brief Sets the event callback. - * @details This function sets the callback which will be invoked every time the - * View processes the user's gesture, action and objects over the map. + * @brief Sets the event callback. + * @details This function sets the callback which will be invoked every time the View processes the user's gesture, action and objects over the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks To unregister the callback use maps_view_unset_event_cb(). - * - * @param[in] view The view handle - * @param[in] type The event type - * @param[in] callback The callback, matching the maps_view_on_event_cb() prototype - * @param[in] user_data The user data pointer to be passed to the callback - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] type The event type + * @param[in] callback The callback, matching the maps_view_on_event_cb() prototype + * @param[in] user_data The user data pointer to be passed to the callback + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_unset_event_cb() * @see maps_view_on_event_cb() * @see maps_view_set_gesture_enabled() * @see maps_view_create() */ -int maps_view_set_event_cb(maps_view_h view, maps_view_event_type_e type, - maps_view_on_event_cb callback, void *user_data); +int maps_view_set_event_cb(maps_view_h view, maps_view_event_type_e type, maps_view_on_event_cb callback, void *user_data); + /** - * @brief Unsets the event callback. + * @brief Unsets the event callback. * @details This function unsets the event callback. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[in] type The event type - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] type The event type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). * @pre the event callback is registered using maps_view_set_event_cb() - * * @see maps_view_set_event_cb() * @see maps_view_get_gesture_enabled() * @see maps_view_create() */ int maps_view_unset_event_cb(maps_view_h view, maps_view_event_type_e type); + /** - * @brief Enables or disables the map gesture. + * @brief Enables or disables the map gesture. * @details This function enables or disables the map gesture. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[in] gesture The user gesture, one of listed in #maps_view_gesture_e - * @param[in] enabled The enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] gesture The user gesture, one of listed in #maps_view_gesture_e + * @param[in] enabled The enable status + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see #maps_view_gesture_e * @see maps_view_get_gesture_enabled() * @see maps_view_create() */ int maps_view_set_gesture_enabled(maps_view_h view, maps_view_gesture_e gesture, bool enabled); + /** - * @brief Checks whether the map gesture is enabled or not. + * @brief Checks whether the map gesture is enabled or not. * @details This function checks whether the map gesture is enabled or not. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] view The view handle - * @param[in] gesture The user gesture, one of listed in #maps_view_gesture_e - * @param[out] enabled The pointer to a boolean in which to store the enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] gesture The user gesture, one of listed in #maps_view_gesture_e + * @param[out] enabled The pointer to a boolean in which to store the enable status + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). * @pre @a enabled status set ad default or modified using - * maps_view_set_gesture_enabled(). - * + * maps_view_set_gesture_enabled(). * @see #maps_view_gesture_e * @see maps_view_set_gesture_enabled() * @see maps_view_create() @@ -1113,28 +1033,25 @@ int maps_view_get_gesture_enabled(const maps_view_h view, maps_view_gesture_e ge /* ---------------------VISUAL OBJECTS ON THE MAP-----------------------------*/ + /** - * @brief Adds a visual object on the map. + * @brief Adds a visual object on the map. * @details This function adds a visual object on the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice - * @remarks The @a object handle will be released automatically when the view is - * destroyed in the maps_view_destroy(). - * - * @param[in] view The view handle - * @param[in] object The handle of the object to add - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks The @a object handle will be released automatically when the view is destroyed in the maps_view_destroy(). + * @param[in] view The view handle + * @param[in] object The handle of the object to add + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * @pre @a object is created using #maps_view_object_create_marker(), - * maps_view_object_create_polygon(), maps_view_object_create_polyline() or - * maps_view_object_create_group() - * + * @pre @a object is created using #maps_view_object_create_marker(), maps_view_object_create_polygon(), + * maps_view_object_create_polyline() or maps_view_object_create_group(). * @see #maps_view_object_h * @see maps_view_object_create_marker() * @see maps_view_object_create_polygon() @@ -1145,25 +1062,24 @@ int maps_view_get_gesture_enabled(const maps_view_h view, maps_view_gesture_e ge */ int maps_view_add_object(maps_view_h view, maps_view_object_h object); + /** - * @brief Removes a visual object from the map. + * @brief Removes a visual object from the map. * @details This function removes a visual object from the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice * @remarks The @a object handle will be released automatically by the View. - * - * @param[in] view The view handle - * @param[in] object The object to remove - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] object The object to remove + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). * @pre @a object is added using maps_view_add_object(). - * * @see maps_view_add_object() * @see maps_view_remove_all_objects() * @see #maps_view_object_h @@ -1171,24 +1087,23 @@ int maps_view_add_object(maps_view_h view, maps_view_object_h object); */ int maps_view_remove_object(maps_view_h view, maps_view_object_h object); + /** - * @brief Removes all visual objects from the map. + * @brief Removes all visual objects from the map. * @details This function removes all visual object from the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice * @remarks All object handles will be released automatically by the View. - * - * @param[in] view The view handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). * @pre objects are added using maps_view_add_object(). - * * @see #maps_view_object_h * @see maps_view_add_object() * @see maps_view_remove_all_objects() @@ -1196,26 +1111,24 @@ int maps_view_remove_object(maps_view_h view, maps_view_object_h object); */ int maps_view_remove_all_objects(maps_view_h view); + /** - * @brief Retrieves all visual objects on the map. - * @details This function retrieves all visual objects, previously added to the map. + * @brief Retrieves all visual objects on the map. + * @details This function retrieves all visual objects previously added to the map. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks The objects will be delivered via maps_view_object_cb(). - * - * @param[in] view The view handle - * @param[in] callback The callback function to invoke - * @param[in] user_data The user data pointer 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data pointer to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). * @pre objects are added using maps_view_add_object(). - * @post This function invokes maps_view_object_cb() repeatedly to retrieve each - * visual object. - * + * @post This function invokes maps_view_object_cb() repeatedly to retrieve each visual object. * @see #maps_view_object_h * @see maps_view_object_cb() * @see maps_view_add_object() @@ -1242,10 +1155,11 @@ int maps_view_get_max_tilt_angle(const maps_view_h view, double *max_angle); * @} */ + #ifdef __cplusplus } #endif /** * @} */ -#endif /* __MAPS_VIEW_H__*/ +#endif /* __MAPS_VIEW_H__*/ diff --git a/include/maps_view_event_data.h b/include/maps_view_event_data.h index 0e67d56..4effff6 100644 --- a/include/maps_view_event_data.h +++ b/include/maps_view_event_data.h @@ -20,21 +20,19 @@ /** * - * @ingroup CAPI_MAPS_VIEW_MODULE - * @defgroup CAPI_MAPS_VIEW_EVENT_DATA_MODULE View Event Data - * + * @ingroup CAPI_MAPS_VIEW_MODULE + * @defgroup CAPI_MAPS_VIEW_EVENT_DATA_MODULE View Event Data * @file maps_view_event_data.h * @brief This file contains the functions related to View Event Data information. - * * @addtogroup CAPI_MAPS_VIEW_EVENT_DATA_MODULE * @{ * @brief This provides APIs related to operations, used in View Event Data. * @details Supported Event types are following: - * - User gesture over the Map - * - Map action, such as zooming or rotation - * - Object Event, such as pressing or moving - * - View readiness - * . + * - User gesture over the Map + * - Map action, such as zooming or rotation + * - Object Event, such as pressing or moving + * - View readiness + * * @par Features available by Event Type * The correspondence between the type of event and available event data * is following: @@ -67,8 +65,6 @@ * * Note: the event of type #MAPS_VIEW_EVENT_READY has no additional data besides the * type. - * - */ @@ -81,122 +77,116 @@ extern "C" { /** - * @brief The View Event data handle + * @brief The View Event data handle. * @details The handle of View Event Data instance. - * @remarks To release the handle use maps_view_event_data_destroy(). - * \n To clone the handle use maps_view_event_data_clone(). * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * + * @remarks To release the handle use maps_view_event_data_destroy().\n + * To clone the handle use maps_view_event_data_clone(). * @see maps_view_event_data_destroy() * @see maps_view_event_data_clone() */ typedef void *maps_view_event_data_h; + /** - * @brief Enumerations of View actions - * @details This is an enumeration of View actions is capable to perform. + * @brief Enumeration for View actions. + * @details This is an enumeration of View actions capable to perform. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks The View performs actions in response on user gestures, such as tap, - * zoom, long press, or APIs, such as set center or change zoom level. - * \n To re-assign View actions to user gestures use maps_view_set_gesture_action(). - * + * @remarks The View performs actions in response on user gestures, such as tap, zoom, long press, or APIs, such as set center or change zoom level.\n + * To re-assign View actions to user gestures use maps_view_set_gesture_action(). * @see #maps_view_gesture_e */ typedef enum _maps_view_action_e { - MAPS_VIEW_ACTION_NONE, /** Indicates the empty action */ - MAPS_VIEW_ACTION_SCROLL, /** Indicates the set center action */ - MAPS_VIEW_ACTION_ZOOM, /** Indicates the zoom action */ - MAPS_VIEW_ACTION_ZOOM_IN, /** Indicates the zoom-in action */ - MAPS_VIEW_ACTION_ZOOM_OUT, /** Indicates the zoom-out action */ + MAPS_VIEW_ACTION_NONE, /** Indicates the empty action */ + MAPS_VIEW_ACTION_SCROLL, /** Indicates the set center action */ + MAPS_VIEW_ACTION_ZOOM, /** Indicates the zoom action */ + MAPS_VIEW_ACTION_ZOOM_IN, /** Indicates the zoom-in action */ + MAPS_VIEW_ACTION_ZOOM_OUT, /** Indicates the zoom-out action */ MAPS_VIEW_ACTION_ZOOM_AND_SCROLL, /** Indicates the zoom and scrolling action */ - MAPS_VIEW_ACTION_ROTATE, /** Indicates the rotation action */ - MAPS_VIEW_ACTION_TILT, /** Indicates the tilt action */ + MAPS_VIEW_ACTION_ROTATE, /** Indicates the rotation action */ + MAPS_VIEW_ACTION_TILT, /** Indicates the tilt action (Since 4.0) */ } maps_view_action_e; + /** - * @brief Enumeration of user gestures over View + * @brief Enumeration for user gestures over View. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif */ typedef enum _maps_view_gesture_e { - MAPS_VIEW_GESTURE_NONE, /**< Indicates the empty gesture */ - MAPS_VIEW_GESTURE_SCROLL, /**< Indicates the move map user gesture */ - MAPS_VIEW_GESTURE_ZOOM, /**< Indicates the zoom user gesture */ - MAPS_VIEW_GESTURE_TAP, /**< Indicates the tap user gesture */ - MAPS_VIEW_GESTURE_DOUBLE_TAP, /**< Indicates the double tap user gesture */ - MAPS_VIEW_GESTURE_2_FINGER_TAP, /**< Indicates the two-finger tap user gesture */ - MAPS_VIEW_GESTURE_ROTATE, /**< Indicates the rotation user gesture */ - MAPS_VIEW_GESTURE_LONG_PRESS, /**< Indicates the long press user gesture */ - MAPS_VIEW_GESTURE_TILT, /**< Indicates the tilt user gesture */ + MAPS_VIEW_GESTURE_NONE, /**< Indicates the empty gesture */ + MAPS_VIEW_GESTURE_SCROLL, /**< Indicates the move map user gesture */ + MAPS_VIEW_GESTURE_ZOOM, /**< Indicates the zoom user gesture */ + MAPS_VIEW_GESTURE_TAP, /**< Indicates the tap user gesture */ + MAPS_VIEW_GESTURE_DOUBLE_TAP, /**< Indicates the double tap user gesture */ + MAPS_VIEW_GESTURE_2_FINGER_TAP, /**< Indicates the two-finger tap user gesture */ + MAPS_VIEW_GESTURE_ROTATE, /**< Indicates the rotation user gesture */ + MAPS_VIEW_GESTURE_LONG_PRESS, /**< Indicates the long press user gesture */ + MAPS_VIEW_GESTURE_TILT, /**< Indicates the tilt user gesture (Since 4.0) */ } maps_view_gesture_e; + /** - * @brief Enumerations of map event types + * @brief Enumeration for map event types. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif */ typedef enum _maps_view_event_type_e { MAPS_VIEW_EVENT_GESTURE, /**< Indicates the gesture event callback */ - MAPS_VIEW_EVENT_ACTION, /**< Indicates the action callback */ - MAPS_VIEW_EVENT_OBJECT, /**< Indicates the object event callback */ - MAPS_VIEW_EVENT_READY /**< Indicates the View readiness callback */ + MAPS_VIEW_EVENT_ACTION, /**< Indicates the action callback */ + MAPS_VIEW_EVENT_OBJECT, /**< Indicates the object event callback */ + MAPS_VIEW_EVENT_READY /**< Indicates the View readiness callback */ } maps_view_event_type_e; + /** - * @brief Destroys the event data handle. - * @details This function destroys the event data handle and releases all its - * resources. + * @brief Destroys the event data handle. + * @details This function destroys the event data handle and releases all its resources. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] event The event data handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @param[in] event The event data handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_event_data_h * @see maps_view_event_data_clone() */ int maps_view_event_data_destroy(maps_view_event_data_h event); + /** - * @brief Clones the event handle. - * @details This function clones the event handle @a origin and all its - * resources. + * @brief Clones the event handle. + * @details This function clones the event handle @a origin and all its resources. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks @a cloned must be released using maps_view_event_data_destroy(). - * - * @param[in] origin The original event handle - * @param[out] cloned A cloned event handle - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @param[in] origin The original event handle + * @param[out] cloned A cloned event handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_event_data_h * @see maps_view_event_data_destroy() * @see maps_view_on_event_cb() */ int maps_view_event_data_clone(const maps_view_event_data_h origin, maps_view_event_data_h *cloned); + /** - * @brief Gets the event type. + * @brief Gets the event type. * @details This function gets the event type. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] event The event data handle - * @param[out] event_type The pointer to the #maps_view_event_type_e in which - * to store the event type - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @param[in] event The event data handle + * @param[out] event_type The pointer to the #maps_view_event_type_e in which to store the event type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_event_type_e * @see #maps_view_event_data_h * @see maps_view_event_data_destroy() @@ -204,23 +194,20 @@ int maps_view_event_data_clone(const maps_view_event_data_h origin, maps_view_ev */ int maps_view_event_data_get_type(const maps_view_event_data_h event, maps_view_event_type_e *event_type); + /** - * @brief Gets the event gesture type. - * @details This function gets the event gesture type if the event type is #MAPS_VIEW_EVENT_GESTURE - * or #MAPS_VIEW_EVENT_OBJECT. - * Otherwise it returns #MAPS_ERROR_INVALID_PARAMETER. + * @brief Gets the event gesture type. + * @details This function gets the event gesture type if the event type is #MAPS_VIEW_EVENT_GESTURE or #MAPS_VIEW_EVENT_OBJECT. + * Otherwise it returns #MAPS_ERROR_INVALID_PARAMETER. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] event The event data handle - * @param[out] gesture_type The pointer to the #maps_view_gesture_e in which to - * store the gesture type - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @param[in] event The event data handle + * @param[out] gesture_type The pointer to the #maps_view_gesture_e in which to store the gesture type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_gesture_e * @see #maps_view_event_data_h * @see maps_view_event_data_get_type() @@ -228,22 +215,20 @@ int maps_view_event_data_get_type(const maps_view_event_data_h event, maps_view_ */ int maps_view_event_data_get_gesture_type(const maps_view_event_data_h event, maps_view_gesture_e *gesture_type); + /** - * @brief Gets the event action type. + * @brief Gets the event action type. * @details This function gets the event action type if the event type is #MAPS_VIEW_EVENT_ACTION. - * Otherwise it returns #MAPS_ERROR_INVALID_PARAMETER. + * Otherwise, it returns #MAPS_ERROR_INVALID_PARAMETER. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] event The event data handle - * @param[out] action_type The pointer to the #maps_view_action_e in which to - * store the action type - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @param[in] event The event data handle + * @param[out] action_type The pointer to the #maps_view_action_e in which to store the action type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_action_e * @see #maps_view_event_data_h * @see maps_view_event_data_get_type() @@ -251,24 +236,21 @@ int maps_view_event_data_get_gesture_type(const maps_view_event_data_h event, ma */ int maps_view_event_data_get_action_type(const maps_view_event_data_h event, maps_view_action_e *action_type); + /** - * @brief Gets the new map center coordinates. - * @details This function gets the new map center coordinates if the event type is - * #MAPS_VIEW_EVENT_ACTION. - * Otherwise it returns #MAPS_ERROR_INVALID_PARAMETER. - * @remarks The @a center should be freed using maps_coordinates_destroy(). + * @brief Gets the new map center coordinates. + * @details This function gets the new map center coordinates if the event type is #MAPS_VIEW_EVENT_ACTION. + * Otherwise, it returns #MAPS_ERROR_INVALID_PARAMETER. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] event The event data handle - * @param[out] center The pointer to the #maps_coordinates_h in which - * to store the new center coordinates - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @remarks The @a center should be freed using maps_coordinates_destroy(). + * @param[in] event The event data handle + * @param[out] center The pointer to the #maps_coordinates_h in which to store the new center coordinates + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_event_type_e * @see #maps_view_event_data_h * @see #maps_coordinates_h @@ -277,23 +259,21 @@ int maps_view_event_data_get_action_type(const maps_view_event_data_h event, map */ int maps_view_event_data_get_center(const maps_view_event_data_h event, maps_coordinates_h *center); + /** - * @brief Gets the new map center movement coordinates delta. - * @details This function gets the screen coordinates delta of map center - * movement if the event type is #MAPS_VIEW_EVENT_ACTION. - * Otherwise it returns #MAPS_ERROR_INVALID_PARAMETER. + * @brief Gets the new map center movement coordinates delta. + * @details This function gets the screen coordinates delta of map center movement if the event type is #MAPS_VIEW_EVENT_ACTION. + * Otherwise, it returns #MAPS_ERROR_INVALID_PARAMETER. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] event The event data handle - * @param[out] delta_x The pointer to an integer in which to store the delta x - * @param[out] delta_y The pointer to an integer in which to store the delta y - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @param[in] event The event data handle + * @param[out] delta_x The pointer to an integer in which to store the delta x + * @param[out] delta_y The pointer to an integer in which to store the delta y + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_event_type_e * @see #maps_view_event_data_h * @see maps_view_event_data_get_type() @@ -301,23 +281,21 @@ int maps_view_event_data_get_center(const maps_view_event_data_h event, maps_coo */ int maps_view_event_data_get_delta(const maps_view_event_data_h event, int *delta_x, int *delta_y); + /** - * @brief Gets the event screen coordinates. - * @details This function gets the event screen coordinates if the event type is - * #MAPS_VIEW_EVENT_GESTURE or #MAPS_VIEW_EVENT_OBJECT. - * Otherwise it returns #MAPS_ERROR_INVALID_PARAMETER. + * @brief Gets the event screen coordinates. + * @details This function gets the event screen coordinates if the event type is #MAPS_VIEW_EVENT_GESTURE or #MAPS_VIEW_EVENT_OBJECT. + * Otherwise, it returns #MAPS_ERROR_INVALID_PARAMETER. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] event The event data handle - * @param[out] x The pointer to an integer in which to store the x position of the event - * @param[out] y The pointer to an integer in which to store the y position of the event - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @param[in] event The event data handle + * @param[out] x The pointer to an integer in which to store the x position of the event + * @param[out] y The pointer to an integer in which to store the y position of the event + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_event_type_e * @see #maps_view_event_data_h * @see maps_view_event_data_get_type() @@ -325,22 +303,21 @@ int maps_view_event_data_get_delta(const maps_view_event_data_h event, int *delt */ int maps_view_event_data_get_position(const maps_view_event_data_h event, int *x, int *y); + /** - * @brief Gets the event geographic coordinates. + * @brief Gets the event geographic coordinates. * @details This function gets the event geographic coordinates if the event type is #MAPS_VIEW_EVENT_GESTURE. - * Otherwise it returns #MAPS_ERROR_INVALID_PARAMETER. - * @remarks The @a coordinates should be freed using maps_coordinates_destroy(). + * Otherwise, it returns #MAPS_ERROR_INVALID_PARAMETER. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] event The event data handle - * @param[out] coordinates The pointer to the #maps_coordinates_h in which to store the coordinates - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @remarks The @a coordinates should be freed using maps_coordinates_destroy(). + * @param[in] event The event data handle + * @param[out] coordinates The pointer to the #maps_coordinates_h in which to store the coordinates + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_event_type_e * @see #maps_view_event_data_h * @see #maps_coordinates_h @@ -349,23 +326,20 @@ int maps_view_event_data_get_position(const maps_view_event_data_h event, int *x */ int maps_view_event_data_get_coordinates(const maps_view_event_data_h event, maps_coordinates_h *coordinates); + /** - * @brief Gets the number of fingers, detected in the event. - * @details This function gets the number of user's fingers, detected in the - * event if the event type is #MAPS_VIEW_EVENT_GESTURE or #MAPS_VIEW_EVENT_OBJECT. - * Otherwise it returns #MAPS_ERROR_INVALID_PARAMETER. + * @brief Gets the number of fingers, detected in the event. + * @details This function gets the number of user's fingers detected in the event if the event type is #MAPS_VIEW_EVENT_GESTURE or #MAPS_VIEW_EVENT_OBJECT. + * Otherwise, it returns #MAPS_ERROR_INVALID_PARAMETER. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] event The event data handle - * @param[out] fingers The pointer to an integer in which to store the - * number of fingers, detected in the gesture - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @param[in] event The event data handle + * @param[out] fingers The pointer to an integer in which to store the number of fingers, detected in the gesture + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_event_type_e * @see #maps_view_event_data_h * @see maps_view_event_data_get_type() @@ -373,22 +347,20 @@ int maps_view_event_data_get_coordinates(const maps_view_event_data_h event, map */ int maps_view_event_data_get_fingers(const maps_view_event_data_h event, int *fingers); + /** - * @brief Gets zoom factor of zoom gesture or action. - * @details This function gets the corresponding zoom factor if the event type is - * #MAPS_VIEW_EVENT_GESTURE or #MAPS_VIEW_EVENT_ACTION. - * Otherwise it returns the #MAPS_ERROR_INVALID_PARAMETER. + * @brief Gets zoom factor of zoom gesture or action. + * @details This function gets the corresponding zoom factor if the event type is #MAPS_VIEW_EVENT_GESTURE or #MAPS_VIEW_EVENT_ACTION. + * Otherwise, it returns the #MAPS_ERROR_INVALID_PARAMETER. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] event The event data handle - * @param[out] zoom_factor The pointer to a double in which to store the zoom factor - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @param[in] event The event data handle + * @param[out] zoom_factor The pointer to a double in which to store the zoom factor + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_event_type_e * @see #maps_view_event_data_h * @see maps_view_event_data_get_type() @@ -396,22 +368,20 @@ int maps_view_event_data_get_fingers(const maps_view_event_data_h event, int *fi */ int maps_view_event_data_get_zoom_factor(const maps_view_event_data_h event, double *zoom_factor); + /** - * @brief Gets rotation angle of rotation gesture or action. - * @details This function gets the corresponding rotation angle if the event type is - * #MAPS_VIEW_EVENT_GESTURE or #MAPS_VIEW_EVENT_ACTION. - * Otherwise it returns #MAPS_ERROR_INVALID_PARAMETER. + * @brief Gets rotation angle of rotation gesture or action. + * @details This function gets the corresponding rotation angle if the event type is #MAPS_VIEW_EVENT_GESTURE or #MAPS_VIEW_EVENT_ACTION. + * Otherwise, it returns #MAPS_ERROR_INVALID_PARAMETER. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] event The event data handle - * @param[out] rotation_angle The pointer to a double in which to store the rotation angle - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @param[in] event The event data handle + * @param[out] rotation_angle The pointer to a double in which to store the rotation angle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_event_type_e * @see #maps_view_event_data_h * @see maps_view_event_data_get_type() @@ -419,22 +389,20 @@ int maps_view_event_data_get_zoom_factor(const maps_view_event_data_h event, dou */ int maps_view_event_data_get_rotation_angle(const maps_view_event_data_h event, double *rotation_angle); + /** - * @brief Gets tilt angle of tilt gesture or action. + * @brief Gets tilt angle of tilt gesture or action. * @details This function gets the corresponding tilt angle if the event type is - * #MAPS_VIEW_EVENT_GESTURE or #MAPS_VIEW_EVENT_ACTION. - * Otherwise it returns #MAPS_ERROR_INVALID_PARAMETER. - * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] event The event data handle - * @param[out] tilt_angle The pointer to a double in which to store the tilt angle - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * #MAPS_VIEW_EVENT_GESTURE or #MAPS_VIEW_EVENT_ACTION. + * Otherwise it returns #MAPS_ERROR_INVALID_PARAMETER. + * @since_tizen 4.0 + * @param[in] event The event data handle + * @param[out] tilt_angle The pointer to a double in which to store the tilt angle + * @return 0, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a event may be obtained in maps_view_on_event_cb() - * * @see #maps_view_event_type_e * @see #maps_view_event_data_h * @see maps_view_event_data_get_type() @@ -442,23 +410,21 @@ int maps_view_event_data_get_rotation_angle(const maps_view_event_data_h event, */ int maps_view_event_data_get_tilt_angle(const maps_view_event_data_h event, double *tilt_angle); + /** - * @brief Gets object of event. - * @details When the event type is #MAPS_VIEW_EVENT_OBJECT, this function gets - * the corresponding object handle. - * Otherwise it returns #MAPS_ERROR_INVALID_PARAMETER. + * @brief Gets object of event. + * @details When the event type is #MAPS_VIEW_EVENT_OBJECT, this function gets the corresponding object handle. + * Otherwise, it returns #MAPS_ERROR_INVALID_PARAMETER. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks The @a object must not be released. - * - * @param[in] event The event data handle - * @param[out] object The pointer to #maps_view_object_h in which to store the object handle - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a event may be obtained in maps_view_on_event_cb() - * + * @param[in] event The event data handle + * @param[out] object The pointer to #maps_view_object_h in which to store the object handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_event_type_e * @see #maps_view_event_data_h * @see maps_view_event_data_get_type() @@ -473,4 +439,4 @@ int maps_view_event_data_get_object(const maps_view_event_data_h event, maps_vie /** * @} */ -#endif /* __MAPS_VIEW_EVENT_DATA_H__*/ +#endif /* __MAPS_VIEW_EVENT_DATA_H__*/ diff --git a/include/maps_view_object.h b/include/maps_view_object.h index 53365f8..fa52cc2 100644 --- a/include/maps_view_object.h +++ b/include/maps_view_object.h @@ -18,128 +18,117 @@ #ifndef __MAPS_VIEW_OBJECT_H__ #define __MAPS_VIEW_OBJECT_H__ + #include #include + /** - * @ingroup CAPI_MAPS_VIEW_MODULE - * @defgroup CAPI_MAPS_VIEW_OBJECT_MODULE View Object - * + * @ingroup CAPI_MAPS_VIEW_MODULE + * @defgroup CAPI_MAPS_VIEW_OBJECT_MODULE View Object * @file maps_view_object.h - * @brief This file contains the functions of Map Object API - * + * @brief This file contains the functions of Map Object API. * @addtogroup CAPI_MAPS_VIEW_OBJECT_MODULE * @{ * @brief This provides APIs related to operations, used in View Object. * @details Supported Object types are following: - * - Markers - * - Polygons - * - Polylines - * - Group Objects - * . + * - Markers + * - Polygons + * - Polylines + * - Group Objects */ + #ifdef __cplusplus extern "C" { #endif + /** - * @brief The View Object handle + * @brief The View Object handle. * @details The handle of an arbitrary visual object instance. - * @remarks The handle may be issued with one of following functions: - * * maps_view_object_create_marker() - * * maps_view_object_create_polygon() - * * maps_view_object_create_polyline() - * \n To release the handle use maps_view_object_destroy(). - * \n Note that when the object is added to View it will be released - * automatically when the View is destroyed * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * + * @remarks The handle may be issued with one of following functions: + * * maps_view_object_create_marker() + * * maps_view_object_create_polygon() + * * maps_view_object_create_polyline()\n + * To release the handle, use maps_view_object_destroy().\n + * Note that when the object is added to View, it will be released automatically when the View is destroyed. * @see maps_view_object_destroy() * @see maps_view_add_object() */ typedef void *maps_view_object_h; + /** - * @brief Enumerations of visual object types + * @brief Enumeration for visual object types. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif */ typedef enum _maps_view_object_type_e { - MAPS_VIEW_OBJECT_POLYLINE, /**< Indicates the polyline */ - MAPS_VIEW_OBJECT_POLYGON, /**< Indicates the polygon */ - MAPS_VIEW_OBJECT_MARKER, /**< Indicates the marker */ - MAPS_VIEW_OBJECT_OVERLAY, /**< Indicates the overlay */ + MAPS_VIEW_OBJECT_POLYLINE, /**< Indicates the polyline */ + MAPS_VIEW_OBJECT_POLYGON, /**< Indicates the polygon */ + MAPS_VIEW_OBJECT_MARKER, /**< Indicates the marker */ + MAPS_VIEW_OBJECT_OVERLAY, /**< Indicates the overlay */ } maps_view_object_type_e; + /** - * @brief Enumerations of map marker types + * @brief Enumeration for map marker types. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif */ typedef enum _maps_view_marker_type_e { - MAPS_VIEW_MARKER_PIN, /**< Indicates the pin marker type */ - MAPS_VIEW_MARKER_STICKER, /**< Indicates the sticker marker type */ + MAPS_VIEW_MARKER_PIN, /**< Indicates the pin marker type */ + MAPS_VIEW_MARKER_STICKER, /**< Indicates the sticker marker type */ } maps_view_marker_type_e; + /** - * @brief Enumerations of overlay types + * @brief Enumeration for overlay types. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif */ typedef enum _maps_view_overlay_type_e { - MAPS_VIEW_OVERLAY_NORMAL, /**< Indicates the normal type */ - MAPS_VIEW_OVERLAY_BUBBLE, /**< Indicates the bubble type */ - MAPS_VIEW_OVERLAY_BOX, /**< Indicates the box type */ + MAPS_VIEW_OVERLAY_NORMAL, /**< Indicates the normal type */ + MAPS_VIEW_OVERLAY_BUBBLE, /**< Indicates the bubble type */ + MAPS_VIEW_OVERLAY_BOX, /**< Indicates the box type */ } maps_view_overlay_type_e; + /** - * @brief Called when requesting the list of points of the polyline. - * @details This callback is invoked while iterating through the list of - * points, added to the polyline. + * @brief Called when requesting the list of points of the polyline. + * @details This callback is invoked while iterating through the list of points, added to the polyline. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks @a point must be released using maps_coordinates_destroy(). - * \n To use @a point outside this function, clone it with - * maps_coordinates_clone(). - * - * @param[in] index The current index of path point - * @param[in] total The total amount of path points - * @param[in] point The point - * @param[in] user_data The user data pointer passed from - * maps_view_object_polyline_foreach_point() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a point must be released using maps_coordinates_destroy().\n + * To use @a point outside this function, clone it with maps_coordinates_clone(). + * @param[in] index The current index of path point + * @param[in] total The total amount of path points + * @param[in] point The point + * @param[in] user_data The user data pointer passed from maps_view_object_polyline_foreach_point() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_view_object_polyline_foreach_point() will invoke this callback. - * * @see maps_view_object_polyline_foreach_point() * @see #maps_coordinates_h */ -typedef bool(*maps_view_object_polyline_point_cb) (int index, int total, - maps_coordinates_h point, void *user_data); +typedef bool(*maps_view_object_polyline_point_cb) (int index, int total, maps_coordinates_h point, void *user_data); /** - * @brief Called when requesting the list of points of the polygon. - * @details This callback is invoked while iterating through the list of - * points, added to the polygon. + * @brief Called when requesting the list of points of the polygon. + * @details This callback is invoked while iterating through the list of points, added to the polygon. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks @a point must be released using maps_coordinates_destroy(). - * \n To use @a point outside this function, clone it with - * maps_coordinates_clone(). - * - * @param[in] index The current index of path point - * @param[in] total The total amount of path points - * @param[in] point The point - * @param[in] user_data The user data pointer passed from - * maps_view_object_polygon_foreach_point() - * @return @c true to continue with the next iteration of the loop, \n @c - * false to break out of the loop - * + * @remarks @a point must be released using maps_coordinates_destroy().\n + * To use @a point outside this function, clone it with maps_coordinates_clone(). + * @param[in] index The current index of path point + * @param[in] total The total amount of path points + * @param[in] point The point + * @param[in] user_data The user data pointer passed from maps_view_object_polygon_foreach_point() + * @return @c true to continue with the next iteration of the loop,\n + * @c false to break out of the loop * @pre maps_view_object_polygon_foreach_point() will invoke this callback. - * * @see maps_view_object_polygon_foreach_point() * @see #maps_coordinates_h */ -typedef bool(*maps_view_object_polygon_point_cb) (int index, int total, - maps_coordinates_h point, void *user_data); +typedef bool(*maps_view_object_polygon_point_cb) (int index, int total, maps_coordinates_h point, void *user_data); /*----------------------------------------------------------------------------*/ @@ -149,29 +138,26 @@ typedef bool(*maps_view_object_polygon_point_cb) (int index, int total, /** - * @brief Creates a marker visual object. + * @brief Creates a marker visual object. * @details This function creates a marker on a given geographical coordinates. - * The marker is specified with a given image file and a type. - * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks @a marker can be released by using maps_view_object_destroy(). - * \n If added to the View using maps_view_add_object(), @a marker will be - * released automatically when the View is destroyed. - * \n http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. - * \n http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. - * - * @param[in] coordinates The geographical coordinates to add marker on - * @param[in] image_file_path The file name with the image for the marker - * @param[in] type The type of the marker, one of listed in maps_view_marker_type_e - * @param[out] marker The handle of newly created marker - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * The marker is specified with a given image file and a type. + * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif + * @remarks @a marker can be released by using maps_view_object_destroy().\n + * If added to the View using maps_view_add_object(), @a marker will be released automatically when the View is destroyed.\n + * http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\n + * http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. + * @param[in] coordinates The geographical coordinates to add marker on + * @param[in] image_file_path The file name with the image for the marker + * @param[in] type The type of the marker, one of listed in maps_view_marker_type_e + * @param[out] marker The handle of newly created marker + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a coordinates are created using map_coordinates_create(). - * * @see #maps_view_object_h * @see #maps_view_marker_type_e * @see maps_view_object_create_polygon() @@ -180,33 +166,29 @@ typedef bool(*maps_view_object_polygon_point_cb) (int index, int total, * @see maps_view_object_destroy() * @see #maps_coordinates_h */ -int maps_view_object_create_marker(maps_coordinates_h coordinates, - const char *image_file_path, maps_view_marker_type_e type, maps_view_object_h *marker); +int maps_view_object_create_marker(maps_coordinates_h coordinates, const char *image_file_path, maps_view_marker_type_e type, maps_view_object_h *marker); + /** - * @brief Creates a polyline visual object. - * @details This function creates a polyline visual object, specified - * with a list of geographical coordinates, line width and color. + * @brief Creates a polyline visual object. + * @details This function creates a polyline visual object, specified with a list of geographical coordinates, line width and color. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks @a polyline can be released by using maps_view_object_destroy(). - * \n If added to the View using maps_view_add_object(), @a polyline will be - * released automatically when the View is destroyed. - * - * @param[in] coordinates The list of geographical coordinates - * @param[in] r The red component of polyline color [0 ~ 255] - * @param[in] g The green component of polyline color [0 ~ 255] - * @param[in] b The blue component of polyline color [0 ~ 255] - * @param[in] a The alpha component of polyline color [0 ~ 255] - * @param[in] width The width of line [1 ~ 100] (pixels) - * @param[out] polyline The handle of newly added polyline - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a polyline can be released by using maps_view_object_destroy().\n + * If added to the View using maps_view_add_object(), @a polyline will be released automatically when the View is destroyed. + * @param[in] coordinates The list of geographical coordinates + * @param[in] r The red component of polyline color [0 ~ 255] + * @param[in] g The green component of polyline color [0 ~ 255] + * @param[in] b The blue component of polyline color [0 ~ 255] + * @param[in] a The alpha component of polyline color [0 ~ 255] + * @param[in] width The width of line [1 ~ 100] (pixels) + * @param[out] polyline The handle of newly added polyline + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a coordinates is created using maps_coordinates_list_create(). - * * @see #maps_view_object_h * @see maps_view_object_create_marker() * @see maps_view_object_create_polygon() @@ -215,33 +197,28 @@ int maps_view_object_create_marker(maps_coordinates_h coordinates, * @see #maps_coordinates_list_h * @see maps_coordinates_list_create() */ -int maps_view_object_create_polyline(maps_coordinates_list_h coordinates, - unsigned char r, unsigned char g, unsigned char b, unsigned char a, - int width, maps_view_object_h *polyline); +int maps_view_object_create_polyline(maps_coordinates_list_h coordinates, unsigned char r, unsigned char g, unsigned char b, unsigned char a, int width, maps_view_object_h *polyline); + /** - * @brief Creates a polygon visual object. - * @details This function creates a polygon visual object, specified - * with a list of geographical coordinates and fill color. + * @brief Creates a polygon visual object. + * @details This function creates a polygon visual object, specified with a list of geographical coordinates and fill color. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks @a polygon can be released by using maps_view_object_destroy(). - * \n If added to the View using maps_view_add_object(), @a polygon will be - * released automatically when the View is destroyed. - * - * @param[in] coordinates The list of geographical coordinates - * @param[in] r The red component of polygon background color [0 ~ 255] - * @param[in] g The green component of polygon background color [0 ~ 255] - * @param[in] b The blue component of polygon background color [0 ~ 255] - * @param[in] a The alpha component of polygon background color [0 ~ 255] - * @param[out] polygon The handle of newly created polygon - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a polygon can be released by using maps_view_object_destroy().\n + * If added to the View using maps_view_add_object(), @a polygon will be released automatically when the View is destroyed. + * @param[in] coordinates The list of geographical coordinates + * @param[in] r The red component of polygon background color [0 ~ 255] + * @param[in] g The green component of polygon background color [0 ~ 255] + * @param[in] b The blue component of polygon background color [0 ~ 255] + * @param[in] a The alpha component of polygon background color [0 ~ 255] + * @param[out] polygon The handle of newly created polygon + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a coordinates is created using maps_coordinates_list_create(). - * * @see #maps_view_object_h * @see maps_view_object_create_marker() * @see maps_view_object_create_polyline() @@ -250,30 +227,26 @@ int maps_view_object_create_polyline(maps_coordinates_list_h coordinates, * @see #maps_coordinates_list_h * @see maps_coordinates_list_create() */ -int maps_view_object_create_polygon(maps_coordinates_list_h coordinates, - unsigned char r, unsigned char g, unsigned char b, unsigned char a, - maps_view_object_h *polygon); +int maps_view_object_create_polygon(maps_coordinates_list_h coordinates, unsigned char r, unsigned char g, unsigned char b, unsigned char a, maps_view_object_h *polygon); + /** - * @brief Creates a overlay object. - * @details This function creates a overlay object to contain Evas objects. + * @brief Creates an overlay object. + * @details This function creates an overlay object to contain Evas objects. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks @a overlay can be released by using maps_view_object_destroy(). - * \n If added to the View using maps_view_add_object(), @a overlay will be - * released automatically when the View is destroyed. - * - * @param[in] coordinates The list of geographical coordinates - * @param[in] object The Evas object to be contained - * @param[in] type The type of boxing the @a object - * @param[out] overlay The handle of newly created polygon - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks @a overlay can be released by using maps_view_object_destroy().\n + * If added to the View using maps_view_add_object(), @a overlay will be released automatically when the View is destroyed. + * @param[in] coordinates The list of geographical coordinates + * @param[in] object The Evas object to be contained + * @param[in] type The type of boxing the @a object + * @param[out] overlay The handle of newly created polygon + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a coordinates is created using maps_coordinates_list_create(). - * * @see #maps_view_object_h * @see maps_view_object_create_marker() * @see maps_view_object_create_polyline() @@ -283,20 +256,19 @@ int maps_view_object_create_polygon(maps_coordinates_list_h coordinates, * @see #maps_coordinates_h * @see maps_coordinates_create() */ -int maps_view_object_create_overlay(maps_coordinates_h coordinates, - Evas_Object *object, maps_view_overlay_type_e type, maps_view_object_h *overlay); +int maps_view_object_create_overlay(maps_coordinates_h coordinates, Evas_Object *object, maps_view_overlay_type_e type, maps_view_object_h *overlay); + /** - * @brief Destroys the object. + * @brief Destroys the object. * @details This function destroys the object handle and releases all its resources. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] object The object handle to destroy - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] object The object handle to destroy + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @see #maps_view_object_h * @see maps_view_object_create_marker() * @see maps_view_object_create_polygon() @@ -304,22 +276,19 @@ int maps_view_object_create_overlay(maps_coordinates_h coordinates, */ int maps_view_object_destroy(maps_view_object_h object); + /** - * @brief Gets the object type. + * @brief Gets the object type. * @details This function gets the object type. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] object The object handle - * @param[out] type The pointer to #maps_view_object_type_e in which to - * store the object type - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a object is created using maps_view_object_create_marker(), - * maps_view_object_create_polyline() or maps_view_object_create_polygon(). - * + * @param[in] object The object handle + * @param[out] type The pointer to #maps_view_object_type_e in which to store the object type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a object is created using maps_view_object_create_marker(), maps_view_object_create_polyline() or maps_view_object_create_polygon(). * @see #maps_view_object_h * @see maps_view_object_create_marker() * @see maps_view_object_create_polyline() @@ -327,42 +296,37 @@ int maps_view_object_destroy(maps_view_object_h object); */ int maps_view_object_get_type(maps_view_object_h object, maps_view_object_type_e *type); + /** - * @brief Shows the object. + * @brief Shows the object. * @details This function changes the visibility of the given object on the View. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] object The object handle - * @param[in] visible The new visibility of the object - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a object is created using maps_view_object_create_marker(), - * maps_view_object_create_polyline(), maps_view_object_create_polygon(). - * + * @param[in] object The object handle + * @param[in] visible The new visibility of the object + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a object is created using maps_view_object_create_marker(), maps_view_object_create_polyline(), maps_view_object_create_polygon(). * @see #maps_view_object_h * @see maps_view_object_get_visible() */ int maps_view_object_set_visible(maps_view_object_h object, bool visible); + /** - * @brief Gets the object visibility. + * @brief Gets the object visibility. * @details This function retrieves whether or not the given object is visible. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] object The object handle - * @param[out] visible The pointer to a boolean in which to store the - * object visibility - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre @a object is created using maps_view_object_create_marker(), - * maps_view_object_create_polyline(), maps_view_object_create_polygon(). - * + * @param[in] object The object handle + * @param[out] visible The pointer to a boolean in which to store the object visibility + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre @a object is created using maps_view_object_create_marker(), maps_view_object_create_polyline(), maps_view_object_create_polygon(). * @see #maps_view_object_h * @see maps_view_object_set_visible() */ @@ -374,22 +338,21 @@ int maps_view_object_get_visible(const maps_view_object_h object, bool *visible) * Polyline */ + /** - * @brief Sets points to the polyline. + * @brief Sets points to the polyline. * @details This function sets point list to the polyline. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] polyline The polyline object handle - * @param[in] points The points to set - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] polyline The polyline object handle + * @param[in] points The points to set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a polyline is created using maps_view_object_create_polyline(). * @pre @a points are created using maps_coordinates_list_create(). * @post Previous points will be destroyed automatically. - * * @see #maps_view_object_h * @see #maps_coordinates_list_h * @see maps_coordinates_list_create() @@ -398,20 +361,18 @@ int maps_view_object_get_visible(const maps_view_object_h object, bool *visible) */ int maps_view_object_polyline_set_polyline(maps_view_object_h polyline, maps_coordinates_list_h points); + /** - * @brief Appends a point to the polyline. + * @brief Appends a point to the polyline. * @details This function appends a point to the polyline. - * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] polyline The polyline object handle - * @param[in] point The point to append - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * + * @since_tizen 4.0 + * @param[in] polyline The polyline object handle + * @param[in] point The point to append + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * @pre @a polyline is created using maps_view_object_create_polyline(). * @pre @a point is created using maps_coordinates_create(). - * * @see #maps_view_object_h * @see #maps_coordinates_h * @see maps_coordinates_create() @@ -420,122 +381,107 @@ int maps_view_object_polyline_set_polyline(maps_view_object_h polyline, maps_coo */ int maps_view_object_polyline_append_point(maps_view_object_h polyline, maps_coordinates_h point); + /** - * @brief Retrieves all points, added to the polyline. + * @brief Retrieves all points, added to the polyline. * @details This function retrieves all points, added to the polyline. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks The points will be delivered via maps_view_object_polyline_point_cb(). - * - * @param[in] polyline The polyline object handle - * @param[in] callback The callback function to invoke - * @param[in] user_data The user data pointer 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 - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] polyline The polyline object handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data pointer to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a polyline is created using maps_view_object_create_polyline(). - * @post This function invokes maps_view_object_polyline_point_cb() repeatedly to - * retrieve each point. - * + * @post This function invokes maps_view_object_polyline_point_cb() repeatedly to retrieve each point. * @see #maps_view_object_h * @see maps_view_object_create_polyline() * @see maps_view_object_polyline_set_polyline() * @see maps_view_object_polyline_point_cb() */ -int maps_view_object_polyline_foreach_point(maps_view_object_h polyline, - maps_coordinates_cb callback, void *user_data); +int maps_view_object_polyline_foreach_point(maps_view_object_h polyline, maps_coordinates_cb callback, void *user_data); + /** - * @brief Sets the polyline color. + * @brief Sets the polyline color. * @details This function sets the polyline color on canvas. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] polyline The polyline object handle - * @param[in] r The red component of the color - * @param[in] g The green component of the color - * @param[in] b The blue component of the color - * @param[in] a The alpha component of the color - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] polyline The polyline object handle + * @param[in] r The red component of the color + * @param[in] g The green component of the color + * @param[in] b The blue component of the color + * @param[in] a The alpha component of the color + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a polyline is created using maps_view_object_create_polyline(). - * * @see maps_view_object_polyline_get_color() * @see maps_view_object_polyline_set_width() * @see maps_view_object_create_polyline() */ -int maps_view_object_polyline_set_color(maps_view_object_h polyline, - unsigned char r, unsigned char g, unsigned char b, unsigned char a); +int maps_view_object_polyline_set_color(maps_view_object_h polyline, unsigned char r, unsigned char g, unsigned char b, unsigned char a); + /** - * @brief Gets the polyline color. + * @brief Gets the polyline color. * @details This function gets the polyline color on canvas. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] polyline The polyline object handle - * @param[out] r The unsigned char pointer in which to store the - * red component of the color, or NULL if not interested - * @param[out] g The unsigned char pointer in which to store the - * green component of the color, or NULL if not interested - * @param[out] b The unsigned char pointer in which to store the - * blue component of the color, or NULL if not interested - * @param[out] a The unsigned char pointer in which to store the - * alpha component of the color, or NULL if not interested - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] polyline The polyline object handle + * @param[out] r The unsigned char pointer in which to store the red component of the color, or NULL if not interested + * @param[out] g The unsigned char pointer in which to store the green component of the color, or NULL if not interested + * @param[out] b The unsigned char pointer in which to store the blue component of the color, or NULL if not interested + * @param[out] a The unsigned char pointer in which to store the alpha component of the color, or NULL if not interested + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a polyline is created using maps_view_object_create_polyline(). - * @pre color components may be previously set using - * maps_view_object_polyline_set_color(). - * + * @pre color components may be previously set using maps_view_object_polyline_set_color(). * @see maps_view_object_polyline_set_color() * @see maps_view_object_polyline_get_width() * @see maps_view_object_create_polyline() */ -int maps_view_object_polyline_get_color(const maps_view_object_h polyline, - unsigned char *r, unsigned char *g, unsigned char *b, unsigned char *a); +int maps_view_object_polyline_get_color(const maps_view_object_h polyline, unsigned char *r, unsigned char *g, unsigned char *b, unsigned char *a); + /** - * @brief Sets the polyline width. + * @brief Sets the polyline width. * @details This function sets the polyline width on canvas. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] polyline The polyline object handle - * @param[in] width The new width of line [1 ~ 100] (pixels) - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] polyline The polyline object handle + * @param[in] width The new width of line [1 ~ 100] (pixels) + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a polyline is created using maps_view_object_create_polyline(). - * * @see maps_view_object_polyline_get_width() * @see maps_view_object_polyline_set_color() * @see maps_view_object_create_polyline() */ int maps_view_object_polyline_set_width(maps_view_object_h polyline, int width); + /** - * @brief Gets the polyline width. + * @brief Gets the polyline width. * @details This function gets the polyline width on canvas. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] polyline The polyline object handle - * @param[out] width The width of line [1 ~ 100] (pixels) - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] polyline The polyline object handle + * @param[out] width The width of line [1 ~ 100] (pixels) + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a polyline is created using maps_view_object_create_polyline(). * @pre @a width may be previously set using maps_view_object_polyline_set_width(). - * * @see maps_view_object_polyline_set_width() * @see maps_view_object_polyline_get_color() * @see maps_view_object_create_polyline() @@ -548,21 +494,20 @@ int maps_view_object_polyline_get_width(const maps_view_object_h polyline, int * * Polygon */ + /** - * @brief Sets points to the polygon. + * @brief Sets points to the polygon. * @details This function sets point list to the polygon. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] polygon The polygon object handle - * @param[in] points The points to set - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] polygon The polygon object handle + * @param[in] points The points to set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a polygon is created using maps_view_object_create_polygon(). * @pre @a points are created using maps_coordinates_list_create(). - * * @see maps_view_object_create_polygon() * @see #maps_view_object_h * @see #maps_coordinates_list_h @@ -571,85 +516,73 @@ int maps_view_object_polyline_get_width(const maps_view_object_h polyline, int * */ int maps_view_object_polygon_set_polygon(maps_view_object_h polygon, maps_coordinates_list_h points); + /** - * @brief Retrieves all points, added to the polygon. + * @brief Retrieves all points, added to the polygon. * @details This function retrieves all points, added to the polygon. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks The objects will be delivered via maps_view_object_polygon_point_cb(). - * - * @param[in] polygon The polygon object handle - * @param[in] callback The callback function to invoke - * @param[in] 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 - * @retval #MAPS_ERROR_NOT_FOUND Result not found - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] polygon The polygon object handle + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_FOUND Result not found + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a polygon is created using maps_view_object_create_polygon(). - * @post This function invokes maps_view_object_polygon_point_cb() repeatedly to - * retrieve each point. - * + * @post This function invokes maps_view_object_polygon_point_cb() repeatedly to retrieve each point. * @see maps_view_object_polygon_point_cb() * @see maps_view_object_create_polygon() * @see #maps_view_object_h * @see maps_view_object_polygon_set_polygon() */ -int maps_view_object_polygon_foreach_point(maps_view_object_h polygon, - maps_coordinates_cb callback, void *user_data); +int maps_view_object_polygon_foreach_point(maps_view_object_h polygon, maps_coordinates_cb callback, void *user_data); + /** - * @brief Sets polygon fill color. + * @brief Sets polygon fill color. * @details This function sets the polygon fill color on canvas. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] polygon The polygon object handle - * @param[in] r The red component of the fill color - * @param[in] g The green component of the fill color - * @param[in] b The blue component of the fill color - * @param[in] a The alpha component of the fill color - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] polygon The polygon object handle + * @param[in] r The red component of the fill color + * @param[in] g The green component of the fill color + * @param[in] b The blue component of the fill color + * @param[in] a The alpha component of the fill color + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a polygon is created using maps_view_object_create_polygon(). - * * @see maps_view_object_polygon_get_fill_color() * @see maps_view_object_create_polygon() */ -int maps_view_object_polygon_set_fill_color(maps_view_object_h polygon, - unsigned char r, unsigned char g, unsigned char b, unsigned char a); +int maps_view_object_polygon_set_fill_color(maps_view_object_h polygon, unsigned char r, unsigned char g, unsigned char b, unsigned char a); + /** - * @brief Gets polygon fill color. + * @brief Gets polygon fill color. * @details This function gets the polygon fill color on canvas. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] polygon The polygon data handle - * @param[in] r The unsigned char pointer in which to store the - * red component of the background color - * @param[in] g The unsigned char pointer in which to store the - * green component of the background color - * @param[in] b The unsigned char pointer in which to store the - * blue component of the background color - * @param[in] a The unsigned char pointer in which to store the - * alpha component of the background color - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] polygon The polygon data handle + * @param[in] r The unsigned char pointer in which to store the red component of the background color + * @param[in] g The unsigned char pointer in which to store the green component of the background color + * @param[in] b The unsigned char pointer in which to store the blue component of the background color + * @param[in] a The unsigned char pointer in which to store the alpha component of the background color + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a polygon is created using maps_view_object_create_polygon(). - * @pre fill color components may be previously set using - * maps_view_object_polygon_set_fill_color(). - * + * @pre Fill color components may be previously set using maps_view_object_polygon_set_fill_color(). * @see maps_view_object_polygon_set_fill_color() * @see maps_view_object_create_polygon() */ -int maps_view_object_polygon_get_fill_color(const maps_view_object_h polygon, - unsigned char *r, unsigned char *g, unsigned char *b, unsigned char *a); +int maps_view_object_polygon_get_fill_color(const maps_view_object_h polygon, unsigned char *r, unsigned char *g, unsigned char *b, unsigned char *a); /*----------------------------------------------------------------------------*/ @@ -657,21 +590,20 @@ int maps_view_object_polygon_get_fill_color(const maps_view_object_h polygon, * Marker */ + /** - * @brief Sets the marker coordinates. + * @brief Sets the marker coordinates. * @details This function sets the marker geographical coordinates. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] marker The marker object handle - * @param[in] coordinates The marker geographical coordinates handle - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] marker The marker object handle + * @param[in] coordinates The marker geographical coordinates handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a marker is created using maps_view_object_create_marker(). * @pre @a coordinates are created using maps_coordinates_create(). - * * @see maps_view_object_create_marker() * @see maps_view_object_marker_get_coordinates() * @see #maps_coordinates_h @@ -679,174 +611,162 @@ int maps_view_object_polygon_get_fill_color(const maps_view_object_h polygon, */ int maps_view_object_marker_set_coordinates(maps_view_object_h marker, maps_coordinates_h coordinates); + /** - * @brief Sets the marker screen size. + * @brief Sets the marker screen size. * @details This function sets the marker screen size. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remark To make the marker size proportionally, use 0 as the value for the @a width or @a height paramter. - * For instance, to make the width of an marker 150 pixels, and change the height using the same proportion, - * use maps_view_object_marker_resize(marker, 150, 0). - * - * @param[in] marker The marker object handle - * @param[in] width The resized marker pixels in width on the screen - * @param[in] height The resized marker pixels in height on the screen - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remark To make the marker size proportionally, use 0 as the value for the @a width or @a height paramter. + * For instance, to make the width of an marker 150 pixels, and change the height using the same proportion, + * use maps_view_object_marker_resize(marker, 150, 0). + * @param[in] marker The marker object handle + * @param[in] width The resized marker pixels in width on the screen + * @param[in] height The resized marker pixels in height on the screen + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a marker is created using maps_view_object_create_marker(). - * * @see maps_view_object_create_marker() * @see maps_view_object_marker_get_size() */ int maps_view_object_marker_resize(maps_view_object_h marker, int width, int height); + /** - * @brief Sets the marker image file path. + * @brief Sets the marker image file path. * @details This function sets the marker image file path. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remarks http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. - * \n http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. - * - * @param[in] marker The marker object handle - * @param[in] file_path The marker image file path - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.\n + * http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. + * @param[in] marker The marker object handle + * @param[in] file_path The marker image file path + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a marker is created using maps_view_object_create_marker(). - * * @see maps_view_object_marker_get_image_file() * @see maps_view_object_create_marker() */ int maps_view_object_marker_set_image_file(maps_view_object_h marker, const char *file_path); + /** - * @brief Gets the marker image file path. + * @brief Gets the marker image file path. * @details This function gets the marker image file path. - * @remarks The @a file_path should be freed using free(). * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] marker The marker object handle - * @param[out] file_path The marker image file path - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks The @a file_path should be freed using free(). + * @param[in] marker The marker object handle + * @param[out] file_path The marker image file path + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a marker is created using maps_view_object_create_marker(). * @pre @a file_path may be set previously using maps_view_object_marker_set_image_file(). - * * @see maps_view_object_marker_set_image_file() * @see maps_view_object_create_marker() */ int maps_view_object_marker_get_image_file(const maps_view_object_h marker, char **file_path); + /** - * @brief Gets the marker coordinates. + * @brief Gets the marker coordinates. * @details This function gets the marker geographical coordinates. - * @remarks The @a coordinates should be freed using maps_coordinates_destroy(). * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] marker The marker object handle - * @param[out] coordinates The pointer to #maps_coordinates_h in which to - * store the marker geographical coordinates - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks The @a coordinates should be freed using maps_coordinates_destroy(). + * @param[in] marker The marker object handle + * @param[out] coordinates The pointer to #maps_coordinates_h in which to store the marker geographical coordinates + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a marker is created using maps_view_object_create_marker(). * @pre @a coordinates may be set previously using maps_view_object_marker_set_coordinates(). - * * @see maps_view_object_marker_set_coordinates() * @see #maps_coordinates_h * @see maps_view_object_create_marker() */ int maps_view_object_marker_get_coordinates(const maps_view_object_h marker, maps_coordinates_h *coordinates); + /** - * @brief Gets the marker screen size. + * @brief Gets the marker screen size. * @details This function gets the marker size on the screen. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] marker The marker object handle - * @param[out] width The pointer to an integer in which to store the - * marker width on the screen in pixels - * @param[out] height The pointer to an integer in which to store the - * marker height on the screen in pixels - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] marker The marker object handle + * @param[out] width The pointer to an integer in which to store the marker width on the screen in pixels + * @param[out] height The pointer to an integer in which to store the marker height on the screen in pixels + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a marker is created using maps_view_object_create_marker(). * @pre @a width and @a height may be set previously using maps_view_object_marker_resize(). - * * @see maps_view_object_marker_resize() * @see maps_view_object_create_marker() */ int maps_view_object_marker_get_size(const maps_view_object_h marker, int *width, int *height); + /** - * @brief Gets the marker type. + * @brief Gets the marker type. * @details This function gets the marker type. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] marker The marker object handle - * @param[out] type The pointer to a maps_view_marker_type_e in which to - * store the marker type - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] marker The marker object handle + * @param[out] type The pointer to a maps_view_marker_type_e in which to store the marker type + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a marker is created using maps_view_object_create_marker(). - * * @see #maps_view_marker_type_e * @see maps_view_object_create_marker() */ int maps_view_object_marker_get_type(const maps_view_object_h marker, maps_view_marker_type_e *type); + /** - * @brief Sets the marker z-order. + * @brief Sets the marker z-order. * @details This function sets the z-order. - * @remarks The @a z_order must be in range of [-100, 100]. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] marker The marker object handle - * @param[in] z_order The z-order - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks The @a z_order must be in range of [-100, 100]. + * @param[in] marker The marker object handle + * @param[in] z_order The z-order + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a marker is created using maps_view_object_create_marker(). - * * @see maps_view_object_create_marker() * @see maps_view_object_marker_get_z_order() */ int maps_view_object_marker_set_z_order(maps_view_object_h marker, int z_order); + /** - * @brief Gets the marker z-order. + * @brief Gets the marker z-order. * @details This function gets the z-order. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] marker The marker object handle - * @param[out] z_order The z-order - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] marker The marker object handle + * @param[out] z_order The z-order + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a marker is created using maps_view_object_create_marker(). - * * @see maps_view_object_create_marker() * @see maps_view_object_marker_set_z_order() */ @@ -859,40 +779,38 @@ int maps_view_object_marker_get_z_order(const maps_view_object_h marker, int *z_ * Overlay */ + /** - * @brief Gets the Evas object. + * @brief Gets the Evas object. * @details This function gets the Evas object. - * @remarks The @a object must not be released. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] overlay The overlay object handle - * @param[out] object The Evas object handle - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks The @a object must not be released. + * @param[in] overlay The overlay object handle + * @param[out] object The Evas object handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a marker is created using maps_view_object_create_overlay(). - * * @see maps_view_object_create_overlay() */ int maps_view_object_overlay_get_object(maps_view_object_h overlay, Evas_Object **object); + /** - * @brief Sets the overlay coordinates. + * @brief Sets the overlay coordinates. * @details This function sets the overlay geographical coordinates. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] overlay The overlay object handle - * @param[in] coordinates The overlay geographical coordinates handle - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] overlay The overlay object handle + * @param[in] coordinates The overlay geographical coordinates handle + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a overlay is created using maps_view_object_create_overlay(). * @pre @a coordinates are created using maps_coordinates_create(). - * * @see maps_view_object_create_overlay() * @see maps_view_object_overlay_get_coordinates() * @see #maps_coordinates_h @@ -900,24 +818,22 @@ int maps_view_object_overlay_get_object(maps_view_object_h overlay, Evas_Object */ int maps_view_object_overlay_set_coordinates(maps_view_object_h overlay, maps_coordinates_h coordinates); + /** - * @brief Gets the overlay coordinates. + * @brief Gets the overlay coordinates. * @details This function gets the overlay geographical coordinates. - * @remarks The @a coordinates should be freed using maps_coordinates_destroy(). * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] overlay The overlay object handle - * @param[out] coordinates The pointer to #maps_coordinates_h in which to - * store the overlay geographical coordinates - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @remarks The @a coordinates should be freed using maps_coordinates_destroy(). + * @param[in] overlay The overlay object handle + * @param[out] coordinates The pointer to #maps_coordinates_h in which to store the overlay geographical coordinates + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a overlay is created using maps_view_object_create_overlay(). * @pre @a coordinates may be set previously using maps_view_object_overlay_set_coordinates(). - * * @see maps_view_object_create_overlay() * @see maps_view_object_overlay_set_coordinates() * @see #maps_coordinates_h @@ -925,20 +841,19 @@ int maps_view_object_overlay_set_coordinates(maps_view_object_h overlay, maps_co */ int maps_view_object_overlay_get_coordinates(const maps_view_object_h overlay, maps_coordinates_h *coordinates); + /** - * @brief Sets the minimal zoom level for overlay. + * @brief Sets the minimal zoom level for overlay. * @details This function sets the minimally allowed zoom level of the map to show the overlay. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] overlay The overlay object handle - * @param[in] zoom The new minimal zoom level - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] overlay The overlay object handle + * @param[in] zoom The new minimal zoom level + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a overlay is created using maps_view_object_create_overlay(). - * * @see maps_view_object_create_overlay() * @see maps_view_object_overlay_get_min_zoom_level() * @see maps_view_object_overlay_set_max_zoom_level() @@ -946,21 +861,19 @@ int maps_view_object_overlay_get_coordinates(const maps_view_object_h overlay, m */ int maps_view_object_overlay_set_min_zoom_level(maps_view_object_h overlay, int zoom); + /** - * @brief Gets the minimal zoom level for overlay. + * @brief Gets the minimal zoom level for overlay. * @details This function gets the minimally allowed zoom level of the map to show the overlay. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] overlay The overlay object handle - * @param[out] zoom The pointer to an integer in which to store - * the minimally allowed zoom level. - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] overlay The overlay object handle + * @param[out] zoom The pointer to an integer in which to store the minimally allowed zoom level. + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a overlay is created using maps_view_object_create_overlay(). - * * @see maps_view_object_create_overlay() * @see maps_view_object_overlay_set_min_zoom_level() * @see maps_view_object_overlay_set_max_zoom_level() @@ -968,20 +881,19 @@ int maps_view_object_overlay_set_min_zoom_level(maps_view_object_h overlay, int */ int maps_view_object_overlay_get_min_zoom_level(const maps_view_object_h overlay, int *zoom); + /** - * @brief Sets the minimal zoom level for overlay. + * @brief Sets the minimal zoom level for overlay. * @details This function sets the minimally allowed zoom level of the map to show the overlay. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] overlay The overlay object handle - * @param[in] zoom The new minimal zoom level - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] overlay The overlay object handle + * @param[in] zoom The new minimal zoom level + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a overlay is created using maps_view_object_create_overlay(). - * * @see maps_view_object_create_overlay() * @see maps_view_object_overlay_get_min_zoom_level() * @see maps_view_object_overlay_set_min_zoom_level() @@ -989,21 +901,19 @@ int maps_view_object_overlay_get_min_zoom_level(const maps_view_object_h overlay */ int maps_view_object_overlay_set_max_zoom_level(maps_view_object_h overlay, int zoom); + /** - * @brief Gets the minimal zoom level for overlay. + * @brief Gets the minimal zoom level for overlay. * @details This function gets the minimally allowed zoom level of the map to show the overlay. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @param[in] overlay The overlay object handle - * @param[out] zoom The pointer to an integer in which to store - * the minimally allowed zoom level. - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] overlay The overlay object handle + * @param[out] zoom The pointer to an integer in which to store the minimally allowed zoom level + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a overlay is created using maps_view_object_create_overlay(). - * * @see maps_view_object_create_overlay() * @see maps_view_object_overlay_get_min_zoom_level() * @see maps_view_object_overlay_set_min_zoom_level() @@ -1011,10 +921,11 @@ int maps_view_object_overlay_set_max_zoom_level(maps_view_object_h overlay, int */ int maps_view_object_overlay_get_max_zoom_level(const maps_view_object_h overlay, int *zoom); + #ifdef __cplusplus } #endif /** * @} */ -#endif /* __MAPS_VIEW_OBJECT_H__ */ +#endif /* __MAPS_VIEW_OBJECT_H__ */ diff --git a/include/maps_view_object_plugin.h b/include/maps_view_object_plugin.h index 395c617..244ead2 100644 --- a/include/maps_view_object_plugin.h +++ b/include/maps_view_object_plugin.h @@ -20,8 +20,8 @@ #include /** - * @ingroup CAPI_MAPS_VIEW_MODULE - * @defgroup CAPI_MAPS_VIEW_OBJECT_MODULE View Object + * @ingroup CAPI_MAPS_VIEW_MODULE + * @defgroup CAPI_MAPS_VIEW_OBJECT_MODULE View Object * * @file maps_view_object.h * @brief This file contains the functions of View Object API @@ -42,33 +42,29 @@ extern "C" { #endif /** - * @brief Enumerations of operation types over the map view object + * @brief Enumerations of operation types over the map view object * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif */ typedef enum _maps_view_object_operation_e { - MAPS_VIEW_OBJECT_ADD, /**< Indicates the add object operation */ - MAPS_VIEW_OBJECT_SET_VISIBLE, /**< Indicates the change object visibility operation */ - MAPS_VIEW_OBJECT_MOVE, /**< Indicates the move object operation */ - MAPS_VIEW_OBJECT_CHANGE, /**< Indicates the operation of changing object specific properties */ - MAPS_VIEW_OBJECT_REMOVE, /**< Indicates the remove object operation */ + MAPS_VIEW_OBJECT_ADD, /**< Indicates the add object operation */ + MAPS_VIEW_OBJECT_SET_VISIBLE, /**< Indicates the change object visibility operation */ + MAPS_VIEW_OBJECT_MOVE, /**< Indicates the move object operation */ + MAPS_VIEW_OBJECT_CHANGE, /**< Indicates the operation of changing object specific properties */ + MAPS_VIEW_OBJECT_REMOVE, /**< Indicates the remove object operation */ } maps_view_object_operation_e; /** - * @brief Sets the marker screen size. + * @brief Sets the marker screen size. * @details This function sets the marker screen size. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * @remark . - * - * @param[in] marker The marker object handle - * @param[in] width The resized marker pixels in width on the screen - * @param[in] height The resized marker pixels in height on the screen - * @return 0, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] marker The marker object handle + * @param[in] width The resized marker pixels in width on the screen + * @param[in] height The resized marker pixels in height on the screen + * @return 0, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a marker is created using maps_view_object_create_marker(). - * * @see maps_view_object_create_marker() * @see maps_view_object_marker_get_size() * @see maps_view_object_marker_resize() @@ -81,4 +77,4 @@ int maps_view_object_marker_set_size(const maps_view_object_h marker, int width, /** * @} */ -#endif /* __MAPS_VIEW_OBJECT_PLUGIN_H__ */ +#endif /* __MAPS_VIEW_OBJECT_PLUGIN_H__ */ diff --git a/include/maps_view_plugin.h b/include/maps_view_plugin.h index 8cec74f..e4f4e18 100644 --- a/include/maps_view_plugin.h +++ b/include/maps_view_plugin.h @@ -20,8 +20,8 @@ #include /** - * @ingroup CAPI_MAPS_VIEW_MODULE - * @defgroup CAPI_MAPS_PLUGIN_VIEW_MODULE View + * @ingroup CAPI_MAPS_VIEW_MODULE + * @defgroup CAPI_MAPS_PLUGIN_VIEW_MODULE View * * @file maps_view_plugin.h * @brief This file contains the functions of Map View API @@ -36,29 +36,28 @@ extern "C" { #endif /** - * @brief Enumerations of color space types + * @brief Enumerations of color space types * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif */ -typedef enum _maps_view_colorspace_type_e -{ +typedef enum _maps_view_colorspace_type_e { MAPS_VIEW_COLORSPACE_RGBA8888, MAPS_VIEW_COLORSPACE_BGRA8888, } maps_view_colorspace_type_e; /** - * @brief Zooms the map on the view. + * @brief Zooms the map on the view. * @details This function zooms the map on the View with real value of zoom * factor. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * - * @param[in] view The view handle - * @param[out] zoom_factor The new zoom factor - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The view handle + * @param[out] zoom_factor The new zoom factor + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a view is created using maps_view_create(). * @post This function invokes maps_view_on_event_cb() with the event type @@ -77,20 +76,20 @@ typedef enum _maps_view_colorspace_type_e int maps_view_set_zoom_factor(maps_view_h view, double zoom_factor); /** - * @brief Gets the zoom factor. + * @brief Gets the zoom factor. * @details This function gets the current zoom factor of View. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @remarks zoom @a factor can be obtained also in maps_view_on_event_cb() * callback, assigned using maps_view_set_event_cb() with the event * type #MAPS_VIEW_EVENT_ACTION specified. * - * @param[in] view The view handle - * @param[out] zoom_factor The pointer to a double in which to store the + * @param[in] view The view handle + * @param[out] zoom_factor The pointer to a double in which to store the * current zoom factor - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a view is created using maps_view_create(). * @@ -101,15 +100,15 @@ int maps_view_set_zoom_factor(maps_view_h view, double zoom_factor); int maps_view_get_zoom_factor(const maps_view_h view, double *zoom_factor); /** - * @brief Get the view handle of maps plugin. + * @brief Get the view handle of maps plugin. * @details This function gets the view handle of maps plugin. * - * @param[in] view The view handle - * @param[in] maps_plugin_view_handle The view handle of maps plugin - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The view handle + * @param[in] maps_plugin_view_handle The view handle of maps plugin + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a view is created using maps_view_create(). * @@ -118,15 +117,15 @@ int maps_view_get_zoom_factor(const maps_view_h view, double *zoom_factor); int maps_view_get_maps_plugin_view_handle(maps_view_h view, void **maps_plugin_view_handle); /** - * @brief Set the view handle of maps plugin. + * @brief Set the view handle of maps plugin. * @details This function sets the view handle of maps plugin. * - * @param[in] view The view handle - * @param[in] maps_plugin_view_handle The view handle of maps plugin - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @param[in] view The view handle + * @param[in] maps_plugin_view_handle The view handle of maps plugin + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * * @pre @a view is created using maps_view_create(). * @@ -134,30 +133,29 @@ int maps_view_get_maps_plugin_view_handle(maps_view_h view, void **maps_plugin_v */ int maps_view_set_maps_plugin_view_handle(maps_view_h view, void *maps_plugin_view_handle); + /** - * @brief Set the position of provider's logo. + * @brief Set the position of provider's logo. * @details This function sets the position of provider's logo on screen. - * - * @param[in] view The view handle - * @param[in] x_factor The propotional x-position of the logo [0.0~1.0] - * @param[in] y_factor The propotional y-position of the logo [0.0~1.0] - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * + * @param[in] view The view handle + * @param[in] x_factor The propotional x-position of the logo [0.0~1.0] + * @param[in] y_factor The propotional y-position of the logo [0.0~1.0] + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported * @pre @a view is created using maps_view_create(). - * * @see maps_view_create() */ int maps_view_set_logo_position(maps_view_h view, double x_factor, double y_factor); + #ifdef __cplusplus } #endif /** * @} */ -#endif /* __MAPS_VIEW_PLUGIN_H__ */ +#endif /* __MAPS_VIEW_PLUGIN_H__ */ diff --git a/include/maps_view_snapshot.h b/include/maps_view_snapshot.h index 8474e18..60a2335 100644 --- a/include/maps_view_snapshot.h +++ b/include/maps_view_snapshot.h @@ -14,22 +14,22 @@ * limitations under the License. */ + #ifndef __MAPS_VIEW_SNAPSHOT_H__ #define __MAPS_VIEW_SNAPSHOT_H__ + #include + /** - * @ingroup CAPI_MAPS_VIEW_MODULE - * @defgroup CAPI_MAPS_VIEW_SNAPSHOT_MODULE Snapshot - * + * @ingroup CAPI_MAPS_VIEW_MODULE + * @defgroup CAPI_MAPS_VIEW_SNAPSHOT_MODULE Snapshot * @file maps_view_snapshot.h - * @brief This file contains the functions of Map Snapshot API - * + * @brief This file contains the functions of Map Snapshot API. * @addtogroup CAPI_MAPS_VIEW_SNAPSHOT_MODULE * @{ * @brief This provides APIs related to take snapshots. - * */ @@ -37,54 +37,48 @@ extern "C" { #endif + /** - * @brief Enumerations of snapshot file format type + * @brief Enumeration for snapshot file format type. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif */ -typedef enum _maps_view_snapshot_format_type_e -{ - MAPS_VIEW_SNAPSHOT_BMP, /**< Indicates the BMP format type */ - MAPS_VIEW_SNAPSHOT_JPEG, /**< Indicates the JPEG format type */ +typedef enum _maps_view_snapshot_format_type_e { + MAPS_VIEW_SNAPSHOT_BMP, /**< Indicates the BMP format type */ + MAPS_VIEW_SNAPSHOT_JPEG, /**< Indicates the JPEG format type */ } maps_view_snapshot_format_type_e; + /** - * @brief Captures a snapshot of the Map View. - * \n The request is synchronous. - * @details This function retrieves an image of a map currently represented on - * the Map View. + * @brief Captures a snapshot of the Map View.\n + * The request is synchronous. + * @details This function retrieves an image of a map currently represented on the Map View. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @privlevel public * @privilege %http://tizen.org/privilege/mapservice * @remarks To check if Maps Provider is capable of capturing snapshots use - * maps_service_provider_is_service_supported() with - * #MAPS_SERVICE_VIEW_SNAPSHOT passed as @a service parameter. - * \n It returns MAPS_ERROR_PERMISSION_DENIED if application doesn't have permission - * to write to the path. - * - * @param[in] view The Map View handle - * @param[in] type The type of file format - * @param[in] quality The quality for encoding (1~100) - * @param[in] path The file path to be created - * callback function - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid - * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported - * - * @pre Call maps_service_create() and map_view_create() to issue Maps Service - * and Map View handles respectively. + * maps_service_provider_is_service_supported() with + * #MAPS_SERVICE_VIEW_SNAPSHOT passed as @a service parameter.\n + * It returns MAPS_ERROR_PERMISSION_DENIED if application doesn't have permission + * to write to the path. + * @param[in] view The Map View handle + * @param[in] type The type of file format + * @param[in] quality The quality for encoding (1~100) + * @param[in] path The file path to be created callback function + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_SERVICE_NOT_AVAILABLE Service not available + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * @retval #MAPS_ERROR_INVALID_OPERATION Operation is not valid + * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @pre Call maps_service_create() and map_view_create() to issue Maps Service and Map View handles respectively. * @post It invokes map_view_snapshot_cb() to deliver requested snapshot. - * * @see maps_view_create() * @see maps_service_create() */ -int maps_view_capture_snapshot(maps_view_h view, - maps_view_snapshot_format_type_e type, - int quality, - const char *path); +int maps_view_capture_snapshot(maps_view_h view, maps_view_snapshot_format_type_e type, int quality, const char *path); + #ifdef __cplusplus } @@ -92,4 +86,4 @@ int maps_view_capture_snapshot(maps_view_h view, /** * @} */ -#endif /* __MAPS_VIEW_SNAPSHOT_H__*/ +#endif /* __MAPS_VIEW_SNAPSHOT_H__*/ diff --git a/packaging/capi-maps-service.spec b/packaging/capi-maps-service.spec index 39cf550..a633229 100644 --- a/packaging/capi-maps-service.spec +++ b/packaging/capi-maps-service.spec @@ -1,6 +1,6 @@ Name: capi-maps-service Summary: Tizen Maps Service API -Version: 0.6.8 +Version: 0.6.9 Release: 1 Group: Location/API License: Apache-2.0 @@ -50,7 +50,7 @@ export FFLAGS="$FFLAGS -DTIZEN_ENGINEER_MODE" MAJORVER=`echo %{version} | awk 'BEGIN {FS="."}{print $1}'` cmake . -DCMAKE_INSTALL_PREFIX=%{_prefix} -DMAJORVER=${MAJORVER} -DFULLVER=%{version} \ - -DLIBDIR=%{_libdir} -DPROFILE=%{?profile} -DTIZEN_VER=0x030000 + -DLIBDIR=%{_libdir} -DTIZEN_VER=0x030000 make %{?jobs:-j%jobs} %install diff --git a/src/api/maps_condition.cpp b/src/api/maps_condition.cpp index 0936090..d6b0442 100644 --- a/src/api/maps_condition.cpp +++ b/src/api/maps_condition.cpp @@ -96,15 +96,13 @@ bool maps_condition_check_maps_feature(void) bool maps_condition_check_internet_feature(void) { static bool is_supported = true; -#ifdef TIZEN_WEARABLE static bool is_read = false; - if (!is_read) { + if (_get_tizen_profile() == TIZEN_PROFILE_WEARABLE && !is_read) { system_info_get_platform_bool(INTERNET_FEATURE, &is_supported); MAPS_LOGD("internet feature is%ssupported", (is_supported ? " " : " not ")); is_read = true; } -#endif return is_supported; } @@ -148,4 +146,4 @@ bool maps_condition_check_view_data_supported(maps_view_h view, maps_service_dat if (maps_service_provider_is_data_supported(maps, data, &supported) != MAPS_ERROR_NONE) return false; return supported; -} \ No newline at end of file +} diff --git a/src/api/maps_extra_types.cpp b/src/api/maps_extra_types.cpp index d0eb1bf..2d51933 100644 --- a/src/api/maps_extra_types.cpp +++ b/src/api/maps_extra_types.cpp @@ -214,6 +214,20 @@ EXPORT_API int maps_item_list_clone(const maps_item_list_h origin, return error; } +EXPORT_API int maps_item_list_get_length(maps_item_list_h list, int *length) +{ + if (!maps_condition_check_maps_feature()) + return MAPS_ERROR_NOT_SUPPORTED; + if (!list || !length) + return MAPS_ERROR_INVALID_PARAMETER; + maps_item_list_s *l = (maps_item_list_s *)list; + if (!l->l) + *length = 0; + else + *length = g_list_length(l->l); + return MAPS_ERROR_NONE; +} + /*----------------------------------------------------------------------------*/ typedef struct _maps_string_hashtable_s diff --git a/src/api/maps_place.cpp b/src/api/maps_place.cpp index c29e3ab..63c47e1 100644 --- a/src/api/maps_place.cpp +++ b/src/api/maps_place.cpp @@ -524,7 +524,7 @@ EXPORT_API int maps_place_foreach_review(const maps_place_h place, maps_place_review_clone, callback, user_data); } -EXPORT_API int maps_place_get_supplier_link(const maps_place_image_h place, +EXPORT_API int maps_place_get_supplier_link(const maps_place_h place, maps_place_link_object_h *supplier) { if (!maps_condition_check_maps_feature()) @@ -540,7 +540,7 @@ EXPORT_API int maps_place_get_supplier_link(const maps_place_image_h place, return maps_place_link_object_clone(((maps_place_s *) place)->supplier, supplier); } -EXPORT_API int maps_place_get_related_link(const maps_place_image_h place, +EXPORT_API int maps_place_get_related_link(const maps_place_h place, maps_place_link_object_h *related) { if (!maps_condition_check_maps_feature()) diff --git a/src/api/maps_view.cpp b/src/api/maps_view.cpp index 0b37f60..3e475f6 100644 --- a/src/api/maps_view.cpp +++ b/src/api/maps_view.cpp @@ -617,11 +617,21 @@ EXPORT_API int maps_view_create(maps_service_h maps, Evas_Object *obj, maps_view if (__get_plugin_interface(v)) { /* Notify the Plugin, that the view is created */ - __get_plugin_interface(v)->maps_plugin_create_map_view(*view, __maps_view_ready); + if (__get_plugin_interface(v)->maps_plugin_create_map_view) + __get_plugin_interface(v)->maps_plugin_create_map_view(*view, __maps_view_ready); + else + MAPS_LOGE("ERROR!! maps_plugin_create_map_view function pointer is null"); /* Set up zoom and rotation */ - __get_plugin_interface(v)->maps_plugin_get_min_zoom_level(v, &v->min_zoom_level); - __get_plugin_interface(v)->maps_plugin_get_max_zoom_level(v, &v->max_zoom_level); + if (__get_plugin_interface(v)->maps_plugin_get_min_zoom_level) + __get_plugin_interface(v)->maps_plugin_get_min_zoom_level(v, &v->min_zoom_level); + else + MAPS_LOGE("ERROR!! maps_plugin_get_min_zoom_level function pointer is null"); + + if (__get_plugin_interface(v)->maps_plugin_get_max_zoom_level) + __get_plugin_interface(v)->maps_plugin_get_max_zoom_level(v, &v->max_zoom_level); + else + MAPS_LOGE("ERROR!! maps_plugin_get_max_zoom_level function pointer is null"); } if (v->min_zoom_level <= 0) @@ -705,7 +715,12 @@ EXPORT_API int maps_view_destroy(maps_view_h view) ecore_animator_del(v->animator); /* Notify the Plugin, that the view is to be destroyed */ - __get_plugin_interface(view)->maps_plugin_destroy_map_view(view); + if (__get_plugin_interface(view)) { + if (__get_plugin_interface(view)->maps_plugin_destroy_map_view) + __get_plugin_interface(view)->maps_plugin_destroy_map_view(view); + else + MAPS_LOGE("ERROR!! maps_plugin_destroy_map_view function pointer is null"); + } /* Destroy a visual panel */ if (v->panel) diff --git a/src/maps_util.cpp b/src/maps_util.cpp index 652e9e0..e3a31b1 100644 --- a/src/maps_util.cpp +++ b/src/maps_util.cpp @@ -18,6 +18,7 @@ #include "maps_error.h" #include #include +#include #define DEFAULT_UNKNOWN_DPI 132 @@ -50,3 +51,36 @@ int maps_get_screen_dpi(int *dpi) *dpi = __dpi; return MAPS_ERROR_NONE; } + +tizen_profile_t _get_tizen_profile() +{ + static tizen_profile_t profile = TIZEN_PROFILE_UNKNOWN; + if (__builtin_expect(profile != TIZEN_PROFILE_UNKNOWN, 1)) + return profile; + + char *profileName; + system_info_get_platform_string("http://tizen.org/feature/profile", &profileName); + switch (*profileName) { + case 'm': + case 'M': + profile = TIZEN_PROFILE_MOBILE; + break; + case 'w': + case 'W': + profile = TIZEN_PROFILE_WEARABLE; + break; + case 't': + case 'T': + profile = TIZEN_PROFILE_TV; + break; + case 'i': + case 'I': + profile = TIZEN_PROFILE_IVI; + break; + default: // common or unknown ==> ALL ARE COMMON. + profile = TIZEN_PROFILE_COMMON; + } + free(profileName); + + return profile; +} diff --git a/src/maps_util.h b/src/maps_util.h index 1f08715..74037fe 100755 --- a/src/maps_util.h +++ b/src/maps_util.h @@ -219,4 +219,13 @@ public: } }; +typedef enum { + TIZEN_PROFILE_UNKNOWN = 0, + TIZEN_PROFILE_MOBILE = 0x1, + TIZEN_PROFILE_WEARABLE = 0x2, + TIZEN_PROFILE_TV = 0x4, + TIZEN_PROFILE_IVI = 0x8, + TIZEN_PROFILE_COMMON = 0x10, +} tizen_profile_t; +extern tizen_profile_t _get_tizen_profile(); #endif /* __MAPS_UTIL_H__ */ diff --git a/src/plugin/discovery.cpp b/src/plugin/discovery.cpp index b00106f..f6b4ddd 100644 --- a/src/plugin/discovery.cpp +++ b/src/plugin/discovery.cpp @@ -158,7 +158,6 @@ typedef struct gboolean user_consent_shutdown(gpointer data) { - MAPS_LOGD("data = %p", data); if (!data) return false; user_consent_s *uc = (user_consent_s*)data; diff --git a/src/plugin/module.cpp b/src/plugin/module.cpp index 697f4d1..69fd200 100644 --- a/src/plugin/module.cpp +++ b/src/plugin/module.cpp @@ -522,6 +522,11 @@ void plugin::binary_extractor::trace_dbg(const plugin_s *plugin) const MAPS_LOGD("maps_plugin_cancel_request:\t\t%p", itf->maps_plugin_cancel_request); + + MAPS_LOGD("maps_plugin_create_map_view:\t\t%p", + itf->maps_plugin_create_map_view); + MAPS_LOGD("maps_plugin_destroy_map_view:\t\t%p", + itf->maps_plugin_destroy_map_view); MAPS_LOGD("maps_plugin_capture_snapshot:\t\t%p", itf->maps_plugin_capture_snapshot); MAPS_LOGD("*********************************************"); diff --git a/src/view/gesture_detector.h b/src/view/gesture_detector.h index 46368c5..84c7f4e 100644 --- a/src/view/gesture_detector.h +++ b/src/view/gesture_detector.h @@ -50,10 +50,17 @@ namespace view /* Half a second is a popular duration of double click in UI */ static const unsigned int __CLICK_DURATION = 500 * __MIL_SEC; static const unsigned int __DOUBLE_CLICK_DURATION = __CLICK_DURATION; +#if (__cplusplus >= 201103L) + static constexpr double __TAP_DURATION = 0.5; + /* Half a second is a popular duration of double click in UI + * however, sometimes it is 1 second */ + static constexpr double __LONG_PRESS_DURATION = 0.5; +#else static const double __TAP_DURATION = 0.5; /* Half a second is a popular duration of double click in UI * however, sometimes it is 1 second */ static const double __LONG_PRESS_DURATION = 0.5; +#endif public: diff --git a/src/view/inertial_camera.h b/src/view/inertial_camera.h index 29ef53a..54b37f7 100644 --- a/src/view/inertial_camera.h +++ b/src/view/inertial_camera.h @@ -38,9 +38,15 @@ namespace view /* Is transition performing right now */ bool transiting; protected: +#if (__cplusplus >= 201103L) + static constexpr double __GEO_ACCURACY = 0.00001; + static constexpr double __ZOOM_ACCURACY = 0.1; + static constexpr double __ROTATE_ACCURACY = 0.5; +#else static const double __GEO_ACCURACY = 0.00001; static const double __ZOOM_ACCURACY = 0.1; static const double __ROTATE_ACCURACY = 0.5; +#endif public: inertial_camera(maps_view_h view); ~inertial_camera(); diff --git a/src/view/inertial_gesture.h b/src/view/inertial_gesture.h index 3b2f19e..23be5ed 100644 --- a/src/view/inertial_gesture.h +++ b/src/view/inertial_gesture.h @@ -38,7 +38,11 @@ namespace view unsigned transiting_start[MAX_FINGERS]; double _dt[MAX_FINGERS]; private: +#if (__cplusplus >= 201103L) + static constexpr double __ACCURACY = 1; +#else static const double __ACCURACY = 1; +#endif public: inertial_gesture(maps_view_h view); ~inertial_gesture();