From 8cc3461a8a042234654bf52af16e78b28fad443b Mon Sep 17 00:00:00 2001 From: liu-ganlin Date: Fri, 25 Nov 2022 16:01:34 +0800 Subject: [PATCH] update unknow decorator and misspell words Signed-off-by: liu-ganlin --- api/@ohos.buffer.d.ts | 142 ++++++++++++++--------------- api/@ohos.util.ArrayList.d.ts | 18 ++-- api/@ohos.util.Deque.d.ts | 10 +- api/@ohos.util.HashMap.d.ts | 10 +- api/@ohos.util.HashSet.d.ts | 6 +- api/@ohos.util.LightWeightMap.d.ts | 28 +++--- api/@ohos.util.LightWeightSet.d.ts | 16 ++-- api/@ohos.util.LinkedList.d.ts | 30 +++--- api/@ohos.util.List.d.ts | 24 ++--- api/@ohos.util.PlainArray.d.ts | 20 ++-- api/@ohos.util.Queue.d.ts | 6 +- api/@ohos.util.Stack.d.ts | 6 +- api/@ohos.util.TreeMap.d.ts | 22 ++--- api/@ohos.util.TreeSet.d.ts | 22 ++--- api/@ohos.util.Vector.d.ts | 37 +++++--- 15 files changed, 202 insertions(+), 195 deletions(-) diff --git a/api/@ohos.buffer.d.ts b/api/@ohos.buffer.d.ts index d4ec693cfd..9fc9a1bfac 100644 --- a/api/@ohos.buffer.d.ts +++ b/api/@ohos.buffer.d.ts @@ -31,7 +31,7 @@ declare namespace buffer { * @param size The desired length of the new Buffer * @param [fill=0] A value to pre-fill the new Buffer with * @param [encoding='utf8'] If `fill` is a string, this is its encoding - * @return Return a new allocated Buffer + * @returns Return a new allocated Buffer * @throws {BusinessError} 401 - if the input parameters are invalid. */ function alloc(size: number, fill?: string | Buffer | number, encoding?: BufferEncoding): Buffer; @@ -41,7 +41,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param size The desired length of the new Buffer - * @return Return a new allocated Buffer + * @returns Return a new allocated Buffer * @throws {BusinessError} 401 - if the input parameters are invalid. */ function allocUninitializedFromPool(size: number): Buffer; @@ -51,7 +51,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param size The desired length of the new Buffer - * @return Return a new allocated Buffer + * @returns Return a new allocated Buffer * @throws {BusinessError} 401 - if the input parameters are invalid. */ function allocUninitialized(size: number): Buffer; @@ -64,7 +64,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param string A value to calculate the length of * @param [encoding='utf8'] If `string` is a string, this is its encoding - * @return The number of bytes contained within `string` + * @returns The number of bytes contained within `string` * @throws {BusinessError} 401 - if the input parameters are invalid. */ function byteLength(string: string | Buffer | TypedArray | DataView | ArrayBuffer | SharedArrayBuffer, encoding?: BufferEncoding): number; @@ -75,7 +75,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param list List of `Buffer` or Uint8Array instances to concatenate * @param totalLength Total length of the `Buffer` instances in `list` when concatenated - * @return Return a new allocated Buffer + * @returns Return a new allocated Buffer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "length" is out of range. It must be >= 0 and <= uint32 max. Received value is: [length] */ @@ -86,7 +86,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param array an array of bytes in the range 0 – 255 - * @return Return a new allocated Buffer + * @returns Return a new allocated Buffer * @throws {BusinessError} 401 - if the input parameters are invalid. */ function from(array: number[]): Buffer; @@ -98,7 +98,7 @@ declare namespace buffer { * @param arrayBuffer An ArrayBuffer, SharedArrayBuffer, for example the .buffer property of a TypedArray. * @param [byteOffset = 0] Index of first byte to expose * @param [length = arrayBuffer.byteLength - byteOffset] Number of bytes to expose - * @return Return a view of the ArrayBuffer + * @returns Return a view of the ArrayBuffer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[byteOffset/length]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [byteOffset/length] */ @@ -109,7 +109,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param buffer An existing Buffer or Uint8Array from which to copy data - * @return Return a new allocated Buffer + * @returns Return a new allocated Buffer * @throws {BusinessError} 401 - if the input parameters are invalid. */ function from(buffer: Buffer | Uint8Array): Buffer; @@ -122,7 +122,7 @@ declare namespace buffer { * @param object An object supporting Symbol.toPrimitive or valueOf() * @param offsetOrEncoding A byte-offset or encoding * @param length A length - * @return Return a new allocated Buffer + * @returns Return a new allocated Buffer * @throws {BusinessError} 401 - if the input parameters are invalid. */ function from(object: Object, offsetOrEncoding: number | string, length: number): Buffer; @@ -134,7 +134,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param string A string to encode * @param [encoding='utf8'] The encoding of string - * @return Return a new Buffer containing string + * @returns Return a new Buffer containing string * @throws {BusinessError} 401 - if the input parameters are invalid. */ function from(string: String, encoding?: BufferEncoding): Buffer; @@ -144,7 +144,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param obj Objects to be judged - * @return true or false + * @returns true or false */ function isBuffer(obj: Object): boolean; @@ -153,7 +153,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param encoding A character encoding name to check - * @return true or false + * @returns true or false */ function isEncoding(encoding: string):boolean; @@ -163,7 +163,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param buf1 A Buffer or Uint8Array instance. * @param buf2 A Buffer or Uint8Array instance. - * @return 0 is returned if target is the same as buf + * @returns 0 is returned if target is the same as buf * 1 is returned if target should come before buf when sorted. * -1 is returned if target should come after buf when sorted. * @throws {BusinessError} 401 - if the input parameters are invalid. @@ -177,7 +177,7 @@ declare namespace buffer { * @param source A Buffer or Uint8Array instance. * @param fromEnc The current encoding * @param toEnc To target encoding - * @return Returns a new Buffer instance + * @returns Returns a new Buffer instance * @throws {BusinessError} 401 - if the input parameters are invalid. */ function transcode(source: Buffer | Uint8Array, fromEnc: string, toEnc: string): Buffer; @@ -218,7 +218,7 @@ declare namespace buffer { * @param [offset = 0] Number of bytes to skip before starting to fill buf * @param [end = buf.length] Where to stop filling buf (not inclusive) * @param [encoding='utf8'] The encoding for value if value is a string - * @return A reference to buf + * @returns A reference to buf * @throws {BusinessError} 10200001 - The value of "[offset/end]" is out of range. It must be >= 0 and <= [right range]. Received value is: [offset/end] * @throws {BusinessError} 401 - if the input parameters are invalid. */ @@ -234,7 +234,7 @@ declare namespace buffer { * @param [targetEnd = target.length] The offset within target at which to end comparison (not inclusive) * @param [sourceStart = 0] The offset within buf at which to begin comparison * @param [sourceEnd = buf.length] The offset within buf at which to end comparison (not inclusive) - * @return 0 is returned if target is the same as buf + * @returns 0 is returned if target is the same as buf * 1 is returned if target should come before buf when sorted. * -1 is returned if target should come after buf when sorted. * @throws {BusinessError} 401 - if the input parameters are invalid. @@ -252,7 +252,7 @@ declare namespace buffer { * @param [targetStart = 0] The offset within target at which to begin writing * @param [sourceStart = 0] The offset within buf from which to begin copying * @param [sourceEnd = buf.length] The offset within buf at which to stop copying (not inclusive) - * @return The number of bytes copied + * @returns The number of bytes copied * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[targetStart/sourceStart/sourceEnd]" is out of range. It must be >= 0. * Received value is: [targetStart/sourceStart/sourceEnd] @@ -264,7 +264,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param otherBuffer A Buffer or Uint8Array with which to compare buf - * @return true or false + * @returns true or false * @throws {BusinessError} 401 - if the input parameters are invalid. */ equals(otherBuffer: Uint8Array | Buffer): boolean; @@ -276,7 +276,7 @@ declare namespace buffer { * @param value What to search for * @param [byteOffset = 0] Where to begin searching in buf. If negative, then offset is calculated from the end of buf * @param [encoding='utf8'] If value is a string, this is its encoding - * @return true or false + * @returns true or false * @throws {BusinessError} 401 - if the input parameters are invalid. */ includes(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): boolean; @@ -288,7 +288,7 @@ declare namespace buffer { * @param value What to search for * @param [byteOffset = 0] Where to begin searching in buf * @param [encoding='utf8'] If value is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf - * @return The index of the first occurrence of value in buf, or -1 if buf does not contain value + * @returns The index of the first occurrence of value in buf, or -1 if buf does not contain value * @throws {BusinessError} 401 - if the input parameters are invalid. */ indexOf(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number; @@ -321,7 +321,7 @@ declare namespace buffer { * @param value What to search for * @param [byteOffset = 0] Where to begin searching in buf * @param [encoding='utf8'] If value is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf - * @return The index of the last occurrence of value in buf, or -1 if buf does not contain value + * @returns The index of the last occurrence of value in buf, or -1 if buf does not contain value * @throws {BusinessError} 401 - if the input parameters are invalid. */ lastIndexOf(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number; @@ -331,7 +331,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8 - * @return Return a signed, big-endian 64-bit integer + * @returns Return a signed, big-endian 64-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset] */ @@ -342,7 +342,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8 - * @return Return a signed, little-endian 64-bit integer + * @returns Return a signed, little-endian 64-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset] */ @@ -353,7 +353,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8 - * @return Return a unsigned, big-endian 64-bit integer + * @returns Return a unsigned, big-endian 64-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset] */ @@ -364,7 +364,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8 - * @return Return a unsigned, little-endian 64-bit integer + * @returns Return a unsigned, little-endian 64-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset] */ @@ -375,7 +375,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8 - * @return Return a 64-bit, big-endian double + * @returns Return a 64-bit, big-endian double * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset] */ @@ -386,7 +386,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8 - * @return Return a 64-bit, little-endian double + * @returns Return a 64-bit, little-endian double * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset] */ @@ -397,7 +397,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4 - * @return Return a 32-bit, big-endian float + * @returns Return a 32-bit, big-endian float * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset] */ @@ -408,7 +408,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4 - * @return Return a 32-bit, little-endian float + * @returns Return a 32-bit, little-endian float * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset] */ @@ -419,7 +419,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 1 - * @return Return a signed 8-bit integer + * @returns Return a signed 8-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 1. Received value is: [offset] */ @@ -430,7 +430,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 2 - * @return Return a signed, big-endian 16-bit integer + * @returns Return a signed, big-endian 16-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset] */ @@ -441,7 +441,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 2 - * @return Return a signed, little-endian 16-bit integer + * @returns Return a signed, little-endian 16-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset] */ @@ -452,7 +452,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4 - * @return Return a signed, big-endian 32-bit integer + * @returns Return a signed, big-endian 32-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset] */ @@ -463,7 +463,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 4 - * @return Return a signed, little-endian 32-bit integer + * @returns Return a signed, little-endian 32-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset] */ @@ -476,7 +476,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength * @param byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6 - * @return + * @returns * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -489,7 +489,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength * @param byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6 - * @return + * @returns * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -500,7 +500,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1 - * @return Reads an unsigned 8-bit integer + * @returns Reads an unsigned 8-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 1. Received value is: [offset] */ @@ -511,7 +511,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2 - * @return Reads an unsigned, big-endian 16-bit integer + * @returns Reads an unsigned, big-endian 16-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset] */ @@ -522,7 +522,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2 - * @return Reads an unsigned, little-endian 16-bit integer + * @returns Reads an unsigned, little-endian 16-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 2. Received value is: [offset] */ @@ -533,7 +533,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4 - * @return Reads an unsigned, big-endian 32-bit integer + * @returns Reads an unsigned, big-endian 32-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset] */ @@ -544,7 +544,7 @@ declare namespace buffer { * @since 9 * @syscap SystemCapability.Utils.Lang * @param [offset = 0] Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4 - * @return Reads an unsigned, little-endian 32-bit integer + * @returns Reads an unsigned, little-endian 32-bit integer * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset] */ @@ -557,7 +557,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength * @param byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6 - * @return + * @returns * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -570,7 +570,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param offset Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - byteLength * @param byteLength Number of bytes to read. Must satisfy 0 < byteLength <= 6 - * @return + * @returns * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -582,7 +582,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param [start = 0] Where the new Buffer will start * @param [end = buf.length] Where the new Buffer will end (not inclusive) - * @return Returns a new Buffer that references the same memory as the original + * @returns Returns a new Buffer that references the same memory as the original */ subarray(start?: number, end?: number): Buffer; @@ -590,7 +590,7 @@ declare namespace buffer { * Interprets buf as an array of unsigned 16-bit integers and swaps the byte order in-place. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return A reference to buf + * @returns A reference to buf * @throws {BusinessError} 10200009 - Buffer size must be a multiple of 16-bits */ swap16(): Buffer; @@ -599,7 +599,7 @@ declare namespace buffer { * Interprets buf as an array of unsigned 32-bit integers and swaps the byte order in-place. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return A reference to buf + * @returns A reference to buf * @throws {BusinessError} 10200009 - Buffer size must be a multiple of 32-bits */ swap32(): Buffer; @@ -608,7 +608,7 @@ declare namespace buffer { * Interprets buf as an array of unsigned 64-bit integers and swaps the byte order in-place. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return A reference to buf + * @returns A reference to buf * @throws {BusinessError} 10200009 - Buffer size must be a multiple of 64-bits */ swap64(): Buffer; @@ -617,7 +617,7 @@ declare namespace buffer { * Returns a JSON representation of buf * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns a JSON + * @returns Returns a JSON */ toJSON(): Object; @@ -640,7 +640,7 @@ declare namespace buffer { * @param [offset = 0] Number of bytes to skip before starting to write string * @param [length = buf.length - offset] Maximum number of bytes to write (written bytes will not exceed buf.length - offset) * @param [encoding='utf8'] The character encoding of string. - * @return Number of bytes written. + * @returns Number of bytes written. * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[offset/length]" is out of range. It must be >= 0 and <= buf.length. Received value is: [offset/length] */ @@ -652,7 +652,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -664,7 +664,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -676,7 +676,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -688,7 +688,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -700,7 +700,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset] */ @@ -712,7 +712,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 8. Received value is: [offset] */ @@ -724,7 +724,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset] */ @@ -736,7 +736,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "offset" is out of range. It must be >= 0 and <= buf.length - 4. Received value is: [offset] */ @@ -748,7 +748,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 1 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -760,7 +760,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 2 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -772,7 +772,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 2 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -784,7 +784,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -796,7 +796,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 4 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -809,7 +809,7 @@ declare namespace buffer { * @param value Number to be written to buf * @param offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength * @param byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -822,7 +822,7 @@ declare namespace buffer { * @param value Number to be written to buf * @param offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength * @param byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -834,7 +834,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -846,7 +846,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -858,7 +858,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -870,7 +870,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -882,7 +882,7 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @param value Number to be written to buf * @param [offset = 0] Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -895,7 +895,7 @@ declare namespace buffer { * @param value Number to be written to buf * @param offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength * @param byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ @@ -908,7 +908,7 @@ declare namespace buffer { * @param value Number to be written to buf * @param offset Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength * @param byteLength Number of bytes to write. Must satisfy 0 < byteLength <= 6 - * @return offset plus the number of bytes written + * @returns offset plus the number of bytes written * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200001 - The value of "[param]" is out of range. It must be >= [left range] and <= [right range]. Received value is: [param] */ diff --git a/api/@ohos.util.ArrayList.d.ts b/api/@ohos.util.ArrayList.d.ts index ac7174e497..acb504fd9d 100644 --- a/api/@ohos.util.ArrayList.d.ts +++ b/api/@ohos.util.ArrayList.d.ts @@ -47,7 +47,7 @@ declare class ArrayList { /** * Check if arraylist contains the specified element * @param element element to be contained - * @return the boolean type,if arraylist contains the specified element,return true,else return false + * @returns the boolean type,if arraylist contains the specified element,return true,else return false * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -56,7 +56,7 @@ declare class ArrayList { * Returns the index of the first occurrence of the specified element * in this arraylist, or -1 if this arraylist does not contain the element. * @param element element to be contained - * @return the number type ,returns the lowest index such that or -1 if there is no such index. + * @returns the number type ,returns the lowest index such that or -1 if there is no such index. * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -65,7 +65,7 @@ declare class ArrayList { * Find the corresponding element according to the index, * delete the element, and move the index of all elements to the right of the element forward by one. * @param index the index in the arraylist - * @return the T type ,returns undefined if arraylist is empty,If the index is + * @returns the T type ,returns undefined if arraylist is empty,If the index is * out of bounds (greater than or equal to length or less than 0), throw an exception * @since 8 * @syscap SystemCapability.Utils.Lang @@ -76,7 +76,7 @@ declare class ArrayList { * if it is present. If the arraylist does not contain the element, it is * unchanged. More formally, removes the element with the lowest index * @param element element to remove - * @return the boolean type ,If there is no such element, return false + * @returns the boolean type ,If there is no such element, return false * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -85,7 +85,7 @@ declare class ArrayList { * Returns in the index of the last occurrence of the specified element in this arraylist , * or -1 if the arraylist does not contain the element. * @param element element to find - * @return the number type + * @returns the number type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -160,28 +160,28 @@ declare class ArrayList { clear(): void; /** * Returns a shallow copy of this instance. (The elements themselves are not copied.) - * @return this arraylist instance + * @returns this arraylist instance * @since 8 * @syscap SystemCapability.Utils.Lang */ clone(): ArrayList; /** * returns the capacity of this arraylist - * @return the number type + * @returns the number type * @since 8 * @syscap SystemCapability.Utils.Lang */ getCapacity(): number; /** * convert arraylist to array - * @return the Array type + * @returns the Array type * @since 8 * @syscap SystemCapability.Utils.Lang */ convertToArray(): Array; /** * Determine whether arraylist is empty and whether there is an element - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ diff --git a/api/@ohos.util.Deque.d.ts b/api/@ohos.util.Deque.d.ts index b8b284b44a..629ab28a6f 100644 --- a/api/@ohos.util.Deque.d.ts +++ b/api/@ohos.util.Deque.d.ts @@ -42,21 +42,21 @@ declare class Deque { /** * Check if deque contains the specified element * @param element element to be contained - * @return the boolean type,if deque contains the specified element,return true,else return false + * @returns the boolean type,if deque contains the specified element,return true,else return false * @since 8 * @syscap SystemCapability.Utils.Lang */ has(element: T): boolean; /** * Obtains the header element of a deque. - * @return the T type + * @returns the T type * @since 8 * @syscap SystemCapability.Utils.Lang */ getFirst(): T; /** * Obtains the end element of a deque. - * @return the T type + * @returns the T type * @throws an exception if the queue is empty * @since 8 * @syscap SystemCapability.Utils.Lang @@ -64,7 +64,7 @@ declare class Deque { getLast(): T; /** * Obtains the header element of a deque and delete the element. - * @return the T type + * @returns the T type * @throws an exception if the deque is empty * @since 8 * @syscap SystemCapability.Utils.Lang @@ -72,7 +72,7 @@ declare class Deque { popFirst(): T; /** * Obtains the end element of a deque and delete the element. - * @return the T type + * @returns the T type * @throws an exception if the deque is empty * @since 8 * @syscap SystemCapability.Utils.Lang diff --git a/api/@ohos.util.HashMap.d.ts b/api/@ohos.util.HashMap.d.ts index db6a86247b..8c1954e3f2 100644 --- a/api/@ohos.util.HashMap.d.ts +++ b/api/@ohos.util.HashMap.d.ts @@ -27,7 +27,7 @@ declare class HashMap { length: number; /** * Returns whether the Map object contains elements - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -35,7 +35,7 @@ declare class HashMap { /** * Returns whether a key is contained in this map * @param key need to determine whether to include the key - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -43,7 +43,7 @@ declare class HashMap { /** * Returns whether a value is contained in this map * @param value need to determine whether to include the value - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -51,7 +51,7 @@ declare class HashMap { /** * Returns a specified element in a Map object, or null if there is no corresponding element * @param key the index in HashMap - * @return value or null + * @returns value or null * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -75,7 +75,7 @@ declare class HashMap { /** * Remove a specified element from a Map object * @param key Target to be deleted - * @return Target mapped value + * @returns Target mapped value * @since 8 * @syscap SystemCapability.Utils.Lang */ diff --git a/api/@ohos.util.HashSet.d.ts b/api/@ohos.util.HashSet.d.ts index 88c292927a..5dce03f2a6 100644 --- a/api/@ohos.util.HashSet.d.ts +++ b/api/@ohos.util.HashSet.d.ts @@ -27,7 +27,7 @@ declare class HashSet { length: number; /** * Returns whether the Set object contains elements - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -35,7 +35,7 @@ declare class HashSet { /** * Returns whether the Set object contain s the elements * @param value need to determine whether to include the element - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -51,7 +51,7 @@ declare class HashSet { /** * Remove a specified element from a Set object * @param value Target to be deleted - * @return the boolean type(Is there contain this element) + * @returns the boolean type(Is there contain this element) * @since 8 * @syscap SystemCapability.Utils.Lang */ diff --git a/api/@ohos.util.LightWeightMap.d.ts b/api/@ohos.util.LightWeightMap.d.ts index cc34b5dfbf..20bed7875c 100644 --- a/api/@ohos.util.LightWeightMap.d.ts +++ b/api/@ohos.util.LightWeightMap.d.ts @@ -28,7 +28,7 @@ declare class LightWeightMap { /** * Returns whether this map has all the object in a specified map * @param map the Map object to compare - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -36,7 +36,7 @@ declare class LightWeightMap { /** * Returns whether a key is contained in this map * @param key need to determine whether to include the key - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -44,7 +44,7 @@ declare class LightWeightMap { /** * Returns whether a value is contained in this map * @param value need to determine whether to include the value - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -66,7 +66,7 @@ declare class LightWeightMap { /** * Returns the value to which the specified key is mapped, or undefined if this map contains no mapping for the key * @param key the index in LightWeightMap - * @return value or undefined + * @returns value or undefined * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -74,7 +74,7 @@ declare class LightWeightMap { /** * Obtains the index of the key equal to a specified key in an LightWeightMap container * @param key Looking for goals - * @return Subscript corresponding to target + * @returns Subscript corresponding to target * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -82,22 +82,22 @@ declare class LightWeightMap { /** * Obtains the index of the value equal to a specified value in an LightWeightMap container * @param value Looking for goals - * @return Subscript corresponding to target + * @returns Subscript corresponding to target * @since 8 * @syscap SystemCapability.Utils.Lang */ getIndexOfValue(value: V): number; /** * Returns whether the Map object contains elements - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ isEmpty(): boolean; /** - * Obtains the key at the loaction identified by index in an LightWeightMap container + * Obtains the key at the location identified by index in an LightWeightMap container * @param index Target subscript for search - * @return the key of key-value pairs + * @returns the key of key-value pairs * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -127,15 +127,15 @@ declare class LightWeightMap { /** * Remove the mapping for this key from this map if present * @param key Target to be deleted - * @return Target mapped value + * @returns Target mapped value * @since 8 * @syscap SystemCapability.Utils.Lang */ remove(key: K): V; /** - * Deletes a key-value pair at the loaction identified by index from an LightWeightMap container + * Deletes a key-value pair at the location identified by index from an LightWeightMap container * @param index Target subscript for search - * @return the boolean type(Is there a delete value) + * @returns the boolean type(Is there a delete value) * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -151,7 +151,7 @@ declare class LightWeightMap { * Sets the value identified by index in an LightWeightMap container to a specified value * @param index Target subscript for search * @param value Updated the target mapped value - * @return the boolean type(Is there a value corresponding to the subscript) + * @returns the boolean type(Is there a value corresponding to the subscript) * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -179,7 +179,7 @@ declare class LightWeightMap { /** * Obtains the value identified by index in an LightWeightMap container * @param index Target subscript for search - * @return the value of key-value pairs + * @returns the value of key-value pairs * @since 8 * @syscap SystemCapability.Utils.Lang */ diff --git a/api/@ohos.util.LightWeightSet.d.ts b/api/@ohos.util.LightWeightSet.d.ts index e882104ee8..b3ae0d6e4c 100644 --- a/api/@ohos.util.LightWeightSet.d.ts +++ b/api/@ohos.util.LightWeightSet.d.ts @@ -44,7 +44,7 @@ declare class LightWeightSet { /** * Returns whether this set has all the object in a specified set * @param set the Set object to compare - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -52,7 +52,7 @@ declare class LightWeightSet { /** * Checks whether an LightWeightSet container has a specified key * @param key need to determine whether to include the key - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -60,7 +60,7 @@ declare class LightWeightSet { /** * Checks whether an the objects of an LightWeighSet containeer are of the same type as a specified Object LightWeightSet * @param obj need to determine whether to include the obj - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -76,7 +76,7 @@ declare class LightWeightSet { /** * Obtains the index of s key of a specified Object type in an LightWeightSet container * @param key Looking for goals - * @return Subscript corresponding to target + * @returns Subscript corresponding to target * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -84,15 +84,15 @@ declare class LightWeightSet { /** * Deletes an object of a specified Object type from an LightWeightSet container * @param key Target to be deleted - * @return Target element + * @returns Target element * @since 8 * @syscap SystemCapability.Utils.Lang */ remove(key: T): T; /** - * Deletes an object at the loaction identified by index from an LightWeightSet container + * Deletes an object at the location identified by index from an LightWeightSet container * @param index Target subscript for search - * @return the boolean type(Is there a delete value) + * @returns the boolean type(Is there a delete value) * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -133,7 +133,7 @@ declare class LightWeightSet { /** * Obtains the object at the location identified by index in an LightWeightSet container * @param index Target subscript for search - * @return the value of key-value pairs + * @returns the value of key-value pairs * @since 8 * @syscap SystemCapability.Utils.Lang */ diff --git a/api/@ohos.util.LinkedList.d.ts b/api/@ohos.util.LinkedList.d.ts index e81ef5c4d2..178e12124d 100644 --- a/api/@ohos.util.LinkedList.d.ts +++ b/api/@ohos.util.LinkedList.d.ts @@ -46,7 +46,7 @@ declare class LinkedList { * Returns the element at the specified position in this linkedlist, * or returns undefined if this linkedlist is empty * @param index specified position - * @return the T type + * @returns the T type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -60,7 +60,7 @@ declare class LinkedList { addFirst(element: T): void; /** * Retrieves and removes the head (first element) of this linkedlist. - * @return the head of this list + * @returns the head of this list * @throws NoSuchElementException if this linkedlist is empty * @since 8 * @syscap SystemCapability.Utils.Lang @@ -68,7 +68,7 @@ declare class LinkedList { removeFirst(): T; /** * Removes and returns the last element from this linkedlist. - * @return the head of this list + * @returns the head of this list * @throws NoSuchElementException if this linkedlist is empty * @since 8 * @syscap SystemCapability.Utils.Lang @@ -78,7 +78,7 @@ declare class LinkedList { /** * Check if linkedlist contains the specified element * @param element element to be contained - * @return the boolean type,if linkedList contains the specified element,return true,else return false + * @returns the boolean type,if linkedList contains the specified element,return true,else return false * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -87,7 +87,7 @@ declare class LinkedList { * Returns the index of the first occurrence of the specified element * in this linkedlist, or -1 if this linkedlist does not contain the element. * @param element element to be contained - * @return the number type ,returns the lowest index such that or -1 if there is no such index. + * @returns the number type ,returns the lowest index such that or -1 if there is no such index. * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -95,7 +95,7 @@ declare class LinkedList { /** * Find the corresponding element according to the index, * @param index the index in the linkedlist - * @return the T type ,returns undefined if linkedlist is empty,If the index is + * @returns the T type ,returns undefined if linkedlist is empty,If the index is * out of bounds (greater than or equal to length or less than 0), throw an exception * @since 8 * @syscap SystemCapability.Utils.Lang @@ -106,7 +106,7 @@ declare class LinkedList { * if it is present. If the linkedlist does not contain the element, it is * unchanged. More formally, removes the element with the lowest index * @param element element to remove - * @return the boolean type ,If there is no such element, return false + * @returns the boolean type ,If there is no such element, return false * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -116,7 +116,7 @@ declare class LinkedList { * if it is present. If the linkedlist does not contain the element, it is * unchanged. More formally, removes the element with the lowest index * @param element element to remove - * @return the boolean type ,If there is no such element, return false + * @returns the boolean type ,If there is no such element, return false * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -126,7 +126,7 @@ declare class LinkedList { * if it is present. If the linkedlist does not contain the element, it is * unchanged. More formally, removes the element with the lowest index * @param element element to remove - * @return the boolean type ,If there is no such element, return false + * @returns the boolean type ,If there is no such element, return false * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -135,7 +135,7 @@ declare class LinkedList { * Returns in the index of the last occurrence of the specified element in this linkedlist , * or -1 if the linkedlist does not contain the element. * @param element element to find - * @return the number type + * @returns the number type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -143,7 +143,7 @@ declare class LinkedList { /** * Returns the first element (the item at index 0) of this linkedlist. * or returns undefined if linkedlist is empty - * @return the T type ,returns undefined if linkedList is empty + * @returns the T type ,returns undefined if linkedList is empty * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -151,7 +151,7 @@ declare class LinkedList { /** * Returns the Last element (the item at index length-1) of this linkedlist. * or returns undefined if linkedlist is empty - * @return the T type ,returns undefined if linkedList is empty + * @returns the T type ,returns undefined if linkedList is empty * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -160,7 +160,7 @@ declare class LinkedList { * Replaces the element at the specified position in this Vector with the specified element * @param element replaced element * @param index index to find - * @return the T type ,returns undefined if linkedList is empty + * @returns the T type ,returns undefined if linkedList is empty * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -188,14 +188,14 @@ declare class LinkedList { clear(): void; /** * Returns a shallow copy of this instance. (The elements themselves are not copied.) - * @return this linkedlist instance + * @returns this linkedlist instance * @since 8 * @syscap SystemCapability.Utils.Lang */ clone(): LinkedList; /** * convert linkedlist to array - * @return the Array type + * @returns the Array type * @since 8 * @syscap SystemCapability.Utils.Lang */ diff --git a/api/@ohos.util.List.d.ts b/api/@ohos.util.List.d.ts index fa79586eca..6f55f6024c 100644 --- a/api/@ohos.util.List.d.ts +++ b/api/@ohos.util.List.d.ts @@ -46,7 +46,7 @@ declare class List { * Returns the element at the specified position in this list, * or returns undefined if this list is empty * @param index specified position - * @return the T type + * @returns the T type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -54,7 +54,7 @@ declare class List { /** * Check if list contains the specified element * @param element element to be contained - * @return the boolean type,if list contains the specified element,return true,else return false + * @returns the boolean type,if list contains the specified element,return true,else return false * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -63,7 +63,7 @@ declare class List { * Returns the index of the first occurrence of the specified element * in this list, or -1 if this list does not contain the element. * @param element element to be contained - * @return the number type ,returns the lowest index such that or -1 if there is no such index. + * @returns the number type ,returns the lowest index such that or -1 if there is no such index. * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -71,7 +71,7 @@ declare class List { /** * Find the corresponding element according to the index, * @param index the index in the list - * @return the T type ,returns undefined if list is empty,If the index is + * @returns the T type ,returns undefined if list is empty,If the index is * out of bounds (greater than or equal to length or less than 0), throw an exception * @since 8 * @syscap SystemCapability.Utils.Lang @@ -82,7 +82,7 @@ declare class List { * if it is present. If the list does not contain the element, it is * unchanged. More formally, removes the element with the lowest index * @param element element to remove - * @return the boolean type ,If there is no such element, return false + * @returns the boolean type ,If there is no such element, return false * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -91,7 +91,7 @@ declare class List { * Returns in the index of the last occurrence of the specified element in this list , * or -1 if the list does not contain the element. * @param element element to find - * @return the number type + * @returns the number type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -99,7 +99,7 @@ declare class List { /** * Returns the first element (the item at index 0) of this list. * or returns undefined if list is empty - * @return the T type ,returns undefined if list is empty + * @returns the T type ,returns undefined if list is empty * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -107,7 +107,7 @@ declare class List { /** * Returns the Last element (the item at index length-1) of this list. * or returns undefined if list is empty - * @return the T type ,returns undefined if list is empty + * @returns the T type ,returns undefined if list is empty * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -116,7 +116,7 @@ declare class List { * Replaces the element at the specified position in this List with the specified element * @param element replaced element * @param index index to find - * @return the T type + * @returns the T type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -125,7 +125,7 @@ declare class List { * Compares the specified object with this list for equality.if the object are the same as this list * return true, otherwise return false. * @param obj Compare objects - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -189,14 +189,14 @@ declare class List { thisArg?: Object): void; /** * convert list to array - * @return the Array type + * @returns the Array type * @since 8 * @syscap SystemCapability.Utils.Lang */ convertToArray(): Array; /** * Determine whether list is empty and whether there is an element - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ diff --git a/api/@ohos.util.PlainArray.d.ts b/api/@ohos.util.PlainArray.d.ts index 37012f6ad2..807af38efc 100644 --- a/api/@ohos.util.PlainArray.d.ts +++ b/api/@ohos.util.PlainArray.d.ts @@ -49,7 +49,7 @@ declare class PlainArray { /** * Checks whether the current PlainArray object contains the specified key * @param key need to determine whether to include the key - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -57,7 +57,7 @@ declare class PlainArray { /** * Queries the value associated with the specified key * @param key Looking for goals - * @return the value of key-value pairs + * @returns the value of key-value pairs * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -65,7 +65,7 @@ declare class PlainArray { /** * Queries the index for a specified key * @param key Looking for goals - * @return Subscript corresponding to target + * @returns Subscript corresponding to target * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -73,14 +73,14 @@ declare class PlainArray { /** * Queries the index for a specified value * @param value Looking for goals - * @return Subscript corresponding to target + * @returns Subscript corresponding to target * @since 8 * @syscap SystemCapability.Utils.Lang */ getIndexOfValue(value: T): number; /** * Checks whether the current PlainArray object is empty - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -88,7 +88,7 @@ declare class PlainArray { /** * Queries the key at a specified index * @param index Target subscript for search - * @return the key of key-value pairs + * @returns the key of key-value pairs * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -96,7 +96,7 @@ declare class PlainArray { /** * Remove the key-value pair based on a specified key if it exists and return the value * @param key Target to be deleted - * @return Target mapped value + * @returns Target mapped value * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -104,7 +104,7 @@ declare class PlainArray { /** * Remove the key-value pair at a specified index if it exists and return the value * @param index Target subscript for search - * @return the T type + * @returns the T type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -113,7 +113,7 @@ declare class PlainArray { * Remove a group of key-value pairs from a specified index * @param index remove start index * @param size Expected deletion quantity - * @return Actual deleted quantity + * @returns Actual deleted quantity * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -135,7 +135,7 @@ declare class PlainArray { /** * Queries the value at a specified index * @param index Target subscript for search - * @return the value of key-value pairs + * @returns the value of key-value pairs * @since 8 * @syscap SystemCapability.Utils.Lang */ diff --git a/api/@ohos.util.Queue.d.ts b/api/@ohos.util.Queue.d.ts index 69c2762bd4..2f3d1cae72 100644 --- a/api/@ohos.util.Queue.d.ts +++ b/api/@ohos.util.Queue.d.ts @@ -29,14 +29,14 @@ declare class Queue { * Inserting specified element at the end of a queue if it is possible to do * so immediately without violating capacity restrictions. * @param element to be appended to this queue - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ add(element: T): boolean; /** * Obtains the header element of a queue. - * @return the T type + * @returns the T type * @throws an exception if the queue is empty * @since 8 * @syscap SystemCapability.Utils.Lang @@ -44,7 +44,7 @@ declare class Queue { getFirst(): T; /** * Retrieves and removes the head of this queue - * @return the T type + * @returns the T type * @throws an exception if the queue is empty * @since 8 * @syscap SystemCapability.Utils.Lang diff --git a/api/@ohos.util.Stack.d.ts b/api/@ohos.util.Stack.d.ts index 59ef60e5d4..0a259d27cc 100644 --- a/api/@ohos.util.Stack.d.ts +++ b/api/@ohos.util.Stack.d.ts @@ -27,15 +27,15 @@ declare class Stack { length: number; /** * Tests if this stack is empty - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ isEmpty(): boolean; /** * Looks at the object at the top of this stack without removing it from the stack - * Return undfined if this stack is empty - * @return the top value or undefined + * Return undefined if this stack is empty + * @returns the top value or undefined * @since 8 * @syscap SystemCapability.Utils.Lang */ diff --git a/api/@ohos.util.TreeMap.d.ts b/api/@ohos.util.TreeMap.d.ts index 2b4647f18f..76fb07c472 100644 --- a/api/@ohos.util.TreeMap.d.ts +++ b/api/@ohos.util.TreeMap.d.ts @@ -30,7 +30,7 @@ declare class TreeMap { length: number; /** * Returns whether the Map object contains elements - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -38,7 +38,7 @@ declare class TreeMap { /** * Returns whether a key is contained in this map * @param key need to determine whether to include the key - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -46,7 +46,7 @@ declare class TreeMap { /** * Returns whether a value is contained in this map * @param value need to determine whether to include the value - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -54,7 +54,7 @@ declare class TreeMap { /** * Returns a specified element in a Map object, or null if there is no corresponding element * @param key the index in TreeMap - * @return value or null + * @returns value or null * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -62,7 +62,7 @@ declare class TreeMap { /** * Obtains the first sorted key in the treemap. * Or returns undefined if tree map is empty - * @return value or undefined + * @returns value or undefined * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -70,7 +70,7 @@ declare class TreeMap { /** * Obtains the last sorted key in the treemap. * Or returns undefined if tree map is empty - * @return value or undefined + * @returns value or undefined * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -94,7 +94,7 @@ declare class TreeMap { /** * Remove a specified element from a Map object * @param key Target to be deleted - * @return Target mapped value + * @returns Target mapped value * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -107,18 +107,18 @@ declare class TreeMap { clear(): void; /** * Returns the greatest element smaller than or equal to the specified key - * if the key does not exist, undefied is returned + * if the key does not exist, undefined is returned * @param key Objective of comparison - * @return key or undefined + * @returns key or undefined * @since 8 * @syscap SystemCapability.Utils.Lang */ getLowerKey(key: K): K; /** * Returns the least element greater than or equal to the specified key - * if the key does not exist, undefied is returned + * if the key does not exist, undefined is returned * @param key Objective of comparison - * @return key or undefined + * @returns key or undefined * @since 8 * @syscap SystemCapability.Utils.Lang */ diff --git a/api/@ohos.util.TreeSet.d.ts b/api/@ohos.util.TreeSet.d.ts index a71ef36bf0..632031c6e9 100644 --- a/api/@ohos.util.TreeSet.d.ts +++ b/api/@ohos.util.TreeSet.d.ts @@ -30,7 +30,7 @@ declare class TreeSet { length: number; /** * Returns whether the Set object contains elements - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -38,7 +38,7 @@ declare class TreeSet { /** * Returns whether the Set object contain s the elements * @param value need to determine whether to include the element - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -54,7 +54,7 @@ declare class TreeSet { /** * Remove a specified element from a Set object * @param value Target to be deleted - * @return the boolean type(Is there contain this element) + * @returns the boolean type(Is there contain this element) * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -67,46 +67,46 @@ declare class TreeSet { clear(): void; /** * Gets the first elements in a set - * @return value or undefined + * @returns value or undefined * @since 8 * @syscap SystemCapability.Utils.Lang */ getFirstValue(): T; /** * Gets the last elements in a set - * @return value or undefined + * @returns value or undefined * @since 8 * @syscap SystemCapability.Utils.Lang */ getLastValue(): T; /** * Returns the greatest element smaller than or equal to the specified key - * if the key does not exist, undefied is returned + * if the key does not exist, undefined is returned * @param key Objective of comparison - * @return key or undefined + * @returns key or undefined * @since 8 * @syscap SystemCapability.Utils.Lang */ getLowerValue(key: T): T; /** * Returns the least element greater than or equal to the specified key - * if the key does not exist, undefied is returned + * if the key does not exist, undefined is returned * @param key Objective of comparison - * @return key or undefined + * @returns key or undefined * @since 8 * @syscap SystemCapability.Utils.Lang */ getHigherValue(key: T): T; /** * Return and delete the first element, returns undefined if tree set is empty - * @return first value or undefined + * @returns first value or undefined * @since 8 * @syscap SystemCapability.Utils.Lang */ popFirst(): T; /** * Return and delete the last element, returns undefined if tree set is empty - * @return last value or undefined + * @returns last value or undefined * @since 8 * @syscap SystemCapability.Utils.Lang */ diff --git a/api/@ohos.util.Vector.d.ts b/api/@ohos.util.Vector.d.ts index 67d310c7b5..cf3772bc5a 100644 --- a/api/@ohos.util.Vector.d.ts +++ b/api/@ohos.util.Vector.d.ts @@ -12,6 +12,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * @syscap SystemCapability.Utils.Lang + * @since 8 + * @deprecated since 9 + * @useinstead ohos.util.ArrayList + */ declare class Vector { /** * A constructor used to create a Vector object. @@ -47,7 +54,7 @@ declare class Vector { /** * Check if vector contains the specified element * @param element element to be contained - * @return the boolean type,if vector contains the specified element,return true,else return false + * @returns the boolean type,if vector contains the specified element,return true,else return false * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -55,7 +62,7 @@ declare class Vector { /** * Returns the element at the specified position in this Vector,or returns undefined if vector is empty * @param element element to be contained - * @return the number type ,returns the lowest index such that or -1 if there is no such index. + * @returns the number type ,returns the lowest index such that or -1 if there is no such index. * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -64,7 +71,7 @@ declare class Vector { * Returns the index of the first occurrence of the specified element * in this vector, or -1 if this vector does not contain the element. * @param element current index - * @return the number type + * @returns the number type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -72,7 +79,7 @@ declare class Vector { /** * Returns the first component (the item at index 0) of this vector. * or returns undefined if vector is empty - * @return the T type ,returns undefined if vector is empty + * @returns the T type ,returns undefined if vector is empty * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -80,7 +87,7 @@ declare class Vector { /** * Returns the Last component (the item at index length-1) of this vector. * or returns undefined if vector is empty - * @return the T type ,returns undefined if vector is empty + * @returns the T type ,returns undefined if vector is empty * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -89,7 +96,7 @@ declare class Vector { * Find the corresponding element according to the index, * delete the element, and move the index of all elements to the right of the element forward by one. * @param index the index in the vector - * @return the T type ,returns undefined if vector is empty,If the index is + * @returns the T type ,returns undefined if vector is empty,If the index is * out of bounds (greater than or equal to length or less than 0), throw an exception * @since 8 * @syscap SystemCapability.Utils.Lang @@ -100,7 +107,7 @@ declare class Vector { * if it is present. If the vector does not contain the element, it is * unchanged. More formally, removes the element with the lowest index * @param element element to remove - * @return the boolean type ,If there is no such element, return false + * @returns the boolean type ,If there is no such element, return false * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -109,7 +116,7 @@ declare class Vector { * Replaces the element at the specified position in this Vector with the specified element * @param element replaced element * @param index index to find - * @return the T type + * @returns the T type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -118,7 +125,7 @@ declare class Vector { * Returns in the index of the last occurrence of the specified element in this vector , * or -1 if the vector does not contain the element. * @param element element to find - * @return the number type + * @returns the number type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -128,7 +135,7 @@ declare class Vector { * or returns -1 if the element is not found,or -1 if there is no such index * @param element element to find * @param index start index - * @return the number type + * @returns the number type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -138,7 +145,7 @@ declare class Vector { * or returns -1 if the element is not found,or -1 if there is no such index * @param element element to find * @param index start index - * @return the number type + * @returns the number type * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -213,7 +220,7 @@ declare class Vector { clear(): void; /** * Returns a shallow copy of this instance. (The elements themselves are not copied.) - * @return this vector instance + * @returns this vector instance * @since 8 * @syscap SystemCapability.Utils.Lang */ @@ -226,21 +233,21 @@ declare class Vector { setLength(newSize: number): void; /** * returns the capacity of this vector - * @return the number type + * @returns the number type * @since 8 * @syscap SystemCapability.Utils.Lang */ getCapacity(): number; /** * convert vector to array - * @return the Array type + * @returns the Array type * @since 8 * @syscap SystemCapability.Utils.Lang */ convertToArray(): Array; /** * Determine whether vector is empty and whether there is an element - * @return the boolean type + * @returns the boolean type * @since 8 * @syscap SystemCapability.Utils.Lang */ -- Gitee