From fb3cbccbb3d961f1918671c7efb4bbe380f1faeb Mon Sep 17 00:00:00 2001
From: shijie <shijie20@huawei.com>
Date: Tue, 31 May 2022 10:42:41 +0800
Subject: [PATCH] add commit

Signed-off-by: shijie <shijie20@huawei.com>
---
 power/v1_0/IPowerHdiCallback.idl |  44 ++++++++++++++
 power/v1_0/IPowerInterface.idl   | 100 +++++++++++++++++++++++++++++++
 power/v1_0/PowerTypes.idl        |  45 ++++++++++++++
 3 files changed, 189 insertions(+)

diff --git a/power/v1_0/IPowerHdiCallback.idl b/power/v1_0/IPowerHdiCallback.idl
index 0e63fb67..a0b1d5aa 100755
--- a/power/v1_0/IPowerHdiCallback.idl
+++ b/power/v1_0/IPowerHdiCallback.idl
@@ -13,9 +13,53 @@
  * limitations under the License.
  */
 
+ /**
+ * @addtogroup power
+ * @{
+ *
+ * @brief Power_Manager模块接口定义
+ *
+ * Power_Manager包括系统电源状态直接的转换，休眠运行锁管理，休眠唤醒和亮灭屏
+ * 和显示相关的能耗调节包括根据环境光调节背光亮度，和根据接近光亮灭屏
+ *
+ * @since 3.1
+ * @version 1.0
+ */
+
+ /**
+ * @file IPowerHdiCallback.idl
+ *
+ * @brief Power_Manager模块的回调接口
+ *
+ * Power_Manager模块回调接口, 包括命休眠和唤醒
+ *
+ * @since 3.1
+ * @version 1.0
+ */
+
 package ohos.hdi.power.v1_0;
 
+/**
+ * @brief Power_Manager回调接口定义
+ *
+ * 提供了以下2种回调函数:
+ * 1.休眠命令回调
+ * 2.唤醒命令回调
+ *
+ */
 [callback] interface IPowerHdiCallback {
+    /**
+    * @brief 休眠命令回调接口
+    *
+    * @return HDF_SUCCESS 表示回调成功
+    *
+    */
     OnSuspend();
+    /**
+    * @brief 唤醒命令回调接口
+    *
+    * @return HDF_SUCCESS 表示回调成功
+    *
+    */
     OnWakeup();
 }
diff --git a/power/v1_0/IPowerInterface.idl b/power/v1_0/IPowerInterface.idl
index 272d5bff..4efac88d 100755
--- a/power/v1_0/IPowerInterface.idl
+++ b/power/v1_0/IPowerInterface.idl
@@ -13,16 +13,116 @@
  * limitations under the License.
  */
 
+ /**
+ * @addtogroup power
+ * @{
+ *
+ * @brief Power_Manager模块接口定义
+ *
+ * Power_Manager包括系统电源状态直接的转换，休眠运行锁管理，休眠唤醒和亮灭屏
+ * 和显示相关的能耗调节包括根据环境光调节背光亮度，和根据接近光亮灭屏
+ *
+ * @since 3.1
+ * @version 1.0
+ */
+
+ /**
+ * @file IPowerInterface.idl
+ *
+ * @brief Power_Manager模块的回调接口
+ *
+ * 主要包括Power_Manager模块管理类接口
+ *
+ * @since 3.1
+ * @version 1.0
+ */
+
 package ohos.hdi.power.v1_0;
 import ohos.hdi.power.v1_0.IPowerHdiCallback;
 import ohos.hdi.power.v1_0.PowerTypes;
 
