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;
}
+ ///
+ /// Manually sets the path to the directory used for inter-process communication with a cutting-edge install.
+ ///
+ /// Path to the IPC directory
+ /// Whether the supplied path was a valid IPC directory.
public bool SetIPCLocation(string path)
{
if (path == null || !ipcFileExistsInDirectory(path))
@@ -170,6 +175,11 @@ namespace osu.Game.Tournament.IPC
return true;
}
+ ///
+ /// Tries to automatically detect the path to the directory used for inter-process communication
+ /// with a cutting-edge install.
+ ///
+ /// Whether an IPC directory was successfully auto-detected.
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
{
+ ///
+ /// Path to the IPC directory used by the stable (cutting-edge) install.
+ ///
public string StablePath { get; set; }
+ ///
+ /// Fired whenever stable info is successfully saved to file.
+ ///
public event Action OnStableInfoSaved;
private const string config_path = "tournament/stable.json";