1
0
mirror of https://github.com/ppy/osu.git synced 2026-05-21 03:39:53 +08:00

A few more xmldocs

This commit is contained in:
smoogipoo
2021-04-15 19:35:57 +09:00
Unverified
parent 82fcabb8f0
commit 33cc5c5cb3
2 changed files with 9 additions and 6 deletions
@@ -6,7 +6,7 @@ using osu.Framework.Timing;
namespace osu.Game.Screens.OnlinePlay.Multiplayer.Spectate.Sync
{
/// <summary>
/// Manages the synchronisation between one or more slave clocks in relation to a master clock.
/// Manages the synchronisation between one or more <see cref="ISpectatorSlaveClock"/>s in relation to a master clock.
/// </summary>
public interface ISpectatorSyncManager
{
@@ -16,15 +16,15 @@ namespace osu.Game.Screens.OnlinePlay.Multiplayer.Spectate.Sync
IAdjustableClock Master { get; }
/// <summary>
/// Adds a slave clock.
/// Adds an <see cref="ISpectatorSlaveClock"/> to manage.
/// </summary>
/// <param name="clock">The clock to add.</param>
/// <param name="clock">The <see cref="ISpectatorSlaveClock"/> to add.</param>
void AddSlave(ISpectatorSlaveClock clock);
/// <summary>
/// Removes a slave clock.
/// Removes an <see cref="ISpectatorSlaveClock"/>, stopping it from being managed by this <see cref="ISpectatorSyncManager"/>.
/// </summary>
/// <param name="clock">The clock to remove.</param>
/// <param name="clock">The <see cref="ISpectatorSlaveClock"/> to remove.</param>
void RemoveSlave(ISpectatorSlaveClock clock);
}
}
@@ -7,10 +7,13 @@ using osu.Framework.Timing;
namespace osu.Game.Screens.OnlinePlay.Multiplayer.Spectate.Sync
{
/// <summary>
/// A <see cref="ISpectatorSlaveClock"/> which catches up using rate adjustment.
/// </summary>
public class SpectatorCatchUpSlaveClock : ISpectatorSlaveClock
{
/// <summary>
/// The catchup rate.
/// The catch up rate.
/// </summary>
public const double CATCHUP_RATE = 2;