KDoc

Author: rfc2822

lib/src/main/kotlin/at/bitfire/synctools/icalendar/validation/StreamPreprocessor.kt

@@ -6,14 +6,19 @@
 
 package at.bitfire.synctools.icalendar.validation
 
+/**
+ * This is a pre-processor for iCalendar lines that can detect and repair errors which
+ * cannot be repaired on a higher level (because parsing alone would cause syntax
+ * or other unrecoverable errors).
+ */
 interface StreamPreprocessor {
 
     /**
-     * Fixes an iCalendar string.
+     * Validates and potentially repairs an iCalendar string.
      *
-     * @param line      full line of an iCalendar lines to validate / fix
+     * @param line  full line of an iCalendar lines to validate / fix (without line break)
      *
-     * @return the potentially fixed version of [line]
+     * @return the potentially fixed version of [line] (without line break)
      */
     fun repairLine(line: String): String