From 8bafe130f453c8fe46872c346d7e2b0c473ef942 Mon Sep 17 00:00:00 2001 From: zaki Date: Thu, 24 Nov 2022 17:04:13 +0800 Subject: [PATCH] fix api docs problems of accessibility and init Signed-off-by: zaki Change-Id: I05b09938415f51d9429fc7e0f1858ea8120099e2 --- api/@ohos.accessibility.d.ts | 22 +++++++++++----------- api/@ohos.systemParameterV9.d.ts | 6 +++--- api/@ohos.systemparameter.d.ts | 6 +++--- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/api/@ohos.accessibility.d.ts b/api/@ohos.accessibility.d.ts index 5ca5f8250e..597532bead 100644 --- a/api/@ohos.accessibility.d.ts +++ b/api/@ohos.accessibility.d.ts @@ -88,7 +88,7 @@ declare namespace accessibility { * @since 7 * @param callback Asynchronous callback interface. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @return Returns {@code true} if the accessibility is enabled; returns {@code false} otherwise. + * @returns Returns {@code true} if the accessibility is enabled; returns {@code false} otherwise. */ function isOpenAccessibility(callback: AsyncCallback): void; function isOpenAccessibility(): Promise; @@ -98,7 +98,7 @@ declare namespace accessibility { * @since 7 * @param callback Asynchronous callback interface. * @syscap SystemCapability.BarrierFree.Accessibility.Vision - * @return Returns {@code true} if the touch browser is enabled; returns {@code false} otherwise. + * @returns Returns {@code true} if the touch browser is enabled; returns {@code false} otherwise. */ function isOpenTouchGuide(callback: AsyncCallback): void; function isOpenTouchGuide(): Promise; @@ -109,7 +109,7 @@ declare namespace accessibility { * @param abilityType The type of the accessibility ability. {@code AbilityType} eg.spoken * @param stateType The state of the accessibility ability. {@code AbilityState} eg.installed * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @return Returns the list of abilityInfos. + * @returns Returns the list of abilityInfos. * @deprecated since 9 * @useinstead ohos.accessibility#getAccessibilityExtensionList */ @@ -125,7 +125,7 @@ declare namespace accessibility { * @param abilityType The type of the accessibility ability. {@code AbilityType} eg.spoken * @param stateType The state of the accessibility ability. {@code AbilityState} eg.installed * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @return Returns the list of abilityInfos. + * @returns Returns the list of abilityInfos. * @throws { BusinessError } 401 - Input parameter error. */ function getAccessibilityExtensionList(abilityType: AbilityType, stateType: AbilityState): Promise>; @@ -137,7 +137,7 @@ declare namespace accessibility { * @param event The object of the accessibility {@code EventInfo} . * @param callback Asynchronous callback interface. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @return Returns {@code true} if success ; returns {@code false} otherwise. + * @returns Returns {@code true} if success ; returns {@code false} otherwise. * @deprecated since 9 * @useinstead ohos.accessibility#sendAccessibilityEvent */ @@ -150,7 +150,7 @@ declare namespace accessibility { * @param event The object of the accessibility {@code EventInfo} . * @param callback Asynchronous callback interface. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @return Returns {@code true} if success ; returns {@code false} otherwise. + * @returns Returns {@code true} if success ; returns {@code false} otherwise. * @throws { BusinessError } 401 - Input parameter error. */ function sendAccessibilityEvent(event: EventInfo, callback: AsyncCallback): void; @@ -162,7 +162,7 @@ declare namespace accessibility { * @param type state event type. * @param callback Asynchronous callback interface. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @return Returns {@code true} if the register is success ; returns {@code false} otherwise. + * @returns Returns {@code true} if the register is success ; returns {@code false} otherwise. * @throws { BusinessError } 401 - Input parameter error. */ function on(type: 'accessibilityStateChange', callback: Callback): void; @@ -173,7 +173,7 @@ declare namespace accessibility { * @param type state event type. * @param callback Asynchronous callback interface. * @syscap SystemCapability.BarrierFree.Accessibility.Vision - * @return Returns {@code true} if the register is success ; returns {@code false} otherwise. + * @returns Returns {@code true} if the register is success ; returns {@code false} otherwise. * @throws { BusinessError } 401 - Input parameter error. */ function on(type: 'touchGuideStateChange', callback: Callback): void; @@ -184,7 +184,7 @@ declare namespace accessibility { * @param type state event type * @param callback Asynchronous callback interface. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @return Returns {@code true} if the Unregister is success ; returns {@code false} otherwise. + * @returns Returns {@code true} if the Unregister is success ; returns {@code false} otherwise. * @throws { BusinessError } 401 - Input parameter error. */ function off(type: 'accessibilityStateChange', callback?: Callback): void; @@ -194,7 +194,7 @@ declare namespace accessibility { * @since 7 * @param type state event type * @param callback Asynchronous callback interface. - * @return Returns {@code true} if the Unregister is success ; returns {@code false} otherwise. + * @returns Returns {@code true} if the Unregister is success ; returns {@code false} otherwise. * @throws { BusinessError } 401 - Input parameter error. */ function off(type: 'touchGuideStateChange', callback?: Callback): void; @@ -203,7 +203,7 @@ declare namespace accessibility { * Get the captions manager. * @syscap SystemCapability.BarrierFree.Accessibility.Hearing * @since 8 - * @return Returns the captions manager. + * @returns Returns the captions manager. */ function getCaptionsManager(): CaptionsManager; diff --git a/api/@ohos.systemParameterV9.d.ts b/api/@ohos.systemParameterV9.d.ts index aee1b8584e..9d37d7f828 100755 --- a/api/@ohos.systemParameterV9.d.ts +++ b/api/@ohos.systemParameterV9.d.ts @@ -28,7 +28,7 @@ declare namespace systemParameterV9 { * * @param key Key of the system attribute. * @param def Default value. - * @return the value of the parameter. + * @returns the value of the parameter. * @throws {BusinessError} 401 - if type of key is not string or key is not specified. * @throws {BusinessError} 14700101 - if key is not found * @throws {BusinessError} 14700103 - if permission denied @@ -76,7 +76,7 @@ declare namespace systemParameterV9 { * @throws {BusinessError} 14700101 - if key is not found * @throws {BusinessError} 14700103 - if permission denied * @throws {BusinessError} 14700104 - if system internal error - * @return Promise, which is used to obtain the result asynchronously. + * @returns Promise, which is used to obtain the result asynchronously. * @syscap SystemCapability.Startup.SystemInfo * @since 9 */ @@ -116,7 +116,7 @@ declare namespace systemParameterV9 { * * @param key Key of the system attribute. * @param value Default value. - * @return Promise, which is used to obtain the result asynchronously. + * @returns Promise, which is used to obtain the result asynchronously. * @throws {BusinessError} 401 - if type of key is not string or key is not specified. * @throws {BusinessError} 14700102 - if value is invalid * @throws {BusinessError} 14700103 - if permission denied diff --git a/api/@ohos.systemparameter.d.ts b/api/@ohos.systemparameter.d.ts index 18f92152a4..93aa70a203 100644 --- a/api/@ohos.systemparameter.d.ts +++ b/api/@ohos.systemparameter.d.ts @@ -28,7 +28,7 @@ declare namespace systemParameter { * * @param key Key of the system attribute. * @param def Default value. - * @return if the parameter is empty or doesn't exist, empty string will be returned. + * @returns if the parameter is empty or doesn't exist, empty string will be returned. * @syscap SystemCapability.Startup.SystemInfo * @since 6 */ @@ -60,7 +60,7 @@ declare namespace systemParameter { * * @param key Key of the system attribute. * @param def Default value. - * @return Promise, which is used to obtain the result asynchronously. + * @returns Promise, which is used to obtain the result asynchronously. * @syscap SystemCapability.Startup.SystemInfo * @since 6 */ @@ -92,7 +92,7 @@ declare namespace systemParameter { * * @param key Key of the system attribute. * @param value Default value. - * @return Promise, which is used to obtain the result asynchronously. + * @returns Promise, which is used to obtain the result asynchronously. * @syscap SystemCapability.Startup.SystemInfo * @since 6 */ -- Gitee