From daa755cd40ede906ff3e10a767b1f1d25e69d35b Mon Sep 17 00:00:00 2001
From: Still Hsu <341464@gmail.com>
Date: Mon, 8 Oct 2018 21:33:37 +0800
Subject: [PATCH] Change verbs used in IVoiceState summary/remarks
---
.../Entities/Users/IVoiceState.cs | 34 +++++++++++++++----
1 file changed, 28 insertions(+), 6 deletions(-)
diff --git a/src/Discord.Net.Core/Entities/Users/IVoiceState.cs b/src/Discord.Net.Core/Entities/Users/IVoiceState.cs
index abe06c3b3..2b3abc06f 100644
--- a/src/Discord.Net.Core/Entities/Users/IVoiceState.cs
+++ b/src/Discord.Net.Core/Entities/Users/IVoiceState.cs
@@ -6,28 +6,50 @@ namespace Discord
public interface IVoiceState
{
///
- /// Returns true if the guild has deafened this user.
+ /// Gets a value that indicates whether this user is deafened by the guild.
///
+ ///
+ /// true if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
+ /// otherwise false.
+ ///
bool IsDeafened { get; }
///
- /// Returns true if the guild has muted this user.
+ /// Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the
+ /// guild.
///
+ ///
+ /// true if this user is muted by the guild; otherwise false.
+ ///
bool IsMuted { get; }
///
- /// Returns true if this user has marked themselves as deafened.
+ /// Gets a value that indicates whether this user has marked themselves as deafened.
///
+ ///
+ /// true if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise false.
+ ///
bool IsSelfDeafened { get; }
///
- /// Returns true if this user has marked themselves as muted.
+ /// Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to
+ /// speak via voice).
///
+ ///
+ /// true if this user has muted themselves; otherwise false.
+ ///
bool IsSelfMuted { get; }
///
- /// Returns true if the guild is temporarily blocking audio to/from this user.
+ /// Gets a value that indicates whether the user is muted by the current user.
///
+ ///
+ /// true if the guild is temporarily blocking audio to/from this user; otherwise false.
+ ///
bool IsSuppressed { get; }
///
- /// Gets the voice channel this user is currently in, or null if none.
+ /// Gets the voice channel this user is currently in.
///
+ ///
+ /// A generic voice channel object representing the voice channel that the user is currently in; null
+ /// if none.
+ ///
IVoiceChannel VoiceChannel { get; }
///
/// Gets the unique identifier for this user's voice session.