functions descriptions fix.

Change-Id: Ib98ba2cdc53528b9100b74657531e2c8d7abb6ca
Signed-off-by: Marcin Masternak <m.masternak@samsung.com>

diff --git a/include/maps_extra_types.h b/include/maps_extra_types.h
index b3320e3183bff383293516efab67b769b4608c22..8b8b54e6d7b27207b5648e2ae4bef4d03ae66f23 100755 (executable)
--- a/include/maps_extra_types.h
+++ b/include/maps_extra_types.h
@@ -1159,7 +1159,7 @@ int maps_item_hashtable_free_float(void *data);
  * maps_item_hashtable_free_string().
  *
  * @param[in]  table           The handle of the table
- * @param[in]  key The         string value of "key"
+ * @param[in]  key     The     string value of "key"
  * @param[in]  value           The string (char*) value
  * @return     0 on success, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful
@@ -1189,7 +1189,7 @@ int maps_item_hashtable_set_string(maps_item_hashtable_h table,
  * maps_item_hashtable_free_int().
  *
  * @param[in]  table           The handle of the table
- * @param[in]  key The         string value of "key"
+ * @param[in]  key     The     string value of "key"
  * @param[in]  value           The integer value
  * @return     0 on success, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful
@@ -1303,7 +1303,7 @@ int maps_item_hashtable_set(maps_item_hashtable_h table, const char *key,
  * @remark @a value must be released using free().
  *
  * @param[in]  table           The handle of the table
- * @param[in]  key The         string value of "key"
+ * @param[in]  key     The     string value of "key"
  * @param[out] value           The string (char*) value
  * @return     0 on success, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful
@@ -1329,7 +1329,7 @@ int maps_item_hashtable_get_string(maps_item_hashtable_h table,
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  *
  * @param[in]  table           The handle of the table
- * @param[in]  key The         string value of "key"
+ * @param[in]  key     The     string value of "key"
  * @param[out] value           The integer value
  * @return     0 on success, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful

diff --git a/include/maps_place.h b/include/maps_place.h
index d4a6ba41cb8d26c5f416cd266a90c74979fb2d1c..0a2bcebd636f9bf0a6676fde2d1af9401555cf8c 100644 (file)
--- a/include/maps_place.h
+++ b/include/maps_place.h
@@ -82,7 +82,7 @@ typedef void *maps_place_list_h;
  * @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
+ * @param[in]  user_data       The user data passed from
  * maps_place_foreach_property()
  * @return     @c true to continue with the next iteration of the loop, \n @c
  * false to break out of the loop
@@ -107,7 +107,7 @@ typedef bool(*maps_place_properties_cb) (int index, int total, char *key,
  * @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]  uesr_data       The user data passed from
+ * @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
@@ -134,7 +134,7 @@ typedef bool(*maps_place_categories_cb) (int index, int total,
  * @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]  uesr_data       The user data passed from the
+ * @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
@@ -161,7 +161,7 @@ typedef bool(*maps_place_attributes_cb) (int index, int total,
  * @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]  uesr_data       The user data passed from the
+ * @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
@@ -188,7 +188,7 @@ typedef bool(*maps_place_contacts_cb) (int index, int total,
  * @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]  uesr_data       The user data passed from the
+ * @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
@@ -215,7 +215,7 @@ typedef bool(*maps_place_editorials_cb) (int index, int total,
  * @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]  uesr_data       The user data passed from the
+ * @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
@@ -242,7 +242,7 @@ typedef bool(*maps_place_images_cb) (int index, int total,
  * @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]  uesr_data       The user data passed from the
+ * @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
@@ -263,7 +263,7 @@ typedef bool(*maps_place_reviews_cb) (int index, int total,
  *
  * @param[in]  index           The current index of review
  * @param[in]  place           The place handle
- * @param[in]  uesr_data       The user data passed from the maps_place_list_foreach()
+ * @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
  *

diff --git a/include/maps_plugin.h b/include/maps_plugin.h
index 9ebba6ae3ab2bc03465a657b07cd13e13959a98f..1eec45364e40e2998485ac75c1c82f1b4d2e67b7 100755 (executable)
--- a/include/maps_plugin.h
+++ b/include/maps_plugin.h
@@ -590,7 +590,6 @@ int maps_plugin_search_place_by_address(const char *address,
  * \n To check if Maps Provider is capable of Place Search and which Place
  * preferences are supported, see the lists of capacities and preferences above.
  *
- * @param[in]  maps            The Maps Service handle
  * @param[in]  boundary        The interested area
  * @param[in]  filter          The filter handle
  * @param[in]  preference      The place preference handle
@@ -632,7 +631,7 @@ int maps_plugin_search_place_list(const maps_area_h boundary,
  * \n To check if Maps Provider is capable of Place Search and which Place
  * preferences are supported, see the lists of capacities and preferences above.
  *
- * @param[in]  uri                     The interested place uri
+ * @param[in]  url                     The interested place url
  * @param[in]  callback        The result callback
  * @param[in]  user_data       The user data to be passed to the callback function
  * @param[out] request_id      The request id
@@ -813,7 +812,7 @@ int maps_plugin_cancel_request(int request_id);
  *
  * @see maps_plugin_render_map()
  */
-typedef void(*maps_plugin_map_view_ready_cb) (maps_view_h hView);
+typedef void(*maps_plugin_map_view_ready_cb) (maps_view_h view);
 
 /**
  * @brief      Create a maps view.
@@ -917,7 +916,7 @@ int maps_plugin_set_scalebar(maps_view_h view, bool enable);
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  *
  * @param[in]  view            The handle of maps_view
- * @param[out]enabled          The pointer to a boolean in which to store the enable status
+ * @param[out] enabled         The pointer to a boolean in which to store the enable status
  * @return     0 on success, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful
  * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
@@ -994,7 +993,7 @@ int maps_plugin_geography_to_screen(maps_view_h view, const maps_coordinates_h c
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  *
  * @param[in]  view                    The handle of maps_view
- * @param[out]min_zoom_level   The minimally available zoom level
+ * @param[out] min_zoom_level  The minimally available zoom level
  * @return     0 on success, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful
  * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
@@ -1007,7 +1006,7 @@ int maps_plugin_get_min_zoom_level(maps_view_h view, int *min_zoom_level);
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  *
  * @param[in]  view                    The handle of maps_view
- * @param[out]max_zoom_level   The maximally available zoom level
+ * @param[out] max_zoom_level  The maximally available zoom level
  * @return     0 on success, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful
  * @retval     #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
@@ -1021,7 +1020,7 @@ int maps_plugin_get_max_zoom_level(maps_view_h view, int *max_zoom_level);
  * @remarks @a coordinates must be released using maps_coordinates_destroy().
  *
  * @param[in]  view            The handle of maps_view
- * @param[out]coordinates      The pointer to #maps_coordinates_h in which to
+ * @param[out] coordinates     The pointer to #maps_coordinates_h in which to
  * store the geographical coordinates of the central position of the Map
  * @return     0 on success, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful

diff --git a/include/maps_route_segment.h b/include/maps_route_segment.h
index 63f3b26c6c7ee3cf24b07946ea1ea6584b0d6c10..b31acd2821098b00d8f16cedb375c71fd2cdf171 100644 (file)
--- a/include/maps_route_segment.h
+++ b/include/maps_route_segment.h
@@ -59,7 +59,9 @@ typedef void *maps_route_segment_h;
  * \n To use @a coordinates outside this function, clone it with
  * maps_coordinates_clone().
  *
- * @param[in]  segment         The segment of route
+ * @param[in]  index           The current index of coordinates list
+ * @param[in]  total           The total amount of coordinates
+ * @param[in]  coordinates             The current coordinates
  * @param[in]  user_data       The user data passed from
  * maps_route_segment_foreach_path()
  * @return     @c true to continue with the next iteration of the loop, \n @c
@@ -84,6 +86,8 @@ typedef bool(*maps_route_segment_path_cb) (int index, int total,
  * \n To use @a maneuver outside this function, clone it with
  * maps_route_maneuver_clone().
  *
+ * @param[in]  index           The current index of maneuvers list
+ * @param[in]  total           The total amount of maneuvers
  * @param[in]  maneuver        The maneuver of route
  * @param[in]  user_data       The user data passed from
  * maps_route_segment_foreach_maneuver()

diff --git a/include/maps_service.h b/include/maps_service.h
index 00cdaa640373738ff94c112ae2a18d6dde76cc62..658604f32f365336ef0a538b9f8719ca20340386 100755 (executable)
--- a/include/maps_service.h
+++ b/include/maps_service.h
@@ -895,7 +895,7 @@ int maps_service_multi_reverse_geocode(const maps_service_h maps,
  * start from 0
  * @param[in]  total           The total number of results
  * @param[in]  place           The resulting Place data
- * @param[in]  uesr_data       The user data passed from
+ * @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
@@ -930,7 +930,7 @@ typedef bool(*maps_service_search_place_cb) (maps_error_e error,
  * @param[in]  request_id      The request id
  * @param[in]  total           The total number of results
  * @param[in]  place_list      The resulting Place list data
- * @param[in]  uesr_data       The user data passed from maps_service_search_place_list()
+ * @param[in]  user_data       The user data passed from maps_service_search_place_list()
  *
  * @pre maps_service_search_place_list() will invoke this callback.
  *
@@ -956,7 +956,7 @@ typedef void(*maps_service_search_place_list_cb) (maps_error_e error,
  * @param[in]  error           The result of request
  * @param[in]  request_id      The request id
  * @param[in]  place           The resulting Place data
- * @param[in]  uesr_data       The user data passed from maps_service_get_place_details()
+ * @param[in]  user_data       The user data passed from maps_service_get_place_details()
  *
  * @pre maps_service_get_place_details() will invoke this callback.
  *