From 5ca9a6a98018544d67f61ef1912596084a70999a Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Mon, 28 Dec 2020 20:05:48 +0900
Subject: [PATCH] Add xmldoc on UserLookupCache's lookup method

---
 osu.Game/Database/UserLookupCache.cs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/osu.Game/Database/UserLookupCache.cs b/osu.Game/Database/UserLookupCache.cs
index 05d6930992..8a99e27708 100644
--- a/osu.Game/Database/UserLookupCache.cs
+++ b/osu.Game/Database/UserLookupCache.cs
@@ -17,6 +17,12 @@ public class UserLookupCache : MemoryCachingComponent<int, User>
         [Resolved]
         private IAPIProvider api { get; set; }
 
+        /// <summary>
+        /// Perform an API lookup on the specified user, populating a <see cref="User"/> model.
+        /// </summary>
+        /// <param name="userId">The user to lookup.</param>
+        /// <param name="token">An optional cancellation token.</param>
+        /// <returns>The populated user, or null if the user does not exist or the request could not be satisfied.</returns>
         public Task<User> GetUserAsync(int userId, CancellationToken token = default) => GetAsync(userId, token);
 
         protected override async Task<User> ComputeValueAsync(int lookup, CancellationToken token = default)