From fa0dd447456c5204510bf058b9bc02d98b468863 Mon Sep 17 00:00:00 2001 From: zengyawen Date: Mon, 7 Mar 2022 14:22:25 +0800 Subject: [PATCH] update docs Signed-off-by: zengyawen --- .../reference/apis/js-apis-battery-info.md | 4 +-- .../reference/apis/js-apis-brightness.md | 26 +++++++++++-------- .../reference/apis/js-apis-power.md | 10 ++++--- .../reference/apis/js-apis-runninglock.md | 12 ++++----- .../reference/apis/js-apis-thermal.md | 4 +-- 5 files changed, 31 insertions(+), 25 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-battery-info.md b/zh-cn/application-dev/reference/apis/js-apis-battery-info.md index 1727267bc2..d627fed783 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-battery-info.md +++ b/zh-cn/application-dev/reference/apis/js-apis-battery-info.md @@ -2,8 +2,8 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -> -> 该模块主要提供电池状态和充放电状态的查询接口。 + +该模块主要提供电池状态和充放电状态的查询接口。 ## 导入模块 diff --git a/zh-cn/application-dev/reference/apis/js-apis-brightness.md b/zh-cn/application-dev/reference/apis/js-apis-brightness.md index d08f6276f3..07ed408bb1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-brightness.md +++ b/zh-cn/application-dev/reference/apis/js-apis-brightness.md @@ -2,8 +2,8 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -> -> 该模块提供屏幕亮度的设置接口。 + +该模块提供屏幕亮度的设置接口。 ## 导入模块 @@ -22,13 +22,17 @@ setValue(value: number) 设置系统的屏幕亮度。 -- 参数: - | 参数名 | 类型 | 必填 | 说明 | - | ----- | ------ | ---- | ----------- | - | value | number | 是 | 亮度的值(0~255) | +**补充说明:**该接口为system api,仅供系统应用使用。 + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------- | +| value | number | 是 | 亮度的值(0~255) | -- 示例: - ``` - import brightness from '@ohos.brightness.d.ts'; - brightness.setValue(128); - ``` +**示例:** + +``` +import brightness from '@ohos.brightness.d.ts'; +brightness.setValue(128); +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-power.md b/zh-cn/application-dev/reference/apis/js-apis-power.md index 1130de52f2..3c223afea0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-power.md +++ b/zh-cn/application-dev/reference/apis/js-apis-power.md @@ -2,8 +2,8 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -> -> 该模块主要提供重启、关机、查询屏幕状态等接口。 + +该模块主要提供重启、关机、查询屏幕状态等接口。 ## 导入模块 @@ -23,7 +23,9 @@ shutdownDevice(reason: string): void 系统关机。 -需要权限:ohos.permission.SHUTDOWN +**需要权限:**ohos.permission.SHUTDOWN + +**补充说明:**该接口为system api,仅供系统应用使用。 **参数:** @@ -45,7 +47,7 @@ rebootDevice(reason: string): void 重启设备。 -需要权限:ohos.permission.REBOOT(重启权限)、ohos.permission.REBOOT_UPDATER(重启并进入updater模式的权限) +**需要权限:**ohos.permission.REBOOT(重启权限)、ohos.permission.REBOOT_UPDATER(重启并进入updater模式的权限) **参数:** diff --git a/zh-cn/application-dev/reference/apis/js-apis-runninglock.md b/zh-cn/application-dev/reference/apis/js-apis-runninglock.md index 8a5a26f33b..f26db121c4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-runninglock.md +++ b/zh-cn/application-dev/reference/apis/js-apis-runninglock.md @@ -2,8 +2,8 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -> -> 该模块主要提供Runninglock锁相关操作的接口,包括创建、查询、持锁、释放锁等操作。 + +该模块主要提供Runninglock锁相关操作的接口,包括创建、查询、持锁、释放锁等操作。 ## 导入模块 @@ -91,7 +91,7 @@ createRunningLock(name: string, type: RunningLockType, callback: AsyncCallback&l 创建RunningLock锁。 -需要权限:ohos.permission.RUNNING_LOCK +**需要权限:**ohos.permission.RUNNING_LOCK **参数:** @@ -124,7 +124,7 @@ createRunningLock(name: string, type: RunningLockType): Promise<RunningLock&g 创建Runninglock锁。 -需要权限:ohos.permission.RUNNING_LOCK +**需要权限:**ohos.permission.RUNNING_LOCK **参数:** @@ -161,7 +161,7 @@ runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.B lock(timeout: number): void -锁定和持有RunningLock +锁定和持有RunningLock。 **参数:** @@ -207,7 +207,7 @@ runningLock.createRunningLock("running_lock_test", runningLock.RunningLockType.B isUsed(): boolean -查询当前Runninglock是持有状态,还是释放状态。 +查询当前Runninglock是持有状态还是释放状态。 **返回值:** | 类型 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-thermal.md b/zh-cn/application-dev/reference/apis/js-apis-thermal.md index 9bd0688674..363db2384a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-thermal.md +++ b/zh-cn/application-dev/reference/apis/js-apis-thermal.md @@ -2,8 +2,8 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -> -> 该模块主要提供设备热状态的监听接口。 + +该模块主要提供设备热状态的监听接口。 ## 导入模块 -- Gitee