[Tizen.System.PowerUsage] Update the description of APIs
authorUnsung Lee <unsung.lee@samsung.com>
Tue, 24 Sep 2024 06:01:08 +0000 (15:01 +0900)
committerChanwoo Choi <chanwoo@kernel.org>
Mon, 30 Sep 2024 05:30:51 +0000 (14:30 +0900)
Update the description of Tizen.System.PowerUsage APIs

Signed-off-by: Unsung Lee <unsung.lee@samsung.com>
src/Tizen.System.PowerUsage/PowerUsage/PowerUsage.cs

index aad07402917283d24c17bcc68d95e16d5d1604e4..ccfdf77bb3092e0e1c5a7fda237b65bf552aa531 100644 (file)
@@ -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;