From 831d2792073ffafd1002dbf38795fc314e20d2e0 Mon Sep 17 00:00:00 2001 From: Joshua Gleitze Date: Wed, 23 Dec 2020 16:21:19 +0100 Subject: [PATCH] Remove @throws Assertion Error kdoc from assertion functions --- .../atrium/api/fluent/en_GB/anyAssertions.kt | 11 -------- .../api/fluent/en_GB/arrayAssertions.kt | 2 +- .../fluent/en_GB/charSequenceAssertions.kt | 17 ------------ .../en_GB/charSequenceContainsCreators.kt | 13 ---------- .../charSequenceContainsCreatorsDeprecated.kt | 16 ------------ .../api/fluent/en_GB/collectionAssertions.kt | 4 --- .../api/fluent/en_GB/comparableAssertions.kt | 5 ---- .../api/fluent/en_GB/featureAssertions.kt | 9 ------- .../fluent/en_GB/floatingPointAssertions.kt | 2 -- .../atrium/api/fluent/en_GB/fun0Assertions.kt | 4 --- .../api/fluent/en_GB/iterableAssertions.kt | 17 ------------ .../iterableContainsInAnyOrderCreators.kt | 6 ----- .../iterableContainsInAnyOrderOnlyCreators.kt | 6 ----- .../iterableContainsInOrderOnlyCreators.kt | 6 ----- ...rableContainsInOrderOnlyGroupedCreators.kt | 2 -- .../iterableLikeContainsInAnyOrderCreators.kt | 5 ---- ...rableLikeContainsInAnyOrderOnlyCreators.kt | 5 ---- ...iterableLikeContainsInOrderOnlyCreators.kt | 5 ---- ...eLikeContainsInOrderOnlyGroupedCreators.kt | 2 -- .../api/fluent/en_GB/iteratorAssertions.kt | 2 -- .../atrium/api/fluent/en_GB/listAssertions.kt | 2 -- .../atrium/api/fluent/en_GB/mapAssertions.kt | 15 ----------- .../en_GB/mapCollectionLikeAssertions.kt | 1 - .../api/fluent/en_GB/mapEntryAssertions.kt | 3 --- .../mapLikeContainsInAnyOrderCreators.kt | 5 ---- .../mapLikeContainsInAnyOrderOnlyCreators.kt | 5 ---- .../mapLikeContainsInOrderOnlyCreators.kt | 5 ---- .../atrium/api/fluent/en_GB/pairAssertions.kt | 2 -- .../api/fluent/en_GB/throwableAssertions.kt | 5 ---- .../api/fluent/en_GB/bigDecimalAssertions.kt | 5 ---- .../fluent/en_GB/chronoLocalDateAssertions.kt | 10 ------- .../en_GB/chronoLocalDateTimeAssertions.kt | 10 ------- .../en_GB/chronoZonedDateTimeAssertions.kt | 10 ------- .../en_GB/floatingPointJvmAssertions.kt | 1 - .../api/fluent/en_GB/localDateAssertions.kt | 4 --- .../fluent/en_GB/localDateTimeAssertions.kt | 4 --- .../api/fluent/en_GB/optionalAssertions.kt | 3 --- .../atrium/api/fluent/en_GB/pathAssertions.kt | 24 ----------------- .../fluent/en_GB/zonedDateTimeAssertions.kt | 4 --- .../en_GB/kotlin_1_3/resultAssertions.kt | 4 --- .../atrium/api/infix/en_GB/anyAssertions.kt | 11 -------- .../api/infix/en_GB/charSequenceAssertions.kt | 21 --------------- .../en_GB/charSequenceContainsCreators.kt | 17 ------------ .../charSequenceContainsCreatorsDeprecated.kt | 20 -------------- .../api/infix/en_GB/collectionAssertions.kt | 4 --- .../api/infix/en_GB/comparableAssertions.kt | 5 ---- .../infix/en_GB/creating/feature/Feature.kt | 2 +- .../api/infix/en_GB/featureAssertions.kt | 1 - .../atrium/api/infix/en_GB/fun0Assertions.kt | 4 --- .../api/infix/en_GB/iterableAssertions.kt | 22 +--------------- .../iterableContainsInAnyOrderCreators.kt | 6 ----- .../iterableContainsInAnyOrderOnlyCreators.kt | 6 ----- .../iterableContainsInOrderOnlyCreators.kt | 6 ----- ...rableContainsInOrderOnlyGroupedCreators.kt | 2 -- .../iterableLikeContainsInAnyOrderCreators.kt | 5 ---- ...rableLikeContainsInAnyOrderOnlyCreators.kt | 5 ---- ...iterableLikeContainsInOrderOnlyCreators.kt | 5 ---- ...eLikeContainsInOrderOnlyGroupedCreators.kt | 2 -- .../api/infix/en_GB/iteratorAssertions.kt | 2 -- .../atrium/api/infix/en_GB/listAssertions.kt | 3 --- .../atrium/api/infix/en_GB/mapAssertions.kt | 19 -------------- .../en_GB/mapCollectionLikeAssertions.kt | 1 - .../api/infix/en_GB/mapEntryAssertions.kt | 3 --- .../mapLikeContainsInAnyOrderCreators.kt | 5 ---- .../mapLikeContainsInAnyOrderOnlyCreators.kt | 5 ---- .../mapLikeContainsInOrderOnlyCreators.kt | 5 ---- .../atrium/api/infix/en_GB/pairAssertions.kt | 2 -- .../api/infix/en_GB/throwableAssertions.kt | 6 ----- .../api/infix/en_GB/bigDecimalAssertions.kt | 15 ++++------- .../infix/en_GB/chronoLocalDateAssertions.kt | 10 ------- .../en_GB/chronoLocalDateTimeAssertions.kt | 10 ------- .../en_GB/chronoZonedDateTimeAssertions.kt | 10 ------- .../api/infix/en_GB/localDateAssertions.kt | 4 --- .../infix/en_GB/localDateTimeAssertions.kt | 4 --- .../api/infix/en_GB/optionalAssertions.kt | 3 --- .../atrium/api/infix/en_GB/pathAssertions.kt | 26 ------------------- .../infix/en_GB/zonedDateTimeAssertions.kt | 4 --- .../en_GB/kotlin_1_3/resultAssertions.kt | 4 --- .../ch/tutteli/atrium/creating/Expect.kt | 9 ------- 79 files changed, 8 insertions(+), 547 deletions(-) diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/anyAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/anyAssertions.kt index 980bbdfd15..066a5d4964 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/anyAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/anyAssertions.kt @@ -11,7 +11,6 @@ import ch.tutteli.kbox.glue * Expects that the subject of the assertion is (equal to) [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.AnyAssertionSamples.toBe */ @@ -21,7 +20,6 @@ fun Expect.toBe(expected: T): Expect = _logicAppend { toBe(expected) } * Expects that the subject of the assertion is not (equal to) [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.AnyAssertionSamples.notToBe */ @@ -31,7 +29,6 @@ fun Expect.notToBe(expected: T): Expect = _logicAppend { notToBe(expec * Expects that the subject of the assertion is the same instance as [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.AnyAssertionSamples.isSameAs */ @@ -41,7 +38,6 @@ fun Expect.isSameAs(expected: T): Expect = _logicAppend { isSameAs(exp * Expects that the subject of the assertion is not the same instance as [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.AnyAssertionSamples.isNotSameAs */ @@ -67,7 +63,6 @@ fun Expect.because(reason: String, assertionCreator: Expect.() -> Unit * is `null` or is not `null` and holds all assertions [assertionCreatorOrNull] creates. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.AnyAssertionSamples.toBeNullIfNullGivenElse */ @@ -79,7 +74,6 @@ fun Expect.toBeNullIfNullGivenElse( * Expects that the subject of the assertion is not null and changes the subject to the non-nullable version. * * @return An [Expect] with the non-nullable type [T] (was `T?` before). - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.AnyAssertionSamples.notToBeNullFeature */ @@ -91,7 +85,6 @@ inline fun Expect.notToBeNull(): Expect = * that it holds all assertions the given [assertionCreator] creates. * * @return An [Expect] with the non-nullable type [T] (was `T?` before) - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.AnyAssertionSamples.notToBeNull */ @@ -115,7 +108,6 @@ inline fun Expect.notToBeNull(noinline assertionCreator: E * `assert(listOf(1, 2)).isA>{}` holds, even though `List` is clearly not a `List`. * * @return An [Expect] with the new type [TSub]. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.AnyAssertionSamples.isAFeature */ @@ -161,7 +153,6 @@ inline fun Expect<*>.isA(): Expect = * `assert(listOf(1, 2)).isA>{}` holds, even though `List` is clearly not a `List`. * * @return An [Expect] with the new type [TSub]. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.AnyAssertionSamples.isA */ @@ -200,7 +191,6 @@ infix fun Expect.and(assertionCreator: Expect.() -> Unit): Expect = * Expects that the subject of the assertion is not (equal to) [expected] and [otherValues]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 * @@ -216,7 +206,6 @@ fun Expect.isNoneOf(expected: T, vararg otherValues: T): Expect = * are passed. This function expects [IterableLike] (which is a typealias for [Any]) to avoid cluttering the API. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case the iterable is empty. * * @since 0.13.0 diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/arrayAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/arrayAssertions.kt index 478a474d05..c1c855dddf 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/arrayAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/arrayAssertions.kt @@ -283,7 +283,7 @@ fun Expect.asList(): Expect> = * @return The newly created [Expect] for the transformed subject. * * @since 0.9.0 - + * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.ArrayAssertionSamples.doubleArrAsList */ @JvmName("doubleArrAsList") diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceAssertions.kt index 673c117365..74808052f4 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceAssertions.kt @@ -58,7 +58,6 @@ val Expect.containsNot: NotCheckerStep Expect.contains( * so that you can mix [String] and [Int] for instance. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CharSequenceAssertionsSpec.containsNot */ @@ -110,7 +108,6 @@ fun Expect.containsNot( * @param otherPatterns Additional patterns which are expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CharSequenceAssertionsSpec.containsRegexString */ @@ -138,7 +135,6 @@ fun Expect.containsRegex(pattern: String, vararg otherPatt * @param otherPatterns Additional patterns which are expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 * @@ -151,7 +147,6 @@ fun Expect.containsRegex(pattern: Regex, vararg otherPatte * Expects that the subject of the assertion (a [CharSequence]) starts with [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CharSequenceAssertionsSpec.startsWith */ @@ -162,7 +157,6 @@ fun Expect.startsWith(expected: CharSequence): Expect = * Expects that the subject of the assertion (a [CharSequence]) starts with [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CharSequenceAssertionsSpec.startsWithChar * @@ -175,7 +169,6 @@ fun Expect.startsWith(expected: Char): Expect = * Expects that the subject of the assertion (a [CharSequence]) does not start with [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CharSequenceAssertionsSpec.startsNotWith */ @@ -186,7 +179,6 @@ fun Expect.startsNotWith(expected: CharSequence): Expect Expect.startsNotWith(expected: Char): Expect = * Expects that the subject of the assertion (a [CharSequence]) ends with [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CharSequenceAssertionsSpec.endsWith */ @@ -211,7 +202,6 @@ fun Expect.endsWith(expected: CharSequence): Expect = * Expects that the subject of the assertion (a [CharSequence]) ends with [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 * @@ -224,7 +214,6 @@ fun Expect.endsWith(expected: Char): Expect = * Expects that the subject of the assertion (a [CharSequence]) does not end with [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CharSequenceAssertionsSpec.endsNotWith */ @@ -235,7 +224,6 @@ fun Expect.endsNotWith(expected: CharSequence): Expect * Expects that the subject of the assertion (a [CharSequence]) does not end with [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CharSequenceAssertionsSpec.endsNotWithChar @@ -248,7 +236,6 @@ fun Expect.endsNotWith(expected: Char): Expect = * Expects that the subject of the assertion (a [CharSequence]) [CharSequence].[kotlin.text.isEmpty]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CharSequenceAssertionsSpec.isEmpty */ @@ -259,7 +246,6 @@ fun Expect.isEmpty(): Expect = * Expects that the subject of the assertion (a [CharSequence]) [CharSequence].[kotlin.text.isNotEmpty]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CharSequenceAssertionsSpec.isNotEmpty */ @@ -270,7 +256,6 @@ fun Expect.isNotEmpty(): Expect = * Expects that the subject of the assertion (a [CharSequence]) [CharSequence].[kotlin.text.isNotBlank]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CharSequenceAssertionsSpec.isNotBlank */ @@ -283,7 +268,6 @@ fun Expect.isNotBlank(): Expect = * In contrast to [containsRegex] it does not look for a partial match but for an entire match. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 * @@ -298,7 +282,6 @@ fun Expect.matches(expected: Regex): Expect = * In contrast to `containsNot.regex` it does not look for a partial match but for an entire match. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 * diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceContainsCreators.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceContainsCreators.kt index e8a34b76d0..7df74c2f74 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceContainsCreators.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceContainsCreators.kt @@ -37,7 +37,6 @@ import kotlin.jvm.JvmName * @param expected The value which is expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ fun CheckerStep.value(expected: CharSequenceOrNumberOrChar): Expect = @@ -66,7 +65,6 @@ fun CheckerStep.value(expected: CharS * @param otherExpected Additional values which are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] or one of the [otherExpected] is not a * [CharSequence], [Number] or [Char]. */ @@ -91,7 +89,6 @@ fun CheckerStep.values( * @param expected The value which is expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ @JvmName("valueIgnoringCase") @@ -122,7 +119,6 @@ fun CheckerStep.value( * @param otherExpected Additional values which are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] or one of the [otherExpected] is not a * [CharSequence], [Number] or [Char]. */ @@ -148,7 +144,6 @@ fun CheckerStep.values( * @param expected The value which is expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ fun EntryPointStep.value(expected: CharSequenceOrNumberOrChar): Expect = @@ -174,7 +169,6 @@ fun EntryPointStep.value(expe * @param otherExpected Additional values which are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] or one of the [otherExpected] is not a * [CharSequence], [Number] or [Char]. */ @@ -202,7 +196,6 @@ fun EntryPointStep.values( * @param otherPatterns Additional patterns which are expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun CheckerStep.regex( pattern: String, @@ -228,7 +221,6 @@ fun CheckerStep.regex( * @param otherPatterns Additional patterns which are expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -257,7 +249,6 @@ fun CheckerStep.regex( * @param otherPatterns Additional patterns which are expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @JvmName("regexIgnoringCase") fun CheckerStep.regex( @@ -287,7 +278,6 @@ fun CheckerStep.regex( * @param otherPatterns Additional patterns which are expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun EntryPointStep.regex( pattern: String, @@ -309,7 +299,6 @@ fun EntryPointStep.regex( * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * @@ -337,7 +326,6 @@ fun CheckerStep.elementsOf( * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * @@ -365,7 +353,6 @@ fun CheckerStep.elementsOf( * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceContainsCreatorsDeprecated.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceContainsCreatorsDeprecated.kt index 64a3c83e6a..a425c0619c 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceContainsCreatorsDeprecated.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceContainsCreatorsDeprecated.kt @@ -34,7 +34,6 @@ import kotlin.jvm.JvmName * @param expected The value which is expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ fun CheckerOption.value(expected: CharSequenceOrNumberOrChar): Expect = @@ -63,7 +62,6 @@ fun CheckerOption.value(expected: Cha * @param otherExpected Additional values which are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] or one of the [otherExpected] is not a * [CharSequence], [Number] or [Char]. */ @@ -88,7 +86,6 @@ fun CheckerOption.values( * @param expected The value which is expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ @JvmName("valueIgnoringCase") @@ -119,7 +116,6 @@ fun CheckerOption.value( * @param otherExpected Additional values which are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] or one of the [otherExpected] is not a * [CharSequence], [Number] or [Char]. */ @@ -145,7 +141,6 @@ fun CheckerOption.values( * @param expected The value which is expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ fun Builder.value(expected: CharSequenceOrNumberOrChar): Expect = @@ -171,7 +166,6 @@ fun Builder.value(expected: C * @param otherExpected Additional values which are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] or one of the [otherExpected] is not a * [CharSequence], [Number] or [Char]. */ @@ -199,7 +193,6 @@ fun Builder.values( * @param otherPatterns Additional patterns which are expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun CheckerOption.regex( pattern: String, @@ -225,7 +218,6 @@ fun CheckerOption.regex( * @param otherPatterns Additional patterns which are expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -254,7 +246,6 @@ fun CheckerOption.regex( * @param otherPatterns Additional patterns which are expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @JvmName("regexIgnoringCase") fun CheckerOption.regex( @@ -284,7 +275,6 @@ fun CheckerOption.regex( * @param otherPatterns Additional patterns which are expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Builder.regex( pattern: String, @@ -307,7 +297,6 @@ fun Builder.regex( * @param expectedIterable The [Iterable] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterable] is not a [CharSequence], [Number] or [Char] or the given * [expectedIterable] does not have elements (is empty). * @@ -337,7 +326,6 @@ fun CheckerOption.elementsOf( * @param expectedIterable The [Iterable] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterable] is not a [CharSequence], [Number] or [Char] or the given * [expectedIterable] does not have elements (is empty). * @@ -368,7 +356,6 @@ fun CheckerOption.elementsOf( * @param expectedIterable The [Iterable] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterable] is not a [CharSequence], [Number] or [Char] or the given * [expectedIterable] does not have elements (is empty). * @@ -398,7 +385,6 @@ fun Builder.elementsOf( * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * @@ -426,7 +412,6 @@ fun CheckerOption.elementsOf( * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * @@ -455,7 +440,6 @@ fun CheckerOption.elementsOf( * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/collectionAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/collectionAssertions.kt index 3c4af1aa2e..7937a1a3f9 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/collectionAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/collectionAssertions.kt @@ -12,7 +12,6 @@ import ch.tutteli.kbox.identity * Expects that the subject of the assertion (a [Collection]) is an empty [Collection]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CollectionAssertionSamples.isEmpty */ @@ -23,7 +22,6 @@ fun > Expect.isEmpty(): Expect = * Expects that the subject of the assertion (a [Collection]) is not an empty [Collection]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CollectionAssertionSamples.isNotEmpty */ @@ -36,7 +34,6 @@ fun > Expect.isNotEmpty(): Expect = * Shortcut for `size.toBe(expected)`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CollectionAssertionSamples.hasSize */ @@ -60,7 +57,6 @@ val > Expect.size: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.CollectionAssertionSamples.size */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/comparableAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/comparableAssertions.kt index 182a67d307..b07c98d643 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/comparableAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/comparableAssertions.kt @@ -8,7 +8,6 @@ import ch.tutteli.atrium.logic.* * The comparison is carried out with [Comparable.compareTo]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.ComparableAssertionSamples.isLessThan */ @@ -20,7 +19,6 @@ fun > Expect.isLessThan(expected: T): Expect = * The comparison is carried out with [Comparable.compareTo]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.ComparableAssertionSamples.isLessThanOrEqual */ @@ -32,7 +30,6 @@ fun > Expect.isLessThanOrEqual(expected: T): Expect = * The comparison is carried out with [Comparable.compareTo]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.ComparableAssertionSamples.isGreaterThan */ @@ -44,7 +41,6 @@ fun > Expect.isGreaterThan(expected: T): Expect = * The comparison is carried out with [Comparable.compareTo]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.ComparableAssertionSamples.isGreaterThanOrEqual */ @@ -56,7 +52,6 @@ fun > Expect.isGreaterThanOrEqual(expected: T): Expect = * where the comparison is carried out with [Comparable.compareTo]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 * diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/featureAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/featureAssertions.kt index f320174453..c603dea60a 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/featureAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/featureAssertions.kt @@ -27,7 +27,6 @@ fun Expect.feature(property: KProperty1): FeatureExpect * returns the initial [Expect] with the current subject. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 */ @@ -57,7 +56,6 @@ fun Expect.feature(f: KFunction1): FeatureExpect = * returns the initial [Expect] with the current subject. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 */ @@ -91,7 +89,6 @@ fun Expect.feature( * returns the initial [Expect] with the current subject. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 */ @@ -126,7 +123,6 @@ fun Expect.feature( * returns the initial [Expect] with the current subject. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 */ @@ -161,7 +157,6 @@ fun Expect.feature( * returns the initial [Expect] with the current subject. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 */ @@ -196,7 +191,6 @@ fun Expect.feature( * returns the initial [Expect] with the current subject. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 */ @@ -230,7 +224,6 @@ fun Expect.feature( * returns the initial [Expect] with the current subject. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 */ @@ -268,7 +261,6 @@ fun Expect.feature(description: String, provider: T.() -> R): FeatureE * implicit parameter `it`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 */ @@ -307,7 +299,6 @@ fun Expect.feature(provider: MetaFeatureOption.(T) -> MetaFeature.toBeWithErrorTolerance(expected: Float, tolerance: Float): Exp * | `subject of the assertion` - [expected] | ≤ [tolerance] * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.FloatingPointAssertionSamples.toBeWithErrorToleranceDouble */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/fun0Assertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/fun0Assertions.kt index c4f30e89b1..3cf8c42185 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/fun0Assertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/fun0Assertions.kt @@ -13,7 +13,6 @@ import ch.tutteli.atrium.logic.toThrow * the element type is actually `String`. * * @return An [Expect] with the new type [TExpected]. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline fun Expect Any?>.toThrow(): Expect = _logic.toThrow(TExpected::class).transform() @@ -49,7 +48,6 @@ inline fun Expect Any?>.toThrow(): Exp * the element type is actually `String`. * * @return An [Expect] with the new type [TExpected]. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline fun Expect Any?>.toThrow( noinline assertionCreator: Expect.() -> Unit @@ -61,7 +59,6 @@ inline fun Expect Any?>.toThrow( * and changes the subject of the assertion to the return value of type [R]. * * @return An [Expect] with the new type [R]. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun R> Expect.notToThrow(): Expect = _logic.notToThrow().transform() @@ -71,7 +68,6 @@ fun R> Expect.notToThrow(): Expect = * and that the corresponding return value holds all assertions the given [assertionCreator] creates. * * @return An [Expect] with the new type [R]. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun R> Expect.notToThrow( assertionCreator: Expect.() -> Unit diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableAssertions.kt index 1cd972d666..30ed8a1b4b 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableAssertions.kt @@ -48,7 +48,6 @@ val > Expect.containsNot: NotCheckerStep> Expect.contains(expected: E, vararg otherExpected: E): Expect = contains.inAnyOrder.atLeast(1).values(expected, *otherExpected) @@ -65,7 +64,6 @@ fun > Expect.contains(expected: E, vararg otherExpected: E * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.contains(assertionCreatorOrNull: (Expect.() -> Unit)?): Expect = contains.inAnyOrder.atLeast(1).entry(assertionCreatorOrNull) @@ -85,7 +83,6 @@ fun > Expect.contains(assertionCreatorOrNull: (Expe * which we are looking for (see [assertionCreatorOrNull] for more information). * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.contains( assertionCreatorOrNull: (Expect.() -> Unit)?, @@ -103,7 +100,6 @@ fun > Expect.contains( * [#292](https://github.com/robstoll/atrium/issues/292) for more information) * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsExactly(expected: E, vararg otherExpected: E): Expect = contains.inOrder.only.values(expected, *otherExpected) @@ -124,7 +120,6 @@ fun > Expect.containsExactly(expected: E, vararg otherExpe * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsExactly(assertionCreatorOrNull: (Expect.() -> Unit)?): Expect = contains.inOrder.only.entry(assertionCreatorOrNull) @@ -148,7 +143,6 @@ fun > Expect.containsExactly(assertionCreatorOrNull * which we are looking for (see [assertionCreatorOrNull] for more information). * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsExactly( assertionCreatorOrNull: (Expect.() -> Unit)?, @@ -167,7 +161,6 @@ fun > Expect.containsExactly( * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within this [Iterable]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * @@ -187,7 +180,6 @@ inline fun > Expect.containsExactlyElementsOf( * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within this [Iterable]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * @@ -204,7 +196,6 @@ inline fun > Expect.containsElementsOf( * It is a shortcut for `containsNot.values(expected, *otherExpected)` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsNot(expected: E, vararg otherExpected: E): Expect = containsNot.values(expected, *otherExpected) @@ -227,7 +218,6 @@ fun , T : Iterable> Expect.min(): Expect = * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -251,7 +241,6 @@ fun , T : Iterable> Expect.max(): Expect = * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -267,7 +256,6 @@ fun , T : Iterable> Expect.max(assertionCreator: Expect< * It is a shortcut for `contains.inAnyOrder.atLeast(1).entry(assertionCreatorOrNull)` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.any(assertionCreatorOrNull: (Expect.() -> Unit)?): Expect = contains.inAnyOrder.atLeast(1).entry(assertionCreatorOrNull) @@ -280,7 +268,6 @@ fun > Expect.any(assertionCreatorOrNull: (Expect * It is a shortcut for `containsNot.entry(assertionCreatorOrNull)` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.none(assertionCreatorOrNull: (Expect.() -> Unit)?): Expect = containsNot.entry(assertionCreatorOrNull) @@ -291,7 +278,6 @@ fun > Expect.none(assertionCreatorOrNull: (Expect> Expect.all(assertionCreatorOrNull: (Expect.() -> Unit)?): Expect = _logicAppend { all(::identity, assertionCreatorOrNull) } @@ -301,7 +287,6 @@ fun > Expect.all(assertionCreatorOrNull: (Expect * Expects that the subject of the assertion (an [Iterable]) has at least one element. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -312,7 +297,6 @@ fun > Expect.hasNext(): Expect = * Expects that the subject of the assertion (an [Iterable]) does not have next element. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -323,7 +307,6 @@ fun > Expect.hasNotNext(): Expect = * Expects that the subject of the assertion (an [Iterable]) does not have duplicate elements. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableContainsInAnyOrderCreators.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableContainsInAnyOrderCreators.kt index 4bc3e1335f..96be0d9b04 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableContainsInAnyOrderCreators.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableContainsInAnyOrderCreators.kt @@ -21,7 +21,6 @@ import ch.tutteli.kbox.glue * @param expected The value which is expected to be contained within this [Iterable]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > CheckerOption.value(expected: E): Expect = values(expected) @@ -44,7 +43,6 @@ fun > CheckerOption.value(ex * @param otherExpected Additional objects which are expected to be contained within this [Iterable]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > CheckerOption.values( expected: E, @@ -63,7 +61,6 @@ fun > CheckerOption.values( * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > CheckerOption.entry( assertionCreatorOrNull: (Expect.() -> Unit)? @@ -82,7 +79,6 @@ fun > CheckerOption. * which we are looking for (see [assertionCreatorOrNull] for more information). * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > CheckerOption.entries( assertionCreatorOrNull: (Expect.() -> Unit)?, @@ -104,7 +100,6 @@ fun > CheckerOption. * @param expectedIterable The [Iterable] whose elements are expected to be contained within this [Iterable]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case the given [expectedIterable] does not have elements (is empty). * * @since 0.9.0 @@ -130,7 +125,6 @@ inline fun > CheckerOption> Builder.value(expected: E): Expect = values(expected) @@ -44,7 +43,6 @@ fun > Builder.value(expe * @param otherExpected Additional values which are expected to be contained within [Iterable]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Builder.values( expected: E, @@ -67,7 +65,6 @@ fun > Builder.values( * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Builder.entry( assertionCreatorOrNull: (Expect.() -> Unit)? @@ -99,7 +96,6 @@ fun > Builder.en * which we are looking for (see [assertionCreatorOrNull] for more information). * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Builder.entries( assertionCreatorOrNull: (Expect.() -> Unit)?, @@ -125,7 +121,6 @@ fun > Builder.en * @param expectedIterable The [Iterable] whose elements are expected to be contained within this [Iterable] * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case the given [expectedIterable] does not have elements (is empty). * * @since 0.9.0 @@ -155,7 +150,6 @@ inline fun > Builder> Builder.value(expected: E): Expect = values(expected) @@ -43,7 +42,6 @@ fun > Builder.value(expecte * @param otherExpected Additional values which are expected to be contained within [Iterable]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Builder.values( expected: E, @@ -66,7 +64,6 @@ fun > Builder.values( * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Builder.entry( assertionCreatorOrNull: (Expect.() -> Unit)? @@ -89,7 +86,6 @@ fun > Builder.entry * which we are looking for (see [assertionCreatorOrNull] for more information). * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Builder.entries( assertionCreatorOrNull: (Expect.() -> Unit)?, @@ -115,7 +111,6 @@ fun > Builder.entri * @param expectedIterable The [Iterable] whose elements are expected to be contained within this [Iterable]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case the given [expectedIterable] does not have elements (is empty). * * @since 0.9.0 @@ -145,7 +140,6 @@ inline fun > Builder> Builder.inAnyOrder( firstGroup: Group, @@ -52,7 +51,6 @@ fun > Builder. * [Iterable] whereas the groups have to appear in the given order. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @JvmName("inAnyOrderEntries") fun > Builder.inAnyOrder( diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeContainsInAnyOrderCreators.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeContainsInAnyOrderCreators.kt index 30794cccf6..1974777fe2 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeContainsInAnyOrderCreators.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeContainsInAnyOrderCreators.kt @@ -21,7 +21,6 @@ import ch.tutteli.kbox.glue * @param expected The value which is expected to be contained within this [IterableLike]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -47,7 +46,6 @@ fun CheckerStep.value(expe * @param otherExpected Additional objects which are expected to be contained within this [IterableLike]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -68,7 +66,6 @@ fun CheckerStep.values( * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -90,7 +87,6 @@ fun CheckerStep * which we are looking for (see [assertionCreatorOrNull] for more information). * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -114,7 +110,6 @@ fun CheckerStep * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within this [IterableLike]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not * an [Iterable], [Sequence] or one of the [Array] types * or the given [expectedIterableLike] does not have elements (is empty). diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeContainsInAnyOrderOnlyCreators.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeContainsInAnyOrderOnlyCreators.kt index c3f24803b1..780b9eb333 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeContainsInAnyOrderOnlyCreators.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeContainsInAnyOrderOnlyCreators.kt @@ -27,7 +27,6 @@ import ch.tutteli.kbox.glue * @param expected The value which is expected to be contained within the subject (an [IterableLike]). * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -47,7 +46,6 @@ fun EntryPointStep.val * @param otherExpected Additional values which are expected to be contained within [IterableLike]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -72,7 +70,6 @@ fun EntryPointStep.val * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -106,7 +103,6 @@ fun EntryPointStep EntryPointStep EntryPointStep.value * @param otherExpected Additional values which are expected to be contained within [IterableLike]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -70,7 +68,6 @@ fun EntryPointStep.value * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -96,7 +93,6 @@ fun EntryPointStep EntryPointStep EntryPointStep> Expect.hasNext(): Expect = * Expects that the subject of the assertion (an [Iterator]) does not have a next element. * * @return an [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 * diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/listAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/listAssertions.kt index 94079be77f..e61fa23c35 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/listAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/listAssertions.kt @@ -9,7 +9,6 @@ import ch.tutteli.atrium.logic.get * returns an [Expect] for the element at that position. * * @return The newly created [Expect] for the element at position [index]. - * @throws AssertionError Might throw an [AssertionError] if the given [index] is out of bound. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.ListAssertionSamples.getFeature */ @@ -21,7 +20,6 @@ fun > Expect.get(index: Int): Expect = * the element at that position holds all assertions the given [assertionCreator] creates for it. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the given [index] is out of bound. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.ListAssertionSamples.get */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapAssertions.kt index 7b65c4ab43..dfe880bc65 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapAssertions.kt @@ -29,7 +29,6 @@ val > Expect.contains: MapLikeContains.EntryPointStep * even though they match the same entry. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.contains( keyValuePair: Pair, @@ -44,7 +43,6 @@ fun > Expect.contains( * Delegates to `contains.inAnyOrder.only.entries(keyValuePair, *otherPairs)` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsOnly( keyValuePair: Pair, @@ -65,7 +63,6 @@ fun > Expect.containsOnly( * , then both match, even though they match the same entry. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline fun > Expect.contains( keyValue: KeyValue, @@ -82,7 +79,6 @@ inline fun > Expect.contains( * Delegates to `contains.inAnyOrder.only.entries(keyValue, *otherKeyValues)` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline fun > Expect.containsOnly( keyValue: KeyValue, @@ -95,7 +91,6 @@ inline fun > Expect.containsOnly( * Delegates to ` contains.inAnyOrder.entriesOf` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsEntriesOf( mapLike: MapLike @@ -108,7 +103,6 @@ fun > Expect.containsEntriesOf( * Delegates to `contains.inAnyOrder.only.entriesOf` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsOnlyEntriesOf( mapLike: MapLike @@ -118,7 +112,6 @@ fun > Expect.containsOnlyEntriesOf( * Expects that the subject of the assertion (a [Map]) contains the given [key]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsKey(key: K): Expect = _logicAppend { containsKey(::identity, key) } @@ -127,7 +120,6 @@ fun > Expect.containsKey(key: K): Expect = * Expects that the subject of the assertion (a [Map]) does not contain the given [key]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsNotKey(key: K): Expect = _logicAppend { containsNotKey(::identity, key) } @@ -138,7 +130,6 @@ fun > Expect.containsNotKey(key: K): Expect = * so that further fluent calls are assertions about it. * * @return The newly created [Expect] for the extracted feature. - * @throws AssertionError Might throw an [AssertionError] if the given [key] does not exist. */ fun > Expect.getExisting(key: K): Expect = _logic.getExisting(::identity, key).transform() @@ -148,8 +139,6 @@ fun > Expect.getExisting(key: K): Expect = * the corresponding value holds all assertions the given [assertionCreator] creates for it. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if a created [Assertion]s (by calling [assertionCreator]) - * does not hold. */ fun > Expect.getExisting(key: K, assertionCreator: Expect.() -> Unit): Expect = _logic.getExisting(::identity, key).collectAndAppend(assertionCreator) @@ -169,7 +158,6 @@ val > Expect.keys: Expect> * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.keys(assertionCreator: Expect>.() -> Unit): Expect = _logic.property(Map::keys).collectAndAppend(assertionCreator) @@ -189,7 +177,6 @@ val > Expect.values: Expect> * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.values(assertionCreator: Expect>.() -> Unit): Expect = _logic.property(Map::values).collectAndAppend(assertionCreator) @@ -224,7 +211,6 @@ fun > Expect.asEntries( * Expects that the subject of the assertion (a [Map]) is an empty [Map]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.isEmpty(): Expect = _logicAppend { isEmpty(::toEntries) } @@ -234,7 +220,6 @@ fun > Expect.isEmpty(): Expect = * Expects that the subject of the assertion (a [Map]) is not an empty [Map]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.isNotEmpty(): Expect = _logicAppend { isNotEmpty(::toEntries) } diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapCollectionLikeAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapCollectionLikeAssertions.kt index c9372d70a9..a3c3c67208 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapCollectionLikeAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapCollectionLikeAssertions.kt @@ -22,7 +22,6 @@ val > Expect.size: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapEntryAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapEntryAssertions.kt index f5628be280..45048d73a1 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapEntryAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapEntryAssertions.kt @@ -12,7 +12,6 @@ import ch.tutteli.atrium.logic.* * reporting etc. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.isKeyValue(key: K, value: V): Expect = _logicAppend { isKeyValue(key, value) } @@ -32,7 +31,6 @@ val > Expect.key: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.key(assertionCreator: Expect.() -> Unit): Expect = _logic.key().collectAndAppend(assertionCreator) @@ -52,7 +50,6 @@ val > Expect.value: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.value(assertionCreator: Expect.() -> Unit): Expect = _logic.value().collectAndAppend(assertionCreator) diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapLikeContainsInAnyOrderCreators.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapLikeContainsInAnyOrderCreators.kt index 812f98ae9b..493cfca2f5 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapLikeContainsInAnyOrderCreators.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapLikeContainsInAnyOrderCreators.kt @@ -18,7 +18,6 @@ import ch.tutteli.kbox.glue * Delegates to [entries]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ @@ -35,7 +34,6 @@ fun EntryPointStep.entry * even though they match the same entry. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ @@ -54,7 +52,6 @@ fun EntryPointStep.entri * Delegates to [entries]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ @@ -75,7 +72,6 @@ inline fun EntryPointStep EntryPointStep EntryPointStep.e * in which order they appear. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ @@ -51,7 +49,6 @@ fun EntryPointStep.e * Delegates to [entries]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ @@ -68,7 +65,6 @@ inline fun EntryPointStep EntryPointStep EntryPointStep.entr * needs to contain only the given [keyValuePair] as well as the [otherPairs] in the specified order. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ @@ -54,7 +52,6 @@ fun EntryPointStep.entr * Delegates to [entries]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ @@ -72,7 +69,6 @@ inline fun EntryPointStep EntryPointStep> Expect.first: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.PairAssertionSamples.first */ @@ -46,7 +45,6 @@ val > Expect.second: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.PairAssertionSamples.second */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/throwableAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/throwableAssertions.kt index 6a4d385e41..77d75d067e 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/throwableAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/throwableAssertions.kt @@ -10,7 +10,6 @@ import ch.tutteli.atrium.logic.causeIsA * creates an [Expect] for it and returns it. * * @return The newly created [Expect] for the property [Throwable.message] of the subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ val Expect.message: Expect get() = feature(Throwable::message).notToBeNull() @@ -21,7 +20,6 @@ val Expect.message: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.message(assertionCreator: Expect.() -> Unit): Expect = feature(Throwable::message) { notToBeNull(assertionCreator) } @@ -39,7 +37,6 @@ fun Expect.message(assertionCreator: Expect.() -> Uni * so that you can mix [String] and [Int] for instance. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.messageContains( expected: CharSequenceOrNumberOrChar, @@ -52,7 +49,6 @@ fun Expect.messageContains( * creates an [Expect] of the [TExpected] type for it and returns it. * * @return The newly created [Expect] for the property [Throwable.cause] of the subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 */ @@ -68,7 +64,6 @@ inline fun Expect.cause(): Expect * [Expect] of the initial type, which was some type `T `, but an [Expect] of the specified type [TExpected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/bigDecimalAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/bigDecimalAssertions.kt index f61ff3dec9..009d382579 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/bigDecimalAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/bigDecimalAssertions.kt @@ -49,7 +49,6 @@ fun Expect.toBe(expected: T): Nothing = throw PleaseUseRepl * Expects that the subject of the assertion (a [BigDecimal]) is `null`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.BigDecimalAssertionSamples.toBe */ @@ -92,7 +91,6 @@ fun Expect.notToBe(expected: T): Nothing = throw PleaseUseRe * - `expect(BigDecimal("10")).isNumericallyEqualTo(BigDecimal("10.0"))` holds. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isNumericallyEqualTo(expected: T): Expect = _logicAppend { isNumericallyEqualTo(expected) } @@ -110,7 +108,6 @@ fun Expect.isNumericallyEqualTo(expected: T): Expect = * - `expect(BigDecimal("10")).isNotNumericallyEqualTo(BigDecimal("10.0"))` does not hold. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isNotNumericallyEqualTo(expected: T): Expect = _logicAppend { isNotNumericallyEqualTo(expected) } @@ -125,7 +122,6 @@ fun Expect.isNotNumericallyEqualTo(expected: T): Expect = * - `expect(BigDecimal("10")).isNumericallyEqualTo(BigDecimal("10.0"))` holds. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isEqualIncludingScale(expected: T): Expect = _logicAppend { isEqualIncludingScale(expected, this::isNumericallyEqualTo.name) } @@ -140,7 +136,6 @@ fun Expect.isEqualIncludingScale(expected: T): Expect = * - `expect(BigDecimal("10")).isNotNumericallyEqualTo(BigDecimal("10.0"))` does not hold. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isNotEqualIncludingScale(expected: T): Expect = _logicAppend { isNotEqualIncludingScale(expected) } diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoLocalDateAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoLocalDateAssertions.kt index b9b5d423be..dc77863bc6 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoLocalDateAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoLocalDateAssertions.kt @@ -14,7 +14,6 @@ import java.time.chrono.ChronoLocalDate * is before the [expected] [ChronoLocalDate]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -26,7 +25,6 @@ fun Expect.isBefore(expected: ChronoLocalDate): Expect< * is before or equal the [expected] [ChronoLocalDate]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -38,7 +36,6 @@ fun Expect.isBeforeOrEqual(expected: ChronoLocalDate): * is after the [expected] [ChronoLocalDate]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -50,7 +47,6 @@ fun Expect.isAfter(expected: ChronoLocalDate): Expect Expect.isAfterOrEqual(expected: ChronoLocalDate): E * is equal to the [expected] [ChronoLocalDate]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -75,7 +70,6 @@ fun Expect.isEqual(expected: ChronoLocalDate): Expect Expect.isBefore(expected: String): Expect = * The [expected] parameter needs to be in the form of **yyyy-mm-dd** or else a [java.time.DateTimeException] will be thrown. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -101,7 +94,6 @@ fun Expect.isBeforeOrEqual(expected: String): Expect * The [expected] parameter needs to be in the form of **yyyy-mm-dd** or else a [java.time.DateTimeException] will be thrown. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -114,7 +106,6 @@ fun Expect.isAfter(expected: String): Expect = * The [expected] parameter needs to be in the form of **yyyy-mm-dd** or else a [java.time.DateTimeException] will be thrown. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -127,7 +118,6 @@ fun Expect.isAfterOrEqual(expected: String): Expect * The [expected] parameter needs to be in the form of **yyyy-mm-dd** or else a [java.time.DateTimeException] will be thrown. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoLocalDateTimeAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoLocalDateTimeAssertions.kt index 3441bccce9..4626a7375e 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoLocalDateTimeAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoLocalDateTimeAssertions.kt @@ -16,7 +16,6 @@ import java.time.chrono.ChronoLocalDateTime * is before the [expected] [ChronoLocalDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -29,7 +28,6 @@ fun > Expect.isBefore( * is before or equal the [expected] [ChronoLocalDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -42,7 +40,6 @@ fun > Expect.isBeforeOrEqual( * is after the [expected] [ChronoLocalDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -55,7 +52,6 @@ fun > Expect.isAfter( * is after or equal the [expected] [ChronoLocalDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -68,7 +64,6 @@ fun > Expect.isAfterOrEqual( * is equal to the [expected] [ChronoLocalDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -88,7 +83,6 @@ fun > Expect.isEqual( * yyyy-mm-dd * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ @@ -108,7 +102,6 @@ fun > Expect.isBefore( * yyyy-mm-dd * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ @@ -128,7 +121,6 @@ fun > Expect.isBeforeOrEqual( * yyyy-mm-dd * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ @@ -148,7 +140,6 @@ fun > Expect.isAfter( * yyyy-mm-dd * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ @@ -168,7 +159,6 @@ fun > Expect.isAfterOrEqual( * yyyy-mm-dd * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoZonedDateTimeAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoZonedDateTimeAssertions.kt index 49fe75d240..4c0d07cb07 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoZonedDateTimeAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoZonedDateTimeAssertions.kt @@ -15,7 +15,6 @@ import java.time.chrono.ChronoZonedDateTime * is before the [expected] [ChronoZonedDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -28,7 +27,6 @@ fun > Expect.isBefore( * is before or equals the [expected] [ChronoZonedDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -41,7 +39,6 @@ fun > Expect.isBeforeOrEqual( * is after the [expected] [ChronoZonedDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -54,7 +51,6 @@ fun > Expect.isAfter( * is after or equal the [expected] [ChronoZonedDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -67,7 +63,6 @@ fun > Expect.isAfterOrEqual( * is equal to the [expected] [ChronoZonedDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -101,7 +96,6 @@ fun > Expect.isEqual( * - 2020-01-02+01:30 * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -135,7 +129,6 @@ fun > Expect.isBefore( * - 2020-01-02+01:30 * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -169,7 +162,6 @@ fun > Expect.isBeforeOrEqual( * - 2020-01-02+01:30 * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -203,7 +195,6 @@ fun > Expect.isAfter( * - 2020-01-02+01:30 * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -237,7 +228,6 @@ fun > Expect.isAfterOrEqual( * - 2020-01-02+01:30 * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/floatingPointJvmAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/floatingPointJvmAssertions.kt index 2106b1ac0b..15118f7a54 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/floatingPointJvmAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/floatingPointJvmAssertions.kt @@ -22,7 +22,6 @@ import java.math.BigDecimal * | `subject of the assertion` - [expected] | ≤ [tolerance] * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.toBeWithErrorTolerance(expected: BigDecimal, tolerance: BigDecimal): Expect = _logicAppend { toBeWithErrorTolerance(expected, tolerance) } diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/localDateAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/localDateAssertions.kt index b014a0bd84..8eaec49983 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/localDateAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/localDateAssertions.kt @@ -26,7 +26,6 @@ val Expect.year: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -50,7 +49,6 @@ val Expect.month: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -74,7 +72,6 @@ val Expect.dayOfWeek: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -99,7 +96,6 @@ val Expect.day: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/localDateTimeAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/localDateTimeAssertions.kt index f2ff70b390..a8aa851e22 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/localDateTimeAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/localDateTimeAssertions.kt @@ -27,7 +27,6 @@ val Expect.year: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -51,7 +50,6 @@ val Expect.month: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -75,7 +73,6 @@ val Expect.dayOfWeek: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -99,7 +96,6 @@ val Expect.day: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/optionalAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/optionalAssertions.kt index 1f8bdb5a4c..a9cd334f61 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/optionalAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/optionalAssertions.kt @@ -19,7 +19,6 @@ import java.util.* * depends on the underlying implementation though. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -34,7 +33,6 @@ fun > Expect.isEmpty(): Expect = * depends on the underlying implementation though. * * @return The newly created [Expect] for the inner type [E]. - * @throws AssertionError Might throw an [AssertionError] if the given assertion is not a success. * * @since 0.9.0 */ @@ -46,7 +44,6 @@ fun > Expect.isPresent(): Expect = * that it holds all assertions the given [assertionCreator] creates. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the given assertions are not success. * * @since 0.9.0 */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/pathAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/pathAssertions.kt index d9cf321fe2..ebbb1ed15c 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/pathAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/pathAssertions.kt @@ -15,7 +15,6 @@ import java.nio.file.Path * Expects that the subject of the assertion (a [Path]) starts with the [expected] [Path]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -26,7 +25,6 @@ fun Expect.startsWith(expected: Path): Expect = * Expects that the subject of the assertion (a [Path]) does not start with the [expected] [Path]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -37,7 +35,6 @@ fun Expect.startsNotWith(expected: Path): Expect = * Expects that the subject of the assertion (a [Path]) ends with the expected [Path]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -49,7 +46,6 @@ fun Expect.endsWith(expected: Path): Expect = * * @param expected The [Path] provided to the assertion * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -64,7 +60,6 @@ fun Expect.endsNotWith(expected: Path): Expect = * then the search will continue at that location. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -79,7 +74,6 @@ fun Expect.exists(): Expect = * then the search will continue at that location. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -105,7 +99,6 @@ val Expect.fileName: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -118,7 +111,6 @@ fun Expect.fileName(assertionCreator: Expect.() -> Unit): * so that further fluent calls are assertions about it. * * @return The newly created [Expect] for the extracted feature. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -132,7 +124,6 @@ val Expect.fileNameWithoutExtension: Expect * and returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -144,7 +135,6 @@ fun Expect.fileNameWithoutExtension(assertionCreator: Expect Expect.parent: Expect * given [assertionCreator] creates for it and returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -168,7 +157,6 @@ fun Expect.parent(assertionCreator: Expect.() -> Unit): Expe * so that further fluent calls are assertions about it. * * @return The newly created [Expect] for the extracted feature. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 */ @@ -180,7 +168,6 @@ fun Expect.resolve(other: String): Expect = * given [assertionCreator] creates for it and returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 */ @@ -201,7 +188,6 @@ fun Expect.resolve(other: String, assertionCreator: Expect.( * take place. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -218,7 +204,6 @@ fun Expect.isReadable(): Expect = * at the location the link points at. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -240,7 +225,6 @@ fun Expect.isWritable(): Expect = * at the location the link points at. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -260,7 +244,6 @@ fun Expect.isExecutable(): Expect = * take place. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -280,7 +263,6 @@ fun Expect.isRegularFile(): Expect = * take place. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -292,7 +274,6 @@ fun Expect.isDirectory(): Expect = * meaning that the [Path] specified in this instance starts at the file system root. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -304,7 +285,6 @@ fun Expect.isAbsolute(): Expect = * meaning that the [Path] specified in this instance does not start at the file system root. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -326,7 +306,6 @@ fun Expect.isRelative(): Expect = * take place. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -352,7 +331,6 @@ val Expect.extension: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -367,7 +345,6 @@ fun Expect.extension(assertionCreator: Expect.() -> Unit): * @param targetCharset target file encoding - UTF-8 per default. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -382,7 +359,6 @@ fun Expect.hasSameTextualContentAs( * as [targetPath]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/zonedDateTimeAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/zonedDateTimeAssertions.kt index 4598511434..34c58f39e5 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/zonedDateTimeAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/zonedDateTimeAssertions.kt @@ -27,7 +27,6 @@ val Expect.year: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -51,7 +50,6 @@ val Expect.month: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -75,7 +73,6 @@ val Expect.dayOfWeek: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -99,7 +96,6 @@ val Expect.day: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ diff --git a/apis/fluent-en_GB/extensions/kotlin_1_3/atrium-api-fluent-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/kotlin_1_3/resultAssertions.kt b/apis/fluent-en_GB/extensions/kotlin_1_3/atrium-api-fluent-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/kotlin_1_3/resultAssertions.kt index ab7d74f4b0..bd6963531e 100644 --- a/apis/fluent-en_GB/extensions/kotlin_1_3/atrium-api-fluent-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/kotlin_1_3/resultAssertions.kt +++ b/apis/fluent-en_GB/extensions/kotlin_1_3/atrium-api-fluent-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/kotlin_1_3/resultAssertions.kt @@ -10,7 +10,6 @@ import ch.tutteli.atrium.logic.kotlin_1_3.isSuccess * and returns an [Expect] for the inner type [E]. * * @return The newly created [Expect] if the given assertion is success - * @throws AssertionError Might throw an [AssertionError] if the given assertion is not a success. * * @since 0.9.0 */ @@ -22,7 +21,6 @@ fun > Expect.isSuccess(): Expect = * that it holds all assertions the given [assertionCreator] creates. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the given assertions are not success. * * @since 0.9.0 */ @@ -34,7 +32,6 @@ fun > Expect.isSuccess(assertionCreator: Expect.() -> Uni * that it encapsulates an exception of type [TExpected]. * * @return An [Expect] with the new type [TExpected] - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ @@ -47,7 +44,6 @@ inline fun Expect>.isFailure(): Ex * holds all assertions the given [assertionCreator] creates. * * @return An [Expect] with the new type [TExpected] - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/anyAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/anyAssertions.kt index b908c4e4ee..c0f62d368a 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/anyAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/anyAssertions.kt @@ -12,7 +12,6 @@ import ch.tutteli.atrium.reporting.Reporter * Expects that the subject of the assertion is (equal to) [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @sample ch.tutteli.atrium.api.infix.en_GB.samples.AnyAssertionSamples.toBe */ @@ -22,7 +21,6 @@ infix fun Expect.toBe(expected: T): Expect = _logicAppend { toBe(expec * Expects that the subject of the assertion is not (equal to) [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.notToBe(expected: T): Expect = _logicAppend { notToBe(expected) } @@ -30,7 +28,6 @@ infix fun Expect.notToBe(expected: T): Expect = _logicAppend { notToBe * Expects that the subject of the assertion is the same instance as [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.isSameAs(expected: T): Expect = _logicAppend { isSameAs(expected) } @@ -38,7 +35,6 @@ infix fun Expect.isSameAs(expected: T): Expect = _logicAppend { isSame * Expects that the subject of the assertion is not the same instance as [expected]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.isNotSameAs(expected: T): Expect = _logicAppend { isNotSameAs(expected) } @@ -67,7 +63,6 @@ fun of(reason: String, assertionCreator: Expect.() -> Unit): KeyWithCreat * is `null` or is not `null` and holds all assertions [assertionCreatorOrNull] creates. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.toBeNullIfNullGivenElse( assertionCreatorOrNull: (Expect.() -> Unit)? @@ -80,7 +75,6 @@ infix fun Expect.toBeNullIfNullGivenElse( * @param o The filler object [o]. * * @return An [Expect] with the non-nullable type [T] (was `T?` before). - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -93,7 +87,6 @@ inline infix fun Expect.notToBeNull(@Suppress("UNUSED_PARA * that it holds all assertions the given [assertionCreator] creates. * * @return An [Expect] with the non-nullable type [T] (was `T?` before) - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @Suppress(/* less magic */ "RemoveExplicitTypeArguments") inline infix fun Expect.notToBeNull(noinline assertionCreator: Expect.() -> Unit): Expect = @@ -116,7 +109,6 @@ inline infix fun Expect.notToBeNull(noinline assertionCrea * `assert(listOf(1, 2)).isA>{}` holds, even though `List` is clearly not a `List`. * * @return An [Expect] with the new type [TSub]. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ //TODO make infix and add `o` as parameter as soon as https://youtrack.jetbrains.com/issue/KT-21593 is fixed inline fun Expect<*>.isA(): Expect = @@ -161,7 +153,6 @@ inline fun Expect<*>.isA(): Expect = * `assert(listOf(1, 2)).isA>{}` holds, even though `List` is clearly not a `List`. * * @return An [Expect] with the new type [TSub]. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline infix fun Expect<*>.isA(noinline assertionCreator: Expect.() -> Unit): Expect = _logic.isA(TSub::class).transformAndAppend(assertionCreator) @@ -248,7 +239,6 @@ inline val Expect.its: Expect get() : Expect = this * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ @@ -262,7 +252,6 @@ infix fun Expect.isNoneOf(values: Values): Expect = * are passed. This function expects [IterableLike] (which is a typealias for [Any]) to avoid cluttering the API. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case the iterable is empty. * * @since 0.13.0 diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/charSequenceAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/charSequenceAssertions.kt index 344436bcfa..63abac71bf 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/charSequenceAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/charSequenceAssertions.kt @@ -52,7 +52,6 @@ infix fun Expect.containsNot( * so that you can mix [String] and [Int] for instance. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ infix fun Expect.contains(expected: CharSequenceOrNumberOrChar): Expect = @@ -83,7 +82,6 @@ infix fun Expect.contains(expected: CharSequenceOrNumberOr * -- use the function `values(t, ...)` to create a [Values]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case one of the [values] is not a * [CharSequence], [Number] or [Char]. */ @@ -100,7 +98,6 @@ infix fun Expect.contains(values: Values Expect.containsNot(expected: CharSequenceOrNumberOrChar): Expect = this containsNot o value expected @@ -118,7 +115,6 @@ infix fun Expect.containsNot(expected: CharSequenceOrNumbe * @param values The values which should not be found -- use the function `values(t, ...)` to create a [Values]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.containsNot(values: Values): Expect = this containsNot o the values @@ -132,7 +128,6 @@ infix fun Expect.containsNot(values: Values Expect.containsRegex(pattern: String): Expect = this contains o atLeast 1 regex pattern @@ -146,7 +141,6 @@ infix fun Expect.containsRegex(pattern: String): Expect * @param pattern The pattern which is expected to have a match against the input of the search. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.contains(pattern: Regex): Expect = this contains o atLeast 1 matchFor pattern @@ -172,7 +166,6 @@ infix fun Expect.contains(pattern: Regex): Expect = * use the function `regexPatterns(t, ...)` to create a [RegexPatterns]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.contains(regexPatterns: RegexPatterns): Expect = this contains o atLeast 1 the regexPatterns @@ -199,7 +192,6 @@ infix fun Expect.contains(regexPatterns: RegexPatterns): E * use the function `all(Regex(...), ...)` to create a [All]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.contains(patterns: All): Expect = this contains o atLeast 1 matchFor patterns @@ -208,7 +200,6 @@ infix fun Expect.contains(patterns: All): Expect * Expects that the subject of the assertion (a [CharSequence]) starts with [expected]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.startsWith(expected: CharSequence): Expect = _logicAppend { startsWith(expected) } @@ -217,7 +208,6 @@ infix fun Expect.startsWith(expected: CharSequence): Expec * Expects that the subject of the assertion (a [CharSequence]) starts with [expected]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -228,7 +218,6 @@ infix fun Expect.startsWith(expected: Char): Expect = * Expects that the subject of the assertion (a [CharSequence]) does not start with [expected]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.startsNotWith(expected: CharSequence): Expect = _logicAppend { startsNotWith(expected) } @@ -237,7 +226,6 @@ infix fun Expect.startsNotWith(expected: CharSequence): Ex * Expects that the subject of the assertion (a [CharSequence]) does not start with [expected]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -249,7 +237,6 @@ infix fun Expect.startsNotWith(expected: Char): Expect * Expects that the subject of the assertion (a [CharSequence]) ends with [expected]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.endsWith(expected: CharSequence): Expect = _logicAppend { endsWith(expected) } @@ -258,7 +245,6 @@ infix fun Expect.endsWith(expected: CharSequence): Expect< * Expects that the subject of the assertion (a [CharSequence]) ends with [expected]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -269,7 +255,6 @@ infix fun Expect.endsWith(expected: Char): Expect = * Expects that the subject of the assertion (a [CharSequence]) does not end with [expected]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.endsNotWith(expected: CharSequence): Expect = _logicAppend { endsNotWith(expected) } @@ -278,7 +263,6 @@ infix fun Expect.endsNotWith(expected: CharSequence): Expe * Expects that the subject of the assertion (a [CharSequence]) does not end with [expected]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -292,7 +276,6 @@ infix fun Expect.endsNotWith(expected: Char): Expect = * @param empty Use the pseudo-keyword `empty`. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") empty: empty): Expect = _logicAppend { isEmpty() } @@ -303,7 +286,6 @@ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") empty: * @param empty Use the pseudo-keyword `empty`. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.notToBe(@Suppress("UNUSED_PARAMETER") empty: empty): Expect = _logicAppend { isNotEmpty() } @@ -314,7 +296,6 @@ infix fun Expect.notToBe(@Suppress("UNUSED_PARAMETER") emp * @param blank Use the pseudo-keyword `blank`. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.notToBe(@Suppress("UNUSED_PARAMETER") blank: blank): Expect = _logicAppend { isNotBlank() } @@ -325,7 +306,6 @@ infix fun Expect.notToBe(@Suppress("UNUSED_PARAMETER") bla * In contrast to [containsRegex] it does not look for a partial match but for an entire match. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -338,7 +318,6 @@ infix fun Expect.matches(expected: Regex): Expect = * In contrast to `containsNot.regex` it does not look for a partial match but for an entire match. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/charSequenceContainsCreators.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/charSequenceContainsCreators.kt index 71ab96faf0..53ca65dd4e 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/charSequenceContainsCreators.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/charSequenceContainsCreators.kt @@ -39,7 +39,6 @@ import kotlin.jvm.JvmName * @param expected The value which is expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ infix fun CheckerStep.value( @@ -69,7 +68,6 @@ infix fun CheckerStep.value( * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case one of the [values] is not a [CharSequence], [Number] or [Char]. */ infix fun CheckerStep.the( @@ -92,7 +90,6 @@ infix fun CheckerStep.the( * @param expected The value which is expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ @JvmName("valueIgnoringCase") @@ -123,7 +120,6 @@ infix fun CheckerStep.value( * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case one of the [values] is not a [CharSequence], [Number] or [Char]. */ @JvmName("valuesIgnoringCase") @@ -146,7 +142,6 @@ infix fun CheckerStep.the( * @param expected The value which is expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ infix fun EntryPointStep.value( @@ -179,7 +174,6 @@ infix fun EntryPointStep.valu * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case one of the [values] is not a [CharSequence], [Number] or [Char]. */ infix fun EntryPointStep.the( @@ -195,7 +189,6 @@ infix fun EntryPointStep.the( * @param pattern The pattern which is expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun CheckerStep.regex(pattern: String): Expect = this the regexPatterns(pattern) @@ -209,7 +202,6 @@ infix fun CheckerStep.regex(pattern: * @param pattern The pattern which is expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -236,7 +228,6 @@ infix fun CheckerStep.matchFor( * -- use the function `regexPatterns(t, ...)` to create a [RegexPatterns]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun CheckerStep.the(patterns: RegexPatterns): Expect = _logicAppend { regex(patterns.toList()) } @@ -260,7 +251,6 @@ infix fun CheckerStep.the(patterns: R * use the function `all(Regex(...), ...)` to create a [All]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -276,7 +266,6 @@ infix fun CheckerStep.matchFor(patter * @param pattern The patterns which is expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @JvmName("regexIgnoringCase") infix fun CheckerStep.regex(pattern: String): Expect = @@ -301,7 +290,6 @@ infix fun CheckerStep.regex(p * -- use the function `regexPatterns(t, ...)` to create a [RegexPatterns]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @JvmName("regexIgnoringCase") infix fun CheckerStep.the(patterns: RegexPatterns): Expect = @@ -316,7 +304,6 @@ infix fun CheckerStep.the(pat * @param pattern The patterns which is expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun EntryPointStep.regex(pattern: String): Expect = this atLeast 1 regex pattern @@ -342,7 +329,6 @@ infix fun EntryPointStep.rege * use the function `regexPatterns(t, ...)` to create a [RegexPatterns]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun EntryPointStep.the(patterns: RegexPatterns): Expect = this atLeast 1 the patterns @@ -362,7 +348,6 @@ infix fun EntryPointStep.the( * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * @@ -389,7 +374,6 @@ infix fun CheckerStep.elementsOf( * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * @@ -417,7 +401,6 @@ infix fun CheckerStep.element * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/charSequenceContainsCreatorsDeprecated.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/charSequenceContainsCreatorsDeprecated.kt index 20c910c122..e1403737c4 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/charSequenceContainsCreatorsDeprecated.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/charSequenceContainsCreatorsDeprecated.kt @@ -36,7 +36,6 @@ import kotlin.jvm.JvmName * @param expected The value which is expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ infix fun CheckerOption.value( @@ -66,7 +65,6 @@ infix fun CheckerOption.value( * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case one of the [values] is not a [CharSequence], [Number] or [Char]. */ infix fun CheckerOption.the( @@ -89,7 +87,6 @@ infix fun CheckerOption.the( * @param expected The value which is expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ @JvmName("valueIgnoringCase") @@ -120,7 +117,6 @@ infix fun CheckerOption.value * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case one of the [values] is not a [CharSequence], [Number] or [Char]. */ @JvmName("valuesIgnoringCase") @@ -143,7 +139,6 @@ infix fun CheckerOption.the( * @param expected The value which is expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expected] is not a [CharSequence], [Number] or [Char]. */ infix fun Builder.value( @@ -176,7 +171,6 @@ infix fun Builder.value( * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case one of the [values] is not a [CharSequence], [Number] or [Char]. */ infix fun Builder.the( @@ -192,7 +186,6 @@ infix fun Builder.the( * @param pattern The pattern which is expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun CheckerOption.regex(pattern: String): Expect = this the regexPatterns(pattern) @@ -206,7 +199,6 @@ infix fun CheckerOption.regex(pattern * @param pattern The pattern which is expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -233,7 +225,6 @@ infix fun CheckerOption.matchFor( * -- use the function `regexPatterns(t, ...)` to create a [RegexPatterns]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun CheckerOption.the(patterns: RegexPatterns): Expect = addAssertion(ExpectImpl.charSequence.contains.regex(this, patterns.toList())) @@ -257,7 +248,6 @@ infix fun CheckerOption.the(patterns: * use the function `all(Regex(...), ...)` to create a [All]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -274,7 +264,6 @@ infix fun CheckerOption.matchFor(patt * @param pattern The patterns which is expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @JvmName("regexIgnoringCase") infix fun CheckerOption.regex(pattern: String): Expect = @@ -299,7 +288,6 @@ infix fun CheckerOption.regex * -- use the function `regexPatterns(t, ...)` to create a [RegexPatterns]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @JvmName("regexIgnoringCase") infix fun CheckerOption.the(patterns: RegexPatterns): Expect = @@ -314,7 +302,6 @@ infix fun CheckerOption.the(p * @param pattern The patterns which is expected to have a match against the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Builder.regex(pattern: String): Expect = this atLeast 1 regex pattern @@ -340,7 +327,6 @@ infix fun Builder.regex(patte * use the function `regexPatterns(t, ...)` to create a [RegexPatterns]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Builder.the(patterns: RegexPatterns): Expect = this atLeast 1 the patterns @@ -361,7 +347,6 @@ infix fun Builder.the(pattern * @param expectedIterable The [Iterable] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterable] is not a [CharSequence], [Number] or [Char] or the given * [expectedIterable] does not have elements (is empty). * @@ -392,7 +377,6 @@ infix fun CheckerOption.elementsOf( * @param expectedIterable The [Iterable] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterable] is not a [CharSequence], [Number] or [Char] or the given * [expectedIterable] does not have elements (is empty). * @@ -423,7 +407,6 @@ infix fun CheckerOption.eleme * @param expectedIterable The [Iterable] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterable] is not a [CharSequence], [Number] or [Char] or the given * [expectedIterable] does not have elements (is empty). * @@ -453,7 +436,6 @@ infix fun Builder.elementsOf( * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * @@ -482,7 +464,6 @@ infix fun CheckerOption.elementsOf( * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * @@ -511,7 +492,6 @@ infix fun CheckerOption.eleme * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within the input of the search. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types or the given * [expectedIterableLike] does not have elements (is empty). * diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/collectionAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/collectionAssertions.kt index fdd9e1dcc6..0b801d2546 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/collectionAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/collectionAssertions.kt @@ -10,7 +10,6 @@ import ch.tutteli.kbox.identity * @param empty Use the pseudo-keyword `empty`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") empty: empty): Expect = _logicAppend { isEmpty(::identity) } @@ -21,7 +20,6 @@ infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") empty * @param empty Use the pseudo-keyword `empty`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.notToBe(@Suppress("UNUSED_PARAMETER") empty: empty): Expect = _logicAppend { isNotEmpty(::identity) } @@ -32,7 +30,6 @@ infix fun > Expect.notToBe(@Suppress("UNUSED_PARAMETER") em * Shortcut for `size.toBe(expected)`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.hasSize(expected: Int): Expect = size { toBe(expected) } @@ -53,7 +50,6 @@ val > Expect.size: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.size(assertionCreator: Expect.() -> Unit): Expect = _logic.size(::identity).collectAndAppend(assertionCreator) diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/comparableAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/comparableAssertions.kt index 2f48a586cd..51159b6146 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/comparableAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/comparableAssertions.kt @@ -8,7 +8,6 @@ import ch.tutteli.atrium.logic.* * The comparison is carried out with [Comparable.compareTo]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.isLessThan(expected: T): Expect = _logicAppend { isLessThan(expected) } @@ -18,7 +17,6 @@ infix fun > Expect.isLessThan(expected: T): Expect = * The comparison is carried out with [Comparable.compareTo]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.isLessThanOrEqual(expected: T): Expect = _logicAppend { isLessThanOrEqual(expected) } @@ -28,7 +26,6 @@ infix fun > Expect.isLessThanOrEqual(expected: T): Expect> Expect.isGreaterThan(expected: T): Expect = _logicAppend { isGreaterThan(expected) } @@ -38,7 +35,6 @@ infix fun > Expect.isGreaterThan(expected: T): Expect = * The comparison is carried out with [Comparable.compareTo]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.isGreaterThanOrEqual(expected: T): Expect = _logicAppend { isGreaterThanOrEqual(expected) } @@ -48,7 +44,6 @@ infix fun > Expect.isGreaterThanOrEqual(expected: T): Expec * where the comparison is carried out with [Comparable.compareTo]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/creating/feature/Feature.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/creating/feature/Feature.kt index 08c6897a7c..b5dce1f69d 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/creating/feature/Feature.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/creating/feature/Feature.kt @@ -12,7 +12,7 @@ import kotlin.reflect.KProperty1 * * @property description The description of the feature. * @property extractor The extractor which extracts the feature out of the subject of the assertion. - + * * @since 0.12.0 */ data class Feature internal constructor(val description: String, val extractor: (T) -> R) diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/featureAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/featureAssertions.kt index 4247fc3a4c..6d37733ec6 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/featureAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/featureAssertions.kt @@ -78,7 +78,6 @@ infix fun Expect.feature(of: Feature): FeatureExpect = * in-between the required arguments in case of a `KFunctionX` where `X` > 1. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.12.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/fun0Assertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/fun0Assertions.kt index e007738f9d..83951fad98 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/fun0Assertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/fun0Assertions.kt @@ -13,7 +13,6 @@ import ch.tutteli.atrium.logic.toThrow * the element type is actually `String`. * * @return An [Expect] with the new type [TExpected]. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline fun Expect Any?>.toThrow(): Expect = _logic.toThrow(TExpected::class).transform() @@ -49,7 +48,6 @@ inline fun Expect Any?>.toThrow(): Exp * the element type is actually `String`. * * @return An [Expect] with the new type [TExpected]. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline infix fun Expect Any?>.toThrow( noinline assertionCreator: Expect.() -> Unit @@ -61,7 +59,6 @@ inline infix fun Expect Any?>.toThrow( * and changes the subject of the assertion to the return value of type [R]. * * @return An [Expect] with the new type [R]. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun R> Expect.notToThrow(): Expect = _logic.notToThrow().transform() @@ -71,7 +68,6 @@ fun R> Expect.notToThrow(): Expect = * and that the corresponding return value holds all assertions the given [assertionCreator] creates. * * @return An [Expect] with the new type [R]. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun R> Expect.notToThrow( assertionCreator: Expect.() -> Unit diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableAssertions.kt index bac54df7ec..af444d74ee 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableAssertions.kt @@ -46,7 +46,6 @@ infix fun > Expect.containsNot( * It is a shortcut for `contains o inAny order atLeast 1 value expected` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.contains(expected: E): Expect = it contains o inAny order atLeast 1 value expected @@ -70,7 +69,6 @@ infix fun > Expect.contains(expected: E): Expect = * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.contains(values: Values): Expect = it contains o inAny order atLeast 1 the values @@ -87,7 +85,6 @@ infix fun > Expect.contains(values: Values): Expect * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.contains(assertionCreatorOrNull: (Expect.() -> Unit)?): Expect = it contains o inAny order atLeast 1 entry assertionCreatorOrNull @@ -105,7 +102,6 @@ infix fun > Expect.contains(assertionCreatorOrNull: * -- use the function `entries(t, ...)` to create an [Entries]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.contains(entries: Entries): Expect = it contains o inAny order atLeast 1 the entries @@ -115,9 +111,8 @@ infix fun > Expect.contains(entries: Entries): E * the [expected] value. * * It is a shortcut for `contains o inGiven order and only value expected` - + * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsExactly(expected: E): Expect = it contains o inGiven order and only value expected @@ -136,7 +131,6 @@ infix fun > Expect.containsExactly(expected: E): Expect * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsExactly(values: Values): Expect = it contains o inGiven order and only the values @@ -157,7 +151,6 @@ infix fun > Expect.containsExactly(values: Values): Exp * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsExactly( assertionCreatorOrNull: (Expect.() -> Unit)? @@ -181,7 +174,6 @@ infix fun > Expect.containsExactly( * -- use the function `entries(t, ...)` to create an [Entries]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsExactly(entries: Entries): Expect = it contains o inGiven order and only the entries @@ -196,7 +188,6 @@ infix fun > Expect.containsExactly(entries: Entries * are passed. This function expects [IterableLike] (which is a typealias for [Any]) to avoid cluttering the API. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types * or the given [expectedIterableLike] does not have elements (is empty). * @@ -216,7 +207,6 @@ inline infix fun > Expect.containsExactlyElementsO * @param expectedIterableLike The [IterableLike] whose elements are expected to be contained within this [Iterable]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedIterableLike] is not an [Iterable], [Sequence] or one of the [Array] types * or the given [expectedIterableLike] does not have elements (is empty). * @@ -233,7 +223,6 @@ inline infix fun > Expect.containsElementsOf( * It is a shortcut for `containsNot o value expected` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsNot(expected: E): Expect = it containsNot o value expected @@ -248,7 +237,6 @@ infix fun > Expect.containsNot(expected: E): Expect = * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsNot(values: Values): Expect = it containsNot o the values @@ -272,7 +260,6 @@ infix fun , T : Iterable> Expect.min(@Suppress("UNUSED_P * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -299,7 +286,6 @@ infix fun , T : Iterable> Expect.max(@Suppress("UNUSED_P * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -315,7 +301,6 @@ infix fun , T : Iterable> Expect.max(assertionCreator: E * It is a shortcut for `contains o inAny order atLeast 1 entry assertionCreatorOrNull` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.any(assertionCreatorOrNull: (Expect.() -> Unit)?): Expect = it contains o inAny order atLeast 1 entry assertionCreatorOrNull @@ -329,7 +314,6 @@ infix fun > Expect.any(assertionCreatorOrNull: (Exp * It is a shortcut for `containsNot o entry assertionCreatorOrNull` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.none(assertionCreatorOrNull: (Expect.() -> Unit)?): Expect = it containsNot o entry assertionCreatorOrNull @@ -340,7 +324,6 @@ infix fun > Expect.none(assertionCreatorOrNull: (Ex * that all elements are `null` in case [assertionCreatorOrNull] is defined as `null`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.all(assertionCreatorOrNull: (Expect.() -> Unit)?): Expect = _logicAppend { all(::identity, assertionCreatorOrNull) } @@ -350,7 +333,6 @@ infix fun > Expect.all(assertionCreatorOrNull: (Exp * Expects that the subject of the assertion (an [Iterable]) has at least one element. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -361,7 +343,6 @@ infix fun > Expect.has(@Suppress("UNUSED_PARAMETER") next: * Expects that the subject of the assertion (an [Iterable]) does not have next element. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -372,7 +353,6 @@ infix fun > Expect.hasNot(@Suppress("UNUSED_PARAMETER") ne * Expects that the subject of the assertion (an [Iterable]) does not have duplicate elements. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableContainsInAnyOrderCreators.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableContainsInAnyOrderCreators.kt index f5db4397b2..fe159e90c8 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableContainsInAnyOrderCreators.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableContainsInAnyOrderCreators.kt @@ -22,7 +22,6 @@ import ch.tutteli.atrium.domain.creating.typeutils.IterableLike * @param expected The value which is expected to be contained within this [Iterable]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > CheckerOption.value(expected: E): Expect = this the values(expected) @@ -45,7 +44,6 @@ infix fun > CheckerOption.va * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > CheckerOption.the(values: Values): Expect = addAssertion(ExpectImpl.iterable.contains.valuesInAnyOrder(this, values.toList())) @@ -62,7 +60,6 @@ infix fun > CheckerOption.th * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > CheckerOption.entry( assertionCreatorOrNull: (Expect.() -> Unit)? @@ -79,7 +76,6 @@ infix fun > CheckerOption> CheckerOption.the( entries: Entries @@ -95,7 +91,6 @@ infix fun > CheckerOption> CheckerOption> Builder.value(expected: E): Expect = this the values(expected) @@ -43,7 +42,6 @@ infix fun > Builder.valu * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Builder.the(values: Values): Expect = addAssertion(ExpectImpl.iterable.contains.valuesInAnyOrderOnly(this, values.toList())) @@ -64,7 +62,6 @@ infix fun > Builder.the( * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Builder.entry( assertionCreatorOrNull: (Expect.() -> Unit)? @@ -94,7 +91,6 @@ infix fun > Builder> Builder.the( @@ -115,7 +111,6 @@ infix fun > Builder> Builder> Builder.value(expected: E): Expect = this the values(expected) @@ -43,7 +42,6 @@ infix fun > Builder.value(e * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Builder.the(values: Values): Expect = addAssertion(ExpectImpl.iterable.contains.valuesInOrderOnly(this, values.toList())) @@ -64,7 +62,6 @@ infix fun > Builder.the(val * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Builder.entry( assertionCreatorOrNull: (Expect.() -> Unit)? @@ -86,7 +83,6 @@ infix fun > Builder * -- use the function `entries(t, ...)` to create an [Entries]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Builder.the( entries: Entries @@ -106,7 +102,6 @@ infix fun > Builder * @param expectedIterable The [Iterable] whose elements are expected to be contained within this [Iterable]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case the given [expectedIterable] does not have elements (is empty). * * @since 0.12.0 @@ -136,7 +131,6 @@ inline infix fun > Builder> Builder.inAny( order: Order> @@ -63,7 +62,6 @@ fun order( * ``` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @JvmName("inAnyOrderEntries") infix fun > Builder.inAny( diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeContainsInAnyOrderCreators.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeContainsInAnyOrderCreators.kt index a6afe164d2..cdd174fcd3 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeContainsInAnyOrderCreators.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeContainsInAnyOrderCreators.kt @@ -22,7 +22,6 @@ import ch.tutteli.atrium.logic.utils.toVarArg * @param expected The value which is expected to be contained within this [IterableLike]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -48,7 +47,6 @@ infix fun CheckerStep.val * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -67,7 +65,6 @@ infix fun CheckerStep.the * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -87,7 +84,6 @@ infix fun CheckerStep CheckerStep EntryPointStep.value(expected: E): Expect = this the values(expected) @@ -44,7 +43,6 @@ infix fun EntryPointStep EntryPointStep.the(values: Values): Expect = _logicAppend { valuesInAnyOrderOnly(values.toList()) } @@ -65,7 +63,6 @@ infix fun EntryPointStep EntryPointStep.entry( assertionCreatorOrNull: (Expect.() -> Unit)? @@ -93,7 +90,6 @@ infix fun EntryPointStep EntryPointStep.the( @@ -117,7 +113,6 @@ infix fun EntryPointStep EntryPointStep * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -68,7 +66,6 @@ infix fun EntryPointStep * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 -- API existed for [Iterable] but not for [IterableLike]. */ @@ -91,7 +88,6 @@ infix fun EntryPointStep EntryPointStep EntryPointStep> Expect.has(@Suppress("UNUSED_PARAMETER") next: * Expects that the subject of the assertion (an [Iterator]) does not have next element. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/listAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/listAssertions.kt index ca881b6d29..90807c3531 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/listAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/listAssertions.kt @@ -10,7 +10,6 @@ import ch.tutteli.atrium.logic.get * returns an [Expect] for the element at that position. * * @return The newly created [Expect] for the element at position [index]. - * @throws AssertionError Might throw an [AssertionError] if the given [index] is out of bound. */ infix fun > Expect.get(index: Int): Expect = _logic.get(index).transform() @@ -23,8 +22,6 @@ infix fun > Expect.get(index: Int): Expect = * Use the function `index(Int) { ... }` to create an [IndexWithCreator]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the given [index] is out of bound or - * if the assertion made is not correct. */ infix fun > Expect.get(index: IndexWithCreator): Expect = _logic.get(index.index).collectAndAppend(index.assertionCreator) diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapAssertions.kt index eab695d11e..a97e0a77f8 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapAssertions.kt @@ -27,7 +27,6 @@ infix fun > Expect.contains( * Delegates to 'it contains o inAny order entry keyValuePair'. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.contains(keyValuePair: Pair): Expect = it contains o inAny order entry keyValuePair @@ -39,7 +38,6 @@ infix fun > Expect.contains(keyValuePair: Pair) * Delegates to 'it contains o inAny order but only entry keyValuePair'. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsOnly(keyValuePair: Pair): Expect = it contains o inAny order but only entry keyValuePair @@ -58,7 +56,6 @@ infix fun > Expect.containsOnly(keyValuePair: Pair> Expect.contains(keyValuePairs: Pairs): Expect = it contains o inAny order the keyValuePairs @@ -73,7 +70,6 @@ infix fun > Expect.contains(keyValuePairs: Pairs> Expect.containsOnly(keyValuePairs: Pairs): Expect = it contains o inAny order but only the keyValuePairs @@ -92,7 +88,6 @@ infix fun > Expect.containsOnly(keyValuePairs: Pairs< * -- use the function `keyValue(x) { ... }` to create a [KeyWithValueCreator]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline infix fun > Expect.contains(keyValue: KeyWithValueCreator): Expect = it contains o inAny order entry keyValue @@ -111,7 +106,6 @@ inline infix fun > Expect.contains(key * -- use the function `keyValue(x) { ... }` to create a [KeyWithValueCreator]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline infix fun > Expect.containsOnly(keyValue: KeyWithValueCreator): Expect = it contains o inAny order but only entry keyValue @@ -136,7 +130,6 @@ fun keyValue(key: K, valueAssertionCreatorOrNull: (Expect.() -> * another one is defined as `Key('a') { isLessThan(2) }`, then both match, even though they match the same entry. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline infix fun > Expect.contains( allKeyValues: KeyValues @@ -152,7 +145,6 @@ inline infix fun > Expect.contains( * Delegates to `it contains o inAny order but only the keyValues` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline infix fun > Expect.containsOnly( allKeyValues: KeyValues @@ -164,7 +156,6 @@ inline infix fun > Expect.containsOnly * Delegates to `it contains o inAny order entriesOf` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsEntriesOf( mapLike: MapLike @@ -177,7 +168,6 @@ infix fun > Expect.containsEntriesOf( * Delegates to `it contains o inAny order but only entriesOf` * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsOnlyEntriesOf( mapLike: MapLike @@ -188,7 +178,6 @@ infix fun > Expect.containsOnlyEntriesOf( * Expects that the subject of the assertion (a [Map]) contains the given [key]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsKey(key: K): Expect = _logicAppend { containsKey(::identity, key) } @@ -197,7 +186,6 @@ infix fun > Expect.containsKey(key: K): Expect = * Expects that the subject of the assertion (a [Map]) does not contain the given [key]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsNotKey(key: K): Expect = _logicAppend { containsNotKey(::identity, key) } @@ -208,7 +196,6 @@ infix fun > Expect.containsNotKey(key: K): Expect = * so that further fluent calls are assertions about it. * * @return The newly created [Expect] for the extracted feature. - * @throws AssertionError Might throw an [AssertionError] if the given [key] does not exist. */ infix fun > Expect.getExisting(key: K): Expect = _logic.getExisting(::identity, key).transform() @@ -221,8 +208,6 @@ infix fun > Expect.getExisting(key: K): Expect = * to the key and the second is the `assertionCreator`-lambda * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] the given [key] does not exist or - * if the assertion made is not correct. */ infix fun > Expect.getExisting(key: KeyWithCreator): Expect = _logic.getExisting(::identity, key.key).collectAndAppend(key.assertionCreator) @@ -249,7 +234,6 @@ val > Expect.keys: Expect> * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.keys(assertionCreator: Expect>.() -> Unit): Expect = _logic.property(Map::keys).collectAndAppend(assertionCreator) @@ -269,7 +253,6 @@ val > Expect.values: Expect> * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.values(assertionCreator: Expect>.() -> Unit): Expect = _logic.property(Map::values).collectAndAppend(assertionCreator) @@ -306,7 +289,6 @@ infix fun > Expect.asEntries( * @param empty Use the pseudo-keyword `empty`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") empty: empty): Expect = _logicAppend { isEmpty(::toEntries) } @@ -318,7 +300,6 @@ infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") empty: em * @param empty Use the pseudo-keyword `empty`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.notToBe(@Suppress("UNUSED_PARAMETER") empty: empty): Expect = _logicAppend { isNotEmpty(::toEntries) } diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapCollectionLikeAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapCollectionLikeAssertions.kt index c01d641fb9..2d871f9734 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapCollectionLikeAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapCollectionLikeAssertions.kt @@ -21,7 +21,6 @@ val > Expect.size: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt index 7070cc56d4..65c16f5140 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt @@ -12,7 +12,6 @@ import ch.tutteli.atrium.logic.* * reporting etc. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.isKeyValue(keyValuePair: Pair): Expect = _logicAppend { isKeyValue(keyValuePair.first, keyValuePair.second) } @@ -32,7 +31,6 @@ val > Expect.key: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.key(assertionCreator: Expect.() -> Unit): Expect = _logic.key().collectAndAppend(assertionCreator) @@ -52,7 +50,6 @@ val > Expect.value: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.value(assertionCreator: Expect.() -> Unit): Expect = _logic.value().collectAndAppend(assertionCreator) diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeContainsInAnyOrderCreators.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeContainsInAnyOrderCreators.kt index 0f39b5c344..0e79096080 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeContainsInAnyOrderCreators.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeContainsInAnyOrderCreators.kt @@ -20,7 +20,6 @@ import ch.tutteli.atrium.logic.utils.toVarArgPairs * Delegates to `the pairs(keyValuePair)`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ @@ -37,7 +36,6 @@ infix fun EntryPointStep * even though they match the same entry. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ @@ -55,7 +53,6 @@ infix fun EntryPointStep * Delegates to `the keyValues(keyValue)`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ @@ -77,7 +74,6 @@ inline infix fun EntryPointStep keyValues( * @param expectedMapLike The [MapLike] whose elements are expected to be contained within this [MapLike]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @throws IllegalArgumentException in case [expectedMapLike] is not * a [Map], [Sequence] or one of the [Array] types * or the given [expectedMapLike] does not have elements (is empty). diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeContainsInAnyOrderOnlyCreators.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeContainsInAnyOrderOnlyCreators.kt index 69d172f6b0..888c09979f 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeContainsInAnyOrderOnlyCreators.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeContainsInAnyOrderOnlyCreators.kt @@ -20,7 +20,6 @@ import ch.tutteli.atrium.logic.utils.toVarArgPairs * Delegates to `the pairs(keyValuePair)`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.15.0 */ @@ -34,7 +33,6 @@ infix fun EntryPointStep EntryPointStep EntryPointStep EntryPointStep EntryPointStep EntryPointStep EntryPointStep EntryPointStep> Expect.first: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.first(assertionCreator: Expect.() -> Unit): Expect = _logic.first().collectAndAppend(assertionCreator) @@ -40,7 +39,6 @@ val > Expect.second: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.second(assertionCreator: Expect.() -> Unit): Expect = _logic.second().collectAndAppend(assertionCreator) diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/throwableAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/throwableAssertions.kt index 19d9e2d40d..7767151c46 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/throwableAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/throwableAssertions.kt @@ -11,7 +11,6 @@ import ch.tutteli.atrium.logic.causeIsA * creates an [Expect] for it and returns it. * * @return The newly created [Expect] for the property [Throwable.message] of the subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ val Expect.message: Expect get() = it feature Throwable::message notToBeNull o @@ -22,7 +21,6 @@ val Expect.message: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.message(assertionCreator: Expect.() -> Unit): Expect = it feature of(Throwable::message) { it notToBeNull assertionCreator } @@ -36,7 +34,6 @@ infix fun Expect.message(assertionCreator: Expect.() * so that you can mix [String] and [Int] for instance. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.messageContains(expected: CharSequenceOrNumberOrChar): Expect = this messageContains values(expected) @@ -52,7 +49,6 @@ infix fun Expect.messageContains(expected: CharSequenceOrNumb * -- use the function `values(t, ...)` to create a [Values]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.messageContains(values: Values): Expect = message { contains(values) } @@ -62,7 +58,6 @@ infix fun Expect.messageContains(values: Values): Expect * creates an [Expect] of the [TExpected] type for it and returns it. * * @return The newly created [Expect] for the property [Throwable.cause] of the subject of the assertion - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -78,7 +73,6 @@ inline fun Expect.cause(): Expect * [Expect] of the initial type, which was some type `T `, but an [Expect] of the specified type [TExpected]. * * @return This assertion container to support a fluent API. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/bigDecimalAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/bigDecimalAssertions.kt index 1673b4d621..cccbf918bd 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/bigDecimalAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/bigDecimalAssertions.kt @@ -49,8 +49,7 @@ infix fun Expect.toBe(expected: T): Nothing = throw PleaseU * Expects that the subject of the assertion (a [BigDecimal]) is `null`. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. - * + */ @JvmName("toBeNull") infix fun Expect.toBe(expected: Nothing?): Expect = @@ -91,8 +90,7 @@ infix fun Expect.notToBe(expected: T): Nothing = throw Pleas * - `expect(BigDecimal("10")).isNumericallyEqualTo(BigDecimal("10.0"))` holds. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. - * + */ infix fun Expect.isNumericallyEqualTo(expected: T): Expect = _logicAppend { isNumericallyEqualTo(expected) } @@ -110,8 +108,7 @@ infix fun Expect.isNumericallyEqualTo(expected: T): Expect Expect.isNotNumericallyEqualTo(expected: T): Expect = _logicAppend { isNotNumericallyEqualTo(expected) } @@ -127,8 +124,7 @@ infix fun Expect.isNotNumericallyEqualTo(expected: T): Expec * - `expect(BigDecimal("10")).isNumericallyEqualTo(BigDecimal("10.0"))` holds. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. - * + */ infix fun Expect.isEqualIncludingScale(expected: T): Expect = _logicAppend { isEqualIncludingScale(expected, this::isNumericallyEqualTo.name) } @@ -143,8 +139,7 @@ infix fun Expect.isEqualIncludingScale(expected: T): Expect< * - `expect(BigDecimal("10")).isNotNumericallyEqualTo(BigDecimal("10.0"))` does not hold. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. - * + */ infix fun Expect.isNotEqualIncludingScale(expected: T): Expect = _logicAppend { isNotEqualIncludingScale(expected) } diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/chronoLocalDateAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/chronoLocalDateAssertions.kt index 660db5ec06..9410504ff8 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/chronoLocalDateAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/chronoLocalDateAssertions.kt @@ -14,7 +14,6 @@ import java.time.chrono.ChronoLocalDate * is before the [expected] [ChronoLocalDate]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -26,7 +25,6 @@ infix fun Expect.isBefore(expected: ChronoLocalDate): E * is before or equal the [expected] [ChronoLocalDate]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -38,7 +36,6 @@ infix fun Expect.isBeforeOrEqual(expected: ChronoLocalD * is after the [expected] [ChronoLocalDate]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -50,7 +47,6 @@ infix fun Expect.isAfter(expected: ChronoLocalDate): Ex * is after or equal the [expected] [ChronoLocalDate]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -62,7 +58,6 @@ infix fun Expect.isAfterOrEqual(expected: ChronoLocalDa * is equal to the [expected] [ChronoLocalDate]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -75,7 +70,6 @@ infix fun Expect.isEqual(expected: ChronoLocalDate): Ex * The [expected] parameter needs to be in the form of **yyyy-mm-dd** or else a [java.time.DateTimeException] will be thrown. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -88,7 +82,6 @@ infix fun Expect.isBefore(expected: String): Expect * The [expected] parameter needs to be in the form of **yyyy-mm-dd** or else a [java.time.DateTimeException] will be thrown. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -101,7 +94,6 @@ infix fun Expect.isBeforeOrEqual(expected: String): Exp * The [expected] parameter needs to be in the form of **yyyy-mm-dd** or else a [java.time.DateTimeException] will be thrown. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -114,7 +106,6 @@ infix fun Expect.isAfter(expected: String): Expect = * The [expected] parameter needs to be in the form of **yyyy-mm-dd** or else a [java.time.DateTimeException] will be thrown. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -127,7 +118,6 @@ infix fun Expect.isAfterOrEqual(expected: String): Expe * The [expected] parameter needs to be in the form of **yyyy-mm-dd** or else a [java.time.DateTimeException] will be thrown. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/chronoLocalDateTimeAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/chronoLocalDateTimeAssertions.kt index 37b1983643..98a901dc9b 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/chronoLocalDateTimeAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/chronoLocalDateTimeAssertions.kt @@ -16,7 +16,6 @@ import java.time.chrono.ChronoLocalDateTime * is before the [expected] [ChronoLocalDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -29,7 +28,6 @@ infix fun > Expect.isBefore( * is before or equal the [expected] [ChronoLocalDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -42,7 +40,6 @@ infix fun > Expect.isBeforeOrEqu * is after the [expected] [ChronoLocalDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -55,7 +52,6 @@ infix fun > Expect.isAfter( * is after or equal the [expected] [ChronoLocalDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -68,7 +64,6 @@ infix fun > Expect.isAfterOrEqua * is equal to the [expected] [ChronoLocalDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -88,7 +83,6 @@ infix fun > Expect.isEqual( * yyyy-mm-dd * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ @@ -108,7 +102,6 @@ infix fun > Expect.isBefore( * yyyy-mm-dd * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ @@ -128,7 +121,6 @@ infix fun > Expect.isBeforeOrEqu * yyyy-mm-dd * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ @@ -148,7 +140,6 @@ infix fun > Expect.isAfter( * yyyy-mm-dd * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ @@ -168,7 +159,6 @@ infix fun > Expect.isAfterOrEqua * yyyy-mm-dd * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/chronoZonedDateTimeAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/chronoZonedDateTimeAssertions.kt index 47f99d884b..5623bd80bc 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/chronoZonedDateTimeAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/chronoZonedDateTimeAssertions.kt @@ -15,7 +15,6 @@ import java.time.chrono.ChronoZonedDateTime * is before the [expected] [ChronoZonedDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -28,7 +27,6 @@ infix fun > Expect.isBefore( * is before or equals the [expected] [ChronoZonedDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -41,7 +39,6 @@ infix fun > Expect.isBeforeOrEqu * is after the [expected] [ChronoZonedDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -54,7 +51,6 @@ infix fun > Expect.isAfter( * is after or equal the [expected] [ChronoZonedDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -67,7 +63,6 @@ infix fun > Expect.isAfterOrEqua * is equal to the [expected] [ChronoZonedDateTime]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -101,7 +96,6 @@ infix fun > Expect.isEqual( * - 2020-01-02+01:30 * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -135,7 +129,6 @@ infix fun > Expect.isBefore( * - 2020-01-02+01:30 * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -169,7 +162,6 @@ infix fun > Expect.isBeforeOrEqu * - 2020-01-02+01:30 * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -203,7 +195,6 @@ infix fun > Expect.isAfter( * - 2020-01-02+01:30 * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -237,7 +228,6 @@ infix fun > Expect.isAfterOrEqua * - 2020-01-02+01:30 * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/localDateAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/localDateAssertions.kt index 7ebc1d654c..3496144020 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/localDateAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/localDateAssertions.kt @@ -27,7 +27,6 @@ val Expect.year: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -51,7 +50,6 @@ val Expect.month: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -75,7 +73,6 @@ val Expect.dayOfWeek: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -100,7 +97,6 @@ val Expect.day: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/localDateTimeAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/localDateTimeAssertions.kt index 3ba67d361e..7c3f20c325 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/localDateTimeAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/localDateTimeAssertions.kt @@ -27,7 +27,6 @@ val Expect.year: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -51,7 +50,6 @@ val Expect.month: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -75,7 +73,6 @@ val Expect.dayOfWeek: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -99,7 +96,6 @@ val Expect.day: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/optionalAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/optionalAssertions.kt index dd4859fb7a..722d1dcc2f 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/optionalAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/optionalAssertions.kt @@ -21,7 +21,6 @@ import java.util.* * depends on the underlying implementation though. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -36,7 +35,6 @@ infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") empty: * depends on the underlying implementation though. * * @return The newly created [Expect] for the inner type [E]. - * @throws AssertionError Might throw an [AssertionError] if the given assertion is not a success. * * @since 0.12.0 */ @@ -48,7 +46,6 @@ infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") pres * that it holds all assertions the given [PresentWithCreator.assertionCreator] creates. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the given assertions are not success. * * @since 0.12.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/pathAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/pathAssertions.kt index 4a395f79f0..680fe2558a 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/pathAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/pathAssertions.kt @@ -18,7 +18,6 @@ import java.nio.file.Path * Expects that the subject of the assertion (a [Path]) starts with the [expected] [Path]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -29,7 +28,6 @@ infix fun Expect.startsWith(expected: Path): Expect = * Expects that the subject of the assertion (a [Path]) does not start with the [expected] [Path]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -40,7 +38,6 @@ infix fun Expect.startsNotWith(expected: Path): Expect = * Expects that the subject of the assertion (a [Path]) ends with the expected [Path]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -52,7 +49,6 @@ infix fun Expect.endsWith(expected: Path): Expect = * * @param expected The [Path] provided to the assertion * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -67,7 +63,6 @@ infix fun Expect.endsNotWith(expected: Path): Expect = * then the search will continue at that location. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -82,7 +77,6 @@ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") existing: exis * then the search will continue at that location. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -108,7 +102,6 @@ val Expect.fileName: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -121,7 +114,6 @@ infix fun Expect.fileName(assertionCreator: Expect.() -> U * so that further fluent calls are assertions about it. * * @return The newly created [Expect] for the extracted feature. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -135,7 +127,6 @@ val Expect.fileNameWithoutExtension: Expect * and returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -147,7 +138,6 @@ infix fun Expect.fileNameWithoutExtension(assertionCreator: Expect * so that further fluent calls are assertions about it. * * @return The newly created [Expect] for the extracted feature. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -159,7 +149,6 @@ val Expect.parent: Expect * given [assertionCreator] creates for it and returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -171,7 +160,6 @@ infix fun Expect.parent(assertionCreator: Expect.() -> Unit) * so that further fluent calls are assertions about it. * * @return The newly created [Expect] for the extracted feature. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -193,7 +181,6 @@ infix fun Expect.resolve(other: String): Expect = * take place. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @see [has] * * @since 0.14.0 @@ -216,7 +203,6 @@ infix fun Expect.hasDirectoryEntry(entry: String) = * take place. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @see [directoryEntries] * @see [hasDirectoryEntry] * @@ -240,7 +226,6 @@ fun directoryEntries(entry: String, vararg otherEntries: String) = DirectoryEntr * Use the function `path(String) { ... }` to create a [PathWithCreator]. * * @return The newly created [Expect] for the extracted feature. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -267,7 +252,6 @@ fun path(path: String, assertionCreator: Expect.() -> Unit): PathWithCrea * take place. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -284,7 +268,6 @@ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") readable: read * at the location the link points at. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -305,7 +288,6 @@ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") writable: writ * at the location the link points at. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -325,7 +307,6 @@ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") executable: ex * take place. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -345,7 +326,6 @@ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") aRegularFile: * take place. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -357,7 +337,6 @@ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") aDirectory: aD * meaning that the [Path] specified in this instance starts at the file system root. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -369,7 +348,6 @@ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") absolute: abso * meaning that the [Path] specified in this instance does not start at the file system root. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.14.0 */ @@ -396,7 +374,6 @@ val Expect.extension: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -408,7 +385,6 @@ infix fun Expect.extension(assertionCreator: Expect.() -> * as [targetPath] (using UTF-8 for encoding) * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ @@ -438,7 +414,6 @@ fun withEncoding( * Use the function `withEncoding(Path, Charset, Charset)` to create a [PathWithEncoding]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ @@ -452,7 +427,6 @@ infix fun Expect.hasSameTextualContentAs(pathWithEncoding: PathWit * as [targetPath]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.13.0 */ diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/zonedDateTimeAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/zonedDateTimeAssertions.kt index 5c588e7198..70ea7c15c9 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/zonedDateTimeAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/zonedDateTimeAssertions.kt @@ -27,7 +27,6 @@ val Expect.year: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -51,7 +50,6 @@ val Expect.month: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -75,7 +73,6 @@ val Expect.dayOfWeek: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -99,7 +96,6 @@ val Expect.day: Expect * returns an [Expect] for the current subject of the assertion. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ diff --git a/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/resultAssertions.kt b/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/resultAssertions.kt index e4fea61ab0..fb3da3bdb9 100644 --- a/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/resultAssertions.kt +++ b/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/resultAssertions.kt @@ -12,7 +12,6 @@ import ch.tutteli.atrium.logic.kotlin_1_3.isSuccess * and returns an [Expect] for the inner type [E]. * * @return The newly created [Expect] if the given assertion is success - * @throws AssertionError Might throw an [AssertionError] if the given assertion is not a success. * * @since 0.12.0 */ @@ -26,7 +25,6 @@ infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") succes * Use the function `success { ... }` to create a [SuccessWithCreator]. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] if the given assertions are not success. * * @since 0.12.0 */ @@ -38,7 +36,6 @@ infix fun > Expect.toBe(success: SuccessWithCreator): Exp * that it encapsulates an exception of type [TExpected]. * * @return An [Expect] with the new type [TExpected] - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ @@ -51,7 +48,6 @@ inline fun Expect>.isFailure(): Ex * holds all assertions the given [assertionCreator] creates. * * @return An [Expect] with the new type [TExpected] - * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.12.0 */ diff --git a/core/api/atrium-core-api-common/src/main/kotlin/ch/tutteli/atrium/creating/Expect.kt b/core/api/atrium-core-api-common/src/main/kotlin/ch/tutteli/atrium/creating/Expect.kt index 465cea6cb1..d2f9db3b02 100644 --- a/core/api/atrium-core-api-common/src/main/kotlin/ch/tutteli/atrium/creating/Expect.kt +++ b/core/api/atrium-core-api-common/src/main/kotlin/ch/tutteli/atrium/creating/Expect.kt @@ -46,7 +46,6 @@ interface Expect : SubjectProvider { * @param assertionCreator The receiver function which should create and add assertions to this container. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] depending on the concrete implementation. */ fun addAssertionsCreatedBy(assertionCreator: Expect.() -> Unit): Expect @@ -56,9 +55,6 @@ interface Expect : SubjectProvider { * @param assertion The assertion which will be added to this container. * * @return An [Expect] for the current subject of the assertion. - * - * @throws AssertionError Might throw an [AssertionError] in case [Assertion]s are immediately - * evaluated (see [ReportingAssertionContainer]). */ override fun addAssertion(assertion: Assertion): Expect @@ -72,8 +68,6 @@ interface Expect : SubjectProvider { * @param test Indicates whether the assertion holds or fails. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] in case [Assertion]s are immediately - * evaluated (see [ReportingAssertionContainer]). */ fun createAndAddAssertion(description: String, expected: Any?, test: (T) -> Boolean): Expect = createAndAddAssertion(Untranslatable(description), expected, test) @@ -87,10 +81,7 @@ interface Expect : SubjectProvider { * @param test Indicates whether the assertion holds or fails. * * @return An [Expect] for the current subject of the assertion. - * @throws AssertionError Might throw an [AssertionError] in case [Assertion]s are immediately - * evaluated (see [ReportingAssertionContainer]). */ fun createAndAddAssertion(description: Translatable, expected: Any?, test: (T) -> Boolean): Expect = addAssertion(assertionBuilder.createDescriptive(this, description, expected, test)) - }