From: Unsung Lee <unsung.lee@samsung.com>
Date: Tue, 24 Sep 2024 06:01:08 +0000 (+0900)
Subject: [Tizen.System.PowerUsage] Update the description of APIs
X-Git-Tag: submit/tizen/20240930.150935~1^2~4
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=9b73d80a28ff3720c613b4a2eb9c6f60f91468c8;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git

[Tizen.System.PowerUsage] Update the description of APIs

Update the description of Tizen.System.PowerUsage APIs

Signed-off-by: Unsung Lee <unsung.lee@samsung.com>
---

diff --git a/src/Tizen.System.PowerUsage/PowerUsage/PowerUsage.cs b/src/Tizen.System.PowerUsage/PowerUsage/PowerUsage.cs
index aad074029..ccfdf77bb 100644
--- a/src/Tizen.System.PowerUsage/PowerUsage/PowerUsage.cs
+++ b/src/Tizen.System.PowerUsage/PowerUsage/PowerUsage.cs
@@ -218,6 +218,18 @@ namespace Tizen.System
             return batteryUsage;
         }
 
+        /// <summary>
+        /// Gets the battery consumption in mAh (milli-Ampere hour) for specific resource from available data usage handle.
+        /// </summary>
+        /// <since_tizen> 7 </since_tizen>
+        /// <param name="dataHandle">Battery consumption data usage handle.</param>
+        /// <param name="rtype">Identifier of resource type. BLE, WiFi, CPU etc.</param>
+        /// <returns>Returns the battery usage in mAh(milli-Ampere hour) by a resource.</returns>
+        /// <feature>http://tizen.org/feature/battery</feature>
+        /// <privilege>http://tizen.org/privilege/systemmonitor</privilege>
+        /// <exception cref="ArgumentException">When an invalid parameter value is set.</exception>
+        /// <exception cref="UnauthorizedAccessException">If the privilege is not set.</exception>
+        /// <exception cref="NotSupportedException">In case power usage is not supported</exception>
         private static double GetPowerUsage(IntPtr dataHandle, PowerUsageResourceType rtype)
         {
             double batteryUsage = 0;