HexagonShowSync: add docs on upload() return value

UweTrottmann · Nov 13, 2024 · fdac1e5 · fdac1e5
1 parent fd66724
commit fdac1e5
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/app/src/main/java/com/battlelancer/seriesguide/shows/tools/ShowTools2.kt b/app/src/main/java/com/battlelancer/seriesguide/shows/tools/ShowTools2.kt
@@ -475,6 +475,9 @@ class ShowTools2 @Inject constructor(
         return !isConnected
     }
 
+    /**
+     * Calls [HexagonShowSync.upload].
+     */
     private suspend fun uploadShowToCloud(show: SgCloudShow): Boolean {
         return hexagonShowSync.get().upload(show)
     }

diff --git a/app/src/main/java/com/battlelancer/seriesguide/sync/HexagonShowSync.kt b/app/src/main/java/com/battlelancer/seriesguide/sync/HexagonShowSync.kt
@@ -399,7 +399,7 @@ class HexagonShowSync @Inject constructor(
     }
 
     /**
-     * Uploads the given list of shows to Hexagon.
+     * Uploads the given list of shows to Hexagon. Returns `true` if upload succeeded.
      */
     fun upload(shows: List<SgCloudShow>): Boolean {
         if (shows.isEmpty()) {
@@ -430,6 +430,9 @@ class HexagonShowSync @Inject constructor(
         return true
     }
 
+    /**
+     * Calls [upload] on the IO dispatcher. Returns `true` if upload succeeded.
+     */
     suspend fun upload(show: SgCloudShow): Boolean {
         return withContext(Dispatchers.IO) {
             upload(listOf(show))