From b7b69707eb83fac01b30ad5b94bb8a2672fc2180 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Fri, 4 Nov 2016 20:13:58 -0400
Subject: document inventory changed event objects

---
 src/StardewModdingAPI/Inheritance/ChangeType.cs      | 6 ++++++
 src/StardewModdingAPI/Inheritance/ItemStackChange.cs | 9 +++++++++
 2 files changed, 15 insertions(+)

(limited to 'src/StardewModdingAPI')

diff --git a/src/StardewModdingAPI/Inheritance/ChangeType.cs b/src/StardewModdingAPI/Inheritance/ChangeType.cs
index 4eaa02af..94eb33ed 100644
--- a/src/StardewModdingAPI/Inheritance/ChangeType.cs
+++ b/src/StardewModdingAPI/Inheritance/ChangeType.cs
@@ -1,9 +1,15 @@
 namespace StardewModdingAPI.Inheritance
 {
+    /// <summary>Indicates how an inventory item changed.</summary>
     public enum ChangeType
     {
+        /// <summary>The entire stack was removed.</summary>
         Removed,
+
+        /// <summary>The entire stack was added.</summary>
         Added,
+
+        /// <summary>The stack size changed.</summary>
         StackChange
     }
 }
\ No newline at end of file
diff --git a/src/StardewModdingAPI/Inheritance/ItemStackChange.cs b/src/StardewModdingAPI/Inheritance/ItemStackChange.cs
index 8abe3a76..8d15b894 100644
--- a/src/StardewModdingAPI/Inheritance/ItemStackChange.cs
+++ b/src/StardewModdingAPI/Inheritance/ItemStackChange.cs
@@ -2,10 +2,19 @@
 
 namespace StardewModdingAPI.Inheritance
 {
+    /// <summary>Represents an inventory slot that changed.</summary>
     public class ItemStackChange
     {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The item in the slot.</summary>
         public Item Item { get; set; }
+
+        /// <summary>The amount by which the item's stack size changed.</summary>
         public int StackChange { get; set; }
+
+        /// <summary>How the inventory slot changed.</summary>
         public ChangeType ChangeType { get; set; }
     }
 }
\ No newline at end of file
-- 
cgit