From 7fc6f06b70bb3024895b005adbe46622c453ff7c Mon Sep 17 00:00:00 2001 From: Ilya Gorbunov Date: Thu, 18 Oct 2018 22:50:46 +0300 Subject: [PATCH] Correct parameter reference in copyInto docs --- .../stdlib/common/src/generated/_Arrays.kt | 18 +++++++++--------- .../stdlib/common/src/generated/_UArrays.kt | 8 ++++---- libraries/stdlib/js/src/generated/_ArraysJs.kt | 18 +++++++++--------- .../stdlib/jvm/src/generated/_ArraysJvm.kt | 18 +++++++++--------- .../kotlin-stdlib-gen/src/templates/Arrays.kt | 2 +- 5 files changed, 32 insertions(+), 32 deletions(-) diff --git a/libraries/stdlib/common/src/generated/_Arrays.kt b/libraries/stdlib/common/src/generated/_Arrays.kt index 549a2b7f392..dbcdef07091 100644 --- a/libraries/stdlib/common/src/generated/_Arrays.kt +++ b/libraries/stdlib/common/src/generated/_Arrays.kt @@ -5842,7 +5842,7 @@ public expect fun CharArray.contentToString(): String * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -5861,7 +5861,7 @@ public expect fun Array.copyInto(destination: Array, destinationOf * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -5880,7 +5880,7 @@ public expect fun ByteArray.copyInto(destination: ByteArray, destinationOffset: * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -5899,7 +5899,7 @@ public expect fun ShortArray.copyInto(destination: ShortArray, destinationOffset * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -5918,7 +5918,7 @@ public expect fun IntArray.copyInto(destination: IntArray, destinationOffset: In * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -5937,7 +5937,7 @@ public expect fun LongArray.copyInto(destination: LongArray, destinationOffset: * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -5956,7 +5956,7 @@ public expect fun FloatArray.copyInto(destination: FloatArray, destinationOffset * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -5975,7 +5975,7 @@ public expect fun DoubleArray.copyInto(destination: DoubleArray, destinationOffs * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -5994,7 +5994,7 @@ public expect fun BooleanArray.copyInto(destination: BooleanArray, destinationOf * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. diff --git a/libraries/stdlib/common/src/generated/_UArrays.kt b/libraries/stdlib/common/src/generated/_UArrays.kt index 52619bbf66f..06743e9c4e8 100644 --- a/libraries/stdlib/common/src/generated/_UArrays.kt +++ b/libraries/stdlib/common/src/generated/_UArrays.kt @@ -334,7 +334,7 @@ public fun UShortArray.contentToString(): String { * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -358,7 +358,7 @@ public inline fun UIntArray.copyInto(destination: UIntArray, destinationOffset: * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -382,7 +382,7 @@ public inline fun ULongArray.copyInto(destination: ULongArray, destinationOffset * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -406,7 +406,7 @@ public inline fun UByteArray.copyInto(destination: UByteArray, destinationOffset * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. diff --git a/libraries/stdlib/js/src/generated/_ArraysJs.kt b/libraries/stdlib/js/src/generated/_ArraysJs.kt index af0c279c463..bd5bbe65785 100644 --- a/libraries/stdlib/js/src/generated/_ArraysJs.kt +++ b/libraries/stdlib/js/src/generated/_ArraysJs.kt @@ -412,7 +412,7 @@ public actual fun CharArray.contentToString(): String { * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -436,7 +436,7 @@ public actual inline fun Array.copyInto(destination: Array, destin * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -460,7 +460,7 @@ public actual inline fun ByteArray.copyInto(destination: ByteArray, destinationO * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -484,7 +484,7 @@ public actual inline fun ShortArray.copyInto(destination: ShortArray, destinatio * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -508,7 +508,7 @@ public actual inline fun IntArray.copyInto(destination: IntArray, destinationOff * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -532,7 +532,7 @@ public actual inline fun LongArray.copyInto(destination: LongArray, destinationO * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -556,7 +556,7 @@ public actual inline fun FloatArray.copyInto(destination: FloatArray, destinatio * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -580,7 +580,7 @@ public actual inline fun DoubleArray.copyInto(destination: DoubleArray, destinat * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -604,7 +604,7 @@ public actual inline fun BooleanArray.copyInto(destination: BooleanArray, destin * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. diff --git a/libraries/stdlib/jvm/src/generated/_ArraysJvm.kt b/libraries/stdlib/jvm/src/generated/_ArraysJvm.kt index 1bb4ee828f2..9ecb1649134 100644 --- a/libraries/stdlib/jvm/src/generated/_ArraysJvm.kt +++ b/libraries/stdlib/jvm/src/generated/_ArraysJvm.kt @@ -617,7 +617,7 @@ public actual inline fun CharArray.contentToString(): String { * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -640,7 +640,7 @@ public actual fun Array.copyInto(destination: Array, destinationOf * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -663,7 +663,7 @@ public actual fun ByteArray.copyInto(destination: ByteArray, destinationOffset: * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -686,7 +686,7 @@ public actual fun ShortArray.copyInto(destination: ShortArray, destinationOffset * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -709,7 +709,7 @@ public actual fun IntArray.copyInto(destination: IntArray, destinationOffset: In * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -732,7 +732,7 @@ public actual fun LongArray.copyInto(destination: LongArray, destinationOffset: * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -755,7 +755,7 @@ public actual fun FloatArray.copyInto(destination: FloatArray, destinationOffset * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -778,7 +778,7 @@ public actual fun DoubleArray.copyInto(destination: DoubleArray, destinationOffs * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. @@ -801,7 +801,7 @@ public actual fun BooleanArray.copyInto(destination: BooleanArray, destinationOf * @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. * * @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + * @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], * or when that index is out of the [destination] array indices range. * * @return the [destination] array. diff --git a/libraries/tools/kotlin-stdlib-gen/src/templates/Arrays.kt b/libraries/tools/kotlin-stdlib-gen/src/templates/Arrays.kt index 2334f710d3c..72541471a0b 100644 --- a/libraries/tools/kotlin-stdlib-gen/src/templates/Arrays.kt +++ b/libraries/tools/kotlin-stdlib-gen/src/templates/Arrays.kt @@ -507,7 +507,7 @@ object ArrayOps : TemplateGroupBase() { @param endIndex the end (exclusive) of the subrange to copy, size of this array by default. @throws IndexOutOfBoundsException or [IllegalArgumentException] when [startIndex] or [endIndex] is out of range of this array indices or when `startIndex > endIndex`. - @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationIndex], + @throws IndexOutOfBoundsException when the subrange doesn't fit into the [destination] array starting at the specified [destinationOffset], or when that index is out of the [destination] array indices range. @return the [destination] array.