From f6e279baa1764a876884341a66f3af6ab05afd5d Mon Sep 17 00:00:00 2001
From: sh0ckR6 <sh0ck.04@outlook.com>
Date: Sat, 18 Sep 2021 12:18:11 -0400
Subject: [PATCH] Add xmldoc to HitErrorMeter.Clear

Explains how the method is called and what inheritors should do when implementing it.
---
 osu.Game/Screens/Play/HUD/HitErrorMeters/HitErrorMeter.cs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/osu.Game/Screens/Play/HUD/HitErrorMeters/HitErrorMeter.cs b/osu.Game/Screens/Play/HUD/HitErrorMeters/HitErrorMeter.cs
index 22ae3900d6..1871519ab5 100644
--- a/osu.Game/Screens/Play/HUD/HitErrorMeters/HitErrorMeter.cs
+++ b/osu.Game/Screens/Play/HUD/HitErrorMeters/HitErrorMeter.cs
@@ -73,6 +73,10 @@ namespace osu.Game.Screens.Play.HUD.HitErrorMeters
             }
         }
 
+        /// <summary>
+        /// Invoked by <see cref="Player.OnSeek"/> when the active <see cref="Player"/> seeks through the current beatmap.
+        /// Any inheritors of <see cref="HitErrorMeter"/> should have this method clear their container that displays the hit error results.
+        /// </summary>
         public abstract void Clear();
 
         protected override void Dispose(bool isDisposing)