Specify when the range is empty in KDoc

This commit is contained in:
Anastasiya Shadrina
2021-03-19 12:01:13 +07:00
committed by Anastasia Shadrina
parent 60f2f85be7
commit 94c4d1c23e
8 changed files with 79 additions and 7 deletions
@@ -22,6 +22,11 @@ public class UIntRange(start: UInt, endInclusive: UInt) : UIntProgression(start,
override fun contains(value: UInt): Boolean = first <= value && value <= last
/**
* Checks if the range is empty.
* The range is empty if its start value is greater than the end value.
*/
override fun isEmpty(): Boolean = first > last
override fun equals(other: Any?): Boolean =
@@ -72,7 +77,12 @@ internal constructor(
override fun iterator(): UIntIterator = UIntProgressionIterator(first, last, step)
/** Checks if the progression is empty. */
/**
* Checks if the progression is empty.
* Progression with a positive step is empty if its first element is greater than the last element.
* Progression with a negative step is empty if its first element is less than the last element.
*/
public open fun isEmpty(): Boolean = if (step > 0) first > last else first < last
override fun equals(other: Any?): Boolean =
@@ -22,6 +22,11 @@ public class ULongRange(start: ULong, endInclusive: ULong) : ULongProgression(st
override fun contains(value: ULong): Boolean = first <= value && value <= last
/**
* Checks if the range is empty.
* The range is empty if its start value is greater than the end value.
*/
override fun isEmpty(): Boolean = first > last
override fun equals(other: Any?): Boolean =
@@ -72,7 +77,12 @@ internal constructor(
override fun iterator(): ULongIterator = ULongProgressionIterator(first, last, step)
/** Checks if the progression is empty. */
/**
* Checks if the progression is empty.
* Progression with a positive step is empty if its first element is greater than the last element.
* Progression with a negative step is empty if its first element is less than the last element.
*/
public open fun isEmpty(): Boolean = if (step > 0) first > last else first < last
override fun equals(other: Any?): Boolean =