diff --git a/src/Discord.Net.Commands/Attributes/PreconditionAttribute.cs b/src/Discord.Net.Commands/Attributes/PreconditionAttribute.cs index 1d791c92e..316b2729e 100644 --- a/src/Discord.Net.Commands/Attributes/PreconditionAttribute.cs +++ b/src/Discord.Net.Commands/Attributes/PreconditionAttribute.cs @@ -15,7 +15,7 @@ namespace Discord.Commands /// /// /// of the same group require only one of the preconditions to pass in order to - /// be successful (A || B). Specifying = or not at all will + /// be successful (A || B). Specifying = null or not at all will /// require *all* preconditions to pass, just like normal (A && B). /// public string Group { get; set; } = null; diff --git a/src/Discord.Net.Commands/CommandService.cs b/src/Discord.Net.Commands/CommandService.cs index 39cae845e..24db6e9b5 100644 --- a/src/Discord.Net.Commands/CommandService.cs +++ b/src/Discord.Net.Commands/CommandService.cs @@ -129,7 +129,7 @@ namespace Discord.Commands /// The type of module. /// /// The for your dependency injection solution, if using one - otherwise, pass - /// . + /// null. /// /// /// A built module. @@ -144,7 +144,7 @@ namespace Discord.Commands /// The type of module. /// /// The for your dependency injection solution, if using one - otherwise, pass - /// . + /// null. /// /// /// A built module. @@ -183,7 +183,7 @@ namespace Discord.Commands /// The containing command modules. /// /// An for your dependency injection solution, if using one - otherwise, pass - /// . + /// null. /// /// /// A collection of built modules. diff --git a/src/Discord.Net.Commands/Results/RuntimeResult.cs b/src/Discord.Net.Commands/Results/RuntimeResult.cs index a7febd68e..e4c86fc23 100644 --- a/src/Discord.Net.Commands/Results/RuntimeResult.cs +++ b/src/Discord.Net.Commands/Results/RuntimeResult.cs @@ -8,7 +8,7 @@ namespace Discord.Commands /// /// Initializes a new class with the type of error and reason. /// - /// The type of failure, or if none. + /// The type of failure, or null if none. /// The reason of failure. protected RuntimeResult(CommandError? error, string reason) { diff --git a/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs b/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs index 5028bd388..3d11e2c6f 100644 --- a/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs @@ -63,10 +63,10 @@ namespace Discord /// The max amount of times this invite may be used. Set to null to have unlimited uses. /// /// - /// If , a user accepting this invite will be kicked from the guild after closing their client. + /// If true, a user accepting this invite will be kicked from the guild after closing their client. /// /// - /// If , don't try to reuse a similar invite (useful for creating many unique one time use invites). + /// If true, don't try to reuse a similar invite (useful for creating many unique one time use invites). /// /// /// The options to be used when sending the request. diff --git a/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs b/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs index ac4bd2f9d..29c67bf6b 100644 --- a/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs @@ -14,7 +14,7 @@ namespace Discord /// Determines whether the channel is NSFW. /// /// - /// if the channel has the NSFW flag enabled; otherwise, . + /// true if the channel has the NSFW flag enabled; otherwise, false. /// bool IsNsfw { get; } diff --git a/src/Discord.Net.Core/Entities/Guilds/IGuild.cs b/src/Discord.Net.Core/Entities/Guilds/IGuild.cs index fa4af045a..17f5ac328 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IGuild.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IGuild.cs @@ -23,7 +23,7 @@ namespace Discord /// Determines if this guild is embeddable (i.e. can use widget). /// /// - /// if this guild can be embedded via widgets; otherwise . + /// true if this guild can be embedded via widgets; otherwise false. /// bool IsEmbeddable { get; } /// @@ -59,7 +59,7 @@ namespace Discord /// Determines if this guild is currently connected and ready to be used. /// /// - /// Returns if this guild is currently connected and ready to be used. Only applies + /// Returns true if this guild is currently connected and ready to be used. Only applies /// to the WebSocket client. /// bool Available { get; } @@ -260,7 +260,7 @@ namespace Discord /// Task> GetTextChannelsAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// - /// Gets a text channel in this guild with the provided ID, or if not found. + /// Gets a text channel in this guild with the provided ID, or null if not found. /// /// The text channel ID. /// @@ -328,7 +328,7 @@ namespace Discord /// The options to be used when sending the request. /// /// An awaitable containing the system channel within this guild, or - /// if none is set. + /// null if none is set. /// Task GetSystemChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// @@ -459,25 +459,29 @@ namespace Discord /// Task DownloadUsersAsync(); /// - /// Removes all users from this guild if they have not logged on in a provided number of - /// or, if is , returns the - /// number of users that would be removed. + /// Prunes inactive users. /// + /// + /// This method removes all users that have not logged on in the provided number of days or, if + /// is true, returns the number of users that would be removed. + /// /// The number of days required for the users to be kicked. /// Whether this prune action is a simulation. /// The options to be used when sending the request. /// - /// An awaitable containing the number of users to be or has been removed from this guild. + /// An awaitable containing the number of users to be or has been removed from this + /// guild. /// Task PruneUsersAsync(int days = 30, bool simulate = false, RequestOptions options = null); /// - /// Gets the webhook in this guild with the provided ID, or null if not found. + /// Gets a webhook found within this guild. /// /// The webhook ID. /// The options to be used when sending the request. /// - /// An awaitable containing the webhook with the specified ID, otherwise null. + /// An awaitable containing the webhook with the specified ID; null if none is + /// found. /// Task GetWebhookAsync(ulong id, RequestOptions options = null); /// diff --git a/src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs b/src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs index 809ed7d66..b6685edf6 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs @@ -11,7 +11,7 @@ namespace Discord /// string IconUrl { get; } /// - /// Returns if the current user owns this guild. + /// Returns true if the current user owns this guild. /// bool IsOwner { get; } /// diff --git a/src/Discord.Net.Core/Entities/Guilds/IVoiceRegion.cs b/src/Discord.Net.Core/Entities/Guilds/IVoiceRegion.cs index eef208905..8516036f1 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IVoiceRegion.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IVoiceRegion.cs @@ -14,19 +14,19 @@ namespace Discord /// string Name { get; } /// - /// Returns if this voice region is exclusive to VIP accounts. + /// Returns true if this voice region is exclusive to VIP accounts. /// bool IsVip { get; } /// - /// Returns if this voice region is the closest to your machine. + /// Returns true if this voice region is the closest to your machine. /// bool IsOptimal { get; } /// - /// Returns if this is a deprecated voice region (avoid switching to these). + /// Returns true if this is a deprecated voice region (avoid switching to these). /// bool IsDeprecated { get; } /// - /// Returns if this is a custom voice region (used for events/etc). + /// Returns true if this is a custom voice region (used for events/etc). /// bool IsCustom { get; } } diff --git a/src/Discord.Net.Core/Entities/Image.cs b/src/Discord.Net.Core/Entities/Image.cs index dd77ec6ae..5453027ac 100644 --- a/src/Discord.Net.Core/Entities/Image.cs +++ b/src/Discord.Net.Core/Entities/Image.cs @@ -35,7 +35,7 @@ namespace Discord /// is a zero-length string, contains only white space, or contains one or more invalid /// characters as defined by . /// - /// is . + /// is null. /// /// The specified path, file name, or both exceed the system-defined maximum length. For example, on /// Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 diff --git a/src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs b/src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs index 4247c403b..1c6b1dd79 100644 --- a/src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs +++ b/src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs @@ -10,11 +10,11 @@ namespace Discord /// IUser Inviter { get; } /// - /// Returns if this invite was revoked. + /// Returns true if this invite was revoked. /// bool IsRevoked { get; } /// - /// Returns if users accepting this invite will be removed from the guild when they + /// Returns true if users accepting this invite will be removed from the guild when they /// log off. /// bool IsTemporary { get; } diff --git a/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs b/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs index c54b2ffcf..6bd259195 100644 --- a/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs +++ b/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs @@ -125,28 +125,28 @@ namespace Discord /// Gets or sets the timestamp of an . /// /// - /// The timestamp of the embed, or if none is set. + /// The timestamp of the embed, or null if none is set. /// public DateTimeOffset? Timestamp { get; set; } /// /// Gets or sets the sidebar color of an . /// /// - /// The color of the embed, or if none is set. + /// The color of the embed, or null if none is set. /// public Color? Color { get; set; } /// /// Gets or sets the of an . /// /// - /// The author field builder of the embed, or if none is set. + /// The author field builder of the embed, or null if none is set. /// public EmbedAuthorBuilder Author { get; set; } /// /// Gets or sets the of an . /// /// - /// The footer field builder of the embed, or if none is set. + /// The footer field builder of the embed, or null if none is set. /// public EmbedFooterBuilder Footer { get; set; } @@ -452,7 +452,7 @@ namespace Discord /// Gets or sets the field name. /// /// - /// Field name is , empty or entirely whitespace. + /// Field name is null, empty or entirely whitespace. /// - or - /// Field name length exceeds . /// @@ -474,7 +474,7 @@ namespace Discord /// Gets or sets the field value. /// /// - /// Field value is , empty or entirely whitespace. + /// Field value is null, empty or entirely whitespace. /// - or - /// Field value length exceeds . /// @@ -540,7 +540,7 @@ namespace Discord /// The current builder. /// /// - /// or is , empty or entirely whitespace. + /// or is null, empty or entirely whitespace. /// - or - /// or exceeds the maximum length allowed by Discord. /// diff --git a/src/Discord.Net.Core/Entities/Messages/IEmbed.cs b/src/Discord.Net.Core/Entities/Messages/IEmbed.cs index 1482de20a..4c1029a10 100644 --- a/src/Discord.Net.Core/Entities/Messages/IEmbed.cs +++ b/src/Discord.Net.Core/Entities/Messages/IEmbed.cs @@ -41,56 +41,56 @@ namespace Discord /// /// /// A based on the timestamp present at the bottom left of the embed, or - /// if none is set. + /// null if none is set. /// DateTimeOffset? Timestamp { get; } /// /// Gets the color of this embed. /// /// - /// The color of the embed present on the side of the embed, or if none is set. + /// The color of the embed present on the side of the embed, or null if none is set. /// Color? Color { get; } /// /// Gets the image of this embed. /// /// - /// The image of the embed, or if none is set. + /// The image of the embed, or null if none is set. /// EmbedImage? Image { get; } /// /// Gets the video of this embed. /// /// - /// The video of the embed, or if none is set. + /// The video of the embed, or null if none is set. /// EmbedVideo? Video { get; } /// /// Gets the author field of this embed. /// /// - /// The author field of the embed, or if none is set. + /// The author field of the embed, or null if none is set. /// EmbedAuthor? Author { get; } /// /// Gets the footer field of this embed. /// /// - /// The author field of the embed, or if none is set. + /// The author field of the embed, or null if none is set. /// EmbedFooter? Footer { get; } /// /// Gets the provider of this embed. /// /// - /// The source of the embed, or if none is set. + /// The source of the embed, or null if none is set. /// EmbedProvider? Provider { get; } /// /// Gets the thumbnail featured in this embed. /// /// - /// The thumbnail featured in the embed, or if none is set. + /// The thumbnail featured in the embed, or null if none is set. /// EmbedThumbnail? Thumbnail { get; } /// diff --git a/src/Discord.Net.Core/Entities/Messages/IMessage.cs b/src/Discord.Net.Core/Entities/Messages/IMessage.cs index b2eb65439..edbe4f4b6 100644 --- a/src/Discord.Net.Core/Entities/Messages/IMessage.cs +++ b/src/Discord.Net.Core/Entities/Messages/IMessage.cs @@ -17,11 +17,11 @@ namespace Discord /// MessageSource Source { get; } /// - /// Returns if this message was sent as a text-to-speech message. + /// Returns true if this message was sent as a text-to-speech message. /// bool IsTTS { get; } /// - /// Returns if this message was added to its channel's pinned messages. + /// Returns true if this message was added to its channel's pinned messages. /// bool IsPinned { get; } /// diff --git a/src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs b/src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs index 8ef11bc47..8f2678cd9 100644 --- a/src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs +++ b/src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs @@ -11,7 +11,7 @@ namespace Discord public int ReactionCount { get; internal set; } /// - /// Returns if the current user has used this reaction. + /// Returns true if the current user has used this reaction. /// public bool IsMe { get; internal set; } } diff --git a/src/Discord.Net.Core/Entities/Permissions/ChannelPermissions.cs b/src/Discord.Net.Core/Entities/Permissions/ChannelPermissions.cs index 99134bb90..a30e51f5f 100644 --- a/src/Discord.Net.Core/Entities/Permissions/ChannelPermissions.cs +++ b/src/Discord.Net.Core/Entities/Permissions/ChannelPermissions.cs @@ -37,52 +37,52 @@ namespace Discord /// Gets a packed value representing all the permissions in this . public ulong RawValue { get; } - /// If , a user may create invites. + /// If true, a user may create invites. public bool CreateInstantInvite => Permissions.GetValue(RawValue, ChannelPermission.CreateInstantInvite); - /// If , a user may create, delete and modify this channel. + /// If true, a user may create, delete and modify this channel. public bool ManageChannel => Permissions.GetValue(RawValue, ChannelPermission.ManageChannels); - /// If , a user may add reactions. + /// If true, a user may add reactions. public bool AddReactions => Permissions.GetValue(RawValue, ChannelPermission.AddReactions); - /// If , a user may join channels. + /// If true, a user may join channels. [Obsolete("Use ViewChannel instead.")] public bool ReadMessages => ViewChannel; - /// If , a user may view channels. + /// If true, a user may view channels. public bool ViewChannel => Permissions.GetValue(RawValue, ChannelPermission.ViewChannel); - /// If , a user may send messages. + /// If true, a user may send messages. public bool SendMessages => Permissions.GetValue(RawValue, ChannelPermission.SendMessages); - /// If , a user may send text-to-speech messages. + /// If true, a user may send text-to-speech messages. public bool SendTTSMessages => Permissions.GetValue(RawValue, ChannelPermission.SendTTSMessages); - /// If , a user may delete messages. + /// If true, a user may delete messages. public bool ManageMessages => Permissions.GetValue(RawValue, ChannelPermission.ManageMessages); - /// If , Discord will auto-embed links sent by this user. + /// If true, Discord will auto-embed links sent by this user. public bool EmbedLinks => Permissions.GetValue(RawValue, ChannelPermission.EmbedLinks); - /// If , a user may send files. + /// If true, a user may send files. public bool AttachFiles => Permissions.GetValue(RawValue, ChannelPermission.AttachFiles); - /// If , a user may read previous messages. + /// If true, a user may read previous messages. public bool ReadMessageHistory => Permissions.GetValue(RawValue, ChannelPermission.ReadMessageHistory); - /// If , a user may mention @everyone. + /// If true, a user may mention @everyone. public bool MentionEveryone => Permissions.GetValue(RawValue, ChannelPermission.MentionEveryone); - /// If , a user may use custom emoji from other guilds. + /// If true, a user may use custom emoji from other guilds. public bool UseExternalEmojis => Permissions.GetValue(RawValue, ChannelPermission.UseExternalEmojis); - /// If , a user may connect to a voice channel. + /// If true, a user may connect to a voice channel. public bool Connect => Permissions.GetValue(RawValue, ChannelPermission.Connect); - /// If , a user may speak in a voice channel. + /// If true, a user may speak in a voice channel. public bool Speak => Permissions.GetValue(RawValue, ChannelPermission.Speak); - /// If , a user may mute users. + /// If true, a user may mute users. public bool MuteMembers => Permissions.GetValue(RawValue, ChannelPermission.MuteMembers); - /// If , a user may deafen users. + /// If true, a user may deafen users. public bool DeafenMembers => Permissions.GetValue(RawValue, ChannelPermission.DeafenMembers); - /// If , a user may move other users between voice channels. + /// If true, a user may move other users between voice channels. public bool MoveMembers => Permissions.GetValue(RawValue, ChannelPermission.MoveMembers); - /// If , a user may use voice-activity-detection rather than push-to-talk. + /// If true, a user may use voice-activity-detection rather than push-to-talk. public bool UseVAD => Permissions.GetValue(RawValue, ChannelPermission.UseVAD); - /// If , a user may adjust role permissions. This also implictly grants all other permissions. + /// If true, a user may adjust role permissions. This also implictly grants all other permissions. public bool ManageRoles => Permissions.GetValue(RawValue, ChannelPermission.ManageRoles); - /// If , a user may edit the webhooks for this channel. + /// If true, a user may edit the webhooks for this channel. public bool ManageWebhooks => Permissions.GetValue(RawValue, ChannelPermission.ManageWebhooks); /// Creates a new with the provided packed value. diff --git a/src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs b/src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs index e1dbb08fd..9a0cb2919 100644 --- a/src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs +++ b/src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs @@ -16,65 +16,65 @@ namespace Discord /// Gets a packed value representing all the permissions in this . public ulong RawValue { get; } - /// If , a user may create invites. + /// If true, a user may create invites. public bool CreateInstantInvite => Permissions.GetValue(RawValue, GuildPermission.CreateInstantInvite); - /// If , a user may ban users from the guild. + /// If true, a user may ban users from the guild. public bool BanMembers => Permissions.GetValue(RawValue, GuildPermission.BanMembers); - /// If , a user may kick users from the guild. + /// If true, a user may kick users from the guild. public bool KickMembers => Permissions.GetValue(RawValue, GuildPermission.KickMembers); - /// If , a user is granted all permissions, and cannot have them revoked via channel permissions. + /// If true, a user is granted all permissions, and cannot have them revoked via channel permissions. public bool Administrator => Permissions.GetValue(RawValue, GuildPermission.Administrator); - /// If , a user may create, delete and modify channels. + /// If true, a user may create, delete and modify channels. public bool ManageChannels => Permissions.GetValue(RawValue, GuildPermission.ManageChannels); - /// If , a user may adjust guild properties. + /// If true, a user may adjust guild properties. public bool ManageGuild => Permissions.GetValue(RawValue, GuildPermission.ManageGuild); - /// If , a user may add reactions. + /// If true, a user may add reactions. public bool AddReactions => Permissions.GetValue(RawValue, GuildPermission.AddReactions); - /// If , a user may view the audit log. + /// If true, a user may view the audit log. public bool ViewAuditLog => Permissions.GetValue(RawValue, GuildPermission.ViewAuditLog); - /// If , a user may join channels. + /// If true, a user may join channels. public bool ReadMessages => Permissions.GetValue(RawValue, GuildPermission.ReadMessages); - /// If , a user may send messages. + /// If true, a user may send messages. public bool SendMessages => Permissions.GetValue(RawValue, GuildPermission.SendMessages); - /// If , a user may send text-to-speech messages. + /// If true, a user may send text-to-speech messages. public bool SendTTSMessages => Permissions.GetValue(RawValue, GuildPermission.SendTTSMessages); - /// If , a user may delete messages. + /// If true, a user may delete messages. public bool ManageMessages => Permissions.GetValue(RawValue, GuildPermission.ManageMessages); - /// If , Discord will auto-embed links sent by this user. + /// If true, Discord will auto-embed links sent by this user. public bool EmbedLinks => Permissions.GetValue(RawValue, GuildPermission.EmbedLinks); - /// If , a user may send files. + /// If true, a user may send files. public bool AttachFiles => Permissions.GetValue(RawValue, GuildPermission.AttachFiles); - /// If , a user may read previous messages. + /// If true, a user may read previous messages. public bool ReadMessageHistory => Permissions.GetValue(RawValue, GuildPermission.ReadMessageHistory); - /// If , a user may mention @everyone. + /// If true, a user may mention @everyone. public bool MentionEveryone => Permissions.GetValue(RawValue, GuildPermission.MentionEveryone); - /// If , a user may use custom emoji from other guilds. + /// If true, a user may use custom emoji from other guilds. public bool UseExternalEmojis => Permissions.GetValue(RawValue, GuildPermission.UseExternalEmojis); - /// If , a user may connect to a voice channel. + /// If true, a user may connect to a voice channel. public bool Connect => Permissions.GetValue(RawValue, GuildPermission.Connect); - /// If , a user may speak in a voice channel. + /// If true, a user may speak in a voice channel. public bool Speak => Permissions.GetValue(RawValue, GuildPermission.Speak); - /// If , a user may mute users. + /// If true, a user may mute users. public bool MuteMembers => Permissions.GetValue(RawValue, GuildPermission.MuteMembers); - /// If , a user may deafen users. + /// If true, a user may deafen users. public bool DeafenMembers => Permissions.GetValue(RawValue, GuildPermission.DeafenMembers); - /// If , a user may move other users between voice channels. + /// If true, a user may move other users between voice channels. public bool MoveMembers => Permissions.GetValue(RawValue, GuildPermission.MoveMembers); - /// If , a user may use voice-activity-detection rather than push-to-talk. + /// If true, a user may use voice-activity-detection rather than push-to-talk. public bool UseVAD => Permissions.GetValue(RawValue, GuildPermission.UseVAD); - /// If , a user may change their own nickname. + /// If true, a user may change their own nickname. public bool ChangeNickname => Permissions.GetValue(RawValue, GuildPermission.ChangeNickname); - /// If , a user may change the nickname of other users. + /// If true, a user may change the nickname of other users. public bool ManageNicknames => Permissions.GetValue(RawValue, GuildPermission.ManageNicknames); - /// If , a user may adjust roles. + /// If true, a user may adjust roles. public bool ManageRoles => Permissions.GetValue(RawValue, GuildPermission.ManageRoles); - /// If , a user may edit the webhooks for this guild. + /// If true, a user may edit the webhooks for this guild. public bool ManageWebhooks => Permissions.GetValue(RawValue, GuildPermission.ManageWebhooks); - /// If , a user may edit the emojis for this guild. + /// If true, a user may edit the emojis for this guild. public bool ManageEmojis => Permissions.GetValue(RawValue, GuildPermission.ManageEmojis); /// Creates a new with the provided packed value. diff --git a/src/Discord.Net.Core/Entities/Roles/IRole.cs b/src/Discord.Net.Core/Entities/Roles/IRole.cs index f4cb4c64d..c0f4e9942 100644 --- a/src/Discord.Net.Core/Entities/Roles/IRole.cs +++ b/src/Discord.Net.Core/Entities/Roles/IRole.cs @@ -21,24 +21,24 @@ namespace Discord /// Determines whether the role can be separated in the user list. /// /// - /// Returns if users of this role are separated in the user list; otherwise, returns - /// . + /// Returns true if users of this role are separated in the user list; otherwise, returns + /// false. /// bool IsHoisted { get; } /// /// Determines whether the role is managed by Discord. /// /// - /// Returns if this role is automatically managed by Discord; otherwise, returns - /// . + /// Returns true if this role is automatically managed by Discord; otherwise, returns + /// false. /// bool IsManaged { get; } /// /// Determines whether the role is mentionable. /// /// - /// Returns if this role may be mentioned in messages; otherwise, returns - /// . + /// Returns true if this role may be mentioned in messages; otherwise, returns + /// false. /// bool IsMentionable { get; } /// diff --git a/src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs b/src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs index 401b0ec7a..27a8be351 100644 --- a/src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs +++ b/src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs @@ -12,21 +12,21 @@ namespace Discord /// Gets or sets whether the user should be muted in a voice channel. /// /// - /// If this value is set to , no user will be able to hear this user speak in the guild. + /// If this value is set to true, no user will be able to hear this user speak in the guild. /// public Optional Mute { get; set; } /// /// Gets or sets whether the user should be deafened in a voice channel. /// /// - /// If this value is set to , this user will not be able to hear anyone speak in the guild. + /// If this value is set to true, this user will not be able to hear anyone speak in the guild. /// public Optional Deaf { get; set; } /// /// Gets or sets the user's nickname. /// /// - /// To clear the user's nickname, this value can be set to or + /// To clear the user's nickname, this value can be set to null or /// . /// public Optional Nickname { get; set; } diff --git a/src/Discord.Net.Core/Entities/Users/ISelfUser.cs b/src/Discord.Net.Core/Entities/Users/ISelfUser.cs index 4a97c86ef..1ead0cbba 100644 --- a/src/Discord.Net.Core/Entities/Users/ISelfUser.cs +++ b/src/Discord.Net.Core/Entities/Users/ISelfUser.cs @@ -13,11 +13,11 @@ namespace Discord /// string Email { get; } /// - /// Returns if this user's email has been verified. + /// Returns true if this user's email has been verified. /// bool IsVerified { get; } /// - /// Returns if this user has enabled MFA on their account. + /// Returns true if this user has enabled MFA on their account. /// bool IsMfaEnabled { get; } diff --git a/src/Discord.Net.Core/Entities/Users/IUser.cs b/src/Discord.Net.Core/Entities/Users/IUser.cs index e1e6c258f..96b9ae7ee 100644 --- a/src/Discord.Net.Core/Entities/Users/IUser.cs +++ b/src/Discord.Net.Core/Entities/Users/IUser.cs @@ -35,11 +35,11 @@ namespace Discord /// ushort DiscriminatorValue { get; } /// - /// Gets if this user is a bot user. + /// Gets true if this user is a bot user. /// bool IsBot { get; } /// - /// Gets if this user is a webhook user. + /// Gets true if this user is a webhook user. /// bool IsWebhook { get; } /// diff --git a/src/Discord.Net.Core/Entities/Users/IVoiceState.cs b/src/Discord.Net.Core/Entities/Users/IVoiceState.cs index c22f094b4..abe06c3b3 100644 --- a/src/Discord.Net.Core/Entities/Users/IVoiceState.cs +++ b/src/Discord.Net.Core/Entities/Users/IVoiceState.cs @@ -6,23 +6,23 @@ namespace Discord public interface IVoiceState { /// - /// Returns if the guild has deafened this user. + /// Returns true if the guild has deafened this user. /// bool IsDeafened { get; } /// - /// Returns if the guild has muted this user. + /// Returns true if the guild has muted this user. /// bool IsMuted { get; } /// - /// Returns if this user has marked themselves as deafened. + /// Returns true if this user has marked themselves as deafened. /// bool IsSelfDeafened { get; } /// - /// Returns if this user has marked themselves as muted. + /// Returns true if this user has marked themselves as muted. /// bool IsSelfMuted { get; } /// - /// Returns if the guild is temporarily blocking audio to/from this user. + /// Returns true if the guild is temporarily blocking audio to/from this user. /// bool IsSuppressed { get; } /// diff --git a/src/Discord.Net.Core/Utils/ConcurrentHashSet.cs b/src/Discord.Net.Core/Utils/ConcurrentHashSet.cs index e8441d7bb..bbdc59087 100644 --- a/src/Discord.Net.Core/Utils/ConcurrentHashSet.cs +++ b/src/Discord.Net.Core/Utils/ConcurrentHashSet.cs @@ -165,7 +165,7 @@ namespace Discord InitializeFromCollection(collection); } /// - /// or is + /// or is null /// public ConcurrentHashSet(int concurrencyLevel, IEnumerable collection, IEqualityComparer comparer) : this(concurrencyLevel, DefaultCapacity, false, comparer) diff --git a/src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs b/src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs index 8976a8557..6a3521bff 100644 --- a/src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs +++ b/src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs @@ -168,7 +168,7 @@ namespace Discord.Rest /// invalid characters as defined by . /// /// - /// is . + /// is null. /// /// /// The specified path, file name, or both exceed the system-defined maximum length. For example, on diff --git a/src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs b/src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs index 34346555f..4b4ccb057 100644 --- a/src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs +++ b/src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs @@ -94,7 +94,7 @@ namespace Discord.Rest /// invalid characters as defined by . /// /// - /// is . + /// is null. /// /// /// The specified path, file name, or both exceed the system-defined maximum length. For example, on diff --git a/src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs b/src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs index 22ec20f03..91e097218 100644 --- a/src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs +++ b/src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs @@ -148,7 +148,7 @@ namespace Discord.Rest } /// - /// is . + /// is null. public async Task ReorderChannelsAsync(IEnumerable args, RequestOptions options = null) { var arr = args.ToArray(); @@ -324,7 +324,7 @@ namespace Discord.Rest public Task CreateEmoteAsync(string name, Image image, Optional> roles = default(Optional>), RequestOptions options = null) => GuildHelper.CreateEmoteAsync(this, Discord, name, image, roles, options); /// - /// is . + /// is null. public Task ModifyEmoteAsync(GuildEmote emote, Action func, RequestOptions options = null) => GuildHelper.ModifyEmoteAsync(this, Discord, emote.Id, func, options); /// diff --git a/src/Discord.Net.WebSocket/BaseSocketClient.cs b/src/Discord.Net.WebSocket/BaseSocketClient.cs index 69a557da9..858fec7fe 100644 --- a/src/Discord.Net.WebSocket/BaseSocketClient.cs +++ b/src/Discord.Net.WebSocket/BaseSocketClient.cs @@ -106,7 +106,7 @@ namespace Discord.WebSocket /// /// The channel snowflake ID. /// - /// A generic WebSocket-based channel object (voice, text, category, etc.); when the + /// A generic WebSocket-based channel object (voice, text, category, etc.); null when the /// channel cannot be found. /// public abstract SocketChannel GetChannel(ulong id); diff --git a/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs b/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs index 8c930e79a..6eb01b295 100644 --- a/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs +++ b/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs @@ -105,7 +105,7 @@ namespace Discord.WebSocket .OrderBy(c => c.Position) .FirstOrDefault(); /// - /// Gets the AFK voice channel, or if none is set. + /// Gets the AFK voice channel, or null if none is set. /// public SocketVoiceChannel AFKChannel { @@ -455,7 +455,7 @@ namespace Discord.WebSocket /// /// The name of the new channel. /// The options to be used when sending the request. - /// is . + /// is null. /// /// The created text channel. /// @@ -467,7 +467,7 @@ namespace Discord.WebSocket /// /// The name of the new channel. /// The options to be used when sending the request. - /// is . + /// is null. /// /// The created voice channel. /// @@ -479,7 +479,7 @@ namespace Discord.WebSocket /// /// The name of the new channel. /// The options to be used when sending the request. - /// is . + /// is null. /// /// The created category channel. /// @@ -537,12 +537,12 @@ namespace Discord.WebSocket /// /// The name of the new role. /// - /// The permissions that the new role possesses. Set to to use the default permissions. + /// The permissions that the new role possesses. Set to null to use the default permissions. /// - /// The color of the role. Set to to use the default color. + /// The color of the role. Set to null to use the default color. /// Used to determine if users of this role are separated in the user list. /// The options to be used when sending the request. - /// is . + /// is null. /// /// The created role. /// diff --git a/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs b/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs index 588ed554d..8721e722b 100644 --- a/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs +++ b/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs @@ -61,7 +61,7 @@ namespace Discord.WebSocket public IReadOnlyCollection Roles => _roleIds.Select(id => Guild.GetRole(id)).Where(x => x != null).ToReadOnlyCollection(() => _roleIds.Length); /// - /// Returns the voice channel the user is in, or if none. + /// Returns the voice channel the user is in, or null if none. /// public SocketVoiceChannel VoiceChannel => VoiceState?.VoiceChannel; ///