From f4f831895d710c6c87ea394aca76e33d975ecf22 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Sun, 16 Mar 2025 12:08:21 -0700 Subject: [PATCH] Add parameters kdoc for builder constructor --- src/main/kotlin/net/thauvin/erik/readingtime/Config.kt | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/main/kotlin/net/thauvin/erik/readingtime/Config.kt b/src/main/kotlin/net/thauvin/erik/readingtime/Config.kt index 139d4eb..d649881 100644 --- a/src/main/kotlin/net/thauvin/erik/readingtime/Config.kt +++ b/src/main/kotlin/net/thauvin/erik/readingtime/Config.kt @@ -33,7 +33,15 @@ package net.thauvin.erik.readingtime import java.math.RoundingMode /** - * Provides a configuration builder. + * Configuration class for reading time calculations. + * + * @property text The text to be evaluated. + * @property wpm The words per minute reading average. + * @property postfix The text to append after the reading time. + * @property plural The text to append after the reading time if plural. + * @property excludeImages Whether to exclude images in the word count. + * @property extra Additional time to add to the reading time. + * @property roundingMode The rounding mode to apply to the reading time. */ class Config private constructor(builder: Builder) { val text = builder.text