From 8e533220f005acbf313ec0ea9c54f3fa3380c40f Mon Sep 17 00:00:00 2001
From: teascade <teascade@gmail.com>
Date: Tue, 16 May 2017 15:21:42 +0300
Subject: [PATCH] Fix docs

---
 .../Scripts/Entities/SyncBases/Inventory.cs   |  3 ++
 .../Scripts/Items/InventoryActionHandler.cs   | 30 ++++++++++++++++++-
 2 files changed, 32 insertions(+), 1 deletion(-)

diff --git a/Assets/Scripts/Entities/SyncBases/Inventory.cs b/Assets/Scripts/Entities/SyncBases/Inventory.cs
index 38a61fd..1351830 100644
--- a/Assets/Scripts/Entities/SyncBases/Inventory.cs
+++ b/Assets/Scripts/Entities/SyncBases/Inventory.cs
@@ -28,6 +28,9 @@ namespace Cyber.Entities.SyncBases {
         /// </summary>
         public Character Character;
 
+        /// <summary>
+        /// The <see cref="InventoryActionHandler"/> which handles inventory actions properly.
+        /// </summary>
         public InventoryActionHandler ActionHandler;
 
         /// <summary>
diff --git a/Assets/Scripts/Items/InventoryActionHandler.cs b/Assets/Scripts/Items/InventoryActionHandler.cs
index 6dc005f..ddc584b 100644
--- a/Assets/Scripts/Items/InventoryActionHandler.cs
+++ b/Assets/Scripts/Items/InventoryActionHandler.cs
@@ -2,32 +2,60 @@
 using Cyber.Entities.SyncBases;
 using Cyber.Networking.Clientside;
 using Cyber.Networking.Messages;
-using UnityEngine;
 
 namespace Cyber.Items {
 
+    /// <summary>
+    /// Handles InventoryActions, building them on the client when needed and running them.
+    /// </summary>
     public class InventoryActionHandler {
 
         private Inventory Inventory;
         private Character Character;
 
+        /// <summary>
+        /// Creates an <see cref="InventoryActionHandler"/>
+        /// </summary>
+        /// <param name="inventory"></param>
+        /// <param name="character"></param>
         public InventoryActionHandler(Inventory inventory, Character character) {
             Inventory = inventory;
             Character = character;
         }
 
+        /// <summary>
+        /// Builds a <see cref="InventoryAction.Use"/> packet.
+        /// </summary>
+        /// <param name="slot">The equipped slot to use.</param>
+        /// <returns></returns>
         public InventoryActionPkt BuildUseItem(EquipSlot slot) {
             return new InventoryActionPkt(InventoryAction.Use, (int) slot);
         }
 
+        /// <summary>
+        /// Builds a <see cref="InventoryAction.Unequip"/> packet.
+        /// </summary>
+        /// <param name="slot">The equipped slot to clear.</param>
+        /// <returns></returns>
         public InventoryActionPkt BuildClearSlot(EquipSlot slot) {
             return new InventoryActionPkt(InventoryAction.Unequip, (int) slot);
         }
 
+        /// <summary>
+        /// Builds a <see cref="InventoryAction.Equip"/> packet.
+        /// </summary>
+        /// <param name="itemID">The item ID to equip.</param>
+        /// <returns></returns>
         public InventoryActionPkt BuildEquipItem(int itemID) {
             return new InventoryActionPkt(InventoryAction.Equip, itemID);
         }
 
+        /// <summary>
+        /// Handles an <see cref="InventoryActionPkt"/> to handle. Ran on server and client.
+        /// </summary>
+        /// <param name="action">The <see cref="InventoryAction"/> to run</param>
+        /// <param name="relatedInt">The item related to the action.</param>
+        /// <returns>Weather the action failed or not.</returns>
         public bool HandleAction(InventoryAction action, int relatedInt) {
             switch (action) {
             case InventoryAction.Equip: