From d41c0f73fef00423a7cf84ba57ec1f11e6c223f1 Mon Sep 17 00:00:00 2001
From: r00telement <47005506+r00telement@users.noreply.github.com>
Date: Mon, 10 Jan 2022 03:30:46 +0000
Subject: [PATCH] Documentation fixes
---
.../GameInterface/ContextMenus/ContextMenu.cs | 1 -
.../ContextMenus/ContextMenuOpenedArgs.cs | 21 +++++++++++++++++++
.../ContextMenus/ContextMenuOpenedDelegate.cs | 4 ++++
3 files changed, 25 insertions(+), 1 deletion(-)
diff --git a/PlayerTags/GameInterface/ContextMenus/ContextMenu.cs b/PlayerTags/GameInterface/ContextMenus/ContextMenu.cs
index 8178b7b..db8ee99 100644
--- a/PlayerTags/GameInterface/ContextMenus/ContextMenu.cs
+++ b/PlayerTags/GameInterface/ContextMenus/ContextMenu.cs
@@ -396,7 +396,6 @@ namespace PlayerTags.GameInterface.ContextMenus
return false;
}
-
try
{
SubContextMenuOpenedImplementation(addon, ref atkValueCount, ref atkValues);
diff --git a/PlayerTags/GameInterface/ContextMenus/ContextMenuOpenedArgs.cs b/PlayerTags/GameInterface/ContextMenus/ContextMenuOpenedArgs.cs
index f4e30ae..b182212 100644
--- a/PlayerTags/GameInterface/ContextMenus/ContextMenuOpenedArgs.cs
+++ b/PlayerTags/GameInterface/ContextMenus/ContextMenuOpenedArgs.cs
@@ -4,18 +4,39 @@ using System.Collections.Generic;
namespace PlayerTags.GameInterface.ContextMenus
{
+ ///
+ /// Provides data for methods.
+ ///
public class ContextMenuOpenedArgs
{
+ ///
+ /// The addon associated with the context menu.
+ ///
public IntPtr Addon { get; }
+ ///
+ /// The agent associated with the context menu.
+ ///
public IntPtr Agent { get; }
+ ///
+ /// The the name of the parent addon associated with the context menu.
+ ///
public string? ParentAddonName { get; }
+ ///
+ /// The items in the context menu.
+ ///
public List ContextMenuItems { get; }
+ ///
+ /// The game object context associated with the context menu.
+ ///
public GameObjectContext? GameObjectContext { get; init; }
+ ///
+ /// The item context associated with the context menu.
+ ///
public ItemContext? ItemContext { get; init; }
public ContextMenuOpenedArgs(IntPtr addon, IntPtr agent, string? parentAddonName, IEnumerable contextMenuItems)
diff --git a/PlayerTags/GameInterface/ContextMenus/ContextMenuOpenedDelegate.cs b/PlayerTags/GameInterface/ContextMenus/ContextMenuOpenedDelegate.cs
index f09216f..c6a22de 100644
--- a/PlayerTags/GameInterface/ContextMenus/ContextMenuOpenedDelegate.cs
+++ b/PlayerTags/GameInterface/ContextMenus/ContextMenuOpenedDelegate.cs
@@ -1,4 +1,8 @@
namespace PlayerTags.GameInterface.ContextMenus
{
+ ///
+ /// Represents the method the event.
+ ///
+ /// The data associated with the event.
public delegate void ContextMenuOpenedDelegate(ContextMenuOpenedArgs args);
}