Browse Source

Cleanup slow-mode-related documentation strings

pull/1161/head
Still Hsu 7 years ago
parent
commit
936cccf9bc
No known key found for this signature in database GPG Key ID: 8601A145FDA95209
2 changed files with 13 additions and 6 deletions
  1. +7
    -1
      src/Discord.Net.Core/Entities/Channels/ITextChannel.cs
  2. +6
    -5
      src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs

+ 7
- 1
src/Discord.Net.Core/Entities/Channels/ITextChannel.cs View File

@@ -26,7 +26,13 @@ namespace Discord
/// </returns> /// </returns>
string Topic { get; } string Topic { get; }


///<summary> Gets the current slow-mode delay for this channel. 0 if disabled. </summary>
/// <summary>
/// Gets the current slow-mode delay for this channel.
/// </summary>
/// <returns>
/// An <see cref="Int32"/> representing the time in seconds required before the user can send another
/// message; <c>0</c> if disabled.
/// </returns>
int SlowModeInterval { get; } int SlowModeInterval { get; }


/// <summary> /// <summary>


+ 6
- 5
src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs View File

@@ -15,14 +15,15 @@ namespace Discord
/// </summary> /// </summary>
public Optional<bool> IsNsfw { get; set; } public Optional<bool> IsNsfw { get; set; }
/// <summary> /// <summary>
/// What the slow-mode ratelimit for this channel should be set to; 0 will disable slow-mode.
/// Gets or sets the slow-mode ratelimit in seconds for this channel.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// This value must fall within [0, 120]
///
/// Users with <see cref="ChannelPermission.ManageMessages"/> will be exempt from slow-mode.
/// Setting this value to <c>0</c> will disable slow-mode for this channel.
/// <note>
/// Users with <see cref="Discord.ChannelPermission.ManageMessages" /> will be exempt from slow-mode.
/// </note>
/// </remarks> /// </remarks>
/// <exception cref="ArgumentOutOfRangeException">Throws ArgummentOutOfRange if the value does not fall within [0, 120]</exception>
/// <exception cref="ArgumentOutOfRangeException">Thrown if the value does not fall within [0, 120].</exception>
public Optional<int> SlowModeInterval { get; set; } public Optional<int> SlowModeInterval { get; set; }
} }
} }

Loading…
Cancel
Save