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:
committed by
Christopher F
parent
bb61efabf3
commit
5ea3e113b8
@@ -17,7 +17,12 @@ namespace Discord.Commands
|
|||||||
/// Gets the specified <see cref="Discord.ChannelPermission" /> of the precondition.
|
/// Gets the specified <see cref="Discord.ChannelPermission" /> of the precondition.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public ChannelPermission? ChannelPermission { get; }
|
public ChannelPermission? ChannelPermission { get; }
|
||||||
|
/// <inheritdoc />
|
||||||
public override string ErrorMessage { get; set; }
|
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; }
|
public string NotAGuildErrorMessage { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|||||||
@@ -33,6 +33,7 @@ namespace Discord.Commands
|
|||||||
/// Gets the context required to execute the command.
|
/// Gets the context required to execute the command.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public ContextType Contexts { get; }
|
public ContextType Contexts { get; }
|
||||||
|
/// <inheritdoc />
|
||||||
public override string ErrorMessage { get; set; }
|
public override string ErrorMessage { get; set; }
|
||||||
|
|
||||||
/// <summary> Requires the command to be invoked in the specified context. </summary>
|
/// <summary> Requires the command to be invoked in the specified context. </summary>
|
||||||
|
|||||||
@@ -30,6 +30,7 @@ namespace Discord.Commands
|
|||||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
|
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
|
||||||
public class RequireNsfwAttribute : PreconditionAttribute
|
public class RequireNsfwAttribute : PreconditionAttribute
|
||||||
{
|
{
|
||||||
|
/// <inheritdoc />
|
||||||
public override string ErrorMessage { get; set; }
|
public override string ErrorMessage { get; set; }
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <inheritdoc />
|
||||||
|
|||||||
@@ -34,6 +34,7 @@ namespace Discord.Commands
|
|||||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
|
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
|
||||||
public class RequireOwnerAttribute : PreconditionAttribute
|
public class RequireOwnerAttribute : PreconditionAttribute
|
||||||
{
|
{
|
||||||
|
/// <inheritdoc />
|
||||||
public override string ErrorMessage { get; set; }
|
public override string ErrorMessage { get; set; }
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <inheritdoc />
|
||||||
|
|||||||
@@ -17,7 +17,12 @@ namespace Discord.Commands
|
|||||||
/// Gets the specified <see cref="Discord.ChannelPermission" /> of the precondition.
|
/// Gets the specified <see cref="Discord.ChannelPermission" /> of the precondition.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public ChannelPermission? ChannelPermission { get; }
|
public ChannelPermission? ChannelPermission { get; }
|
||||||
|
/// <inheritdoc />
|
||||||
public override string ErrorMessage { get; set; }
|
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; }
|
public string NotAGuildErrorMessage { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|||||||
Reference in New Issue
Block a user