HelperFunctions.kt has some documentation

2023-08-06 19:25:48 -04:00 · 2023-08-06 19:25:48 -04:00 · 7bda420a5d
commit 7bda420a5d
parent a8406bbc9a
1 changed files with 3 additions and 0 deletions
--- a/src/main/kotlin/HelperFunctions.kt
+++ b/src/main/kotlin/HelperFunctions.kt
@ -1,3 +1,6 @@
+/**
+ * A collection of helper functions for common utility tasks.
+ */
 object HelperFunctions {
    /**
     * Computes the total number of steps needed to process the given total volume.