KT-20357: Add sample usages for array constructor functions

kotlin-native/runtime/src/main/kotlin/kotlin/ArrayIntrinsics.kt

@@ -21,6 +21,8 @@ public actual inline fun <T> arrayOfNulls(size: Int): Array<T?> =
 
 /**
  * Returns an array containing the specified elements.
+ *
+ * @sample samples.collections.Arrays.Constructors.arrayOfSample
  */
 @TypedIntrinsic(IntrinsicType.IDENTITY)
 @PointsTo(0x00, 0x01) // ret -> elements
@@ -35,48 +37,64 @@ public actual external fun <T> emptyArray(): Array<T>
 
 /**
  * Returns an array containing the specified [Double] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.doubleArrayOfSample
  */
 @Suppress("NOTHING_TO_INLINE")
 public actual inline fun doubleArrayOf(vararg elements: Double): DoubleArray = elements
 
 /**
  * Returns an array containing the specified [Float] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.floatArrayOfSample
  */
 @Suppress("NOTHING_TO_INLINE")
 public actual inline fun floatArrayOf(vararg elements: Float): FloatArray = elements
 
 /**
  * Returns an array containing the specified [Long] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.longArrayOfSample
  */
 @Suppress("NOTHING_TO_INLINE")
 public actual inline fun longArrayOf(vararg elements: Long): LongArray = elements
 
 /**
  * Returns an array containing the specified [Int] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.intArrayOfSample
  */
 @Suppress("NOTHING_TO_INLINE")
 public actual inline fun intArrayOf(vararg elements: Int): IntArray = elements
 
 /**
  * Returns an array containing the specified characters.
+ *
+ * @sample samples.collections.Arrays.Constructors.charArrayOfSample
  */
 @Suppress("NOTHING_TO_INLINE")
 public actual inline fun charArrayOf(vararg elements: Char): CharArray = elements
 
 /**
  * Returns an array containing the specified [Short] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.shortArrayOfSample
  */
 @Suppress("NOTHING_TO_INLINE")
 public actual inline fun shortArrayOf(vararg elements: Short): ShortArray = elements
 
 /**
  * Returns an array containing the specified [Byte] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.byteArrayOfSample
  */
 @Suppress("NOTHING_TO_INLINE")
 public actual inline fun byteArrayOf(vararg elements: Byte): ByteArray = elements
 
 /**
  * Returns an array containing the specified boolean values.
+ *
+ * @sample samples.collections.Arrays.Constructors.booleanArrayOfSample
  */
 @Suppress("NOTHING_TO_INLINE")
 public actual inline fun booleanArrayOf(vararg elements: Boolean): BooleanArray = elements

libraries/stdlib/js/builtins/Library.kt

