From 8a6501fa58f67f49aa71df20dbb76a5caba92516 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Thu, 30 Sep 2021 14:46:07 +0900
Subject: [PATCH] Add basic component level xmldoc

---
 osu.Game/Beatmaps/BeatmapOnlineLookupQueue.cs | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/osu.Game/Beatmaps/BeatmapOnlineLookupQueue.cs b/osu.Game/Beatmaps/BeatmapOnlineLookupQueue.cs
index bbac30f2bb..19f02c82ec 100644
--- a/osu.Game/Beatmaps/BeatmapOnlineLookupQueue.cs
+++ b/osu.Game/Beatmaps/BeatmapOnlineLookupQueue.cs
@@ -21,6 +21,13 @@ using SharpCompress.Compressors.BZip2;
 
 namespace osu.Game.Beatmaps
 {
+    /// <summary>
+    /// A component which handles population of online IDs for beatmaps using a two part lookup procedure.
+    /// </summary>
+    /// <remarks>
+    /// On creating the component, a copy of a database containing metadata for a large subset of beatmaps (stored to <see cref="cache_database_name"/>).
+    /// This will always be checked before doing a second online query to get required metadata.
+    /// </remarks>
     [ExcludeFromDynamicCompile]
     public class BeatmapOnlineLookupQueue : IDisposable
     {