From a57af7413a2800a288a210f5f456cda7d188016f Mon Sep 17 00:00:00 2001
From: Anna Clemens <git@annaclemens.io>
Date: Fri, 30 Apr 2021 15:12:20 -0400
Subject: [PATCH] docs(context): add missing documentation

---
 .../Functions/ContextMenu/BaseContextMenuArgs.cs     |  3 +++
 XivCommon/Functions/ContextMenu/ContextMenu.cs       | 11 +++++++++++
 .../Functions/ContextMenu/CustomContextMenuItem.cs   |  2 +-
 .../Inventory/BaseInventoryContextMenuArgs.cs        | 12 ++++++++++++
 .../Inventory/InventoryContextMenuItem.cs            |  8 ++++++++
 .../InventoryContextMenuItemSelectedArgs.cs          |  3 +++
 .../Inventory/InventoryContextMenuOpenArgs.cs        |  3 +++
 .../ContextMenu/NormalCustomContextMenuItem.cs       | 11 +++++++++++
 8 files changed, 52 insertions(+), 1 deletion(-)

diff --git a/XivCommon/Functions/ContextMenu/BaseContextMenuArgs.cs b/XivCommon/Functions/ContextMenu/BaseContextMenuArgs.cs
index 35bc539..31ef8e5 100755
--- a/XivCommon/Functions/ContextMenu/BaseContextMenuArgs.cs
+++ b/XivCommon/Functions/ContextMenu/BaseContextMenuArgs.cs
@@ -1,6 +1,9 @@
 using System;
 
 namespace XivCommon.Functions.ContextMenu {
+    /// <summary>
+    /// The base class for context menu arguments
+    /// </summary>
     public abstract class BaseContextMenuArgs {
         /// <summary>
         /// Pointer to the context menu addon.
diff --git a/XivCommon/Functions/ContextMenu/ContextMenu.cs b/XivCommon/Functions/ContextMenu/ContextMenu.cs
index 3c00357..28de447 100755
--- a/XivCommon/Functions/ContextMenu/ContextMenu.cs
+++ b/XivCommon/Functions/ContextMenu/ContextMenu.cs
@@ -78,8 +78,19 @@ namespace XivCommon.Functions.ContextMenu {
         /// </summary>
         public event ContextMenuOpenEventDelegate? OpenContextMenu;
 
+        /// <summary>
+        /// The delegate for inventory context menu events.
+        /// </summary>
         public delegate void InventoryContextMenuOpenEventDelegate(InventoryContextMenuOpenArgs args);
 
+        /// <summary>
+        /// <para>
+        /// The event that is fired when an inventory context menu is being prepared for opening.
+        /// </para>
+        /// <para>
+        /// Requires the <see cref="Hooks.ContextMenu"/> hook to be enabled.
+        /// </para>
+        /// </summary>
         public event InventoryContextMenuOpenEventDelegate? OpenInventoryContextMenu;
 
         /// <summary>
diff --git a/XivCommon/Functions/ContextMenu/CustomContextMenuItem.cs b/XivCommon/Functions/ContextMenu/CustomContextMenuItem.cs
index 9170015..b5fbf8c 100755
--- a/XivCommon/Functions/ContextMenu/CustomContextMenuItem.cs
+++ b/XivCommon/Functions/ContextMenu/CustomContextMenuItem.cs
@@ -36,7 +36,7 @@ namespace XivCommon.Functions.ContextMenu {
         /// </summary>
         /// <param name="name">the English name of the item, copied to other languages</param>
         /// <param name="action">the action to perform on click</param>
-        public CustomContextMenuItem(string name, T action) {
+        internal CustomContextMenuItem(string name, T action) {
             this.NameEnglish = name;
             this.NameJapanese = name;
             this.NameFrench = name;
diff --git a/XivCommon/Functions/ContextMenu/Inventory/BaseInventoryContextMenuArgs.cs b/XivCommon/Functions/ContextMenu/Inventory/BaseInventoryContextMenuArgs.cs
index 973b974..116b43d 100755
--- a/XivCommon/Functions/ContextMenu/Inventory/BaseInventoryContextMenuArgs.cs
+++ b/XivCommon/Functions/ContextMenu/Inventory/BaseInventoryContextMenuArgs.cs
@@ -1,6 +1,9 @@
 using System;
 
 namespace XivCommon.Functions.ContextMenu.Inventory {
+    /// <summary>
+    /// The base class for inventory context menu arguments
+    /// </summary>
     public abstract class BaseInventoryContextMenuArgs {
         /// <summary>
         /// Pointer to the context menu addon.
@@ -17,10 +20,19 @@ namespace XivCommon.Functions.ContextMenu.Inventory {
         /// </summary>
         public string? ParentAddonName { get; }
 
+        /// <summary>
+        /// The ID of the item this context menu is for.
+        /// </summary>
         public uint ItemId { get; }
 
+        /// <summary>
+        /// The amount of the item this context menu is for.
+        /// </summary>
         public uint ItemAmount { get; }
 
+        /// <summary>
+        /// If the item this context menu is for is high-quality.
+        /// </summary>
         public bool ItemHq { get; }
 
         internal BaseInventoryContextMenuArgs(IntPtr addon, IntPtr agent, string? parentAddonName, uint itemId, uint itemAmount, bool itemHq) {
diff --git a/XivCommon/Functions/ContextMenu/Inventory/InventoryContextMenuItem.cs b/XivCommon/Functions/ContextMenu/Inventory/InventoryContextMenuItem.cs
index 2280514..3d3514c 100755
--- a/XivCommon/Functions/ContextMenu/Inventory/InventoryContextMenuItem.cs
+++ b/XivCommon/Functions/ContextMenu/Inventory/InventoryContextMenuItem.cs
@@ -1,5 +1,13 @@
 namespace XivCommon.Functions.ContextMenu.Inventory {
+    /// <summary>
+    /// A custom context menu item for inventory items.
+    /// </summary>
     public class InventoryContextMenuItem : CustomContextMenuItem<ContextMenu.InventoryContextMenuItemSelectedDelegate> {
+        /// <summary>
+        /// Create a new context menu item for inventory items.
+        /// </summary>
+        /// <param name="name">the English name of the item, copied to other languages</param>
+        /// <param name="action">the action to perform on click</param>
         public InventoryContextMenuItem(string name, ContextMenu.InventoryContextMenuItemSelectedDelegate action) : base(name, action) {
         }
     }
diff --git a/XivCommon/Functions/ContextMenu/Inventory/InventoryContextMenuItemSelectedArgs.cs b/XivCommon/Functions/ContextMenu/Inventory/InventoryContextMenuItemSelectedArgs.cs
index 327b76a..d42653b 100755
--- a/XivCommon/Functions/ContextMenu/Inventory/InventoryContextMenuItemSelectedArgs.cs
+++ b/XivCommon/Functions/ContextMenu/Inventory/InventoryContextMenuItemSelectedArgs.cs
@@ -1,6 +1,9 @@
 using System;
 
 namespace XivCommon.Functions.ContextMenu.Inventory {
+    /// <summary>
+    /// The arguments for when an inventory context menu item is selected
+    /// </summary>
     public class InventoryContextMenuItemSelectedArgs : BaseInventoryContextMenuArgs {
         internal InventoryContextMenuItemSelectedArgs(IntPtr addon, IntPtr agent, string? parentAddonName, uint itemId, uint itemAmount, bool itemHq) : base(addon, agent, parentAddonName, itemId, itemAmount, itemHq) {
         }
diff --git a/XivCommon/Functions/ContextMenu/Inventory/InventoryContextMenuOpenArgs.cs b/XivCommon/Functions/ContextMenu/Inventory/InventoryContextMenuOpenArgs.cs
index a0c60ff..9c15020 100755
--- a/XivCommon/Functions/ContextMenu/Inventory/InventoryContextMenuOpenArgs.cs
+++ b/XivCommon/Functions/ContextMenu/Inventory/InventoryContextMenuOpenArgs.cs
@@ -2,6 +2,9 @@
 using System.Collections.Generic;
 
 namespace XivCommon.Functions.ContextMenu.Inventory {
+    /// <summary>
+    /// The arguments for when an inventory context menu is opened
+    /// </summary>
     public class InventoryContextMenuOpenArgs : BaseInventoryContextMenuArgs {
         /// <summary>
         /// Context menu items in this menu.
diff --git a/XivCommon/Functions/ContextMenu/NormalCustomContextMenuItem.cs b/XivCommon/Functions/ContextMenu/NormalCustomContextMenuItem.cs
index 0e345fe..31bde81 100755
--- a/XivCommon/Functions/ContextMenu/NormalCustomContextMenuItem.cs
+++ b/XivCommon/Functions/ContextMenu/NormalCustomContextMenuItem.cs
@@ -1,5 +1,16 @@
 namespace XivCommon.Functions.ContextMenu {
+    /// <summary>
+    /// A custom normal context menu item
+    /// </summary>
     public class NormalContextMenuItem : CustomContextMenuItem<ContextMenu.ContextMenuItemSelectedDelegate> {
+        /// <summary>
+        /// Create a new custom context menu item.
+        /// </summary>
+        /// <summary>
+        /// Create a new context menu item for inventory items.
+        /// </summary>
+        /// <param name="name">the English name of the item, copied to other languages</param>
+        /// <param name="action">the action to perform on click</param>
         public NormalContextMenuItem(string name, ContextMenu.ContextMenuItemSelectedDelegate action) : base(name, action) {
         }
     }