同步zh-cn/device_api/hdi/input/input_controller.h的修改

Signed-off-by: N li-yan339 <liyan339@h-partners.com>

同步zh-cn/device_api/hdi/input/input_controller.h的修改
Signed-off-by: N li-yan339 <liyan339@h-partners.com>
34d7af0e · liyan · Gitee · 1c5e7790 · 34d7af0e
隐藏空白更改
内联并排

Showing with 46 addition and 46 deletion

zh-cn/device-dev/reference/hdi-apis/_input_controller.md zh-cn/device-dev/reference/hdi-apis/_input_controller.md +46 -46

未找到文件。
--- a/zh-cn/device-dev/reference/hdi-apis/_input_controller.md
+++ b/zh-cn/device-dev/reference/hdi-apis/_input_controller.md
@@ -45,7 +45,7 @@ int32_t(* InputController::GetChipInfo) (uint32_t devIndex, char *chipInfo, uint
 **描述：**
-获取器件对应的编码信息
+获取器件对应的编码信息。
 一款产品通常会有多家模组和Driver IC，上层应用如果关注具体器件型号，则通过此接口来获取。
@@ -53,15 +53,15 @@ int32_t(* InputController::GetChipInfo) (uint32_t devIndex, char *chipInfo, uint
  | 名称 | 描述 | 
 | -------- | -------- |
-| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
+| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
-| chipInfo | 获取的对应设备索引的器件编码信息。 | 
+| chipInfo | 输出参数，获取的对应设备索引的器件编码信息。 | 
-| length | 保存器件芯片信息的内存长度。 | 
+| length | 输入参数，保存器件芯片信息的内存长度。 | 
 **返回：**
-Returns INPUT_SUCCESS 表示执行成功。
+INPUT_SUCCESS 表示执行成功。
-Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
+其他值表示执行失败，具体错误码查看**RetSatus**。
 ### GetChipName
@@ -73,21 +73,21 @@ int32_t(* InputController::GetChipName) (uint32_t devIndex, char *chipName, uint
 **描述：**
-获取devIndex对应的驱动芯片名
+获取devIndex对应的驱动芯片名。
 **参数：**
  | 名称 | 描述 | 
 | -------- | -------- |
-| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
+| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
-| chipName | 获取的对应设备索引的驱动芯片名。 | 
+| chipName | 输出参数，获取的对应设备索引的驱动芯片名。 | 
-| length | 保存驱动芯片名的内存长度。 | 
+| length | 输入参数，保存驱动芯片名的内存长度。 | 
 **返回：**
-Returns INPUT_SUCCESS 表示执行成功。
+INPUT_SUCCESS 表示执行成功。
-Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
+其他值表示执行失败，具体错误码查看**RetSatus**。
 ### GetDeviceType
@@ -99,20 +99,20 @@ int32_t(* InputController::GetDeviceType) (uint32_t devIndex, uint32_t *deviceTy
 **描述：**
-获取devIndex对应的Input设备的类型
+获取devIndex对应的Input设备的类型。
 **参数：**
  | 名称 | 描述 | 
 | -------- | -------- |
-| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
+| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
-| deviceType | 获取的对应设备索引的设备类型，具体参考**InputDevType**。 | 
+| deviceType | 输出参数，获取的对应设备索引的设备类型，具体参考**InputDevType**。 | 
 **返回：**
-Returns INPUT_SUCCESS 表示执行成功。
+INPUT_SUCCESS 表示执行成功。
-Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
+其他值表示执行失败，具体错误码查看**RetSatus**。
 ### GetPowerStatus
@@ -124,7 +124,7 @@ int32_t(* InputController::GetPowerStatus) (uint32_t devIndex, uint32_t *status)
 **描述：**
-获取电源状态
+获取电源状态。
 在系统休眠或者唤醒时，Input服务或电源管理模块获取电源状态，以便驱动IC能正常进入对应的休眠模式。
@@ -132,14 +132,14 @@ int32_t(* InputController::GetPowerStatus) (uint32_t devIndex, uint32_t *status)
  | 名称 | 描述 | 
 | -------- | -------- |
-| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
+| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
-| status | 获取的对应设备索引的电源状态，具体参考**PowerStatus**。 | 
+| status | 输出参数，获取的对应设备索引的电源状态，具体参考[PowerStatus](_input.md#powerstatus)。 | 
 **返回：**
-Returns INPUT_SUCCESS 表示执行成功。
+INPUT_SUCCESS 表示执行成功。
-Returns 其他值表示执行失败，具体错误码查看**RetSatus。**
+其他值表示执行失败，具体错误码查看**RetSatus。**
 ### GetVendorName
@@ -177,24 +177,24 @@ int32_t(* InputController::RunCapacitanceTest) (uint32_t devIndex, uint32_t test
 **描述：**
-执行容值自检测试
+执行容值自检测试。
-启动不同检测场景下的容值自检测试，并获取测试结果，容值自检项由器件厂商自定义， 一般包括RawData测试、 \* 短路检测、开路检测、干扰检测、行列差检测等测试项。
+启动不同检测场景下的容值自检测试，并获取测试结果，容值自检项由器件厂商自定义， 一般包括RawData测试、短路检测、开路检测、干扰检测、行列差检测等测试项。
 **参数：**
  | 名称 | 描述 | 
 | -------- | -------- |
-| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
+| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
-| testType | 容值测试的测试类型，具体参考**CapacitanceTest**。 | 
+| testType | 输入参数，容值测试的测试类型，具体参考**CapacitanceTest**。 | 
-| result | 容值测试的结果，成功则输出“SUCCESS”，失败则返回对应的错误提示&nbsp;。 | 
+| result | 输出参数，容值测试的结果，成功则输出“SUCC”，失败则返回对应的错误提示。 | 
-| length | 保存容值测试结果的内存长度。 | 
+| length | 输入参数，保存容值测试结果的内存长度。 | 
 **返回：**
-Returns INPUT_SUCCESS 表示执行成功。
+INPUT_SUCCESS 表示执行成功。
-Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
+其他值表示执行失败，具体错误码查看**RetSatus**。
 ### RunExtraCommand
@@ -206,20 +206,20 @@ int32_t(* InputController::RunExtraCommand) (uint32_t devIndex, InputExtraCmd *c
 **描述：**
-执行拓展指令
+执行拓展指令。
 **参数：**
  | 名称 | 描述 | 
 | -------- | -------- |
-| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
+| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
-| cmd | 拓展指令数据包，包括指令编码及参数，具体参考**InputExtraCmd**。 | 
+| cmd | 输入参数，拓展指令数据包，包括指令编码及参数，具体参考**InputExtraCmd**。 | 
 **返回：**
-Returns INPUT_SUCCESS 表示执行成功。
+INPUT_SUCCESS 表示执行成功。
-Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
+其他值表示执行失败，具体错误码查看**RetSatus**。
 ### SetGestureMode
@@ -231,22 +231,22 @@ int32_t(* InputController::SetGestureMode) (uint32_t devIndex, uint32_t gestureM
 **描述：**
-设置手势模式
+设置手势模式。
-上层应用开关手势模式，即设置手势模式的对应使能bit
+上层应用开关手势模式，即设置手势模式的对应使能bit。
 **参数：**
  | 名称 | 描述 | 
 | -------- | -------- |
-| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
+| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
-| gestureMode | 手势模式的开关状态 | 
+| gestureMode | 输入参数，手势模式的开关状态。 | 
 **返回：**
-Returns INPUT_SUCCESS 表示执行成功。
+INPUT_SUCCESS 表示执行成功。
-Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
+其他值表示执行失败，具体错误码查看**RetSatus**。
 ### SetPowerStatus
@@ -258,7 +258,7 @@ int32_t(* InputController::SetPowerStatus) (uint32_t devIndex, uint32_t status)
 **描述：**
-设置电源状态
+设置电源状态。
 在系统休眠或者唤醒时，Input服务或电源管理模块设置电源状态，以使驱动IC能正常进入对应的休眠模式。
@@ -266,11 +266,11 @@ int32_t(* InputController::SetPowerStatus) (uint32_t devIndex, uint32_t status)
  | 名称 | 描述 | 
 | -------- | -------- |
-| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
+| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 
-| status | 设置的电源状态，Input服务控制Input设备进入resume或者suspend等状态[PowerStatus](_input.md#powerstatus)。 | 
+| status | 输入参数，设置的电源状态，Input服务控制Input设备进入resume或者suspend等状态[PowerStatus](_input.md#powerstatus)。 | 
 **返回：**
-Returns INPUT_SUCCESS 表示执行成功。
+INPUT_SUCCESS 表示执行成功。
-Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
+其他值表示执行失败，具体错误码查看**RetSatus**。