adding kdoc for coroutine-safety (#2417)

google · Jan 31, 2024 · d97031d · d97031d
1 parent d601844
commit d97031d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/engine/src/main/java/com/google/android/fhir/sync/FhirSynchronizer.kt b/engine/src/main/java/com/google/android/fhir/sync/FhirSynchronizer.kt
@@ -80,6 +80,11 @@ internal class FhirSynchronizer(
     return state
   }
 
+  /**
+   * Manages the sequential execution of downloading and uploading for coordinated operation. This
+   * function is coroutine-safe, ensuring that multiple invocations will not interfere with each
+   * other.
+   */
   suspend fun synchronize(): SyncJobStatus {
     mutex.withLock {
       setSyncState(SyncJobStatus.Started())