From 42b1e9d6a4185cea488227a159de1d256456bb4b Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Tue, 8 Dec 2020 15:54:52 +0900
Subject: [PATCH] Add xmldoc coverage of MultiplayerRoom

---
 .../RealtimeMultiplayer/MultiplayerRoom.cs    | 22 +++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/osu.Game/Online/RealtimeMultiplayer/MultiplayerRoom.cs b/osu.Game/Online/RealtimeMultiplayer/MultiplayerRoom.cs
index 7c3724915f..4bd8411344 100644
--- a/osu.Game/Online/RealtimeMultiplayer/MultiplayerRoom.cs
+++ b/osu.Game/Online/RealtimeMultiplayer/MultiplayerRoom.cs
@@ -9,14 +9,28 @@ namespace osu.Game.Online.RealtimeMultiplayer
     [Serializable]
     public class MultiplayerRoom
     {
+        /// <summary>
+        /// The ID of the room, used for database persistence.
+        /// </summary>
         public long RoomID { get; set; }
 
+        /// <summary>
+        /// The current state of the room (ie. whether it is in progress or otherwise).
+        /// </summary>
         public MultiplayerRoomState State { get; set; }
 
+        /// <summary>
+        /// All currently enforced game settings for this room.
+        /// </summary>
         public MultiplayerRoomSettings Settings { get; set; }
 
         private List<MultiplayerRoomUser> users = new List<MultiplayerRoomUser>();
 
+        private object writeLock = new object();
+
+        /// <summary>
+        /// All users which are currently in this room, in any state.
+        /// </summary>
         public IReadOnlyList<MultiplayerRoomUser> Users
         {
             get
@@ -26,6 +40,9 @@ public IReadOnlyList<MultiplayerRoomUser> Users
             }
         }
 
+        /// <summary>
+        /// Join a new user to this room.
+        /// </summary>
         public MultiplayerRoomUser Join(int userId)
         {
             var user = new MultiplayerRoomUser(userId);
@@ -33,6 +50,9 @@ public MultiplayerRoomUser Join(int userId)
             return user;
         }
 
+        /// <summary>
+        /// Remove a user from this room.
+        /// </summary>
         public MultiplayerRoomUser Leave(int userId)
         {
             MultiplayerRoomUser user = null;
@@ -48,8 +68,6 @@ public MultiplayerRoomUser Leave(int userId)
             return user;
         }
 
-        private object writeLock = new object();
-
         /// <summary>
         /// Perform an update on this room in a thread-safe manner.
         /// </summary>