From cb7f9398453b09094e8861833568982ee129c73e Mon Sep 17 00:00:00 2001 From: luoying_ace_admin Date: Tue, 29 Nov 2022 15:59:39 +0800 Subject: [PATCH] revise js doc Signed-off-by: luoying_ace_admin --- .../component/ets/alphabet_indexer.d.ts | 1 + api/@internal/component/ets/animator.d.ts | 2 +- api/@internal/component/ets/badge.d.ts | 4 ++-- api/@internal/component/ets/calendar.d.ts | 2 +- api/@internal/component/ets/checkboxgroup.d.ts | 2 +- api/@internal/component/ets/common.d.ts | 15 ++++++++------- .../component/ets/common_ts_ets_api.d.ts | 12 +----------- .../ets/custom_dialog_controller.d.ts | 2 +- api/@internal/component/ets/enums.d.ts | 6 +++--- api/@internal/component/ets/grid.d.ts | 2 +- api/@internal/component/ets/hyperlink.d.ts | 2 +- api/@internal/component/ets/inspector.d.ts | 6 ++++-- api/@internal/component/ets/lazy_for_each.d.ts | 4 ++++ api/@internal/component/ets/list_item.d.ts | 2 +- .../component/ets/list_item_group.d.ts | 2 +- api/@internal/component/ets/navigation.d.ts | 2 +- .../component/ets/plugin_component.d.ts | 2 +- api/@internal/component/ets/progress.d.ts | 5 +++-- api/@internal/component/ets/qrcode.d.ts | 2 +- api/@internal/component/ets/rating.d.ts | 2 +- api/@internal/component/ets/refresh.d.ts | 2 +- api/@internal/component/ets/scroll.d.ts | 4 ++-- api/@internal/component/ets/scroll_bar.d.ts | 2 +- api/@internal/component/ets/select.d.ts | 2 +- api/@internal/component/ets/sidebar.d.ts | 2 +- api/@internal/component/ets/stepper_item.d.ts | 2 +- api/@internal/component/ets/swiper.d.ts | 2 +- api/@internal/component/ets/text_input.d.ts | 1 + api/@internal/component/ets/toggle.d.ts | 2 +- api/@internal/ets/global.d.ts | 4 ++-- api/@ohos.curves.d.ts | 4 ++++ api/@system.mediaquery.d.ts | 2 +- api/@system.router.d.ts | 18 ++++++++++++------ api/common/full/dom.d.ts | 2 +- api/common/full/viewmodel.d.ts | 10 +++++----- 35 files changed, 73 insertions(+), 63 deletions(-) diff --git a/api/@internal/component/ets/alphabet_indexer.d.ts b/api/@internal/component/ets/alphabet_indexer.d.ts index 42a4b1694a..55264f74fe 100644 --- a/api/@internal/component/ets/alphabet_indexer.d.ts +++ b/api/@internal/component/ets/alphabet_indexer.d.ts @@ -53,6 +53,7 @@ declare class AlphabetIndexerAttribute extends CommonMethod void): AlphabetIndexerAttribute; diff --git a/api/@internal/component/ets/animator.d.ts b/api/@internal/component/ets/animator.d.ts index ff253c2eba..e83ece83d4 100644 --- a/api/@internal/component/ets/animator.d.ts +++ b/api/@internal/component/ets/animator.d.ts @@ -70,7 +70,7 @@ declare class ScrollMotion { } /** - * Defines Animtor. + * Defines Animator. * @since 7 * @systemapi */ diff --git a/api/@internal/component/ets/badge.d.ts b/api/@internal/component/ets/badge.d.ts index 6c6ef7b593..6e292e1e05 100644 --- a/api/@internal/component/ets/badge.d.ts +++ b/api/@internal/component/ets/badge.d.ts @@ -116,7 +116,7 @@ declare interface BadgeParamWithString extends BadgeParam { } /** - * Defines Badge Componrnt. + * Defines Badge Component. * @since 7 */ interface BadgeInterface { @@ -140,7 +140,7 @@ interface BadgeInterface { } /** - * Defines Badge Componrnt attribute. + * Defines Badge Component attribute. * @since 7 */ declare class BadgeAttribute extends CommonMethod {} diff --git a/api/@internal/component/ets/calendar.d.ts b/api/@internal/component/ets/calendar.d.ts index 63569d8107..5b528afd21 100644 --- a/api/@internal/component/ets/calendar.d.ts +++ b/api/@internal/component/ets/calendar.d.ts @@ -283,7 +283,7 @@ interface CurrentDayStyle { scheduleMarkerRadius?: number; /** - * Bound dary row offset. + * Boundary row offset. * @since 7 * @systemapi */ diff --git a/api/@internal/component/ets/checkboxgroup.d.ts b/api/@internal/component/ets/checkboxgroup.d.ts index 16695f09d2..32a3810ef5 100644 --- a/api/@internal/component/ets/checkboxgroup.d.ts +++ b/api/@internal/component/ets/checkboxgroup.d.ts @@ -19,7 +19,7 @@ */ declare enum SelectStatus { /** - * All checkboxs is selected. + * All checkboxes are selected. * @since 8 */ All, diff --git a/api/@internal/component/ets/common.d.ts b/api/@internal/component/ets/common.d.ts index 0f109d96c8..09355b00f3 100644 --- a/api/@internal/component/ets/common.d.ts +++ b/api/@internal/component/ets/common.d.ts @@ -1045,7 +1045,7 @@ declare interface KeyEvent { } /** - * Component State Styels. + * Component State Styles. * @since 8 */ declare interface StateStyles { @@ -1259,7 +1259,8 @@ declare class CommonMethod { /** * Sets the touchable of the current component * @since 7 - * @deprecated since 9, instead of hitTestBehavior. + * @deprecated since 9 + * @useinstead hitTestBehavior */ touchable(value: boolean): T; @@ -1554,7 +1555,7 @@ declare class CommonMethod { sepia(value: number): T; /** - * Inverts the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. + * Invert the input image. Value defines the scale of the conversion. 100% of the value is a complete reversal. * A value of 0% does not change the image. (Percentage) * @since 7 */ @@ -1828,7 +1829,7 @@ declare class CommonMethod { * path:Motion path for displacement animation, using the svg path string. * from:Start point of the motion path. The default value is 0.0. * to:End point of the motion path. The default value is 1.0. - * rotatble:Whether to follow the path for rotation. + * rotatable:Whether to follow the path for rotation. * @since 7 */ motionPath(value: MotionPathOptions): T; @@ -1902,7 +1903,7 @@ declare class CommonMethod { stateStyles(value: StateStyles): T; /** - * id for distrubte identification. + * id for distribute identification. * @since 8 */ restoreId(value: number): T; @@ -1954,7 +1955,7 @@ declare class CommonShapeMethod extends CommonMethod { /** * constructor. * @since 7 - * @syetemapi + * @systemapi */ constructor(); @@ -2167,7 +2168,7 @@ declare class CustomComponent extends CommonAttribute { declare class View { /** * Just use for generate tsbundle - * @ignore ide should ignore this arrtibute + * @ignore ide should ignore this attribute * @systemapi * @since 7 */ diff --git a/api/@internal/component/ets/common_ts_ets_api.d.ts b/api/@internal/component/ets/common_ts_ets_api.d.ts index a1c780576a..2e33d8736d 100644 --- a/api/@internal/component/ets/common_ts_ets_api.d.ts +++ b/api/@internal/component/ets/common_ts_ets_api.d.ts @@ -368,14 +368,12 @@ interface ISinglePropertyChangeSubscriber extends IPropertySubscriber { * Defines the Subscribale base class. * @since 7 * @systemapi - * @hide */ declare abstract class SubscribaleAbstract { /** * Returns the ownership attribute set by the. * @since 7 * @systemapi - * @hide */ private owningProperties_: Set; @@ -383,7 +381,6 @@ declare abstract class SubscribaleAbstract { * Constructor. * @since 7 * @systemapi - * @hide */ constructor(); @@ -391,7 +388,6 @@ declare abstract class SubscribaleAbstract { * Called when the notification property has changed. * @since 7 * @systemapi - * @hide */ protected notifyPropertyHasChanged(propName: string, newValue: any): void; @@ -399,7 +395,6 @@ declare abstract class SubscribaleAbstract { * Called when adding an already owned property. * @since 7 * @systemapi - * @hide */ public addOwningProperty(subscriber: IPropertySubscriber): void; @@ -407,7 +402,6 @@ declare abstract class SubscribaleAbstract { * Called when an already owned property is deleted. * @since 7 * @systemapi - * @hide */ public removeOwningProperty(property: IPropertySubscriber): void; @@ -415,7 +409,6 @@ declare abstract class SubscribaleAbstract { * Called when an already owned property is deleted by ID * @since 7 * @systemapi - * @hide */ public removeOwningPropertyById(subscriberId: number): void; } @@ -429,7 +422,6 @@ declare class Environment { * Constructor. * @since 7 * @systemapi - * @hide */ constructor(); @@ -466,7 +458,6 @@ declare class PersistentStorage { * Constructor parameters. * @since 7 * @systemapi - * @hide */ constructor(appStorage: AppStorage, storage: Storage); @@ -504,7 +495,6 @@ declare class PersistentStorage { * Used for ide. * @since 7 * @systemapi - * @hide */ declare const appStorage: AppStorage; @@ -527,7 +517,7 @@ declare const appStorage: AppStorage; static GetShared(): LocalStorage; /** - * Return true if prooperty with given name exists + * Return true if property with given name exists * @since 9 */ has(propName: string): boolean; diff --git a/api/@internal/component/ets/custom_dialog_controller.d.ts b/api/@internal/component/ets/custom_dialog_controller.d.ts index c0686ea814..ee5cca1718 100644 --- a/api/@internal/component/ets/custom_dialog_controller.d.ts +++ b/api/@internal/component/ets/custom_dialog_controller.d.ts @@ -50,7 +50,7 @@ declare interface CustomDialogControllerOptions { offset?: Offset; /** - * Defines if use costom style. + * Defines if use custom style. * @since 7 */ customStyle?: boolean; diff --git a/api/@internal/component/ets/enums.d.ts b/api/@internal/component/ets/enums.d.ts index 4485ed6929..0810e0a187 100644 --- a/api/@internal/component/ets/enums.d.ts +++ b/api/@internal/component/ets/enums.d.ts @@ -361,7 +361,7 @@ declare enum Curve { LinearOutSlowIn, /** - * Fast OutL inear In. + * Fast Out Linear In. * @since 7 */ FastOutLinearIn, @@ -1511,13 +1511,13 @@ declare enum HitTestMode { */ declare enum TitleHeight { /** - * Title height when only main title is avaliable. + * Title height when only main title is available. * @since 9 */ MainOnly, /** - * Title height when main title and subtitle are both avaliable. + * Title height when main title and subtitle are both available. * @since 9 */ MainWithSub, diff --git a/api/@internal/component/ets/grid.d.ts b/api/@internal/component/ets/grid.d.ts index e58a4765bc..f65b792b93 100644 --- a/api/@internal/component/ets/grid.d.ts +++ b/api/@internal/component/ets/grid.d.ts @@ -53,7 +53,7 @@ declare enum GridDirection { } /** - * Defines the grid attibute functions. + * Defines the grid attribute functions. * @since 7 */ declare class GridAttribute extends CommonMethod { diff --git a/api/@internal/component/ets/hyperlink.d.ts b/api/@internal/component/ets/hyperlink.d.ts index 40751b2d28..07b7f981f3 100644 --- a/api/@internal/component/ets/hyperlink.d.ts +++ b/api/@internal/component/ets/hyperlink.d.ts @@ -28,7 +28,7 @@ interface HyperlinkInterface { } /** - * Defines the hyperlink attibute functions + * Defines the hyperlink attribute functions * @since 7 */ declare class HyperlinkAttribute extends CommonMethod { diff --git a/api/@internal/component/ets/inspector.d.ts b/api/@internal/component/ets/inspector.d.ts index c62f3802cf..eae589afa5 100644 --- a/api/@internal/component/ets/inspector.d.ts +++ b/api/@internal/component/ets/inspector.d.ts @@ -17,7 +17,8 @@ * Get inspector node infos. * @since 7 * @systemapi - * @deprecated + * @deprecated since 9 + * @useinstead getInspectorTree */ declare function getInspectorNodes(): object; @@ -25,7 +26,8 @@ declare function getInspectorNodes(): object; * Get inspector node info by node id. * @since 7 * @systemapi - * @deprecated + * @deprecated since 9 + * @useinstead getInspectorByKey */ declare function getInspectorNodeById(id: number): object; diff --git a/api/@internal/component/ets/lazy_for_each.d.ts b/api/@internal/component/ets/lazy_for_each.d.ts index a027eab8af..7e6c2da51f 100644 --- a/api/@internal/component/ets/lazy_for_each.d.ts +++ b/api/@internal/component/ets/lazy_for_each.d.ts @@ -28,6 +28,7 @@ declare interface DataChangeListener { * Data added. * @since 7 * @deprecated since 8 + * @useinstead onDataAdd */ onDataAdded(index: number): void; @@ -41,6 +42,7 @@ declare interface DataChangeListener { * Data moved. * @since 7 * @deprecated since 8 + * @useinstead onDataMove */ onDataMoved(from: number, to: number): void; @@ -54,6 +56,7 @@ declare interface DataChangeListener { * Data deleted. * @since 7 * @deprecated since 8 + * @useinstead onDataDelete */ onDataDeleted(index: number): void; @@ -67,6 +70,7 @@ declare interface DataChangeListener { * Call when has data change. * @since 7 * @deprecated since 8 + * @useinstead onDataChange */ onDataChanged(index: number): void; diff --git a/api/@internal/component/ets/list_item.d.ts b/api/@internal/component/ets/list_item.d.ts index edfea632c9..146e5fb8f6 100644 --- a/api/@internal/component/ets/list_item.d.ts +++ b/api/@internal/component/ets/list_item.d.ts @@ -50,7 +50,7 @@ declare enum EditMode { None, /** - * Deleteable. + * Deletable. * @since 7 */ Deletable, diff --git a/api/@internal/component/ets/list_item_group.d.ts b/api/@internal/component/ets/list_item_group.d.ts index 6914c606ce..28a580f94d 100644 --- a/api/@internal/component/ets/list_item_group.d.ts +++ b/api/@internal/component/ets/list_item_group.d.ts @@ -50,7 +50,7 @@ interface ListItemGroupInterface { } /** - * Defines the item group attibute functions. + * Defines the item group attribute functions. * @since 9 */ declare class ListItemGroupAttribute extends CommonMethod { diff --git a/api/@internal/component/ets/navigation.d.ts b/api/@internal/component/ets/navigation.d.ts index 3cec4a169d..0d8ba46d4c 100644 --- a/api/@internal/component/ets/navigation.d.ts +++ b/api/@internal/component/ets/navigation.d.ts @@ -50,7 +50,7 @@ declare interface NavigationCustomTitle { } /** - * Nativation mode + * Navigation mode * @since 9 */ declare enum NavigationMode { diff --git a/api/@internal/component/ets/plugin_component.d.ts b/api/@internal/component/ets/plugin_component.d.ts index 08ddae847e..c306f416b4 100644 --- a/api/@internal/component/ets/plugin_component.d.ts +++ b/api/@internal/component/ets/plugin_component.d.ts @@ -48,7 +48,7 @@ interface PluginComponentInterface { } /** - * Defines the plugin component attibute functions. + * Defines the plugin component attribute functions. * @since 9 * @systemapi */ diff --git a/api/@internal/component/ets/progress.d.ts b/api/@internal/component/ets/progress.d.ts index 76faf8e8a6..1e35aa28c8 100644 --- a/api/@internal/component/ets/progress.d.ts +++ b/api/@internal/component/ets/progress.d.ts @@ -34,6 +34,7 @@ * Sets the style of Progress. * @since 7 * @deprecated since 8 + * @useinstead type */ style?: ProgressStyle @@ -92,7 +93,7 @@ declare interface ProgressStyleOptions { strokeWidth?: Length; /** - * Defines the scaleCoun property. + * Defines the scaleCount property. * @since 8 */ scaleCount?: number; @@ -153,7 +154,7 @@ interface ProgressInterface { } /** - * Defines the progress attibute functions. + * Defines the progress attribute functions. * @since 7 */ declare class ProgressAttribute extends CommonMethod { diff --git a/api/@internal/component/ets/qrcode.d.ts b/api/@internal/component/ets/qrcode.d.ts index ecae91dc55..9f28e680fc 100644 --- a/api/@internal/component/ets/qrcode.d.ts +++ b/api/@internal/component/ets/qrcode.d.ts @@ -26,7 +26,7 @@ interface QRCodeInterface { } /** - * Defines the qrcode attibute functions. + * Defines the qrcode attribute functions. * @since 7 */ declare class QRCodeAttribute extends CommonMethod { diff --git a/api/@internal/component/ets/rating.d.ts b/api/@internal/component/ets/rating.d.ts index 7dc8bac496..555806118b 100644 --- a/api/@internal/component/ets/rating.d.ts +++ b/api/@internal/component/ets/rating.d.ts @@ -26,7 +26,7 @@ interface RatingInterface { } /** - * Defines the rating attibute functions. + * Defines the rating attribute functions. * @since 7 */ declare class RatingAttribute extends CommonMethod { diff --git a/api/@internal/component/ets/refresh.d.ts b/api/@internal/component/ets/refresh.d.ts index 2475dc5518..43bcf23f7a 100644 --- a/api/@internal/component/ets/refresh.d.ts +++ b/api/@internal/component/ets/refresh.d.ts @@ -62,7 +62,7 @@ interface RefreshInterface { } /** - * Defines the refresh attibute functions. + * Defines the refresh attribute functions. * @since 8 */ declare class RefreshAttribute extends CommonMethod { diff --git a/api/@internal/component/ets/scroll.d.ts b/api/@internal/component/ets/scroll.d.ts index 47334f21c6..6adbd5d26c 100644 --- a/api/@internal/component/ets/scroll.d.ts +++ b/api/@internal/component/ets/scroll.d.ts @@ -107,7 +107,7 @@ interface ScrollInterface { } /** - * Defines the scroll attibute functions. + * Defines the scroll attribute functions. * @since 7 */ declare class ScrollAttribute extends CommonMethod { @@ -160,7 +160,7 @@ declare class ScrollAttribute extends CommonMethod { edgeEffect(edgeEffect: EdgeEffect): ScrollAttribute; /** - * Event called when sroll will scroll. + * Event called when Scroll will scroll. * @since 9 */ onScrollBegin(event: (dx: number, dy: number) => { dxRemain: number, dyRemain: number }): ScrollAttribute; diff --git a/api/@internal/component/ets/scroll_bar.d.ts b/api/@internal/component/ets/scroll_bar.d.ts index d8089e23b4..5e33db841d 100644 --- a/api/@internal/component/ets/scroll_bar.d.ts +++ b/api/@internal/component/ets/scroll_bar.d.ts @@ -68,7 +68,7 @@ interface ScrollBarInterface { } /** - * Defines the scrollbar attibute functions. + * Defines the scrollbar attribute functions. * @since 8 */ declare class ScrollBarAttribute extends CommonMethod {} diff --git a/api/@internal/component/ets/select.d.ts b/api/@internal/component/ets/select.d.ts index 0c03c35b06..09ad5034ba 100644 --- a/api/@internal/component/ets/select.d.ts +++ b/api/@internal/component/ets/select.d.ts @@ -14,7 +14,7 @@ */ /** - * The declare of slectOption. + * The declare of selectOption. * @since 8 */ declare interface SelectOption { diff --git a/api/@internal/component/ets/sidebar.d.ts b/api/@internal/component/ets/sidebar.d.ts index 55e73273e3..e7bd376653 100644 --- a/api/@internal/component/ets/sidebar.d.ts +++ b/api/@internal/component/ets/sidebar.d.ts @@ -69,7 +69,7 @@ declare interface ButtonStyle { width?: number; /** - * Set the heigth of control button + * Set the height of control button * @since 8 */ height?: number; diff --git a/api/@internal/component/ets/stepper_item.d.ts b/api/@internal/component/ets/stepper_item.d.ts index c7e0976f37..3a407266a4 100644 --- a/api/@internal/component/ets/stepper_item.d.ts +++ b/api/@internal/component/ets/stepper_item.d.ts @@ -56,7 +56,7 @@ interface StepperItemInterface { } /** - * Defines the stepper item attrbute functions. + * Defines the stepper item attribute functions. * @since 8 */ declare class StepperItemAttribute extends CommonMethod { diff --git a/api/@internal/component/ets/swiper.d.ts b/api/@internal/component/ets/swiper.d.ts index 1a3f7ad21e..f584d9047a 100644 --- a/api/@internal/component/ets/swiper.d.ts +++ b/api/@internal/component/ets/swiper.d.ts @@ -128,7 +128,7 @@ declare interface IndicatorStyle { } /** - * Defines the swiper attibute functions. + * Defines the swiper attribute functions. * @since 7 */ declare class SwiperAttribute extends CommonMethod { diff --git a/api/@internal/component/ets/text_input.d.ts b/api/@internal/component/ets/text_input.d.ts index 8b8db8f2c9..125bf7dca0 100644 --- a/api/@internal/component/ets/text_input.d.ts +++ b/api/@internal/component/ets/text_input.d.ts @@ -195,6 +195,7 @@ declare class TextInputAttribute extends CommonMethod { * Called when judging whether the text editing change finished. * @since 7 * @deprecated since 8 + * @useinstead onEditChange */ onEditChanged(callback: (isEditing: boolean) => void): TextInputAttribute; diff --git a/api/@internal/component/ets/toggle.d.ts b/api/@internal/component/ets/toggle.d.ts index b51b5b490e..287e86e8c8 100644 --- a/api/@internal/component/ets/toggle.d.ts +++ b/api/@internal/component/ets/toggle.d.ts @@ -50,7 +50,7 @@ interface ToggleInterface { } /** - * Defines the toggle attibute functions + * Defines the toggle attribute functions * @since 8 */ declare class ToggleAttribute extends CommonMethod { diff --git a/api/@internal/ets/global.d.ts b/api/@internal/ets/global.d.ts index 8040d61a98..ac16fd7e2d 100644 --- a/api/@internal/ets/global.d.ts +++ b/api/@internal/ets/global.d.ts @@ -82,7 +82,7 @@ export declare function setInterval(handler: Function | string, delay: number, . export declare function setTimeout(handler: Function | string, delay?: number, ...arguments: any[]): number; /** - * Cancels the interval set by " setInterval()". + * Cancel the interval set by " setInterval()". * @syscap SystemCapability.ArkUI.ArkUI.Full * @param intervalID Indicates the timer ID returned by "setInterval()". * @since 7 @@ -90,7 +90,7 @@ export declare function setTimeout(handler: Function | string, delay?: number, . export declare function clearInterval(intervalID?: number): void; /** - * Cancels the timer set by "setTimeout()". + * Cancel the timer set by "setTimeout()". * @syscap SystemCapability.ArkUI.ArkUI.Full * @param timeoutID Indicates the timer ID returned by "setTimeout()". * @since 7 diff --git a/api/@ohos.curves.d.ts b/api/@ohos.curves.d.ts index 4eb74e0d97..bc7b2df505 100644 --- a/api/@ohos.curves.d.ts +++ b/api/@ohos.curves.d.ts @@ -76,6 +76,7 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 * @deprecated since 9 + * @useinstead initCurve */ function init(curve?: Curve): string; @@ -97,6 +98,7 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 * @deprecated since 9 + * @useinstead stepsCurve */ function steps(count: number, end: boolean): string; @@ -120,6 +122,7 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 * @deprecated since 9 + * @useinstead cubicBezierCurve */ function cubicBezier(x1: number, y1: number, x2: number, y2: number): string; @@ -145,6 +148,7 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 * @deprecated since 9 + * @useinstead springCurve */ function spring(velocity: number, mass: number, stiffness: number, damping: number): string; diff --git a/api/@system.mediaquery.d.ts b/api/@system.mediaquery.d.ts index 445cd2d1ee..e0b58acc47 100644 --- a/api/@system.mediaquery.d.ts +++ b/api/@system.mediaquery.d.ts @@ -73,7 +73,7 @@ export interface MediaQueryList { } /** - * Defines the mediaqurey interface. + * Defines the mediaquery interface. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 3 */ diff --git a/api/@system.router.d.ts b/api/@system.router.d.ts index 0867df975c..83cc054702 100644 --- a/api/@system.router.d.ts +++ b/api/@system.router.d.ts @@ -16,7 +16,8 @@ /** * Defines the option of router. * @syscap SystemCapability.ArkUI.ArkUI.Lite - * @deprecated since 8, please use @ohos.router instead. + * @deprecated since 8 + * @useinstead @ohos.router * @since 3 */ export interface RouterOptions { @@ -45,7 +46,8 @@ export interface RouterOptions { /** * Defines the option of router back. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @deprecated since 8, please use @ohos.router instead. + * @deprecated since 8 + * @useinstead @ohos.router * @since 7 */ export interface BackRouterOptions { @@ -68,7 +70,8 @@ export interface BackRouterOptions { /** * Defines the state of router. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @deprecated since 8, please use @ohos.router instead. + * @deprecated since 8 + * @useinstead @ohos.router * @since 3 */ export interface RouterState { @@ -98,7 +101,8 @@ export interface RouterState { /** * Defines the option of EnableAlertBeforeBackPage. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @deprecated since 8, please use @ohos.router instead. + * @deprecated since 8 + * @useinstead @ohos.router * @since 6 */ export interface EnableAlertBeforeBackPageOptions { @@ -134,7 +138,8 @@ export interface EnableAlertBeforeBackPageOptions { /** * Defines the option of DisableAlertBeforeBackPage. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @deprecated since 8, please use @ohos.router instead. + * @deprecated since 8 + * @useinstead @ohos.router * @since 6 */ export interface DisableAlertBeforeBackPageOptions { @@ -167,7 +172,8 @@ type ParamsInterface = { /** * Defines the Router interface. * @syscap SystemCapability.ArkUI.ArkUI.Lite - * @deprecated since 8, please use @ohos.router instead. + * @deprecated since 8 + * @useinstead @ohos.router * @since 3 */ export default class Router { diff --git a/api/common/full/dom.d.ts b/api/common/full/dom.d.ts index 6d9ea5aeea..96a2cb5dbd 100644 --- a/api/common/full/dom.d.ts +++ b/api/common/full/dom.d.ts @@ -21,7 +21,7 @@ import { Element } from './viewmodel'; */ export declare class dom { /** - * create a dynamic dom by tag, rturn element + * create a dynamic dom by tag, return element * @param tag dom tag * @since 8 */ diff --git a/api/common/full/viewmodel.d.ts b/api/common/full/viewmodel.d.ts index 06b578c7fd..991dd2553d 100644 --- a/api/common/full/viewmodel.d.ts +++ b/api/common/full/viewmodel.d.ts @@ -20,7 +20,7 @@ import image from "../../@ohos.multimedia.image"; import { CanvasPattern } from './canvaspattern'; /** - * Defines the foucs param. + * Defines the focus param. * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 3 */ @@ -555,7 +555,7 @@ export interface observer { observe(callback: string): void; /** - * Turn off the listenerr. + * Turn off the listener. * @since 6 */ unobserve(): void; @@ -2546,7 +2546,7 @@ export interface ViewModel { $t(path: string, params?: object | Array): string; /** - * Converses between singular and plural forms based on the system language, for example, this.$tc('strings.plurals'). + * Converse between singular and plural forms based on the system language, for example, this.$tc('strings.plurals'). * NOTE * The resource content is distinguished by the following JSON keys: zero, one, two, few, many, and other. * @param path Resource file path. @@ -2698,7 +2698,7 @@ export declare class Locate { language: string; /** - * country or regin, such ass 'CN'. + * country or region, such ass 'CN'. * @since 4 */ countryOrRegion: string; @@ -2796,7 +2796,7 @@ export interface Options> { /** * Listens for page active. - * Called when the page is activing. + * Called when the page is active. * @since 5 */ onActive?(): void; -- Gitee