add xmldoc

This commit is contained in:
Davran Dilshat
2021-09-05 10:42:38 +01:00
parent 9aa1564e0d
commit e409f2dc6d

View File

@ -11,16 +11,30 @@ namespace osu.Game.Online.API.Requests
private readonly string userIdentifier; private readonly string userIdentifier;
public readonly RulesetInfo Ruleset; public readonly RulesetInfo Ruleset;
/// <summary>
/// Gets the currently logged-in user.
/// </summary>
public GetUserRequest() public GetUserRequest()
{ {
} }
/// <summary>
/// Gets a user from their ID.
/// </summary>
/// <param name="userId">The user to get.</param>
/// <param name="ruleset">The ruleset to get the user's info for.</param>
public GetUserRequest(long? userId = null, RulesetInfo ruleset = null) public GetUserRequest(long? userId = null, RulesetInfo ruleset = null)
{ {
this.userIdentifier = userId.ToString(); this.userIdentifier = userId.ToString();
Ruleset = ruleset; Ruleset = ruleset;
} }
/// <summary>
/// Gets a user from their username.
/// </summary>
/// <param name="username">The user to get.</param>
/// <param name="ruleset">The ruleset to get the user's info for.</param>
public GetUserRequest(string username = null, RulesetInfo ruleset = null) public GetUserRequest(string username = null, RulesetInfo ruleset = null)
{ {
this.userIdentifier = username; this.userIdentifier = username;