From 59cd600d603629680220a63136c45ea3daa69629 Mon Sep 17 00:00:00 2001 From: InsanusMokrassar Date: Wed, 3 Jun 2020 20:19:57 +0600 Subject: [PATCH] update CronDateTime documentation --- .../krontab/internal/CronDateTime.kt | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/src/commonMain/kotlin/com/insanusmokrassar/krontab/internal/CronDateTime.kt b/src/commonMain/kotlin/com/insanusmokrassar/krontab/internal/CronDateTime.kt index 2cf6fb9..2c9e235 100644 --- a/src/commonMain/kotlin/com/insanusmokrassar/krontab/internal/CronDateTime.kt +++ b/src/commonMain/kotlin/com/insanusmokrassar/krontab/internal/CronDateTime.kt @@ -5,11 +5,11 @@ import com.soywiz.klock.DateTime import com.soywiz.klock.DateTimeSpan /** - * [month] 0-11 - * [dayOfMonth] 0-31 - * [hours] 0-23 - * [minutes] 0-59 - * [seconds] 0-59 + * @param month 0-11 + * @param dayOfMonth 0-31 + * @param hours 0-23 + * @param minutes 0-59 + * @param seconds 0-59 */ internal data class CronDateTime( val month: Byte? = null, @@ -29,6 +29,14 @@ internal data class CronDateTime( internal val klockDayOfMonth = dayOfMonth ?.plus(1) companion object { + /** + * Using [clamp] extension for checking every parameter to be ensure that they are all correct + * @param month 0-11 + * @param dayOfMonth 0-31 + * @param hours 0-23 + * @param minutes 0-59 + * @param seconds 0-59 + */ fun create( month: Int? = null, dayOfMonth: Int? = null,