From 06b6bcfd29a355b8a7ca89d2f2febafc74ca98d2 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Fri, 29 Oct 2021 14:51:06 +0900
Subject: [PATCH] Add xmldoc for `CreateScoreInfo` function for now

I don't actually know how temporary this one is going to be. The usages
are quite deep - ie. converting to a `ScoreInfo` to get a calculated
total score for ordering purposes.
---
 osu.Game/Online/API/Requests/Responses/APIScoreInfo.cs | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/osu.Game/Online/API/Requests/Responses/APIScoreInfo.cs b/osu.Game/Online/API/Requests/Responses/APIScoreInfo.cs
index b996d21ad3..4abb227414 100644
--- a/osu.Game/Online/API/Requests/Responses/APIScoreInfo.cs
+++ b/osu.Game/Online/API/Requests/Responses/APIScoreInfo.cs
@@ -70,7 +70,12 @@ namespace osu.Game.Online.API.Requests.Responses
         [JsonConverter(typeof(StringEnumConverter))]
         public ScoreRank Rank { get; set; }
 
-        // TODO: This function will eventually be going away.
+        /// <summary>
+        /// Create a <see cref="ScoreInfo"/> from an API score instance.
+        /// </summary>
+        /// <param name="rulesets">A ruleset store, used to populate a ruleset instance in the returned score.</param>
+        /// <param name="beatmap">An optional beatmap, copied into the returned score (for cases where the API does not populate the beatmap).</param>
+        /// <returns></returns>
         public ScoreInfo CreateScoreInfo(RulesetStore rulesets, BeatmapInfo beatmap = null)
         {
             var ruleset = rulesets.GetRuleset(OnlineRulesetID);