From ac47d84ea74c81e136434dcc33967fe4cd95c1e6 Mon Sep 17 00:00:00 2001 From: Still Hsu <341464@gmail.com> Date: Sun, 6 May 2018 15:22:17 +0800 Subject: [PATCH] Replace langword null to code block null instead - Because DocFX sucks at rendering langword --- .../Entities/Activities/GameAsset.cs | 2 +- .../Entities/Channels/IGuildChannel.cs | 10 ++--- .../Entities/Channels/IMessageChannel.cs | 4 +- .../Entities/Channels/ITextChannel.cs | 4 +- .../Entities/Channels/IVoiceChannel.cs | 2 +- .../Channels/VoiceChannelProperties.cs | 2 +- .../Entities/Guilds/GuildEmbedProperties.cs | 4 +- .../Entities/Guilds/IGuild.cs | 38 +++++++++---------- .../Entities/Guilds/IUserGuild.cs | 2 +- .../Entities/Invites/IInviteMetadata.cs | 4 +- .../Entities/Messages/EmbedBuilder.cs | 2 +- .../Entities/Messages/EmbedVideo.cs | 4 +- .../Entities/Messages/IAttachment.cs | 4 +- .../Entities/Messages/IMessage.cs | 2 +- .../Entities/Users/IVoiceState.cs | 2 +- src/Discord.Net.Core/Net/HttpException.cs | 2 +- src/Discord.Net.Core/RequestOptions.cs | 2 +- src/Discord.Net.Core/Utils/Cacheable.cs | 2 +- .../Utils/ConcurrentHashSet.cs | 8 ++-- .../Entities/Channels/IRestMessageChannel.cs | 4 +- .../Entities/Guilds/GuildHelper.cs | 14 +++---- .../Entities/Guilds/RestGuild.cs | 4 +- src/Discord.Net.WebSocket/BaseSocketClient.cs | 12 +++--- .../DiscordSocketConfig.cs | 2 +- .../Channels/ISocketMessageChannel.cs | 2 +- .../Entities/Channels/SocketGuildChannel.cs | 2 +- .../Entities/Channels/SocketTextChannel.cs | 2 +- .../Entities/Guilds/SocketGuild.cs | 10 ++--- .../Entities/Users/SocketVoiceState.cs | 2 +- 29 files changed, 77 insertions(+), 77 deletions(-) diff --git a/src/Discord.Net.Core/Entities/Activities/GameAsset.cs b/src/Discord.Net.Core/Entities/Activities/GameAsset.cs index b0c8ea975..467b2885f 100644 --- a/src/Discord.Net.Core/Entities/Activities/GameAsset.cs +++ b/src/Discord.Net.Core/Entities/Activities/GameAsset.cs @@ -19,7 +19,7 @@ namespace Discord public string ImageId { get; internal set; } /// - /// Returns the image URL of the asset, or when the application ID does not exist. + /// Returns the image URL of the asset, or null 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/Channels/IGuildChannel.cs b/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs index fdbe77653..5028bd388 100644 --- a/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs @@ -24,7 +24,7 @@ namespace Discord /// Gets the parent ID (category) of this channel in the guild's channel list. /// /// - /// The parent category ID associated with this channel, or if none is set. + /// The parent category ID associated with this channel, or null if none is set. /// ulong? CategoryId { get; } /// @@ -57,10 +57,10 @@ namespace Discord /// Creates a new invite to this channel. /// /// - /// The time (in seconds) until the invite expires. Set to to never expire. + /// 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 to have unlimited uses. + /// The max amount of times this invite may be used. Set to null to have unlimited uses. /// /// /// If , a user accepting this invite will be kicked from the guild after closing their client. @@ -86,12 +86,12 @@ namespace Discord Task ModifyAsync(Action func, RequestOptions options = null); /// - /// Gets the permission overwrite for a specific role, or if one does not exist. + /// Gets the permission overwrite for a specific role, or null if one does not exist. /// /// The role to get the overwrite from. OverwritePermissions? GetPermissionOverwrite(IRole role); /// - /// Gets the permission overwrite for a specific user, or if one does not exist. + /// Gets the permission overwrite for a specific user, or null if one does not exist. /// /// The user to get the overwrite from. OverwritePermissions? GetPermissionOverwrite(IUser user); diff --git a/src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs b/src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs index 7abecf54d..837e90604 100644 --- a/src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs @@ -60,13 +60,13 @@ namespace Discord Task SendFileAsync(Stream stream, string filename, string text = null, bool isTTS = false, Embed embed = null, RequestOptions options = null); /// - /// Gets a message from this message channel with the given id, or if not found. + /// Gets a message from this message channel with the given id, or null if not found. /// /// The ID of the message. /// The that determines whether the object should be fetched from cache. /// The options to be used when sending the request. /// - /// The message gotten from either the cache or the download, or if none is found. + /// The message gotten from either the cache or the download, or null if none is found. /// Task GetMessageAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); diff --git a/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs b/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs index 099822fb0..ac4bd2f9d 100644 --- a/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs @@ -22,7 +22,7 @@ namespace Discord /// Gets the current topic for this text channel. /// /// - /// The topic set in the channel, or if none is set. + /// The topic set in the channel, or null if none is set. /// string Topic { get; } @@ -72,7 +72,7 @@ namespace Discord /// The ID of the webhook. /// The options to be used when sending the request. /// - /// A webhook associated with the , or if not found. + /// A webhook associated with the , or null if not found. /// Task GetWebhookAsync(ulong id, RequestOptions options = null); /// diff --git a/src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs b/src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs index f69e6e22e..e1efb1a86 100644 --- a/src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs @@ -14,7 +14,7 @@ namespace Discord int Bitrate { get; } /// /// Gets the max amount of users allowed to be connected to this channel at one time, or - /// if none is set. + /// null if none is set. /// int? UserLimit { get; } diff --git a/src/Discord.Net.Core/Entities/Channels/VoiceChannelProperties.cs b/src/Discord.Net.Core/Entities/Channels/VoiceChannelProperties.cs index c285560df..46e8f8550 100644 --- a/src/Discord.Net.Core/Entities/Channels/VoiceChannelProperties.cs +++ b/src/Discord.Net.Core/Entities/Channels/VoiceChannelProperties.cs @@ -10,7 +10,7 @@ namespace Discord /// public Optional Bitrate { get; set; } /// - /// Gets or sets the maximum number of users that can be present in a channel, or if none. + /// Gets or sets the maximum number of users that can be present in a channel, or null if none. /// public Optional UserLimit { get; set; } } diff --git a/src/Discord.Net.Core/Entities/Guilds/GuildEmbedProperties.cs b/src/Discord.Net.Core/Entities/Guilds/GuildEmbedProperties.cs index 68925b103..2977cd10c 100644 --- a/src/Discord.Net.Core/Entities/Guilds/GuildEmbedProperties.cs +++ b/src/Discord.Net.Core/Entities/Guilds/GuildEmbedProperties.cs @@ -10,11 +10,11 @@ namespace Discord /// public Optional Enabled { get; set; } /// - /// Sets the channel that the invite should place its users in, if not . + /// Sets the channel that the invite should place its users in, if not null. /// public Optional Channel { get; set; } /// - /// Sets the channel the invite should place its users in, if not . + /// Sets the channel the invite should place its users in, if not null. /// public Optional ChannelId { get; set; } } diff --git a/src/Discord.Net.Core/Entities/Guilds/IGuild.cs b/src/Discord.Net.Core/Entities/Guilds/IGuild.cs index 057b94788..fa4af045a 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IGuild.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IGuild.cs @@ -40,19 +40,19 @@ namespace Discord /// VerificationLevel VerificationLevel { get; } /// - /// Returns the ID of this guild's icon, or if none is set. + /// Returns the ID of this guild's icon, or null if none is set. /// string IconId { get; } /// - /// Returns the URL of this guild's icon, or if none is set. + /// Returns the URL of this guild's icon, or null if none is set. /// string IconUrl { get; } /// - /// Returns the ID of this guild's splash image, or if none is set. + /// Returns the ID of this guild's splash image, or null if none is set. /// string SplashId { get; } /// - /// Returns the URL of this guild's splash image, or if none is set. + /// Returns the URL of this guild's splash image, or null if none is set. /// string SplashUrl { get; } /// @@ -65,7 +65,7 @@ namespace Discord bool Available { get; } /// - /// Gets the ID of the AFK voice channel for this guild, or if none is set. + /// Gets the ID of the AFK voice channel for this guild, or null if none is set. /// ulong? AFKChannelId { get; } /// @@ -73,11 +73,11 @@ namespace Discord /// ulong DefaultChannelId { get; } /// - /// Gets the ID of the embed channel set in the widget settings of this guild, or if none is set. + /// Gets the ID of the embed channel set in the widget settings of this guild, or null if none is set. /// ulong? EmbedChannelId { get; } /// - /// Gets the ID of the channel where randomized welcome messages are sent, or if none is set. + /// Gets the ID of the channel where randomized welcome messages are sent, or null if none is set. /// ulong? SystemChannelId { get; } /// @@ -245,7 +245,7 @@ namespace Discord /// The options to be used when sending the request. /// /// An awaitable containing the generic channel with the specified ID, or - /// if none is found. + /// null if none is found. /// Task GetChannelAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// @@ -269,7 +269,7 @@ namespace Discord /// The options to be used when sending the request. /// /// An awaitable containing the text channel with the specified ID, or - /// if none is found. + /// null if none is found. /// Task GetTextChannelAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// @@ -304,7 +304,7 @@ namespace Discord /// The options to be used when sending the request. /// /// An awaitable containing the voice channel with the specified ID, or - /// if none is found. + /// null if none is found. /// Task GetVoiceChannelAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// @@ -316,7 +316,7 @@ namespace Discord /// The options to be used when sending the request. /// /// An awaitable containing the AFK voice channel set within this guild, or - /// if none is set. + /// null if none is set. /// Task GetAFKChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// @@ -340,7 +340,7 @@ namespace Discord /// The options to be used when sending the request. /// /// An awaitable containing the first viewable text channel in this guild, or - /// if none is found. + /// null if none is found. /// Task GetDefaultChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// @@ -352,7 +352,7 @@ namespace Discord /// The options to be used when sending the request. /// /// An awaitable containing the embed channel set within the server's widget settings, or - /// if none is set. + /// null if none is set. /// Task GetEmbedChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// @@ -392,7 +392,7 @@ namespace Discord Task> GetInvitesAsync(RequestOptions options = null); /// - /// Gets the role in this guild with the provided ID, or if not found. + /// Gets the role in this guild with the provided ID, or null if not found. /// /// The role ID. IRole GetRole(ulong id); @@ -424,13 +424,13 @@ namespace Discord /// Task> GetUsersAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// - /// Gets the user in this guild with the provided ID, or if not found. + /// Gets the user in this guild with the provided ID, or null if not found. /// /// The user ID. /// The that determines whether the object should be fetched from cache. /// The options to be used when sending the request. /// - /// An awaitable containing the guild user with the specified ID, otherwise . + /// An awaitable containing the guild user with the specified ID, otherwise null. /// Task GetUserAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); /// @@ -472,12 +472,12 @@ namespace Discord Task PruneUsersAsync(int days = 30, bool simulate = false, RequestOptions options = null); /// - /// Gets the webhook in this guild with the provided ID, or if not found. + /// Gets the webhook in this guild with the provided ID, or null if not found. /// /// The webhook ID. /// The options to be used when sending the request. /// - /// An awaitable containing the webhook with the specified ID, otherwise . + /// An awaitable containing the webhook with the specified ID, otherwise null. /// Task GetWebhookAsync(ulong id, RequestOptions options = null); /// @@ -495,7 +495,7 @@ namespace Discord /// The guild emote ID. /// The options to be used when sending the request. /// - /// An awaitable containing the emote found with the specified ID, or if not found. + /// An awaitable containing the emote found with the specified ID, or null if not found. /// Task GetEmoteAsync(ulong id, RequestOptions options = null); /// diff --git a/src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs b/src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs index 5da2ce5da..809ed7d66 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs @@ -7,7 +7,7 @@ namespace Discord /// string Name { get; } /// - /// Gets the icon URL associated with this guild, or if one is not set. + /// Gets the icon URL associated with this guild, or null if one is not set. /// string IconUrl { get; } /// diff --git a/src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs b/src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs index dcd3de997..4247c403b 100644 --- a/src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs +++ b/src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs @@ -19,11 +19,11 @@ namespace Discord /// bool IsTemporary { get; } /// - /// Gets the time (in seconds) until the invite expires, or if it never expires. + /// Gets the time (in seconds) until the invite expires, or null if it never expires. /// int? MaxAge { get; } /// - /// Gets the max amount of times this invite may be used, or if there is no limit. + /// Gets the max amount of times this invite may be used, or null if there is no limit. /// int? MaxUses { get; } /// diff --git a/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs b/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs index 087b30993..c54b2ffcf 100644 --- a/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs +++ b/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs @@ -106,7 +106,7 @@ namespace Discord /// Gets or sets the list of of an . /// An embed builder's fields collection is set to - /// . + /// null. /// Description length exceeds . /// /// The list of existing . diff --git a/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs b/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs index 4368f74a4..d02b2cdc3 100644 --- a/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs +++ b/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs @@ -13,11 +13,11 @@ namespace Discord /// public string Url { get; } /// - /// Gets the height of the video, or if none. + /// Gets the height of the video, or null if none. /// public int? Height { get; } /// - /// Gets the weight of the video, or if none. + /// Gets the weight of the video, or null if none. /// public int? Width { get; } diff --git a/src/Discord.Net.Core/Entities/Messages/IAttachment.cs b/src/Discord.Net.Core/Entities/Messages/IAttachment.cs index c61d8177c..5d4d32cfa 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 . + /// The height of this attachment if it is a picture; otherwise null. /// int? Height { get; } /// /// Gets the width of this attachment. /// /// - /// The width of this attachment if it is a picture; otherwise . + /// The width of this attachment if it is a picture; otherwise null. /// int? Width { get; } } diff --git a/src/Discord.Net.Core/Entities/Messages/IMessage.cs b/src/Discord.Net.Core/Entities/Messages/IMessage.cs index c8ed14f0c..b2eb65439 100644 --- a/src/Discord.Net.Core/Entities/Messages/IMessage.cs +++ b/src/Discord.Net.Core/Entities/Messages/IMessage.cs @@ -39,7 +39,7 @@ namespace Discord /// Gets the time of this message's last edit. /// /// - /// Time of when the message was last edited; when the message is never edited. + /// Time of when the message was last edited; null when the message is never edited. /// DateTimeOffset? EditedTimestamp { get; } diff --git a/src/Discord.Net.Core/Entities/Users/IVoiceState.cs b/src/Discord.Net.Core/Entities/Users/IVoiceState.cs index 725ef2870..c22f094b4 100644 --- a/src/Discord.Net.Core/Entities/Users/IVoiceState.cs +++ b/src/Discord.Net.Core/Entities/Users/IVoiceState.cs @@ -26,7 +26,7 @@ namespace Discord /// bool IsSuppressed { get; } /// - /// Gets the voice channel this user is currently in, or if none. + /// Gets the voice channel this user is currently in, or null if none. /// IVoiceChannel VoiceChannel { get; } /// diff --git a/src/Discord.Net.Core/Net/HttpException.cs b/src/Discord.Net.Core/Net/HttpException.cs index c49273451..aa440bf1c 100644 --- a/src/Discord.Net.Core/Net/HttpException.cs +++ b/src/Discord.Net.Core/Net/HttpException.cs @@ -23,7 +23,7 @@ namespace Discord.Net /// /// A /// JSON error code - /// from Discord, or if none. + /// from Discord, or null if none. /// public int? DiscordCode { get; } /// diff --git a/src/Discord.Net.Core/RequestOptions.cs b/src/Discord.Net.Core/RequestOptions.cs index 2318f3f98..c2d1f6549 100644 --- a/src/Discord.Net.Core/RequestOptions.cs +++ b/src/Discord.Net.Core/RequestOptions.cs @@ -14,7 +14,7 @@ namespace Discord /// /// Gets or set the max time, in milliseconds, to wait for this request to complete. If - /// , a request will not time out. If a rate limit has been triggered for this + /// null, 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. /// public int? Timeout { get; set; } diff --git a/src/Discord.Net.Core/Utils/Cacheable.cs b/src/Discord.Net.Core/Utils/Cacheable.cs index 15358dda0..02da682ae 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; } diff --git a/src/Discord.Net.Core/Utils/ConcurrentHashSet.cs b/src/Discord.Net.Core/Utils/ConcurrentHashSet.cs index 233d1b0b0..e8441d7bb 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 + /// is null public ConcurrentHashSet(IEnumerable collection, IEqualityComparer comparer) : this(comparer) { @@ -210,7 +210,7 @@ namespace Discord if (_budget == 0) _budget = _tables._buckets.Length / _tables._locks.Length; } - /// is + /// is null public bool ContainsKey(T value) { if (value == null) throw new ArgumentNullException(nameof(value)); @@ -234,7 +234,7 @@ namespace Discord return false; } - /// is + /// is null public bool TryAdd(T value) { if (value == null) throw new ArgumentNullException(nameof(value)); @@ -284,7 +284,7 @@ namespace Discord } } - /// is + /// is null public bool TryRemove(T value) { if (value == null) throw new ArgumentNullException(nameof(value)); diff --git a/src/Discord.Net.Rest/Entities/Channels/IRestMessageChannel.cs b/src/Discord.Net.Rest/Entities/Channels/IRestMessageChannel.cs index 37a5ef9cf..b0eed8b25 100644 --- a/src/Discord.Net.Rest/Entities/Channels/IRestMessageChannel.cs +++ b/src/Discord.Net.Rest/Entities/Channels/IRestMessageChannel.cs @@ -59,12 +59,12 @@ namespace Discord.Rest new Task SendFileAsync(Stream stream, string filename, string text = null, bool isTTS = false, Embed embed = null, RequestOptions options = null); /// - /// Gets a message from this message channel with the given id, or if not found. + /// Gets a message from this message channel with the given id, or null if not found. /// /// The ID of the message. /// The options to be used when sending the request. /// - /// The message gotten from either the cache or the download, or if none is found. + /// The message gotten from either the cache or the download, or null if none is found. /// Task GetMessageAsync(ulong id, RequestOptions options = null); /// diff --git a/src/Discord.Net.Rest/Entities/Guilds/GuildHelper.cs b/src/Discord.Net.Rest/Entities/Guilds/GuildHelper.cs index 6408ead2f..53cc20024 100644 --- a/src/Discord.Net.Rest/Entities/Guilds/GuildHelper.cs +++ b/src/Discord.Net.Rest/Entities/Guilds/GuildHelper.cs @@ -14,7 +14,7 @@ namespace Discord.Rest internal static class GuildHelper { //General - /// is . + /// is null. public static async Task ModifyAsync(IGuild guild, BaseDiscordClient client, Action func, RequestOptions options) { @@ -62,7 +62,7 @@ namespace Discord.Rest return await client.ApiClient.ModifyGuildAsync(guild.Id, apiArgs, options).ConfigureAwait(false); } - /// is . + /// is null. public static async Task ModifyEmbedAsync(IGuild guild, BaseDiscordClient client, Action func, RequestOptions options) { @@ -140,7 +140,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 . + /// is null. public static async Task CreateTextChannelAsync(IGuild guild, BaseDiscordClient client, string name, RequestOptions options) { @@ -150,7 +150,7 @@ namespace Discord.Rest var model = await client.ApiClient.CreateGuildChannelAsync(guild.Id, args, options).ConfigureAwait(false); return RestTextChannel.Create(client, guild, model); } - /// is . + /// is null. public static async Task CreateVoiceChannelAsync(IGuild guild, BaseDiscordClient client, string name, RequestOptions options) { @@ -160,7 +160,7 @@ namespace Discord.Rest var model = await client.ApiClient.CreateGuildChannelAsync(guild.Id, args, options).ConfigureAwait(false); return RestVoiceChannel.Create(client, guild, model); } - /// is . + /// is null. public static async Task CreateCategoryChannelAsync(IGuild guild, BaseDiscordClient client, string name, RequestOptions options) { @@ -195,7 +195,7 @@ namespace Discord.Rest } //Roles - /// is . + /// is null. public static async Task CreateRoleAsync(IGuild guild, BaseDiscordClient client, string name, GuildPermissions? permissions, Color? color, bool isHoisted, RequestOptions options) { @@ -302,7 +302,7 @@ namespace Discord.Rest var emote = await client.ApiClient.CreateGuildEmoteAsync(guild.Id, apiargs, options).ConfigureAwait(false); return emote.ToEntity(); } - /// is . + /// is null. 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 5a79565ba..22ec20f03 100644 --- a/src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs +++ b/src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs @@ -132,7 +132,7 @@ namespace Discord.Rest => GuildHelper.DeleteAsync(this, Discord, options); /// - /// is . + /// is null. public async Task ModifyAsync(Action func, RequestOptions options = null) { var model = await GuildHelper.ModifyAsync(this, Discord, func, options).ConfigureAwait(false); @@ -140,7 +140,7 @@ namespace Discord.Rest } /// - /// is . + /// is null. public async Task ModifyEmbedAsync(Action func, RequestOptions options = null) { var model = await GuildHelper.ModifyEmbedAsync(this, Discord, func, options).ConfigureAwait(false); diff --git a/src/Discord.Net.WebSocket/BaseSocketClient.cs b/src/Discord.Net.WebSocket/BaseSocketClient.cs index b3702a811..69a557da9 100644 --- a/src/Discord.Net.WebSocket/BaseSocketClient.cs +++ b/src/Discord.Net.WebSocket/BaseSocketClient.cs @@ -66,7 +66,7 @@ namespace Discord.WebSocket /// /// This method gets the user present in the WebSocket cache with the given condition. /// - /// Sometimes a user may return due to Discord not sending offline users in large + /// Sometimes a user may return null due to Discord not sending offline users in large /// guilds (i.e. guild with 100+ members) actively. To download users on startup, consider enabling /// . /// @@ -76,7 +76,7 @@ namespace Discord.WebSocket /// /// /// - /// A WebSocket-based generic user; when the user cannot be found. + /// A WebSocket-based generic user; null when the user cannot be found. /// public abstract SocketUser GetUser(ulong id); @@ -88,7 +88,7 @@ namespace Discord.WebSocket /// /// This method gets the user present in the WebSocket cache with the given condition. /// - /// Sometimes a user may return due to Discord not sending offline users in large + /// Sometimes a user may return null due to Discord not sending offline users in large /// guilds (i.e. guild with 100+ members) actively. To download users on startup, consider enabling /// . /// @@ -98,7 +98,7 @@ namespace Discord.WebSocket /// /// /// - /// A WebSocket-based generic user; when the user cannot be found. + /// A WebSocket-based generic user; null when the user cannot be found. /// public abstract SocketUser GetUser(string username, string discriminator); /// @@ -115,7 +115,7 @@ namespace Discord.WebSocket /// /// The guild snowflake ID. /// - /// A WebSocket-based guild; when the guild cannot be found. + /// A WebSocket-based guild; null when the guild cannot be found. /// public abstract SocketGuild GetGuild(ulong id); /// @@ -123,7 +123,7 @@ namespace Discord.WebSocket /// /// The unique identifier of the voice region. /// - /// A REST-based voice region; if none can be found. + /// A REST-based voice region; null if none can be found. /// public abstract RestVoiceRegion GetVoiceRegion(string id); /// diff --git a/src/Discord.Net.WebSocket/DiscordSocketConfig.cs b/src/Discord.Net.WebSocket/DiscordSocketConfig.cs index 17f200c08..d85230fec 100644 --- a/src/Discord.Net.WebSocket/DiscordSocketConfig.cs +++ b/src/Discord.Net.WebSocket/DiscordSocketConfig.cs @@ -15,7 +15,7 @@ namespace Discord.WebSocket public const string GatewayEncoding = "json"; /// - /// Gets or sets the WebSocket host to connect to. If , the client will use the + /// Gets or sets the WebSocket host to connect to. If null, the client will use the /// /gateway endpoint. /// public string GatewayHost { get; set; } = null; diff --git a/src/Discord.Net.WebSocket/Entities/Channels/ISocketMessageChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/ISocketMessageChannel.cs index 59c382184..c37311a41 100644 --- a/src/Discord.Net.WebSocket/Entities/Channels/ISocketMessageChannel.cs +++ b/src/Discord.Net.WebSocket/Entities/Channels/ISocketMessageChannel.cs @@ -72,7 +72,7 @@ namespace Discord.WebSocket /// /// The ID of the message. /// - /// Cached message object; if it doesn't exist in the cache. + /// Cached message object; null if it doesn't exist in the cache. /// SocketMessage GetCachedMessage(ulong id); /// diff --git a/src/Discord.Net.WebSocket/Entities/Channels/SocketGuildChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/SocketGuildChannel.cs index ecbbbcd49..1151f0141 100644 --- a/src/Discord.Net.WebSocket/Entities/Channels/SocketGuildChannel.cs +++ b/src/Discord.Net.WebSocket/Entities/Channels/SocketGuildChannel.cs @@ -34,7 +34,7 @@ namespace Discord.WebSocket /// Gets the parent category of this channel. /// /// - /// A parent category ID associated with this channel, or if none is set. + /// A parent category ID associated with this channel, or null 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/SocketTextChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs index eed8f45b9..92bc07c60 100644 --- a/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs +++ b/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs @@ -152,7 +152,7 @@ namespace Discord.WebSocket /// The ID of the webhook. /// The options to be used when sending the request. /// - /// A webhook associated with the , or if not found. + /// A webhook associated with the , or null if not found. /// public Task GetWebhookAsync(ulong id, RequestOptions options = null) => ChannelHelper.GetWebhookAsync(this, Discord, id, options); diff --git a/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs b/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs index 029e600fc..8c930e79a 100644 --- a/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs +++ b/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs @@ -116,7 +116,7 @@ namespace Discord.WebSocket } } /// - /// Gets the embed channel set in the widget settings of this guild, or if none is set. + /// Gets the embed channel set in the widget settings of this guild, or null if none is set. /// public SocketGuildChannel EmbedChannel { @@ -127,7 +127,7 @@ namespace Discord.WebSocket } } /// - /// Gets the channel where randomized welcome messages are sent, or if none is set. + /// Gets the channel where randomized welcome messages are sent, or null if none is set. /// public SocketTextChannel SystemChannel { @@ -372,12 +372,12 @@ namespace Discord.WebSocket => GuildHelper.DeleteAsync(this, Discord, options); /// - /// is . + /// is null. public Task ModifyAsync(Action func, RequestOptions options = null) => GuildHelper.ModifyAsync(this, Discord, func, options); /// - /// is . + /// is null. public Task ModifyEmbedAsync(Action func, RequestOptions options = null) => GuildHelper.ModifyEmbedAsync(this, Discord, func, options); /// @@ -671,7 +671,7 @@ namespace Discord.WebSocket public Task CreateEmoteAsync(string name, Image image, Optional> roles = default(Optional>), RequestOptions options = null) => GuildHelper.CreateEmoteAsync(this, Discord, name, image, roles, options); /// - /// is . + /// is null. public Task ModifyEmoteAsync(GuildEmote emote, Action func, RequestOptions options = null) => GuildHelper.ModifyEmoteAsync(this, Discord, emote.Id, func, options); /// diff --git a/src/Discord.Net.WebSocket/Entities/Users/SocketVoiceState.cs b/src/Discord.Net.WebSocket/Entities/Users/SocketVoiceState.cs index 428405431..d5f0433ad 100644 --- a/src/Discord.Net.WebSocket/Entities/Users/SocketVoiceState.cs +++ b/src/Discord.Net.WebSocket/Entities/Users/SocketVoiceState.cs @@ -23,7 +23,7 @@ namespace Discord.WebSocket private readonly Flags _voiceStates; /// - /// Gets the voice channel that the user is currently in; or if none. + /// Gets the voice channel that the user is currently in; or null if none. /// public SocketVoiceChannel VoiceChannel { get; } ///