Updated descriptions from Tizen 2.3.2

Change-Id: I66ee689de2c5a70487d12866bd8f551f904ba41f

diff --git a/include/maps_preference.h b/include/maps_preference.h
index 88862a22954a4471ca5296ed813635e732b0ecf3..ece6b084ccf8ea0b5ab97e88ce15c157c4e012f3 100644 (file)
--- a/include/maps_preference.h
+++ b/include/maps_preference.h
@@ -54,7 +54,6 @@ extern "C" {
 *  - #MAPS_ROUTE_INSTRUCTION_BOUNDING_BOX
 *  - #MAPS_ROUTE_INSTRUCTION_RETRIEVAL
 *  - #MAPS_ROUTE_REALTIME_TRAFFIC
-*  .
 * .
 */
 

diff --git a/include/maps_service.h b/include/maps_service.h
index 0f7c2164c69c69856bab869b31bd68d7923ed845..fc0e1adb470797d1c9e56e2df667aa3f3e3f2928 100644 (file)
--- a/include/maps_service.h
+++ b/include/maps_service.h
@@ -392,16 +392,16 @@ int maps_service_provider_is_data_supported(const maps_service_h maps,
  * @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()

diff --git a/include/maps_view.h b/include/maps_view.h
index be61b736b3b7b2d08b2e17665ef942839335cf5d..c195f1af9eb061b21ecde0c58443633b15b921f9 100644 (file)
--- a/include/maps_view.h
+++ b/include/maps_view.h
@@ -51,12 +51,12 @@
  * @{
  * @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
  *  .
@@ -1072,7 +1072,7 @@ int maps_view_unset_event_cb(maps_view_h view, maps_view_event_type_e type);
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  *
  * @param[in]  view            The view handle
- * @param[in]  gesture         The user gesture, one of listed in #maps_gesture_e
+ * @param[in]  gesture         The user gesture, one of listed in #maps_view_gesture_e
  * @param[in]  enabled         The enable status
  * @return     0 on success, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful
@@ -1081,7 +1081,7 @@ int maps_view_unset_event_cb(maps_view_h view, maps_view_event_type_e type);
  *
  * @pre @a view is created using maps_view_create().
  *
- * @see #maps_gesture_e
+ * @see #maps_view_gesture_e
  * @see maps_view_get_gesture_enabled()
  * @see maps_view_create()
  */
@@ -1093,7 +1093,7 @@ int maps_view_set_gesture_enabled(maps_view_h view, maps_view_gesture_e gesture,
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  *
  * @param[in]  view            The view handle
- * @param[in]  gesture         The user gesture, one of listed in #maps_gesture_e
+ * @param[in]  gesture         The user gesture, one of listed in #maps_view_gesture_e
  * @param[out] enabled         The pointer to a boolean in which to store the enable status
  * @return     0 on success, otherwise a negative error value
  * @retval     #MAPS_ERROR_NONE Successful
@@ -1104,7 +1104,7 @@ int maps_view_set_gesture_enabled(maps_view_h view, maps_view_gesture_e gesture,
  * @pre @a enabled status set ad default or modified using
  * maps_view_set_gesture_enabled().
  *
- * @see #maps_gesture_e
+ * @see #maps_view_gesture_e
  * @see maps_view_set_gesture_enabled()
  * @see maps_view_create()
  */

diff --git a/include/maps_view_event_data.h b/include/maps_view_event_data.h
index 34c973cbd54f873880e5c89468275aa7c4c4bdc2..ffcc5cd2623a76d98d44e5796f643bfef899fee0 100644 (file)
--- a/include/maps_view_event_data.h
+++ b/include/maps_view_event_data.h
@@ -30,10 +30,10 @@
  * @{
  * @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

diff --git a/include/maps_view_object.h b/include/maps_view_object.h
index 66ceba135cc5289520d9ab33d24b8e571cb90b82..eaecdfb18495d0e6e9359c7c75a8ae5ab72296fa 100644 (file)
--- a/include/maps_view_object.h
+++ b/include/maps_view_object.h
@@ -32,10 +32,10 @@
  * @{
  * @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
  *  .
  */
 
@@ -156,8 +156,8 @@ typedef bool(*maps_view_object_polygon_point_cb) (int index, int total,
  * @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.
- * \nhttp://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.
- * \nhttp://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.
+ * \n http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.
+ * \n http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.
  *
  * @param[in]  coordinates     The geographical coordinates to add marker on
  * @param[in]  image_file_path The file name with the image for the marker
@@ -682,7 +682,7 @@ int maps_view_object_marker_resize(maps_view_object_h marker, int width, int hei
  * @details This function sets the marker image file path.
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  * @remarks http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.
- * \nhttp://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.
+ * \n http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.
  *
  * @param[in]  marker          The marker object handle
  * @param[in]  file_path       The marker image file path

diff --git a/include/maps_view_object_plugin.h b/include/maps_view_object_plugin.h
index 9b0ac82611c697396a403a574591b96f393e1ceb..2cb193e53fe990ea44fc376613f1f85a8ebfaada 100644 (file)
--- a/include/maps_view_object_plugin.h
+++ b/include/maps_view_object_plugin.h
@@ -21,19 +21,19 @@
 
 /**
  * @ingroup    CAPI_MAPS_VIEW_MODULE
- * @defgroup   CAPI_MAPS_VIEW_OBJECT_MODULE View Objects
+ * @defgroup   CAPI_MAPS_VIEW_OBJECT_MODULE View Object
  *
- * @file map_object.h
+ * @file maps_view_object.h
  * @brief This file contains the functions of View 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
  *  .
  */
 

diff --git a/include/maps_view_plugin.h b/include/maps_view_plugin.h
index 98df31e83ef77622def4e69c70d4e0f1c45295ab..5826703b7cd262d336b0e7a1a8b579a1b1898821 100644 (file)
--- a/include/maps_view_plugin.h
+++ b/include/maps_view_plugin.h
@@ -21,12 +21,12 @@
 
 /**
  * @ingroup    CAPI_MAPS_VIEW_MODULE
- * @defgroup   CAPI_MAPS_VIEW_MODULE View
+ * @defgroup   CAPI_MAPS_PLUGIN_VIEW_MODULE View
  *
- * @file map_object.h
+ * @file maps_view_plugin.h
  * @brief This file contains the functions of Map View API
  *
- * @addtogroup CAPI_MAPS_VIEW_MODULE
+ * @addtogroup CAPI_MAPS_PLUGIN_VIEW_MODULE
  * @{
  * @brief This file contains the functions related to Map View
  */