docs(ICommandHookListener): add XML doc comments to ModId, Commands, Registration

This commit is contained in:
2026-06-21 12:18:19 +02:00
parent 912a78a689
commit 46dea83699
+18
View File
@@ -2,9 +2,27 @@ using System.Collections.Generic;
namespace CommandHook; namespace CommandHook;
/// <summary>
/// Implement this to watch chat commands through CommandHook. Pass your
/// implementation to <see cref="CommandHookModSystem.Register"/>.
/// </summary>
public interface ICommandHookListener public interface ICommandHookListener
{ {
/// <summary>
/// Your mod's id. Used as the namespace key so two mods can register
/// for the same command without colliding, and to find your existing
/// registration when you call <see cref="CommandHookModSystem.Register"/> again.
/// </summary>
string ModId { get; } string ModId { get; }
/// <summary>
/// The command names to watch, without the leading slash (e.g. "tp", not "/tp").
/// Return null or an empty list to stop watching anything.
/// </summary>
IReadOnlyList<string> Commands { get; } IReadOnlyList<string> Commands { get; }
/// <summary>
/// The Before/After delegates to invoke for the commands in <see cref="Commands"/>.
/// </summary>
CommandRegistration Registration { get; } CommandRegistration Registration { get; }
} }