From a7817e5e98c49d7cdaaa80b67da9bdc084289a4b Mon Sep 17 00:00:00 2001
From: R Midhun Suresh <hi@midhun.dev>
Date: Sun, 2 Mar 2025 16:35:25 +0530
Subject: [PATCH] Add more docs

---
 src/components/viewmodels/roomlist/RoomListViewModel.tsx | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/components/viewmodels/roomlist/RoomListViewModel.tsx b/src/components/viewmodels/roomlist/RoomListViewModel.tsx
index 97312d0504..1dacd030e2 100644
--- a/src/components/viewmodels/roomlist/RoomListViewModel.tsx
+++ b/src/components/viewmodels/roomlist/RoomListViewModel.tsx
@@ -9,9 +9,16 @@ import type { Room } from "matrix-js-sdk/src/matrix";
 import RoomListStoreV3 from "../../../stores/room-list-v3/RoomListStoreV3";
 
 export interface RoomListViewState {
+    /**
+     * A list of rooms to be displayed in the left panel.
+     */
     rooms: Room[];
 }
 
+/**
+ * View model for the new room list
+ * @see {@link RoomListViewState} for more information about what this view model returns.
+ */
 export function useRoomListViewModel(): RoomListViewState {
     const rooms = RoomListStoreV3.instance.getSortedRooms();
     return { rooms };