erik/readingtime
erik/readingtime
1
1
Fork 0
Code Issues Pull requests Releases Activity

Add parameters kdoc for builder constructor

Browse source
This commit is contained in:
Erik C. Thauvin 2025-03-16 12:08:21 -07:00
parent 918efe4c70
commit f4f831895d
Signed by: erik
GPG key ID: 776702A6A2DA330E
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/main/kotlin/net/thauvin/erik/readingtime/Config.kt
View file

@ -33,7 +33,15 @@ package net.thauvin.erik.readingtime
import java.math.RoundingMode 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) { class Config private constructor(builder: Builder) {
val text = builder.text val text = builder.text