Update KDoc

bitfireAT · Oct 9, 2024 · 2d9ffaa · 2d9ffaa
1 parent b7cb85b
commit 2d9ffaa
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/app/src/main/kotlin/at/bitfire/davdroid/sync/Syncer.kt b/app/src/main/kotlin/at/bitfire/davdroid/sync/Syncer.kt
@@ -138,7 +138,9 @@ abstract class Syncer<CollectionType: LocalCollection<*>>(
  *
  * @param localCollections The local collections to be updated or deleted
  * @param dbCollections The database collections possibly containing new information
- * @return New found database collections to be created in provider
+ * @return Pair of:
+ * 1) New found database collections to be created in provider
+ * 2) Local collections which have been deleted
  */
  @VisibleForTesting
  internal fun updateCollections(
@@ -152,7 +154,7 @@ abstract class Syncer<CollectionType: LocalCollection<*>>(
  if (dbCollection == null) {
  // Collection not available in db = on server (anymore), delete obsolete local collection
  localCollection.deleteCollection()
- deletedLocalCollections.add(localCollection)
+ deletedLocalCollections.add(localCollection) // Add to "not to be synced" list
  } else {
  // Collection exists locally, update local collection and remove it from "to be created" map
  update(localCollection, dbCollection)