github/Discord.Net
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Refactor] Refactor some stuff (#2688)

Browse Source 
* fix some `internal` classes being exposed

* update xmldoc comments to use `<see langword>`

* bump library version in samples

* fix possible oversight
This commit is contained in:
Misha133
2023-06-27 17:11:16 +03:00
committed by GitHub
parent fe4130df45
commit 9ddd922d2f
119 changed files with 326 additions and 324 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/Discord.Net.Core/DiscordConfig.cs
View File

@@ -170,7 +170,7 @@ namespace Discord
/// Gets or sets whether the initial log entry should be printed.
/// </summary>
/// <remarks>
/// If set to <c>true</c>, the library will attempt to print the current version of the library, as well as
/// If set to <see langword="true" />, the library will attempt to print the current version of the library, as well as
/// the API version it uses on startup.
/// </remarks>
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.
/// </summary>
/// <remarks>
/// If set to <c>false</c>, we will use the X-RateLimit-Reset-After header
/// If set to <see langword="false" />, 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.
///

2
src/Discord.Net.Core/Entities/Activities/GameAsset.cs
View File

@@ -30,7 +30,7 @@ namespace Discord
/// <param name="size">The size of the image to return in. This can be any power of two between 16 and 2048.</param>
/// <param name="format">The format to return.</param>
/// <returns>
/// A string pointing to the image URL of the asset; <c>null</c> when the application ID does not exist.
/// A string pointing to the image URL of the asset; <see langword="null" /> when the application ID does not exist.
/// </returns>
public string GetImageUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128)
=> ApplicationId.HasValue ? CDN.GetRichAssetUrl(ApplicationId.Value, ImageId, size, format) : null;

4
src/Discord.Net.Core/Entities/AuditLogs/IAuditLogEntry.cs
View File

@@ -23,7 +23,7 @@ namespace Discord
/// Gets the data for this entry.
/// </summary>
/// <returns>
/// An <see cref="IAuditLogData" /> for this audit log entry; <c>null</c> if no data is available.
/// An <see cref="IAuditLogData" /> for this audit log entry; <see langword="null" /> if no data is available.
/// </returns>
IAuditLogData Data { get; }
@@ -39,7 +39,7 @@ namespace Discord
/// Gets the reason behind the change.
/// </summary>
/// <returns>
/// A string containing the reason for the change; <c>null</c> if none is provided.
/// A string containing the reason for the change; <see langword="null" /> if none is provided.
/// </returns>
string Reason { get; }
}

2
src/Discord.Net.Core/Entities/Channels/IChannel.cs
View File

@@ -46,7 +46,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task that represents the asynchronous get operation. The task result contains a user object that
/// represents the found user; <c>null</c> if none is found.
/// represents the found user; <see langword="null" /> if none is found.
/// </returns>
Task<IUser> GetUserAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);
}

14
src/Discord.Net.Core/Entities/Channels/IForumChannel.cs
View File

@@ -16,7 +16,7 @@ namespace Discord
/// Gets a value that indicates whether the channel is NSFW.
/// </summary>
/// <returns>
/// <c>true</c> if the channel has the NSFW flag enabled; otherwise <c>false</c>.
/// <see langword="true" /> if the channel has the NSFW flag enabled; otherwise <see langword="false" />.
/// </returns>
bool IsNsfw { get; }
@@ -24,7 +24,7 @@ namespace Discord
/// Gets the current topic for this text channel.
/// </summary>
/// <returns>
/// A string representing the topic set in the channel; <c>null</c> if none is set.
/// A string representing the topic set in the channel; <see langword="null" /> if none is set.
/// </returns>
string Topic { get; }
@@ -103,7 +103,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <param name="allowedMentions">
/// Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
/// If <c>null</c>, all mentioned roles and users will be notified.
/// If <see langword="null" />, all mentioned roles and users will be notified.
/// </param>
/// <param name="components">The message components to be included with this message. Used for interactions.</param>
/// <param name="stickers">A collection of stickers to send with the message.</param>
@@ -130,7 +130,7 @@ namespace Discord
/// <param name="isSpoiler">Whether the message attachment should be hidden as a spoiler.</param>
/// <param name="allowedMentions">
/// Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
/// If <c>null</c>, all mentioned roles and users will be notified.
/// If <see langword="null" />, all mentioned roles and users will be notified.
/// </param>
/// <param name="components">The message components to be included with this message. Used for interactions.</param>
/// <param name="stickers">A collection of stickers to send with the file.</param>
@@ -159,7 +159,7 @@ namespace Discord
/// <param name="isSpoiler">Whether the message attachment should be hidden as a spoiler.</param>
/// <param name="allowedMentions">
/// Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
/// If <c>null</c>, all mentioned roles and users will be notified.
/// If <see langword="null" />, all mentioned roles and users will be notified.
/// </param>
/// <param name="components">The message components to be included with this message. Used for interactions.</param>
/// <param name="stickers">A collection of stickers to send with the file.</param>
@@ -186,7 +186,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <param name="allowedMentions">
/// Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
/// If <c>null</c>, all mentioned roles and users will be notified.
/// If <see langword="null" />, all mentioned roles and users will be notified.
/// </param>
/// <param name="components">The message components to be included with this message. Used for interactions.</param>
/// <param name="stickers">A collection of stickers to send with the file.</param>
@@ -212,7 +212,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <param name="allowedMentions">
/// Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
/// If <c>null</c>, all mentioned roles and users will be notified.
/// If <see langword="null" />, all mentioned roles and users will be notified.
/// </param>
/// <param name="components">The message components to be included with this message. Used for interactions.</param>
/// <param name="stickers">A collection of stickers to send with the file.</param>

6
src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs
View File

@@ -74,7 +74,7 @@ namespace Discord
/// </summary>
/// <param name="role">The role to get the overwrite from.</param>
/// <returns>
/// An overwrite object for the targeted role; <c>null</c> if none is set.
/// An overwrite object for the targeted role; <see langword="null" /> if none is set.
/// </returns>
OverwritePermissions? GetPermissionOverwrite(IRole role);
/// <summary>
@@ -82,7 +82,7 @@ namespace Discord
/// </summary>
/// <param name="user">The user to get the overwrite from.</param>
/// <returns>
/// An overwrite object for the targeted user; <c>null</c> if none is set.
/// An overwrite object for the targeted user; <see langword="null" /> if none is set.
/// </returns>
OverwritePermissions? GetPermissionOverwrite(IUser user);
/// <summary>
@@ -163,7 +163,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task representing the asynchronous get operation. The task result contains a guild user object that
/// represents the user; <c>null</c> if none is found.
/// represents the user; <see langword="null" /> if none is found.
/// </returns>
new Task<IGuildUser> GetUserAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);
}

2
src/Discord.Net.Core/Entities/Channels/IIntegrationChannel.cs
View File

@@ -28,7 +28,7 @@ public interface IIntegrationChannel : IGuildChannel
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task that represents the asynchronous get operation. The task result contains a webhook associated
/// with the identifier; <c>null</c> if the webhook is not found.
/// with the identifier; <see langword="null" /> if the webhook is not found.
/// </returns>
Task<IWebhook> GetWebhookAsync(ulong id, RequestOptions options = null);

12
src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs
View File

