From 5ea3e113b80122c03beae36a262772e8b518a654 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 13 May 2019 15:28:13 -0700 Subject: [PATCH] docs: add missing xmldoc for inherited properties and NotAGuildErrorMessage (#1301) - adds inheritdoc tag to the inherited ErrorMessage properties of several attributes - adds xmldoc summary for the NotAGuildErrorMessage properties --- .../Attributes/Preconditions/RequireBotPermissionAttribute.cs | 5 +++++ .../Attributes/Preconditions/RequireContextAttribute.cs | 1 + .../Attributes/Preconditions/RequireNsfwAttribute.cs | 1 + .../Attributes/Preconditions/RequireOwnerAttribute.cs | 1 + .../Attributes/Preconditions/RequireUserPermissionAttribute.cs | 5 +++++ 5 files changed, 13 insertions(+) diff --git a/src/Discord.Net.Commands/Attributes/Preconditions/RequireBotPermissionAttribute.cs b/src/Discord.Net.Commands/Attributes/Preconditions/RequireBotPermissionAttribute.cs index 1ab05531a..5b3b5bd47 100644 --- a/src/Discord.Net.Commands/Attributes/Preconditions/RequireBotPermissionAttribute.cs +++ b/src/Discord.Net.Commands/Attributes/Preconditions/RequireBotPermissionAttribute.cs @@ -17,7 +17,12 @@ namespace Discord.Commands /// Gets the specified of the precondition. /// public ChannelPermission? ChannelPermission { get; } + /// public override string ErrorMessage { get; set; } + /// + /// Gets or sets the error message if the precondition + /// fails due to being run outside of a Guild channel. + /// public string NotAGuildErrorMessage { get; set; } /// diff --git a/src/Discord.Net.Commands/Attributes/Preconditions/RequireContextAttribute.cs b/src/Discord.Net.Commands/Attributes/Preconditions/RequireContextAttribute.cs index 762aa91dd..a27469c88 100644 --- a/src/Discord.Net.Commands/Attributes/Preconditions/RequireContextAttribute.cs +++ b/src/Discord.Net.Commands/Attributes/Preconditions/RequireContextAttribute.cs @@ -33,6 +33,7 @@ namespace Discord.Commands /// Gets the context required to execute the command. /// public ContextType Contexts { get; } + /// public override string ErrorMessage { get; set; } /// Requires the command to be invoked in the specified context. diff --git a/src/Discord.Net.Commands/Attributes/Preconditions/RequireNsfwAttribute.cs b/src/Discord.Net.Commands/Attributes/Preconditions/RequireNsfwAttribute.cs index a97c70e8b..2a9647cd2 100644 --- a/src/Discord.Net.Commands/Attributes/Preconditions/RequireNsfwAttribute.cs +++ b/src/Discord.Net.Commands/Attributes/Preconditions/RequireNsfwAttribute.cs @@ -30,6 +30,7 @@ namespace Discord.Commands [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)] public class RequireNsfwAttribute : PreconditionAttribute { + /// public override string ErrorMessage { get; set; } /// diff --git a/src/Discord.Net.Commands/Attributes/Preconditions/RequireOwnerAttribute.cs b/src/Discord.Net.Commands/Attributes/Preconditions/RequireOwnerAttribute.cs index 10d513631..c08e1e9da 100644 --- a/src/Discord.Net.Commands/Attributes/Preconditions/RequireOwnerAttribute.cs +++ b/src/Discord.Net.Commands/Attributes/Preconditions/RequireOwnerAttribute.cs @@ -34,6 +34,7 @@ namespace Discord.Commands [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)] public class RequireOwnerAttribute : PreconditionAttribute { + /// public override string ErrorMessage { get; set; } /// diff --git a/src/Discord.Net.Commands/Attributes/Preconditions/RequireUserPermissionAttribute.cs b/src/Discord.Net.Commands/Attributes/Preconditions/RequireUserPermissionAttribute.cs index a4bed1fd7..2908a18c1 100644 --- a/src/Discord.Net.Commands/Attributes/Preconditions/RequireUserPermissionAttribute.cs +++ b/src/Discord.Net.Commands/Attributes/Preconditions/RequireUserPermissionAttribute.cs @@ -17,7 +17,12 @@ namespace Discord.Commands /// Gets the specified of the precondition. /// public ChannelPermission? ChannelPermission { get; } + /// public override string ErrorMessage { get; set; } + /// + /// Gets or sets the error message if the precondition + /// fails due to being run outside of a Guild channel. + /// public string NotAGuildErrorMessage { get; set; } ///