From 7fe85119219c17d459fd5a373916dafff7b4e2a2 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Mon, 31 Oct 2016 14:48:23 -0400
Subject: document & format event code

---
 .../Events/EventArgsMineLevelChanged.cs            | 26 +++++++++++++++++-----
 1 file changed, 20 insertions(+), 6 deletions(-)

(limited to 'src/StardewModdingAPI/Events/EventArgsMineLevelChanged.cs')

diff --git a/src/StardewModdingAPI/Events/EventArgsMineLevelChanged.cs b/src/StardewModdingAPI/Events/EventArgsMineLevelChanged.cs
index f95e0ac2..a02921d2 100644
--- a/src/StardewModdingAPI/Events/EventArgsMineLevelChanged.cs
+++ b/src/StardewModdingAPI/Events/EventArgsMineLevelChanged.cs
@@ -2,15 +2,29 @@
 
 namespace StardewModdingAPI.Events
 {
+    /// <summary>Event arguments for a <see cref="MineEvents.MineLevelChanged"/> event.</summary>
     public class EventArgsMineLevelChanged : EventArgs
     {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The previous mine level.</summary>
+        public int PreviousMineLevel { get; private set; }
+
+        /// <summary>The current mine level.</summary>
+        public int CurrentMineLevel { get; private set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="previousMineLevel">The previous mine level.</param>
+        /// <param name="currentMineLevel">The current mine level.</param>
         public EventArgsMineLevelChanged(int previousMineLevel, int currentMineLevel)
         {
-            PreviousMineLevel = previousMineLevel;
-            CurrentMineLevel = currentMineLevel;
+            this.PreviousMineLevel = previousMineLevel;
+            this.CurrentMineLevel = currentMineLevel;
         }
-
-        public int PreviousMineLevel { get; private set; }
-        public int CurrentMineLevel { get; private set; }
     }
-}
\ No newline at end of file
+}
-- 
cgit