@@ -25,7 +25,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <param name="allowedMentions">
/// Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
/// If <c>null</c>, all mentioned roles and users will be notified.
/// If <see langword="null" />, all mentioned roles and users will be notified.
/// </param>
/// <param name="messageReference">The message references to be included. Used to reply to specific messages.</param>
/// <param name="components">The message components to be included with this message. Used for interactions.</param>
@@ -67,7 +67,7 @@ namespace Discord
/// <param name="isSpoiler">Whether the message attachment should be hidden as a spoiler.</param>
/// <param name="allowedMentions">
/// Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
/// If <c>null</c>, all mentioned roles and users will be notified.
/// If <see langword="null" />, all mentioned roles and users will be notified.
/// </param>
/// <param name="messageReference">The message references to be included. Used to reply to specific messages.</param>
/// <param name="components">The message components to be included with this message. Used for interactions.</param>
@@ -105,7 +105,7 @@ namespace Discord
/// <param name="isSpoiler">Whether the message attachment should be hidden as a spoiler.</param>
/// <param name="allowedMentions">
/// Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
/// If <c>null</c>, all mentioned roles and users will be notified.
/// If <see langword="null" />, all mentioned roles and users will be notified.
/// </param>
/// <param name="messageReference">The message references to be included. Used to reply to specific messages.</param>
/// <param name="components">The message components to be included with this message. Used for interactions.</param>
@@ -135,7 +135,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <param name="allowedMentions">
/// Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
/// If <c>null</c>, all mentioned roles and users will be notified.
/// If <see langword="null" />, all mentioned roles and users will be notified.
/// </param>
/// <param name="messageReference">The message references to be included. Used to reply to specific messages.</param>
/// <param name="components">The message components to be included with this message. Used for interactions.</param>
@@ -165,7 +165,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <param name="allowedMentions">
/// Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
/// If <c>null</c>, all mentioned roles and users will be notified.
/// If <see langword="null" />, all mentioned roles and users will be notified.
/// </param>
/// <param name="messageReference">The message references to be included. Used to reply to specific messages.</param>
/// <param name="components">The message components to be included with this message. Used for interactions.</param>
@@ -186,7 +186,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task that represents an asynchronous get operation for retrieving the message. The task result contains
/// the retrieved message; <c>null</c> if no message is found with the specified identifier.
/// the retrieved message; <see langword="null" /> if no message is found with the specified identifier.
/// </returns>
Task<IMessage> GetMessageAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);

36
src/Discord.Net.Core/Entities/Channels/INestedChannel.cs
View File

@@ -13,7 +13,7 @@ namespace Discord
/// </summary>
/// <returns>
/// A <see cref="ulong"/> representing the snowflake identifier of the parent of this channel;
/// <c>null</c> if none is set.
/// <see langword="null" /> if none is set.
/// </returns>
ulong? CategoryId { get; }
/// <summary>
@@ -23,7 +23,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task that represents the asynchronous get operation. The task result contains the category channel
/// representing the parent of this channel; <c>null</c> if none is set.
/// representing the parent of this channel; <see langword="null" /> if none is set.
/// </returns>
Task<ICategoryChannel> GetCategoryAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);
@@ -46,10 +46,10 @@ namespace Discord
/// await guildChannel.CreateInviteAsync(maxAge: 43200, maxUses: 3);
/// </code>
/// </example>
/// <param name="maxAge">The time (in seconds) until the invite expires. Set to <c>null</c> to never expire.</param>
/// <param name="maxUses">The max amount of times this invite may be used. Set to <c>null</c> to have unlimited uses.</param>
/// <param name="isTemporary">If <c>true</c>, the user accepting this invite will be kicked from the guild after closing their client.</param>
/// <param name="isUnique">If <c>true</c>, don't try to reuse a similar invite (useful for creating many unique one time use invites).</param>
/// <param name="maxAge">The time (in seconds) until the invite expires. Set to <see langword="null" /> to never expire.</param>
/// <param name="maxUses">The max amount of times this invite may be used. Set to <see langword="null" /> to have unlimited uses.</param>
/// <param name="isTemporary">If <see langword="true" />, the user accepting this invite will be kicked from the guild after closing their client.</param>
/// <param name="isUnique">If <see langword="true" />, don't try to reuse a similar invite (useful for creating many unique one time use invites).</param>
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// 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.
/// </summary>
/// <param name="applicationId">The id of the embedded application to open for this invite.</param>
/// <param name="maxAge">The time (in seconds) until the invite expires. Set to <c>null</c> to never expire.</param>
/// <param name="maxUses">The max amount of times this invite may be used. Set to <c>null</c> to have unlimited uses.</param>
/// <param name="isTemporary">If <c>true</c>, the user accepting this invite will be kicked from the guild after closing their client.</param>
/// <param name="isUnique">If <c>true</c>, don't try to reuse a similar invite (useful for creating many unique one time use invites).</param>
/// <param name="maxAge">The time (in seconds) until the invite expires. Set to <see langword="null" /> to never expire.</param>
/// <param name="maxUses">The max amount of times this invite may be used. Set to <see langword="null" /> to have unlimited uses.</param>
/// <param name="isTemporary">If <see langword="true" />, the user accepting this invite will be kicked from the guild after closing their client.</param>
/// <param name="isUnique">If <see langword="true" />, don't try to reuse a similar invite (useful for creating many unique one time use invites).</param>
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// 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.
/// </summary>
/// <param name="application">The application to open for this invite.</param>
/// <param name="maxAge">The time (in seconds) until the invite expires. Set to <c>null</c> to never expire.</param>
/// <param name="maxUses">The max amount of times this invite may be used. Set to <c>null</c> to have unlimited uses.</param>
/// <param name="isTemporary">If <c>true</c>, the user accepting this invite will be kicked from the guild after closing their client.</param>
/// <param name="isUnique">If <c>true</c>, don't try to reuse a similar invite (useful for creating many unique one time use invites).</param>
/// <param name="maxAge">The time (in seconds) until the invite expires. Set to <see langword="null" /> to never expire.</param>
/// <param name="maxUses">The max amount of times this invite may be used. Set to <see langword="null" /> to have unlimited uses.</param>
/// <param name="isTemporary">If <see langword="true" />, the user accepting this invite will be kicked from the guild after closing their client.</param>
/// <param name="isUnique">If <see langword="true" />, don't try to reuse a similar invite (useful for creating many unique one time use invites).</param>
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task that represents the asynchronous invite creation operation. The task result contains an invite
@@ -98,10 +98,10 @@ namespace Discord
/// </code>
/// </example>
/// <param name="user">The id of the user whose stream to display for this invite.</param>
/// <param name="maxAge">The time (in seconds) until the invite expires. Set to <c>null</c> to never expire.</param>
/// <param name="maxUses">The max amount of times this invite may be used. Set to <c>null</c> to have unlimited uses.</param>
/// <param name="isTemporary">If <c>true</c>, the user accepting this invite will be kicked from the guild after closing their client.</param>
/// <param name="isUnique">If <c>true</c>, don't try to reuse a similar invite (useful for creating many unique one time use invites).</param>
/// <param name="maxAge">The time (in seconds) until the invite expires. Set to <see langword="null" /> to never expire.</param>
/// <param name="maxUses">The max amount of times this invite may be used. Set to <see langword="null" /> to have unlimited uses.</param>
/// <param name="isTemporary">If <see langword="true" />, the user accepting this invite will be kicked from the guild after closing their client.</param>
/// <param name="isUnique">If <see langword="true" />, don't try to reuse a similar invite (useful for creating many unique one time use invites).</param>
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task that represents the asynchronous invite creation operation. The task result contains an invite

4
src/Discord.Net.Core/Entities/Channels/ITextChannel.cs
View File

