provide documentation for generated built-in classes
This commit is contained in:
@@ -18,89 +18,153 @@
|
||||
|
||||
package kotlin
|
||||
|
||||
/**
|
||||
* An array of bytes. When targeting the JVM, instances of this class are represented as byte[].
|
||||
* @constructor Creates a new array of the specified [size], with all elements initialized to zero.
|
||||
*/
|
||||
public class ByteArray(size: Int) : Cloneable {
|
||||
/** Returns the array element at the given [index]. This method can be called using the index operator. */
|
||||
public fun get(index: Int): Byte
|
||||
/** Sets the element at the given [index] to the given [value]. This method can be called using the index operator. */
|
||||
public fun set(index: Int, value: Byte): Unit
|
||||
|
||||
/** Returns the number of elements in the array. */
|
||||
public fun size(): Int
|
||||
|
||||
/** Creates an iterator over the elements of the array. */
|
||||
public fun iterator(): ByteIterator
|
||||
|
||||
public override fun clone(): ByteArray
|
||||
}
|
||||
|
||||
/**
|
||||
* An array of chars. When targeting the JVM, instances of this class are represented as char[].
|
||||
* @constructor Creates a new array of the specified [size], with all elements initialized to zero.
|
||||
*/
|
||||
public class CharArray(size: Int) : Cloneable {
|
||||
/** Returns the array element at the given [index]. This method can be called using the index operator. */
|
||||
public fun get(index: Int): Char
|
||||
/** Sets the element at the given [index] to the given [value]. This method can be called using the index operator. */
|
||||
public fun set(index: Int, value: Char): Unit
|
||||
|
||||
/** Returns the number of elements in the array. */
|
||||
public fun size(): Int
|
||||
|
||||
/** Creates an iterator over the elements of the array. */
|
||||
public fun iterator(): CharIterator
|
||||
|
||||
public override fun clone(): CharArray
|
||||
}
|
||||
|
||||
/**
|
||||
* An array of shorts. When targeting the JVM, instances of this class are represented as short[].
|
||||
* @constructor Creates a new array of the specified [size], with all elements initialized to zero.
|
||||
*/
|
||||
public class ShortArray(size: Int) : Cloneable {
|
||||
/** Returns the array element at the given [index]. This method can be called using the index operator. */
|
||||
public fun get(index: Int): Short
|
||||
/** Sets the element at the given [index] to the given [value]. This method can be called using the index operator. */
|
||||
public fun set(index: Int, value: Short): Unit
|
||||
|
||||
/** Returns the number of elements in the array. */
|
||||
public fun size(): Int
|
||||
|
||||
/** Creates an iterator over the elements of the array. */
|
||||
public fun iterator(): ShortIterator
|
||||
|
||||
public override fun clone(): ShortArray
|
||||
}
|
||||
|
||||
/**
|
||||
* An array of ints. When targeting the JVM, instances of this class are represented as int[].
|
||||
* @constructor Creates a new array of the specified [size], with all elements initialized to zero.
|
||||
*/
|
||||
public class IntArray(size: Int) : Cloneable {
|
||||
/** Returns the array element at the given [index]. This method can be called using the index operator. */
|
||||
public fun get(index: Int): Int
|
||||
/** Sets the element at the given [index] to the given [value]. This method can be called using the index operator. */
|
||||
public fun set(index: Int, value: Int): Unit
|
||||
|
||||
/** Returns the number of elements in the array. */
|
||||
public fun size(): Int
|
||||
|
||||
/** Creates an iterator over the elements of the array. */
|
||||
public fun iterator(): IntIterator
|
||||
|
||||
public override fun clone(): IntArray
|
||||
}
|
||||
|
||||
/**
|
||||
* An array of longs. When targeting the JVM, instances of this class are represented as long[].
|
||||
* @constructor Creates a new array of the specified [size], with all elements initialized to zero.
|
||||
*/
|
||||
public class LongArray(size: Int) : Cloneable {
|
||||
/** Returns the array element at the given [index]. This method can be called using the index operator. */
|
||||
public fun get(index: Int): Long
|
||||
/** Sets the element at the given [index] to the given [value]. This method can be called using the index operator. */
|
||||
public fun set(index: Int, value: Long): Unit
|
||||
|
||||
/** Returns the number of elements in the array. */
|
||||
public fun size(): Int
|
||||
|
||||
/** Creates an iterator over the elements of the array. */
|
||||
public fun iterator(): LongIterator
|
||||
|
||||
public override fun clone(): LongArray
|
||||
}
|
||||
|
||||
/**
|
||||
* An array of floats. When targeting the JVM, instances of this class are represented as float[].
|
||||
* @constructor Creates a new array of the specified [size], with all elements initialized to zero.
|
||||
*/
|
||||
public class FloatArray(size: Int) : Cloneable {
|
||||
/** Returns the array element at the given [index]. This method can be called using the index operator. */
|
||||
public fun get(index: Int): Float
|
||||
/** Sets the element at the given [index] to the given [value]. This method can be called using the index operator. */
|
||||
public fun set(index: Int, value: Float): Unit
|
||||
|
||||
/** Returns the number of elements in the array. */
|
||||
public fun size(): Int
|
||||
|
||||
/** Creates an iterator over the elements of the array. */
|
||||
public fun iterator(): FloatIterator
|
||||
|
||||
public override fun clone(): FloatArray
|
||||
}
|
||||
|
||||
/**
|
||||
* An array of doubles. When targeting the JVM, instances of this class are represented as double[].
|
||||
* @constructor Creates a new array of the specified [size], with all elements initialized to zero.
|
||||
*/
|
||||
public class DoubleArray(size: Int) : Cloneable {
|
||||
/** Returns the array element at the given [index]. This method can be called using the index operator. */
|
||||
public fun get(index: Int): Double
|
||||
/** Sets the element at the given [index] to the given [value]. This method can be called using the index operator. */
|
||||
public fun set(index: Int, value: Double): Unit
|
||||
|
||||
/** Returns the number of elements in the array. */
|
||||
public fun size(): Int
|
||||
|
||||
/** Creates an iterator over the elements of the array. */
|
||||
public fun iterator(): DoubleIterator
|
||||
|
||||
public override fun clone(): DoubleArray
|
||||
}
|
||||
|
||||
/**
|
||||
* An array of booleans. When targeting the JVM, instances of this class are represented as boolean[].
|
||||
* @constructor Creates a new array of the specified [size], with all elements initialized to false.
|
||||
*/
|
||||
public class BooleanArray(size: Int) : Cloneable {
|
||||
/** Returns the array element at the given [index]. This method can be called using the index operator. */
|
||||
public fun get(index: Int): Boolean
|
||||
/** Sets the element at the given [index] to the given [value]. This method can be called using the index operator. */
|
||||
public fun set(index: Int, value: Boolean): Unit
|
||||
|
||||
/** Returns the number of elements in the array. */
|
||||
public fun size(): Int
|
||||
|
||||
/** Creates an iterator over the elements of the array. */
|
||||
public fun iterator(): BooleanIterator
|
||||
|
||||
public override fun clone(): BooleanArray
|
||||
|
||||
Reference in New Issue
Block a user