From e4b17588f52361048a05fea72203e69d97c653ab Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Mon, 6 Feb 2023 14:11:40 +0900
Subject: [PATCH] Add missing xmldoc to new methods in `EditorChangeHandler`

---
 osu.Game/Screens/Edit/EditorChangeHandler.cs | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/osu.Game/Screens/Edit/EditorChangeHandler.cs b/osu.Game/Screens/Edit/EditorChangeHandler.cs
index 0391da6d86..4511b654b6 100644
--- a/osu.Game/Screens/Edit/EditorChangeHandler.cs
+++ b/osu.Game/Screens/Edit/EditorChangeHandler.cs
@@ -96,8 +96,18 @@ namespace osu.Game.Screens.Edit
             updateBindables();
         }
 
+        /// <summary>
+        /// Write a serialised copy of the currently tracked state to the provided stream.
+        /// This will be stored as a state which can be restored in the future.
+        /// </summary>
+        /// <param name="stream">The stream which the state should be written to.</param>
         protected abstract void WriteCurrentStateToStream(MemoryStream stream);
 
+        /// <summary>
+        /// Given a previous and new state, apply any changes required to bring the current state in line with the new state.
+        /// </summary>
+        /// <param name="previousState">The previous (current before this call) serialised state.</param>
+        /// <param name="newState">The new state to be applied.</param>
         protected abstract void ApplyStateChange(byte[] previousState, byte[] newState);
 
         private void updateBindables()