From c19b1f917f759cd8ac6478e4d1dbebd8b437e6aa Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Tue, 9 Jul 2019 17:16:17 +0200
Subject: [PATCH] Javadoc

---
 .../matrix/android/internal/worker/WorkManagerUtil.kt    | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/worker/WorkManagerUtil.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/worker/WorkManagerUtil.kt
index fa1d22a1..ea0ff282 100644
--- a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/worker/WorkManagerUtil.kt
+++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/worker/WorkManagerUtil.kt
@@ -22,17 +22,22 @@ import androidx.work.*
 internal object WorkManagerUtil {
     private const val MATRIX_SDK_TAG = "MatrixSDK"
 
-    // Default constraints: network
+    /**
+     * Default constraints: connected network
+     */
     val workConstraints = Constraints.Builder()
             .setRequiredNetworkType(NetworkType.CONNECTED)
             .build()
 
+    /**
+     * Create a OneTimeWorkRequestBuilder, with the Matrix SDK tag
+     */
     inline fun <reified W : ListenableWorker> matrixOneTimeWorkRequestBuilder() =
             OneTimeWorkRequestBuilder<W>()
                     .addTag(MATRIX_SDK_TAG)
 
     /**
-     * Cancel all work instanciated by the Matrix SDK and not those from the SDK client
+     * Cancel all works instantiated by the Matrix SDK and not those from the SDK client
      */
     fun cancelAllWorks(context: Context) {
         WorkManager.getInstance(context).also {