@@ -14,7 +14,7 @@ namespace Discord
/// Gets a value that indicates whether the channel is NSFW.
/// </summary>
/// <returns>
/// <c>true</c> if the channel has the NSFW flag enabled; otherwise <c>false</c>.
/// <see langword="true" /> if the channel has the NSFW flag enabled; otherwise <see langword="false" />.
/// </returns>
bool IsNsfw { get; }
@@ -22,7 +22,7 @@ namespace Discord
/// Gets the current topic for this text channel.
/// </summary>
/// <returns>
/// A string representing the topic set in the channel; <c>null</c> if none is set.
/// A string representing the topic set in the channel; <see langword="null" /> if none is set.
/// </returns>
string Topic { get; }

2
src/Discord.Net.Core/Entities/Channels/IVoiceChannel.cs
View File

@@ -22,7 +22,7 @@ namespace Discord
/// </summary>
/// <returns>
/// An <see cref="int"/> representing the maximum number of users that are allowed to be connected to this
/// channel at once; <c>null</c> if a limit is not set.
/// channel at once; <see langword="null" /> if a limit is not set.
/// </returns>
int? UserLimit { get; }

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

@@ -13,7 +13,7 @@ namespace Discord
/// Gets or sets the topic of the channel.
/// </summary>
/// <remarks>
/// Setting this value to any string other than <c>null</c> or <see cref="string.Empty"/> will set the
/// Setting this value to any string other than <see langword="null" /> or <see cref="string.Empty"/> will set the
/// channel topic or description to the desired value.
/// </remarks>
public Optional<string> Topic { get; set; }
@@ -21,8 +21,8 @@ namespace Discord
/// Gets or sets whether this channel should be flagged as NSFW.
/// </summary>
/// <remarks>
/// Setting this value to <c>true</c> 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 <c>false</c> will
/// Setting this value to <see langword="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 <see langword="false" /> will
/// remove the NSFW indicator.
/// </remarks>
public Optional<bool> IsNsfw { get; set; }

2
src/Discord.Net.Core/Entities/Channels/VoiceChannelProperties.cs
View File

@@ -12,7 +12,7 @@ public class VoiceChannelProperties : TextChannelProperties
/// </summary>
public Optional<int> Bitrate { get; set; }
/// <summary>
/// Gets or sets the maximum number of users that can be present in a channel, or <c>null</c> if none.
/// Gets or sets the maximum number of users that can be present in a channel, or <see langword="null" /> if none.
/// </summary>
public Optional<int?> UserLimit { get; set; }
/// <summary>

2
src/Discord.Net.Core/Entities/Emotes/GuildEmote.cs
View File

@@ -35,7 +35,7 @@ namespace Discord
/// </summary>
/// <returns>
/// An <see cref="ulong"/> snowflake identifier representing the user who created this emoji;
/// <c>null</c> if unknown.
/// <see langword="null" /> if unknown.
/// </returns>
public ulong? CreatorId { get; }

2
src/Discord.Net.Core/Entities/Guilds/IBan.cs
View File

@@ -16,7 +16,7 @@ namespace Discord
/// Gets the reason why the user is banned if specified.
/// </summary>
/// <returns>
/// A string containing the reason behind the ban; <c>null</c> if none is specified.
/// A string containing the reason behind the ban; <see langword="null" /> if none is specified.
/// </returns>
string Reason { get; }
}

4
src/Discord.Net.Core/Entities/Guilds/IGuild.cs
View File

@@ -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.
/// </remarks>
/// <returns>
/// <c>true</c> if this guild is currently connected and ready to be used; otherwise <see langword="false"/>.
/// <see langword="true" /> if this guild is currently connected and ready to be used; otherwise <see langword="false"/>.
/// </returns>
bool Available { get; }
@@ -966,7 +966,7 @@ namespace Discord
/// This method removes all users that have not logged on in the provided number of <paramref name="days"/>.
/// </para>
/// <para>
/// If <paramref name="simulate" /> is <c>true</c>, this method will only return the number of users that
/// If <paramref name="simulate" /> is <see langword="true" />, this method will only return the number of users that
/// would be removed without kicking the users.
/// </para>
/// </remarks>

4
src/Discord.Net.Core/Entities/Guilds/IUserGuild.cs
View File

@@ -7,11 +7,11 @@ namespace Discord
/// </summary>
string Name { get; }
/// <summary>
/// Gets the icon URL associated with this guild, or <c>null</c> if one is not set.
/// Gets the icon URL associated with this guild, or <see langword="null" /> if one is not set.
/// </summary>
string IconUrl { get; }
/// <summary>
/// Returns <c>true</c> if the current user owns this guild.
/// Returns <see langword="true" /> if the current user owns this guild.
/// </summary>
bool IsOwner { get; }
/// <summary>

8
src/Discord.Net.Core/Entities/Guilds/IVoiceRegion.cs
View File

@@ -23,28 +23,28 @@ namespace Discord
/// Gets a value that indicates whether or not this voice region is exclusive to partnered servers.
/// </summary>
/// <returns>
/// <c>true</c> if this voice region is exclusive to VIP accounts; otherwise <c>false</c>.
/// <see langword="true" /> if this voice region is exclusive to VIP accounts; otherwise <see langword="false" />.
/// </returns>
bool IsVip { get; }
/// <summary>
/// Gets a value that indicates whether this voice region is optimal for your client in terms of latency.
/// </summary>
/// <returns>
/// <c>true</c> if this voice region is the closest to your machine; otherwise <c>false</c> .
/// <see langword="true" /> if this voice region is the closest to your machine; otherwise <see langword="false" /> .
/// </returns>
bool IsOptimal { get; }
/// <summary>
/// Gets a value that indicates whether this voice region is no longer being maintained.
/// </summary>
/// <returns>
/// <c>true</c> if this is a deprecated voice region; otherwise <c>false</c>.
/// <see langword="true" /> if this is a deprecated voice region; otherwise <see langword="false" />.
/// </returns>
bool IsDeprecated { get; }
/// <summary>
/// Gets a value that indicates whether this voice region is custom-made for events.
/// </summary>
/// <returns>
/// <c>true</c> if this is a custom voice region (used for events/etc); otherwise <c>false</c>/
/// <see langword="true" /> if this is a custom voice region (used for events/etc); otherwise <see langword="false" />/
/// </returns>
bool IsCustom { get; }
}

2
src/Discord.Net.Core/Entities/Image.cs
View File

@@ -41,7 +41,7 @@ namespace Discord
/// <paramref name="path" /> is a zero-length string, contains only white space, or contains one or more invalid
/// characters as defined by <see cref="Path.GetInvalidPathChars"/>.
/// </exception>
/// <exception cref="System.ArgumentNullException"><paramref name="path" /> is <c>null</c>.</exception>
/// <exception cref="System.ArgumentNullException"><paramref name="path" /> is <see langword="null" />.</exception>
/// <exception cref="PathTooLongException">
/// 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

4
src/Discord.Net.Core/Entities/Integrations/IIntegration.cs
View File

@@ -33,7 +33,7 @@ namespace Discord
/// Gets a value that indicates whether this integration is enabled or not.
/// </summary>
/// <returns>
/// <c>true</c> if this integration is enabled; otherwise <c>false</c>.
/// <see langword="true" /> if this integration is enabled; otherwise <see langword="false" />.
/// </returns>
bool IsEnabled { get; }
/// <summary>
@@ -44,7 +44,7 @@ namespace Discord
/// disabled will not. A user must manually choose when sync the integration if syncing is disabled.
/// </remarks>
/// <returns>
/// <c>true</c> if this integration is syncing; otherwise <c>false</c>.
/// <see langword="true" /> if this integration is syncing; otherwise <see langword="false" />.
/// </returns>
bool? IsSyncing { get; }
/// <summary>

