From af915726c31392f0bce17264a68f36416ab162f8 Mon Sep 17 00:00:00 2001 From: Ilya Gorbunov Date: Mon, 14 Jan 2019 19:52:08 +0300 Subject: [PATCH] Regenerate docs for contentEquals/DeepEquals (KT-22942) --- .../main/kotlin/generated/_ArraysNative.kt | 32 ++++++++++++++++++- .../kotlin/generated/_CollectionsNative.kt | 2 +- .../kotlin/generated/_ComparisonsNative.kt | 2 +- 3 files changed, 33 insertions(+), 3 deletions(-) diff --git a/runtime/src/main/kotlin/generated/_ArraysNative.kt b/runtime/src/main/kotlin/generated/_ArraysNative.kt index 74c8a5a80b9..76a58b914a7 100644 --- a/runtime/src/main/kotlin/generated/_ArraysNative.kt +++ b/runtime/src/main/kotlin/generated/_ArraysNative.kt @@ -1,5 +1,5 @@ /* - * Copyright 2010-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license + * Copyright 2010-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license * that can be found in the license/LICENSE.txt file. */ @@ -143,6 +143,9 @@ public actual fun CharArray.asList(): List { * * If two corresponding elements are nested arrays, they are also compared deeply. * If any of arrays contains itself on any nesting level the behavior is undefined. + * + * The elements of other types are compared for equality with the [equals][Any.equals] function. + * For floating point numbers it means that `NaN` is equal to itself and `-0.0` is not equal to `0.0`. */ @SinceKotlin("1.1") public actual infix fun Array.contentDeepEquals(other: Array): Boolean { @@ -177,6 +180,9 @@ public actual fun Array.contentDeepToString(): String { /** * Returns `true` if the two specified arrays are *structurally* equal to one another, * i.e. contain the same number of the same elements in the same order. + * + * The elements are compared for equality with the [equals][Any.equals] function. + * For floating point numbers it means that `NaN` is equal to itself and `-0.0` is not equal to `0.0`. */ @SinceKotlin("1.1") public actual infix fun Array.contentEquals(other: Array): Boolean { @@ -191,6 +197,9 @@ public actual infix fun Array.contentEquals(other: Array): Boo /** * Returns `true` if the two specified arrays are *structurally* equal to one another, * i.e. contain the same number of the same elements in the same order. + * + * The elements are compared for equality with the [equals][Any.equals] function. + * For floating point numbers it means that `NaN` is equal to itself and `-0.0` is not equal to `0.0`. */ @SinceKotlin("1.1") public actual infix fun ByteArray.contentEquals(other: ByteArray): Boolean { @@ -205,6 +214,9 @@ public actual infix fun ByteArray.contentEquals(other: ByteArray): Boolean { /** * Returns `true` if the two specified arrays are *structurally* equal to one another, * i.e. contain the same number of the same elements in the same order. + * + * The elements are compared for equality with the [equals][Any.equals] function. + * For floating point numbers it means that `NaN` is equal to itself and `-0.0` is not equal to `0.0`. */ @SinceKotlin("1.1") public actual infix fun ShortArray.contentEquals(other: ShortArray): Boolean { @@ -219,6 +231,9 @@ public actual infix fun ShortArray.contentEquals(other: ShortArray): Boolean { /** * Returns `true` if the two specified arrays are *structurally* equal to one another, * i.e. contain the same number of the same elements in the same order. + * + * The elements are compared for equality with the [equals][Any.equals] function. + * For floating point numbers it means that `NaN` is equal to itself and `-0.0` is not equal to `0.0`. */ @SinceKotlin("1.1") public actual infix fun IntArray.contentEquals(other: IntArray): Boolean { @@ -233,6 +248,9 @@ public actual infix fun IntArray.contentEquals(other: IntArray): Boolean { /** * Returns `true` if the two specified arrays are *structurally* equal to one another, * i.e. contain the same number of the same elements in the same order. + * + * The elements are compared for equality with the [equals][Any.equals] function. + * For floating point numbers it means that `NaN` is equal to itself and `-0.0` is not equal to `0.0`. */ @SinceKotlin("1.1") public actual infix fun LongArray.contentEquals(other: LongArray): Boolean { @@ -247,6 +265,9 @@ public actual infix fun LongArray.contentEquals(other: LongArray): Boolean { /** * Returns `true` if the two specified arrays are *structurally* equal to one another, * i.e. contain the same number of the same elements in the same order. + * + * The elements are compared for equality with the [equals][Any.equals] function. + * For floating point numbers it means that `NaN` is equal to itself and `-0.0` is not equal to `0.0`. */ @SinceKotlin("1.1") public actual infix fun FloatArray.contentEquals(other: FloatArray): Boolean { @@ -261,6 +282,9 @@ public actual infix fun FloatArray.contentEquals(other: FloatArray): Boolean { /** * Returns `true` if the two specified arrays are *structurally* equal to one another, * i.e. contain the same number of the same elements in the same order. + * + * The elements are compared for equality with the [equals][Any.equals] function. + * For floating point numbers it means that `NaN` is equal to itself and `-0.0` is not equal to `0.0`. */ @SinceKotlin("1.1") public actual infix fun DoubleArray.contentEquals(other: DoubleArray): Boolean { @@ -275,6 +299,9 @@ public actual infix fun DoubleArray.contentEquals(other: DoubleArray): Boolean { /** * Returns `true` if the two specified arrays are *structurally* equal to one another, * i.e. contain the same number of the same elements in the same order. + * + * The elements are compared for equality with the [equals][Any.equals] function. + * For floating point numbers it means that `NaN` is equal to itself and `-0.0` is not equal to `0.0`. */ @SinceKotlin("1.1") public actual infix fun BooleanArray.contentEquals(other: BooleanArray): Boolean { @@ -289,6 +316,9 @@ public actual infix fun BooleanArray.contentEquals(other: BooleanArray): Boolean /** * Returns `true` if the two specified arrays are *structurally* equal to one another, * i.e. contain the same number of the same elements in the same order. + * + * The elements are compared for equality with the [equals][Any.equals] function. + * For floating point numbers it means that `NaN` is equal to itself and `-0.0` is not equal to `0.0`. */ @SinceKotlin("1.1") public actual infix fun CharArray.contentEquals(other: CharArray): Boolean { diff --git a/runtime/src/main/kotlin/generated/_CollectionsNative.kt b/runtime/src/main/kotlin/generated/_CollectionsNative.kt index 4425c54825f..b13abcf3abf 100644 --- a/runtime/src/main/kotlin/generated/_CollectionsNative.kt +++ b/runtime/src/main/kotlin/generated/_CollectionsNative.kt @@ -1,5 +1,5 @@ /* - * Copyright 2010-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license + * Copyright 2010-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license * that can be found in the license/LICENSE.txt file. */ diff --git a/runtime/src/main/kotlin/generated/_ComparisonsNative.kt b/runtime/src/main/kotlin/generated/_ComparisonsNative.kt index 89d706e8ff3..1ca15c2b85f 100644 --- a/runtime/src/main/kotlin/generated/_ComparisonsNative.kt +++ b/runtime/src/main/kotlin/generated/_ComparisonsNative.kt @@ -1,5 +1,5 @@ /* - * Copyright 2010-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license + * Copyright 2010-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license * that can be found in the license/LICENSE.txt file. */