document & format event code

1 files changed, 15 insertions, 3 deletions

diff --git a/src/StardewModdingAPI/Events/MineEvents.cs b/src/StardewModdingAPI/Events/MineEvents.cs
index b9c3070c..6121abf4 100644
--- a/src/StardewModdingAPI/Events/MineEvents.cs
+++ b/src/StardewModdingAPI/Events/MineEvents.cs
@@ -2,13 +2,25 @@
 
 namespace StardewModdingAPI.Events
 {
+    /// <summary>Events raised when something happens in the mines.</summary>
     public static class MineEvents
     {
+        /*********
+        ** Events
+        *********/
+        /// <summary>Raised after the player warps to a new level of the mine.</summary>
         public static event EventHandler<EventArgsMineLevelChanged> MineLevelChanged = delegate { };
 
-        internal static void InvokeMineLevelChanged(int previousMinelevel, int currentMineLevel)
+
+        /*********
+        ** Internal methods
+        *********/
+        /// <summary>Raise a <see cref="MineLevelChanged"/> event.</summary>
+        /// <param name="previousMineLevel">The previous mine level.</param>
+        /// <param name="currentMineLevel">The current mine level.</param>
+        internal static void InvokeMineLevelChanged(int previousMineLevel, int currentMineLevel)
         {
-            MineLevelChanged.Invoke(null, new EventArgsMineLevelChanged(previousMinelevel, currentMineLevel));
+            MineEvents.MineLevelChanged.Invoke(null, new EventArgsMineLevelChanged(previousMineLevel, currentMineLevel));
         }
     }
-}
\ No newline at end of file
+}