From c75995f925eded9731f5df4ba859ad8df45fac16 Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Mon, 29 Apr 2024 14:16:12 +0200
Subject: [PATCH] Add documentation on new API.

---
 .../android/libraries/matrix/api/room/MatrixRoom.kt        | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/room/MatrixRoom.kt b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/room/MatrixRoom.kt
index 86e943fea9..fc4ded247a 100644
--- a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/room/MatrixRoom.kt
+++ b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/room/MatrixRoom.kt
@@ -98,8 +98,15 @@ interface MatrixRoom : Closeable {
 
     val syncUpdateFlow: StateFlow<Long>
 
+    /**
+     * The live timeline of the room. Must be used to send Event to a room.
+     */
     val liveTimeline: Timeline
 
+    /**
+     * Create a new timeline, focused on the provided Event.
+     * Should not be used directly, see `TimelineController` to manage the various timelines.
+     */
     suspend fun timelineFocusedOnEvent(eventId: EventId): Result<Timeline>
 
     fun destroy()