8
src/Discord.Net.Core/Entities/Invites/IInviteMetadata.cs
View File

@@ -11,15 +11,15 @@ namespace Discord
/// Gets a value that indicates whether the invite is a temporary one.
/// </summary>
/// <returns>
/// <c>true</c> if users accepting this invite will be removed from the guild when they log off; otherwise
/// <c>false</c>.
/// <see langword="true" /> if users accepting this invite will be removed from the guild when they log off; otherwise
/// <see langword="false" />.
/// </returns>
bool IsTemporary { get; }
/// <summary>
/// Gets the time (in seconds) until the invite expires.
/// </summary>
/// <returns>
/// An <see cref="int"/> representing the time in seconds until this invite expires; <c>null</c> if this
/// An <see cref="int"/> representing the time in seconds until this invite expires; <see langword="null" /> if this
/// invite never expires.
/// </returns>
int? MaxAge { get; }
@@ -28,7 +28,7 @@ namespace Discord
/// </summary>
/// <returns>
/// An <see cref="int"/> representing the number of uses this invite may be accepted until it is removed
/// from the guild; <c>null</c> if none is set.
/// from the guild; <see langword="null" /> if none is set.
/// </returns>
int? MaxUses { get; }
/// <summary>

8
src/Discord.Net.Core/Entities/Messages/AllowedMentions.cs
View File

