From 78dd2f1536a18cbae1f9a1f3f4a3966a5a47eac0 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Tue, 3 Mar 2020 23:28:59 -0800 Subject: [PATCH] docs: update xmldoc for allowedMentions args --- src/Discord.Net.Commands/ModuleBase.cs | 5 ++++- src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs | 5 ++++- src/Discord.Net.Core/Extensions/UserExtensions.cs | 5 ++++- .../Entities/Channels/IRestMessageChannel.cs | 5 ++++- .../Entities/Channels/ISocketMessageChannel.cs | 5 ++++- 5 files changed, 20 insertions(+), 5 deletions(-) diff --git a/src/Discord.Net.Commands/ModuleBase.cs b/src/Discord.Net.Commands/ModuleBase.cs index d4f7099a8..46b82cd0b 100644 --- a/src/Discord.Net.Commands/ModuleBase.cs +++ b/src/Discord.Net.Commands/ModuleBase.cs @@ -31,7 +31,10 @@ namespace Discord.Commands /// /// Specifies if Discord should read this aloud using text-to-speech. /// An embed to be displayed alongside the . - /// The types of mention notifications that will be sent with this message. + /// + /// Specifies if notifications are sent for mentioned users and roles in the message . + /// If null, all mentioned roles and users will be notified. + /// protected virtual async Task ReplyAsync(string message = null, bool isTTS = false, Embed embed = null, RequestOptions options = null, AllowedMentions allowedMentions = null) { return await Context.Channel.SendMessageAsync(message, isTTS, embed, options, allowedMentions).ConfigureAwait(false); diff --git a/src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs b/src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs index c1315896b..667acd198 100644 --- a/src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs @@ -23,7 +23,10 @@ namespace Discord /// Determines whether the message should be read aloud by Discord or not. /// The to be sent. /// The options to be used when sending the request. - /// The types of mention notifications that will be sent with this message. + /// + /// Specifies if notifications are sent for mentioned users and roles in the message . If null, all mentioned roles and users will be notified. If null, all mentioned roles and users will be notified.Specifies if notifications are sent for mentioned users and roles in the message . + /// If null, all mentioned roles and users will be notified. + /// /// /// A task that represents an asynchronous send operation for delivering the message. The task result /// contains the sent message. diff --git a/src/Discord.Net.Core/Extensions/UserExtensions.cs b/src/Discord.Net.Core/Extensions/UserExtensions.cs index 8ec718d0a..7bab882d6 100644 --- a/src/Discord.Net.Core/Extensions/UserExtensions.cs +++ b/src/Discord.Net.Core/Extensions/UserExtensions.cs @@ -28,7 +28,10 @@ namespace Discord /// Whether the message should be read aloud by Discord or not. /// The to be sent. /// The options to be used when sending the request. - /// The types of mention notifications that will be sent with this message. + /// + /// Specifies if notifications are sent for mentioned users and roles in the message . + /// If null, all mentioned roles and users will be notified. + /// /// /// A task that represents the asynchronous send operation. The task result contains the sent message. /// diff --git a/src/Discord.Net.Rest/Entities/Channels/IRestMessageChannel.cs b/src/Discord.Net.Rest/Entities/Channels/IRestMessageChannel.cs index 6a1d32f58..195fa92df 100644 --- a/src/Discord.Net.Rest/Entities/Channels/IRestMessageChannel.cs +++ b/src/Discord.Net.Rest/Entities/Channels/IRestMessageChannel.cs @@ -20,7 +20,10 @@ namespace Discord.Rest /// Determines whether the message should be read aloud by Discord or not. /// The to be sent. /// The options to be used when sending the request. - /// The types of mention notifications that will be sent with this message. + /// + /// Specifies if notifications are sent for mentioned users and roles in the message . + /// If null, all mentioned roles and users will be notified. + /// /// /// A task that represents an asynchronous send operation for delivering the message. The task result /// contains the sent message. diff --git a/src/Discord.Net.WebSocket/Entities/Channels/ISocketMessageChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/ISocketMessageChannel.cs index b63c0c3d7..4674b623c 100644 --- a/src/Discord.Net.WebSocket/Entities/Channels/ISocketMessageChannel.cs +++ b/src/Discord.Net.WebSocket/Entities/Channels/ISocketMessageChannel.cs @@ -28,7 +28,10 @@ namespace Discord.WebSocket /// The message to be sent. /// Determines whether the message should be read aloud by Discord or not. /// The to be sent. - /// The types of mention notifications that will be sent with this message. + /// + /// Specifies if notifications are sent for mentioned users and roles in the message . + /// If null, all mentioned roles and users will be notified. + /// /// The options to be used when sending the request. /// /// A task that represents an asynchronous send operation for delivering the message. The task result