diff --git a/src/Discord.Net/ConnectionState.cs b/src/Discord.Net/ConnectionState.cs
index 42c505ccd..e4658b884 100644
--- a/src/Discord.Net/ConnectionState.cs
+++ b/src/Discord.Net/ConnectionState.cs
@@ -1,10 +1,15 @@
namespace Discord
{
+ /// Connection state for clients
public enum ConnectionState : byte
{
+ /// Not connected to Discord
Disconnected,
+ /// Currently connecting to Discord
Connecting,
+ /// Connected to Discord
Connected,
+ /// Disconnecting from Discord
Disconnecting
}
}
diff --git a/src/Discord.Net/DiscordConfig.cs b/src/Discord.Net/DiscordConfig.cs
index 737cf0050..9fcb26e36 100644
--- a/src/Discord.Net/DiscordConfig.cs
+++ b/src/Discord.Net/DiscordConfig.cs
@@ -2,20 +2,29 @@
namespace Discord
{
+ /// Stores common configuration settings
public class DiscordConfig
{
- public const int APIVersion = 6;
+ /// The version of Discord's REST API which is used
+ public const int APIVersion = 6;
+ /// Version information about Discord.Net
public static string Version { get; } =
typeof(DiscordConfig).GetTypeInfo().Assembly.GetCustomAttribute()?.InformationalVersion ??
typeof(DiscordConfig).GetTypeInfo().Assembly.GetName().Version.ToString(3) ??
"Unknown";
+ /// The base URL for all REST API requests
public static readonly string ClientAPIUrl = $"https://discordapp.com/api/v{APIVersion}/";
+ /// The base URL for all CDN requests
public const string CDNUrl = "https://discordcdn.com/";
+ /// The base URL for all invite links
public const string InviteUrl = "https://discord.gg/";
+ /// The maximum amount of characters which can be sent in a message
public const int MaxMessageSize = 2000;
+ /// The maximum number of messages which can be received in a batch
public const int MaxMessagesPerBatch = 100;
+ /// The maximum number of users which can be received in a batch
public const int MaxUsersPerBatch = 1000;
/// Gets or sets the minimum log level severity that will be sent to the LogMessage event.
diff --git a/src/Discord.Net/Format.cs b/src/Discord.Net/Format.cs
index 8b1d06bf8..ac3232692 100644
--- a/src/Discord.Net/Format.cs
+++ b/src/Discord.Net/Format.cs
@@ -1,5 +1,6 @@
namespace Discord
{
+ /// Contains common macros for formatting text using Markdown
public static class Format
{
/// Returns a markdown-formatted string with bold formatting.
diff --git a/src/Discord.Net/LogSeverity.cs b/src/Discord.Net/LogSeverity.cs
index 785b0ef46..e563abf77 100644
--- a/src/Discord.Net/LogSeverity.cs
+++ b/src/Discord.Net/LogSeverity.cs
@@ -1,12 +1,19 @@
namespace Discord
{
+ /// The severity of a log message
public enum LogSeverity
{
+ /// Used when a critical, non-recoverable error occurs
Critical = 0,
+ /// Used when a recoverable error occurs
Error = 1,
+ /// Used when a warning occurs
Warning = 2,
+ /// Used for general, informative messages
Info = 3,
+ /// Used for debugging purposes
Verbose = 4,
+ /// Used for debugging purposes
Debug = 5
}
}
diff --git a/src/Discord.Net/LoginState.cs b/src/Discord.Net/LoginState.cs
index 42b6ecac9..d10eaf74c 100644
--- a/src/Discord.Net/LoginState.cs
+++ b/src/Discord.Net/LoginState.cs
@@ -1,10 +1,15 @@
namespace Discord
{
+ /// Login state for clients
public enum LoginState : byte
{
+ /// Logged out
LoggedOut,
+ /// Logging in
LoggingIn,
+ /// Logged in
LoggedIn,
+ /// Logging out
LoggingOut
}
}
diff --git a/src/Discord.Net/RequestOptions.cs b/src/Discord.Net/RequestOptions.cs
index 242642d56..332b3147b 100644
--- a/src/Discord.Net/RequestOptions.cs
+++ b/src/Discord.Net/RequestOptions.cs
@@ -1,12 +1,15 @@
namespace Discord
{
+ /// Contains options specific to requests
public class RequestOptions
{
+ /// Returns the default options for a request.
public static RequestOptions Default => new RequestOptions();
/// The max time, in milliseconds, to wait for this request to complete. If null, a request will not time out. If a rate limit has been triggered for this request's bucket and will not be unpaused in time, this request will fail immediately.
public int? Timeout { get; set; }
+ /// Creates a new instance of the RequestOptions class
public RequestOptions()
{
Timeout = 30000;