From 5de1634645239139500b7cd74c34ba1e7954f78a Mon Sep 17 00:00:00 2001 From: SubZero0 Date: Fri, 5 Jun 2020 09:38:04 -0300 Subject: [PATCH] Better xml documentation --- .../Entities/Gateway/BotGateway.cs | 10 +++++--- .../Entities/Gateway/SessionStartLimit.cs | 24 +++++++++++++++---- 2 files changed, 27 insertions(+), 7 deletions(-) diff --git a/src/Discord.Net.Core/Entities/Gateway/BotGateway.cs b/src/Discord.Net.Core/Entities/Gateway/BotGateway.cs index a6f1b0989..c9be0ac1f 100644 --- a/src/Discord.Net.Core/Entities/Gateway/BotGateway.cs +++ b/src/Discord.Net.Core/Entities/Gateway/BotGateway.cs @@ -1,17 +1,21 @@ namespace Discord { + /// + /// Stores the gateway information related to the current bot. + /// public class BotGateway { /// - /// The WSS URL that can be used for connecting to the gateway. + /// Gets the WSS URL that can be used for connecting to the gateway. /// public string Url { get; internal set; } /// - /// The recommended number of shards to use when connecting. + /// Gets the recommended number of shards to use when connecting. /// public int Shards { get; internal set; } /// - /// Information on the current session start limit. + /// Gets the that contains the information + /// about the current session start limit. /// public SessionStartLimit SessionStartLimit { get; internal set; } } diff --git a/src/Discord.Net.Core/Entities/Gateway/SessionStartLimit.cs b/src/Discord.Net.Core/Entities/Gateway/SessionStartLimit.cs index 40c9d6dd2..74ae96af1 100644 --- a/src/Discord.Net.Core/Entities/Gateway/SessionStartLimit.cs +++ b/src/Discord.Net.Core/Entities/Gateway/SessionStartLimit.cs @@ -1,22 +1,38 @@ namespace Discord { + /// + /// Stores the information related to the gateway identify request. + /// public class SessionStartLimit { /// - /// The total number of session starts the current user is allowed. + /// Gets the total number of session starts the current user is allowed. /// + /// + /// The maximum amount of session starts the current user is allowed. + /// public int Total { get; internal set; } /// - /// The remaining number of session starts the current user is allowed. + /// Gets the remaining number of session starts the current user is allowed. /// + /// + /// The remaining amount of session starts the current user is allowed. + /// public int Remaining { get; internal set; } /// - /// The number of milliseconds after which the limit resets. + /// Gets the number of milliseconds after which the limit resets. /// + /// + /// The milliseconds until the limit resets back to the . + /// public int ResetAfter { get; internal set; } /// - /// The maximum concurrent identify requests in a time window. + /// Gets the maximum concurrent identify requests in a time window. /// + /// + /// The maximum concurrent identify requests in a time window, + /// limited to the same rate limit key. + /// public int MaxConcurrency { get; internal set; } } }