InsanusMokrassar/krontab
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/krontab.git synced 2024-11-29 21:48:50 +00:00
Code Issues Projects Releases Wiki Activity

update CronDateTime documentation

Browse Source
This commit is contained in:
InsanusMokrassar 2020-06-03 20:19:57 +06:00
parent be33a130d3
commit 59cd600d60
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/commonMain/kotlin/com/insanusmokrassar/krontab/internal/CronDateTime.kt
View File

@ -5,11 +5,11 @@ import com.soywiz.klock.DateTime
import com.soywiz.klock.DateTimeSpan import com.soywiz.klock.DateTimeSpan
/** /**
* [month] 0-11 * @param month 0-11
* [dayOfMonth] 0-31 * @param dayOfMonth 0-31
* [hours] 0-23 * @param hours 0-23
* [minutes] 0-59 * @param minutes 0-59
* [seconds] 0-59 * @param seconds 0-59
*/ */
internal data class CronDateTime( internal data class CronDateTime(
val month: Byte? = null, val month: Byte? = null,
@ -29,6 +29,14 @@ internal data class CronDateTime(
internal val klockDayOfMonth = dayOfMonth ?.plus(1) internal val klockDayOfMonth = dayOfMonth ?.plus(1)
companion object { 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( fun create(
month: Int? = null, month: Int? = null,
dayOfMonth: Int? = null, dayOfMonth: Int? = null,