1
0
mirror of https://github.com/ppy/osu.git synced 2025-01-13 14:12:56 +08:00

Add some xmldocs

This commit is contained in:
smoogipoo 2021-06-25 18:02:53 +09:00
parent c0d2b41d4c
commit 04279e7f5c
9 changed files with 27 additions and 7 deletions

View File

@ -9,6 +9,9 @@ using osu.Game.Tests.Visual.Spectator;
namespace osu.Game.Tests.Visual.Multiplayer
{
/// <summary>
/// Interface that defines the dependencies required for multiplayer test scenes.
/// </summary>
public interface IMultiplayerTestDependencies : IOnlinePlayTestDependencies
{
/// <summary>

View File

@ -10,12 +10,14 @@ using osu.Game.Tests.Visual.Spectator;
namespace osu.Game.Tests.Visual.Multiplayer
{
/// <summary>
/// Contains the basic dependencies of multiplayer test scenes.
/// </summary>
public class MultiplayerRoomTestDependencies : RoomTestDependencies, IMultiplayerTestDependencies
{
public TestMultiplayerClient Client { get; }
public TestUserLookupCache LookupCache { get; }
public TestSpectatorClient SpectatorClient { get; }
public new TestMultiplayerRoomManager RoomManager => (TestMultiplayerRoomManager)base.RoomManager;
public MultiplayerRoomTestDependencies()

View File

@ -9,6 +9,9 @@ using osu.Game.Tests.Visual.Spectator;
namespace osu.Game.Tests.Visual.Multiplayer
{
/// <summary>
/// The base test scene for all multiplayer components and screens.
/// </summary>
public abstract class MultiplayerTestScene : OnlinePlayTestScene, IMultiplayerTestDependencies
{
public const int PLAYER_1_ID = 55;
@ -21,8 +24,6 @@ namespace osu.Game.Tests.Visual.Multiplayer
protected new MultiplayerRoomTestDependencies RoomDependencies => (MultiplayerRoomTestDependencies)base.RoomDependencies;
protected override RoomTestDependencies CreateRoomDependencies() => new MultiplayerRoomTestDependencies();
private readonly bool joinRoom;
protected MultiplayerTestScene(bool joinRoom = true)
@ -58,9 +59,9 @@ namespace osu.Game.Tests.Visual.Multiplayer
base.SetUpSteps();
if (joinRoom)
{
AddUntilStep("wait for room join", () => Client.Room != null);
}
}
protected override RoomTestDependencies CreateRoomDependencies() => new MultiplayerRoomTestDependencies();
}
}

View File

@ -20,6 +20,9 @@ using osu.Game.Users;
namespace osu.Game.Tests.Visual.Multiplayer
{
/// <summary>
/// A <see cref="MultiplayerClient"/> for use in multiplayer test scenes. Should generally not be used by itself outside of a <see cref="MultiplayerTestScene"/>.
/// </summary>
public class TestMultiplayerClient : MultiplayerClient
{
public override IBindable<bool> IsConnected => isConnected;

View File

@ -11,11 +11,15 @@ using osu.Game.Online.API.Requests;
using osu.Game.Online.Rooms;
using osu.Game.Rulesets.Scoring;
using osu.Game.Scoring;
using osu.Game.Screens.OnlinePlay.Components;
using osu.Game.Screens.OnlinePlay.Lounge.Components;
using osu.Game.Screens.OnlinePlay.Multiplayer;
namespace osu.Game.Tests.Visual.Multiplayer
{
/// <summary>
/// A <see cref="RoomManager"/> for use in multiplayer test scenes. Should generally not be used by itself outside of a <see cref="MultiplayerTestScene"/>.
/// </summary>
public class TestMultiplayerRoomManager : MultiplayerRoomManager
{
[Resolved]

View File

@ -8,10 +8,14 @@ using osu.Game.Beatmaps;
using osu.Game.Online.Rooms;
using osu.Game.Rulesets;
using osu.Game.Screens.OnlinePlay;
using osu.Game.Screens.OnlinePlay.Components;
using osu.Game.Users;
namespace osu.Game.Tests.Visual.OnlinePlay
{
/// <summary>
/// A very simple <see cref="RoomManager"/> for use in online-play test scenes.
/// </summary>
public class BasicTestRoomManager : IRoomManager
{
public event Action RoomsUpdated

View File

@ -8,6 +8,9 @@ using osu.Game.Screens.OnlinePlay.Lounge.Components;
namespace osu.Game.Tests.Visual.OnlinePlay
{
/// <summary>
/// Interface that defines the dependencies required for online-play test scenes.
/// </summary>
public interface IOnlinePlayTestDependencies
{
/// <summary>

View File

@ -14,7 +14,7 @@ using osu.Game.Screens.OnlinePlay.Lounge.Components;
namespace osu.Game.Tests.Visual.OnlinePlay
{
/// <summary>
/// A <see cref="ScreenTestScene"/> providing all the dependencies cached by <see cref="OnlinePlayScreen"/> for testing <see cref="OnlinePlaySubScreen"/>s.
/// A base test scene for all online-play components and screens.
/// </summary>
public abstract class OnlinePlayTestScene : ScreenTestScene, IOnlinePlayTestDependencies
{

View File

@ -13,7 +13,7 @@ using osu.Game.Screens.OnlinePlay.Lounge.Components;
namespace osu.Game.Tests.Visual.OnlinePlay
{
/// <summary>
/// Contains dependencies for testing online-play rooms.
/// Contains the basic dependencies of online-play test scenes.
/// </summary>
public class RoomTestDependencies : IReadOnlyDependencyContainer, IOnlinePlayTestDependencies
{