@@ -118,6 +118,8 @@ impl RoomList {
118118 /// Get a subscriber to the room list loading state.
119119 ///
120120 /// This method will send out the current loading state as the first update.
121+ ///
122+ /// See [`RoomListLoadingState`].
121123 pub fn loading_state ( & self ) -> Subscriber < RoomListLoadingState > {
122124 self . loading_state . subscribe_reset ( )
123125 }
@@ -285,6 +287,8 @@ fn merge_stream_and_receiver(
285287/// When a [`RoomList`] is displayed to the user, it can be in various states.
286288/// This enum tries to represent those states with a correct level of
287289/// abstraction.
290+ ///
291+ /// See [`RoomList::loading_state`].
288292#[ derive( Clone , Debug , PartialEq , Eq ) ]
289293pub enum RoomListLoadingState {
290294 /// The [`RoomList`] has not been loaded yet, i.e. a sync might run
@@ -309,8 +313,8 @@ pub enum RoomListLoadingState {
309313 /// The maximum number of rooms a [`RoomList`] contains.
310314 ///
311315 /// It does not mean that there are exactly this many rooms to display.
312- /// Usually, the room entries are represented by [`Room `]. The room
313- /// entry might have been synced or not synced yet, but we know for sure
316+ /// The room entries are represented by [`RoomListItem `]. The room entry
317+ /// might have been synced or not synced yet, but we know for sure
314318 /// (from the server), that there will be this amount of rooms in the
315319 /// list at the end.
316320 ///
0 commit comments