Browse Source

Better xml documentation

pull/1537/head
SubZero0 5 years ago
parent
commit
5de1634645
2 changed files with 27 additions and 7 deletions
  1. +7
    -3
      src/Discord.Net.Core/Entities/Gateway/BotGateway.cs
  2. +20
    -4
      src/Discord.Net.Core/Entities/Gateway/SessionStartLimit.cs

+ 7
- 3
src/Discord.Net.Core/Entities/Gateway/BotGateway.cs View File

@@ -1,17 +1,21 @@
namespace Discord namespace Discord
{ {
/// <summary>
/// Stores the gateway information related to the current bot.
/// </summary>
public class BotGateway public class BotGateway
{ {
/// <summary> /// <summary>
/// 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.
/// </summary> /// </summary>
public string Url { get; internal set; } public string Url { get; internal set; }
/// <summary> /// <summary>
/// The recommended number of shards to use when connecting.
/// Gets the recommended number of shards to use when connecting.
/// </summary> /// </summary>
public int Shards { get; internal set; } public int Shards { get; internal set; }
/// <summary> /// <summary>
/// Information on the current session start limit.
/// Gets the <see cref="SessionStartLimit"/> that contains the information
/// about the current session start limit.
/// </summary> /// </summary>
public SessionStartLimit SessionStartLimit { get; internal set; } public SessionStartLimit SessionStartLimit { get; internal set; }
} }


+ 20
- 4
src/Discord.Net.Core/Entities/Gateway/SessionStartLimit.cs View File

@@ -1,22 +1,38 @@
namespace Discord namespace Discord
{ {
/// <summary>
/// Stores the information related to the gateway identify request.
/// </summary>
public class SessionStartLimit public class SessionStartLimit
{ {
/// <summary> /// <summary>
/// The total number of session starts the current user is allowed.
/// Gets the total number of session starts the current user is allowed.
/// </summary> /// </summary>
/// <returns>
/// The maximum amount of session starts the current user is allowed.
/// </returns>
public int Total { get; internal set; } public int Total { get; internal set; }
/// <summary> /// <summary>
/// The remaining number of session starts the current user is allowed.
/// Gets the remaining number of session starts the current user is allowed.
/// </summary> /// </summary>
/// <returns>
/// The remaining amount of session starts the current user is allowed.
/// </returns>
public int Remaining { get; internal set; } public int Remaining { get; internal set; }
/// <summary> /// <summary>
/// The number of milliseconds after which the limit resets.
/// Gets the number of milliseconds after which the limit resets.
/// </summary> /// </summary>
/// <returns>
/// The milliseconds until the limit resets back to the <see cref="Total"/>.
/// </returns>
public int ResetAfter { get; internal set; } public int ResetAfter { get; internal set; }
/// <summary> /// <summary>
/// The maximum concurrent identify requests in a time window.
/// Gets the maximum concurrent identify requests in a time window.
/// </summary> /// </summary>
/// <returns>
/// The maximum concurrent identify requests in a time window,
/// limited to the same rate limit key.
/// </returns>
public int MaxConcurrency { get; internal set; } public int MaxConcurrency { get; internal set; }
} }
} }

Loading…
Cancel
Save