Reword xmldoc to specify intended usage

This commit is contained in:
smoogipoo 2020-07-15 13:08:57 +09:00
parent 350a4a153b
commit e2c043737d
1 changed files with 5 additions and 1 deletions

View File

@ -58,8 +58,12 @@ public interface IOsuScreen : IScreen
bool AllowRateAdjustments { get; }
/// <summary>
/// Whether there are sub overlays/screens that need closing with the back button before this <see cref="IOsuScreen"/> can be exited.
/// Invoked when the back button has been pressed to close any overlays before exiting this <see cref="IOsuScreen"/>.
/// </summary>
/// <remarks>
/// Return <c>true</c> to block this <see cref="IOsuScreen"/> from being exited after closing an overlay.
/// Return <c>false</c> if this <see cref="IOsuScreen"/> should continue exiting.
/// </remarks>
bool OnBackButton();
}
}