diff --git a/src/Discord.Net.WebSocket/DiscordSocketConfig.cs b/src/Discord.Net.WebSocket/DiscordSocketConfig.cs
index e4e7f59dc..a45d4f5be 100644
--- a/src/Discord.Net.WebSocket/DiscordSocketConfig.cs
+++ b/src/Discord.Net.WebSocket/DiscordSocketConfig.cs
@@ -45,6 +45,7 @@ namespace Discord.WebSocket
/// Gets or sets the ID for this shard. Must be less than .
///
public int? ShardId { get; set; } = null;
+
///
/// Gets or sets the total number of shards for this application.
///
@@ -55,9 +56,10 @@ namespace Discord.WebSocket
/// disables the message cache entirely.
///
public int MessageCacheSize { get; set; } = 0;
+
///
/// Gets or sets the max number of users a guild may have for offline users to be included in the READY
- /// packet. Max is 250.
+ /// packet. The maximum value allowed is 250.
///
public int LargeThreshold { get; set; } = 250;
@@ -65,6 +67,7 @@ namespace Discord.WebSocket
/// Gets or sets the provider used to generate new WebSocket connections.
///
public WebSocketProvider WebSocketProvider { get; set; }
+
///
/// Gets or sets the provider used to generate new UDP sockets.
///
@@ -95,15 +98,16 @@ namespace Discord.WebSocket
/// traffic. If you are using the command system, the default user TypeReader may fail to find the user
/// due to this issue. This may be resolved at v3 of the library. Until then, you may want to consider
/// overriding the TypeReader and use
- ///
+ ///
/// or
/// as a backup.
///
///
public bool AlwaysDownloadUsers { get; set; } = false;
+
///
/// Gets or sets the timeout for event handlers, in milliseconds, after which a warning will be logged.
- /// nulldisables this check.
+ /// Setting this property to nulldisables this check.
///
public int? HandlerTimeout { get; set; } = 3000;
@@ -151,18 +155,21 @@ namespace Discord.WebSocket
/// before firing READY.
///
/// Value must be at least 0.
- public int MaxWaitBetweenGuildAvailablesBeforeReady {
+ public int MaxWaitBetweenGuildAvailablesBeforeReady
+ {
get
{
- return _maxWaitForGuildAvailable;
+ return this.maxWaitForGuildAvailable;
}
+
set
{
- Preconditions.AtLeast(value, 0, nameof(MaxWaitBetweenGuildAvailablesBeforeReady));
- _maxWaitForGuildAvailable = value;
+ Preconditions.AtLeast(value, 0, nameof(this.MaxWaitBetweenGuildAvailablesBeforeReady));
+ this.maxWaitForGuildAvailable = value;
}
}
- private int _maxWaitForGuildAvailable = 10000;
+
+ private int maxWaitForGuildAvailable = 10000;
///
/// Gets or sets gateway intents to limit what events are sent from Discord. Allows for more granular control than the property.
@@ -175,7 +182,7 @@ namespace Discord.WebSocket
public GatewayIntents? GatewayIntents { get; set; }
///
- /// Initializes a default configuration.
+ /// Initializes a new instance of the class with the default configuration.
///
public DiscordSocketConfig()
{