From e0b2d11aaadee9bd266de2b0e4698f1ce47de80c Mon Sep 17 00:00:00 2001 From: wusongqing Date: Thu, 9 Jun 2022 14:14:16 +0800 Subject: [PATCH] updated docs Signed-off-by: wusongqing --- .../reference/apis/js-apis-faultLogger.md | 15 +++++++-------- .../reference/apis/js-apis-treeset.md | 6 +++--- .../reference/apis/js-apis-window.md | 18 +++++++----------- .../reference/apis/js-apis-treeset.md | 4 ++-- 4 files changed, 19 insertions(+), 24 deletions(-) diff --git a/en/application-dev/reference/apis/js-apis-faultLogger.md b/en/application-dev/reference/apis/js-apis-faultLogger.md index 1233939892..9a6414cbb5 100644 --- a/en/application-dev/reference/apis/js-apis-faultLogger.md +++ b/en/application-dev/reference/apis/js-apis-faultLogger.md @@ -1,10 +1,10 @@ # Fault Logger -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** +> **NOTE** > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. ## Modules to Import -``` +```js import faultLogger from '@ohos.faultLogger' ``` @@ -52,11 +52,10 @@ Obtains the fault information about the current process. This API uses a callbac | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | faultType | [FaultType](#faulttype) | Yes| Fault type.| -| callback | AsyncCallbackArray<Array<[FaultLogInfo](#faultloginfo)>> | Yes| Callback used to return the fault information array.
The value is the fault information array obtained. If the value is **undefined**, an exception occurs during the information retrieval. In this case, an error string will be returned. - +| callback | AsyncCallbackArray<Array<[FaultLogInfo](#faultloginfo)>> | Yes | Callback used to return the fault information array.
The value is the fault information array obtained. If the value is **undefined**, an exception occurs during the information retrieval. In this case, an error string will be returned. | **Example** -``` +```js function queryFaultLogCallback(error, value) { if (error) { console.info('error is ' + error); @@ -68,7 +67,7 @@ function queryFaultLogCallback(error, value) { console.info("Log pid: " + value[i].pid); console.info("Log uid: " + value[i].uid); console.info("Log type: " + value[i].type); - console.info("Log ts: " + value[i].ts); + console.info("Log timestamp: " + value[i].timestamp); console.info("Log reason: " + value[i].reason); console.info("Log module: " + value[i].module); console.info("Log summary: " + value[i].summary); @@ -101,7 +100,7 @@ Obtains the fault information about the current process. This API uses a promise **Example** -``` +```js async function getLog() { let value = await faultLogger.querySelfFaultLog(faultLogger.FaultType.JS_CRASH); if (value) { @@ -112,7 +111,7 @@ async function getLog() { console.info("Log pid: " + value[i].pid); console.info("Log uid: " + value[i].uid); console.info("Log type: " + value[i].type); - console.info("Log ts: " + value[i].ts); + console.info("Log timestamp: " + value[i].timestamp); console.info("Log reason: " + value[i].reason); console.info("Log module: " + value[i].module); console.info("Log summary: " + value[i].summary); diff --git a/en/application-dev/reference/apis/js-apis-treeset.md b/en/application-dev/reference/apis/js-apis-treeset.md index 69e6c6e1fc..0a2d5e99ae 100644 --- a/en/application-dev/reference/apis/js-apis-treeset.md +++ b/en/application-dev/reference/apis/js-apis-treeset.md @@ -1,6 +1,6 @@ # Nonlinear Container TreeSet -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** +> **NOTE** > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. @@ -259,7 +259,7 @@ Removes the first entry in this container. | -------- | -------- | | T | Entry removed.| -**Return value** +**Example** ```ts let treeSet = new TreeSet(); @@ -281,7 +281,7 @@ Removes the last entry in this container. | -------- | -------- | | T | Entry removed.| -**Return value** +**Example** ```ts let treeSet = new TreeSet(); diff --git a/en/application-dev/reference/apis/js-apis-window.md b/en/application-dev/reference/apis/js-apis-window.md index be2cc3942b..881b281ffe 100644 --- a/en/application-dev/reference/apis/js-apis-window.md +++ b/en/application-dev/reference/apis/js-apis-window.md @@ -98,7 +98,7 @@ This is a system API and cannot be called by third-party applications. ## Rect7+ -Rectangular area of the window. + Describes the rectangular area of the window. **System capability**: SystemCapability.WindowManager.WindowManager.Core @@ -238,9 +238,7 @@ This API is deprecated since API version 8. You are advised to use [window.creat create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback<Window>): void -Creates a subwindow when the context is [Context](js-apis-Context.md). This API uses an asynchronous callback to return the result. - -Creates a system window when the context is [ServiceExtensionContext](js-apis-service-extension-context.md). This API uses an asynchronous callback to return the result. It is valid since API version 9. +Creates a subwindow (in API version 8) or a system window (from API version 9). This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.WindowManager.WindowManager.Core @@ -248,7 +246,7 @@ Creates a system window when the context is [ServiceExtensionContext](js-apis-se | Name | Type | Mandatory| Description | | -------- | -------------------------------------- | ---- | ------------------------------------------------------------ | -| ctx | Context | Yes | Current application context.
For the definition of **Context** of API version 8, see [Context](js-apis-Context.md).
For the definition of **Context** of API version 9, see [Context](js-apis-service-extension-context.md).| +| ctx | Context | Yes | Current application context.
For the definition of **Context** of API version 8, see [Context](js-apis-Context.md).
For the definition of **Context** of API version 9, see [ServiceExtensionContext](js-apis-service-extension-context.md). | | id | string | Yes | Window ID. | | type | [WindowType](#windowtype) | Yes | Window type. | | callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the window created. | @@ -272,9 +270,7 @@ Creates a system window when the context is [ServiceExtensionContext](js-apis-se create(ctx: Context, id: string, type: WindowType): Promise<Window> -Creates a subwindow when the context is [Context](js-apis-Context.md). This API uses a promise to return the result. - -Creates a system window when the context is [ServiceExtensionContext](js-apis-service-extension-context.md). This API uses a promise to return the result. It is valid since API version 9. +Creates a subwindow (in API version 8) or a system window (from API version 9). This API uses a promise to return the result. **System capability**: SystemCapability.WindowManager.WindowManager.Core @@ -282,7 +278,7 @@ Creates a system window when the context is [ServiceExtensionContext](js-apis-se | Name| Type | Mandatory| Description | | ------ | ------------------------- | ---- | ------------------------------------------------------------ | -| ctx | Context | Yes | Current application context.
For the definition of **Context** of API version 8, see [Context](js-apis-Context.md).
For the definition of **Context** of API version 9, see [Context](js-apis-service-extension-context.md).| +| ctx | Context | Yes | Current application context.
For the definition of **Context** of API version 8, see [Context](js-apis-Context.md).
For the definition of **Context** of API version 9, see [ServiceExtensionContext](js-apis-service-extension-context.md). | | id | string | Yes | Window ID. | | type | [WindowType](#windowtype) | Yes | Window type. | @@ -438,7 +434,7 @@ Obtains the top window of the current application. This API uses an asynchronous | Name | Type | Mandatory| Description | | -------- | -------------------------------------- | ---- | ------------------------------------------------------------ | -| ctx | Context | Yes | Current application context.
For the definition of **Context** of API version 8, see [Context](js-apis-Context.md).
For the definition of **Context** of API version 9, see [Context](js-apis-ability-context.md).| +| ctx | Context | Yes | Current application context.
For the definition of **Context** of API version 8, see [Context](js-apis-Context.md).
For the definition of **Context** of API version 9, see [AbilityContext](js-apis-ability-context.md). | | callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the top window obtained. | **Example** @@ -467,7 +463,7 @@ Obtains the top window of the current application. This API uses a promise to re | Name| Type | Mandatory| Description | | ------ | ------- | ---- | ------------------------------------------------------------ | -| ctx | Context | Yes | Current application context.
For the definition of **Context** of API version 8, see [Context](js-apis-Context.md).
For the definition of **Context** of API version 9, see [Context](js-apis-ability-context.md).| +| ctx | Context | Yes | Current application context.
For the definition of **Context** of API version 8, see [Context](js-apis-Context.md).
For the definition of **Context** of API version 9, see [AbilityContext](js-apis-ability-context.md). | **Return value** diff --git a/zh-cn/application-dev/reference/apis/js-apis-treeset.md b/zh-cn/application-dev/reference/apis/js-apis-treeset.md index 0a6b7e9958..c1260540b6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-treeset.md +++ b/zh-cn/application-dev/reference/apis/js-apis-treeset.md @@ -281,7 +281,7 @@ popFirst(): T | -------- | -------- | | T | 返回删除的数据。 | -**返回值：** +**示例：** ```ts let treeSet = new TreeSet(); @@ -305,7 +305,7 @@ popLast(): T | -------- | -------- | | T | 返回删除的数据。 | -**返回值：** +**示例：** ```ts let treeSet = new TreeSet(); -- GitLab