Documentation fixes

This commit is contained in:
r00telement
2022-01-10 03:30:46 +00:00
parent 18170be557
commit d41c0f73fe
3 changed files with 25 additions and 1 deletions

View File

@@ -396,7 +396,6 @@ namespace PlayerTags.GameInterface.ContextMenus
return false;
}
try
{
SubContextMenuOpenedImplementation(addon, ref atkValueCount, ref atkValues);

View File

@@ -4,18 +4,39 @@ using System.Collections.Generic;
namespace PlayerTags.GameInterface.ContextMenus
{
/// <summary>
/// Provides data for <see cref="ContextMenuOpenedDelegate"/> methods.
/// </summary>
public class ContextMenuOpenedArgs
{
/// <summary>
/// The addon associated with the context menu.
/// </summary>
public IntPtr Addon { get; }
/// <summary>
/// The agent associated with the context menu.
/// </summary>
public IntPtr Agent { get; }
/// <summary>
/// The the name of the parent addon associated with the context menu.
/// </summary>
public string? ParentAddonName { get; }
/// <summary>
/// The items in the context menu.
/// </summary>
public List<ContextMenuItem> ContextMenuItems { get; }
/// <summary>
/// The game object context associated with the context menu.
/// </summary>
public GameObjectContext? GameObjectContext { get; init; }
/// <summary>
/// The item context associated with the context menu.
/// </summary>
public ItemContext? ItemContext { get; init; }
public ContextMenuOpenedArgs(IntPtr addon, IntPtr agent, string? parentAddonName, IEnumerable<ContextMenuItem> contextMenuItems)

View File

@@ -1,4 +1,8 @@
namespace PlayerTags.GameInterface.ContextMenus
{
/// <summary>
/// Represents the method the <see cref="ContextMenu.ContextMenuOpened"/> event.
/// </summary>
/// <param name="args">The data associated with the <see cref="ContextMenu.ContextMenuOpened"/> event.</param>
public delegate void ContextMenuOpenedDelegate(ContextMenuOpenedArgs args);
}