From: Hyotaek Shim <hyotaek.shim@samsung.com>
Date: Thu, 22 Jul 2021 05:22:34 +0000 (+0900)
Subject: Add description on device_battery_property_e
X-Git-Tag: submit/tizen/20210726.050348^0
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F08%2F261608%2F3;p=platform%2Fcore%2Fapi%2Fdevice.git

Add description on device_battery_property_e

Change-Id: I4769e5c5db34fa4aed81720db7e1262884880f12
Signed-off-by: Hyotaek Shim <hyotaek.shim@samsung.com>
---

diff --git a/include/battery.h b/include/battery.h
index f28f8ee..9f81d38 100644
--- a/include/battery.h
+++ b/include/battery.h
@@ -75,6 +75,8 @@ typedef enum {
 /**
  * @brief Enumeration for battery property information.
  * @since_tizen 3.0
+ * @remarks If fuel gauge hardware does not provide average current or average voltage,
+            CURRENT_AVERAGE/VOLTAGE_AVERAGE can be substituted by CURRENT_NOW/VOLTAGE_NOW, respectively.
  */
 typedef enum {
 	DEVICE_BATTERY_PROPERTY_CAPACITY, /**< The battery capacity (0 ~ 100 %) */