@@ -29,7 +29,7 @@ namespace Discord
/// The <see cref="AllowedMentionTypes.Users"/> flag is mutually exclusive with the <see cref="UserIds"/>
/// property, and the <see cref="AllowedMentionTypes.Roles"/> flag is mutually exclusive with the
/// <see cref="RoleIds"/> property.
/// If <c>null</c>, only the ids specified in <see cref="UserIds"/> and <see cref="RoleIds"/> will be mentioned.
/// If <see langword="null" />, only the ids specified in <see cref="UserIds"/> and <see cref="RoleIds"/> will be mentioned.
/// </remarks>
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 <see cref="AllowedMentionTypes.Roles"/>
/// flag of the <see cref="AllowedTypes"/> property. If the flag is set, the value of this property
/// must be <c>null</c> or empty.
/// must be <see langword="null" /> or empty.
/// </summary>
public List<ulong> RoleIds { get; set; } = new List<ulong>();
@@ -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 <see cref="AllowedMentionTypes.Users"/>
/// flag of the <see cref="AllowedTypes"/> property. If the flag is set, the value of this property
/// must be <c>null</c> or empty.
/// must be <see langword="null" /> or empty.
/// </summary>
public List<ulong> UserIds { get; set; } = new List<ulong>();
@@ -62,7 +62,7 @@ namespace Discord
/// </summary>
/// <param name="allowedTypes">
/// The types of mentions to parse from the message content.
/// If <c>null</c>, only the ids specified in <see cref="UserIds"/> and <see cref="RoleIds"/> will be mentioned.
/// If <see langword="null" />, only the ids specified in <see cref="UserIds"/> and <see cref="RoleIds"/> will be mentioned.
/// </param>
public AllowedMentions(AllowedMentionTypes? allowedTypes = null)
{

16
src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs
View File

@@ -93,7 +93,7 @@ namespace Discord
/// <summary> Gets or sets the list of <see cref="EmbedFieldBuilder"/> of an <see cref="Embed"/>. </summary>
/// <exception cref="ArgumentNullException" accessor="set">An embed builder's fields collection is set to
/// <c>null</c>.</exception>
/// <see langword="null" />.</exception>
/// <exception cref="ArgumentException" accessor="set">Fields count exceeds <see cref="MaxFieldCount"/>.
/// </exception>
/// <returns> The list of existing <see cref="EmbedFieldBuilder"/>.</returns>
@@ -114,28 +114,28 @@ namespace Discord
/// Gets or sets the timestamp of an <see cref="Embed"/>.
/// </summary>
/// <returns>
/// The timestamp of the embed, or <c>null</c> if none is set.
/// The timestamp of the embed, or <see langword="null" /> if none is set.
/// </returns>
public DateTimeOffset? Timestamp { get; set; }
/// <summary>
/// Gets or sets the sidebar color of an <see cref="Embed"/>.
/// </summary>
/// <returns>
/// The color of the embed, or <c>null</c> if none is set.
/// The color of the embed, or <see langword="null" /> if none is set.
/// </returns>
public Color? Color { get; set; }
/// <summary>
/// Gets or sets the <see cref="EmbedAuthorBuilder" /> of an <see cref="Embed"/>.
/// </summary>
/// <returns>
/// The author field builder of the embed, or <c>null</c> if none is set.
/// The author field builder of the embed, or <see langword="null" /> if none is set.
/// </returns>
public EmbedAuthorBuilder Author { get; set; }
/// <summary>
/// Gets or sets the <see cref="EmbedFooterBuilder" /> of an <see cref="Embed"/>.
/// </summary>
/// <returns>
/// The footer field builder of the embed, or <c>null</c> if none is set.
/// The footer field builder of the embed, or <see langword="null" /> if none is set.
/// </returns>
public EmbedFooterBuilder Footer { get; set; }
@@ -556,7 +556,7 @@ namespace Discord
/// Gets or sets the field name.
/// </summary>
/// <exception cref="ArgumentException">
/// <para>Field name is <c>null</c>, empty or entirely whitespace.</para>
/// <para>Field name is <see langword="null" />, empty or entirely whitespace.</para>
/// <para><c>- or -</c></para>
/// <para>Field name length exceeds <see cref="MaxFieldNameLength"/>.</para>
/// </exception>
@@ -580,7 +580,7 @@ namespace Discord
/// Gets or sets the field value.
/// </summary>
/// <exception cref="ArgumentException" accessor="set">
/// <para>Field value is <c>null</c>, empty or entirely whitespace.</para>
/// <para>Field value is <see langword="null" />, empty or entirely whitespace.</para>
/// <para><c>- or -</c></para>
/// <para>Field value length exceeds <see cref="MaxFieldValueLength"/>.</para>
/// </exception>
@@ -648,7 +648,7 @@ namespace Discord
/// The current builder.
/// </returns>
/// <exception cref="ArgumentException">
/// <para><see cref="Name"/> or <see cref="Value"/> is <c>null</c>, empty or entirely whitespace.</para>
/// <para><see cref="Name"/> or <see cref="Value"/> is <see langword="null" />, empty or entirely whitespace.</para>
/// <para><c>- or -</c></para>
/// <para><see cref="Name"/> or <see cref="Value"/> exceeds the maximum length allowed by Discord.</para>
/// </exception>

4
src/Discord.Net.Core/Entities/Messages/EmbedImage.cs
View File

@@ -26,7 +26,7 @@ namespace Discord
/// </summary>
/// <returns>
/// A <see cref="int"/> representing the height of this image if it can be retrieved; otherwise
/// <c>null</c>.
/// <see langword="null" />.
/// </returns>
public int? Height { get; }
/// <summary>
@@ -34,7 +34,7 @@ namespace Discord
/// </summary>
/// <returns>
/// A <see cref="int"/> representing the width of this image if it can be retrieved; otherwise
/// <c>null</c>.
/// <see langword="null" />.
/// </returns>
public int? Width { get; }

4
src/Discord.Net.Core/Entities/Messages/EmbedThumbnail.cs
View File

@@ -26,7 +26,7 @@ namespace Discord
/// </summary>
/// <returns>
/// A <see cref="int"/> representing the height of this thumbnail if it can be retrieved; otherwise
/// <c>null</c>.
/// <see langword="null" />.
/// </returns>
public int? Height { get; }
/// <summary>
@@ -34,7 +34,7 @@ namespace Discord
/// </summary>
/// <returns>
/// A <see cref="int"/> representing the width of this thumbnail if it can be retrieved; otherwise
/// <c>null</c>.
/// <see langword="null" />.
/// </returns>
public int? Width { get; }

4
src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs
View File

@@ -21,7 +21,7 @@ namespace Discord
/// </summary>
/// <returns>
/// A <see cref="int"/> representing the height of this video if it can be retrieved; otherwise
/// <c>null</c>.
/// <see langword="null" />.
/// </returns>
public int? Height { get; }
/// <summary>
@@ -29,7 +29,7 @@ namespace Discord
/// </summary>
/// <returns>
/// A <see cref="int"/> representing the width of this video if it can be retrieved; otherwise
/// <c>null</c>.
/// <see langword="null" />.
/// </returns>
public int? Width { get; }

2
src/Discord.Net.Core/Entities/Messages/FileAttachment.cs
View File

@@ -71,7 +71,7 @@ namespace Discord
/// <paramref name="path" /> is a zero-length string, contains only white space, or contains one or more invalid
/// characters as defined by <see cref="Path.GetInvalidPathChars"/>.
/// </exception>
/// <exception cref="System.ArgumentNullException"><paramref name="path" /> is <c>null</c>.</exception>
/// <exception cref="System.ArgumentNullException"><paramref name="path" /> is <see langword="null" />.</exception>
/// <exception cref="PathTooLongException">
/// 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

4
src/Discord.Net.Core/Entities/Messages/IAttachment.cs
View File

@@ -45,14 +45,14 @@ namespace Discord
/// Gets the height of this attachment.
/// </summary>
/// <returns>
/// The height of this attachment if it is a picture; otherwise <c>null</c>.
/// The height of this attachment if it is a picture; otherwise <see langword="null" />.
/// </returns>
int? Height { get; }
/// <summary>
/// Gets the width of this attachment.
/// </summary>
/// <returns>
/// The width of this attachment if it is a picture; otherwise <c>null</c>.
/// The width of this attachment if it is a picture; otherwise <see langword="null" />.
/// </returns>
int? Width { get; }
/// <summary>

16
src/Discord.Net.Core/Entities/Messages/IEmbed.cs
View File

@@ -41,56 +41,56 @@ namespace Discord
/// </summary>
/// <returns>
/// A <see cref="DateTimeOffset"/> based on the timestamp present at the bottom left of the embed, or
/// <c>null</c> if none is set.
/// <see langword="null" /> if none is set.
/// </returns>
DateTimeOffset? Timestamp { get; }
/// <summary>
/// Gets the color of this embed.
/// </summary>
/// <returns>
/// The color of the embed present on the side of the embed, or <c>null</c> if none is set.
/// The color of the embed present on the side of the embed, or <see langword="null" /> if none is set.
/// </returns>
Color? Color { get; }
/// <summary>
/// Gets the image of this embed.
/// </summary>
/// <returns>
/// The image of the embed, or <c>null</c> if none is set.
/// The image of the embed, or <see langword="null" /> if none is set.
/// </returns>
EmbedImage? Image { get; }
/// <summary>
/// Gets the video of this embed.
/// </summary>
/// <returns>
/// The video of the embed, or <c>null</c> if none is set.
/// The video of the embed, or <see langword="null" /> if none is set.
/// </returns>
EmbedVideo? Video { get; }
/// <summary>
/// Gets the author field of this embed.
/// </summary>
/// <returns>
/// The author field of the embed, or <c>null</c> if none is set.
/// The author field of the embed, or <see langword="null" /> if none is set.
/// </returns>
EmbedAuthor? Author { get; }
/// <summary>
/// Gets the footer field of this embed.
/// </summary>
/// <returns>
/// The author field of the embed, or <c>null</c> if none is set.
/// The author field of the embed, or <see langword="null" /> if none is set.
/// </returns>
EmbedFooter? Footer { get; }
/// <summary>
/// Gets the provider of this embed.
/// </summary>
/// <returns>
/// The source of the embed, or <c>null</c> if none is set.
/// The source of the embed, or <see langword="null" /> if none is set.
/// </returns>
EmbedProvider? Provider { get; }
/// <summary>
/// Gets the thumbnail featured in this embed.
/// </summary>
/// <returns>
/// The thumbnail featured in the embed, or <c>null</c> if none is set.
/// The thumbnail featured in the embed, or <see langword="null" /> if none is set.
/// </returns>
EmbedThumbnail? Thumbnail { get; }
/// <summary>

10
src/Discord.Net.Core/Entities/Messages/IMessage.cs
View File

@@ -21,28 +21,28 @@ namespace Discord
/// Gets the value that indicates whether this message was meant to be read-aloud by Discord.
/// </summary>
/// <returns>
/// <c>true</c> if this message was sent as a text-to-speech message; otherwise <c>false</c>.
/// <see langword="true" /> if this message was sent as a text-to-speech message; otherwise <see langword="false" />.
/// </returns>
bool IsTTS { get; }
/// <summary>
/// Gets the value that indicates whether this message is pinned.
/// </summary>
/// <returns>
/// <c>true</c> if this message was added to its channel's pinned messages; otherwise <c>false</c>.
/// <see langword="true" /> if this message was added to its channel's pinned messages; otherwise <see langword="false" />.
/// </returns>
bool IsPinned { get; }
/// <summary>
/// Gets the value that indicates whether or not this message's embeds are suppressed.
/// </summary>
/// <returns>
/// <c>true</c> if the embeds in this message have been suppressed (made invisible); otherwise <c>false</c>.
/// <see langword="true" /> if the embeds in this message have been suppressed (made invisible); otherwise <see langword="false" />.
/// </returns>
bool IsSuppressed { get; }
/// <summary>
/// Gets the value that indicates whether this message mentioned everyone.
/// </summary>
/// <returns>
/// <c>true</c> if this message mentioned everyone; otherwise <c>false</c>.
/// <see langword="true" /> if this message mentioned everyone; otherwise <see langword="false" />.
/// </returns>
bool MentionedEveryone { get; }
/// <summary>
@@ -76,7 +76,7 @@ namespace Discord
/// Gets the time of this message's last edit.
/// </summary>
/// <returns>
/// Time of when the message was last edited; <c>null</c> if the message is never edited.
/// Time of when the message was last edited; <see langword="null" /> if the message is never edited.
/// </returns>
DateTimeOffset? EditedTimestamp { get; }

2
src/Discord.Net.Core/Entities/Messages/ReactionMetadata.cs
View File

@@ -17,7 +17,7 @@ namespace Discord
/// Gets a value that indicates whether the current user has reacted to this.
/// </summary>
/// <returns>
/// <c>true</c> if the user has reacted to the message; otherwise <c>false</c>.
/// <see langword="true" /> if the user has reacted to the message; otherwise <see langword="false" />.
/// </returns>
public bool IsMe { get; internal set; }
}

2
src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs
View File

