RepoMirrors
/
osu
mirror of https://github.com/ppy/osu
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add xmldoc

This commit is contained in:
smoogipoo 2018-05-07 10:23:32 +09:00
parent b68ee39136
commit 7e83c75888
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
osu.Game/Beatmaps/WorkingBeatmap.cs
View File

@ -79,6 +79,13 @@ private IBeatmap populateOriginalBeatmap()
return b;
}
/// <summary>
/// Retrieves the resulting <see cref="IBeatmap"/> from the conversion of <see cref="OriginalBeatmap"/> to a specific <see cref="RulesetInfo"/>.
/// All mods have been applied to the returned <see cref="IBeatmap"/>.
/// </summary>
/// <param name="ruleset">The <see cref="RulesetInfo"/> to convert <see cref="OriginalBeatmap"/> to.</param>
/// <returns>The converted <see cref="IBeatmap"/>.</returns>
/// <exception cref="BeatmapInvalidForRulesetException">If <see cref="OriginalBeatmap"/> could not be converted to <paramref name="ruleset"/>.</exception>
public IBeatmap GetBeatmap(RulesetInfo ruleset)
{
var rulesetInstance = ruleset.CreateInstance();