From c2de0c055f3894c795ea7d7da774fb006c752898 Mon Sep 17 00:00:00 2001 From: Still Hsu <341464@gmail.com> Date: Sat, 5 May 2018 15:40:16 +0800 Subject: [PATCH] Fix seealso for preconditions and add missing descriptions --- .../Commands/PreconditionAttribute.Overwrites.md | 4 ---- .../Attributes/ParameterPreconditionAttribute.cs | 1 + .../Attributes/PreconditionAttribute.cs | 13 +++++++++++-- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/_overwrites/Commands/PreconditionAttribute.Overwrites.md b/docs/_overwrites/Commands/PreconditionAttribute.Overwrites.md index 9af953e72..75b9f93a5 100644 --- a/docs/_overwrites/Commands/PreconditionAttribute.Overwrites.md +++ b/docs/_overwrites/Commands/PreconditionAttribute.Overwrites.md @@ -1,7 +1,5 @@ --- uid: Discord.Commands.PreconditionAttribute -seealso: - - linkId: Discord.Commands.ParameterPreconditionAttribute remarks: *content --- @@ -12,8 +10,6 @@ method-level for a command. --- uid: Discord.Commands.ParameterPreconditionAttribute -seealso: - - linkId: Discord.Commands.PreconditionAttribute remarks: *content --- diff --git a/src/Discord.Net.Commands/Attributes/ParameterPreconditionAttribute.cs b/src/Discord.Net.Commands/Attributes/ParameterPreconditionAttribute.cs index efdb2c5b2..9b750809b 100644 --- a/src/Discord.Net.Commands/Attributes/ParameterPreconditionAttribute.cs +++ b/src/Discord.Net.Commands/Attributes/ParameterPreconditionAttribute.cs @@ -6,6 +6,7 @@ namespace Discord.Commands /// /// Requires the parameter to pass the specified precondition before execution can begin. /// + /// [AttributeUsage(AttributeTargets.Parameter, AllowMultiple = true, Inherited = true)] public abstract class ParameterPreconditionAttribute : Attribute { diff --git a/src/Discord.Net.Commands/Attributes/PreconditionAttribute.cs b/src/Discord.Net.Commands/Attributes/PreconditionAttribute.cs index 58d9c8ba4..1d791c92e 100644 --- a/src/Discord.Net.Commands/Attributes/PreconditionAttribute.cs +++ b/src/Discord.Net.Commands/Attributes/PreconditionAttribute.cs @@ -3,12 +3,15 @@ using System.Threading.Tasks; namespace Discord.Commands { - /// Requires the module or class to pass the specified precondition before execution can begin. + /// + /// Requires the module or class to pass the specified precondition before execution can begin. + /// + /// [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = true, Inherited = true)] public abstract class PreconditionAttribute : Attribute { /// - /// Specify a group that this precondition belongs to. + /// Specifies a group that this precondition belongs to. /// /// /// of the same group require only one of the preconditions to pass in order to @@ -17,6 +20,12 @@ namespace Discord.Commands /// public string Group { get; set; } = null; + /// + /// Checks if the has the sufficient permission to be executed. + /// + /// The context of the command. + /// The command being executed. + /// The service collection used for dependency injection. public abstract Task CheckPermissionsAsync(ICommandContext context, CommandInfo command, IServiceProvider services); } }