From: Kichan Kwon <k_c.kwon@samsung.com>
Date: Wed, 18 Sep 2019 04:31:44 +0000 (+0900)
Subject: Fix comments
X-Git-Tag: submit/tizen/20190919.020747~3
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e6866423d32305d22bbfb684396fb700f992d433;p=platform%2Fcore%2Fapi%2Fbatterymonitor.git

Fix comments

Change-Id: If102716277c6fb8d33082b41165691b764a4a5f3
Signed-off-by: Kichan Kwon <k_c.kwon@samsung.com>
---

diff --git a/include/battery_monitor.h b/include/battery_monitor.h
index 30447b9..018ff28 100644
--- a/include/battery_monitor.h
+++ b/include/battery_monitor.h
@@ -35,7 +35,7 @@ extern "C" {
 #endif
 
 /**
- * @brief        Enumeration for error codes for battery monitor.
+ * @brief        Enumeration for battery monitor error codes.
  * @since_tizen  5.5
  */
 typedef enum {
@@ -52,18 +52,18 @@ typedef enum {
 } battery_monitor_error_e;
 
 /**
- * @brief        Enumeration for feature data type.
+ * @brief        Enumeration for battery consuming features.
  * @since_tizen  5.5
  */
 typedef enum {
-	BATTERY_MONITOR_RESOURCE_ID_BLE = 0,		/**< Bluetooth Low Energy */
-	BATTERY_MONITOR_RESOURCE_ID_WIFI,		/**< Wi-Fi */
-	BATTERY_MONITOR_RESOURCE_ID_CPU,		/**< CPU */
-	BATTERY_MONITOR_RESOURCE_ID_DISPLAY,		/**< Display */
-	BATTERY_MONITOR_RESOURCE_ID_DEVICE_NETWORK,	/**< Network */
-	BATTERY_MONITOR_RESOURCE_ID_GPS_SENSOR,		/**< GPS */
-	BATTERY_MONITOR_RESOURCE_ID_HRM_SENSOR,		/**< Heart Rate Monitor */
-	BATTERY_MONITOR_RESOURCE_ID_BATTERY,		/**< Battery */
+	BATTERY_MONITOR_RESOURCE_ID_BLE = 0,         /**< Bluetooth Low Energy */
+	BATTERY_MONITOR_RESOURCE_ID_WIFI,            /**< Wi-Fi */
+	BATTERY_MONITOR_RESOURCE_ID_CPU,             /**< CPU */
+	BATTERY_MONITOR_RESOURCE_ID_DISPLAY,         /**< Display */
+	BATTERY_MONITOR_RESOURCE_ID_DEVICE_NETWORK,  /**< Network */
+	BATTERY_MONITOR_RESOURCE_ID_GPS_SENSOR,      /**< GPS */
+	BATTERY_MONITOR_RESOURCE_ID_HRM_SENSOR,      /**< Heart Rate Monitor */
+	BATTERY_MONITOR_RESOURCE_ID_BATTERY,         /**< Battery */
 } battery_monitor_resource_id_e;
 
 /**
@@ -76,8 +76,11 @@ typedef enum {
 } battery_monitor_duration_type_e;
 
 /**
- * @brief        Handle for total battery consumption structure.
+ * @brief        Handle for battery consumption, either total or summary for the selected application.
  * @since_tizen  5.5
+ *
+ * @see  battery_monitor_create()
+ * @see  battery_monitor_get_usage_by_app_id_for_all_resource_id()
  */
 typedef struct battery_monitor_total_consumption_s* battery_monitor_h;
 
@@ -87,7 +90,7 @@ typedef struct battery_monitor_total_consumption_s* battery_monitor_h;
  *
  * @remarks  @a handle should be released using battery_monitor_destroy().
  *
- * @param[in] handle  Battery usage consumption handle reference for the app-id usage
+ * @param[out] handle  Battery usage consumption handle for the application
  *
  * @return  @c 0 on success,
  *          otherwise a negative error value
@@ -102,7 +105,7 @@ int battery_monitor_create(battery_monitor_h *handle);
  * @brief  Destroys the Battery Consumption handle and releases all its resources.
  * @since_tizen  5.5
  *
- * @param[in] handle  Battery usage consumption handle for the app-id
+ * @param[in] handle  Battery usage consumption handle for the application
  *
  * @return  @c 0 on success,
  *          otherwise a negative error value
@@ -118,9 +121,9 @@ int battery_monitor_destroy(battery_monitor_h handle);
  * @privlevel  public
  * @privilege  %http://tizen.org/privilege/systemmonitor
  *
- * @param[in] handle  Battery usage consumption handle for the app-id
- * @param[in] resource_id  Identifier of resource type . BLE, WiFi, CPU etc
- * @param[out] battery_usage  Battery usage consumption for resource_id
+ * @param[in] handle  Battery usage consumption handle for the application
+ * @param[in] resource_id  Identifier of resource type. BLE, WiFi, CPU etc
+ * @param[out] battery_usage  Battery usage consumption for @a resource_id
  *
  * @return  @c 0 on success,
  *          otherwise a negative error value
@@ -132,16 +135,16 @@ int battery_monitor_destroy(battery_monitor_h handle);
 int battery_monitor_get_usage_for_resource_id(battery_monitor_h handle, battery_monitor_resource_id_e resource_id, int *battery_usage);
 
 /**
- * @brief  Gets the battery-percent for all resources used by app_id.
+ * @brief  Gets the battery_monitor_h with battery consumption by the specified application.
  * @since_tizen  5.5
  * @privlevel  public
  * @privilege  %http://tizen.org/privilege/systemmonitor
  *
  * @remarks  The @a handle should be released using battery_monitor_destroy().
  *
- * @param[in] app_id  App-id for which battery usage is required
+ * @param[in] app_id  Application ID of the application for which battery usage is required
  * @param[in] duration  Time duration for which battery usage is requested
- * @param[out] handle  Battery usage consumption for the app-id
+ * @param[out] handle  Battery usage consumption for the application
  *
  * @return  @c 0 on success,
  *          otherwise a negative error value
@@ -159,15 +162,15 @@ int battery_monitor_get_usage_for_resource_id(battery_monitor_h handle, battery_
 int battery_monitor_get_usage_by_app_id_for_all_resource_id(char *app_id, battery_monitor_duration_type_e duration, battery_monitor_h *handle);
 
 /**
- * @brief  Gets the battery-percent by an app-id for a specific resource.
+ * @brief  Gets the battery consumption for the specific resource for the given application.
  * @since_tizen  5.5
  * @privlevel  public
  * @privilege  %http://tizen.org/privilege/systemmonitor
  *
- * @param[in] app_id  App-id for which battery usage is required
- * @param[in] resource_id  Identifier of resource type . BLE, WiFi, CPU etc
+ * @param[in] app_id  Application ID of the application for which battery usage is required
+ * @param[in] resource_id  Identifier of resource type. BLE, WiFi, CPU etc
  * @param[in] duration  Time duration for which battery usage is requested
- * @param[out] battery_usage  Battery usage consumption for the app-id
+ * @param[out] battery_usage  Battery usage consumption for the application
  *
  * @return  @c 0 on success,
  *          otherwise a negative error value
@@ -183,15 +186,15 @@ int battery_monitor_get_usage_by_app_id_for_all_resource_id(char *app_id, batter
 int battery_monitor_get_usage_by_app_id_for_resource_id(char *app_id, battery_monitor_resource_id_e resource_id, battery_monitor_duration_type_e duration, int *battery_usage);
 
 /**
- * @brief  Gets the total battery usage in percent by an app-id for certain time duration.
+ * @brief  Gets the total battery usage in percent by an application for certain time duration.
  * @details  This will be sum of all battery consumed by resources used by application.
  * @since_tizen  5.5
  * @privlevel  public
  * @privilege  %http://tizen.org/privilege/systemmonitor
  *
- * @param[in] app_id  App-id for which battery usage is required
+ * @param[in] app_id  Application ID of the application for which battery usage is required
  * @param[in] duration  Time duration for which battery usage is requested
- * @param[out] battery_usage  Battery usage consumption for the app-id
+ * @param[out] battery_usage  Battery usage consumption for the application
  *
  * @return  @c 0 on success,
  *          otherwise a negative error value