@@ -30,46 +30,64 @@ public actual inline fun <T> arrayOfNulls(size: Int): Array<T?> = Array<T?>(size
 
 /**
  * Returns an array containing the specified elements.
+ *
+ * @sample samples.collections.Arrays.Constructors.arrayOfSample
  */
 public actual inline fun <T> arrayOf(vararg elements: T): Array<T> = elements.unsafeCast<Array<T>>()
 
 /**
  * Returns an array containing the specified [Double] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.doubleArrayOfSample
  */
 public actual inline fun doubleArrayOf(vararg elements: Double): DoubleArray = elements
 
 /**
  * Returns an array containing the specified [Float] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.floatArrayOfSample
  */
 public actual inline fun floatArrayOf(vararg elements: Float): FloatArray = elements
 
 /**
  * Returns an array containing the specified [Long] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.longArrayOfSample
  */
 public actual inline fun longArrayOf(vararg elements: Long): LongArray = elements
 
 /**
  * Returns an array containing the specified [Int] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.intArrayOfSample
  */
 public actual inline fun intArrayOf(vararg elements: Int): IntArray = elements
 
 /**
  * Returns an array containing the specified characters.
+ *
+ * @sample samples.collections.Arrays.Constructors.charArrayOfSample
  */
 public actual inline fun charArrayOf(vararg elements: Char): CharArray = elements
 
 /**
  * Returns an array containing the specified [Short] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.shortArrayOfSample
  */
 public actual inline fun shortArrayOf(vararg elements: Short): ShortArray = elements
 
 /**
  * Returns an array containing the specified [Byte] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.byteArrayOfSample
  */
 public actual inline fun byteArrayOf(vararg elements: Byte): ByteArray = elements
 
 /**
  * Returns an array containing the specified boolean values.
+ *
+ * @sample samples.collections.Arrays.Constructors.booleanArrayOfSample
  */
 public actual inline fun booleanArrayOf(vararg elements: Boolean): BooleanArray = elements
 
@@ -87,4 +105,4 @@ public actual inline fun <reified T : Enum<T>> enumValues(): Array<T> = enumValu
  * Returns an enum entry with specified name.
  */
 @SinceKotlin("1.1")
-public actual inline fun <reified T : Enum<T>> enumValueOf(name: String): T = enumValueOfIntrinsic<T>(name)
+public actual inline fun <reified T : Enum<T>> enumValueOf(name: String): T = enumValueOfIntrinsic<T>(name)

libraries/stdlib/jvm/builtins/Library.kt

@@ -30,46 +30,64 @@ public actual fun <reified T> arrayOfNulls(size: Int): Array<T?>
 
 /**
  * Returns an array containing the specified elements.
+ *
+ * @sample samples.collections.Arrays.Constructors.arrayOfSample
  */
 public actual inline fun <reified T> arrayOf(vararg elements: T): Array<T>
 
 /**
  * Returns an array containing the specified [Double] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.doubleArrayOfSample
  */
 public actual fun doubleArrayOf(vararg elements: Double): DoubleArray
 
 /**
  * Returns an array containing the specified [Float] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.floatArrayOfSample
  */
 public actual fun floatArrayOf(vararg elements: Float): FloatArray
 
 /**
  * Returns an array containing the specified [Long] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.longArrayOfSample
  */
 public actual fun longArrayOf(vararg elements: Long): LongArray
 
 /**
  * Returns an array containing the specified [Int] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.intArrayOfSample
  */
 public actual fun intArrayOf(vararg elements: Int): IntArray
 
 /**
  * Returns an array containing the specified characters.
+ *
+ * @sample samples.collections.Arrays.Constructors.charArrayOfSample
  */
 public actual fun charArrayOf(vararg elements: Char): CharArray
 
 /**
  * Returns an array containing the specified [Short] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.shortArrayOfSample
  */
 public actual fun shortArrayOf(vararg elements: Short): ShortArray
 
 /**
  * Returns an array containing the specified [Byte] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.byteArrayOfSample
  */
 public actual fun byteArrayOf(vararg elements: Byte): ByteArray
 
 /**
  * Returns an array containing the specified boolean values.
+ *
+ * @sample samples.collections.Arrays.Constructors.booleanArrayOfSample
  */
 public actual fun booleanArrayOf(vararg elements: Boolean): BooleanArray
 

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

@@ -534,4 +534,90 @@ class Arrays {
 
     }
 
+    class Constructors {
+        @Sample
+        fun arrayOfSample() {
+            val emptyArray = arrayOf<Any>()
+            assertPrints(emptyArray.contentToString(), "[]")
+
+            val strings = arrayOf("Hello", "world")
+            assertPrints(strings.contentToString(), "[Hello, world]")
+
+            val numbers: Array<Number> = arrayOf(3.14, 42L, 0.123f)
+            assertPrints(numbers.contentToString(), "[3.14, 42, 0.123]")
+        }
+
+        @Sample
+        fun doubleArrayOfSample() {
+            val emptyDoubleArray = doubleArrayOf()
+            assertPrints(emptyDoubleArray.contentToString(), "[]")
+
+            val doubleArray = doubleArrayOf(1.0, 2.5, 3.14)
+            assertPrints(doubleArray.contentToString(), "[1.0, 2.5, 3.14]")
+        }
+
+        @Sample
+        fun floatArrayOfSample() {
+            val emptyFloatArray = floatArrayOf()
+            assertPrints(emptyFloatArray.contentToString(), "[]")
+
+            val floatArray = floatArrayOf(1.0f, 2.5f, 3.14f)
+            assertPrints(floatArray.contentToString(), "[1.0, 2.5, 3.14]")
+        }
+
+        @Sample
+        fun longArrayOfSample() {
+            val emptyLongArray = longArrayOf()
+            assertPrints(emptyLongArray.contentToString(), "[]")
+
+            val longArray = longArrayOf(1L, 2L, 3L)
+            assertPrints(longArray.contentToString(), "[1, 2, 3]")
+        }
+
+        @Sample
+        fun intArrayOfSample() {
+            val emptyIntArray = intArrayOf()
+            assertPrints(emptyIntArray.contentToString(), "[]")
+
+            val intArray = intArrayOf(1, 2, 3)
+            assertPrints(intArray.contentToString(), "[1, 2, 3]")
+        }
+
+        @Sample
+        fun charArrayOfSample() {
+            val emptyCharArray = charArrayOf()
+            assertPrints(emptyCharArray.contentToString(), "[]")
+
+            val charArray = charArrayOf('a', 'b', 'c')
+            assertPrints(charArray.contentToString(), "[a, b, c]")
+        }
+
+        @Sample
+        fun shortArrayOfSample() {
+            val emptyShortArray = shortArrayOf()
+            assertPrints(emptyShortArray.contentToString(), "[]")
+
+            val shortArray = shortArrayOf(1, 2, 3)
+            assertPrints(shortArray.contentToString(), "[1, 2, 3]")
+        }
+
+        @Sample
+        fun byteArrayOfSample() {
+            val emptyByteArray = byteArrayOf()
+            assertPrints(emptyByteArray.contentToString(), "[]")
+
+            val byteArray = byteArrayOf(1, 2, 3)
+            assertPrints(byteArray.contentToString(), "[1, 2, 3]")
+        }
+
+        @Sample
+        fun booleanArrayOfSample() {
+            val emptyBooleanArray = booleanArrayOf()
+            assertPrints(emptyBooleanArray.contentToString(), "[]")
+
+            val booleanArray = booleanArrayOf(true, false, true)
+            assertPrints(booleanArray.contentToString(), "[true, false, true]")
+        }
+    }
+
 }