+/**
+ * @brief Power_Manager模块管理类接口定义
+ *
+ * 主要提供以下功能:
+ * 1. 注册回调
+ * 2. 休眠
+ * 3. 唤醒
+ * 4. 强制休眠
+ * 5. 上锁
+ * 6. 解锁
+ * 7. dump
+ */
+
 interface IPowerInterface {
+    /**
+     * @brief 注册回调
+     *
+     * 通过此接口注册回调
+     *
+     * @param ipowerHdiCallback 输入参数, 注册回调类型{@link IPowerHdiCallback}
+     *
+     * @return HDF_SUCCESS 表示注册成功
+     */
     RegisterCallback([in] IPowerHdiCallback ipowerHdiCallback);
+
+    /**
+     * @brief 休眠
+     *
+     * 通过此接口休眠
+     *
+     * @return HDF_SUCCESS 表示下发命令成功
+     */
     StartSuspend();
+
+    /**
+     * @brief 唤醒
+     *
+     * 通过此接口唤醒
+     *
+     * @return HDF_SUCCESS 表示下发命令成功
+     */
     StopSuspend();
+
+    /**
+     * @brief 强制休眠
+     *
+     * 通过此接口强制休眠
+     *
+     * @return HDF_SUCCESS 表示下发命令成功
+     */
     ForceSuspend();
+
+    /**
+     * @brief 上锁
+     *
+     * 通过此接口上锁
+     *
+     * @param name 输入参数, 向节点写入
+     *
+     * @return HDF_SUCCESS 表示注册成功
+     */
     SuspendBlock([in] String name);
+
+    /**
+     * @brief 解锁
+     *
+     * 通过此接口解锁
+     *
+     * @param name 输入参数, 向节点写入
+     *
+     * @return HDF_SUCCESS 表示注册成功
+     */
     SuspendUnblock([in] String name);
+
+    /**
+     * @brief Dump
+     *
+     * 通过此接口Dump
+     *
+     * @param info 输入参数, dump信息
+     *
+     * @return HDF_SUCCESS 表示注册成功
+     */
     PowerDump([out] String info);
 }
diff --git a/power/v1_0/PowerTypes.idl b/power/v1_0/PowerTypes.idl
index a23fa1ea..6ddd3292 100755
--- a/power/v1_0/PowerTypes.idl
+++ b/power/v1_0/PowerTypes.idl
@@ -13,25 +13,70 @@
  * limitations under the License.
  */
 
+ /**
+ * @addtogroup power
+ * @{
+ *
+ * @brief Power_Manager模块接口定义
+ *
+ * Power_Manager包括系统电源状态直接的转换，休眠运行锁管理，休眠唤醒和亮灭屏
+ * 和显示相关的能耗调节包括根据环境光调节背光亮度，和根据接近光亮灭屏
+ *
+ * @since 3.1
+ * @version 1.0
+ */
+
+ /**
+ * @file PowerTypes.idl
+ *
+ * @brief Power_Manager模块接口定义中使用的自定义数据类型
+ *
+ * Power_Manager模块接口定义中使用的自定义数据类型, 包括命令参数、回调参数和系统状态
+ *
+ * @since 3.1
+ * @version 1.0
+ */
+
 package ohos.hdi.power.v1_0;
 
+/**
+ * @brief 枚举命令的参数
+ */
 enum PowerHdfCmd {
+    /** 注册的命令参数 */
     CMD_REGISTER_CALLBCK = 0,
+    /** 休眠的命令参数 */
     CMD_START_SUSPEND,
+    /** 唤醒的命令参数 */
     CMD_STOP_SUSPEND,
+    /** 强制休眠的命令参数 */
     CMD_FORCE_SUSPEND,
+    /** 上锁的命令参数 */
     CMD_SUSPEND_BLOCK,
+    /** 解锁的命令参数 */
     CMD_SUSPEND_UNBLOCK,
+    /** dump的命令参数 */
     CMD_DUMP,
 };
 
+/**
+ * @brief 枚举回调的参数
+ */
 enum PowerHdfCallbackCmd {
+    /** 休眠的回调参数 */
     CMD_ON_SUSPEND = 0,
+    /** 唤醒的回调参数 */
     CMD_ON_WAKEUP,
 };
 
+/**
+ * @brief 枚举回调的参数
+ */
 enum PowerHdfState {
+    /** AWAKE状态 */
     AWAKE = 0,
+    /** INACTIVE状态 */
     INACTIVE,
+    /** SLEEP状态 */
     SLEEP,
 };
-- 
Gitee