From: jomui Date: Thu, 12 Jan 2017 07:26:34 +0000 (+0900) Subject: apply doxygen from DXL X-Git-Tag: submit/tizen_3.0/20170120.062955^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=969ec63db061d630617910d25ffefc3ba54d411c;p=platform%2Fcore%2Fapi%2Fmaps-service.git apply doxygen from DXL Signed-off-by: jomui Change-Id: I081f4e03c5cc1bc736c5217614c6c7f9c17a995b --- diff --git a/include/maps_address.h b/include/maps_address.h index efd1878..2396d4a 100644 --- a/include/maps_address.h +++ b/include/maps_address.h @@ -14,19 +14,22 @@ * limitations under the License. */ + #ifndef __MAPS_ADDRESS_H__ #define __MAPS_ADDRESS_H__ + /** * @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 * @{ - * @file maps_address.h - * @brief This file contains the functions related to Address information. * @brief This provides APIs related to Address information used in Geocoding and Reverse Geocoding. */ + #ifdef __cplusplus extern "C" { #endif @@ -47,8 +50,10 @@ typedef void *maps_address_h; */ 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. @@ -105,8 +110,10 @@ int maps_address_destroy(maps_address_h address); */ int maps_address_clone(const maps_address_h origin, maps_address_h *cloned); + /*----------------------------------------------------------------------------*/ + /** * @brief Gets the building number of the address handle. * @details This function gets the building number of the address handle. @@ -296,8 +303,10 @@ int maps_address_get_postal_code(const maps_address_h address, char **postal_cod */ int maps_address_get_freetext(const maps_address_h address, char **freetext); + /*----------------------------------------------------------------------------*/ + /** * @brief Sets the building number of the address handle. * @details This function sets the building number of the address handle. @@ -448,7 +457,7 @@ int maps_address_set_county(maps_address_h address, const char *county); * @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 @c 0, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -496,7 +505,7 @@ int maps_address_list_create(maps_address_list_h *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 its removed from the list using maps_address_list_remove(). + * @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, @@ -555,7 +564,7 @@ int maps_address_list_get_length(maps_address_list_h address_list, int *length); * @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_address() + * @see maps_address_list_foreach() * @see maps_address_list_destroy() */ typedef bool (*maps_address_cb)(int index, maps_address_h address, void *user_data); diff --git a/include/maps_area.h b/include/maps_area.h index c9cbb29..98724de 100644 --- a/include/maps_area.h +++ b/include/maps_area.h @@ -14,32 +14,35 @@ * limitations under the License. */ + #ifndef __MAPS_GEOAREA_H__ #define __MAPS_GEOAREA_H__ + #include + /** * @ingroup CAPI_MAPS_SERVICE_MODULE * @defgroup CAPI_MAPS_GEOAREA_MODULE Area - * @addtogroup CAPI_MAPS_GEOAREA_MODULE - * @{ * @file maps_area.h * @brief This file contains the definitions, structures, and functions related to area information. - * @brief This provides APIs related to Geographical Area. + * @addtogroup CAPI_MAPS_GEOAREA_MODULE + * @{ + * @brief This provides APIs related to geographical area. */ + #ifdef __cplusplus extern "C" { #endif /** - * @brief Geographical Area handle. - * @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(). + * @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 * @see maps_area_create_rectangle() * @see maps_area_create_circle() @@ -51,8 +54,7 @@ typedef void *maps_area_h; /** * @brief Enumeration for supported types of the Geographical Area. - * @details This enumeration represents allowed geographical type of - * Geographical Area: rectangular and circular. + * @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 { @@ -64,10 +66,9 @@ typedef enum { /** * @brief Structure of the rectangular Geographical Area. - * @details This structure represents a rectangular Geographical Area, - * specified with left top and right bottom coordinates. - * @remarks Do not use #maps_area_rectangle_s directly if you are an application developer. + * @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. */ @@ -102,8 +103,10 @@ typedef struct _maps_area_s { }; } 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. @@ -137,7 +140,7 @@ int maps_area_create_rectangle(const maps_coordinates_h top_left, const maps_coo * @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. + * 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 diff --git a/include/maps_coordinates.h b/include/maps_coordinates.h index aaa5b9e..44d7633 100644 --- a/include/maps_coordinates.h +++ b/include/maps_coordinates.h @@ -14,38 +14,43 @@ * limitations under the License. */ + #ifndef __MAPS_COORDINATES_H__ #define __MAPS_COORDINATES_H__ + #include + /** * @ingroup CAPI_MAPS_SERVICE_MODULE * @defgroup CAPI_MAPS_COORDS_MODULE Coordinates - * @addtogroup CAPI_MAPS_COORDS_MODULE - * @{* * @file maps_coordinates.h * @brief This file contains the functions related to Geographical Coordinates. - * @brief This provides APIs related to Geographical Coordinates. + * @addtogroup CAPI_MAPS_COORDS_MODULE + * @{ + * @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(). * @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 the @a latitude and @a longitude values.\n + * @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 @@ -67,12 +72,13 @@ typedef struct _maps_coordinates_s { */ 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 + * @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 @@ -96,7 +102,7 @@ int maps_coordinates_create(const double latitude, const double longitude, maps_ * @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 coordinates handle to destroy + * @param[in] coordinates The coordinate handle to destroy * @return @c 0 on coordinates, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -128,14 +134,16 @@ int maps_coordinates_destroy(maps_coordinates_h coordinates); */ int maps_coordinates_clone(const maps_coordinates_h origin, maps_coordinates_h *cloned); + /*----------------------------------------------------------------------------*/ + /** * @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 coordinates handle - * @param[out] latitude The latitude of the coordinates handle + * @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 @@ -152,8 +160,8 @@ int maps_coordinates_get_latitude(const maps_coordinates_h coordinates, double * * @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 coordinates handle - * @param[out] longitude The longitude of the coordinates handle + * @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 @@ -170,9 +178,9 @@ int maps_coordinates_get_longitude(const maps_coordinates_h coordinates, double * @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 coordinates handle - * @param[out] latitude The latitude of the coordinates handle - * @param[out] longitude The longitude of the coordinates handle + * @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 @@ -183,14 +191,17 @@ int maps_coordinates_get_longitude(const maps_coordinates_h coordinates, double * @see maps_coordinates_set_latitude_longitude() */ int maps_coordinates_get_latitude_longitude(const maps_coordinates_h coordinates, double *latitude, double *longitude); + + /*----------------------------------------------------------------------------*/ + /** * @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 coordinates handle - * @param[in] latitude The latitude of the coordinates handle + * @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 @@ -207,8 +218,8 @@ int maps_coordinates_set_latitude(maps_coordinates_h coordinates, const double l * @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 coordinates handle - * @param[out] longitude The longitude of the coordinates handle + * @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 @@ -258,7 +269,7 @@ int maps_coordinates_list_create(maps_coordinates_list_h *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 + * @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 diff --git a/include/maps_error.h b/include/maps_error.h index a35278c..2f21c9e 100644 --- a/include/maps_error.h +++ b/include/maps_error.h @@ -14,32 +14,37 @@ * limitations under the License. */ + #ifndef __MAPS_ERROR_H__ #define __MAPS_ERROR_H__ + #include #include + /** * @ingroup CAPI_MAPS_SERVICE_MODULE - * @addtogroup CAPI_MAPS_SERVICE_AND_PREFERENCE_MODULE - * @{ * @file maps_error.h * @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. */ + #ifdef __cplusplus extern "C" { #endif + #ifndef TIZEN_ERROR_MAPS_SERVICE #define TIZEN_ERROR_MAPS_SERVICE -0x02C20000 #endif /** - * @brief Enumeration for Maps Service and Plug-ins error codes. + * @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 { diff --git a/include/maps_extra_types.h b/include/maps_extra_types.h index 2060c66..a5d1067 100644 --- a/include/maps_extra_types.h +++ b/include/maps_extra_types.h @@ -488,7 +488,7 @@ int maps_string_hashtable_set(maps_string_hashtable_h table, const char *key, co * @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" @@ -1174,7 +1174,7 @@ int maps_item_hashtable_free_float(void *data); * @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(). @@ -1204,7 +1204,7 @@ int maps_item_hashtable_set_string(maps_item_hashtable_h table, const char *key, * @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(). @@ -1234,7 +1234,7 @@ int maps_item_hashtable_set_int(maps_item_hashtable_h table, const char *key, co * @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(). @@ -1283,7 +1283,7 @@ int maps_item_hashtable_set_float(maps_item_hashtable_h table, const char *key, * - 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 @@ -1319,7 +1319,7 @@ int maps_item_hashtable_set(maps_item_hashtable_h table, const char *key, const * @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" @@ -1397,7 +1397,7 @@ int maps_item_hashtable_get_float(maps_item_hashtable_h table, const char *key, * @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" diff --git a/include/maps_place.h b/include/maps_place.h index 59235e4..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,26 +31,29 @@ #include #include + /** * @ingroup CAPI_MAPS_PLACE_MODULE * @defgroup CAPI_MAPS_PLACE_DATA_MODULE Place - * @addtogroup CAPI_MAPS_PLACE_DATA_MODULE - * @{ * @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. */ + #ifdef __cplusplus extern "C" { #endif + /** * @brief The Place handle. * @details The handle of Place instance. * @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(). + * @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() */ @@ -64,13 +69,15 @@ typedef void *maps_place_h; */ 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. * @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. + * @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 @@ -83,6 +90,7 @@ typedef void *maps_place_list_h; */ 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. @@ -91,7 +99,7 @@ typedef bool(*maps_place_properties_cb) (int index, int total, char *key, void * * 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] 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 @@ -110,7 +118,7 @@ typedef bool(*maps_place_categories_cb) (int index, int total, maps_place_catego * 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] 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 @@ -129,7 +137,7 @@ typedef bool(*maps_place_attributes_cb) (int index, int total, maps_place_attrib * 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] 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 @@ -148,7 +156,7 @@ typedef bool(*maps_place_contacts_cb) (int index, int total, maps_place_contact_ * 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] 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 @@ -156,7 +164,6 @@ typedef bool(*maps_place_contacts_cb) (int index, int total, maps_place_contact_ * @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); @@ -168,7 +175,7 @@ typedef bool(*maps_place_editorials_cb) (int index, int total, maps_place_editor * 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] 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 @@ -187,7 +194,7 @@ typedef bool(*maps_place_images_cb) (int index, int total, maps_place_image_h im * 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] 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 @@ -203,7 +210,7 @@ typedef bool(*maps_place_reviews_cb) (int index, int total, maps_place_review_h * @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] 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 @@ -219,13 +226,15 @@ typedef bool(*maps_place_reviews_cb) (int index, int total, maps_place_review_h */ 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 + * @param[in] place The place handle to destroy * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -237,12 +246,12 @@ 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 + * @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 @@ -253,15 +262,17 @@ int maps_place_destroy(maps_place_h place); */ 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 + * @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 @@ -272,12 +283,12 @@ int maps_place_get_id(const maps_place_h place, char **id); /** - * @brief Gets the Place name. - * @details This function 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 + * @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 @@ -288,12 +299,12 @@ int maps_place_get_name(const maps_place_h place, char **name); /** - * @brief Gets the Place View URI. - * @details This function 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 + * @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 @@ -304,12 +315,12 @@ int maps_place_get_uri(const maps_place_h place, char **uri); /** - * @brief Gets the Place Location. - * @details This function 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 + * @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 @@ -320,11 +331,11 @@ int maps_place_get_location(const maps_place_h place, maps_coordinates_h *locati /** - * @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 + * @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 @@ -335,12 +346,12 @@ int maps_place_get_distance(const maps_place_h place, int *distance); /** - * @brief Gets the Place Address. - * @details This function 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 + * @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 @@ -350,12 +361,12 @@ int maps_place_get_distance(const maps_place_h place, int *distance); int maps_place_get_address(const maps_place_h place, maps_address_h *address); /** - * @brief Gets the Place rating. - * @details This function 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 + * @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 @@ -367,10 +378,10 @@ int maps_place_get_rating(const maps_place_h place, maps_place_rating_h *rating) /** * @brief Retrieves all properties. - * @details This function retrieves all Place 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] 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, @@ -387,10 +398,10 @@ int maps_place_foreach_property(const maps_place_h place, maps_place_properties_ /** * @brief Retrieves all categories - * @details This function retrieves all Place 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] 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, @@ -407,10 +418,10 @@ int maps_place_foreach_category(const maps_place_h place, maps_place_categories_ /** * @brief Retrieves all attributes. - * @details This function retrieves all Place 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] 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, @@ -427,10 +438,10 @@ int maps_place_foreach_attribute(const maps_place_h place, maps_place_attributes /** * @brief Retrieves all contacts. - * @details This function retrieves all Place 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] 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, @@ -447,10 +458,10 @@ int maps_place_foreach_contact(const maps_place_h place, maps_place_contacts_cb /** * @brief Retrieves all editorials. - * @details This function retrieves all Place 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] 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, @@ -464,12 +475,13 @@ int maps_place_foreach_contact(const maps_place_h place, maps_place_contacts_cb */ int maps_place_foreach_editorial(const maps_place_h place, maps_place_editorials_cb callback, void *user_data); + /** * @brief Retrieves all images. - * @details This function retrieves all Place 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] 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, @@ -486,10 +498,10 @@ int maps_place_foreach_image(const maps_place_h place, maps_place_images_cb call /** * @brief Retrieves all reviews. - * @details This function retrieves all Place 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] 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, @@ -505,12 +517,12 @@ int maps_place_foreach_review(const maps_place_h place, maps_place_reviews_cb ca /** - * @brief Gets the Place supplier link. - * @details This function 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 - * @param[out] supplier The Place supplier link + * @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 @@ -521,12 +533,12 @@ int maps_place_get_supplier_link(const maps_place_h place, maps_place_link_objec /** - * @brief Gets the Place related link. - * @details This function 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 - * @param[out] related The Place related link + * @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 @@ -537,12 +549,12 @@ int maps_place_get_related_link(const maps_place_h place, maps_place_link_object /** - * @brief Retrieves all Places. - * @details This function 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] 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, @@ -559,9 +571,9 @@ int maps_place_list_foreach(const maps_place_list_h place_list, maps_place_cb ca /** - * @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 + * @param[in] place_list The place list handle * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful diff --git a/include/maps_place_attribute.h b/include/maps_place_attribute.h index 995db0d..a5ba044 100644 --- a/include/maps_place_attribute.h +++ b/include/maps_place_attribute.h @@ -14,19 +14,22 @@ * 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 - * @addtogroup CAPI_MAPS_PLACE_ATTRIBUTE_MODULE - * @{ * @file maps_place_attribute.h * @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. */ + #ifdef __cplusplus extern "C" { #endif @@ -36,20 +39,22 @@ extern "C" { * @brief The Place Attribute handle. * @details The handle of Place Attribute instance. * @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(). + * @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 + * @param[in] attribute The place attribute handle to destroy * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -61,12 +66,12 @@ 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 + * @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 @@ -77,17 +82,19 @@ int maps_place_attribute_destroy(maps_place_attribute_h attribute); */ 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 + * @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 + * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported @@ -96,12 +103,12 @@ int maps_place_attribute_get_id(const maps_place_attribute_h attribute, char **i /** - * @brief Gets the Place Attribute label. - * @details This function 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 + * @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 @@ -112,12 +119,12 @@ int maps_place_attribute_get_label(const maps_place_attribute_h attribute, char /** - * @brief Gets the Place Attribute text. - * @details This function 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 + * @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 diff --git a/include/maps_place_category.h b/include/maps_place_category.h index 98341ae..9edbcb2 100644 --- a/include/maps_place_category.h +++ b/include/maps_place_category.h @@ -14,19 +14,22 @@ * 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 - * @addtogroup CAPI_MAPS_PLACE_CATEGORY_MODULE - * @{ * @file maps_place_category.h * @brief This file contains the functions related to Place Category information. - * @brief This provides APIs related to Place Category information, used in Place Discovery and Search. + * @addtogroup CAPI_MAPS_PLACE_CATEGORY_MODULE + * @{ + * @brief This provides APIs related to place Category information, used in Place Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif @@ -36,23 +39,24 @@ extern "C" { * @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(). + * @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 + * @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 @@ -66,12 +70,12 @@ 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 + * @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 @@ -84,10 +88,10 @@ int maps_place_category_clone(const maps_place_category_h origin, maps_place_cat /** - * @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 + * @param[in] category The place category handle to destroy * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -100,13 +104,14 @@ 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 + * @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 @@ -117,12 +122,12 @@ int maps_place_category_get_id(const maps_place_category_h category, char **id); /** - * @brief Gets the Place Category name. - * @details This function 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 + * @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 @@ -133,12 +138,12 @@ int maps_place_category_get_name(const maps_place_category_h category, char **na /** - * @brief Gets the Place Category URL. - * @details This function 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 + * @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 @@ -149,11 +154,11 @@ 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 + * @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 @@ -167,11 +172,11 @@ int maps_place_category_set_id(maps_place_category_h category, const char *id); /** - * @brief Sets the Place Category name. - * @details This function 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 + * @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 @@ -185,11 +190,11 @@ int maps_place_category_set_name(maps_place_category_h category, const char *nam /** - * @brief Sets the Place Category URL. - * @details This function 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 + * @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 diff --git a/include/maps_place_contact.h b/include/maps_place_contact.h index 4b9c4ea..af20993 100644 --- a/include/maps_place_contact.h +++ b/include/maps_place_contact.h @@ -14,19 +14,22 @@ * 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 - * @addtogroup CAPI_MAPS_PLACE_CONTACT_MODULE - * @{ * @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. */ + #ifdef __cplusplus extern "C" { #endif @@ -36,20 +39,22 @@ extern "C" { * @brief The Place Contact handle. * @details The handle of Place Contact instance. * @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(). + * @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 + * @param[in] contact The place contact handle to destroy * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -61,12 +66,12 @@ 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 + * @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 @@ -77,15 +82,17 @@ int maps_place_contact_destroy(maps_place_contact_h contact); */ int maps_place_contact_clone(const maps_place_contact_h origin, maps_place_contact_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the Place Contact label. - * @details This function 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 + * @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 @@ -96,12 +103,12 @@ int maps_place_contact_get_label(const maps_place_contact_h contact, char **labe /** - * @brief Gets the Place Contact type. - * @details This function 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 + * @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 @@ -112,12 +119,12 @@ int maps_place_contact_get_type(const maps_place_contact_h contact, char **type) /** - * @brief Gets the Place Contact value. - * @details This function 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 + * @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 diff --git a/include/maps_place_editorial.h b/include/maps_place_editorial.h index 1506454..5353eb5 100644 --- a/include/maps_place_editorial.h +++ b/include/maps_place_editorial.h @@ -14,22 +14,25 @@ * 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 + * @file maps_place_editorial.h + * @brief This file contains the functions related to Place Editorial information. * @addtogroup CAPI_MAPS_PLACE_EDITORIAL_MODULE * @{ - * @file maps_place_editorial.h - * @brief This file contains the functions related to Place Editorial - * information. * @brief This provides APIs related to Place Editorial information, used in Place Discovery and Search. */ + #ifdef __cplusplus extern "C" { #endif @@ -38,21 +41,23 @@ extern "C" { /** * @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 + * @param[in] editorial The place editorial handle to destroy * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -64,12 +69,12 @@ 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 + * @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 @@ -80,15 +85,17 @@ int maps_place_editorial_destroy(maps_place_editorial_h editorial); */ int maps_place_editorial_clone(const maps_place_editorial_h origin, maps_place_editorial_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the Place Editorial description. - * @details This function 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 + * @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 @@ -99,12 +106,12 @@ int maps_place_editorial_get_description(const maps_place_editorial_h editorial, /** - * @brief Gets the Place Editorial language. - * @details This function 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 + * @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 @@ -115,12 +122,12 @@ int maps_place_editorial_get_language(const maps_place_editorial_h editorial, ch /** - * @brief Gets the Place Editorial media. - * @details This function 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 + * @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 diff --git a/include/maps_place_filter.h b/include/maps_place_filter.h index d2c4a2e..72d62f5 100644 --- a/include/maps_place_filter.h +++ b/include/maps_place_filter.h @@ -14,21 +14,26 @@ * 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 - * @addtogroup CAPI_MAPS_PLACE_FILTER_MODULE - * @{ * @file maps_place_filter.h * @brief This file contains the functions related to Place Filter information. - * @brief This provides APIs related to Place Filter information, used in Place Discovery and Search. + * @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 @@ -38,42 +43,45 @@ extern "C" { * @brief The Place Filter handle. * @details The handle of Place Filter instance. * @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(). + * @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. * @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. + * @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 + * @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); + /*----------------------------------------------------------------------------*/ + /** * @brief Creates a new Place Filter handle. - * @details This function creates a new Place Filter handle and allocates all needed resources. + * @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 + * @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 @@ -87,10 +95,10 @@ 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 + * @param[in] filter The place filter handle to destroy * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -104,13 +112,13 @@ 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 + * @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 @@ -123,14 +131,16 @@ int maps_place_filter_destroy(maps_place_filter_h filter); */ 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] 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, @@ -150,7 +160,7 @@ int maps_place_filter_get(const maps_place_filter_h filter, const char *key, cha * @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[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 @@ -169,7 +179,7 @@ int maps_place_filter_get_keyword(const maps_place_filter_h filter, char **keywo * @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[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 @@ -189,7 +199,7 @@ int maps_place_filter_get_place_name(const maps_place_filter_h filter, char **pl * 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[in] filter The handle of the place filter * @param[out] category The category * @return @c 0 on success, * otherwise a negative error value @@ -205,9 +215,9 @@ int maps_place_filter_get_category(const maps_place_filter_h filter, maps_place_ /** * @brief Retrieves all filter properties. - * @details This function retrieves all Place 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] 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, @@ -231,7 +241,7 @@ int maps_place_filter_foreach_property(const maps_place_filter_h filter, maps_pl * @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[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 @@ -244,15 +254,17 @@ int maps_place_filter_foreach_property(const maps_place_filter_h filter, maps_pl */ 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. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif - * @param[in] filter The handle of the Place Filter + * @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 the value is removed + * @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 @@ -269,7 +281,7 @@ int maps_place_filter_set(maps_place_filter_h filter, const char *key, const cha * @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] filter The handle of the place filter * @param[in] keyword The keyword * @return @c 0 on success, * otherwise a negative error value @@ -287,7 +299,7 @@ int maps_place_filter_set_keyword(maps_place_filter_h filter, const char *keywor * @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] filter The handle of the place filter * @param[in] place_name The place name * @return @c 0 on success, * otherwise a negative error value @@ -303,9 +315,9 @@ int maps_place_filter_set_place_name(maps_place_filter_h filter, const char *pla /** * @brief Sets the category. - * @details This function 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] filter The handle of the place filter * @param[in] category The category * @return @c 0 on success, * otherwise a negative error value @@ -323,7 +335,7 @@ int maps_place_filter_set_category(maps_place_filter_h filter, const maps_place_ * @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] filter The handle of the place filter * @param[in] place_address The place address * @return @c 0 on success, * otherwise a negative error value diff --git a/include/maps_place_image.h b/include/maps_place_image.h index 3d427ba..aac1c51 100644 --- a/include/maps_place_image.h +++ b/include/maps_place_image.h @@ -14,22 +14,26 @@ * 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 - * @addtogroup CAPI_MAPS_PLACE_IMAGE_MODULE - * @{ * @file maps_place_image.h * @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. */ + #ifdef __cplusplus extern "C" { #endif @@ -38,21 +42,23 @@ extern "C" { /** * @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 + * @param[in] image The place image handle to destroy * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -64,12 +70,12 @@ 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 + * @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 @@ -80,15 +86,17 @@ int maps_place_image_destroy(maps_place_image_h image); */ 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 + * @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 @@ -99,12 +107,12 @@ int maps_place_image_get_id(const maps_place_image_h image, char **id); /** - * @brief Gets the Place Image URL. - * @details This function 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 + * @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 @@ -115,11 +123,11 @@ int maps_place_image_get_url(const maps_place_image_h image, char **url); /** - * @brief Gets the Place Image width. - * @details This function 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 + * @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 @@ -130,11 +138,11 @@ int maps_place_image_get_width(const maps_place_image_h image, int *width); /** - * @brief Gets the Place Image height. - * @details This function 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 + * @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 @@ -145,12 +153,12 @@ int maps_place_image_get_height(const maps_place_image_h image, int *height); /** - * @brief Gets the Place Image user link. - * @details This function 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 + * @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 @@ -162,12 +170,12 @@ int maps_place_image_get_user_link(const maps_place_image_h image, maps_place_li /** - * @brief Gets the Place Image media. - * @details This function 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 + * @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 diff --git a/include/maps_place_link_object.h b/include/maps_place_link_object.h index 3eba61b..a9aeae4 100644 --- a/include/maps_place_link_object.h +++ b/include/maps_place_link_object.h @@ -14,16 +14,18 @@ * 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 - * @addtogroup CAPI_MAPS_PLACE_LINK_MODULE - * @{ * @file maps_place_link_object.h * @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. */ @@ -35,21 +37,23 @@ extern "C" { /** * @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 + * @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 @@ -61,12 +65,12 @@ 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 + * @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 @@ -77,15 +81,17 @@ int maps_place_link_object_destroy(maps_place_link_object_h link); */ 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 + * @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 @@ -96,12 +102,12 @@ int maps_place_link_object_get_id(const maps_place_link_object_h link, char **id /** - * @brief Gets the Place Link Object name. - * @details This function 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 + * @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 @@ -112,12 +118,12 @@ int maps_place_link_object_get_name(const maps_place_link_object_h link, char ** /** - * @brief Gets the Place Link Object string. - * @details This function 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 + * @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 @@ -128,12 +134,12 @@ int maps_place_link_object_get_string(const maps_place_link_object_h link, char /** - * @brief Gets the Place Link Object type. - * @details This function 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 + * @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 diff --git a/include/maps_place_media.h b/include/maps_place_media.h index 03a21e2..8347782 100644 --- a/include/maps_place_media.h +++ b/include/maps_place_media.h @@ -14,21 +14,25 @@ * 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 - * @addtogroup CAPI_MAPS_PLACE_MEDIA_MODULE - * @{ * @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. */ + #ifdef __cplusplus extern "C" { #endif @@ -37,21 +41,23 @@ extern "C" { /** * @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 + * @param[in] media The place media handle to destroy * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -63,12 +69,12 @@ 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 + * @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 @@ -79,15 +85,17 @@ int maps_place_media_destroy(maps_place_media_h media); */ int maps_place_media_clone(const maps_place_media_h origin, maps_place_media_h *cloned); + /*---------------------------------------------------------------------------*/ + /** - * @brief Gets the Place Media attribution. - * @details This function 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 + * @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 @@ -98,12 +106,12 @@ int maps_place_media_get_attribution(const maps_place_media_h media, char **attr /** - * @brief Gets the Place Media supplier link. - * @details This function 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 + * @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 @@ -115,12 +123,12 @@ int maps_place_media_get_supplier(const maps_place_media_h media, maps_place_lin /** - * @brief Gets the Place Media "via" link. - * @details This function 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 + * @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 diff --git a/include/maps_place_rating.h b/include/maps_place_rating.h index d9b984a..8f37f15 100644 --- a/include/maps_place_rating.h +++ b/include/maps_place_rating.h @@ -14,21 +14,25 @@ * 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 - * @addtogroup CAPI_MAPS_PLACE_RATING_MODULE - * @{ * @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. */ + #ifdef __cplusplus extern "C" { #endif @@ -37,21 +41,23 @@ extern "C" { /** * @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 + * @param[in] rating The place rating handle to destroy * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -63,12 +69,12 @@ 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 + * @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 @@ -79,14 +85,16 @@ int maps_place_rating_destroy(maps_place_rating_h rating); */ int maps_place_rating_clone(const maps_place_rating_h origin, maps_place_rating_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the Place Rating count. - * @details This function 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 + * @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 @@ -97,10 +105,10 @@ int maps_place_rating_get_count(const maps_place_rating_h rating, int *count); /** - * @brief Gets the Place Rating average. - * @details This function 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[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 diff --git a/include/maps_place_review.h b/include/maps_place_review.h index 283f7f8..fdda91b 100644 --- a/include/maps_place_review.h +++ b/include/maps_place_review.h @@ -14,22 +14,26 @@ * 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 - * @addtogroup CAPI_MAPS_PLACE_REVIEW_MODULE - * @{ * @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. */ + #ifdef __cplusplus extern "C" { #endif @@ -39,22 +43,24 @@ extern "C" { * @brief The Place Review handle. * @details The handle of Place Review instance. * @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(). + * @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 + * @param[in] review The place review handle to destroy * @return @c 0 on success, - * otherwise a negative error value + * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported @@ -64,12 +70,12 @@ 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 + * @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 @@ -80,15 +86,17 @@ int maps_place_review_destroy(maps_place_review_h review); */ int maps_place_review_clone(const maps_place_review_h origin, maps_place_review_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the Place Review date. - * @details This function 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 + * @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 @@ -99,12 +107,12 @@ int maps_place_review_get_date(const maps_place_review_h review, char **date); /** - * @brief Gets the Place Review title. - * @details This function 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 + * @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 @@ -115,11 +123,11 @@ int maps_place_review_get_title(const maps_place_review_h review, char **title); /** - * @brief Gets the Place Review rating. - * @details This function 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 + * @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 @@ -130,12 +138,12 @@ int maps_place_review_get_rating(const maps_place_review_h review, double *ratin /** - * @brief Gets the Place Review description. - * @details This function 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 + * @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 @@ -146,12 +154,12 @@ int maps_place_review_get_description(const maps_place_review_h review, char **d /** - * @brief Gets the Place Review language. - * @details This function 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 + * @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 @@ -162,12 +170,12 @@ int maps_place_review_get_language(const maps_place_review_h review, char **lang /** - * @brief Gets the Place Review media. - * @details This function 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 + * @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 @@ -179,12 +187,12 @@ int maps_place_review_get_media(const maps_place_review_h review, maps_place_med /** - * @brief Gets the Place Review user link. - * @details This function 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 + * @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 diff --git a/include/maps_place_url.h b/include/maps_place_url.h index c1506e1..3a2d1d1 100644 --- a/include/maps_place_url.h +++ b/include/maps_place_url.h @@ -14,19 +14,22 @@ * 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 - * @addtogroup CAPI_MAPS_PLACE_URL_MODULE - * @{ * @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. */ + #ifdef __cplusplus extern "C" { #endif @@ -35,21 +38,23 @@ extern "C" { /** * @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 + * @param[in] url The place URL handle to destroy * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -61,12 +66,12 @@ 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 + * @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 @@ -77,15 +82,17 @@ int maps_place_url_destroy(maps_place_url_h url); */ int maps_place_url_clone(const maps_place_url_h origin, maps_place_url_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the Place URL path. - * @details This function 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 + * @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 @@ -96,12 +103,12 @@ int maps_place_url_get_path(const maps_place_url_h url, char **path); /** - * @brief Gets the Place URL description. - * @details This function 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 + * @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 diff --git a/include/maps_preference.h b/include/maps_preference.h index 8c62d8f..cab7eba 100644 --- a/include/maps_preference.h +++ b/include/maps_preference.h @@ -14,22 +14,26 @@ * 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 - * @addtogroup CAPI_MAPS_PREFERENCE_MODULE - * @{ * @file maps_preference.h * @brief This file contains the enumerations of Maps API preferences. + * @addtogroup CAPI_MAPS_PREFERENCE_MODULE + * @{ * @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 @@ -47,7 +51,6 @@ extern "C" { * - #MAPS_ROUTE_INSTRUCTION_RETRIEVAL * - #MAPS_ROUTE_REALTIME_TRAFFIC * . - * . */ @@ -80,71 +83,62 @@ extern "C" { /** - * @brief Definition for 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 Definition for 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 Definition for 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 Definition for 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 Definition for 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 Definition for 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 Definition for the name of the preference indicating that route should be - * computed corresponding 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 Definition for 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" @@ -152,8 +146,8 @@ extern "C" { /** * @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(). + * 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() @@ -250,14 +244,15 @@ typedef enum _maps_route_request_feature_e { 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. * @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. + * @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 @@ -270,8 +265,10 @@ typedef enum _maps_route_request_feature_e { */ 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. @@ -323,8 +320,10 @@ int maps_preference_destroy(maps_preference_h preference); */ int maps_preference_clone(const maps_preference_h origin, maps_preference_h *cloned); + /*----------------------------------------------------------------------------*/ + /** * @brief Gets the distance unit. * @details This function gets the maps distance unit. @@ -498,8 +497,10 @@ int maps_preference_get(const maps_preference_h preference, const char *key, cha */ int maps_preference_foreach_property(const maps_preference_h preference, maps_preference_properties_cb callback, void *user_data); + /*----------------------------------------------------------------------------*/ + /** * @brief Sets the maps distance unit. * @details This function sets the maps distance unit. diff --git a/include/maps_route.h b/include/maps_route.h index afa96e6..411d011 100644 --- a/include/maps_route.h +++ b/include/maps_route.h @@ -14,29 +14,34 @@ * limitations under the License. */ + #ifndef __MAPS_ROUTE_H__ #define __MAPS_ROUTE_H__ + #include #include #include #include #include + /** * @ingroup CAPI_MAPS_ROUTE_MODULE * @defgroup CAPI_MAPS_ROUTE_DATA_MODULE Route - * @addtogroup CAPI_MAPS_ROUTE_DATA_MODULE - * @{ * @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. * @details The handle of Route instance. @@ -48,8 +53,10 @@ extern "C" { */ 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. @@ -92,7 +99,7 @@ typedef bool(*maps_route_segment_cb) (int index, int total, maps_route_segment_h * @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 + * @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 @@ -100,19 +107,21 @@ typedef bool(*maps_route_segment_cb) (int index, int total, maps_route_segment_h * @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 + * @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); + /*----------------------------------------------------------------------------*/ + /** - * @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 + * @param[in] route The route handle * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -124,12 +133,12 @@ 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 + * @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 @@ -140,15 +149,17 @@ int maps_route_destroy(maps_route_h route); */ 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 + * @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 @@ -159,12 +170,12 @@ int maps_route_get_route_id(const maps_route_h route, char **route_id); /** - * @brief Gets the Route origin. - * @details This function 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 + * @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 @@ -177,12 +188,12 @@ int maps_route_get_origin(const maps_route_h route, maps_coordinates_h *origin); /** - * @brief Gets the Route destination. - * @details This function 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 + * @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 @@ -195,12 +206,12 @@ int maps_route_get_destination(const maps_route_h route, maps_coordinates_h *des /** - * @brief Gets the Route bounding box. - * @details This function 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 + * @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 @@ -212,10 +223,10 @@ int maps_route_get_bounding_box(const maps_route_h route, maps_area_h *bounding_ /** - * @brief Gets the Route transport mode. - * @details This function 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[in] route The route handle * @param[out] transport_mode The transport mode * @return @c 0 on success, * otherwise a negative error value @@ -228,11 +239,11 @@ int maps_route_get_transport_mode(const maps_route_h route, maps_route_transport /** - * @brief Gets the Route total distance. - * @details This function 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() + * @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 @@ -244,10 +255,10 @@ int maps_route_get_total_distance(const maps_route_h route, double *total_distan /** - * @brief Gets the Route total duration. - * @details This function 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[in] route The route handle * @param[out] total_duration The duration * @return @c 0 on success, * otherwise a negative error value @@ -260,10 +271,10 @@ int maps_route_get_total_duration(const maps_route_h route, long *total_duration /** - * @brief Gets the Route distance units. - * @details This function 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[in] route The route handle * @param[out] distance_unit The distance units * @return @c 0 on success, * otherwise a negative error value @@ -277,10 +288,10 @@ int maps_route_get_distance_unit(const maps_route_h route, maps_distance_unit_e /** * @brief Retrieves all properties. - * @details This function retrieves all Route 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] 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, @@ -297,10 +308,10 @@ int maps_route_foreach_property(const maps_route_h route, maps_route_properties_ /** * @brief Retrieves all coordinates of the path. - * @details This function retrieves all coordinates of the Route 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] 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, @@ -316,11 +327,11 @@ int maps_route_foreach_path(const maps_route_h route, maps_route_path_cb callbac /** - * @brief Retrieves all segments of the Route. - * @details This function 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] 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, @@ -329,7 +340,7 @@ int maps_route_foreach_path(const maps_route_h route, maps_route_path_cb callbac * @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 retrieved each segment + * @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); diff --git a/include/maps_route_maneuver.h b/include/maps_route_maneuver.h index 7dac1f7..5dd6085 100644 --- a/include/maps_route_maneuver.h +++ b/include/maps_route_maneuver.h @@ -14,31 +14,36 @@ * 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 - * @addtogroup CAPI_MAPS_ROUTE_MANEUVER_MODULE - * @{ * @file maps_route_maneuver.h * @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. */ + #ifdef __cplusplus extern "C" { #endif + /** * @brief The Route Maneuver handle. * @details The handle of Route Maneuver instance. * @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(). + * @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() */ @@ -46,7 +51,7 @@ typedef void *maps_route_maneuver_h; /** - * @brief Enumeration for the direction type. + * @brief Enumeration for direction type. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif */ typedef enum { @@ -84,11 +89,13 @@ typedef enum { 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 @c 0 on success, @@ -102,8 +109,8 @@ 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 @@ -118,11 +125,13 @@ int maps_route_maneuver_destroy(maps_route_maneuver_h maneuver); */ 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 @@ -137,8 +146,8 @@ int maps_route_maneuver_get_direction_id(const maps_route_maneuver_h maneuver, m /** - * @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 @@ -151,9 +160,10 @@ int maps_route_maneuver_get_direction_id(const maps_route_maneuver_h maneuver, m */ 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 @@ -169,8 +179,8 @@ int maps_route_maneuver_get_position(const maps_route_maneuver_h maneuver, maps_ /** - * @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 @@ -186,8 +196,8 @@ int maps_route_maneuver_get_road_name(const maps_route_maneuver_h maneuver, char /** * - * @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 @@ -202,8 +212,8 @@ int maps_route_maneuver_get_instruction_text(const maps_route_maneuver_h maneuve /** - * @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 @@ -218,8 +228,8 @@ int maps_route_maneuver_get_locale(const maps_route_maneuver_h maneuver, char ** /** - * @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 @@ -233,8 +243,8 @@ int maps_route_maneuver_get_time_to_next_instruction(const maps_route_maneuver_h /** - * @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 diff --git a/include/maps_route_segment.h b/include/maps_route_segment.h index d49b4f9..592e2b0 100644 --- a/include/maps_route_segment.h +++ b/include/maps_route_segment.h @@ -14,24 +14,29 @@ * 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 - * @addtogroup CAPI_MAPS_ROUTE_SEGMENT_MODULE - * @{ * @file maps_route_segment.h * @brief This file contains the functions related to Route Segment information. - * @brief This provides APIs related to Place Segment information, used in Route Search. + * @addtogroup CAPI_MAPS_ROUTE_SEGMENT_MODULE + * @{ + * @brief This provides APIs related to Place Segment information, used in Route + * Search. */ + #ifdef __cplusplus extern "C" { #endif @@ -41,8 +46,8 @@ extern "C" { * @brief The Route Segment handle. * @details The handle of Route Segment instance. * @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(). + * @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() */ @@ -54,8 +59,7 @@ typedef void *maps_route_segment_h; * @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(). + * 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 @@ -73,11 +77,11 @@ typedef bool(*maps_route_segment_path_cb) (int index, int total, maps_coordinate * @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(). + * @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] 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 @@ -87,13 +91,15 @@ typedef bool(*maps_route_segment_path_cb) (int index, int total, maps_coordinate */ 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 + * @param[in] segment The segment handle to destroy * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful @@ -105,14 +111,14 @@ 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 + * @param[in] origin The original segment handle + * @param[out] cloned A cloned segment handle * @return @c 0 on success, - * otherwise a negative error value + * 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 @@ -121,15 +127,17 @@ int maps_route_segment_destroy(maps_route_segment_h segment); */ int maps_route_segment_clone(const maps_route_segment_h origin, maps_route_segment_h *cloned); + /*----------------------------------------------------------------------------*/ + /** - * @brief Gets the Route Segment origin. - * @details This function 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 + * @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 @@ -141,12 +149,12 @@ int maps_route_segment_get_origin(const maps_route_segment_h segment, maps_coord /** - * @brief Gets the Route Segment destination. - * @details This function 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 + * @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 @@ -158,12 +166,12 @@ int maps_route_segment_get_destination(const maps_route_segment_h segment, maps_ /** - * @brief Gets the Route Segment bounding box. - * @details This function 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 + * @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 @@ -175,11 +183,11 @@ int maps_route_segment_get_bounding_box(const maps_route_segment_h segment, maps /** - * @brief Gets the Route Segment distance. - * @details This function 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 + * @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 @@ -190,11 +198,11 @@ int maps_route_segment_get_distance(const maps_route_segment_h segment, double * /** - * @brief Gets the Route Segment duration. - * @details This function 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 duration of Segment + * @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 @@ -206,10 +214,10 @@ int maps_route_segment_get_duration(const maps_route_segment_h segment, long *du /** * @brief Retrieves all coordinates of the path. - * @details This function retrieves all coordinates of the Route Segment 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] 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, @@ -226,10 +234,10 @@ int maps_route_segment_foreach_path(const maps_route_segment_h segment, maps_rou /** * @brief Retrieves all Maneuvers of the path. - * @details This function retrieves all Maneuvers of the Route Segment 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] 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, diff --git a/include/maps_service.h b/include/maps_service.h index d82f563..9e204aa 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,10 +38,12 @@ * */ + #ifdef __cplusplus extern "C" { #endif + /*----------------------------------------------------------------------------*/ /* * Maps Service and Preference @@ -53,6 +58,7 @@ extern "C" { * @brief This provides APIs related Search and Preference. */ + /** * @brief Enumeration for maps requests available in the Maps Service. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif @@ -137,6 +143,7 @@ typedef bool(*maps_service_provider_info_cb) (char *maps_provider, void *user_da */ int maps_service_foreach_provider(maps_service_provider_info_cb callback, void *user_data); + /** * @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. @@ -150,13 +157,14 @@ int maps_service_foreach_provider(maps_service_provider_info_cb callback, void * */ 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. * @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 @@ -164,23 +172,24 @@ typedef void(*maps_service_request_user_consent_cb) (bool consented, const char * @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 + * @return @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. + * @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); + /** * @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 + * @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 @@ -203,7 +212,7 @@ int maps_service_request_user_consent(const char *maps_provider, maps_service_re * @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 the available Maps Providers. + * @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() @@ -250,7 +259,6 @@ int maps_service_destroy(maps_service_h maps); * 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 @@ -330,7 +338,7 @@ int maps_service_get_preference(maps_service_h maps, maps_preference_h *preferen /** * @brief Checks if the Maps Service supports a request. - * @details This function checks if the Maps Service supports the specified 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 @@ -394,15 +402,15 @@ int maps_service_provider_is_data_supported(const maps_service_h maps, maps_serv * @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() @@ -421,6 +429,7 @@ int maps_service_cancel_request(const maps_service_h maps, int request_id); * @} */ + /*----------------------------------------------------------------------------*/ /* * Geocoder Service @@ -428,27 +437,26 @@ int maps_service_cancel_request(const maps_service_h maps, int request_id); /** - * * @ingroup CAPI_MAPS_SERVICE_MODULE * @defgroup CAPI_MAPS_GEOCODER_MODULE Geocoder - * @addtogroup CAPI_MAPS_GEOCODER_MODULE - * @{ * @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. + * 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 + * @{ * @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 + * 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; @@ -469,7 +477,7 @@ int maps_service_cancel_request(const maps_service_h maps, int request_id); * #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 starts from 0 + * @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() @@ -496,11 +504,10 @@ typedef bool(*maps_service_geocode_cb) (maps_error_e result, int request_id, int * #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 starts from 0 + * @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() + * @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() @@ -687,10 +694,10 @@ int maps_service_reverse_geocode(const maps_service_h maps, double latitude, dou /** - * @brief Called when responds to a request of multi reverse geocoding. + * @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 the address is not provided, valid address handle is retrieved. + * 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 @@ -757,6 +764,7 @@ int maps_service_multi_reverse_geocode(const maps_service_h maps, maps_coordinat * @} */ + /*----------------------------------------------------------------------------*/ /* * Place Service @@ -766,21 +774,20 @@ int maps_service_multi_reverse_geocode(const maps_service_h maps, maps_coordinat /** * @ingroup CAPI_MAPS_SERVICE_MODULE * @defgroup CAPI_MAPS_PLACE_MODULE Places - * @addtogroup CAPI_MAPS_PLACE_MODULE - * @{ - * @section CAPI_MAPS_SERVICE_MODULE_FEATURE Related Features * @if WEARABLE - * 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 + * @{ * @brief This provides APIs for Place Service. * @details The Maps Place API allows to find places that are relevant to user discovery context. * @@ -800,16 +807,14 @@ int maps_service_multi_reverse_geocode(const maps_service_h maps, maps_coordinat * #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 starts from 0 + * @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 + * @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. + * @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() @@ -921,11 +926,11 @@ int maps_service_search_place(const maps_service_h maps, const maps_coordinates_ * @privilege %http://tizen.org/privilege/mapservice \n * %http://tizen.org/privilege/internet \n * %http://tizen.org/privilege/network.get - * @remarks @a boundary supports only circle type bounds for search.\n + * @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 + * 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. @@ -974,8 +979,8 @@ int maps_service_search_place_by_area(const maps_service_h maps, const maps_area * %http://tizen.org/privilege/network.get * @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 + * 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 @@ -1101,10 +1106,12 @@ int maps_service_search_place_list(const maps_service_h maps, const maps_area_h */ 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); + /** * @} */ + /*----------------------------------------------------------------------------*/ /* * Route Service @@ -1114,21 +1121,20 @@ int maps_service_get_place_details(const maps_service_h maps, const char *uri, m /** * @ingroup CAPI_MAPS_SERVICE_MODULE * @defgroup CAPI_MAPS_ROUTE_MODULE Routes - * @addtogroup CAPI_MAPS_ROUTE_MODULE - * @{ * @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. + * 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 + * @{ * @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 @@ -1149,11 +1155,10 @@ int maps_service_get_place_details(const maps_service_h maps, const char *uri, m * #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 starts from 0 + * @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() + * @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. diff --git a/include/maps_types.h b/include/maps_types.h index 247c6a9..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 - * * @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(). + * @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() */ @@ -54,20 +52,19 @@ typedef void *maps_service_h; /** * @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 diff --git a/include/maps_view.h b/include/maps_view.h index af4aa3b..6330637 100644 --- a/include/maps_view.h +++ b/include/maps_view.h @@ -14,42 +14,44 @@ * 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 - * @addtogroup CAPI_MAPS_VIEW_MODULE - * @{ - * @file maps_view.h * @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. + * 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. + * @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), + * - 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 + * - 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. */ @@ -68,7 +70,7 @@ typedef enum _maps_view_type_e { 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_HYBRID, /**< Indicates the hybrid theme which is the satellite and normal street theme */ } maps_view_type_e; @@ -80,7 +82,7 @@ typedef enum _maps_view_type_e { * @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 + * @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 @@ -110,19 +112,19 @@ 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 + * @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_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 @@ -154,8 +156,7 @@ 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. + * @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 @@ -186,7 +187,7 @@ int maps_view_destroy(maps_view_h view); * @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 + * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied @@ -233,7 +234,7 @@ int maps_view_get_center(const maps_view_h view, maps_coordinates_h *coordinates * @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() + * 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 @@ -377,8 +378,8 @@ 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. + * 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 @@ -426,8 +427,7 @@ int maps_view_get_orientation(const maps_view_h view, double *rotation_angle); /** * @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. + * @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 @@ -435,8 +435,7 @@ int maps_view_get_orientation(const maps_view_h view, double *rotation_angle); * @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, + * @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 @@ -488,8 +487,7 @@ int maps_view_geolocation_to_screen(maps_view_h view, const maps_coordinates_h c /** * @brief Sets View type. - * @details This function switches the View to a specified type, one of - * listed in #maps_view_type_e enumeration. + * @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 @@ -688,8 +686,8 @@ int maps_view_get_public_transit_enabled(const maps_view_h view, bool *enable); * @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 + * @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. @@ -753,7 +751,7 @@ int maps_view_get_language(const maps_view_h view, char **language); * @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 + * @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() @@ -859,8 +857,8 @@ int maps_view_get_screen_location(const maps_view_h view, int *x, int *y, int *w /** * @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 + * @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 @@ -950,10 +948,9 @@ int maps_view_get_visibility(const maps_view_h view, bool *visible); /** * @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. + * @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(). + * @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 @@ -997,7 +994,7 @@ int maps_view_unset_event_cb(maps_view_h view, maps_view_event_type_e type); * @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 listed in #maps_view_gesture_e + * @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 @@ -1026,7 +1023,7 @@ int maps_view_set_gesture_enabled(maps_view_h view, maps_view_gesture_e gesture, * @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() @@ -1053,9 +1050,8 @@ int maps_view_get_gesture_enabled(const maps_view_h view, maps_view_gesture_e ge * @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() @@ -1147,6 +1143,7 @@ int maps_view_foreach_object(const maps_view_h view, maps_view_object_cb callbac * @} */ + #ifdef __cplusplus } #endif diff --git a/include/maps_view_event_data.h b/include/maps_view_event_data.h index 4b1ed51..6f62194 100644 --- a/include/maps_view_event_data.h +++ b/include/maps_view_event_data.h @@ -22,17 +22,17 @@ * * @ingroup CAPI_MAPS_VIEW_MODULE * @defgroup CAPI_MAPS_VIEW_EVENT_DATA_MODULE View Event Data - * @addtogroup CAPI_MAPS_VIEW_EVENT_DATA_MODULE - * @{ * @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: @@ -64,7 +64,6 @@ * * Note: the event of type #MAPS_VIEW_EVENT_READY has no additional data besides the * type. - * */ @@ -80,8 +79,8 @@ extern "C" { * @brief The View Event data handle. * @details The handle of View Event Data instance. * @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(). + * @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() */ @@ -92,9 +91,8 @@ typedef void *maps_view_event_data_h; * @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 to 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 { @@ -146,7 +144,7 @@ typedef enum _maps_view_event_type_e { * @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() + * @pre @a event may be obtained in maps_view_on_event_cb(). * @see #maps_view_event_data_h * @see maps_view_event_data_clone() */ @@ -166,7 +164,7 @@ int maps_view_event_data_destroy(maps_view_event_data_h event); * @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() + * @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() @@ -180,12 +178,12 @@ int maps_view_event_data_clone(const maps_view_event_data_h origin, maps_view_ev * @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 @c 0, + * @return @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() + * @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() @@ -201,12 +199,12 @@ int maps_view_event_data_get_type(const maps_view_event_data_h event, maps_view_ * @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 @c 0, + * @return @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() + * @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() @@ -222,12 +220,12 @@ int maps_view_event_data_get_gesture_type(const maps_view_event_data_h event, ma * @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 @c 0, + * @return @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() + * @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() @@ -244,12 +242,12 @@ int maps_view_event_data_get_action_type(const maps_view_event_data_h event, map * @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, + * @return @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() + * @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 @@ -267,12 +265,12 @@ int maps_view_event_data_get_center(const maps_view_event_data_h event, maps_coo * @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, + * @return @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() + * @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() @@ -289,12 +287,12 @@ int maps_view_event_data_get_delta(const maps_view_event_data_h event, int *delt * @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, + * @return @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() + * @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() @@ -311,12 +309,12 @@ int maps_view_event_data_get_position(const maps_view_event_data_h event, int *x * @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, + * @return @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() + * @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 @@ -333,12 +331,12 @@ int maps_view_event_data_get_coordinates(const maps_view_event_data_h event, map * @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 @c 0, + * @return @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() + * @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() @@ -354,12 +352,12 @@ int maps_view_event_data_get_fingers(const maps_view_event_data_h event, int *fi * @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 @c 0, + * @return @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() + * @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() @@ -375,12 +373,12 @@ int maps_view_event_data_get_zoom_factor(const maps_view_event_data_h event, dou * @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 @c 0, + * @return @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() + * @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() @@ -397,12 +395,12 @@ int maps_view_event_data_get_rotation_angle(const maps_view_event_data_h event, * @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 @c 0, - * otherwise a negative error 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 event may be obtained in maps_view_on_event_cb() + * @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() diff --git a/include/maps_view_object.h b/include/maps_view_object.h index 4edafcf..31b9738 100644 --- a/include/maps_view_object.h +++ b/include/maps_view_object.h @@ -18,25 +18,27 @@ #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 - * @addtogroup CAPI_MAPS_VIEW_OBJECT_MODULE - * @{ * @file maps_view_object.h * @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 @@ -92,7 +94,7 @@ typedef enum _maps_view_overlay_type_e { /** - * @brief Called when requesting the list of points of 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 @@ -111,7 +113,7 @@ typedef bool(*maps_view_object_polyline_point_cb) (int index, int total, maps_co /** - * @brief Called when requesting the list of points of 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 @@ -121,7 +123,7 @@ typedef bool(*maps_view_object_polyline_point_cb) (int index, int total, maps_co * @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 + * @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 @@ -142,8 +144,8 @@ typedef bool(*maps_view_object_polygon_point_cb) (int index, int total, maps_coo * @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. + * 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 @@ -169,7 +171,7 @@ int maps_view_object_create_marker(maps_coordinates_h coordinates, const char *i /** * @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. + * @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. @@ -239,7 +241,7 @@ int maps_view_object_create_polygon(maps_coordinates_list_h coordinates, unsigne * @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 + * 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 @@ -263,7 +265,7 @@ int maps_view_object_create_overlay(maps_coordinates_h coordinates, Evas_Object * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif * @param[in] object The object handle to destroy * @return @c 0 on success, - * otherwise a negative error value + * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported @@ -286,8 +288,7 @@ int maps_view_object_destroy(maps_view_object_h object); * @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(). + * @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() @@ -302,13 +303,12 @@ int maps_view_object_get_type(maps_view_object_h object, maps_view_object_type_e * @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 @c 0, + * @return @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(). + * @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() */ @@ -321,13 +321,12 @@ int maps_view_object_set_visible(maps_view_object_h object, bool 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 @c 0, + * @return @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(). + * @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() */ @@ -339,6 +338,7 @@ int maps_view_object_get_visible(const maps_view_object_h object, bool *visible) * Polyline */ + /** * @brief Sets points to the polyline. * @details This function sets point list to the polyline. @@ -346,7 +346,7 @@ int maps_view_object_get_visible(const maps_view_object_h object, bool *visible) * @param[in] polyline The polyline object handle * @param[in] points The points to set * @return @c 0 on success, - * otherwise a negative error value + * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported @@ -371,7 +371,7 @@ int maps_view_object_polyline_set_polyline(maps_view_object_h polyline, maps_coo * @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 + * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported @@ -394,8 +394,8 @@ int maps_view_object_polyline_foreach_point(maps_view_object_h polyline, maps_co * @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, - * otherwise a negative error 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 @@ -412,15 +412,11 @@ int maps_view_object_polyline_set_color(maps_view_object_h polyline, unsigned ch * @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 @c 0, + * @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 @@ -440,7 +436,7 @@ int maps_view_object_polyline_get_color(const maps_view_object_h polyline, unsig * @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 @c 0, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -459,7 +455,7 @@ int maps_view_object_polyline_set_width(maps_view_object_h polyline, int width); * @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 @c 0, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -510,7 +506,7 @@ int maps_view_object_polygon_set_polygon(maps_view_object_h polygon, maps_coordi * @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 + * 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 @@ -535,8 +531,8 @@ int maps_view_object_polygon_foreach_point(maps_view_object_h polygon, maps_coor * @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, - * otherwise a negative error 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 @@ -556,8 +552,8 @@ int maps_view_object_polygon_set_fill_color(maps_view_object_h polygon, unsigned * @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, - * otherwise a negative error 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 @@ -581,7 +577,7 @@ int maps_view_object_polygon_get_fill_color(const maps_view_object_h polygon, un * @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 @c 0, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -600,10 +596,13 @@ int maps_view_object_marker_set_coordinates(maps_view_object_h marker, maps_coor * @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 marker pixels in width on the screen - * @param[in] height The marker pixels in height on the screen - * @return @c 0, + * @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 @@ -623,7 +622,7 @@ int maps_view_object_marker_resize(maps_view_object_h marker, int width, int hei * 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, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -643,7 +642,7 @@ int maps_view_object_marker_set_image_file(maps_view_object_h marker, const char * @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, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory @@ -664,7 +663,7 @@ int maps_view_object_marker_get_image_file(const maps_view_object_h marker, char * @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, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory @@ -686,7 +685,7 @@ int maps_view_object_marker_get_coordinates(const maps_view_object_h marker, map * @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, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -705,7 +704,7 @@ int maps_view_object_marker_get_size(const maps_view_object_h marker, int *width * @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 @c 0, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -724,7 +723,7 @@ int maps_view_object_marker_get_type(const maps_view_object_h marker, maps_view_ * @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, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -742,7 +741,7 @@ int maps_view_object_marker_set_z_order(maps_view_object_h marker, int 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 @c 0, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -768,7 +767,7 @@ int maps_view_object_marker_get_z_order(const maps_view_object_h marker, int *z_ * @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, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -785,7 +784,7 @@ int maps_view_object_overlay_get_object(maps_view_object_h overlay, Evas_Object * @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 @c 0, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -807,7 +806,7 @@ int maps_view_object_overlay_set_coordinates(maps_view_object_h overlay, maps_co * @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, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory @@ -829,7 +828,7 @@ int maps_view_object_overlay_get_coordinates(const maps_view_object_h overlay, m * @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 @c 0, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -849,7 +848,7 @@ int maps_view_object_overlay_set_min_zoom_level(maps_view_object_h overlay, int * @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 @c 0, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -869,7 +868,7 @@ int maps_view_object_overlay_get_min_zoom_level(const maps_view_object_h 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 @c 0, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter @@ -889,7 +888,7 @@ int maps_view_object_overlay_set_max_zoom_level(maps_view_object_h overlay, int * @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 @c 0, + * @return @c 0 on success, * otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter diff --git a/include/maps_view_object_plugin.h b/include/maps_view_object_plugin.h index 770217e..244ead2 100644 --- a/include/maps_view_object_plugin.h +++ b/include/maps_view_object_plugin.h @@ -57,8 +57,6 @@ typedef enum _maps_view_object_operation_e { * @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 @@ -66,9 +64,7 @@ typedef enum _maps_view_object_operation_e { * @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() diff --git a/include/maps_view_snapshot.h b/include/maps_view_snapshot.h index 806ae16..60a2335 100644 --- a/include/maps_view_snapshot.h +++ b/include/maps_view_snapshot.h @@ -14,21 +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 - * @addtogroup CAPI_MAPS_VIEW_SNAPSHOT_MODULE - * @{ * @file maps_view_snapshot.h * @brief This file contains the functions of Map Snapshot API. - * @brief This provides APIs related to taking snapshots. - * + * @addtogroup CAPI_MAPS_VIEW_SNAPSHOT_MODULE + * @{ + * @brief This provides APIs related to take snapshots. */ @@ -48,7 +49,7 @@ typedef enum _maps_view_snapshot_format_type_e { /** - * @brief Captures a snapshot of the Map View. \n + * @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 @@ -64,7 +65,7 @@ typedef enum _maps_view_snapshot_format_type_e { * @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 + * 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