libraries/stdlib/src/kotlin/Library.kt

@@ -28,46 +28,64 @@ public expect fun <reified T> arrayOfNulls(size: Int): Array<T?>
 
 /**
  * Returns an array containing the specified elements.
+ *
+ * @sample samples.collections.Arrays.Constructors.arrayOfSample
  */
 public expect inline fun <reified T> arrayOf(vararg elements: T): Array<T>
 
 /**
  * Returns an array containing the specified [Double] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.doubleArrayOfSample
  */
 public expect fun doubleArrayOf(vararg elements: Double): DoubleArray
 
 /**
  * Returns an array containing the specified [Float] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.floatArrayOfSample
  */
 public expect fun floatArrayOf(vararg elements: Float): FloatArray
 
 /**
  * Returns an array containing the specified [Long] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.longArrayOfSample
  */
 public expect fun longArrayOf(vararg elements: Long): LongArray
 
 /**
  * Returns an array containing the specified [Int] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.intArrayOfSample
  */
 public expect fun intArrayOf(vararg elements: Int): IntArray
 
 /**
  * Returns an array containing the specified characters.
+ *
+ * @sample samples.collections.Arrays.Constructors.charArrayOfSample
  */
 public expect fun charArrayOf(vararg elements: Char): CharArray
 
 /**
  * Returns an array containing the specified [Short] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.shortArrayOfSample
  */
 public expect fun shortArrayOf(vararg elements: Short): ShortArray
 
 /**
  * Returns an array containing the specified [Byte] numbers.
+ *
+ * @sample samples.collections.Arrays.Constructors.byteArrayOfSample
  */
 public expect fun byteArrayOf(vararg elements: Byte): ByteArray
 
 /**
  * Returns an array containing the specified boolean values.
+ *
+ * @sample samples.collections.Arrays.Constructors.booleanArrayOfSample
  */
 public expect fun booleanArrayOf(vararg elements: Boolean): BooleanArray