From db4dd3182b2494f6aa641855a32928be9465c9d4 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Thu, 22 Oct 2020 13:12:58 +0900
Subject: [PATCH] Add xmldoc to spectator interfaces

---
 osu.Game/Online/Spectator/ISpectatorClient.cs | 23 +++++++++++++--
 osu.Game/Online/Spectator/ISpectatorServer.cs | 28 +++++++++++++++++++
 osu.Game/Online/Spectator/SpectatorClient.cs  |  1 -
 3 files changed, 48 insertions(+), 4 deletions(-)

diff --git a/osu.Game/Online/Spectator/ISpectatorClient.cs b/osu.Game/Online/Spectator/ISpectatorClient.cs
index 4741d7409a..ed762ac1fe 100644
--- a/osu.Game/Online/Spectator/ISpectatorClient.cs
+++ b/osu.Game/Online/Spectator/ISpectatorClient.cs
@@ -1,14 +1,31 @@
 using System.Threading.Tasks;
-using osu.Game.Online.Spectator;
 
-namespace osu.Server.Spectator.Hubs
+namespace osu.Game.Online.Spectator
 {
+    /// <summary>
+    /// An interface defining a spectator client instance.
+    /// </summary>
     public interface ISpectatorClient
     {
+        /// <summary>
+        /// Signals that a user has begun a new play session.
+        /// </summary>
+        /// <param name="userId">The user.</param>
+        /// <param name="beatmapId">The beatmap the user is playing.</param>
         Task UserBeganPlaying(string userId, int beatmapId);
 
+        /// <summary>
+        /// Signals that a user has finished a play session.
+        /// </summary>
+        /// <param name="userId">The user.</param>
+        /// <param name="beatmapId">The beatmap the user has finished playing.</param>
         Task UserFinishedPlaying(string userId, int beatmapId);
 
+        /// <summary>
+        /// Called when new frames are available for a subscribed user's play session.
+        /// </summary>
+        /// <param name="userId">The user.</param>
+        /// <param name="data">The frame data.</param>
         Task UserSentFrames(string userId, FrameDataBundle data);
     }
-}
\ No newline at end of file
+}
diff --git a/osu.Game/Online/Spectator/ISpectatorServer.cs b/osu.Game/Online/Spectator/ISpectatorServer.cs
index 1dcde30221..03ca37d524 100644
--- a/osu.Game/Online/Spectator/ISpectatorServer.cs
+++ b/osu.Game/Online/Spectator/ISpectatorServer.cs
@@ -2,13 +2,41 @@ using System.Threading.Tasks;
 
 namespace osu.Game.Online.Spectator
 {
+    /// <summary>
+    /// An interface defining the spectator server instance.
+    /// </summary>
     public interface ISpectatorServer
     {
+        /// <summary>
+        /// Signal the start of a new play session.
+        /// </summary>
+        /// <param name="beatmapId">The beatmap currently being played. Eventually this should be replaced with more complete metadata.</param>
         Task BeginPlaySession(int beatmapId);
+
+        /// <summary>
+        /// Send a bundle of frame data for the current play session.
+        /// </summary>
+        /// <param name="data">The frame data.</param>
         Task SendFrameData(FrameDataBundle data);
+
+        /// <summary>
+        /// Signal the end of a play session.
+        /// </summary>
+        /// <param name="beatmapId">The beatmap that was completed. This should be replaced with a play token once that flow is established.</param>
         Task EndPlaySession(int beatmapId);
 
+        /// <summary>
+        /// Request spectating data for the specified user. May be called on multiple users and offline users.
+        /// For offline users, a subscription will be created and data will begin streaming on next play.
+        /// </summary>
+        /// <param name="userId">The user to subscribe to.</param>
+        /// <returns></returns>
         Task StartWatchingUser(string userId);
+
+        /// <summary>
+        /// Stop requesting spectating data for the specified user. Unsubscribes from receiving further data.
+        /// </summary>
+        /// <param name="userId">The user to unsubscribe from.</param>
         Task EndWatchingUser(string userId);
     }
 }
diff --git a/osu.Game/Online/Spectator/SpectatorClient.cs b/osu.Game/Online/Spectator/SpectatorClient.cs
index c1414f7914..4558699618 100644
--- a/osu.Game/Online/Spectator/SpectatorClient.cs
+++ b/osu.Game/Online/Spectator/SpectatorClient.cs
@@ -3,7 +3,6 @@ using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.SignalR.Client;
-using osu.Server.Spectator.Hubs;
 
 namespace osu.Game.Online.Spectator
 {