KT-22298 Improve docs for Array.copyOf(newSize: Int)
Signed-off-by: Valeriy Zhirnov <neonailol@gmail.com>
This commit is contained in:
committed by
Ilya Gorbunov
parent
df4dcc0f8e
commit
9239de9a02
@@ -5574,92 +5574,164 @@ public expect fun CharArray.contentToString(): String
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.copyOf
|
||||
*/
|
||||
@Suppress("NO_ACTUAL_FOR_EXPECT")
|
||||
public expect fun <T> Array<T>.copyOf(): Array<T>
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.copyOf
|
||||
*/
|
||||
public expect fun ByteArray.copyOf(): ByteArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.copyOf
|
||||
*/
|
||||
public expect fun ShortArray.copyOf(): ShortArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.copyOf
|
||||
*/
|
||||
public expect fun IntArray.copyOf(): IntArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.copyOf
|
||||
*/
|
||||
public expect fun LongArray.copyOf(): LongArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.copyOf
|
||||
*/
|
||||
public expect fun FloatArray.copyOf(): FloatArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.copyOf
|
||||
*/
|
||||
public expect fun DoubleArray.copyOf(): DoubleArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.copyOf
|
||||
*/
|
||||
public expect fun BooleanArray.copyOf(): BooleanArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.copyOf
|
||||
*/
|
||||
public expect fun CharArray.copyOf(): CharArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize].
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize],
|
||||
* truncating original values or padding new array with primitive default values if necessary.
|
||||
*
|
||||
* For all indices that are valid in both the original array and the copy, the two arrays contents will be identical.
|
||||
* For all indices that are valid in the copy, but not in the original, the copy will contain primitive default values.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.resizedPrimitiveCopyOf
|
||||
*/
|
||||
public expect fun ByteArray.copyOf(newSize: Int): ByteArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize].
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize],
|
||||
* truncating original values or padding new array with primitive default values if necessary.
|
||||
*
|
||||
* For all indices that are valid in both the original array and the copy, the two arrays contents will be identical.
|
||||
* For all indices that are valid in the copy, but not in the original, the copy will contain primitive default values.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.resizedPrimitiveCopyOf
|
||||
*/
|
||||
public expect fun ShortArray.copyOf(newSize: Int): ShortArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize].
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize],
|
||||
* truncating original values or padding new array with primitive default values if necessary.
|
||||
*
|
||||
* For all indices that are valid in both the original array and the copy, the two arrays contents will be identical.
|
||||
* For all indices that are valid in the copy, but not in the original, the copy will contain primitive default values.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.resizedPrimitiveCopyOf
|
||||
*/
|
||||
public expect fun IntArray.copyOf(newSize: Int): IntArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize].
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize],
|
||||
* truncating original values or padding new array with primitive default values if necessary.
|
||||
*
|
||||
* For all indices that are valid in both the original array and the copy, the two arrays contents will be identical.
|
||||
* For all indices that are valid in the copy, but not in the original, the copy will contain primitive default values.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.resizedPrimitiveCopyOf
|
||||
*/
|
||||
public expect fun LongArray.copyOf(newSize: Int): LongArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize].
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize],
|
||||
* truncating original values or padding new array with primitive default values if necessary.
|
||||
*
|
||||
* For all indices that are valid in both the original array and the copy, the two arrays contents will be identical.
|
||||
* For all indices that are valid in the copy, but not in the original, the copy will contain primitive default values.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.resizedPrimitiveCopyOf
|
||||
*/
|
||||
public expect fun FloatArray.copyOf(newSize: Int): FloatArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize].
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize],
|
||||
* truncating original values or padding new array with primitive default values if necessary.
|
||||
*
|
||||
* For all indices that are valid in both the original array and the copy, the two arrays contents will be identical.
|
||||
* For all indices that are valid in the copy, but not in the original, the copy will contain primitive default values.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.resizedPrimitiveCopyOf
|
||||
*/
|
||||
public expect fun DoubleArray.copyOf(newSize: Int): DoubleArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize].
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize],
|
||||
* truncating original values or padding new array with primitive default values if necessary.
|
||||
*
|
||||
* For all indices that are valid in both the original array and the copy, the two arrays contents will be identical.
|
||||
* For all indices that are valid in the copy, but not in the original, the copy will contain primitive default values.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.resizedPrimitiveCopyOf
|
||||
*/
|
||||
public expect fun BooleanArray.copyOf(newSize: Int): BooleanArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize].
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize],
|
||||
* truncating original values or padding new array with primitive default values if necessary.
|
||||
*
|
||||
* For all indices that are valid in both the original array and the copy, the two arrays contents will be identical.
|
||||
* For all indices that are valid in the copy, but not in the original, the copy will contain primitive default values.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.resizedPrimitiveCopyOf
|
||||
*/
|
||||
public expect fun CharArray.copyOf(newSize: Int): CharArray
|
||||
|
||||
/**
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize].
|
||||
* Returns new array which is a copy of the original array, resized to the given [newSize],
|
||||
* truncating original values or padding new array with null values if necessary.
|
||||
*
|
||||
* For all indices that are valid in both the original array and the copy, the two arrays contents will be identical.
|
||||
* For all indices that are valid in the copy, but not in the original, the copy will contain null values.
|
||||
*
|
||||
* @sample samples.collections.Arrays.CopyOfOperations.resizingCopyOf
|
||||
*/
|
||||
@Suppress("NO_ACTUAL_FOR_EXPECT")
|
||||
public expect fun <T> Array<T>.copyOf(newSize: Int): Array<T?>
|
||||
|
||||
Reference in New Issue
Block a user