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
This commit is contained in:
Chris Johnston
2019-05-13 15:28:13 -07:00
committed by Christopher F
parent bb61efabf3
commit 5ea3e113b8
5 changed files with 13 additions and 0 deletions

View File

@@ -17,7 +17,12 @@ namespace Discord.Commands
/// Gets the specified <see cref="Discord.ChannelPermission" /> of the precondition.
/// </summary>
public ChannelPermission? ChannelPermission { get; }
/// <inheritdoc />
public override string ErrorMessage { get; set; }
/// <summary>
/// Gets or sets the error message if the precondition
/// fails due to being run outside of a Guild channel.
/// </summary>
public string NotAGuildErrorMessage { get; set; }
/// <summary>

View File

@@ -33,6 +33,7 @@ namespace Discord.Commands
/// Gets the context required to execute the command.
/// </summary>
public ContextType Contexts { get; }
/// <inheritdoc />
public override string ErrorMessage { get; set; }
/// <summary> Requires the command to be invoked in the specified context. </summary>

View File

@@ -30,6 +30,7 @@ namespace Discord.Commands
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
public class RequireNsfwAttribute : PreconditionAttribute
{
/// <inheritdoc />
public override string ErrorMessage { get; set; }
/// <inheritdoc />

View File

@@ -34,6 +34,7 @@ namespace Discord.Commands
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
public class RequireOwnerAttribute : PreconditionAttribute
{
/// <inheritdoc />
public override string ErrorMessage { get; set; }
/// <inheritdoc />

View File

@@ -17,7 +17,12 @@ namespace Discord.Commands
/// Gets the specified <see cref="Discord.ChannelPermission" /> of the precondition.
/// </summary>
public ChannelPermission? ChannelPermission { get; }
/// <inheritdoc />
public override string ErrorMessage { get; set; }
/// <summary>
/// Gets or sets the error message if the precondition
/// fails due to being run outside of a Guild channel.
/// </summary>
public string NotAGuildErrorMessage { get; set; }
/// <summary>