Skip to content

Commit a74af86

Browse files
KT-20357: Rename and enhance sample usages for array constructor functions in standard library
Related issue: KT-20357
1 parent a166b7e commit a74af86

File tree

3 files changed

+58
-18
lines changed

3 files changed

+58
-18
lines changed

libraries/stdlib/jvm/builtins/Library.kt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,41 +35,57 @@ public actual inline fun <reified T> arrayOf(vararg elements: T): Array<T>
3535

3636
/**
3737
* Returns an array containing the specified [Double] numbers.
38+
*
39+
* @sample samples.collections.Arrays.Constructors.doubleArrayOfSampl
3840
*/
3941
public actual fun doubleArrayOf(vararg elements: Double): DoubleArray
4042

4143
/**
4244
* Returns an array containing the specified [Float] numbers.
45+
*
46+
* @sample samples.collections.Arrays.Constructors.floatArrayOfSample
4347
*/
4448
public actual fun floatArrayOf(vararg elements: Float): FloatArray
4549

4650
/**
4751
* Returns an array containing the specified [Long] numbers.
52+
*
53+
* @sample samples.collections.Arrays.Constructors.longArrayOfSample
4854
*/
4955
public actual fun longArrayOf(vararg elements: Long): LongArray
5056

5157
/**
5258
* Returns an array containing the specified [Int] numbers.
59+
*
60+
* @sample samples.collections.Arrays.Constructors.intArrayOfSample
5361
*/
5462
public actual fun intArrayOf(vararg elements: Int): IntArray
5563

5664
/**
5765
* Returns an array containing the specified characters.
66+
*
67+
* @sample samples.collections.Arrays.Constructors.charArrayOfSample
5868
*/
5969
public actual fun charArrayOf(vararg elements: Char): CharArray
6070

6171
/**
6272
* Returns an array containing the specified [Short] numbers.
73+
*
74+
* @sample samples.collections.Arrays.Constructors.shortArrayOfSample
6375
*/
6476
public actual fun shortArrayOf(vararg elements: Short): ShortArray
6577

6678
/**
6779
* Returns an array containing the specified [Byte] numbers.
80+
*
81+
* @sample samples.collections.Arrays.Constructors.byteArrayOfSample
6882
*/
6983
public actual fun byteArrayOf(vararg elements: Byte): ByteArray
7084

7185
/**
7286
* Returns an array containing the specified boolean values.
87+
*
88+
* @sample samples.collections.Arrays.Constructors.booleanArrayOfSample
7389
*/
7490
public actual fun booleanArrayOf(vararg elements: Boolean): BooleanArray
7591

