Browse Source

Update xml docs

pull/1537/head
Paulo 5 years ago
parent
commit
5c5f2720ad
3 changed files with 7 additions and 4 deletions
  1. +2
    -2
      src/Discord.Net.Rest/Entities/Gateway/GatewayLimit.cs
  2. +4
    -1
      src/Discord.Net.Rest/Entities/Gateway/GatewayLimits.cs
  3. +1
    -1
      src/Discord.Net.WebSocket/DiscordSocketConfig.cs

+ 2
- 2
src/Discord.Net.Rest/Entities/Gateway/GatewayLimit.cs View File

@@ -6,11 +6,11 @@ namespace Discord.Rest
public struct GatewayLimit public struct GatewayLimit
{ {
/// <summary> /// <summary>
/// The maximum amount of this type of request in a time window, that is set by <see cref="Seconds"/>.
/// Gets or sets the maximum amount of this type of request in a time window, that is set by <see cref="Seconds"/>.
/// </summary> /// </summary>
public int Count { get; set; } public int Count { get; set; }
/// <summary> /// <summary>
/// The amount of seconds until the rate limiter resets the remaining requests <see cref="Count"/>.
/// Gets or sets the amount of seconds until the rate limiter resets the remaining requests <see cref="Count"/>.
/// </summary> /// </summary>
public int Seconds { get; set; } public int Seconds { get; set; }




+ 4
- 1
src/Discord.Net.Rest/Entities/Gateway/GatewayLimits.cs View File

@@ -9,7 +9,7 @@ namespace Discord.Rest
/// Gets or sets the global limits for the gateway rate limiter. /// Gets or sets the global limits for the gateway rate limiter.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// It includes all the other limits, like Identify.
/// This property includes all the other limits, like Identify.
/// </remarks> /// </remarks>
public GatewayLimit Global { get; set; } public GatewayLimit Global { get; set; }
/// <summary> /// <summary>
@@ -17,6 +17,9 @@ namespace Discord.Rest
/// </summary> /// </summary>
public GatewayLimit Identify { get; set; } public GatewayLimit Identify { get; set; }


/// <summary>
/// Initializes a new <see cref="GatewayLimits"/> with the default values.
/// </summary>
public GatewayLimits() public GatewayLimits()
{ {
Global = new GatewayLimit(120, 60); Global = new GatewayLimit(120, 60);


+ 1
- 1
src/Discord.Net.WebSocket/DiscordSocketConfig.cs View File

@@ -128,7 +128,7 @@ namespace Discord.WebSocket
/// <summary> /// <summary>
/// Gets or sets the gateway limits. /// Gets or sets the gateway limits.
/// <note type="warning"> /// <note type="warning">
/// It should only be changed for bots that have special limits provided by Discord.
/// This property should only be changed for bots that have special limits provided by Discord.
/// </note> /// </note>
/// </summary> /// </summary>
public GatewayLimits GatewayLimits { get; set; } = new GatewayLimits(); public GatewayLimits GatewayLimits { get; set; } = new GatewayLimits();


Loading…
Cancel
Save