From 83bae81095dd8de79cfef2f166db8eeb16c0873a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= <dach.bartlomiej@gmail.com>
Date: Wed, 30 Mar 2022 22:02:51 +0200
Subject: [PATCH] Fill out `ICreateReplayData` xmldocs

---
 osu.Game/Rulesets/Mods/ICreateReplayData.cs | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/osu.Game/Rulesets/Mods/ICreateReplayData.cs b/osu.Game/Rulesets/Mods/ICreateReplayData.cs
index b022949345..1d07b95e7a 100644
--- a/osu.Game/Rulesets/Mods/ICreateReplayData.cs
+++ b/osu.Game/Rulesets/Mods/ICreateReplayData.cs
@@ -5,6 +5,7 @@ using System.Collections.Generic;
 using osu.Game.Beatmaps;
 using osu.Game.Online.API.Requests.Responses;
 using osu.Game.Replays;
+using osu.Game.Scoring;
 using osu.Game.Users;
 
 namespace osu.Game.Rulesets.Mods
@@ -17,9 +18,13 @@ namespace osu.Game.Rulesets.Mods
         /// <summary>
         /// Create replay data.
         /// </summary>
-        /// <param name="beatmap"></param>
-        /// <param name="mods"></param>
-        /// <returns></returns>
+        /// <param name="beatmap">The beatmap to create replay data for.</param>
+        /// <param name="mods">The mods to take into account when creating the replay data.</param>
+        /// <returns>A <see cref="ModReplayData"/> structure, containing the generated replay data.</returns>
+        /// <remarks>
+        /// For callers that want to receive a directly usable <see cref="Score"/> instance,
+        /// the <see cref="ModExtensions.CreateScoreFromReplayData"/> extension method is provided for convenience.
+        /// </remarks>
         public ModReplayData CreateReplayData(IBeatmap beatmap, IReadOnlyList<Mod> mods);
     }