From 0b5ad293913e834dffd2a621e3722d0d1677a72f Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Thu, 23 Jan 2025 15:03:40 +0100
Subject: [PATCH] Add documentation on buildMediaViewerPageList.

---
 .../mediaviewer/impl/viewer/MediaViewerDataSource.kt         | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/libraries/mediaviewer/impl/src/main/kotlin/io/element/android/libraries/mediaviewer/impl/viewer/MediaViewerDataSource.kt b/libraries/mediaviewer/impl/src/main/kotlin/io/element/android/libraries/mediaviewer/impl/viewer/MediaViewerDataSource.kt
index 5d610589b6..b185834c3e 100644
--- a/libraries/mediaviewer/impl/src/main/kotlin/io/element/android/libraries/mediaviewer/impl/viewer/MediaViewerDataSource.kt
+++ b/libraries/mediaviewer/impl/src/main/kotlin/io/element/android/libraries/mediaviewer/impl/viewer/MediaViewerDataSource.kt
@@ -102,6 +102,11 @@ class MediaViewerDataSource(
         return buildMediaViewerPageList(initialMediaItems)
     }
 
+    /**
+     * Build a list of [MediaViewerPageData] from a list of [MediaItem].
+     * In particular, create a mutable state of AsyncData<LocalMedia> for each media item, which
+     * will be used to render the downloaded media (see [loadMedia] which will update this value).
+     */
     private fun buildMediaViewerPageList(groupedItems: List<MediaItem>) = buildList {
         groupedItems.forEach { mediaItem ->
             when (mediaItem) {