azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More standard library documentation.

Browse Source
This commit is contained in:
Dmitry Jemerov
2015-03-05 19:07:02 +01:00
parent cb27797845
commit 32072d0a4f
44 changed files with 1702 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files
core/builtins/native/kotlin/Arrays.kt
+8 -8
View File
@@ -19,7 +19,7 @@
package kotlin
/**
* An array of bytes. When targeting the JVM, instances of this class are represented as byte[].
* 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 {
@@ -38,7 +38,7 @@ public class ByteArray(size: Int) : Cloneable {
}
/**
* An array of chars. When targeting the JVM, instances of this class are represented as char[].
* 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 {
@@ -57,7 +57,7 @@ public class CharArray(size: Int) : Cloneable {
}
/**
* An array of shorts. When targeting the JVM, instances of this class are represented as short[].
* 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 {
@@ -76,7 +76,7 @@ public class ShortArray(size: Int) : Cloneable {
}
/**
* An array of ints. When targeting the JVM, instances of this class are represented as int[].
* 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 {
@@ -95,7 +95,7 @@ public class IntArray(size: Int) : Cloneable {
}
/**
* An array of longs. When targeting the JVM, instances of this class are represented as long[].
* 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 {
@@ -114,7 +114,7 @@ public class LongArray(size: Int) : Cloneable {
}
/**
* An array of floats. When targeting the JVM, instances of this class are represented as float[].
* 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 {
@@ -133,7 +133,7 @@ public class FloatArray(size: Int) : Cloneable {
}
/**
* An array of doubles. When targeting the JVM, instances of this class are represented as double[].
* 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 {
@@ -152,7 +152,7 @@ public class DoubleArray(size: Int) : Cloneable {
}
/**
* An array of booleans. When targeting the JVM, instances of this class are represented as boolean[].
* 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 {
core/builtins/native/kotlin/Boolean.kt
+12
View File
@@ -21,12 +21,24 @@ package kotlin
* represented as values of the primitive type `boolean`.
*/
public class Boolean private () : Comparable<Boolean> {
/**
* Returns the inverse of this boolean.
*/
public fun not(): Boolean
/**
* Performs a logical `and` operation between this Boolean and the [other] one.
*/
public fun and(other: Boolean): Boolean
/**
* Performs a logical `or` operation between this Boolean and the [other] one.
*/
public fun or(other: Boolean): Boolean
/**
* Performs a logical `xor` operation between this Boolean and the [other] one.
*/
public fun xor(other: Boolean): Boolean
public override fun compareTo(other: Boolean): Int
core/builtins/native/kotlin/Primitives.kt
+578
View File
File diff suppressed because it is too large Load Diff
core/builtins/src/kotlin/Annotations.kt
+2 -2
View File
@@ -26,13 +26,13 @@ public annotation class data
/**
* Marks the annotated class, function or property as deprecated.
* @param value the message explaining the deprecation and recommending an alternative API to use.
* @property value the message explaining the deprecation and recommending an alternative API to use.
*/
public annotation class deprecated(val value: String)
/**
* Suppresses the given compilation warnings in the annotated element.
* @param names names of the compiler diagnostics to suppress.
* @property names names of the compiler diagnostics to suppress.
*/
public annotation class suppress(vararg val names: String)
core/builtins/src/kotlin/ExtensionFunctions.kt
+46
View File
@@ -18,72 +18,118 @@
package kotlin
/** An extension function that takes 0 arguments. */
public trait ExtensionFunction0<in T, out R> {
/** Invokes the function. */
public fun T.invoke(): R
}
/** An extension function that takes 1 argument. */
public trait ExtensionFunction1<in T, in P1, out R> {
/** Invokes the function with the specified argument. */
public fun T.invoke(p1: P1): R
}
/** An extension function that takes 2 arguments. */
public trait ExtensionFunction2<in T, in P1, in P2, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2): R
}
/** An extension function that takes 3 arguments. */
public trait ExtensionFunction3<in T, in P1, in P2, in P3, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3): R
}
/** An extension function that takes 4 arguments. */
public trait ExtensionFunction4<in T, in P1, in P2, in P3, in P4, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4): R
}
/** An extension function that takes 5 arguments. */
public trait ExtensionFunction5<in T, in P1, in P2, in P3, in P4, in P5, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5): R
}
/** An extension function that takes 6 arguments. */
public trait ExtensionFunction6<in T, in P1, in P2, in P3, in P4, in P5, in P6, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6): R
}
/** An extension function that takes 7 arguments. */
public trait ExtensionFunction7<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7): R
}
/** An extension function that takes 8 arguments. */
public trait ExtensionFunction8<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8): R
}
/** An extension function that takes 9 arguments. */
public trait ExtensionFunction9<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9): R
}
/** An extension function that takes 10 arguments. */
public trait ExtensionFunction10<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10): R
}
/** An extension function that takes 11 arguments. */
public trait ExtensionFunction11<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11): R
}
/** An extension function that takes 12 arguments. */
public trait ExtensionFunction12<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12): R
}
/** An extension function that takes 13 arguments. */
public trait ExtensionFunction13<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13): R
}
/** An extension function that takes 14 arguments. */
public trait ExtensionFunction14<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14): R
}
/** An extension function that takes 15 arguments. */
public trait ExtensionFunction15<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15): R
}
/** An extension function that takes 16 arguments. */
public trait ExtensionFunction16<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16): R
}
/** An extension function that takes 17 arguments. */
public trait ExtensionFunction17<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, in P17, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16, p17: P17): R
}
/** An extension function that takes 18 arguments. */
public trait ExtensionFunction18<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, in P17, in P18, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16, p17: P17, p18: P18): R
}
/** An extension function that takes 19 arguments. */
public trait ExtensionFunction19<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, in P17, in P18, in P19, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16, p17: P17, p18: P18, p19: P19): R
}
/** An extension function that takes 20 arguments. */
public trait ExtensionFunction20<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, in P17, in P18, in P19, in P20, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16, p17: P17, p18: P18, p19: P19, p20: P20): R
}
/** An extension function that takes 21 arguments. */
public trait ExtensionFunction21<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, in P17, in P18, in P19, in P20, in P21, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16, p17: P17, p18: P18, p19: P19, p20: P20, p21: P21): R
}
/** An extension function that takes 22 arguments. */
public trait ExtensionFunction22<in T, in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, in P17, in P18, in P19, in P20, in P21, in P22, out R> {
/** Invokes the function with the specified arguments. */
public fun T.invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16, p17: P17, p18: P18, p19: P19, p20: P20, p21: P21, p22: P22): R
}
core/builtins/src/kotlin/FloatingPointConstants.kt
+14
View File
@@ -16,8 +16,22 @@
package kotlin
/**
* Holder for special values of floating point types.
*/
public trait FloatingPointConstants<T> {
/**
* A constant holding the positive infinity value.
*/
public val POSITIVE_INFINITY: T
/**
* A constant holding the negative infinity value.
*/
public val NEGATIVE_INFINITY: T
/**
* A constant holding the "not a number" value.
*/
public val NaN: T
}
core/builtins/src/kotlin/Functions.kt
+46
View File
@@ -18,72 +18,118 @@
package kotlin
/** A function that takes 0 arguments. */
public trait Function0<out R> {
/** Invokes the function. */
public fun invoke(): R
}
/** A function that takes 1 argument. */
public trait Function1<in P1, out R> {
/** Invokes the function with the specified argument. */
public fun invoke(p1: P1): R
}
/** A function that takes 2 arguments. */
public trait Function2<in P1, in P2, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2): R
}
/** A function that takes 3 arguments. */
public trait Function3<in P1, in P2, in P3, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3): R
}
/** A function that takes 4 arguments. */
public trait Function4<in P1, in P2, in P3, in P4, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4): R
}
/** A function that takes 5 arguments. */
public trait Function5<in P1, in P2, in P3, in P4, in P5, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5): R
}
/** A function that takes 6 arguments. */
public trait Function6<in P1, in P2, in P3, in P4, in P5, in P6, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6): R
}
/** A function that takes 7 arguments. */
public trait Function7<in P1, in P2, in P3, in P4, in P5, in P6, in P7, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7): R
}
/** A function that takes 8 arguments. */
public trait Function8<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8): R
}
/** A function that takes 9 arguments. */
public trait Function9<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9): R
}
/** A function that takes 10 arguments. */
public trait Function10<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10): R
}
/** A function that takes 11 arguments. */
public trait Function11<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11): R
}
/** A function that takes 12 arguments. */
public trait Function12<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12): R
}
/** A function that takes 13 arguments. */
public trait Function13<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13): R
}
/** A function that takes 14 arguments. */
public trait Function14<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14): R
}
/** A function that takes 15 arguments. */
public trait Function15<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15): R
}
/** A function that takes 16 arguments. */
public trait Function16<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16): R
}
/** A function that takes 17 arguments. */
public trait Function17<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, in P17, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16, p17: P17): R
}
/** A function that takes 18 arguments. */
public trait Function18<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, in P17, in P18, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16, p17: P17, p18: P18): R
}
/** A function that takes 19 arguments. */
public trait Function19<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, in P17, in P18, in P19, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16, p17: P17, p18: P18, p19: P19): R
}
/** A function that takes 20 arguments. */
public trait Function20<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, in P17, in P18, in P19, in P20, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16, p17: P17, p18: P18, p19: P19, p20: P20): R
}
/** A function that takes 21 arguments. */
public trait Function21<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, in P17, in P18, in P19, in P20, in P21, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16, p17: P17, p18: P18, p19: P19, p20: P20, p21: P21): R
}
/** A function that takes 22 arguments. */
public trait Function22<in P1, in P2, in P3, in P4, in P5, in P6, in P7, in P8, in P9, in P10, in P11, in P12, in P13, in P14, in P15, in P16, in P17, in P18, in P19, in P20, in P21, in P22, out R> {
/** Invokes the function with the specified arguments. */
public fun invoke(p1: P1, p2: P2, p3: P3, p4: P4, p5: P5, p6: P6, p7: P7, p8: P8, p9: P9, p10: P10, p11: P11, p12: P12, p13: P13, p14: P14, p15: P15, p16: P16, p17: P17, p18: P18, p19: P19, p20: P20, p21: P21, p22: P22): R
}
core/builtins/src/kotlin/Inline.kt
+5
View File
@@ -27,6 +27,9 @@ public annotation class noinline
* calling functions. Inline functions can use reified type parameters, and lambdas passed to inline
* functions can contain non-local returns.
* See the [Kotlin language documentation](http://kotlinlang.org/docs/reference/inline-functions.html) for more information.
*
* @property strategy the [InlineStrategy] to use for inlining this function.
*
* @see noinline
* @see inlineOptions
*/
@@ -55,6 +58,8 @@ public enum class InlineStrategy {
* receiving function are allowed to use non-local control flow statements. Lambdas which are called from
* a different execution context (for example, from an object contained in the receiving function)
* are restricted to local control flow statements.
*
* @property value the inlining options selected for the annotated function parameter.
*/
public annotation class inlineOptions(vararg val value: InlineOption)
core/builtins/src/kotlin/Iterators.kt
+8 -8
View File
@@ -18,7 +18,7 @@
package kotlin
/** An iterator over a sequence of values of type Byte. */
/** An iterator over a sequence of values of type `Byte`. */
public abstract class ByteIterator : Iterator<Byte> {
override final fun next() = nextByte()
@@ -26,7 +26,7 @@ public abstract class ByteIterator : Iterator<Byte> {
public abstract fun nextByte(): Byte
}
/** An iterator over a sequence of values of type Char. */
/** An iterator over a sequence of values of type `Char`. */
public abstract class CharIterator : Iterator<Char> {
override final fun next() = nextChar()
@@ -34,7 +34,7 @@ public abstract class CharIterator : Iterator<Char> {
public abstract fun nextChar(): Char
}
/** An iterator over a sequence of values of type Short. */
/** An iterator over a sequence of values of type `Short`. */
public abstract class ShortIterator : Iterator<Short> {
override final fun next() = nextShort()
@@ -42,7 +42,7 @@ public abstract class ShortIterator : Iterator<Short> {
public abstract fun nextShort(): Short
}
/** An iterator over a sequence of values of type Int. */
/** An iterator over a sequence of values of type `Int`. */
public abstract class IntIterator : Iterator<Int> {
override final fun next() = nextInt()
@@ -50,7 +50,7 @@ public abstract class IntIterator : Iterator<Int> {
public abstract fun nextInt(): Int
}
/** An iterator over a sequence of values of type Long. */
/** An iterator over a sequence of values of type `Long`. */
public abstract class LongIterator : Iterator<Long> {
override final fun next() = nextLong()
@@ -58,7 +58,7 @@ public abstract class LongIterator : Iterator<Long> {
public abstract fun nextLong(): Long
}
/** An iterator over a sequence of values of type Float. */
/** An iterator over a sequence of values of type `Float`. */
public abstract class FloatIterator : Iterator<Float> {
override final fun next() = nextFloat()
@@ -66,7 +66,7 @@ public abstract class FloatIterator : Iterator<Float> {
public abstract fun nextFloat(): Float
}
/** An iterator over a sequence of values of type Double. */
/** An iterator over a sequence of values of type `Double`. */
public abstract class DoubleIterator : Iterator<Double> {
override final fun next() = nextDouble()
@@ -74,7 +74,7 @@ public abstract class DoubleIterator : Iterator<Double> {
public abstract fun nextDouble(): Double
}
/** An iterator over a sequence of values of type Boolean. */
/** An iterator over a sequence of values of type `Boolean`. */
public abstract class BooleanIterator : Iterator<Boolean> {
override final fun next() = nextBoolean()
core/builtins/src/kotlin/ProgressionIterators.kt
+28 -7
View File
@@ -20,7 +20,10 @@ package kotlin
import kotlin.internal.getProgressionFinalElement
/** An iterator over a progression of values of type Byte. */
/**
* An iterator over a progression of values of type `Byte`.
* @property increment the number by which the value is incremented on each step.
*/
class ByteProgressionIterator(start: Byte, end: Byte, val increment: Int) : ByteIterator() {
private var next = start.toInt()
private val finalElement: Byte = getProgressionFinalElement(start.toInt(), end.toInt(), increment).toByte()
@@ -40,7 +43,10 @@ class ByteProgressionIterator(start: Byte, end: Byte, val increment: Int) : Byte
}
}
/** An iterator over a progression of values of type Char. */
/**
* An iterator over a progression of values of type `Char`.
* @property increment the number by which the value is incremented on each step.
*/
class CharProgressionIterator(start: Char, end: Char, val increment: Int) : CharIterator() {
private var next = start.toInt()
private val finalElement: Char = getProgressionFinalElement(start.toInt(), end.toInt(), increment).toChar()
@@ -60,7 +66,10 @@ class CharProgressionIterator(start: Char, end: Char, val increment: Int) : Char
}
}
/** An iterator over a progression of values of type Short. */
/**
* An iterator over a progression of values of type `Short`.
* @property increment the number by which the value is incremented on each step.
*/
class ShortProgressionIterator(start: Short, end: Short, val increment: Int) : ShortIterator() {
private var next = start.toInt()
private val finalElement: Short = getProgressionFinalElement(start.toInt(), end.toInt(), increment).toShort()
@@ -80,7 +89,10 @@ class ShortProgressionIterator(start: Short, end: Short, val increment: Int) : S
}
}
/** An iterator over a progression of values of type Int. */
/**
* An iterator over a progression of values of type `Int`.
* @property increment the number by which the value is incremented on each step.
*/
class IntProgressionIterator(start: Int, end: Int, val increment: Int) : IntIterator() {
private var next = start
private val finalElement: Int = getProgressionFinalElement(start, end, increment)
@@ -100,7 +112,10 @@ class IntProgressionIterator(start: Int, end: Int, val increment: Int) : IntIter
}
}
/** An iterator over a progression of values of type Long. */
/**
* An iterator over a progression of values of type `Long`.
* @property increment the number by which the value is incremented on each step.
*/
class LongProgressionIterator(start: Long, end: Long, val increment: Long) : LongIterator() {
private var next = start
private val finalElement: Long = getProgressionFinalElement(start, end, increment)
@@ -120,7 +135,10 @@ class LongProgressionIterator(start: Long, end: Long, val increment: Long) : Lon
}
}
/** An iterator over a progression of values of type Float. */
/**
* An iterator over a progression of values of type `Float`.
* @property increment the number by which the value is incremented on each step.
*/
class FloatProgressionIterator(start: Float, val end: Float, val increment: Float) : FloatIterator() {
private var next = start
@@ -133,7 +151,10 @@ class FloatProgressionIterator(start: Float, val end: Float, val increment: Floa
}
}
/** An iterator over a progression of values of type Double. */
/**
* An iterator over a progression of values of type `Double`.
* @property increment the number by which the value is incremented on each step.
*/
class DoubleProgressionIterator(start: Double, val end: Double, val increment: Double) : DoubleIterator() {
private var next = start
core/builtins/src/kotlin/Progressions.kt
+7 -7
View File
@@ -19,7 +19,7 @@
package kotlin
/**
* A progression of values of type Byte.
* A progression of values of type `Byte`.
*/
public class ByteProgression(
override val start: Byte,
@@ -46,7 +46,7 @@ public class ByteProgression(
}
/**
* A progression of values of type Char.
* A progression of values of type `Char`.
*/
public class CharProgression(
override val start: Char,
@@ -73,7 +73,7 @@ public class CharProgression(
}
/**
* A progression of values of type Short.
* A progression of values of type `Short`.
*/
public class ShortProgression(
override val start: Short,
@@ -100,7 +100,7 @@ public class ShortProgression(
}
/**
* A progression of values of type Int.
* A progression of values of type `Int`.
*/
public class IntProgression(
override val start: Int,
@@ -127,7 +127,7 @@ public class IntProgression(
}
/**
* A progression of values of type Long.
* A progression of values of type `Long`.
*/
public class LongProgression(
override val start: Long,
@@ -154,7 +154,7 @@ public class LongProgression(
}
/**
* A progression of values of type Float.
* A progression of values of type `Float`.
*/
public class FloatProgression(
override val start: Float,
@@ -182,7 +182,7 @@ public class FloatProgression(
}
/**
* A progression of values of type Double.
* A progression of values of type `Double`.
*/
public class DoubleProgression(
override val start: Double,
core/builtins/src/kotlin/PropertyMetadata.kt
+3
View File
@@ -26,4 +26,7 @@ public trait PropertyMetadata {
public val name: String
}
/**
* @suppress
*/
public class PropertyMetadataImpl(override val name: String): PropertyMetadata
core/builtins/src/kotlin/Ranges.kt
+7 -7
View File
@@ -19,7 +19,7 @@
package kotlin
/**
* A range of values of type Byte.
* A range of values of type `Byte`.
*/
public class ByteRange(override val start: Byte, override val end: Byte) : Range<Byte>, Progression<Byte> {
override val increment: Int
@@ -45,7 +45,7 @@ public class ByteRange(override val start: Byte, override val end: Byte) : Range
}
/**
* A range of values of type Char.
* A range of values of type `Char`.
*/
public class CharRange(override val start: Char, override val end: Char) : Range<Char>, Progression<Char> {
override val increment: Int
@@ -71,7 +71,7 @@ public class CharRange(override val start: Char, override val end: Char) : Range
}
/**
* A range of values of type Short.
* A range of values of type `Short`.
*/
public class ShortRange(override val start: Short, override val end: Short) : Range<Short>, Progression<Short> {
override val increment: Int
@@ -97,7 +97,7 @@ public class ShortRange(override val start: Short, override val end: Short) : Ra
}
/**
* A range of values of type Int.
* A range of values of type `Int`.
*/
public class IntRange(override val start: Int, override val end: Int) : Range<Int>, Progression<Int> {
override val increment: Int
@@ -123,7 +123,7 @@ public class IntRange(override val start: Int, override val end: Int) : Range<In
}
/**
* A range of values of type Long.
* A range of values of type `Long`.
*/
public class LongRange(override val start: Long, override val end: Long) : Range<Long>, Progression<Long> {
override val increment: Long
@@ -149,7 +149,7 @@ public class LongRange(override val start: Long, override val end: Long) : Range
}
/**
* A range of values of type Float.
* A range of values of type `Float`.
*/
public class FloatRange(override val start: Float, override val end: Float) : Range<Float>, Progression<Float> {
override val increment: Float
@@ -175,7 +175,7 @@ public class FloatRange(override val start: Float, override val end: Float) : Ra
}
/**
* A range of values of type Double.
* A range of values of type `Double`.
*/
public class DoubleRange(override val start: Double, override val end: Double) : Range<Double>, Progression<Double> {
override val increment: Double
core/builtins/src/kotlin/Unit.kt
+3
View File
@@ -16,6 +16,9 @@
package kotlin
/**
* The type with only one value: the Unit object. This type corresponds to the `void` type in Java.
*/
public object Unit {
override fun toString() = "kotlin.Unit"
}