Fill in missing xmldoc

This commit is contained in:
Dean Herbert
2020-02-21 15:35:40 +09:00
parent 92f6f0207c
commit b94f937f7e
2 changed files with 7 additions and 2 deletions

View File

@ -11,7 +11,7 @@ using osuTK.Graphics;
namespace osu.Game.Graphics.UserInterface namespace osu.Game.Graphics.UserInterface
{ {
/// <summary> /// <summary>
/// An overlay that will show a loading overlay and completely block input to an area. /// A layer that will show a loading spinner and completely block input to an area.
/// Also optionally dims target elements. /// Also optionally dims target elements.
/// Useful for disabling all elements in a form and showing we are waiting on a response, for instance. /// Useful for disabling all elements in a form and showing we are waiting on a response, for instance.
/// </summary> /// </summary>
@ -19,6 +19,11 @@ namespace osu.Game.Graphics.UserInterface
{ {
private readonly Drawable dimTarget; private readonly Drawable dimTarget;
/// <summary>
/// Constuct a new loading spinner.
/// </summary>
/// <param name="dimTarget">An optional target to dim when displayed.</param>
/// <param name="withBox">Whether the spinner should have a surrounding black box for visibility.</param>
public LoadingLayer(Drawable dimTarget = null, bool withBox = true) public LoadingLayer(Drawable dimTarget = null, bool withBox = true)
: base(withBox) : base(withBox)
{ {

View File

@ -26,7 +26,7 @@ namespace osu.Game.Graphics.UserInterface
/// <summary> /// <summary>
/// Constuct a new loading spinner. /// Constuct a new loading spinner.
/// </summary> /// </summary>
/// <param name="withBox"></param> /// <param name="withBox">Whether the spinner should have a surrounding black box for visibility.</param>
public LoadingSpinner(bool withBox = false) public LoadingSpinner(bool withBox = false)
{ {
Size = new Vector2(60); Size = new Vector2(60);