@@ -364,7 +364,7 @@ namespace Discord
/// in these permissions.
/// </summary>
/// <param name="permission">The permission value to check for.</param>
/// <returns><see langword="true"/> if the permission is enabled, <c>false</c> otherwise.</returns>
/// <returns><see langword="true"/> if the permission is enabled, <see langword="false" /> otherwise.</returns>
public bool Has(GuildPermission permission) => Permissions.GetValue(RawValue, permission);
/// <summary>

16
src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs
View File

@@ -83,21 +83,21 @@ namespace Discord
public PermValue ManageRoles => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.ManageRoles);
/// <summary> If True, a user may edit the webhooks for this channel. </summary>
public PermValue ManageWebhooks => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.ManageWebhooks);
/// <summary> If <c>true</c>, a user may use slash commands in this guild. </summary>
/// <summary> If <see langword="true" />, a user may use slash commands in this guild. </summary>
public PermValue UseApplicationCommands => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.UseApplicationCommands);
/// <summary> If <c>true</c>, a user may request to speak in stage channels. </summary>
/// <summary> If <see langword="true" />, a user may request to speak in stage channels. </summary>
public PermValue RequestToSpeak => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.RequestToSpeak);
/// <summary> If <c>true</c>, a user may manage threads in this guild. </summary>
/// <summary> If <see langword="true" />, a user may manage threads in this guild. </summary>
public PermValue ManageThreads => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.ManageThreads);
/// <summary> If <c>true</c>, a user may create public threads in this guild. </summary>
/// <summary> If <see langword="true" />, a user may create public threads in this guild. </summary>
public PermValue CreatePublicThreads => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.CreatePublicThreads);
/// <summary> If <c>true</c>, a user may create private threads in this guild. </summary>
/// <summary> If <see langword="true" />, a user may create private threads in this guild. </summary>
public PermValue CreatePrivateThreads => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.CreatePrivateThreads);
/// <summary> If <c>true</c>, a user may use external stickers in this guild. </summary>
/// <summary> If <see langword="true" />, a user may use external stickers in this guild. </summary>
public PermValue UseExternalStickers => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.UseExternalStickers);
/// <summary> If <c>true</c>, a user may send messages in threads in this guild. </summary>
/// <summary> If <see langword="true" />, a user may send messages in threads in this guild. </summary>
public PermValue SendMessagesInThreads => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.SendMessagesInThreads);
/// <summary> If <c>true</c>, a user launch application activities in voice channels in this guild. </summary>
/// <summary> If <see langword="true" />, a user launch application activities in voice channels in this guild. </summary>
public PermValue StartEmbeddedActivities => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.StartEmbeddedActivities);
/// <summary> Creates a new OverwritePermissions with the provided allow and deny packed values. </summary>

6
src/Discord.Net.Core/Entities/Roles/IRole.cs
View File

@@ -27,21 +27,21 @@ namespace Discord
/// Gets a value that indicates whether the role can be separated in the user list.
/// </summary>
/// <returns>
/// <c>true</c> if users of this role are separated in the user list; otherwise <c>false</c>.
/// <see langword="true" /> if users of this role are separated in the user list; otherwise <see langword="false" />.
/// </returns>
bool IsHoisted { get; }
/// <summary>
/// Gets a value that indicates whether the role is managed by Discord.
/// </summary>
/// <returns>
/// <c>true</c> if this role is automatically managed by Discord; otherwise <c>false</c>.
/// <see langword="true" /> if this role is automatically managed by Discord; otherwise <see langword="false" />.
/// </returns>
bool IsManaged { get; }
/// <summary>
/// Gets a value that indicates whether the role is mentionable.
/// </summary>
/// <returns>
/// <c>true</c> if this role may be mentioned in messages; otherwise <c>false</c>.
/// <see langword="true" /> if this role may be mentioned in messages; otherwise <see langword="false" />.
/// </returns>
bool IsMentionable { get; }
/// <summary>

6
src/Discord.Net.Core/Entities/Users/AddGuildUserProperties.cs
View File

@@ -12,7 +12,7 @@ namespace Discord
/// Gets or sets the user's nickname.
/// </summary>
/// <remarks>
/// To clear the user's nickname, this value can be set to <c>null</c> or
/// To clear the user's nickname, this value can be set to <see langword="null" /> or
/// <see cref="string.Empty"/>.
/// </remarks>
public Optional<string> Nickname { get; set; }
@@ -20,14 +20,14 @@ namespace Discord
/// Gets or sets whether the user should be muted in a voice channel.
/// </summary>
/// <remarks>
/// If this value is set to <c>true</c>, no user will be able to hear this user speak in the guild.
/// If this value is set to <see langword="true" />, no user will be able to hear this user speak in the guild.
/// </remarks>
public Optional<bool> Mute { get; set; }
/// <summary>
/// Gets or sets whether the user should be deafened in a voice channel.
/// </summary>
/// <remarks>
/// If this value is set to <c>true</c>, this user will not be able to hear anyone speak in the guild.
/// If this value is set to <see langword="true" />, this user will not be able to hear anyone speak in the guild.
/// </remarks>
public Optional<bool> Deaf { get; set; }
/// <summary>

10
src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs
View File

@@ -13,21 +13,21 @@ namespace Discord
/// Gets or sets whether the user should be muted in a voice channel.
/// </summary>
/// <remarks>
/// If this value is set to <c>true</c>, no user will be able to hear this user speak in the guild.
/// If this value is set to <see langword="true" />, no user will be able to hear this user speak in the guild.
/// </remarks>
public Optional<bool> Mute { get; set; }
/// <summary>
/// Gets or sets whether the user should be deafened in a voice channel.
/// </summary>
/// <remarks>
/// If this value is set to <c>true</c>, this user will not be able to hear anyone speak in the guild.
/// If this value is set to <see langword="true" />, this user will not be able to hear anyone speak in the guild.
/// </remarks>
public Optional<bool> Deaf { get; set; }
/// <summary>
/// Gets or sets the user's nickname.
/// </summary>
/// <remarks>
/// To clear the user's nickname, this value can be set to <c>null</c> or
/// To clear the user's nickname, this value can be set to <see langword="null" /> or
/// <see cref="string.Empty"/>.
/// </remarks>
public Optional<string> Nickname { get; set; }
@@ -60,7 +60,7 @@ namespace Discord
/// </remarks>
public Optional<IEnumerable<ulong>> RoleIds { get; set; }
/// <summary>
/// Moves a user to a voice channel. If <c>null</c>, this user will be disconnected from their current voice channel.
/// Moves a user to a voice channel. If <see langword="null" />, this user will be disconnected from their current voice channel.
/// </summary>
/// <remarks>
/// This user MUST already be in a <see cref="IVoiceChannel"/> for this to work.
@@ -68,7 +68,7 @@ namespace Discord
/// </remarks>
public Optional<IVoiceChannel> Channel { get; set; }
/// <summary>
/// Moves a user to a voice channel. Set <see cref="Channel"/> to <c>null</c> to disconnect this user from their current voice channel.
/// Moves a user to a voice channel. Set <see cref="Channel"/> to <see langword="null" /> to disconnect this user from their current voice channel.
/// </summary>
/// <remarks>
/// This user MUST already be in a <see cref="IVoiceChannel"/> for this to work.

6
src/Discord.Net.Core/Entities/Users/IGuildUser.cs
View File

