Add documentation

1 files changed, 13 insertions, 0 deletions

diff --git a/src/main/java/at/bitfire/ical4android/AndroidEvent.kt b/src/main/java/at/bitfire/ical4android/AndroidEvent.kt
index ce9a959..3fed6b6 100644
--- a/src/main/java/at/bitfire/ical4android/AndroidEvent.kt
+++ b/src/main/java/at/bitfire/ical4android/AndroidEvent.kt
@@ -522,6 +522,13 @@ abstract class AndroidEvent(
         return resultUri
     }
 
+    /**
+     * Adds or updates the calendar provider [Events] main row for this [event].
+     *
+     * @param batch batch operation for insert/update operation
+     *
+     * @return [Events._ID] of the created/updated row; *null* if now ID is available
+     */
     fun addOrUpdateRows(batch: BatchOperation): Int? {
         val event = requireNotNull(event)
         val builder =
@@ -699,6 +706,12 @@ abstract class AndroidEvent(
     }
 
 
+    /**
+     * Builds an Android [Events] row for a given ical4android [Event].
+     *
+     * @param recurrence   event to be used as data source; *null*: use this AndroidEvent's main [event] as source
+     * @param builder      data row builder to be used
+     */
     @CallSuper
     protected open fun buildEvent(recurrence: Event?, builder: CpoBuilder) {
         val event = recurrence ?: requireNotNull(event)