Update xmldoc for DangerousActionDialog to match new behaviour

This commit is contained in:
Dean Herbert 2023-03-07 18:00:37 +09:00
parent 908651cc11
commit 55467fcbe3

View File

@ -8,10 +8,14 @@ using osu.Game.Localisation;
namespace osu.Game.Overlays.Dialog namespace osu.Game.Overlays.Dialog
{ {
/// <summary> /// <summary>
/// Base class for various confirmation dialogs that concern deletion actions. /// A dialog which provides confirmation for actions which result in permanent consequences.
/// Differs from <see cref="ConfirmDialog"/> in that the confirmation button is a "dangerous" one /// Differs from <see cref="ConfirmDialog"/> in that the confirmation button is a "dangerous" one
/// (requires the confirm button to be held). /// (requires the confirm button to be held).
/// </summary> /// </summary>
/// <remarks>
/// The default implementation comes with text for a generic deletion operation.
/// This can be further customised by specifying custom <see cref="PopupDialog.HeaderText"/>.
/// </remarks>
public abstract partial class DangerousActionDialog : PopupDialog public abstract partial class DangerousActionDialog : PopupDialog
{ {
/// <summary> /// <summary>