From 2cadab8d29a3e5f30fbc9676f1a23d3fdd6df682 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= <dach.bartlomiej@gmail.com>
Date: Sat, 13 Jun 2020 16:20:59 +0200
Subject: [PATCH] Add xmldoc

---
 osu.Game.Tournament/IPC/FileBasedIPC.cs  | 10 ++++++++++
 osu.Game.Tournament/Models/StableInfo.cs |  6 ++++++
 2 files changed, 16 insertions(+)

diff --git a/osu.Game.Tournament/IPC/FileBasedIPC.cs b/osu.Game.Tournament/IPC/FileBasedIPC.cs
index d52a2b6445..681839ebc4 100644
--- a/osu.Game.Tournament/IPC/FileBasedIPC.cs
+++ b/osu.Game.Tournament/IPC/FileBasedIPC.cs
@@ -157,6 +157,11 @@ namespace osu.Game.Tournament.IPC
             return IPCStorage;
         }
 
+        /// <summary>
+        /// Manually sets the path to the directory used for inter-process communication with a cutting-edge install.
+        /// </summary>
+        /// <param name="path">Path to the IPC directory</param>
+        /// <returns>Whether the supplied path was a valid IPC directory.</returns>
         public bool SetIPCLocation(string path)
         {
             if (path == null || !ipcFileExistsInDirectory(path))
@@ -170,6 +175,11 @@ namespace osu.Game.Tournament.IPC
             return true;
         }
 
+        /// <summary>
+        /// Tries to automatically detect the path to the directory used for inter-process communication
+        /// with a cutting-edge install.
+        /// </summary>
+        /// <returns>Whether an IPC directory was successfully auto-detected.</returns>
         public bool AutoDetectIPCLocation() => SetIPCLocation(findStablePath());
 
         private static bool ipcFileExistsInDirectory(string p) => File.Exists(Path.Combine(p, "ipc.txt"));
diff --git a/osu.Game.Tournament/Models/StableInfo.cs b/osu.Game.Tournament/Models/StableInfo.cs
index 1faf6beaff..0b0050a245 100644
--- a/osu.Game.Tournament/Models/StableInfo.cs
+++ b/osu.Game.Tournament/Models/StableInfo.cs
@@ -14,8 +14,14 @@ namespace osu.Game.Tournament.Models
     [Serializable]
     public class StableInfo
     {
+        /// <summary>
+        /// Path to the IPC directory used by the stable (cutting-edge) install.
+        /// </summary>
         public string StablePath { get; set; }
 
+        /// <summary>
+        /// Fired whenever stable info is successfully saved to file.
+        /// </summary>
         public event Action OnStableInfoSaved;
 
         private const string config_path = "tournament/stable.json";