@@ -14,7 +14,7 @@ namespace Discord
/// </summary>
/// <returns>
/// A <see cref="DateTimeOffset"/> representing the time of which the user has joined the guild;
/// <c>null</c> when it cannot be obtained.
/// <see langword="null" /> when it cannot be obtained.
/// </returns>
DateTimeOffset? JoinedAt { get; }
/// <summary>
@@ -28,7 +28,7 @@ namespace Discord
/// Gets the nickname for this user.
/// </summary>
/// <returns>
/// A string representing the nickname of the user; <c>null</c> if none is set.
/// A string representing the nickname of the user; <see langword="null" /> if none is set.
/// </returns>
string Nickname { get; }
/// <summary>
@@ -73,7 +73,7 @@ namespace Discord
/// Gets the date and time for when this user's guild boost began.
/// </summary>
/// <returns>
/// A <see cref="DateTimeOffset"/> for when the user began boosting this guild; <c>null</c> if they are not boosting the guild.
/// A <see cref="DateTimeOffset"/> for when the user began boosting this guild; <see langword="null" /> if they are not boosting the guild.
/// </returns>
DateTimeOffset? PremiumSince { get; }
/// <summary>

4
src/Discord.Net.Core/Entities/Users/ISelfUser.cs
View File

@@ -16,14 +16,14 @@ namespace Discord
/// Indicates whether or not this user has their email verified.
/// </summary>
/// <returns>
/// <c>true</c> if this user's email has been verified; <c>false</c> if not.
/// <see langword="true" /> if this user's email has been verified; <see langword="false" /> if not.
/// </returns>
bool IsVerified { get; }
/// <summary>
/// Indicates whether or not this user has MFA enabled on their account.
/// </summary>
/// <returns>
/// <c>true</c> if this user has enabled multi-factor authentication on their account; <c>false</c> if not.
/// <see langword="true" /> if this user has enabled multi-factor authentication on their account; <see langword="false" /> if not.
/// </returns>
bool IsMfaEnabled { get; }
/// <summary>

8
src/Discord.Net.Core/Entities/Users/IUser.cs
View File

@@ -16,7 +16,7 @@ namespace Discord
/// </summary>
/// <remarks>
/// 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 <c>null</c>. If you wish to
/// (i.e. their avatar identifier is not set), this method will return <see langword="null" />. If you wish to
/// retrieve the default avatar for this user, consider using <see cref="IUser.GetDefaultAvatarUrl"/> (see
/// example).
/// </remarks>
@@ -31,7 +31,7 @@ namespace Discord
/// <param name="size">The size of the image to return in. This can be any power of two between 16 and 2048.
/// </param>
/// <returns>
/// A string representing the user's avatar URL; <c>null</c> if the user does not have an avatar in place.
/// A string representing the user's avatar URL; <see langword="null" /> if the user does not have an avatar in place.
/// </returns>
string GetAvatarUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128);
/// <summary>
@@ -62,14 +62,14 @@ namespace Discord
/// (indicated by the blue BOT tag within the official chat client).
/// </remarks>
/// <returns>
/// <c>true</c> if the user is a bot application; otherwise <c>false</c>.
/// <see langword="true" /> if the user is a bot application; otherwise <see langword="false" />.
/// </returns>
bool IsBot { get; }
/// <summary>
/// Gets a value that indicates whether this user is a webhook user.
/// </summary>
/// <returns>
/// <c>true</c> if the user is a webhook; otherwise <c>false</c>.
/// <see langword="true" /> if the user is a webhook; otherwise <see langword="false" />.
/// </returns>
bool IsWebhook { get; }
/// <summary>

18
src/Discord.Net.Core/Entities/Users/IVoiceState.cs
View File

@@ -11,8 +11,8 @@ namespace Discord
/// Gets a value that indicates whether this user is deafened by the guild.
/// </summary>
/// <returns>
/// <c>true</c> if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
/// otherwise <c>false</c>.
/// <see langword="true" /> if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
/// otherwise <see langword="false" />.
/// </returns>
bool IsDeafened { get; }
/// <summary>
@@ -20,14 +20,14 @@ namespace Discord
/// guild.
/// </summary>
/// <returns>
/// <c>true</c> if this user is muted by the guild; otherwise <c>false</c>.
/// <see langword="true" /> if this user is muted by the guild; otherwise <see langword="false" />.
/// </returns>
bool IsMuted { get; }
/// <summary>
/// Gets a value that indicates whether this user has marked themselves as deafened.
/// </summary>
/// <returns>
/// <c>true</c> if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise <c>false</c>.
/// <see langword="true" /> if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise <see langword="false" />.
/// </returns>
bool IsSelfDeafened { get; }
/// <summary>
@@ -35,21 +35,21 @@ namespace Discord
/// speak via voice).
/// </summary>
/// <returns>
/// <c>true</c> if this user has muted themselves; otherwise <c>false</c>.
/// <see langword="true" /> if this user has muted themselves; otherwise <see langword="false" />.
/// </returns>
bool IsSelfMuted { get; }
/// <summary>
/// Gets a value that indicates whether the user is muted by the current user.
/// </summary>
/// <returns>
/// <c>true</c> if the guild is temporarily blocking audio to/from this user; otherwise <c>false</c>.
/// <see langword="true" /> if the guild is temporarily blocking audio to/from this user; otherwise <see langword="false" />.
/// </returns>
bool IsSuppressed { get; }
/// <summary>
/// Gets the voice channel this user is currently in.
/// </summary>
/// <returns>
/// A generic voice channel object representing the voice channel that the user is currently in; <c>null</c>
/// A generic voice channel object representing the voice channel that the user is currently in; <see langword="null" />
/// if none.
/// </returns>
IVoiceChannel VoiceChannel { get; }
@@ -61,14 +61,14 @@ namespace Discord
/// Gets a value that indicates if this user is streaming in a voice channel.
/// </summary>
/// <returns>
/// <c>true</c> if the user is streaming; otherwise <c>false</c>.
/// <see langword="true" /> if the user is streaming; otherwise <see langword="false" />.
/// </returns>
bool IsStreaming { get; }
/// <summary>
/// Gets a value that indicates if the user is videoing in a voice channel.
/// </summary>
/// <returns>
/// <c>true</c> if the user has their camera turned on; otherwise <c>false</c>.
/// <see langword="true" /> if the user has their camera turned on; otherwise <see langword="false" />.
/// </returns>
bool IsVideoing { get; }
/// <summary>

2
src/Discord.Net.Core/Extensions/MessageExtensions.cs
View File

@@ -84,7 +84,7 @@ namespace Discord
/// <param name="embeds">A array of <see cref="Embed"/>s to send with this response. Max 10.</param>
/// <param name="allowedMentions">
/// Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
/// If <c>null</c>, all mentioned roles and users will be notified.
/// If <see langword="null" />, all mentioned roles and users will be notified.
/// </param>
/// <param name="options">The options to be used when sending the request.</param>
/// <param name="components">The message components to be included with this message. Used for interactions.</param>

2
src/Discord.Net.Core/Extensions/UserExtensions.cs
View File

@@ -31,7 +31,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <param name="allowedMentions">
/// Specifies if notifications are sent for mentioned users and roles in the message <paramref name="text"/>.
/// If <c>null</c>, all mentioned roles and users will be notified.
/// If <see langword="null" />, all mentioned roles and users will be notified.
/// </param>
/// <param name="components">The message components to be included with this message. Used for interactions.</param>
/// <param name="embeds">A array of <see cref="Embed"/>s to send with this response. Max 10.</param>

12
src/Discord.Net.Core/IDiscordClient.cs
View File

