mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2025-04-03 20:52:13 +00:00
规范syscap注释
Signed-off-by: xuyong <xuyong59@huawei.com>
This commit is contained in:
xuyong
parent
b4f42acf93
commit
14320e7629
8
api/@ohos.bytrace.d.ts
vendored
8
api/@ohos.bytrace.d.ts
vendored
@ -36,7 +36,7 @@
|
||||
*
|
||||
* @deprecated
|
||||
* @since 7
|
||||
* @SysCap SystemCapability.Developtools.Bytrace
|
||||
* @syscap SystemCapability.Developtools.Bytrace
|
||||
*/
|
||||
declare namespace bytrace {
|
||||
/**
|
||||
@ -49,7 +49,7 @@ declare namespace bytrace {
|
||||
*
|
||||
* @deprecated
|
||||
* @since 7
|
||||
* @SysCap SystemCapability.Developtools.Bytrace
|
||||
* @syscap SystemCapability.Developtools.Bytrace
|
||||
* @param name Indicates the task name.
|
||||
* @param taskId The unique id used to distinguish the tasks and match with the id in follow finishTrace.
|
||||
* @param expectedTime Indicates the expected time required for completing the task, in milliseconds.
|
||||
@ -64,7 +64,7 @@ declare namespace bytrace {
|
||||
*
|
||||
* @deprecated
|
||||
* @since 7
|
||||
* @SysCap SystemCapability.Developtools.Bytrace
|
||||
* @syscap SystemCapability.Developtools.Bytrace
|
||||
* @param name Indicates the task name. It must be the same whith the {@code name} of startTrace.
|
||||
* @param taskId The unique id used to distinguish the tasks and must be the same whith the .
|
||||
* {@code taskId} of startTrace.
|
||||
@ -76,7 +76,7 @@ declare namespace bytrace {
|
||||
*
|
||||
* @deprecated
|
||||
* @since 7
|
||||
* @SysCap SystemCapability.Developtools.Bytrace
|
||||
* @syscap SystemCapability.Developtools.Bytrace
|
||||
* @param name Indicates the name used to identify the count.
|
||||
* @param count Indicates the number of the count.
|
||||
*/
|
||||
|
||||
30
api/@ohos.hiTraceChain.d.ts
vendored
30
api/@ohos.hiTraceChain.d.ts
vendored
@ -20,14 +20,14 @@
|
||||
* or cross-thread communications.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
*/
|
||||
declare namespace hiTraceChain {
|
||||
/**
|
||||
* Enumerate trace flag
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
*/
|
||||
enum HiTraceFlag {
|
||||
/**
|
||||
@ -75,7 +75,7 @@ declare namespace hiTraceChain {
|
||||
* Enumerate trace point type
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
*/
|
||||
enum HiTraceTracepointType {
|
||||
/**
|
||||
@ -108,7 +108,7 @@ declare namespace hiTraceChain {
|
||||
* Enumerate trace communication mode
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
*/
|
||||
enum HiTraceCommunicationMode {
|
||||
/**
|
||||
@ -136,7 +136,7 @@ declare namespace hiTraceChain {
|
||||
* Trace id, for tracing process.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
*/
|
||||
interface HiTraceId {
|
||||
chainId: bigint; /* 0n: invalid */
|
||||
@ -149,7 +149,7 @@ declare namespace hiTraceChain {
|
||||
* Start tracing a process impl.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
* @param {string} name Process name.
|
||||
* @param {number} flags Trace function flag.
|
||||
* @return {HiTraceId} Valid if first call, otherwise invalid.
|
||||
@ -161,7 +161,7 @@ declare namespace hiTraceChain {
|
||||
* id is valid, otherwise do nothing.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
* @param {HiTraceId} id The trace id that need to stop.
|
||||
*/
|
||||
function end(id: HiTraceId): void;
|
||||
@ -171,7 +171,7 @@ declare namespace hiTraceChain {
|
||||
* trace id belong to current thread
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
* @return {HiTraceId} Valid if current thread have a trace id, otherwise invalid.
|
||||
*/
|
||||
function getId(): HiTraceId;
|
||||
@ -180,7 +180,7 @@ declare namespace hiTraceChain {
|
||||
* Set id as trace id of current thread. Do nothing if id is invalid.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
* @param {HiTraceId} id Set id as trace id of current thread.
|
||||
*/
|
||||
function setId(id: HiTraceId): void;
|
||||
@ -189,7 +189,7 @@ declare namespace hiTraceChain {
|
||||
* Clear trace id of current thread and set it invalid.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
*/
|
||||
function clearId(): void;
|
||||
|
||||
@ -197,7 +197,7 @@ declare namespace hiTraceChain {
|
||||
* Create a new span id according to the trace id of current thread.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
* @return {HiTraceId} A valid span trace id. Otherwise trace id of current thread if do not allow create span.
|
||||
*/
|
||||
function createSpan(): HiTraceId;
|
||||
@ -206,7 +206,7 @@ declare namespace hiTraceChain {
|
||||
* Print hitrace info, include trace id info.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
* @param {HiTraceCommunicationMode} mode Trace communication mode.
|
||||
* @param {HiTraceTracepointType} type Trace info type.
|
||||
* @param {HiTraceId} id Trace id that need to print.
|
||||
@ -218,7 +218,7 @@ declare namespace hiTraceChain {
|
||||
* Judge whether the trace id is valid or not.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
* @param {HiTraceId} id Trace id that need to judge.
|
||||
* @return {boolean} True for a valid trace id, otherwise false.
|
||||
*/
|
||||
@ -228,7 +228,7 @@ declare namespace hiTraceChain {
|
||||
* Judge whether the trace id has enabled a trace flag or not.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @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.
|
||||
@ -239,7 +239,7 @@ declare namespace hiTraceChain {
|
||||
* Enable the designative trace flag for the trace id.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
* @param {HiTraceId} id Trace id that need to enable a flag.
|
||||
* @param {HiTraceFlag} flag the designative trace flag that need to be enabled in the trace id.
|
||||
*/
|
||||
|
||||
14
api/@ohos.hiTraceMeter.d.ts
vendored
14
api/@ohos.hiTraceMeter.d.ts
vendored
@ -22,20 +22,20 @@
|
||||
* <p>Example:
|
||||
* To trace a name verification that is expected to complete within 5 ms:
|
||||
* <pre>{@code
|
||||
* bytrace.startTrace("checkName", 111, 5);
|
||||
* hiTraceMeter.startTrace("checkName", 111, 5);
|
||||
* //your process
|
||||
* bytrace.finishTrace("checkName", 111);
|
||||
* hiTraceMeter.finishTrace("checkName", 111);
|
||||
* }</pre>
|
||||
* To trace the number of layers, which is 3:
|
||||
* <pre>{@code
|
||||
* bytrace.traceByValue("curLayer", 3);
|
||||
* hiTraceMeter.traceByValue("curLayer", 3);
|
||||
* }</pre>
|
||||
*
|
||||
* <p>Each {@code startTrace} matches one {@code finishTrace}, and they must have the same name
|
||||
* and taskId.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
*/
|
||||
declare namespace hiTraceMeter {
|
||||
/**
|
||||
@ -47,7 +47,7 @@ declare namespace hiTraceMeter {
|
||||
* {@link #finishTrace}, the name and taskId need to be the same.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
* @param name Indicates the task name.
|
||||
* @param taskId The unique id used to distinguish the tasks and match with the id in follow finishTrace.
|
||||
*/
|
||||
@ -60,7 +60,7 @@ declare namespace hiTraceMeter {
|
||||
* is specified by {@code name}. This method must be invoked after the the startTrace.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
* @param name Indicates the task name. It must be the same whith the {@code name} of startTrace.
|
||||
* @param taskId The unique id used to distinguish the tasks and must be the same whith the .
|
||||
* {@code taskId} of startTrace.
|
||||
@ -71,7 +71,7 @@ declare namespace hiTraceMeter {
|
||||
* Records a trace for generating a count, such as clock pulse and the number of layers.
|
||||
*
|
||||
* @since 8
|
||||
* @SysCap SystemCapability.HiviewDFX.HiTrace
|
||||
* @syscap SystemCapability.HiviewDFX.HiTrace
|
||||
* @param name Indicates the name used to identify the count.
|
||||
* @param count Indicates the number of the count.
|
||||
*/
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user