From be33a130d3a859fc58b9b79ff33a03300ae31529 Mon Sep 17 00:00:00 2001 From: InsanusMokrassar Date: Wed, 3 Jun 2020 20:16:53 +0600 Subject: [PATCH] add data docs --- .../kotlin/com/insanusmokrassar/krontab/utils/Data.kt | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/commonMain/kotlin/com/insanusmokrassar/krontab/utils/Data.kt b/src/commonMain/kotlin/com/insanusmokrassar/krontab/utils/Data.kt index 305df46..5060708 100644 --- a/src/commonMain/kotlin/com/insanusmokrassar/krontab/utils/Data.kt +++ b/src/commonMain/kotlin/com/insanusmokrassar/krontab/utils/Data.kt @@ -1,4 +1,12 @@ package com.insanusmokrassar.krontab.utils +/** + * @return [min] in case if [this] less than [min]. Otherwise will check that [max] grant than [this] and return [this] + * if so or [max] otherwise + */ internal fun Int.clamp(min: Int, max: Int): Int = if (this < min) min else if (this > max) max else this + +/** + * Wrapper function for [clamp] extension + */ internal fun Int.clamp(range: IntRange): Int = clamp(range.first, range.last)