@@ -76,7 +76,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task that represents the asynchronous get operation. The task result contains the channel associated
/// with the snowflake identifier; <c>null</c> when the channel cannot be found.
/// with the snowflake identifier; <see langword="null" /> when the channel cannot be found.
/// </returns>
Task<IChannel> GetChannelAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);
/// <summary>
@@ -192,7 +192,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task that represents the asynchronous get operation. The task result contains the guild associated
/// with the snowflake identifier; <c>null</c> when the guild cannot be found.
/// with the snowflake identifier; <see langword="null" /> when the guild cannot be found.
/// </returns>
Task<IGuild> GetGuildAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);
/// <summary>
@@ -248,7 +248,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task that represents the asynchronous get operation. The task result contains the user associated with
/// the snowflake identifier; <c>null</c> if the user is not found.
/// the snowflake identifier; <see langword="null" /> if the user is not found.
/// </returns>
Task<IUser> GetUserAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);
/// <summary>
@@ -266,7 +266,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task that represents the asynchronous get operation. The task result contains the user associated with
/// the name and the discriminator; <c>null</c> if the user is not found.
/// the name and the discriminator; <see langword="null" /> if the user is not found.
/// </returns>
Task<IUser> GetUserAsync(string username, string discriminator, RequestOptions options = null);
@@ -293,7 +293,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task that represents the asynchronous get operation. The task result contains the voice region
/// associated with the identifier; <c>null</c> if the voice region is not found.
/// associated with the identifier; <see langword="null" /> if the voice region is not found.
/// </returns>
Task<IVoiceRegion> GetVoiceRegionAsync(string id, RequestOptions options = null);
@@ -304,7 +304,7 @@ namespace Discord
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// A task that represents the asynchronous get operation. The task result contains a webhook associated
/// with the identifier; <c>null</c> if the webhook is not found.
/// with the identifier; <see langword="null" /> if the webhook is not found.
/// </returns>
Task<IWebhook> GetWebhookAsync(ulong id, RequestOptions options = null);

2
src/Discord.Net.Core/Logging/LogMessage.cs
View File

@@ -33,7 +33,7 @@ namespace Discord
/// Gets the exception of this log entry.
/// </summary>
/// <returns>
/// An <see cref="Discord.LogMessage.Exception" /> object associated with an incident; otherwise <c>null</c>.
/// An <see cref="Discord.LogMessage.Exception" /> object associated with an incident; otherwise <see langword="null" />.
/// </returns>
public Exception Exception { get; }

2
src/Discord.Net.Core/Net/HttpException.cs
View File

@@ -25,7 +25,7 @@ namespace Discord.Net
/// <returns>
/// A
/// <see href="https://discord.com/developers/docs/topics/opcodes-and-status-codes#json">JSON error code</see>
/// from Discord, or <c>null</c> if none.
/// from Discord, or <see langword="null" /> if none.
/// </returns>
public DiscordErrorCode? DiscordCode { get; }
/// <summary>

4
src/Discord.Net.Core/RequestOptions.cs
View File

@@ -21,7 +21,7 @@ namespace Discord
/// </summary>
/// <remarks>
/// Gets or set the max time, in milliseconds, to wait for this request to complete. If
/// <c>null</c>, a request will not time out. If a rate limit has been triggered for this request's bucket
/// <see langword="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.
/// </remarks>
/// <returns>
@@ -50,7 +50,7 @@ namespace Discord
public string AuditLogReason { get; set; }
/// <summary>
/// Gets or sets whether or not this request should use the system
/// clock for rate-limiting. Defaults to <c>true</c>.
/// clock for rate-limiting. Defaults to <see langword="true" />.
/// </summary>
/// <remarks>
/// This property can also be set in <see cref="DiscordConfig"/>.

4
src/Discord.Net.Core/Utils/Cacheable.cs
View File

@@ -25,7 +25,7 @@ namespace Discord
/// </summary>
/// <remarks>
/// This value is not guaranteed to be set; in cases where the entity cannot be pulled from cache, it is
/// <c>null</c>.
/// <see langword="null" />.
/// </remarks>
public TEntity Value { get; }
private Func<Task<TEntity>> DownloadFunc { get; }
@@ -81,7 +81,7 @@ namespace Discord
/// </summary>
/// <remarks>
/// This value is not guaranteed to be set; in cases where the entity cannot be pulled from cache, it is
/// <c>null</c>.
/// <see langword="null" />.
/// </remarks>
public TCachedEntity Value { get; }
private Func<Task<TDownloadableEntity>> DownloadFunc { get; }

10
src/Discord.Net.Core/Utils/ConcurrentHashSet.cs
View File

@@ -157,7 +157,7 @@ namespace Discord
: this(collection, EqualityComparer<T>.Default) { }
public ConcurrentHashSet(IEqualityComparer<T> comparer)
: this(DefaultConcurrencyLevel, DefaultCapacity, true, comparer) { }
/// <exception cref="ArgumentNullException"><paramref name="collection"/> is <c>null</c></exception>
/// <exception cref="ArgumentNullException"><paramref name="collection"/> is <see langword="null" /></exception>
public ConcurrentHashSet(IEnumerable<T> collection, IEqualityComparer<T> comparer)
: this(comparer)
{
@@ -166,7 +166,7 @@ namespace Discord
InitializeFromCollection(collection);
}
/// <exception cref="ArgumentNullException">
/// <paramref name="collection" /> or <paramref name="comparer" /> is <c>null</c>
/// <paramref name="collection" /> or <paramref name="comparer" /> is <see langword="null" />
/// </exception>
public ConcurrentHashSet(int concurrencyLevel, IEnumerable<T> collection, IEqualityComparer<T> comparer)
: this(concurrencyLevel, DefaultCapacity, false, comparer)
@@ -217,7 +217,7 @@ namespace Discord
if (_budget == 0)
_budget = _tables._buckets.Length / _tables._locks.Length;
}
/// <exception cref="ArgumentNullException"><paramref name="value"/> is <c>null</c></exception>
/// <exception cref="ArgumentNullException"><paramref name="value"/> is <see langword="null" /></exception>
public bool ContainsKey(T value)
{
if (value == null)
@@ -242,7 +242,7 @@ namespace Discord
return false;
}
/// <exception cref="ArgumentNullException"><paramref name="value"/> is <c>null</c></exception>
/// <exception cref="ArgumentNullException"><paramref name="value"/> is <see langword="null" /></exception>
public bool TryAdd(T value)
{
if (value == null)
@@ -294,7 +294,7 @@ namespace Discord
}
}
/// <exception cref="ArgumentNullException"><paramref name="value"/> is <c>null</c></exception>
/// <exception cref="ArgumentNullException"><paramref name="value"/> is <see langword="null" /></exception>
public bool TryRemove(T value)
{
if (value == null)

2
src/Discord.Net.Core/Utils/TokenUtils.cs
View File

@@ -144,7 +144,7 @@ namespace Discord
/// </summary>
/// <param name="tokenType"> The type of token to validate. </param>
/// <param name="token"> The token value to validate. </param>
/// <exception cref="ArgumentNullException"> Thrown when the supplied token string is <c>null</c>, empty, or contains only whitespace.</exception>
/// <exception cref="ArgumentNullException"> Thrown when the supplied token string is <see langword="null" />, empty, or contains only whitespace.</exception>
/// <exception cref="ArgumentException"> Thrown when the supplied <see cref="TokenType"/> or token value is invalid. </exception>
public static void ValidateToken(TokenType tokenType, string token)
{