libraries/stdlib/samples/test/samples/collections/arrays.kt

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -536,49 +536,73 @@ class Arrays {
536536

537537
class Constructors {
538538
@Sample
539-
fun doubleArrayOf() {
539+
fun doubleArrayOfSample() {
540+
val emptyDoubleArray = doubleArrayOf()
541+
assertPrints(emptyDoubleArray.contentToString(), "[]")
542+
540543
val doubleArray = doubleArrayOf(1.0, 2.5, 3.14)
541544
assertPrints(doubleArray.contentToString(), "[1.0, 2.5, 3.14]")
542545
}
543546

544547
@Sample
545-
fun floatArrayOf() {
548+
fun floatArrayOfSample() {
549+
val emptyFloatArray = floatArrayOf()
550+
assertPrints(emptyFloatArray.contentToString(), "[]")
551+
546552
val floatArray = floatArrayOf(1.0f, 2.5f, 3.14f)
547553
assertPrints(floatArray.contentToString(), "[1.0, 2.5, 3.14]")
548554
}
549555

550556
@Sample
551-
fun longArrayOf() {
557+
fun longArrayOfSample() {
558+
val emptyLongArray = longArrayOf()
559+
assertPrints(emptyLongArray.contentToString(), "[]")
560+
552561
val longArray = longArrayOf(1L, 2L, 3L)
553562
assertPrints(longArray.contentToString(), "[1, 2, 3]")
554563
}
555564

556565
@Sample
557-
fun intArrayOf() {
566+
fun intArrayOfSample() {
567+
val emptyIntArray = intArrayOf()
568+
assertPrints(emptyIntArray.contentToString(), "[]")
569+
558570
val intArray = intArrayOf(1, 2, 3)
559571
assertPrints(intArray.contentToString(), "[1, 2, 3]")
560572
}
561573

562574
@Sample
563-
fun charArrayOf() {
564-
val chars = charArrayOf('a', 'b', 'c')
565-
assertPrints(chars.contentToString(), "[a, b, c]")
575+
fun charArrayOfSample() {
576+
val emptyCharArray = charArrayOf()
577+
assertPrints(emptyCharArray.contentToString(), "[]")
578+
579+
val charArray = charArrayOf('a', 'b', 'c')
580+
assertPrints(charArray.contentToString(), "[a, b, c]")
566581
}
567582

568583
@Sample
569-
fun shortArrayOf() {
584+
fun shortArrayOfSample() {
585+
val emptyShortArray = shortArrayOf()
586+
assertPrints(emptyShortArray.contentToString(), "[]")
587+
570588
val shortArray = shortArrayOf(1, 2, 3)
571589
assertPrints(shortArray.contentToString(), "[1, 2, 3]")
572590
}
573591

574592
@Sample
575-
fun byteArrayOf() {
593+
fun byteArrayOfSample() {
594+
val emptyByteArray = byteArrayOf()
595+
assertPrints(emptyByteArray.contentToString(), "[]")
596+
576597
val byteArray = byteArrayOf(1, 2, 3)
577598
assertPrints(byteArray.contentToString(), "[1, 2, 3]")
578599
}
579600

580601
@Sample
581-
fun booleanArrayOf() {
602+
fun booleanArrayOfSample() {
603+
val emptyBooleanArray = booleanArrayOf()
604+
assertPrints(emptyBooleanArray.contentToString(), "[]")
605+
582606
val booleanArray = booleanArrayOf(true, false, true)
583607
assertPrints(booleanArray.contentToString(), "[true, false, true]")
584608
}

libraries/stdlib/src/kotlin/Library.kt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,56 +34,56 @@ public expect inline fun <reified T> arrayOf(vararg elements: T): Array<T>
3434
/**
3535
* Returns an array containing the specified [Double] numbers.
3636
*
37-
* @sample samples.collections.Arrays.Constructors.doubleArrayOf
37+
* @sample samples.collections.Arrays.Constructors.doubleArrayOfSample
3838
*/
3939
public expect fun doubleArrayOf(vararg elements: Double): DoubleArray
4040

4141
/**
4242
* Returns an array containing the specified [Float] numbers.
4343
*
44-
* @sample samples.collections.Arrays.Constructors.floatArrayOf
44+
* @sample samples.collections.Arrays.Constructors.floatArrayOfSample
4545
*/
4646
public expect fun floatArrayOf(vararg elements: Float): FloatArray
4747

4848
/**
4949
* Returns an array containing the specified [Long] numbers.
5050
*
51-
* @sample samples.collections.Arrays.Constructors.longArrayOf
51+
* @sample samples.collections.Arrays.Constructors.longArrayOfSample
5252
*/
5353
public expect fun longArrayOf(vararg elements: Long): LongArray
5454

5555
/**
5656
* Returns an array containing the specified [Int] numbers.
5757
*
58-
* @sample samples.collections.Arrays.Constructors.intArrayOf
58+
* @sample samples.collections.Arrays.Constructors.intArrayOfSample
5959
*/
6060
public expect fun intArrayOf(vararg elements: Int): IntArray
6161

6262
/**
6363
* Returns an array containing the specified characters.
6464
*
65-
* @sample samples.collections.Arrays.Constructors.charArrayOf
65+
* @sample samples.collections.Arrays.Constructors.charArrayOfSample
6666
*/
6767
public expect fun charArrayOf(vararg elements: Char): CharArray
6868

6969
/**
7070
* Returns an array containing the specified [Short] numbers.
7171
*
72-
* @sample samples.collections.Arrays.Constructors.shortArrayOf
72+
* @sample samples.collections.Arrays.Constructors.shortArrayOfSample
7373
*/
7474
public expect fun shortArrayOf(vararg elements: Short): ShortArray
7575

7676
/**
7777
* Returns an array containing the specified [Byte] numbers.
7878
*
79-
* @sample samples.collections.Arrays.Constructors.byteArrayOf
79+
* @sample samples.collections.Arrays.Constructors.byteArrayOfSample
8080
*/
8181
public expect fun byteArrayOf(vararg elements: Byte): ByteArray
8282

8383
/**
8484
* Returns an array containing the specified boolean values.
8585
*
86-
* @sample samples.collections.Arrays.Constructors.booleanArrayOf
86+
* @sample samples.collections.Arrays.Constructors.booleanArrayOfSample
8787
*/
8888
public expect fun booleanArrayOf(vararg elements: Boolean): BooleanArray
8989

0 commit comments

Comments
 (0)