diff --git a/samples/BasicBot/_BasicBot.csproj b/samples/BasicBot/_BasicBot.csproj index 7d3004ad..b27e3268 100644 --- a/samples/BasicBot/_BasicBot.csproj +++ b/samples/BasicBot/_BasicBot.csproj @@ -6,7 +6,7 @@ - + diff --git a/samples/InteractionFramework/_InteractionFramework.csproj b/samples/InteractionFramework/_InteractionFramework.csproj index a0fa14d7..8d28d271 100644 --- a/samples/InteractionFramework/_InteractionFramework.csproj +++ b/samples/InteractionFramework/_InteractionFramework.csproj @@ -13,7 +13,7 @@ - + diff --git a/samples/ShardedClient/_ShardedClient.csproj b/samples/ShardedClient/_ShardedClient.csproj index 5c1c6a20..5a307993 100644 --- a/samples/ShardedClient/_ShardedClient.csproj +++ b/samples/ShardedClient/_ShardedClient.csproj @@ -8,7 +8,7 @@ - + diff --git a/samples/TextCommandFramework/_TextCommandFramework.csproj b/samples/TextCommandFramework/_TextCommandFramework.csproj index 5307303c..d70fd9d3 100644 --- a/samples/TextCommandFramework/_TextCommandFramework.csproj +++ b/samples/TextCommandFramework/_TextCommandFramework.csproj @@ -8,8 +8,8 @@ - - + + diff --git a/samples/WebhookClient/_WebhookClient.csproj b/samples/WebhookClient/_WebhookClient.csproj index acea75d2..3e0375a7 100644 --- a/samples/WebhookClient/_WebhookClient.csproj +++ b/samples/WebhookClient/_WebhookClient.csproj @@ -7,7 +7,7 @@ - + diff --git a/src/Discord.Net.Commands/Attributes/PreconditionAttribute.cs b/src/Discord.Net.Commands/Attributes/PreconditionAttribute.cs index 37a08ba3..8abd4d3b 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 = null or not at all will + /// be successful (A || B). Specifying = 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 b57886b9..cb4bea56 100644 --- a/src/Discord.Net.Commands/CommandService.cs +++ b/src/Discord.Net.Commands/CommandService.cs @@ -163,7 +163,7 @@ namespace Discord.Commands /// /// /// The type of module. - /// The for your dependency injection solution if using one; otherwise, pass null. + /// The for your dependency injection solution if using one; otherwise, pass . /// This module has already been added. /// /// The fails to be built; an invalid type may have been provided. @@ -178,7 +178,7 @@ namespace Discord.Commands /// Adds a command module from a . /// /// The type of module. - /// The for your dependency injection solution if using one; otherwise, pass null . + /// The for your dependency injection solution if using one; otherwise, pass . /// This module has already been added. /// /// The fails to be built; an invalid type may have been provided. @@ -217,7 +217,7 @@ namespace Discord.Commands /// Add command modules from an . /// /// The containing command modules. - /// The for your dependency injection solution if using one; otherwise, pass null. + /// The for your dependency injection solution if using one; otherwise, pass . /// /// A task that represents the asynchronous operation for adding the command modules. The task result /// contains an enumerable collection of modules added. diff --git a/src/Discord.Net.Commands/Extensions/MessageExtensions.cs b/src/Discord.Net.Commands/Extensions/MessageExtensions.cs index dd5defca..46a5440e 100644 --- a/src/Discord.Net.Commands/Extensions/MessageExtensions.cs +++ b/src/Discord.Net.Commands/Extensions/MessageExtensions.cs @@ -14,7 +14,7 @@ namespace Discord.Commands /// The char prefix. /// References where the command starts. /// - /// true if the message begins with the char ; otherwise false. + /// if the message begins with the char ; otherwise . /// public static bool HasCharPrefix(this IUserMessage msg, char c, ref int argPos) { diff --git a/src/Discord.Net.Commands/ModuleBase.cs b/src/Discord.Net.Commands/ModuleBase.cs index 79ab1cc3..fdd982b4 100644 --- a/src/Discord.Net.Commands/ModuleBase.cs +++ b/src/Discord.Net.Commands/ModuleBase.cs @@ -34,7 +34,7 @@ namespace Discord.Commands /// An embed to be displayed alongside the . /// /// Specifies if notifications are sent for mentioned users and roles in the . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The request options for this request. /// The message references to be included. Used to reply to specific messages. diff --git a/src/Discord.Net.Commands/Results/ExecuteResult.cs b/src/Discord.Net.Commands/Results/ExecuteResult.cs index 05599959..ba12ced1 100644 --- a/src/Discord.Net.Commands/Results/ExecuteResult.cs +++ b/src/Discord.Net.Commands/Results/ExecuteResult.cs @@ -76,7 +76,7 @@ namespace Discord.Commands /// Gets a string that indicates the execution result. /// /// - /// Success if is true; otherwise ": + /// Success if is ; otherwise ": /// ". /// public override string ToString() => IsSuccess ? "Success" : $"{Error}: {ErrorReason}"; diff --git a/src/Discord.Net.Commands/Results/IResult.cs b/src/Discord.Net.Commands/Results/IResult.cs index c11b5800..65e944bb 100644 --- a/src/Discord.Net.Commands/Results/IResult.cs +++ b/src/Discord.Net.Commands/Results/IResult.cs @@ -10,7 +10,7 @@ namespace Discord.Commands /// /// /// A indicating the type of error that may have occurred during the operation; - /// null if the operation was successful. + /// if the operation was successful. /// CommandError? Error { get; } /// @@ -24,7 +24,7 @@ namespace Discord.Commands /// Indicates whether the operation was successful or not. /// /// - /// true if the result is positive; otherwise false. + /// if the result is positive; otherwise . /// bool IsSuccess { get; } } diff --git a/src/Discord.Net.Commands/Results/ParseResult.cs b/src/Discord.Net.Commands/Results/ParseResult.cs index 43351b6b..d4662c13 100644 --- a/src/Discord.Net.Commands/Results/ParseResult.cs +++ b/src/Discord.Net.Commands/Results/ParseResult.cs @@ -23,7 +23,7 @@ namespace Discord.Commands /// /// /// A indicating the parameter info of the error that may have occurred during parsing; - /// null if the parsing was successful or the parsing error is not specific to a single parameter. + /// if the parsing was successful or the parsing error is not specific to a single parameter. /// public ParameterInfo ErrorParameter { get; } diff --git a/src/Discord.Net.Commands/Results/RuntimeResult.cs b/src/Discord.Net.Commands/Results/RuntimeResult.cs index e4c86fc2..a7febd68 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 null if none. + /// The type of failure, or if none. /// The reason of failure. protected RuntimeResult(CommandError? error, string reason) { diff --git a/src/Discord.Net.Core/DiscordConfig.cs b/src/Discord.Net.Core/DiscordConfig.cs index 3aacc30b..46fc08ff 100644 --- a/src/Discord.Net.Core/DiscordConfig.cs +++ b/src/Discord.Net.Core/DiscordConfig.cs @@ -170,7 +170,7 @@ namespace Discord /// Gets or sets whether the initial log entry should be printed. /// /// - /// If set to true, the library will attempt to print the current version of the library, as well as + /// If set to , the library will attempt to print the current version of the library, as well as /// the API version it uses on startup. /// internal bool DisplayInitialLog { get; set; } = true; @@ -179,7 +179,7 @@ namespace Discord /// Gets or sets whether or not rate-limits should use the system clock. /// /// - /// If set to false, we will use the X-RateLimit-Reset-After header + /// If set to , we will use the X-RateLimit-Reset-After header /// to determine when a rate-limit expires, rather than comparing the /// X-RateLimit-Reset timestamp to the system time. /// diff --git a/src/Discord.Net.Core/Entities/Activities/GameAsset.cs b/src/Discord.Net.Core/Entities/Activities/GameAsset.cs index 7217bded..b78307dd 100644 --- a/src/Discord.Net.Core/Entities/Activities/GameAsset.cs +++ b/src/Discord.Net.Core/Entities/Activities/GameAsset.cs @@ -30,7 +30,7 @@ namespace Discord /// The size of the image to return in. This can be any power of two between 16 and 2048. /// The format to return. /// - /// A string pointing to the image URL of the asset; null when the application ID does not exist. + /// A string pointing to the image URL of the asset; when the application ID does not exist. /// public string GetImageUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128) => ApplicationId.HasValue ? CDN.GetRichAssetUrl(ApplicationId.Value, ImageId, size, format) : null; diff --git a/src/Discord.Net.Core/Entities/AuditLogs/IAuditLogEntry.cs b/src/Discord.Net.Core/Entities/AuditLogs/IAuditLogEntry.cs index 15ae5fd8..7e387583 100644 --- a/src/Discord.Net.Core/Entities/AuditLogs/IAuditLogEntry.cs +++ b/src/Discord.Net.Core/Entities/AuditLogs/IAuditLogEntry.cs @@ -23,7 +23,7 @@ namespace Discord /// Gets the data for this entry. /// /// - /// An for this audit log entry; null if no data is available. + /// An for this audit log entry; if no data is available. /// IAuditLogData Data { get; } @@ -39,7 +39,7 @@ namespace Discord /// Gets the reason behind the change. /// /// - /// A string containing the reason for the change; null if none is provided. + /// A string containing the reason for the change; if none is provided. /// string Reason { get; } } diff --git a/src/Discord.Net.Core/Entities/Channels/IChannel.cs b/src/Discord.Net.Core/Entities/Channels/IChannel.cs index 6d58486f..1de37243 100644 --- a/src/Discord.Net.Core/Entities/Channels/IChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/IChannel.cs @@ -46,7 +46,7 @@ namespace Discord /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains a user object that - /// represents the found user; null if none is found. + /// represents the found user; if none is found. /// Task GetUserAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); } diff --git a/src/Discord.Net.Core/Entities/Channels/IForumChannel.cs b/src/Discord.Net.Core/Entities/Channels/IForumChannel.cs index cd9c82d5..dda6a6c3 100644 --- a/src/Discord.Net.Core/Entities/Channels/IForumChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/IForumChannel.cs @@ -16,7 +16,7 @@ namespace Discord /// Gets a value that indicates whether the channel is NSFW. /// /// - /// true if the channel has the NSFW flag enabled; otherwise false. + /// if the channel has the NSFW flag enabled; otherwise . /// bool IsNsfw { get; } @@ -24,7 +24,7 @@ namespace Discord /// Gets the current topic for this text channel. /// /// - /// A string representing the topic set in the channel; null if none is set. + /// A string representing the topic set in the channel; if none is set. /// string Topic { get; } @@ -103,7 +103,7 @@ namespace Discord /// The options to be used when sending the request. /// /// Specifies if notifications are sent for mentioned users and roles in the message . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The message components to be included with this message. Used for interactions. /// A collection of stickers to send with the message. @@ -130,7 +130,7 @@ namespace Discord /// Whether the message attachment should be hidden as a spoiler. /// /// Specifies if notifications are sent for mentioned users and roles in the message . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The message components to be included with this message. Used for interactions. /// A collection of stickers to send with the file. @@ -159,7 +159,7 @@ namespace Discord /// Whether the message attachment should be hidden as a spoiler. /// /// Specifies if notifications are sent for mentioned users and roles in the message . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The message components to be included with this message. Used for interactions. /// A collection of stickers to send with the file. @@ -186,7 +186,7 @@ namespace Discord /// The options to be used when sending the request. /// /// Specifies if notifications are sent for mentioned users and roles in the message . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The message components to be included with this message. Used for interactions. /// A collection of stickers to send with the file. @@ -212,7 +212,7 @@ namespace Discord /// The options to be used when sending the request. /// /// Specifies if notifications are sent for mentioned users and roles in the message . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The message components to be included with this message. Used for interactions. /// A collection of stickers to send with the file. diff --git a/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs b/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs index 12874f2c..6726b7b4 100644 --- a/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs @@ -74,7 +74,7 @@ namespace Discord /// /// The role to get the overwrite from. /// - /// An overwrite object for the targeted role; null if none is set. + /// An overwrite object for the targeted role; if none is set. /// OverwritePermissions? GetPermissionOverwrite(IRole role); /// @@ -82,7 +82,7 @@ namespace Discord /// /// The user to get the overwrite from. /// - /// An overwrite object for the targeted user; null if none is set. + /// An overwrite object for the targeted user; if none is set. /// OverwritePermissions? GetPermissionOverwrite(IUser user); /// @@ -163,7 +163,7 @@ namespace Discord /// The options to be used when sending the request. /// /// A task representing the asynchronous get operation. The task result contains a guild user object that - /// represents the user; null if none is found. + /// represents the user; if none is found. /// new Task GetUserAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); } diff --git a/src/Discord.Net.Core/Entities/Channels/IIntegrationChannel.cs b/src/Discord.Net.Core/Entities/Channels/IIntegrationChannel.cs index 7c28ea9f..0dab9596 100644 --- a/src/Discord.Net.Core/Entities/Channels/IIntegrationChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/IIntegrationChannel.cs @@ -28,7 +28,7 @@ public interface IIntegrationChannel : IGuildChannel /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains a webhook associated - /// with the identifier; null if the webhook is not found. + /// with the identifier; if the webhook is not found. /// Task GetWebhookAsync(ulong id, RequestOptions options = null); diff --git a/src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs b/src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs index 7bd9fabf..615b009f 100644 --- a/src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs @@ -25,7 +25,7 @@ namespace Discord /// The options to be used when sending the request. /// /// Specifies if notifications are sent for mentioned users and roles in the message . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The message references to be included. Used to reply to specific messages. /// The message components to be included with this message. Used for interactions. @@ -67,7 +67,7 @@ namespace Discord /// Whether the message attachment should be hidden as a spoiler. /// /// Specifies if notifications are sent for mentioned users and roles in the message . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The message references to be included. Used to reply to specific messages. /// The message components to be included with this message. Used for interactions. @@ -105,7 +105,7 @@ namespace Discord /// Whether the message attachment should be hidden as a spoiler. /// /// Specifies if notifications are sent for mentioned users and roles in the message . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The message references to be included. Used to reply to specific messages. /// The message components to be included with this message. Used for interactions. @@ -135,7 +135,7 @@ namespace Discord /// The options to be used when sending the request. /// /// Specifies if notifications are sent for mentioned users and roles in the message . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The message references to be included. Used to reply to specific messages. /// The message components to be included with this message. Used for interactions. @@ -165,7 +165,7 @@ namespace Discord /// The options to be used when sending the request. /// /// Specifies if notifications are sent for mentioned users and roles in the message . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The message references to be included. Used to reply to specific messages. /// The message components to be included with this message. Used for interactions. @@ -186,7 +186,7 @@ namespace Discord /// The options to be used when sending the request. /// /// A task that represents an asynchronous get operation for retrieving the message. The task result contains - /// the retrieved message; null if no message is found with the specified identifier. + /// the retrieved message; if no message is found with the specified identifier. /// Task GetMessageAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); diff --git a/src/Discord.Net.Core/Entities/Channels/INestedChannel.cs b/src/Discord.Net.Core/Entities/Channels/INestedChannel.cs index 511d2bf5..973ac7b3 100644 --- a/src/Discord.Net.Core/Entities/Channels/INestedChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/INestedChannel.cs @@ -13,7 +13,7 @@ namespace Discord /// /// /// A representing the snowflake identifier of the parent of this channel; - /// null if none is set. + /// if none is set. /// ulong? CategoryId { get; } /// @@ -23,7 +23,7 @@ namespace Discord /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains the category channel - /// representing the parent of this channel; null if none is set. + /// representing the parent of this channel; if none is set. /// Task GetCategoryAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); @@ -46,10 +46,10 @@ namespace Discord /// await guildChannel.CreateInviteAsync(maxAge: 43200, maxUses: 3); /// /// - /// The time (in seconds) until the invite expires. Set to null to never expire. - /// The max amount of times this invite may be used. Set to null to have unlimited uses. - /// If true, the user accepting this invite will be kicked from the guild after closing their client. - /// If true, don't try to reuse a similar invite (useful for creating many unique one time use invites). + /// The time (in seconds) until the invite expires. Set to to never expire. + /// The max amount of times this invite may be used. Set to to have unlimited uses. + /// If , the 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). /// The options to be used when sending the request. /// /// A task that represents the asynchronous invite creation operation. The task result contains an invite @@ -61,10 +61,10 @@ namespace Discord /// Creates a new invite to this channel. /// /// The id of the embedded application to open for this invite. - /// The time (in seconds) until the invite expires. Set to null to never expire. - /// The max amount of times this invite may be used. Set to null to have unlimited uses. - /// If true, the user accepting this invite will be kicked from the guild after closing their client. - /// If true, don't try to reuse a similar invite (useful for creating many unique one time use invites). + /// The time (in seconds) until the invite expires. Set to to never expire. + /// The max amount of times this invite may be used. Set to to have unlimited uses. + /// If , the 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). /// The options to be used when sending the request. /// /// A task that represents the asynchronous invite creation operation. The task result contains an invite @@ -76,10 +76,10 @@ namespace Discord /// Creates a new invite to this channel. /// /// The application to open for this invite. - /// The time (in seconds) until the invite expires. Set to null to never expire. - /// The max amount of times this invite may be used. Set to null to have unlimited uses. - /// If true, the user accepting this invite will be kicked from the guild after closing their client. - /// If true, don't try to reuse a similar invite (useful for creating many unique one time use invites). + /// The time (in seconds) until the invite expires. Set to to never expire. + /// The max amount of times this invite may be used. Set to to have unlimited uses. + /// If , the 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). /// The options to be used when sending the request. /// /// A task that represents the asynchronous invite creation operation. The task result contains an invite @@ -98,10 +98,10 @@ namespace Discord /// /// /// The id of the user whose stream to display for this invite. - /// The time (in seconds) until the invite expires. Set to null to never expire. - /// The max amount of times this invite may be used. Set to null to have unlimited uses. - /// If true, the user accepting this invite will be kicked from the guild after closing their client. - /// If true, don't try to reuse a similar invite (useful for creating many unique one time use invites). + /// The time (in seconds) until the invite expires. Set to to never expire. + /// The max amount of times this invite may be used. Set to to have unlimited uses. + /// If , the 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). /// The options to be used when sending the request. /// /// A task that represents the asynchronous invite creation operation. The task result contains an invite diff --git a/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs b/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs index ae02229b..54956f14 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 /// Gets a value that indicates whether the channel is NSFW. /// /// - /// true if the channel has the NSFW flag enabled; otherwise false. + /// if the channel has the NSFW flag enabled; otherwise . /// bool IsNsfw { get; } @@ -22,7 +22,7 @@ namespace Discord /// Gets the current topic for this text channel. /// /// - /// A string representing the topic set in the channel; null if none is set. + /// A string representing the topic set in the channel; if none is set. /// string Topic { get; } diff --git a/src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs b/src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs index 5976abe3..77f1e9d5 100644 --- a/src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs @@ -22,7 +22,7 @@ namespace Discord /// /// /// An representing the maximum number of users that are allowed to be connected to this - /// channel at once; null if a limit is not set. + /// channel at once; if a limit is not set. /// int? UserLimit { get; } diff --git a/src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs b/src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs index 2dc5cfd2..dac86d2d 100644 --- a/src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs +++ b/src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs @@ -13,7 +13,7 @@ namespace Discord /// Gets or sets the topic of the channel. /// /// - /// Setting this value to any string other than null or will set the + /// Setting this value to any string other than or will set the /// channel topic or description to the desired value. /// public Optional Topic { get; set; } @@ -21,8 +21,8 @@ namespace Discord /// Gets or sets whether this channel should be flagged as NSFW. /// /// - /// Setting this value to true will mark the channel as NSFW (Not Safe For Work) and will prompt the - /// user about its possibly mature nature before they may view the channel; setting this value to false will + /// Setting this value to will mark the channel as NSFW (Not Safe For Work) and will prompt the + /// user about its possibly mature nature before they may view the channel; setting this value to will /// remove the NSFW indicator. /// public Optional IsNsfw { get; set; } diff --git a/src/Discord.Net.Core/Entities/Channels/VoiceChannelProperties.cs b/src/Discord.Net.Core/Entities/Channels/VoiceChannelProperties.cs index 30d692d6..ee0795c8 100644 --- a/src/Discord.Net.Core/Entities/Channels/VoiceChannelProperties.cs +++ b/src/Discord.Net.Core/Entities/Channels/VoiceChannelProperties.cs @@ -12,7 +12,7 @@ public class VoiceChannelProperties : TextChannelProperties /// public Optional Bitrate { get; set; } /// - /// Gets or sets the maximum number of users that can be present in a channel, or null if none. + /// Gets or sets the maximum number of users that can be present in a channel, or if none. /// public Optional UserLimit { get; set; } /// diff --git a/src/Discord.Net.Core/Entities/Emotes/GuildEmote.cs b/src/Discord.Net.Core/Entities/Emotes/GuildEmote.cs index 4bd0845c..47ec3a42 100644 --- a/src/Discord.Net.Core/Entities/Emotes/GuildEmote.cs +++ b/src/Discord.Net.Core/Entities/Emotes/GuildEmote.cs @@ -35,7 +35,7 @@ namespace Discord /// /// /// An snowflake identifier representing the user who created this emoji; - /// null if unknown. + /// if unknown. /// public ulong? CreatorId { get; } diff --git a/src/Discord.Net.Core/Entities/Guilds/IBan.cs b/src/Discord.Net.Core/Entities/Guilds/IBan.cs index 617f2fe0..f3845592 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IBan.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IBan.cs @@ -16,7 +16,7 @@ namespace Discord /// Gets the reason why the user is banned if specified. /// /// - /// A string containing the reason behind the ban; null if none is specified. + /// A string containing the reason behind the ban; if none is specified. /// string Reason { get; } } diff --git a/src/Discord.Net.Core/Entities/Guilds/IGuild.cs b/src/Discord.Net.Core/Entities/Guilds/IGuild.cs index aec5bff1..e63b2de0 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IGuild.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IGuild.cs @@ -115,7 +115,7 @@ namespace Discord /// This boolean is used to determine if the guild is currently connected to the WebSocket and is ready to be used/accessed. /// /// - /// true if this guild is currently connected and ready to be used; otherwise . + /// if this guild is currently connected and ready to be used; otherwise . /// bool Available { get; } @@ -966,7 +966,7 @@ namespace Discord /// This method removes all users that have not logged on in the provided number of . /// /// - /// If is true, this method will only return the number of users that + /// If is , this method will only return the number of users that /// would be removed without kicking the users. /// /// diff --git a/src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs b/src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs index 83bde9ba..75ee3065 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs @@ -7,11 +7,11 @@ namespace Discord /// string Name { get; } /// - /// Gets the icon URL associated with this guild, or null if one is not set. + /// Gets the icon URL associated with this guild, or if one is not set. /// string IconUrl { get; } /// - /// Returns true if the current user owns this guild. + /// Returns 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 9cef8491..8435cc75 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IVoiceRegion.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IVoiceRegion.cs @@ -23,28 +23,28 @@ namespace Discord /// Gets a value that indicates whether or not this voice region is exclusive to partnered servers. /// /// - /// true if this voice region is exclusive to VIP accounts; otherwise false. + /// if this voice region is exclusive to VIP accounts; otherwise . /// bool IsVip { get; } /// /// Gets a value that indicates whether this voice region is optimal for your client in terms of latency. /// /// - /// true if this voice region is the closest to your machine; otherwise false . + /// if this voice region is the closest to your machine; otherwise . /// bool IsOptimal { get; } /// /// Gets a value that indicates whether this voice region is no longer being maintained. /// /// - /// true if this is a deprecated voice region; otherwise false. + /// if this is a deprecated voice region; otherwise . /// bool IsDeprecated { get; } /// /// Gets a value that indicates whether this voice region is custom-made for events. /// /// - /// true if this is a custom voice region (used for events/etc); otherwise false/ + /// if this is a custom voice region (used for events/etc); otherwise / /// bool IsCustom { get; } } diff --git a/src/Discord.Net.Core/Entities/Image.cs b/src/Discord.Net.Core/Entities/Image.cs index 3f5a01f6..2043091f 100644 --- a/src/Discord.Net.Core/Entities/Image.cs +++ b/src/Discord.Net.Core/Entities/Image.cs @@ -41,7 +41,7 @@ namespace Discord /// is a zero-length string, contains only white space, or contains one or more invalid /// characters as defined by . /// - /// is null. + /// is . /// /// 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/Integrations/IIntegration.cs b/src/Discord.Net.Core/Entities/Integrations/IIntegration.cs index 3fe83118..11d05792 100644 --- a/src/Discord.Net.Core/Entities/Integrations/IIntegration.cs +++ b/src/Discord.Net.Core/Entities/Integrations/IIntegration.cs @@ -33,7 +33,7 @@ namespace Discord /// Gets a value that indicates whether this integration is enabled or not. /// /// - /// true if this integration is enabled; otherwise false. + /// if this integration is enabled; otherwise . /// bool IsEnabled { get; } /// @@ -44,7 +44,7 @@ namespace Discord /// disabled will not. A user must manually choose when sync the integration if syncing is disabled. /// /// - /// true if this integration is syncing; otherwise false. + /// if this integration is syncing; otherwise . /// bool? IsSyncing { get; } /// diff --git a/src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs b/src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs index c2580c85..0f9ff4f9 100644 --- a/src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs +++ b/src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs @@ -11,15 +11,15 @@ namespace Discord /// Gets a value that indicates whether the invite is a temporary one. /// /// - /// true if users accepting this invite will be removed from the guild when they log off; otherwise - /// false. + /// if users accepting this invite will be removed from the guild when they log off; otherwise + /// . /// bool IsTemporary { get; } /// /// Gets the time (in seconds) until the invite expires. /// /// - /// An representing the time in seconds until this invite expires; null if this + /// An representing the time in seconds until this invite expires; if this /// invite never expires. /// int? MaxAge { get; } @@ -28,7 +28,7 @@ namespace Discord /// /// /// An representing the number of uses this invite may be accepted until it is removed - /// from the guild; null if none is set. + /// from the guild; if none is set. /// int? MaxUses { get; } /// diff --git a/src/Discord.Net.Core/Entities/Messages/AllowedMentions.cs b/src/Discord.Net.Core/Entities/Messages/AllowedMentions.cs index 0206ad7b..42e3b751 100644 --- a/src/Discord.Net.Core/Entities/Messages/AllowedMentions.cs +++ b/src/Discord.Net.Core/Entities/Messages/AllowedMentions.cs @@ -29,7 +29,7 @@ namespace Discord /// The flag is mutually exclusive with the /// property, and the flag is mutually exclusive with the /// property. - /// If null, only the ids specified in and will be mentioned. + /// If , only the ids specified in and will be mentioned. /// public AllowedMentionTypes? AllowedTypes { get; set; } @@ -37,7 +37,7 @@ namespace Discord /// Gets or sets the list of all role ids that will be mentioned. /// This property is mutually exclusive with the /// flag of the property. If the flag is set, the value of this property - /// must be null or empty. + /// must be or empty. /// public List RoleIds { get; set; } = new List(); @@ -45,7 +45,7 @@ namespace Discord /// Gets or sets the list of all user ids that will be mentioned. /// This property is mutually exclusive with the /// flag of the property. If the flag is set, the value of this property - /// must be null or empty. + /// must be or empty. /// public List UserIds { get; set; } = new List(); @@ -62,7 +62,7 @@ namespace Discord /// /// /// The types of mentions to parse from the message content. - /// If null, only the ids specified in and will be mentioned. + /// If , only the ids specified in and will be mentioned. /// public AllowedMentions(AllowedMentionTypes? allowedTypes = null) { diff --git a/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs b/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs index 797cea2a..7f049383 100644 --- a/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs +++ b/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs @@ -93,7 +93,7 @@ namespace Discord /// Gets or sets the list of of an . /// An embed builder's fields collection is set to - /// null. + /// . /// Fields count exceeds . /// /// The list of existing . @@ -114,28 +114,28 @@ namespace Discord /// Gets or sets the timestamp of an . /// /// - /// The timestamp of the embed, or null if none is set. + /// The timestamp of the embed, or if none is set. /// public DateTimeOffset? Timestamp { get; set; } /// /// Gets or sets the sidebar color of an . /// /// - /// The color of the embed, or null if none is set. + /// The color of the embed, or if none is set. /// public Color? Color { get; set; } /// /// Gets or sets the of an . /// /// - /// The author field builder of the embed, or null if none is set. + /// The author field builder of the embed, or if none is set. /// public EmbedAuthorBuilder Author { get; set; } /// /// Gets or sets the of an . /// /// - /// The footer field builder of the embed, or null if none is set. + /// The footer field builder of the embed, or if none is set. /// public EmbedFooterBuilder Footer { get; set; } @@ -556,7 +556,7 @@ namespace Discord /// Gets or sets the field name. /// /// - /// Field name is null, empty or entirely whitespace. + /// Field name is , empty or entirely whitespace. /// - or - /// Field name length exceeds . /// @@ -580,7 +580,7 @@ namespace Discord /// Gets or sets the field value. /// /// - /// Field value is null, empty or entirely whitespace. + /// Field value is , empty or entirely whitespace. /// - or - /// Field value length exceeds . /// @@ -648,7 +648,7 @@ namespace Discord /// The current builder. /// /// - /// or is null, empty or entirely whitespace. + /// or is , empty or entirely whitespace. /// - or - /// or exceeds the maximum length allowed by Discord. /// diff --git a/src/Discord.Net.Core/Entities/Messages/EmbedImage.cs b/src/Discord.Net.Core/Entities/Messages/EmbedImage.cs index 85a638dc..74f59748 100644 --- a/src/Discord.Net.Core/Entities/Messages/EmbedImage.cs +++ b/src/Discord.Net.Core/Entities/Messages/EmbedImage.cs @@ -26,7 +26,7 @@ namespace Discord /// /// /// A representing the height of this image if it can be retrieved; otherwise - /// null. + /// . /// public int? Height { get; } /// @@ -34,7 +34,7 @@ namespace Discord /// /// /// A representing the width of this image if it can be retrieved; otherwise - /// null. + /// . /// public int? Width { get; } diff --git a/src/Discord.Net.Core/Entities/Messages/EmbedThumbnail.cs b/src/Discord.Net.Core/Entities/Messages/EmbedThumbnail.cs index 65c8139c..dea07426 100644 --- a/src/Discord.Net.Core/Entities/Messages/EmbedThumbnail.cs +++ b/src/Discord.Net.Core/Entities/Messages/EmbedThumbnail.cs @@ -26,7 +26,7 @@ namespace Discord /// /// /// A representing the height of this thumbnail if it can be retrieved; otherwise - /// null. + /// . /// public int? Height { get; } /// @@ -34,7 +34,7 @@ namespace Discord /// /// /// A representing the width of this thumbnail if it can be retrieved; otherwise - /// null. + /// . /// public int? Width { get; } diff --git a/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs b/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs index 0762ed8e..a0c7249a 100644 --- a/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs +++ b/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs @@ -21,7 +21,7 @@ namespace Discord /// /// /// A representing the height of this video if it can be retrieved; otherwise - /// null. + /// . /// public int? Height { get; } /// @@ -29,7 +29,7 @@ namespace Discord /// /// /// A representing the width of this video if it can be retrieved; otherwise - /// null. + /// . /// public int? Width { get; } diff --git a/src/Discord.Net.Core/Entities/Messages/FileAttachment.cs b/src/Discord.Net.Core/Entities/Messages/FileAttachment.cs index 7470a72c..b7b1cb36 100644 --- a/src/Discord.Net.Core/Entities/Messages/FileAttachment.cs +++ b/src/Discord.Net.Core/Entities/Messages/FileAttachment.cs @@ -71,7 +71,7 @@ namespace Discord /// is a zero-length string, contains only white space, or contains one or more invalid /// characters as defined by . /// - /// is null. + /// is . /// /// 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/Messages/IAttachment.cs b/src/Discord.Net.Core/Entities/Messages/IAttachment.cs index 55d2596e..75d1262e 100644 --- a/src/Discord.Net.Core/Entities/Messages/IAttachment.cs +++ b/src/Discord.Net.Core/Entities/Messages/IAttachment.cs @@ -45,14 +45,14 @@ namespace Discord /// Gets the height of this attachment. /// /// - /// The height of this attachment if it is a picture; otherwise null. + /// The height of this attachment if it is a picture; otherwise . /// int? Height { get; } /// /// Gets the width of this attachment. /// /// - /// The width of this attachment if it is a picture; otherwise null. + /// The width of this attachment if it is a picture; otherwise . /// int? Width { get; } /// diff --git a/src/Discord.Net.Core/Entities/Messages/IEmbed.cs b/src/Discord.Net.Core/Entities/Messages/IEmbed.cs index 4c1029a1..1482de20 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 - /// null if none is set. + /// 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 null if none is set. + /// The color of the embed present on the side of the embed, or if none is set. /// Color? Color { get; } /// /// Gets the image of this embed. /// /// - /// The image of the embed, or null if none is set. + /// The image of the embed, or if none is set. /// EmbedImage? Image { get; } /// /// Gets the video of this embed. /// /// - /// The video of the embed, or null if none is set. + /// The video of the embed, or if none is set. /// EmbedVideo? Video { get; } /// /// Gets the author field of this embed. /// /// - /// The author field of the embed, or null if none is set. + /// The author field of the embed, or if none is set. /// EmbedAuthor? Author { get; } /// /// Gets the footer field of this embed. /// /// - /// The author field of the embed, or null if none is set. + /// The author field of the embed, or if none is set. /// EmbedFooter? Footer { get; } /// /// Gets the provider of this embed. /// /// - /// The source of the embed, or null if none is set. + /// The source of the embed, or if none is set. /// EmbedProvider? Provider { get; } /// /// Gets the thumbnail featured in this embed. /// /// - /// The thumbnail featured in the embed, or null if none is set. + /// The thumbnail featured in the embed, or 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 c50f873a..75cb98b5 100644 --- a/src/Discord.Net.Core/Entities/Messages/IMessage.cs +++ b/src/Discord.Net.Core/Entities/Messages/IMessage.cs @@ -21,28 +21,28 @@ namespace Discord /// Gets the value that indicates whether this message was meant to be read-aloud by Discord. /// /// - /// true if this message was sent as a text-to-speech message; otherwise false. + /// if this message was sent as a text-to-speech message; otherwise . /// bool IsTTS { get; } /// /// Gets the value that indicates whether this message is pinned. /// /// - /// true if this message was added to its channel's pinned messages; otherwise false. + /// if this message was added to its channel's pinned messages; otherwise . /// bool IsPinned { get; } /// /// Gets the value that indicates whether or not this message's embeds are suppressed. /// /// - /// true if the embeds in this message have been suppressed (made invisible); otherwise false. + /// if the embeds in this message have been suppressed (made invisible); otherwise . /// bool IsSuppressed { get; } /// /// Gets the value that indicates whether this message mentioned everyone. /// /// - /// true if this message mentioned everyone; otherwise false. + /// if this message mentioned everyone; otherwise . /// bool MentionedEveryone { get; } /// @@ -76,7 +76,7 @@ namespace Discord /// Gets the time of this message's last edit. /// /// - /// Time of when the message was last edited; null if the message is never edited. + /// Time of when the message was last edited; if the message is never edited. /// DateTimeOffset? EditedTimestamp { get; } diff --git a/src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs b/src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs index 85066692..f6a11634 100644 --- a/src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs +++ b/src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs @@ -17,7 +17,7 @@ namespace Discord /// Gets a value that indicates whether the current user has reacted to this. /// /// - /// true if the user has reacted to the message; otherwise false. + /// if the user has reacted to the message; otherwise . /// public bool IsMe { get; internal set; } } diff --git a/src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs b/src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs index 071fc6f4..c4d20948 100644 --- a/src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs +++ b/src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs @@ -364,7 +364,7 @@ namespace Discord /// in these permissions. /// /// The permission value to check for. - /// if the permission is enabled, false otherwise. + /// if the permission is enabled, otherwise. public bool Has(GuildPermission permission) => Permissions.GetValue(RawValue, permission); /// diff --git a/src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs b/src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs index d095e78e..fcc7573b 100644 --- a/src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs +++ b/src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs @@ -83,21 +83,21 @@ namespace Discord public PermValue ManageRoles => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.ManageRoles); /// If True, a user may edit the webhooks for this channel. public PermValue ManageWebhooks => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.ManageWebhooks); - /// If true, a user may use slash commands in this guild. + /// If , a user may use slash commands in this guild. public PermValue UseApplicationCommands => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.UseApplicationCommands); - /// If true, a user may request to speak in stage channels. + /// If , a user may request to speak in stage channels. public PermValue RequestToSpeak => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.RequestToSpeak); - /// If true, a user may manage threads in this guild. + /// If , a user may manage threads in this guild. public PermValue ManageThreads => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.ManageThreads); - /// If true, a user may create public threads in this guild. + /// If , a user may create public threads in this guild. public PermValue CreatePublicThreads => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.CreatePublicThreads); - /// If true, a user may create private threads in this guild. + /// If , a user may create private threads in this guild. public PermValue CreatePrivateThreads => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.CreatePrivateThreads); - /// If true, a user may use external stickers in this guild. + /// If , a user may use external stickers in this guild. public PermValue UseExternalStickers => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.UseExternalStickers); - /// If true, a user may send messages in threads in this guild. + /// If , a user may send messages in threads in this guild. public PermValue SendMessagesInThreads => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.SendMessagesInThreads); - /// If true, a user launch application activities in voice channels in this guild. + /// If , a user launch application activities in voice channels in this guild. public PermValue StartEmbeddedActivities => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.StartEmbeddedActivities); /// Creates a new OverwritePermissions with the provided allow and deny packed values. diff --git a/src/Discord.Net.Core/Entities/Roles/IRole.cs b/src/Discord.Net.Core/Entities/Roles/IRole.cs index 59ca41e3..edb92fb1 100644 --- a/src/Discord.Net.Core/Entities/Roles/IRole.cs +++ b/src/Discord.Net.Core/Entities/Roles/IRole.cs @@ -27,21 +27,21 @@ namespace Discord /// Gets a value that indicates whether the role can be separated in the user list. /// /// - /// true if users of this role are separated in the user list; otherwise false. + /// if users of this role are separated in the user list; otherwise . /// bool IsHoisted { get; } /// /// Gets a value that indicates whether the role is managed by Discord. /// /// - /// true if this role is automatically managed by Discord; otherwise false. + /// if this role is automatically managed by Discord; otherwise . /// bool IsManaged { get; } /// /// Gets a value that indicates whether the role is mentionable. /// /// - /// true if this role may be mentioned in messages; otherwise false. + /// if this role may be mentioned in messages; otherwise . /// bool IsMentionable { get; } /// diff --git a/src/Discord.Net.Core/Entities/Users/AddGuildUserProperties.cs b/src/Discord.Net.Core/Entities/Users/AddGuildUserProperties.cs index e380d902..03177de0 100644 --- a/src/Discord.Net.Core/Entities/Users/AddGuildUserProperties.cs +++ b/src/Discord.Net.Core/Entities/Users/AddGuildUserProperties.cs @@ -12,7 +12,7 @@ namespace Discord /// Gets or sets the user's nickname. /// /// - /// To clear the user's nickname, this value can be set to null or + /// To clear the user's nickname, this value can be set to or /// . /// public Optional Nickname { get; set; } @@ -20,14 +20,14 @@ namespace Discord /// Gets or sets whether the user should be muted in a voice channel. /// /// - /// If this value is set to true, no user will be able to hear this user speak in the guild. + /// If this value is set to , 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 true, this user will not be able to hear anyone speak in the guild. + /// If this value is set to , this user will not be able to hear anyone speak in the guild. /// public Optional Deaf { get; set; } /// diff --git a/src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs b/src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs index 7ea397c8..8903168a 100644 --- a/src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs +++ b/src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs @@ -13,21 +13,21 @@ namespace Discord /// Gets or sets whether the user should be muted in a voice channel. /// /// - /// If this value is set to true, no user will be able to hear this user speak in the guild. + /// If this value is set to , 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 true, this user will not be able to hear anyone speak in the guild. + /// If this value is set to , 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 null or + /// To clear the user's nickname, this value can be set to or /// . /// public Optional Nickname { get; set; } @@ -60,7 +60,7 @@ namespace Discord /// public Optional> RoleIds { get; set; } /// - /// Moves a user to a voice channel. If null, this user will be disconnected from their current voice channel. + /// Moves a user to a voice channel. If , this user will be disconnected from their current voice channel. /// /// /// This user MUST already be in a for this to work. @@ -68,7 +68,7 @@ namespace Discord /// public Optional Channel { get; set; } /// - /// Moves a user to a voice channel. Set to null to disconnect this user from their current voice channel. + /// Moves a user to a voice channel. Set to to disconnect this user from their current voice channel. /// /// /// This user MUST already be in a for this to work. diff --git a/src/Discord.Net.Core/Entities/Users/IGuildUser.cs b/src/Discord.Net.Core/Entities/Users/IGuildUser.cs index 572bfc49..814a5234 100644 --- a/src/Discord.Net.Core/Entities/Users/IGuildUser.cs +++ b/src/Discord.Net.Core/Entities/Users/IGuildUser.cs @@ -14,7 +14,7 @@ namespace Discord /// /// /// A representing the time of which the user has joined the guild; - /// null when it cannot be obtained. + /// when it cannot be obtained. /// DateTimeOffset? JoinedAt { get; } /// @@ -28,7 +28,7 @@ namespace Discord /// Gets the nickname for this user. /// /// - /// A string representing the nickname of the user; null if none is set. + /// A string representing the nickname of the user; if none is set. /// string Nickname { get; } /// @@ -73,7 +73,7 @@ namespace Discord /// Gets the date and time for when this user's guild boost began. /// /// - /// A for when the user began boosting this guild; null if they are not boosting the guild. + /// A for when the user began boosting this guild; if they are not boosting the guild. /// DateTimeOffset? PremiumSince { get; } /// diff --git a/src/Discord.Net.Core/Entities/Users/ISelfUser.cs b/src/Discord.Net.Core/Entities/Users/ISelfUser.cs index 04c65521..4f5da84c 100644 --- a/src/Discord.Net.Core/Entities/Users/ISelfUser.cs +++ b/src/Discord.Net.Core/Entities/Users/ISelfUser.cs @@ -16,14 +16,14 @@ namespace Discord /// Indicates whether or not this user has their email verified. /// /// - /// true if this user's email has been verified; false if not. + /// if this user's email has been verified; if not. /// bool IsVerified { get; } /// /// Indicates whether or not this user has MFA enabled on their account. /// /// - /// true if this user has enabled multi-factor authentication on their account; false if not. + /// if this user has enabled multi-factor authentication on their account; if not. /// bool IsMfaEnabled { get; } /// diff --git a/src/Discord.Net.Core/Entities/Users/IUser.cs b/src/Discord.Net.Core/Entities/Users/IUser.cs index d260abf7..683f6e6f 100644 --- a/src/Discord.Net.Core/Entities/Users/IUser.cs +++ b/src/Discord.Net.Core/Entities/Users/IUser.cs @@ -16,7 +16,7 @@ namespace Discord /// /// /// This property retrieves a URL for this user's avatar. In event that the user does not have a valid avatar - /// (i.e. their avatar identifier is not set), this method will return null. If you wish to + /// (i.e. their avatar identifier is not set), this method will return . If you wish to /// retrieve the default avatar for this user, consider using (see /// example). /// @@ -31,7 +31,7 @@ namespace Discord /// The size of the image to return in. This can be any power of two between 16 and 2048. /// /// - /// A string representing the user's avatar URL; null if the user does not have an avatar in place. + /// A string representing the user's avatar URL; if the user does not have an avatar in place. /// string GetAvatarUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128); /// @@ -62,14 +62,14 @@ namespace Discord /// (indicated by the blue BOT tag within the official chat client). /// /// - /// true if the user is a bot application; otherwise false. + /// if the user is a bot application; otherwise . /// bool IsBot { get; } /// /// Gets a value that indicates whether this user is a webhook user. /// /// - /// true if the user is a webhook; otherwise false. + /// if the user is a webhook; otherwise . /// bool IsWebhook { get; } /// diff --git a/src/Discord.Net.Core/Entities/Users/IVoiceState.cs b/src/Discord.Net.Core/Entities/Users/IVoiceState.cs index f346fc91..3a1e3207 100644 --- a/src/Discord.Net.Core/Entities/Users/IVoiceState.cs +++ b/src/Discord.Net.Core/Entities/Users/IVoiceState.cs @@ -11,8 +11,8 @@ namespace Discord /// 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. + /// if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild; + /// otherwise . /// bool IsDeafened { get; } /// @@ -20,14 +20,14 @@ namespace Discord /// guild. /// /// - /// true if this user is muted by the guild; otherwise false. + /// if this user is muted by the guild; otherwise . /// bool IsMuted { get; } /// /// 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. + /// if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise . /// bool IsSelfDeafened { get; } /// @@ -35,21 +35,21 @@ namespace Discord /// speak via voice). /// /// - /// true if this user has muted themselves; otherwise false. + /// if this user has muted themselves; otherwise . /// bool IsSelfMuted { get; } /// /// 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. + /// if the guild is temporarily blocking audio to/from this user; otherwise . /// bool IsSuppressed { get; } /// /// 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 + /// A generic voice channel object representing the voice channel that the user is currently in; /// if none. /// IVoiceChannel VoiceChannel { get; } @@ -61,14 +61,14 @@ namespace Discord /// Gets a value that indicates if this user is streaming in a voice channel. /// /// - /// true if the user is streaming; otherwise false. + /// if the user is streaming; otherwise . /// bool IsStreaming { get; } /// /// Gets a value that indicates if the user is videoing in a voice channel. /// /// - /// true if the user has their camera turned on; otherwise false. + /// if the user has their camera turned on; otherwise . /// bool IsVideoing { get; } /// diff --git a/src/Discord.Net.Core/Extensions/MessageExtensions.cs b/src/Discord.Net.Core/Extensions/MessageExtensions.cs index cf330c44..128c78cd 100644 --- a/src/Discord.Net.Core/Extensions/MessageExtensions.cs +++ b/src/Discord.Net.Core/Extensions/MessageExtensions.cs @@ -84,7 +84,7 @@ namespace Discord /// A array of s to send with this response. Max 10. /// /// Specifies if notifications are sent for mentioned users and roles in the message . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The options to be used when sending the request. /// The message components to be included with this message. Used for interactions. diff --git a/src/Discord.Net.Core/Extensions/UserExtensions.cs b/src/Discord.Net.Core/Extensions/UserExtensions.cs index f28c4790..ca081eac 100644 --- a/src/Discord.Net.Core/Extensions/UserExtensions.cs +++ b/src/Discord.Net.Core/Extensions/UserExtensions.cs @@ -31,7 +31,7 @@ namespace Discord /// The options to be used when sending the request. /// /// Specifies if notifications are sent for mentioned users and roles in the message . - /// If null, all mentioned roles and users will be notified. + /// If , all mentioned roles and users will be notified. /// /// The message components to be included with this message. Used for interactions. /// A array of s to send with this response. Max 10. diff --git a/src/Discord.Net.Core/IDiscordClient.cs b/src/Discord.Net.Core/IDiscordClient.cs index dd1da3ae..ddf8c32d 100644 --- a/src/Discord.Net.Core/IDiscordClient.cs +++ b/src/Discord.Net.Core/IDiscordClient.cs @@ -76,7 +76,7 @@ namespace Discord /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains the channel associated - /// with the snowflake identifier; null when the channel cannot be found. + /// with the snowflake identifier; when the channel cannot be found. /// Task GetChannelAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// @@ -192,7 +192,7 @@ namespace Discord /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains the guild associated - /// with the snowflake identifier; null when the guild cannot be found. + /// with the snowflake identifier; when the guild cannot be found. /// Task GetGuildAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// @@ -248,7 +248,7 @@ namespace Discord /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains the user associated with - /// the snowflake identifier; null if the user is not found. + /// the snowflake identifier; if the user is not found. /// Task GetUserAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// @@ -266,7 +266,7 @@ namespace Discord /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains the user associated with - /// the name and the discriminator; null if the user is not found. + /// the name and the discriminator; if the user is not found. /// Task GetUserAsync(string username, string discriminator, RequestOptions options = null); @@ -293,7 +293,7 @@ namespace Discord /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains the voice region - /// associated with the identifier; null if the voice region is not found. + /// associated with the identifier; if the voice region is not found. /// Task GetVoiceRegionAsync(string id, RequestOptions options = null); @@ -304,7 +304,7 @@ namespace Discord /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains a webhook associated - /// with the identifier; null if the webhook is not found. + /// with the identifier; if the webhook is not found. /// Task GetWebhookAsync(ulong id, RequestOptions options = null); diff --git a/src/Discord.Net.Core/Logging/LogMessage.cs b/src/Discord.Net.Core/Logging/LogMessage.cs index 7f8e12d0..08afe79f 100644 --- a/src/Discord.Net.Core/Logging/LogMessage.cs +++ b/src/Discord.Net.Core/Logging/LogMessage.cs @@ -33,7 +33,7 @@ namespace Discord /// Gets the exception of this log entry. /// /// - /// An object associated with an incident; otherwise null. + /// An object associated with an incident; otherwise . /// public Exception Exception { get; } diff --git a/src/Discord.Net.Core/Net/HttpException.cs b/src/Discord.Net.Core/Net/HttpException.cs index b026bc6f..fc7cec1d 100644 --- a/src/Discord.Net.Core/Net/HttpException.cs +++ b/src/Discord.Net.Core/Net/HttpException.cs @@ -25,7 +25,7 @@ namespace Discord.Net /// /// A /// JSON error code - /// from Discord, or null if none. + /// from Discord, or if none. /// public DiscordErrorCode? DiscordCode { get; } /// diff --git a/src/Discord.Net.Core/RequestOptions.cs b/src/Discord.Net.Core/RequestOptions.cs index 7db5b943..489fe2e9 100644 --- a/src/Discord.Net.Core/RequestOptions.cs +++ b/src/Discord.Net.Core/RequestOptions.cs @@ -21,7 +21,7 @@ namespace Discord /// /// /// Gets or set the max time, in milliseconds, to wait for this request to complete. If - /// null, a request will not time out. If a rate limit has been triggered for this request's bucket + /// , a request will not time out. If a rate limit has been triggered for this request's bucket /// and will not be unpaused in time, this request will fail immediately. /// /// @@ -50,7 +50,7 @@ namespace Discord public string AuditLogReason { get; set; } /// /// Gets or sets whether or not this request should use the system - /// clock for rate-limiting. Defaults to true. + /// clock for rate-limiting. Defaults to . /// /// /// This property can also be set in . diff --git a/src/Discord.Net.Core/Utils/Cacheable.cs b/src/Discord.Net.Core/Utils/Cacheable.cs index 8e26ebd4..99a76282 100644 --- a/src/Discord.Net.Core/Utils/Cacheable.cs +++ b/src/Discord.Net.Core/Utils/Cacheable.cs @@ -25,7 +25,7 @@ namespace Discord /// /// /// This value is not guaranteed to be set; in cases where the entity cannot be pulled from cache, it is - /// null. + /// . /// public TEntity Value { get; } private Func> DownloadFunc { get; } @@ -81,7 +81,7 @@ namespace Discord /// /// /// This value is not guaranteed to be set; in cases where the entity cannot be pulled from cache, it is - /// null. + /// . /// public TCachedEntity Value { get; } private Func> DownloadFunc { get; } diff --git a/src/Discord.Net.Core/Utils/ConcurrentHashSet.cs b/src/Discord.Net.Core/Utils/ConcurrentHashSet.cs index b41d64ac..6041c288 100644 --- a/src/Discord.Net.Core/Utils/ConcurrentHashSet.cs +++ b/src/Discord.Net.Core/Utils/ConcurrentHashSet.cs @@ -157,7 +157,7 @@ namespace Discord : this(collection, EqualityComparer.Default) { } public ConcurrentHashSet(IEqualityComparer comparer) : this(DefaultConcurrencyLevel, DefaultCapacity, true, comparer) { } - /// is null + /// is public ConcurrentHashSet(IEnumerable collection, IEqualityComparer comparer) : this(comparer) { @@ -166,7 +166,7 @@ namespace Discord InitializeFromCollection(collection); } /// - /// or is null + /// or is /// public ConcurrentHashSet(int concurrencyLevel, IEnumerable collection, IEqualityComparer comparer) : this(concurrencyLevel, DefaultCapacity, false, comparer) @@ -217,7 +217,7 @@ namespace Discord if (_budget == 0) _budget = _tables._buckets.Length / _tables._locks.Length; } - /// is null + /// is public bool ContainsKey(T value) { if (value == null) @@ -242,7 +242,7 @@ namespace Discord return false; } - /// is null + /// is public bool TryAdd(T value) { if (value == null) @@ -294,7 +294,7 @@ namespace Discord } } - /// is null + /// is public bool TryRemove(T value) { if (value == null) diff --git a/src/Discord.Net.Core/Utils/TokenUtils.cs b/src/Discord.Net.Core/Utils/TokenUtils.cs index c3dd3923..55e40f0c 100644 --- a/src/Discord.Net.Core/Utils/TokenUtils.cs +++ b/src/Discord.Net.Core/Utils/TokenUtils.cs @@ -144,7 +144,7 @@ namespace Discord /// /// The type of token to validate. /// The token value to validate. - /// Thrown when the supplied token string is null, empty, or contains only whitespace. + /// Thrown when the supplied token string is , empty, or contains only whitespace. /// Thrown when the supplied or token value is invalid. public static void ValidateToken(TokenType tokenType, string token) { diff --git a/src/Discord.Net.Interactions/Attributes/PreconditionAttribute.cs b/src/Discord.Net.Interactions/Attributes/PreconditionAttribute.cs index 917538fb..706f648f 100644 --- a/src/Discord.Net.Interactions/Attributes/PreconditionAttribute.cs +++ b/src/Discord.Net.Interactions/Attributes/PreconditionAttribute.cs @@ -15,7 +15,7 @@ namespace Discord.Interactions /// /// /// of the same group require only one of the preconditions to pass in order to - /// be successful (A || B). Specifying = null or not at all will + /// be successful (A || B). Specifying = 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.Interactions/InteractionService.cs b/src/Discord.Net.Interactions/InteractionService.cs index b957bc2d..fd02887b 100644 --- a/src/Discord.Net.Interactions/InteractionService.cs +++ b/src/Discord.Net.Interactions/InteractionService.cs @@ -250,7 +250,7 @@ namespace Discord.Interactions /// Create and loads a using a builder factory. /// /// Name of the module. - /// The for your dependency injection solution if using one; otherwise, pass null. + /// The for your dependency injection solution if using one; otherwise, pass . /// Module builder factory. /// /// A task representing the operation for adding modules. The task result contains the built module instance. @@ -280,7 +280,7 @@ namespace Discord.Interactions /// Discover and load command modules from an . /// /// the command modules are defined in. - /// The for your dependency injection solution if using one; otherwise, pass null. + /// The for your dependency injection solution if using one; otherwise, pass . /// /// A task representing the operation for adding modules. The task result contains a collection of the modules added. /// @@ -312,7 +312,7 @@ namespace Discord.Interactions /// Add a command module from a . /// /// Type of the module. - /// The for your dependency injection solution if using one; otherwise, pass null . + /// The for your dependency injection solution if using one; otherwise, pass . /// /// A task representing the operation for adding the module. The task result contains the built module. /// @@ -329,7 +329,7 @@ namespace Discord.Interactions /// Add a command module from a . /// /// Type of the module. - /// The for your dependency injection solution if using one; otherwise, pass null . + /// The for your dependency injection solution if using one; otherwise, pass . /// /// A task representing the operation for adding the module. The task result contains the built module. /// diff --git a/src/Discord.Net.Interactions/Results/AutocompletionResult.cs b/src/Discord.Net.Interactions/Results/AutocompletionResult.cs index 2dc9f93b..e5f65ce0 100644 --- a/src/Discord.Net.Interactions/Results/AutocompletionResult.cs +++ b/src/Discord.Net.Interactions/Results/AutocompletionResult.cs @@ -91,7 +91,7 @@ namespace Discord.Interactions /// Gets a string that indicates the autocompletion result. /// /// - /// Success if is true; otherwise ": + /// Success if is ; otherwise ": /// ". /// public override string ToString() => IsSuccess ? "Success" : $"{Error}: {ErrorReason}"; diff --git a/src/Discord.Net.Interactions/Results/RuntimeResult.cs b/src/Discord.Net.Interactions/Results/RuntimeResult.cs index 81083a67..cf2d456d 100644 --- a/src/Discord.Net.Interactions/Results/RuntimeResult.cs +++ b/src/Discord.Net.Interactions/Results/RuntimeResult.cs @@ -17,7 +17,7 @@ namespace Discord.Interactions /// /// Initializes a new class with the type of error and reason. /// - /// The type of failure, or null if none. + /// The type of failure, or if none. /// The reason of failure. protected RuntimeResult(InteractionCommandError? error, string reason) { @@ -29,7 +29,7 @@ namespace Discord.Interactions /// Gets a string that indicates the runtime result. /// /// - /// Success if is true; otherwise ": + /// Success if is ; otherwise ": /// ". /// public override string ToString() => ErrorReason ?? (IsSuccess ? "Successful" : "Unsuccessful"); diff --git a/src/Discord.Net.Rest/API/AuditLogs/GuildInfoAuditLogModel.cs b/src/Discord.Net.Rest/API/AuditLogs/GuildInfoAuditLogModel.cs index fd4a85fb..1ecc30c0 100644 --- a/src/Discord.Net.Rest/API/AuditLogs/GuildInfoAuditLogModel.cs +++ b/src/Discord.Net.Rest/API/AuditLogs/GuildInfoAuditLogModel.cs @@ -2,7 +2,7 @@ using Discord.Rest; namespace Discord.API.AuditLogs; -public class GuildInfoAuditLogModel : IAuditLogInfoModel +internal class GuildInfoAuditLogModel : IAuditLogInfoModel { [JsonField("name")] public string Name { get; set; } diff --git a/src/Discord.Net.Rest/API/Common/ForumReactionEmoji.cs b/src/Discord.Net.Rest/API/Common/ForumReactionEmoji.cs index ae2d2b54..12615cbf 100644 --- a/src/Discord.Net.Rest/API/Common/ForumReactionEmoji.cs +++ b/src/Discord.Net.Rest/API/Common/ForumReactionEmoji.cs @@ -2,7 +2,7 @@ using Newtonsoft.Json; namespace Discord.API; -public class ForumReactionEmoji +internal class ForumReactionEmoji { [JsonProperty("emoji_id")] public ulong? EmojiId { get; set; } diff --git a/src/Discord.Net.Rest/API/Common/InviteVanity.cs b/src/Discord.Net.Rest/API/Common/InviteVanity.cs index 412795aa..2ae97169 100644 --- a/src/Discord.Net.Rest/API/Common/InviteVanity.cs +++ b/src/Discord.Net.Rest/API/Common/InviteVanity.cs @@ -5,7 +5,7 @@ namespace Discord.API /// /// Represents a vanity invite. /// - public class InviteVanity + internal class InviteVanity { /// /// The unique code for the invite link. diff --git a/src/Discord.Net.Rest/API/Common/MessageActivity.cs b/src/Discord.Net.Rest/API/Common/MessageActivity.cs index 701f6fc0..bbe0d52c 100644 --- a/src/Discord.Net.Rest/API/Common/MessageActivity.cs +++ b/src/Discord.Net.Rest/API/Common/MessageActivity.cs @@ -7,7 +7,7 @@ using System.Threading.Tasks; namespace Discord.API { - public class MessageActivity + internal class MessageActivity { [JsonProperty("type")] public Optional Type { get; set; } diff --git a/src/Discord.Net.Rest/API/Common/MessageApplication.cs b/src/Discord.Net.Rest/API/Common/MessageApplication.cs index 7302185a..ee596308 100644 --- a/src/Discord.Net.Rest/API/Common/MessageApplication.cs +++ b/src/Discord.Net.Rest/API/Common/MessageApplication.cs @@ -7,7 +7,7 @@ using System.Threading.Tasks; namespace Discord.API { - public class MessageApplication + internal class MessageApplication { /// /// Gets the snowflake ID of the application. diff --git a/src/Discord.Net.Rest/API/Common/RoleConnection.cs b/src/Discord.Net.Rest/API/Common/RoleConnection.cs index f8c26a6b..4ee5a141 100644 --- a/src/Discord.Net.Rest/API/Common/RoleConnection.cs +++ b/src/Discord.Net.Rest/API/Common/RoleConnection.cs @@ -3,7 +3,7 @@ using System.Collections.Generic; namespace Discord.API; -public class RoleConnection +internal class RoleConnection { [JsonProperty("platform_name")] public Optional PlatformName { get; set; } diff --git a/src/Discord.Net.Rest/API/Common/RoleConnectionMetadata.cs b/src/Discord.Net.Rest/API/Common/RoleConnectionMetadata.cs index 9ce36a05..7171bd85 100644 --- a/src/Discord.Net.Rest/API/Common/RoleConnectionMetadata.cs +++ b/src/Discord.Net.Rest/API/Common/RoleConnectionMetadata.cs @@ -3,7 +3,7 @@ using System.Collections.Generic; namespace Discord.API; -public class RoleConnectionMetadata +internal class RoleConnectionMetadata { [JsonProperty("type")] public RoleConnectionMetadataType Type { get; set; } diff --git a/src/Discord.Net.Rest/API/Rest/CreateGuildChannelParams.cs b/src/Discord.Net.Rest/API/Rest/CreateGuildChannelParams.cs index 4dc0066a..9035ad15 100644 --- a/src/Discord.Net.Rest/API/Rest/CreateGuildChannelParams.cs +++ b/src/Discord.Net.Rest/API/Rest/CreateGuildChannelParams.cs @@ -46,7 +46,7 @@ namespace Discord.API.Rest [JsonProperty("default_sort_order")] public Optional DefaultSortOrder { get; set; } - [JsonProperty("default_forum_layout ")] + [JsonProperty("default_forum_layout")] public Optional DefaultLayout { get; set; } public CreateGuildChannelParams(string name, ChannelType type) diff --git a/src/Discord.Net.Rest/API/Rest/ModifyForumReactionEmojiParams.cs b/src/Discord.Net.Rest/API/Rest/ModifyForumReactionEmojiParams.cs index d659f70c..c8540fd8 100644 --- a/src/Discord.Net.Rest/API/Rest/ModifyForumReactionEmojiParams.cs +++ b/src/Discord.Net.Rest/API/Rest/ModifyForumReactionEmojiParams.cs @@ -3,7 +3,7 @@ using Newtonsoft.Json; namespace Discord.API; [JsonObject(MemberSerialization = MemberSerialization.OptIn)] -public class ModifyForumReactionEmojiParams +internal class ModifyForumReactionEmojiParams { [JsonProperty("emoji_id")] public Optional EmojiId { get; set; } diff --git a/src/Discord.Net.Rest/DiscordRestApiClient.cs b/src/Discord.Net.Rest/DiscordRestApiClient.cs index 375beb35..bb6760f7 100644 --- a/src/Discord.Net.Rest/DiscordRestApiClient.cs +++ b/src/Discord.Net.Rest/DiscordRestApiClient.cs @@ -1471,7 +1471,8 @@ namespace Discord.API { if ((!args.Embeds.IsSpecified || args.Embeds.Value == null || args.Embeds.Value.Length == 0) && (!args.Content.IsSpecified || args.Content.Value is null || string.IsNullOrWhiteSpace(args.Content.Value)) - && (!args.Components.IsSpecified || args.Components.Value is null || args.Components.Value.Length == 0)) + && (!args.Components.IsSpecified || args.Components.Value is null || args.Components.Value.Length == 0) + && (!args.File.IsSpecified)) { throw new ArgumentException("At least one of 'Content', 'Embeds', 'File' or 'Components' must be specified.", nameof(args)); } @@ -1494,7 +1495,8 @@ namespace Discord.API { if ((!args.Embeds.IsSpecified || args.Embeds.Value == null || args.Embeds.Value.Length == 0) && (!args.Content.IsSpecified || args.Content.Value is null || string.IsNullOrWhiteSpace(args.Content.Value)) - && (!args.MessageComponents.IsSpecified || args.MessageComponents.Value is null || args.MessageComponents.Value.Length == 0)) + && (!args.MessageComponents.IsSpecified || args.MessageComponents.Value is null || args.MessageComponents.Value.Length == 0) + && (args.Files.Length == 0)) { throw new ArgumentException("At least one of 'Content', 'Embeds', 'Files' or 'Components' must be specified.", nameof(args)); } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs index 6cd2d4ea..23e6e15b 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs @@ -92,7 +92,7 @@ public class ChannelCreateAuditLogData : IAuditLogData /// /// An representing the time in seconds required before the user can send another /// message; 0 if disabled. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? SlowModeInterval { get; } @@ -100,8 +100,8 @@ public class ChannelCreateAuditLogData : IAuditLogData /// Gets the value that indicates whether the created channel is NSFW. /// /// - /// true if the created channel has the NSFW flag enabled; otherwise false. - /// null if this is not mentioned in this entry. + /// if the created channel has the NSFW flag enabled; otherwise . + /// if this is not mentioned in this entry. /// public bool? IsNsfw { get; } @@ -111,7 +111,7 @@ public class ChannelCreateAuditLogData : IAuditLogData /// /// An representing the bit-rate (bps) that the created voice channel defines and requests the /// client(s) to use. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? Bitrate { get; } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs index 5ba1da50..c8e21900 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs @@ -93,15 +93,15 @@ public class ChannelDeleteAuditLogData : IAuditLogData /// /// An representing the time in seconds required before the user can send another /// message; 0 if disabled. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? SlowModeInterval { get; } /// /// Gets the value that indicates whether the deleted channel was NSFW. /// /// - /// true if this channel had the NSFW flag enabled; otherwise false. - /// null if this is not mentioned in this entry. + /// if this channel had the NSFW flag enabled; otherwise . + /// if this is not mentioned in this entry. /// public bool? IsNsfw { get; } /// @@ -109,7 +109,7 @@ public class ChannelDeleteAuditLogData : IAuditLogData /// /// /// An representing the bit-rate set of the voice channel. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? Bitrate { get; } /// diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelInfo.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelInfo.cs index dce7534f..76fcef78 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelInfo.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelInfo.cs @@ -67,15 +67,15 @@ namespace Discord.Rest /// /// An representing the time in seconds required before the user can send another /// message; 0 if disabled. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? SlowModeInterval { get; } /// /// Gets the value that indicates whether this channel is NSFW. /// /// - /// true if this channel has the NSFW flag enabled; otherwise false. - /// null if this is not mentioned in this entry. + /// if this channel has the NSFW flag enabled; otherwise . + /// if this is not mentioned in this entry. /// public bool? IsNsfw { get; } /// @@ -83,14 +83,14 @@ namespace Discord.Rest /// /// /// An representing the bit-rate set for the voice channel; - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? Bitrate { get; } /// /// Gets the type of this channel. /// /// - /// The channel type of this channel; null if not applicable. + /// The channel type of this channel; if not applicable. /// public ChannelType? ChannelType { get; } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildInfo.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildInfo.cs index 099da3ef..31a4526a 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildInfo.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildInfo.cs @@ -123,7 +123,7 @@ public struct GuildInfo /// /// An representing the amount of time in seconds for a user to be marked as inactive /// and moved into the AFK voice channel. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? AfkTimeout { get; } /// @@ -131,14 +131,14 @@ public struct GuildInfo /// /// /// The default message notifications setting of this guild. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public DefaultMessageNotifications? DefaultMessageNotifications { get; } /// /// Gets the ID of the AFK voice channel for this guild. /// /// - /// A representing the snowflake identifier of the AFK voice channel; null if + /// A representing the snowflake identifier of the AFK voice channel; if /// none is set. /// public ulong? AfkChannelId { get; } @@ -157,7 +157,7 @@ public struct GuildInfo /// Gets the ID of this guild's icon. /// /// - /// A string containing the identifier for the splash image; null if none is set. + /// A string containing the identifier for the splash image; if none is set. /// public string IconHash { get; } /// @@ -165,7 +165,7 @@ public struct GuildInfo /// /// /// The level of requirements. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public VerificationLevel? VerificationLevel { get; } /// @@ -181,7 +181,7 @@ public struct GuildInfo /// /// /// The level of MFA requirement. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public MfaLevel? MfaLevel { get; } /// @@ -196,7 +196,7 @@ public struct GuildInfo /// /// /// A representing the snowflake identifier of the channel where system - /// messages are sent; null if none is set. + /// messages are sent; if none is set. /// public ulong? SystemChannelId { get; } /// @@ -204,15 +204,15 @@ public struct GuildInfo /// /// /// A representing the snowflake identifier of the embedded channel found within the - /// widget settings of this guild; null if none is set. + /// widget settings of this guild; if none is set. /// public ulong? EmbedChannelId { get; } /// /// Gets a value that indicates whether this guild is embeddable (i.e. can use widget). /// /// - /// true if this guild can be embedded via widgets; otherwise false. - /// null if this is not mentioned in this entry. + /// if this guild can be embedded via widgets; otherwise . + /// if this is not mentioned in this entry. /// public bool? IsEmbeddable { get; } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteCreateAuditLogData.cs index bce9e916..c58457d3 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteCreateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteCreateAuditLogData.cs @@ -59,8 +59,8 @@ public class InviteCreateAuditLogData : IAuditLogData /// Gets a value that determines whether the invite is a temporary one. /// /// - /// true if users accepting this invite will be removed from the guild when they log off; otherwise - /// false. + /// if users accepting this invite will be removed from the guild when they log off; otherwise + /// . /// public bool Temporary { get; } @@ -96,7 +96,7 @@ public class InviteCreateAuditLogData : IAuditLogData /// /// /// An representing the number of uses this invite may be accepted until it is removed - /// from the guild; null if none is set. + /// from the guild; if none is set. /// public int MaxUses { get; } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteDeleteAuditLogData.cs index 9698bdab..c34bbd2a 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteDeleteAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteDeleteAuditLogData.cs @@ -59,8 +59,8 @@ public class InviteDeleteAuditLogData : IAuditLogData /// Gets a value that indicates whether the invite is a temporary one. /// /// - /// true if users accepting this invite will be removed from the guild when they log off; otherwise - /// false. + /// if users accepting this invite will be removed from the guild when they log off; otherwise + /// . /// public bool Temporary { get; } @@ -96,7 +96,7 @@ public class InviteDeleteAuditLogData : IAuditLogData /// /// /// An representing the number of uses this invite may be accepted until it is removed - /// from the guild; null if none is set. + /// from the guild; if none is set. /// public int MaxUses { get; } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteInfo.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteInfo.cs index 1a3a7c56..87dadb38 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteInfo.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteInfo.cs @@ -21,7 +21,7 @@ public struct InviteInfo /// Gets the time (in seconds) until the invite expires. /// /// - /// An representing the time in seconds until this invite expires; null if this + /// An representing the time in seconds until this invite expires; if this /// invite never expires or not specified. /// public int? MaxAge { get; } @@ -38,8 +38,8 @@ public struct InviteInfo /// Gets a value that indicates whether the invite is a temporary one. /// /// - /// true if users accepting this invite will be removed from the guild when they log off, - /// false if not; null if not specified. + /// if users accepting this invite will be removed from the guild when they log off, + /// if not; if not specified. /// public bool? Temporary { get; } @@ -48,7 +48,7 @@ public struct InviteInfo /// /// /// A representing the channel snowflake identifier that the invite points to; - /// null if not specified. + /// if not specified. /// public ulong? ChannelId { get; } @@ -57,7 +57,7 @@ public struct InviteInfo /// /// /// An representing the number of uses this invite may be accepted until it is removed - /// from the guild; null if none is specified. + /// from the guild; if none is specified. /// public int? MaxUses { get; } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleEditInfo.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleEditInfo.cs index dd178d38..5fdca395 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleEditInfo.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleEditInfo.cs @@ -32,7 +32,7 @@ public struct MemberRoleEditInfo /// Gets a value that indicates whether the role was added to the user. /// /// - /// true if the role was added to the user; otherwise false. + /// if the role was added to the user; otherwise . /// public bool Added { get; } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleEditInfo.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleEditInfo.cs index 7d4ad3c1..f765a9e7 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleEditInfo.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleEditInfo.cs @@ -30,7 +30,7 @@ public struct RoleEditInfo /// Gets the color of this role. /// /// - /// A color object representing the color assigned to this role; null if this role does not have a + /// A color object representing the color assigned to this role; if this role does not have a /// color. /// public Color? Color { get; } @@ -39,8 +39,8 @@ public struct RoleEditInfo /// Gets a value that indicates whether this role is mentionable. /// /// - /// true if other members can mention this role in a text channel; otherwise false; - /// null if this is not mentioned in this entry. + /// if other members can mention this role in a text channel; otherwise ; + /// if this is not mentioned in this entry. /// public bool? Mentionable { get; } @@ -49,8 +49,8 @@ public struct RoleEditInfo /// section on the user list). /// /// - /// true if this role's members will appear in a separate section in the user list; otherwise - /// false; null if this is not mentioned in this entry. + /// if this role's members will appear in a separate section in the user list; otherwise + /// ; if this is not mentioned in this entry. /// public bool? Hoist { get; } @@ -66,7 +66,7 @@ public struct RoleEditInfo /// Gets the permissions assigned to this role. /// /// - /// A guild permissions object representing the permissions that have been assigned to this role; null + /// A guild permissions object representing the permissions that have been assigned to this role; /// if no permissions have been assigned. /// public GuildPermissions? Permissions { get; } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ThreadCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ThreadCreateAuditLogData.cs index 5969b457..48952b4d 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ThreadCreateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ThreadCreateAuditLogData.cs @@ -43,7 +43,7 @@ public class ThreadCreateAuditLogData : IAuditLogData /// Gets the thread that was created if it still exists. /// /// - /// A thread object representing the thread that was created if it still exists, otherwise returns null. + /// A thread object representing the thread that was created if it still exists, otherwise returns . /// public IThreadChannel Thread { get; } @@ -75,7 +75,7 @@ public class ThreadCreateAuditLogData : IAuditLogData /// Gets the value that indicates whether the thread is archived. /// /// - /// true if this thread has the Archived flag enabled; otherwise false. + /// if this thread has the Archived flag enabled; otherwise . /// public bool IsArchived { get; } @@ -91,7 +91,7 @@ public class ThreadCreateAuditLogData : IAuditLogData /// Gets the value that indicates whether the thread is locked. /// /// - /// true if this thread has the Locked flag enabled; otherwise false. + /// if this thread has the Locked flag enabled; otherwise . /// public bool IsLocked { get; } @@ -101,7 +101,7 @@ public class ThreadCreateAuditLogData : IAuditLogData /// /// An representing the time in seconds required before the user can send another /// message; 0 if disabled. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? SlowModeInterval { get; } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ThreadDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ThreadDeleteAuditLogData.cs index abf1fea1..f7a46b96 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ThreadDeleteAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ThreadDeleteAuditLogData.cs @@ -63,7 +63,7 @@ public class ThreadDeleteAuditLogData : IAuditLogData /// Gets the value that indicates whether the deleted thread was archived. /// /// - /// true if this thread had the Archived flag enabled; otherwise false. + /// if this thread had the Archived flag enabled; otherwise . /// public bool IsArchived { get; } @@ -79,7 +79,7 @@ public class ThreadDeleteAuditLogData : IAuditLogData /// Gets the value that indicates whether the deleted thread was locked. /// /// - /// true if this thread had the Locked flag enabled; otherwise false. + /// if this thread had the Locked flag enabled; otherwise . /// public bool IsLocked { get; } @@ -89,7 +89,7 @@ public class ThreadDeleteAuditLogData : IAuditLogData /// /// An representing the time in seconds required before the user can send another /// message; 0 if disabled. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? SlowModeInterval { get; } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ThreadUpdateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ThreadUpdateAuditLogData.cs index b7343aad..d98ae072 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ThreadUpdateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ThreadUpdateAuditLogData.cs @@ -37,7 +37,7 @@ public class ThreadUpdateAuditLogData : IAuditLogData /// Gets the thread that was created if it still exists. /// /// - /// A thread object representing the thread that was created if it still exists, otherwise returns null. + /// A thread object representing the thread that was created if it still exists, otherwise returns . /// public IThreadChannel Thread { get; } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookCreateAuditLogData.cs index 6b91f243..5698744e 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookCreateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookCreateAuditLogData.cs @@ -39,7 +39,7 @@ public class WebhookCreateAuditLogData : IAuditLogData /// Gets the webhook that was created if it still exists. /// /// - /// A webhook object representing the webhook that was created if it still exists, otherwise returns null. + /// A webhook object representing the webhook that was created if it still exists, otherwise returns . /// public IWebhook Webhook { get; } diff --git a/src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs b/src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs index 1cf2bdc5..751fbfc0 100644 --- a/src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs +++ b/src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs @@ -329,7 +329,7 @@ namespace Discord.Rest /// invalid characters as defined by . /// /// - /// is null. + /// is . /// /// /// 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/IRestMessageChannel.cs b/src/Discord.Net.Rest/Entities/Channels/IRestMessageChannel.cs index 256fc350..2f80546a 100644 --- a/src/Discord.Net.Rest/Entities/Channels/IRestMessageChannel.cs +++ b/src/Discord.Net.Rest/Entities/Channels/IRestMessageChannel.cs @@ -35,7 +35,7 @@ namespace Discord.Rest /// The options to be used when sending the request. /// /// A task that represents an asynchronous get operation for retrieving the message. The task result contains - /// the retrieved message; null if no message is found with the specified identifier. + /// the retrieved message; if no message is found with the specified identifier. /// Task GetMessageAsync(ulong id, RequestOptions options = null); /// diff --git a/src/Discord.Net.Rest/Entities/Channels/RestDMChannel.cs b/src/Discord.Net.Rest/Entities/Channels/RestDMChannel.cs index 59c502f1..71a6b100 100644 --- a/src/Discord.Net.Rest/Entities/Channels/RestDMChannel.cs +++ b/src/Discord.Net.Rest/Entities/Channels/RestDMChannel.cs @@ -64,7 +64,7 @@ namespace Discord.Rest /// /// The snowflake identifier of the user. /// - /// A object that is a recipient of this channel; otherwise null. + /// A object that is a recipient of this channel; otherwise . /// public RestUser GetUser(ulong id) { @@ -107,7 +107,7 @@ namespace Discord.Rest /// invalid characters as defined by . /// /// - /// is null. + /// is . /// /// /// 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 38e20e8f..2ae3a017 100644 --- a/src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs +++ b/src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs @@ -117,7 +117,7 @@ namespace Discord.Rest /// invalid characters as defined by . /// /// - /// is null. + /// is . /// /// /// 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/RestGuildChannel.cs b/src/Discord.Net.Rest/Entities/Channels/RestGuildChannel.cs index a6c9c367..30b05847 100644 --- a/src/Discord.Net.Rest/Entities/Channels/RestGuildChannel.cs +++ b/src/Discord.Net.Rest/Entities/Channels/RestGuildChannel.cs @@ -90,7 +90,7 @@ namespace Discord.Rest /// /// The user to get the overwrite from. /// - /// An overwrite object for the targeted user; null if none is set. + /// An overwrite object for the targeted user; if none is set. /// public virtual OverwritePermissions? GetPermissionOverwrite(IUser user) { @@ -107,7 +107,7 @@ namespace Discord.Rest /// /// The role to get the overwrite from. /// - /// An overwrite object for the targeted role; null if none is set. + /// An overwrite object for the targeted role; if none is set. /// public virtual OverwritePermissions? GetPermissionOverwrite(IRole role) { diff --git a/src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs b/src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs index 798d15ef..bca7cbea 100644 --- a/src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs +++ b/src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs @@ -76,7 +76,7 @@ namespace Discord.Rest /// /// /// A task representing the asynchronous get operation. The task result contains a guild user object that - /// represents the user; null if none is found. + /// represents the user; if none is found. /// public Task GetUserAsync(ulong id, RequestOptions options = null) => ChannelHelper.GetUserAsync(this, Guild, Discord, id, options); @@ -127,7 +127,7 @@ namespace Discord.Rest /// invalid characters as defined by . /// /// - /// is null. + /// is . /// /// /// The specified path, file name, or both exceed the system-defined maximum length. For example, on @@ -227,7 +227,7 @@ namespace Discord.Rest /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains a webhook associated - /// with the identifier; null if the webhook is not found. + /// with the identifier; if the webhook is not found. /// public virtual Task GetWebhookAsync(ulong id, RequestOptions options = null) => ChannelHelper.GetWebhookAsync(this, Discord, id, options); @@ -280,7 +280,7 @@ namespace Discord.Rest /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains the category channel - /// representing the parent of this channel; null if none is set. + /// representing the parent of this channel; if none is set. /// public virtual Task GetCategoryAsync(RequestOptions options = null) => ChannelHelper.GetCategoryAsync(this, Discord, options); diff --git a/src/Discord.Net.Rest/Entities/Guilds/GuildHelper.cs b/src/Discord.Net.Rest/Entities/Guilds/GuildHelper.cs index 2f68e650..0314e5e6 100644 --- a/src/Discord.Net.Rest/Entities/Guilds/GuildHelper.cs +++ b/src/Discord.Net.Rest/Entities/Guilds/GuildHelper.cs @@ -16,7 +16,7 @@ namespace Discord.Rest internal static class GuildHelper { #region General - /// is null. + /// is . public static async Task ModifyAsync(IGuild guild, BaseDiscordClient client, Action func, RequestOptions options) { @@ -90,7 +90,7 @@ namespace Discord.Rest return await client.ApiClient.ModifyGuildAsync(guild.Id, apiArgs, options).ConfigureAwait(false); } - /// is null. + /// is . public static async Task ModifyWidgetAsync(IGuild guild, BaseDiscordClient client, Action func, RequestOptions options) { @@ -230,7 +230,7 @@ namespace Discord.Rest var models = await client.ApiClient.GetGuildChannelsAsync(guild.Id, options).ConfigureAwait(false); return models.Select(x => RestGuildChannel.Create(client, guild, x)).ToImmutableArray(); } - /// is null. + /// is . public static async Task CreateTextChannelAsync(IGuild guild, BaseDiscordClient client, string name, RequestOptions options, Action func = null) { @@ -261,7 +261,7 @@ namespace Discord.Rest var model = await client.ApiClient.CreateGuildChannelAsync(guild.Id, args, options).ConfigureAwait(false); return RestTextChannel.Create(client, guild, model); } - /// is null. + /// is . public static async Task CreateVoiceChannelAsync(IGuild guild, BaseDiscordClient client, string name, RequestOptions options, Action func = null) { @@ -320,7 +320,7 @@ namespace Discord.Rest var model = await client.ApiClient.CreateGuildChannelAsync(guild.Id, args, options).ConfigureAwait(false); return RestStageChannel.Create(client, guild, model); } - /// is null. + /// is . public static async Task CreateCategoryChannelAsync(IGuild guild, BaseDiscordClient client, string name, RequestOptions options, Action func = null) { @@ -348,7 +348,7 @@ namespace Discord.Rest return RestCategoryChannel.Create(client, guild, model); } - /// is null. + /// is . public static async Task CreateForumChannelAsync(IGuild guild, BaseDiscordClient client, string name, RequestOptions options, Action func = null) { @@ -466,7 +466,7 @@ namespace Discord.Rest #endregion #region Roles - /// is null. + /// is . public static async Task CreateRoleAsync(IGuild guild, BaseDiscordClient client, string name, GuildPermissions? permissions, Color? color, bool isHoisted, bool isMentionable, RequestOptions options) { @@ -685,7 +685,7 @@ namespace Discord.Rest var emote = await client.ApiClient.CreateGuildEmoteAsync(guild.Id, apiargs, options).ConfigureAwait(false); return emote.ToEntity(); } - /// is null. + /// is . public static async Task ModifyEmoteAsync(IGuild guild, BaseDiscordClient client, ulong id, Action func, RequestOptions options) { diff --git a/src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs b/src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs index a6c2d2d9..a2bd23e2 100644 --- a/src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs +++ b/src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs @@ -873,7 +873,7 @@ namespace Discord.Rest /// This method removes all users that have not logged on in the provided number of . /// /// - /// If is true, this method will only return the number of users that + /// If is , this method will only return the number of users that /// would be removed without kicking the users. /// /// diff --git a/src/Discord.Net.WebSocket/BaseSocketClient.cs b/src/Discord.Net.WebSocket/BaseSocketClient.cs index 482a08a0..3cad7201 100644 --- a/src/Discord.Net.WebSocket/BaseSocketClient.cs +++ b/src/Discord.Net.WebSocket/BaseSocketClient.cs @@ -102,7 +102,7 @@ namespace Discord.WebSocket /// /// This method gets the user present in the WebSocket cache with the given condition. /// - /// Sometimes a user may return null due to Discord not sending offline users in large guilds + /// Sometimes a user may return due to Discord not sending offline users in large guilds /// (i.e. guild with 100+ members) actively. To download users on startup and to see more information /// about this subject, see . /// @@ -114,7 +114,7 @@ namespace Discord.WebSocket /// /// /// - /// A generic WebSocket-based user; null when the user cannot be found. + /// A generic WebSocket-based user; when the user cannot be found. /// public abstract SocketUser GetUser(ulong id); @@ -124,7 +124,7 @@ namespace Discord.WebSocket /// /// This method gets the user present in the WebSocket cache with the given condition. /// - /// Sometimes a user may return null due to Discord not sending offline users in large guilds + /// Sometimes a user may return due to Discord not sending offline users in large guilds /// (i.e. guild with 100+ members) actively. To download users on startup and to see more information /// about this subject, see . /// @@ -138,7 +138,7 @@ namespace Discord.WebSocket /// The name of the user. /// The discriminator value of the user. /// - /// A generic WebSocket-based user; null when the user cannot be found. + /// A generic WebSocket-based user; when the user cannot be found. /// public abstract SocketUser GetUser(string username, string discriminator); /// @@ -147,7 +147,7 @@ namespace Discord.WebSocket /// The snowflake identifier of the channel (e.g. `381889909113225237`). /// /// A generic WebSocket-based channel object (voice, text, category, etc.) associated with the identifier; - /// null when the channel cannot be found. + /// when the channel cannot be found. /// public abstract SocketChannel GetChannel(ulong id); /// @@ -155,7 +155,7 @@ namespace Discord.WebSocket /// /// The guild snowflake identifier. /// - /// A WebSocket-based guild associated with the snowflake identifier; null when the guild cannot be + /// A WebSocket-based guild associated with the snowflake identifier; when the guild cannot be /// found. /// public abstract SocketGuild GetGuild(ulong id); @@ -173,7 +173,7 @@ namespace Discord.WebSocket /// The identifier of the voice region (e.g. eu-central ). /// The options to be used when sending the request. /// - /// A task that contains a REST-based voice region associated with the identifier; null if the + /// A task that contains a REST-based voice region associated with the identifier; if the /// voice region is not found. /// public abstract ValueTask GetVoiceRegionAsync(string id, RequestOptions options = null); diff --git a/src/Discord.Net.WebSocket/DiscordSocketClient.cs b/src/Discord.Net.WebSocket/DiscordSocketClient.cs index 2b8a72f7..1f881c0b 100644 --- a/src/Discord.Net.WebSocket/DiscordSocketClient.cs +++ b/src/Discord.Net.WebSocket/DiscordSocketClient.cs @@ -390,7 +390,7 @@ namespace Discord.WebSocket /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains the channel associated - /// with the snowflake identifier; null when the channel cannot be found. + /// with the snowflake identifier; when the channel cannot be found. /// public async ValueTask GetChannelAsync(ulong id, RequestOptions options = null) => GetChannel(id) ?? (IChannel)await ClientHelper.GetChannelAsync(this, id, options).ConfigureAwait(false); @@ -408,7 +408,7 @@ namespace Discord.WebSocket /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains the user associated with - /// the snowflake identifier; null if the user is not found. + /// the snowflake identifier; if the user is not found. /// public async ValueTask GetUserAsync(ulong id, RequestOptions options = null) => await ((IDiscordClient)this).GetUserAsync(id, CacheMode.AllowDownload, options).ConfigureAwait(false); diff --git a/src/Discord.Net.WebSocket/DiscordSocketConfig.cs b/src/Discord.Net.WebSocket/DiscordSocketConfig.cs index 5917fc97..21f21a28 100644 --- a/src/Discord.Net.WebSocket/DiscordSocketConfig.cs +++ b/src/Discord.Net.WebSocket/DiscordSocketConfig.cs @@ -31,7 +31,7 @@ namespace Discord.WebSocket public const string GatewayEncoding = "json"; /// - /// Gets or sets the WebSocket host to connect to. If null, the client will use the + /// Gets or sets the WebSocket host to connect to. If , the client will use the /// /gateway endpoint. /// public string GatewayHost { get; set; } = null; @@ -136,7 +136,7 @@ namespace Discord.WebSocket /// /// Gets or sets the timeout for event handlers, in milliseconds, after which a warning will be logged. - /// Setting this property to nulldisables this check. + /// Setting this property to disables this check. /// public int? HandlerTimeout { get; set; } = 3000; diff --git a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketChannelCreateAuditLogData.cs b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketChannelCreateAuditLogData.cs index 801ce617..f5c86bbd 100644 --- a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketChannelCreateAuditLogData.cs +++ b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketChannelCreateAuditLogData.cs @@ -90,7 +90,7 @@ public class SocketChannelCreateAuditLogData : ISocketAuditLogData /// /// An representing the time in seconds required before the user can send another /// message; 0 if disabled. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? SlowModeInterval { get; } @@ -98,8 +98,8 @@ public class SocketChannelCreateAuditLogData : ISocketAuditLogData /// Gets the value that indicates whether the created channel is NSFW. /// /// - /// true if the created channel has the NSFW flag enabled; otherwise false. - /// null if this is not mentioned in this entry. + /// if the created channel has the NSFW flag enabled; otherwise . + /// if this is not mentioned in this entry. /// public bool? IsNsfw { get; } @@ -109,7 +109,7 @@ public class SocketChannelCreateAuditLogData : ISocketAuditLogData /// /// An representing the bit-rate (bps) that the created voice channel defines and requests the /// client(s) to use. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? Bitrate { get; } diff --git a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketChannelDeleteAuditLogData.cs b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketChannelDeleteAuditLogData.cs index 8f9fb80a..48e46125 100644 --- a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketChannelDeleteAuditLogData.cs +++ b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketChannelDeleteAuditLogData.cs @@ -96,7 +96,7 @@ public class SocketChannelDeleteAuditLogData : ISocketAuditLogData /// /// An representing the time in seconds required before the user can send another /// message; 0 if disabled. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? SlowModeInterval { get; } @@ -104,8 +104,8 @@ public class SocketChannelDeleteAuditLogData : ISocketAuditLogData /// Gets the value that indicates whether the deleted channel was NSFW. /// /// - /// true if this channel had the NSFW flag enabled; otherwise false. - /// null if this is not mentioned in this entry. + /// if this channel had the NSFW flag enabled; otherwise . + /// if this is not mentioned in this entry. /// public bool? IsNsfw { get; } @@ -114,7 +114,7 @@ public class SocketChannelDeleteAuditLogData : ISocketAuditLogData /// /// /// An representing the bit-rate set of the voice channel. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? Bitrate { get; } diff --git a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketChannelInfo.cs b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketChannelInfo.cs index aa620c0d..669c448a 100644 --- a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketChannelInfo.cs +++ b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketChannelInfo.cs @@ -81,7 +81,7 @@ public struct SocketChannelInfo /// Gets the type of this channel. /// /// - /// The channel type of this channel; null if not applicable. + /// The channel type of this channel; if not applicable. /// public ChannelType? ChannelType { get; } diff --git a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketInviteCreateAuditLogData.cs b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketInviteCreateAuditLogData.cs index 7c648222..a66db3e1 100644 --- a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketInviteCreateAuditLogData.cs +++ b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketInviteCreateAuditLogData.cs @@ -67,8 +67,8 @@ public class SocketInviteCreateAuditLogData : ISocketAuditLogData /// Gets a value that determines whether the invite is a temporary one. /// /// - /// true if users accepting this invite will be removed from the guild when they log off; otherwise - /// false. + /// if users accepting this invite will be removed from the guild when they log off; otherwise + /// . /// public bool Temporary { get; } @@ -104,7 +104,7 @@ public class SocketInviteCreateAuditLogData : ISocketAuditLogData /// /// /// An representing the number of uses this invite may be accepted until it is removed - /// from the guild; null if none is set. + /// from the guild; if none is set. /// public int MaxUses { get; } } diff --git a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketInviteDeleteAuditLogData.cs b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketInviteDeleteAuditLogData.cs index 15df061c..1f260aae 100644 --- a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketInviteDeleteAuditLogData.cs +++ b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketInviteDeleteAuditLogData.cs @@ -66,8 +66,8 @@ public class SocketInviteDeleteAuditLogData : ISocketAuditLogData /// Gets a value that indicates whether the invite is a temporary one. /// /// - /// true if users accepting this invite will be removed from the guild when they log off; otherwise - /// false. + /// if users accepting this invite will be removed from the guild when they log off; otherwise + /// . /// public bool Temporary { get; } @@ -103,7 +103,7 @@ public class SocketInviteDeleteAuditLogData : ISocketAuditLogData /// /// /// An representing the number of uses this invite may be accepted until it is removed - /// from the guild; null if none is set. + /// from the guild; if none is set. /// public int MaxUses { get; } } diff --git a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketInviteInfo.cs b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketInviteInfo.cs index bfb51912..82570d58 100644 --- a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketInviteInfo.cs +++ b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketInviteInfo.cs @@ -21,7 +21,7 @@ public struct SocketInviteInfo /// Gets the time (in seconds) until the invite expires. /// /// - /// An representing the time in seconds until this invite expires; null if this + /// An representing the time in seconds until this invite expires; if this /// invite never expires or not specified. /// public int? MaxAge { get; } @@ -38,8 +38,8 @@ public struct SocketInviteInfo /// Gets a value that indicates whether the invite is a temporary one. /// /// - /// true if users accepting this invite will be removed from the guild when they log off, - /// false if not; null if not specified. + /// if users accepting this invite will be removed from the guild when they log off, + /// if not; if not specified. /// public bool? Temporary { get; } @@ -48,7 +48,7 @@ public struct SocketInviteInfo /// /// /// A representing the channel snowflake identifier that the invite points to; - /// null if not specified. + /// if not specified. /// public ulong? ChannelId { get; } @@ -57,7 +57,7 @@ public struct SocketInviteInfo /// /// /// An representing the number of uses this invite may be accepted until it is removed - /// from the guild; null if none is specified. + /// from the guild; if none is specified. /// public int? MaxUses { get; } diff --git a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketMemberRoleEditInfo.cs b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketMemberRoleEditInfo.cs index 66ff970c..127b6da7 100644 --- a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketMemberRoleEditInfo.cs +++ b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketMemberRoleEditInfo.cs @@ -30,7 +30,7 @@ public struct SocketMemberRoleEditInfo /// Gets a value that indicates whether the role was added to the user. /// /// - /// true if the role was added to the user; otherwise false. + /// if the role was added to the user; otherwise . /// public bool Added { get; } } diff --git a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketRoleEditInfo.cs b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketRoleEditInfo.cs index 1bb99337..fbf6ba33 100644 --- a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketRoleEditInfo.cs +++ b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketRoleEditInfo.cs @@ -30,7 +30,7 @@ public struct SocketRoleEditInfo /// Gets the color of this role. /// /// - /// A color object representing the color assigned to this role; null if this role does not have a + /// A color object representing the color assigned to this role; if this role does not have a /// color. /// public Color? Color { get; } @@ -39,8 +39,8 @@ public struct SocketRoleEditInfo /// Gets a value that indicates whether this role is mentionable. /// /// - /// true if other members can mention this role in a text channel; otherwise false; - /// null if this is not mentioned in this entry. + /// if other members can mention this role in a text channel; otherwise ; + /// if this is not mentioned in this entry. /// public bool? Mentionable { get; } @@ -49,8 +49,8 @@ public struct SocketRoleEditInfo /// section on the user list). /// /// - /// true if this role's members will appear in a separate section in the user list; otherwise - /// false; null if this is not mentioned in this entry. + /// if this role's members will appear in a separate section in the user list; otherwise + /// ; if this is not mentioned in this entry. /// public bool? Hoist { get; } @@ -66,7 +66,7 @@ public struct SocketRoleEditInfo /// Gets the permissions assigned to this role. /// /// - /// A guild permissions object representing the permissions that have been assigned to this role; null + /// A guild permissions object representing the permissions that have been assigned to this role; /// if no permissions have been assigned. /// public GuildPermissions? Permissions { get; } diff --git a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketThreadCreateAuditLogData.cs b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketThreadCreateAuditLogData.cs index 3ecff7cf..d55a7a5f 100644 --- a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketThreadCreateAuditLogData.cs +++ b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketThreadCreateAuditLogData.cs @@ -61,7 +61,7 @@ public class SocketThreadCreateAuditLogData : ISocketAuditLogData /// Gets the value that indicates whether the thread is archived. /// /// - /// true if this thread has the Archived flag enabled; otherwise false. + /// if this thread has the Archived flag enabled; otherwise . /// public bool IsArchived { get; } @@ -77,7 +77,7 @@ public class SocketThreadCreateAuditLogData : ISocketAuditLogData /// Gets the value that indicates whether the thread is locked. /// /// - /// true if this thread has the Locked flag enabled; otherwise false. + /// if this thread has the Locked flag enabled; otherwise . /// public bool IsLocked { get; } @@ -87,7 +87,7 @@ public class SocketThreadCreateAuditLogData : ISocketAuditLogData /// /// An representing the time in seconds required before the user can send another /// message; 0 if disabled. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? SlowModeInterval { get; } diff --git a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketThreadDeleteAuditLogData.cs b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketThreadDeleteAuditLogData.cs index e6520beb..12bd3749 100644 --- a/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketThreadDeleteAuditLogData.cs +++ b/src/Discord.Net.WebSocket/Entities/AuditLogs/DataTypes/SocketThreadDeleteAuditLogData.cs @@ -63,7 +63,7 @@ public class SocketThreadDeleteAuditLogData : ISocketAuditLogData /// Gets the value that indicates whether the deleted thread was archived. /// /// - /// true if this thread had the Archived flag enabled; otherwise false. + /// if this thread had the Archived flag enabled; otherwise . /// public bool IsArchived { get; } @@ -79,7 +79,7 @@ public class SocketThreadDeleteAuditLogData : ISocketAuditLogData /// Gets the value that indicates whether the deleted thread was locked. /// /// - /// true if this thread had the Locked flag enabled; otherwise false. + /// if this thread had the Locked flag enabled; otherwise . /// public bool IsLocked { get; } @@ -89,7 +89,7 @@ public class SocketThreadDeleteAuditLogData : ISocketAuditLogData /// /// An representing the time in seconds required before the user can send another /// message; 0 if disabled. - /// null if this is not mentioned in this entry. + /// if this is not mentioned in this entry. /// public int? SlowModeInterval { get; } diff --git a/src/Discord.Net.WebSocket/Entities/Channels/ISocketMessageChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/ISocketMessageChannel.cs index 3e5f5664..5fbd98a9 100644 --- a/src/Discord.Net.WebSocket/Entities/Channels/ISocketMessageChannel.cs +++ b/src/Discord.Net.WebSocket/Entities/Channels/ISocketMessageChannel.cs @@ -54,7 +54,7 @@ namespace Discord.WebSocket /// /// /// This method requires the use of cache, which is not enabled by default; if caching is not enabled, - /// this method will always return null. Please refer to + /// this method will always return . Please refer to /// for more details. /// /// @@ -64,7 +64,7 @@ namespace Discord.WebSocket /// /// The snowflake identifier of the message. /// - /// A WebSocket-based message object; null if it does not exist in the cache or if caching is not + /// A WebSocket-based message object; if it does not exist in the cache or if caching is not /// enabled. /// SocketMessage GetCachedMessage(ulong id); diff --git a/src/Discord.Net.WebSocket/Entities/Channels/SocketDMChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/SocketDMChannel.cs index e2031fef..b86865bf 100644 --- a/src/Discord.Net.WebSocket/Entities/Channels/SocketDMChannel.cs +++ b/src/Discord.Net.WebSocket/Entities/Channels/SocketDMChannel.cs @@ -71,7 +71,7 @@ namespace Discord.WebSocket /// TThe ID of the message. /// The options to be used when sending the request. /// - /// The message gotten from either the cache or the download, or null if none is found. + /// The message gotten from either the cache or the download, or if none is found. /// public async Task GetMessageAsync(ulong id, RequestOptions options = null) { @@ -215,7 +215,7 @@ namespace Discord.WebSocket /// /// The snowflake identifier of the user. /// - /// A object that is a recipient of this channel; otherwise null. + /// A object that is a recipient of this channel; otherwise . /// public new SocketUser GetUser(ulong id) { diff --git a/src/Discord.Net.WebSocket/Entities/Channels/SocketForumChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/SocketForumChannel.cs index 73b817cb..ef696bd2 100644 --- a/src/Discord.Net.WebSocket/Entities/Channels/SocketForumChannel.cs +++ b/src/Discord.Net.WebSocket/Entities/Channels/SocketForumChannel.cs @@ -52,7 +52,7 @@ namespace Discord.WebSocket /// Gets the parent (category) of this channel in the guild's channel list. /// /// - /// An representing the parent of this channel; null if none is set. + /// An representing the parent of this channel; if none is set. /// public ICategoryChannel Category => CategoryId.HasValue ? Guild.GetChannel(CategoryId.Value) as ICategoryChannel : null; diff --git a/src/Discord.Net.WebSocket/Entities/Channels/SocketGroupChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/SocketGroupChannel.cs index 7502a4e2..cc918fe9 100644 --- a/src/Discord.Net.WebSocket/Entities/Channels/SocketGroupChannel.cs +++ b/src/Discord.Net.WebSocket/Entities/Channels/SocketGroupChannel.cs @@ -107,7 +107,7 @@ namespace Discord.WebSocket /// The options to be used when sending the request. /// /// A task that represents an asynchronous get operation for retrieving the message. The task result contains - /// the retrieved message; null if no message is found with the specified identifier. + /// the retrieved message; if no message is found with the specified identifier. /// public async Task GetMessageAsync(ulong id, RequestOptions options = null) { diff --git a/src/Discord.Net.WebSocket/Entities/Channels/SocketGuildChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/SocketGuildChannel.cs index ee1f0c95..bb4e4613 100644 --- a/src/Discord.Net.WebSocket/Entities/Channels/SocketGuildChannel.cs +++ b/src/Discord.Net.WebSocket/Entities/Channels/SocketGuildChannel.cs @@ -93,7 +93,7 @@ namespace Discord.WebSocket /// /// The user to get the overwrite from. /// - /// An overwrite object for the targeted user; null if none is set. + /// An overwrite object for the targeted user; if none is set. /// public virtual OverwritePermissions? GetPermissionOverwrite(IUser user) { @@ -109,7 +109,7 @@ namespace Discord.WebSocket /// /// The role to get the overwrite from. /// - /// An overwrite object for the targeted role; null if none is set. + /// An overwrite object for the targeted role; if none is set. /// public virtual OverwritePermissions? GetPermissionOverwrite(IRole role) { diff --git a/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs index 5545048c..d2c50a16 100644 --- a/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs +++ b/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs @@ -31,7 +31,7 @@ namespace Discord.WebSocket /// Gets the parent (category) of this channel in the guild's channel list. /// /// - /// An representing the parent of this channel; null if none is set. + /// An representing the parent of this channel; if none is set. /// public ICategoryChannel Category => CategoryId.HasValue ? Guild.GetChannel(CategoryId.Value) as ICategoryChannel : null; @@ -151,7 +151,7 @@ namespace Discord.WebSocket /// The options to be used when sending the request. /// /// A task that represents an asynchronous get operation for retrieving the message. The task result contains - /// the retrieved message; null if no message is found with the specified identifier. + /// the retrieved message; if no message is found with the specified identifier. /// public virtual async Task GetMessageAsync(ulong id, RequestOptions options = null) { @@ -332,7 +332,7 @@ namespace Discord.WebSocket /// The options to be used when sending the request. /// /// A task that represents the asynchronous get operation. The task result contains a webhook associated - /// with the identifier; null if the webhook is not found. + /// with the identifier; if the webhook is not found. /// public virtual Task GetWebhookAsync(ulong id, RequestOptions options = null) => ChannelHelper.GetWebhookAsync(this, Discord, id, options); diff --git a/src/Discord.Net.WebSocket/Entities/Roles/SocketRole.cs b/src/Discord.Net.WebSocket/Entities/Roles/SocketRole.cs index b6a61cfb..a399f2c1 100644 --- a/src/Discord.Net.WebSocket/Entities/Roles/SocketRole.cs +++ b/src/Discord.Net.WebSocket/Entities/Roles/SocketRole.cs @@ -50,7 +50,7 @@ namespace Discord.WebSocket /// Returns a value that determines if the role is an @everyone role. /// /// - /// true if the role is @everyone; otherwise false. + /// if the role is @everyone; otherwise . /// public bool IsEveryone => Id == Guild.Id; /// diff --git a/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs b/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs index c9b16c75..7ad46575 100644 --- a/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs +++ b/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs @@ -82,7 +82,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 null if none. + /// Returns the voice channel the user is in, or if none. /// public SocketVoiceChannel VoiceChannel => VoiceState?.VoiceChannel; /// @@ -91,7 +91,7 @@ namespace Discord.WebSocket /// Gets the voice connection status of the user if any. /// /// - /// A representing the user's voice status; null if the user is not + /// A representing the user's voice status; if the user is not /// connected to a voice channel. /// public SocketVoiceState? VoiceState => Guild.GetVoiceState(Id); diff --git a/src/Discord.Net.WebSocket/Entities/Users/SocketVoiceState.cs b/src/Discord.Net.WebSocket/Entities/Users/SocketVoiceState.cs index d3818760..242112a9 100644 --- a/src/Discord.Net.WebSocket/Entities/Users/SocketVoiceState.cs +++ b/src/Discord.Net.WebSocket/Entities/Users/SocketVoiceState.cs @@ -11,7 +11,7 @@ namespace Discord.WebSocket public struct SocketVoiceState : IVoiceState { /// - /// Initializes a default with everything set to null or false. + /// Initializes a default with everything set to or . /// public static readonly SocketVoiceState Default = new SocketVoiceState(null, null, null, false, false, false, false, false, false, false); @@ -31,7 +31,7 @@ namespace Discord.WebSocket private readonly Flags _voiceStates; /// - /// Gets the voice channel that the user is currently in; or null if none. + /// Gets the voice channel that the user is currently in; or if none. /// public SocketVoiceChannel VoiceChannel { get; } ///