1
0
mirror of https://github.com/ppy/osu.git synced 2025-02-15 16:03:01 +08:00

Fix up code comments

Default value restated in xmldoc was snipped because it's made redundant
by the initialiser and possibly bound to be outdated at some point.
This commit is contained in:
Bartłomiej Dach 2021-01-11 20:28:24 +01:00
parent 90fb67b377
commit 0d5fbb15ac
4 changed files with 4 additions and 4 deletions

View File

@ -49,7 +49,7 @@ namespace osu.Game.Online.Multiplayer
Task UserStateChanged(int userId, MultiplayerUserState state);
/// <summary>
/// Signals that a user in this room has their beatmap availability state changed.
/// Signals that a user in this room changed their beatmap availability state.
/// </summary>
/// <param name="userId">The ID of the user whose beatmap availability state has changed.</param>
/// <param name="beatmapAvailability">The new beatmap availability state of the user.</param>

View File

@ -42,7 +42,7 @@ namespace osu.Game.Online.Multiplayer
Task ChangeState(MultiplayerUserState newState);
/// <summary>
/// Change the user's local availability state of the beatmap set in joined room.
/// Change the local user's availability state of the current beatmap set in joined room.
/// </summary>
/// <param name="newBeatmapAvailability">The proposed new beatmap availability state.</param>
Task ChangeBeatmapAvailability(BeatmapAvailability newBeatmapAvailability);

View File

@ -18,7 +18,7 @@ namespace osu.Game.Online.Multiplayer
public MultiplayerUserState State { get; set; } = MultiplayerUserState.Idle;
/// <summary>
/// The availability state of the beatmap, set to <see cref="DownloadState.LocallyAvailable"/> by default.
/// The availability state of the current beatmap.
/// </summary>
public BeatmapAvailability BeatmapAvailability { get; set; } = BeatmapAvailability.LocallyAvailable();

View File

@ -322,7 +322,7 @@ namespace osu.Game.Online.Multiplayer
{
var user = Room?.Users.SingleOrDefault(u => u.UserID == userId);
// we don't care whether the room doesn't exist or user isn't in joined room, just return in that point.
// errors here are not critical - beatmap availability state is mostly for display.
if (user == null)
return;