diff --git a/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs b/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs index aeddceb65..ca0300e80 100644 --- a/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs +++ b/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs @@ -11,14 +11,25 @@ namespace Discord /// /// Gets the URL of the video. /// + /// + /// A string containing the URL of the image. + /// public string Url { get; } /// - /// Gets the height of the video, or null if none. + /// Gets the height of the video. /// + /// + /// A representing the height of this video if it can be retrieved; otherwise + /// null. + /// public int? Height { get; } /// - /// Gets the weight of the video, or null if none. + /// Gets the weight of the video. /// + /// + /// A representing the width of this video if it can be retrieved; otherwise + /// null. + /// public int? Width { get; } internal EmbedVideo(string url, int? height, int? width) @@ -32,6 +43,9 @@ namespace Discord /// /// Gets the URL of the video. /// + /// + /// A string that resolves to . + /// public override string ToString() => Url; } } diff --git a/src/Discord.Net.Core/Entities/Messages/IAttachment.cs b/src/Discord.Net.Core/Entities/Messages/IAttachment.cs index 5d4d32cfa..13b2cf48a 100644 --- a/src/Discord.Net.Core/Entities/Messages/IAttachment.cs +++ b/src/Discord.Net.Core/Entities/Messages/IAttachment.cs @@ -17,7 +17,7 @@ namespace Discord /// Gets the filename of this attachment. /// /// - /// A string containing the full filename of this attachment (e.g. textFile.txt). + /// A string containing the full filename of this attachment (e.g. textFile.txt). /// string Filename { get; } /// diff --git a/src/Discord.Net.Core/Entities/Messages/IMessage.cs b/src/Discord.Net.Core/Entities/Messages/IMessage.cs index 3de57bd50..87754eecd 100644 --- a/src/Discord.Net.Core/Entities/Messages/IMessage.cs +++ b/src/Discord.Net.Core/Entities/Messages/IMessage.cs @@ -31,8 +31,11 @@ namespace Discord /// bool IsPinned { get; } /// - /// Returns the content for this message. + /// Gets the content for this message. /// + /// + /// A string that contains the body of the message; note that this field may be empty if there is an embed. + /// string Content { get; } /// /// Gets the time this message was sent. diff --git a/src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs b/src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs index 8f2678cd9..850666921 100644 --- a/src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs +++ b/src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs @@ -8,11 +8,17 @@ namespace Discord /// /// Gets the number of reactions. /// + /// + /// An representing the number of this reactions that has been added to this message. + /// public int ReactionCount { get; internal set; } /// - /// Returns true if the current user has used this reaction. + /// Gets a value that indicates whether the current user has reacted to this. /// + /// + /// true if the user has reacted to the message; otherwise false. + /// public bool IsMe { get; internal set; } } } diff --git a/src/Discord.Net.Core/Entities/Permissions/ChannelPermissions.cs b/src/Discord.Net.Core/Entities/Permissions/ChannelPermissions.cs index 753be6d51..b6a4d33b9 100644 --- a/src/Discord.Net.Core/Entities/Permissions/ChannelPermissions.cs +++ b/src/Discord.Net.Core/Entities/Permissions/ChannelPermissions.cs @@ -8,6 +8,7 @@ namespace Discord public struct ChannelPermissions { /// Gets a blank that grants no permissions. + /// A structure that does not contain any set permissions. public static readonly ChannelPermissions None = new ChannelPermissions(); /// Gets a that grants all permissions for text channels. public static readonly ChannelPermissions Text = new ChannelPermissions(0b01100_0000000_1111111110001_010001); diff --git a/src/Discord.Net.Core/Net/HttpException.cs b/src/Discord.Net.Core/Net/HttpException.cs index 7b395d022..d36bd66f9 100644 --- a/src/Discord.Net.Core/Net/HttpException.cs +++ b/src/Discord.Net.Core/Net/HttpException.cs @@ -38,6 +38,10 @@ namespace Discord.Net /// /// Initializes a new instance of the class. /// + /// The HTTP status code returned. + /// The request that was sent prior to the exception. + /// The Discord status code returned. + /// The reason behind the exception. public HttpException(HttpStatusCode httpCode, IRequest request, int? discordCode = null, string reason = null) : base(CreateMessage(httpCode, discordCode, reason)) { diff --git a/src/Discord.Net.Core/Net/Rest/IRestClient.cs b/src/Discord.Net.Core/Net/Rest/IRestClient.cs index addfa9061..2e30d2ef4 100644 --- a/src/Discord.Net.Core/Net/Rest/IRestClient.cs +++ b/src/Discord.Net.Core/Net/Rest/IRestClient.cs @@ -4,11 +4,32 @@ using System.Threading.Tasks; namespace Discord.Net.Rest { + /// + /// Represents a generic REST-based client. + /// public interface IRestClient { + /// + /// Sets the HTTP header of this client for all requests. + /// + /// The field name of the header. + /// The value of the header. void SetHeader(string key, string value); + /// + /// Sets the cancellation token for this client. + /// + /// The cancellation token. void SetCancelToken(CancellationToken cancelToken); + /// + /// Sends a REST request. + /// + /// The method used to send this request (i.e. HTTP verb such as GET, POST). + /// The endpoint to send this request to. + /// The cancellation token used to cancel the task. + /// Indicates whether to send the header only. + /// The audit log reason. + /// Task SendAsync(string method, string endpoint, CancellationToken cancelToken, bool headerOnly = false, string reason = null); Task SendAsync(string method, string endpoint, string json, CancellationToken cancelToken, bool headerOnly = false, string reason = null); Task SendAsync(string method, string endpoint, IReadOnlyDictionary multipartParams, CancellationToken cancelToken, bool headerOnly = false, string reason = null); diff --git a/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs b/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs index 8721e722b..659a2eeea 100644 --- a/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs +++ b/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs @@ -66,6 +66,13 @@ namespace Discord.WebSocket public SocketVoiceChannel VoiceChannel => VoiceState?.VoiceChannel; /// public string VoiceSessionId => VoiceState?.VoiceSessionId ?? ""; + /// + /// Gets the voice connection status of the user if any. + /// + /// + /// A representing the user's voice status; null if the user is not + /// connected to a voice channel. + /// public SocketVoiceState? VoiceState => Guild.GetVoiceState(Id); public AudioInStream AudioStream => Guild.GetAudioStream(Id);