diff --git a/api/@ohos.hiAppEvent.d.ts b/api/@ohos.hiAppEvent.d.ts index b62cf6f34a704d8c3b7c20fd499b689e8306bfdf..96446e5bc575c37c152b415d46e263406039de13 100644 --- a/api/@ohos.hiAppEvent.d.ts +++ b/api/@ohos.hiAppEvent.d.ts @@ -140,7 +140,7 @@ declare namespace hiAppEvent { * @param {EventType} eventType Application event type. * @param {object} keyValues Application event key-value pair params. * @param {AsyncCallback} [callback] Callback function. - * @return {void | Promise} No callback return Promise otherwise return void. + * @returns {void | Promise} No callback return Promise otherwise return void. */ function write(eventName: string, eventType: EventType, keyValues: object): Promise; function write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback): void; @@ -152,7 +152,7 @@ declare namespace hiAppEvent { * @syscap SystemCapability.HiviewDFX.HiAppEvent * @static * @param {ConfigOption} config Application event logging configuration item object. - * @return {boolean} Configuration result. + * @returns {boolean} Configuration result. */ function configure(config: ConfigOption): boolean; @@ -181,4 +181,4 @@ declare namespace hiAppEvent { } } -export default hiAppEvent; \ No newline at end of file +export default hiAppEvent; diff --git a/api/@ohos.hiSysEvent.d.ts b/api/@ohos.hiSysEvent.d.ts index 625d69b69fbd05dfe5e5d6f02ec31ee23f2e2c2c..cbda18a429cbade90b096385343f66cbd1f18129 100644 --- a/api/@ohos.hiSysEvent.d.ts +++ b/api/@ohos.hiSysEvent.d.ts @@ -22,7 +22,6 @@ import { AsyncCallback } from './basic'; * * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @import import hiSysEvent from '@ohos.hiSysEvent' * @since 9 */ declare namespace hiSysEvent { @@ -119,7 +118,7 @@ declare namespace hiSysEvent { * @throws {BusinessError} 11200052 - Size of the event parameter of the string type is over limit. * @throws {BusinessError} 11200053 - Count of event parameters is over limit. * @throws {BusinessError} 11200054 - Count of event parameter of the array type is over limit. - * @return {void | Promise} no callback return Promise otherwise return void. + * @returns {void | Promise} no callback return Promise otherwise return void. * @since 9 */ function write(info: SysEventInfo): Promise; @@ -211,7 +210,7 @@ declare namespace hiSysEvent { * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use * @param {SysEventInfo} info system event information of receive. - * @return {void} return void. + * @returns {void} return void. * @since 9 */ onEvent: (info: SysEventInfo) => void; @@ -221,7 +220,7 @@ declare namespace hiSysEvent { * * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @return {void} return void. + * @returns {void} return void. * @since 9 */ onServiceDied: () => void; @@ -286,7 +285,7 @@ declare namespace hiSysEvent { * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use * @param {SysEventInfo[]} infos system event information of query result. - * @return {void} return void. + * @returns {void} return void. * @since 9 */ onQuery: (infos: SysEventInfo[]) => void; @@ -298,7 +297,7 @@ declare namespace hiSysEvent { * @systemapi hide for inner use * @param {number} reason 0 success, 1 fail. * @param {number} total the total number of query result. - * @return {void} return void. + * @returns {void} return void. * @since 9 */ onComplete: (reason: number, total: number) => void; @@ -315,7 +314,7 @@ declare namespace hiSysEvent { * @throws {BusinessError} 401 - Invalid argument. * @throws {BusinessError} 11200101 - Count of watchers is over limit. * @throws {BusinessError} 11200102 - Count of watch rules is over limit. - * @return {void} return void. + * @returns {void} return void. * @since 9 */ function addWatcher(watcher: Watcher): void; @@ -330,7 +329,7 @@ declare namespace hiSysEvent { * @throws {BusinessError} 201 - Permission denied. An attempt was made to read system event forbidden by permission: ohos.permission.READ_DFX_SYSEVENT. * @throws {BusinessError} 401 - Invalid argument. * @throws {BusinessError} 11200201 - The watcher does not exist. - * @return {void} return void. + * @returns {void} return void. * @since 9 */ function removeWatcher(watcher: Watcher): void; @@ -350,7 +349,7 @@ declare namespace hiSysEvent { * @throws {BusinessError} 11200302 - Invalid query rule. * @throws {BusinessError} 11200303 - Count of concurrent queriers is over limit. * @throws {BusinessError} 11200304 - Query frequency is over limit. - * @return {void} return void. + * @returns {void} return void. * @since 9 */ function query(queryArg: QueryArg, rules: QueryRule[], querier: Querier): void; diff --git a/api/@ohos.hiTraceChain.d.ts b/api/@ohos.hiTraceChain.d.ts index 30d805b3722e70615b6c334b1dac219e46fe969e..4c0150cb7da926c64e5c50954f047c092ff1854c 100644 --- a/api/@ohos.hiTraceChain.d.ts +++ b/api/@ohos.hiTraceChain.d.ts @@ -152,7 +152,7 @@ declare namespace hiTraceChain { * @syscap SystemCapability.HiviewDFX.HiTrace * @param {string} name Process name. * @param {number} flags Trace function flag. - * @return {HiTraceId} Valid if first call, otherwise invalid. + * @returns {HiTraceId} Valid if first call, otherwise invalid. */ function begin(name: string, flags?: number): HiTraceId; @@ -172,7 +172,7 @@ declare namespace hiTraceChain { * * @since 8 * @syscap SystemCapability.HiviewDFX.HiTrace - * @return {HiTraceId} Valid if current thread have a trace id, otherwise invalid. + * @returns {HiTraceId} Valid if current thread have a trace id, otherwise invalid. */ function getId(): HiTraceId; @@ -198,7 +198,7 @@ declare namespace hiTraceChain { * * @since 8 * @syscap SystemCapability.HiviewDFX.HiTrace - * @return {HiTraceId} A valid span trace id. Otherwise trace id of current thread if do not allow create span. + * @returns {HiTraceId} A valid span trace id. Otherwise trace id of current thread if do not allow create span. */ function createSpan(): HiTraceId; @@ -220,7 +220,7 @@ declare namespace hiTraceChain { * @since 8 * @syscap SystemCapability.HiviewDFX.HiTrace * @param {HiTraceId} id Trace id that need to judge. - * @return {boolean} True for a valid trace id, otherwise false. + * @returns {boolean} True for a valid trace id, otherwise false. */ function isValid(id: HiTraceId): boolean; @@ -231,7 +231,7 @@ declare namespace hiTraceChain { * @syscap SystemCapability.HiviewDFX.HiTrace * @param {HiTraceId} id Trace id that need to judge. * @param {HiTraceFlag} flag Trace flag that need to judge. - * @return {boolean} true if the trace id has enabled the flag. + * @returns {boolean} true if the trace id has enabled the flag. */ function isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean; diff --git a/api/@ohos.hiviewdfx.hiAppEvent.d.ts b/api/@ohos.hiviewdfx.hiAppEvent.d.ts index 9d9df9602c09830085844caa2f6a0402c0a9a05c..a856daee9befe671eb411c9b17d47e47ad3382be 100644 --- a/api/@ohos.hiviewdfx.hiAppEvent.d.ts +++ b/api/@ohos.hiviewdfx.hiAppEvent.d.ts @@ -272,7 +272,7 @@ declare namespace hiAppEvent { * * @since 9 * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @return {AppEventPackage} The read event package. + * @returns {AppEventPackage} The read event package. */ takeNext(): AppEventPackage; } @@ -353,7 +353,7 @@ declare namespace hiAppEvent { * @syscap SystemCapability.HiviewDFX.HiAppEvent * @static * @param {Watcher} watcher Watcher object for monitoring events. - * @return {AppEventPackageHolder} Holder object, which is used to read the monitoring data of the watcher. + * @returns {AppEventPackageHolder} Holder object, which is used to read the monitoring data of the watcher. * @throws {BusinessError} 401 - Parameter error. * @throws {BusinessError} 11102001 - Invalid watcher name. * @throws {BusinessError} 11102002 - Invalid filtering event domain. @@ -385,4 +385,4 @@ declare namespace hiAppEvent { function clearData(): void; } -export default hiAppEvent; \ No newline at end of file +export default hiAppEvent;