From 63a6fc25963ef227429f02ba7bce093e0a441a0d Mon Sep 17 00:00:00 2001
From: smoogipoo <smoogipoo@smgi.me>
Date: Thu, 21 Jun 2018 18:54:42 +0900
Subject: [PATCH] XMLDoc all the things

---
 osu.Game/Audio/PreviewTrack.cs        | 16 ++++++++++++++++
 osu.Game/Audio/PreviewTrackManager.cs | 17 +++++++++++++++++
 2 files changed, 33 insertions(+)

diff --git a/osu.Game/Audio/PreviewTrack.cs b/osu.Game/Audio/PreviewTrack.cs
index 59baa86f80..5fd3dbfe8f 100644
--- a/osu.Game/Audio/PreviewTrack.cs
+++ b/osu.Game/Audio/PreviewTrack.cs
@@ -11,7 +11,14 @@ namespace osu.Game.Audio
 {
     public abstract class PreviewTrack : Component
     {
+        /// <summary>
+        /// Invoked when this <see cref="PreviewTrack"/> has stopped playing.
+        /// </summary>
         public event Action Stopped;
+
+        /// <summary>
+        /// Invoked when this <see cref="PreviewTrack"/> has started playing.
+        /// </summary>
         public event Action Started;
 
         private Track track;
@@ -52,6 +59,9 @@ namespace osu.Game.Audio
 
         private ScheduledDelegate startDelegate;
 
+        /// <summary>
+        /// Starts playing this <see cref="PreviewTrack"/>.
+        /// </summary>
         public void Start() => startDelegate = Schedule(() =>
         {
             if (!IsLoaded)
@@ -68,6 +78,9 @@ namespace osu.Game.Audio
             Started?.Invoke();
         });
 
+        /// <summary>
+        /// Stops playing this <see cref="PreviewTrack"/>.
+        /// </summary>
         public void Stop()
         {
             startDelegate?.Cancel();
@@ -86,6 +99,9 @@ namespace osu.Game.Audio
             Stopped?.Invoke();
         }
 
+        /// <summary>
+        /// Retrieves the audio track.
+        /// </summary>
         protected abstract Track GetTrack();
     }
 }
diff --git a/osu.Game/Audio/PreviewTrackManager.cs b/osu.Game/Audio/PreviewTrackManager.cs
index 499e4a1eea..8febf8e621 100644
--- a/osu.Game/Audio/PreviewTrackManager.cs
+++ b/osu.Game/Audio/PreviewTrackManager.cs
@@ -11,6 +11,9 @@ using osu.Game.Beatmaps;
 
 namespace osu.Game.Audio
 {
+    /// <summary>
+    /// A central store for the retrieval of <see cref="PreviewTrack"/>s.
+    /// </summary>
     public class PreviewTrackManager : Component
     {
         private readonly BindableDouble muteBindable = new BindableDouble();
@@ -31,6 +34,11 @@ namespace osu.Game.Audio
             config.BindWith(FrameworkSetting.VolumeMusic, trackManager.Volume);
         }
 
+        /// <summary>
+        /// Retrieves a <see cref="PreviewTrack"/> for a <see cref="BeatmapSetInfo"/>.
+        /// </summary>
+        /// <param name="beatmapSetInfo">The <see cref="BeatmapSetInfo"/> to retrieve the preview track for.</param>
+        /// <returns>The playable <see cref="PreviewTrack"/>.</returns>
         public PreviewTrack Get(BeatmapSetInfo beatmapSetInfo)
         {
             var track = new TrackManagerPreviewTrack(beatmapSetInfo, trackManager);
@@ -51,6 +59,15 @@ namespace osu.Game.Audio
             return track;
         }
 
+        /// <summary>
+        /// Stops the currently playing <see cref="PreviewTrack"/>.
+        /// </summary>
+        /// <remarks>
+        /// Only the immediate owner (an object that implements <see cref="IPreviewTrackOwner"/>) of the playing <see cref="PreviewTrack"/>
+        /// can globally stop the currently playing <see cref="PreviewTrack"/>. The object holding a reference to the <see cref="PreviewTrack"/>
+        /// can always stop the <see cref="PreviewTrack"/> themselves through <see cref="PreviewTrack.Stop()"/>.
+        /// </remarks>
+        /// <param name="source">The <see cref="IPreviewTrackOwner"/> which may be the owner of the <see cref="PreviewTrack"/>.</param>
         public void Stop(IPreviewTrackOwner source)
         {
             if (current?.Owner != source)