From 189c680555e82222bf7115305b5156cb12d3adc8 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Tue, 27 Feb 2024 20:46:25 +0800
Subject: [PATCH] Add basic xmldoc on interface type

---
 .../Performance/IHighPerformanceSessionManager.cs     | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/osu.Game/Performance/IHighPerformanceSessionManager.cs b/osu.Game/Performance/IHighPerformanceSessionManager.cs
index 826a0a04f5..d3d1fda8fc 100644
--- a/osu.Game/Performance/IHighPerformanceSessionManager.cs
+++ b/osu.Game/Performance/IHighPerformanceSessionManager.cs
@@ -5,8 +5,19 @@ using System;
 
 namespace osu.Game.Performance
 {
+    /// <summary>
+    /// Allows creating a temporary "high performance" session, with the goal of optimising runtime
+    /// performance for gameplay purposes.
+    ///
+    /// On desktop platforms, this will set a low latency GC mode which collects more frequently to avoid
+    /// GC spikes.
+    /// </summary>
     public interface IHighPerformanceSessionManager
     {
+        /// <summary>
+        /// Start a new high performance session.
+        /// </summary>
+        /// <returns>An <see cref="IDisposable"/> which will end the session when disposed.</returns>
         IDisposable BeginSession();
     }
 }