From 706442fcecc63ca806d7d42fc760cbebdd74700e Mon Sep 17 00:00:00 2001
From: Still Hsu <341464@gmail.com>
Date: Tue, 26 Jun 2018 17:09:09 +0800
Subject: [PATCH] Fix styling of several member documentation
* Fix ' />' caused by Agent Smith oddities
* Fix styling to be more specific about the mention of IDs
---
.../Attributes/OverrideTypeReaderAttribute.cs | 2 +-
.../RequireBotPermissionAttribute.cs | 2 +-
.../RequireUserPermissionAttribute.cs | 2 +-
src/Discord.Net.Commands/CommandService.cs | 68 ++++++++++---------
.../CommandServiceConfig.cs | 2 +-
src/Discord.Net.Commands/Info/CommandInfo.cs | 2 +-
.../Entities/Activities/Game.cs | 2 +-
.../Entities/AuditLogs/IAuditLogData.cs | 2 +-
.../Channels/ReorderChannelProperties.cs | 2 +-
.../Entities/Emotes/EmoteProperties.cs | 4 +-
src/Discord.Net.Core/Entities/Image.cs | 4 +-
.../Entities/Messages/Embed.cs | 2 +-
.../Entities/Messages/EmbedAuthor.cs | 2 +-
.../Entities/Messages/EmbedBuilder.cs | 36 +++++-----
.../Entities/Messages/EmbedField.cs | 2 +-
.../Entities/Messages/EmbedVideo.cs | 2 +-
.../Permissions/OverwritePermissions.cs | 4 +-
.../Entities/Roles/ReorderRoleProperties.cs | 2 +-
.../Entities/Roles/RoleProperties.cs | 2 +-
.../Entities/Users/GuildUserProperties.cs | 2 +-
.../Entities/Webhooks/WebhookProperties.cs | 4 +-
src/Discord.Net.Core/RequestOptions.cs | 2 +-
src/Discord.Net.Rest/DiscordRestConfig.cs | 2 +-
.../DataTypes/ChannelCreateAuditLogData.cs | 2 +-
.../DataTypes/ChannelDeleteAuditLogData.cs | 2 +-
.../Entities/Channels/ChannelHelper.cs | 2 +-
.../Entities/Channels/RestDMChannel.cs | 2 +-
.../Entities/Channels/RestGroupChannel.cs | 2 +-
.../Entities/Channels/RestTextChannel.cs | 2 +-
.../Entities/Messages/Attachment.cs | 2 +-
src/Discord.Net.WebSocket/BaseSocketClient.cs | 11 +--
.../DiscordSocketConfig.cs | 2 +-
.../Entities/Channels/SocketChannel.cs | 6 +-
.../Entities/Channels/SocketGroupChannel.cs | 4 +-
.../Entities/Channels/SocketTextChannel.cs | 10 +--
.../Entities/Guilds/SocketGuild.cs | 2 +-
.../Entities/Messages/SocketReaction.cs | 7 +-
37 files changed, 108 insertions(+), 102 deletions(-)
diff --git a/src/Discord.Net.Commands/Attributes/OverrideTypeReaderAttribute.cs b/src/Discord.Net.Commands/Attributes/OverrideTypeReaderAttribute.cs
index 1ea2d2574..ec110ab1a 100644
--- a/src/Discord.Net.Commands/Attributes/OverrideTypeReaderAttribute.cs
+++ b/src/Discord.Net.Commands/Attributes/OverrideTypeReaderAttribute.cs
@@ -5,7 +5,7 @@ using System.Reflection;
namespace Discord.Commands
{
///
- /// Marks the to be read by the specified .
+ /// Marks the to be read by the specified .
///
[AttributeUsage(AttributeTargets.Parameter, AllowMultiple = false, Inherited = true)]
public class OverrideTypeReaderAttribute : Attribute
diff --git a/src/Discord.Net.Commands/Attributes/Preconditions/RequireBotPermissionAttribute.cs b/src/Discord.Net.Commands/Attributes/Preconditions/RequireBotPermissionAttribute.cs
index adea63edf..76d18449e 100644
--- a/src/Discord.Net.Commands/Attributes/Preconditions/RequireBotPermissionAttribute.cs
+++ b/src/Discord.Net.Commands/Attributes/Preconditions/RequireBotPermissionAttribute.cs
@@ -19,7 +19,7 @@ namespace Discord.Commands
public ChannelPermission? ChannelPermission { get; }
///
- /// Requires the bot account to have a specific .
+ /// Requires the bot account to have a specific .
///
///
/// This precondition will always fail if the command is being invoked in a .
diff --git a/src/Discord.Net.Commands/Attributes/Preconditions/RequireUserPermissionAttribute.cs b/src/Discord.Net.Commands/Attributes/Preconditions/RequireUserPermissionAttribute.cs
index f2bd717e4..e12b0c737 100644
--- a/src/Discord.Net.Commands/Attributes/Preconditions/RequireUserPermissionAttribute.cs
+++ b/src/Discord.Net.Commands/Attributes/Preconditions/RequireUserPermissionAttribute.cs
@@ -19,7 +19,7 @@ namespace Discord.Commands
public ChannelPermission? ChannelPermission { get; }
///
- /// Requires that the user invoking the command to have a specific .
+ /// Requires that the user invoking the command to have a specific .
///
///
/// This precondition will always fail if the command is being invoked in a .
diff --git a/src/Discord.Net.Commands/CommandService.cs b/src/Discord.Net.Commands/CommandService.cs
index 4a9b0476d..291fba246 100644
--- a/src/Discord.Net.Commands/CommandService.cs
+++ b/src/Discord.Net.Commands/CommandService.cs
@@ -41,17 +41,17 @@ namespace Discord.Commands
internal readonly IReadOnlyDictionary _quotationMarkAliasMap;
///
- /// Represents all modules loaded within .
+ /// Represents all modules loaded within .
///
public IEnumerable Modules => _moduleDefs.Select(x => x);
///
- /// Represents all commands loaded within .
+ /// Represents all commands loaded within .
///
public IEnumerable Commands => _moduleDefs.SelectMany(x => x.Commands);
///
- /// Represents all loaded within .
+ /// Represents all loaded within .
///
public ILookup TypeReaders => _typeReaders.SelectMany(x => x.Value.Select(y => new { y.Key, y.Value })).ToLookup(x => x.Key, x => x.Value);
@@ -130,30 +130,30 @@ namespace Discord.Commands
}
///
- /// Add a command module from a .
+ /// Add a command module from a .
///
/// The type of module.
///
- /// The for your dependency injection solution, if using one - otherwise, pass
+ /// The for your dependency injection solution if using one; otherwise, pass
/// null.
///
///
- /// A built module.
+ /// An awaitable containing the built module.
///
/// This module has already been added.
/// The fails to be built; an invalid type may have been provided.
public Task AddModuleAsync(IServiceProvider services) => AddModuleAsync(typeof(T), services);
///
- /// Adds a command module from a .
+ /// Adds a command module from a .
///
/// The type of module.
///
- /// The for your dependency injection solution, if using one - otherwise, pass
+ /// The for your dependency injection solution if using one; otherwise, pass
/// null.
///
///
- /// A built module.
+ /// An awaitable containing the built module.
///
/// This module has already been added.
/// The fails to be built; an invalid type may have been provided.
@@ -184,15 +184,15 @@ namespace Discord.Commands
}
}
///
- /// Add command modules from an .
+ /// Add command modules from an .
///
/// The containing command modules.
///
- /// An for your dependency injection solution, if using one - otherwise, pass
+ /// The for your dependency injection solution if using one; otherwise, pass
/// null.
///
///
- /// A collection of built modules.
+ /// An awaitable containing the built module.
///
public async Task> AddModulesAsync(Assembly assembly, IServiceProvider services)
{
@@ -296,22 +296,24 @@ namespace Discord.Commands
//Type Readers
///
- /// Adds a custom to this for the supplied object type.
- /// If is a , a nullable will also be
- /// added.
- /// If a default exists for , a warning will be logged and the
- /// default will be replaced.
+ /// Adds a custom to this for the supplied object
+ /// type.
+ /// If is a , a nullable will
+ /// also be added.
+ /// If a default exists for , a warning will be logged
+ /// and the default will be replaced.
///
- /// The object type to be read by the .
+ /// The object type to be read by the .
/// An instance of the to be added.
public void AddTypeReader(TypeReader reader)
=> AddTypeReader(typeof(T), reader);
///
- /// Adds a custom to this for the supplied object type.
- /// If is a , a nullable for the value
- /// type will also be added.
- /// If a default exists for , a warning will be logged and the
- /// default will be replaced.
+ /// Adds a custom to this for the supplied object
+ /// type.
+ /// If is a , a nullable for the
+ /// value type will also be added.
+ /// If a default exists for , a warning will be logged and
+ /// the default will be replaced.
///
/// A instance for the type to be read.
/// An instance of the to be added.
@@ -323,11 +325,12 @@ namespace Discord.Commands
AddTypeReader(type, reader, true);
}
///
- /// Adds a custom to this for the supplied object type.
- /// If is a , a nullable will also be
- /// added.
+ /// Adds a custom to this for the supplied object
+ /// type.
+ /// If is a , a nullable will
+ /// also be added.
///
- /// The object type to be read by the .
+ /// The object type to be read by the .
/// An instance of the to be added.
///
/// Defines whether the should replace the default one for
@@ -336,15 +339,16 @@ namespace Discord.Commands
public void AddTypeReader(TypeReader reader, bool replaceDefault)
=> AddTypeReader(typeof(T), reader, replaceDefault);
///
- /// Adds a custom to this for the supplied object type.
- /// If is a , a nullable for the value
- /// type will also be added.
+ /// Adds a custom to this for the supplied object
+ /// type.
+ /// If is a , a nullable for the
+ /// value type will also be added.
///
/// A instance for the type to be read.
/// An instance of the to be added.
///
- /// Defines whether the should replace the default one for
- /// if it exists.
+ /// Defines whether the should replace the default one for if
+ /// it exists.
///
public void AddTypeReader(Type type, TypeReader reader, bool replaceDefault)
{
diff --git a/src/Discord.Net.Commands/CommandServiceConfig.cs b/src/Discord.Net.Commands/CommandServiceConfig.cs
index f9c90f08e..741c3bc59 100644
--- a/src/Discord.Net.Commands/CommandServiceConfig.cs
+++ b/src/Discord.Net.Commands/CommandServiceConfig.cs
@@ -4,7 +4,7 @@ using System.Collections.Generic;
namespace Discord.Commands
{
///
- /// Represents a configuration class for .
+ /// Represents a configuration class for .
///
public class CommandServiceConfig
{
diff --git a/src/Discord.Net.Commands/Info/CommandInfo.cs b/src/Discord.Net.Commands/Info/CommandInfo.cs
index 0f0572be7..8f97c1492 100644
--- a/src/Discord.Net.Commands/Info/CommandInfo.cs
+++ b/src/Discord.Net.Commands/Info/CommandInfo.cs
@@ -16,7 +16,7 @@ namespace Discord.Commands
///
///
/// This object contains the information of a command. This can include the module of the command, various
- /// descriptions regarding the command, and its .
+ /// descriptions regarding the command, and its .
///
[DebuggerDisplay("{Name,nq}")]
public class CommandInfo
diff --git a/src/Discord.Net.Core/Entities/Activities/Game.cs b/src/Discord.Net.Core/Entities/Activities/Game.cs
index 62b2853d5..5be99cacb 100644
--- a/src/Discord.Net.Core/Entities/Activities/Game.cs
+++ b/src/Discord.Net.Core/Entities/Activities/Game.cs
@@ -18,7 +18,7 @@ namespace Discord
/// Creates a with the provided and .
///
/// The name of the game.
- /// The type of activity. Default is .
+ /// The type of activity. Default is .
public Game(string name, ActivityType type = ActivityType.Playing)
{
Name = name;
diff --git a/src/Discord.Net.Core/Entities/AuditLogs/IAuditLogData.cs b/src/Discord.Net.Core/Entities/AuditLogs/IAuditLogData.cs
index 5d87c9d58..a99a14eda 100644
--- a/src/Discord.Net.Core/Entities/AuditLogs/IAuditLogData.cs
+++ b/src/Discord.Net.Core/Entities/AuditLogs/IAuditLogData.cs
@@ -1,7 +1,7 @@
namespace Discord
{
///
- /// Represents data applied to an .
+ /// Represents data applied to an .
///
public interface IAuditLogData
{ }
diff --git a/src/Discord.Net.Core/Entities/Channels/ReorderChannelProperties.cs b/src/Discord.Net.Core/Entities/Channels/ReorderChannelProperties.cs
index f114e0ef5..55427aec7 100644
--- a/src/Discord.Net.Core/Entities/Channels/ReorderChannelProperties.cs
+++ b/src/Discord.Net.Core/Entities/Channels/ReorderChannelProperties.cs
@@ -1,7 +1,7 @@
namespace Discord
{
///
- /// Properties that are used to reorder an .
+ /// Properties that are used to reorder an .
///
public class ReorderChannelProperties
{
diff --git a/src/Discord.Net.Core/Entities/Emotes/EmoteProperties.cs b/src/Discord.Net.Core/Entities/Emotes/EmoteProperties.cs
index de457a0dc..a52f81ca7 100644
--- a/src/Discord.Net.Core/Entities/Emotes/EmoteProperties.cs
+++ b/src/Discord.Net.Core/Entities/Emotes/EmoteProperties.cs
@@ -9,11 +9,11 @@ namespace Discord
public class EmoteProperties
{
///
- /// Gets or sets the name of the .
+ /// Gets or sets the name of the .
///
public Optional Name { get; set; }
///
- /// Gets or sets the roles that can access this .
+ /// Gets or sets the roles that can access this .
///
public Optional> Roles { get; set; }
}
diff --git a/src/Discord.Net.Core/Entities/Image.cs b/src/Discord.Net.Core/Entities/Image.cs
index 5c775f9f4..d5a9e26a3 100644
--- a/src/Discord.Net.Core/Entities/Image.cs
+++ b/src/Discord.Net.Core/Entities/Image.cs
@@ -11,7 +11,7 @@ namespace Discord
///
public Stream Stream { get; }
///
- /// Create the image with a .
+ /// Create the image with a .
///
///
/// The to create the image with. Note that this must be some type of stream
@@ -32,7 +32,7 @@ namespace Discord
/// The path to the file.
///
/// is a zero-length string, contains only white space, or contains one or more invalid
- /// characters as defined by .
+ /// characters as defined by .
///
/// is null.
///
diff --git a/src/Discord.Net.Core/Entities/Messages/Embed.cs b/src/Discord.Net.Core/Entities/Messages/Embed.cs
index b10473c00..7fa6f6f36 100644
--- a/src/Discord.Net.Core/Entities/Messages/Embed.cs
+++ b/src/Discord.Net.Core/Entities/Messages/Embed.cs
@@ -6,7 +6,7 @@ using System.Linq;
namespace Discord
{
///
- /// Represents an embed object seen in an .
+ /// Represents an embed object seen in an .
///
[DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class Embed : IEmbed
diff --git a/src/Discord.Net.Core/Entities/Messages/EmbedAuthor.cs b/src/Discord.Net.Core/Entities/Messages/EmbedAuthor.cs
index e596c0707..3b11f6a8b 100644
--- a/src/Discord.Net.Core/Entities/Messages/EmbedAuthor.cs
+++ b/src/Discord.Net.Core/Entities/Messages/EmbedAuthor.cs
@@ -3,7 +3,7 @@ using System.Diagnostics;
namespace Discord
{
///
- /// A author field of an .
+ /// A author field of an .
///
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public struct EmbedAuthor
diff --git a/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs b/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs
index 034d7eb73..ed411c8eb 100644
--- a/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs
+++ b/src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs
@@ -6,7 +6,7 @@ using System.Linq;
namespace Discord
{
///
- /// Represents a builder class for creating a .
+ /// Represents a builder class for creating a .
///
public class EmbedBuilder
{
@@ -122,28 +122,28 @@ namespace Discord
}
///
- /// Gets or sets the timestamp of an .
+ /// Gets or sets the timestamp of an .
///
///
/// The timestamp of the embed, or null if none is set.
///
public DateTimeOffset? Timestamp { get; set; }
///
- /// Gets or sets the sidebar color of an .
+ /// Gets or sets the sidebar color of an .
///
///
/// The color of the embed, or null if none is set.
///
public Color? Color { get; set; }
///
- /// Gets or sets the of an .
+ /// Gets or sets the of an .
///
///
/// The author field builder of the embed, or null if none is set.
///
public EmbedAuthorBuilder Author { get; set; }
///
- /// Gets or sets the of an .
+ /// Gets or sets the of an .
///
///
/// The footer field builder of the embed, or null if none is set.
@@ -172,7 +172,7 @@ namespace Discord
}
///
- /// Sets the title of an .
+ /// Sets the title of an .
///
/// The title to be set.
///
@@ -220,7 +220,7 @@ namespace Discord
return this;
}
///
- /// Sets the image URL of an .
+ /// Sets the image URL of an .
///
/// The image URL to be set.
///
@@ -243,7 +243,7 @@ namespace Discord
return this;
}
///
- /// Sets the timestamp of an .
+ /// Sets the timestamp of an .
///
/// The timestamp to be set.
///
@@ -255,7 +255,7 @@ namespace Discord
return this;
}
///
- /// Sets the sidebar color of an .
+ /// Sets the sidebar color of an .
///
/// The color to be set.
///
@@ -268,7 +268,7 @@ namespace Discord
}
///
- /// Sets the of an .
+ /// Sets the of an .
///
/// The author builder class containing the author field properties.
///
@@ -314,7 +314,7 @@ namespace Discord
return this;
}
///
- /// Sets the of an .
+ /// Sets the of an .
///
/// The footer builder class containing the footer field properties.
///
@@ -379,7 +379,7 @@ namespace Discord
///
/// Adds a field with the provided to an
- /// .
+ /// .
///
/// The field builder class containing the field properties.
/// Field count exceeds .
@@ -564,7 +564,7 @@ namespace Discord
/// Gets or sets the author name.
///
///
- /// Author name length is longer than .
+ /// Author name length is longer than .
///
///
/// The author name.
@@ -652,11 +652,11 @@ namespace Discord
/// Builds the author field to be used.
///
///
- /// Author name length is longer than .
+ /// Author name length is longer than .
/// - or -
- /// is not a well-formed .
+ /// is not a well-formed .
/// - or -
- /// is not a well-formed .
+ /// is not a well-formed .
///
///
/// The built author field.
@@ -682,7 +682,7 @@ namespace Discord
/// Gets or sets the footer text.
///
///
- /// Author name length is longer than .
+ /// Author name length is longer than .
///
///
/// The footer text.
@@ -743,7 +743,7 @@ namespace Discord
///
///
///
- /// length is longer than .
+ /// length is longer than .
/// - or -
/// is not a well-formed .
///
diff --git a/src/Discord.Net.Core/Entities/Messages/EmbedField.cs b/src/Discord.Net.Core/Entities/Messages/EmbedField.cs
index 5d8fd3c6b..12cdcec9b 100644
--- a/src/Discord.Net.Core/Entities/Messages/EmbedField.cs
+++ b/src/Discord.Net.Core/Entities/Messages/EmbedField.cs
@@ -3,7 +3,7 @@ using System.Diagnostics;
namespace Discord
{
///
- /// A field for an .
+ /// A field for an .
///
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public struct EmbedField
diff --git a/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs b/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs
index d02b2cdc3..aeddceb65 100644
--- a/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs
+++ b/src/Discord.Net.Core/Entities/Messages/EmbedVideo.cs
@@ -3,7 +3,7 @@ using System.Diagnostics;
namespace Discord
{
///
- /// A video featured in an .
+ /// A video featured in an .
///
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public struct EmbedVideo
diff --git a/src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs b/src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs
index 97735c42c..ff38f52e3 100644
--- a/src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs
+++ b/src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs
@@ -23,11 +23,11 @@ namespace Discord
=> new OverwritePermissions(0, ChannelPermissions.All(channel).RawValue);
///
- /// Gets a packed value representing all the allowed permissions in this .
+ /// Gets a packed value representing all the allowed permissions in this .
///
public ulong AllowValue { get; }
///
- /// Gets a packed value representing all the denied permissions in this .
+ /// Gets a packed value representing all the denied permissions in this .
///
public ulong DenyValue { get; }
diff --git a/src/Discord.Net.Core/Entities/Roles/ReorderRoleProperties.cs b/src/Discord.Net.Core/Entities/Roles/ReorderRoleProperties.cs
index e13083f1d..5d7a53c3e 100644
--- a/src/Discord.Net.Core/Entities/Roles/ReorderRoleProperties.cs
+++ b/src/Discord.Net.Core/Entities/Roles/ReorderRoleProperties.cs
@@ -1,7 +1,7 @@
namespace Discord
{
///
- /// Properties that are used to reorder an .
+ /// Properties that are used to reorder an .
///
public class ReorderRoleProperties
{
diff --git a/src/Discord.Net.Core/Entities/Roles/RoleProperties.cs b/src/Discord.Net.Core/Entities/Roles/RoleProperties.cs
index 54fa27bfd..ad057a827 100644
--- a/src/Discord.Net.Core/Entities/Roles/RoleProperties.cs
+++ b/src/Discord.Net.Core/Entities/Roles/RoleProperties.cs
@@ -14,7 +14,7 @@ namespace Discord
///
public Optional Name { get; set; }
///
- /// Gets or sets the role's .
+ /// Gets or sets the role's .
///
public Optional Permissions { get; set; }
///
diff --git a/src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs b/src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs
index 27a8be351..bea26e656 100644
--- a/src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs
+++ b/src/Discord.Net.Core/Entities/Users/GuildUserProperties.cs
@@ -27,7 +27,7 @@ namespace Discord
///
///
/// To clear the user's nickname, this value can be set to null or
- /// .
+ /// .
///
public Optional Nickname { get; set; }
///
diff --git a/src/Discord.Net.Core/Entities/Webhooks/WebhookProperties.cs b/src/Discord.Net.Core/Entities/Webhooks/WebhookProperties.cs
index 00af9f9ef..e5ee4d6aa 100644
--- a/src/Discord.Net.Core/Entities/Webhooks/WebhookProperties.cs
+++ b/src/Discord.Net.Core/Entities/Webhooks/WebhookProperties.cs
@@ -18,14 +18,14 @@ namespace Discord
/// Gets or sets the channel for this webhook.
///
///
- /// This field is not used when authenticated with .
+ /// This field is not used when authenticated with .
///
public Optional Channel { get; set; }
///
/// Gets or sets the channel ID for this webhook.
///
///
- /// This field is not used when authenticated with .
+ /// This field is not used when authenticated with .
///
public Optional ChannelId { get; set; }
}
diff --git a/src/Discord.Net.Core/RequestOptions.cs b/src/Discord.Net.Core/RequestOptions.cs
index 785b518f3..47cb8be70 100644
--- a/src/Discord.Net.Core/RequestOptions.cs
+++ b/src/Discord.Net.Core/RequestOptions.cs
@@ -47,7 +47,7 @@ namespace Discord
///
/// Initializes a new class with the default request timeout set in
- /// .
+ /// .
///
public RequestOptions()
{
diff --git a/src/Discord.Net.Rest/DiscordRestConfig.cs b/src/Discord.Net.Rest/DiscordRestConfig.cs
index 68fa68e03..7bf7440ce 100644
--- a/src/Discord.Net.Rest/DiscordRestConfig.cs
+++ b/src/Discord.Net.Rest/DiscordRestConfig.cs
@@ -3,7 +3,7 @@ using Discord.Net.Rest;
namespace Discord.Rest
{
///
- /// Represents a configuration class for .
+ /// Represents a configuration class for .
///
public class DiscordRestConfig : DiscordConfig
{
diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs
index 451aac373..ffd620e04 100644
--- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs
+++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs
@@ -71,7 +71,7 @@ namespace Discord.Rest
/// Gets a collection of permission overwrites that was assigned to the created channel.
///
///
- /// A collection of permission .
+ /// A collection of permission .
///
public IReadOnlyCollection Overwrites { get; }
}
diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs
index 7278b7b75..c56bf6d32 100644
--- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs
+++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs
@@ -62,7 +62,7 @@ namespace Discord.Rest
/// Gets a collection of permission overwrites that was assigned to the deleted channel.
///
///
- /// A collection of permission .
+ /// A collection of permission .
///
public IReadOnlyCollection Overwrites { get; }
}
diff --git a/src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs b/src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs
index 8cd497ffe..57ccd0207 100644
--- a/src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs
+++ b/src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs
@@ -164,7 +164,7 @@ namespace Discord.Rest
///
/// is a zero-length string, contains only white space, or contains one or more
- /// invalid characters as defined by .
+ /// invalid characters as defined by .
///
///
/// is null.
diff --git a/src/Discord.Net.Rest/Entities/Channels/RestDMChannel.cs b/src/Discord.Net.Rest/Entities/Channels/RestDMChannel.cs
index f4fd2009e..14d19bfa3 100644
--- a/src/Discord.Net.Rest/Entities/Channels/RestDMChannel.cs
+++ b/src/Discord.Net.Rest/Entities/Channels/RestDMChannel.cs
@@ -81,7 +81,7 @@ namespace Discord.Rest
///
///
/// is a zero-length string, contains only white space, or contains one or more
- /// invalid characters as defined by .
+ /// invalid characters as defined by .
///
///
/// is null.
diff --git a/src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs b/src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs
index f1c3b8c53..8461e24f3 100644
--- a/src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs
+++ b/src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs
@@ -98,7 +98,7 @@ namespace Discord.Rest
///
///
/// is a zero-length string, contains only white space, or contains one or more
- /// invalid characters as defined by .
+ /// invalid characters as defined by .
///
///
/// is null.
diff --git a/src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs b/src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs
index 97f34c521..2a9000f16 100644
--- a/src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs
+++ b/src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs
@@ -79,7 +79,7 @@ namespace Discord.Rest
///
///
/// is a zero-length string, contains only white space, or contains one or more
- /// invalid characters as defined by .
+ /// invalid characters as defined by .
///
///
/// is null.
diff --git a/src/Discord.Net.Rest/Entities/Messages/Attachment.cs b/src/Discord.Net.Rest/Entities/Messages/Attachment.cs
index 0f5aaf438..a2c7b9cf7 100644
--- a/src/Discord.Net.Rest/Entities/Messages/Attachment.cs
+++ b/src/Discord.Net.Rest/Entities/Messages/Attachment.cs
@@ -4,7 +4,7 @@ using Model = Discord.API.Attachment;
namespace Discord
{
///
- /// An attachment file seen in a .
+ /// An attachment file seen in a .
///
[DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class Attachment : IAttachment
diff --git a/src/Discord.Net.WebSocket/BaseSocketClient.cs b/src/Discord.Net.WebSocket/BaseSocketClient.cs
index ad00a49b4..29c08a4ef 100644
--- a/src/Discord.Net.WebSocket/BaseSocketClient.cs
+++ b/src/Discord.Net.WebSocket/BaseSocketClient.cs
@@ -107,18 +107,19 @@ namespace Discord.WebSocket
///
/// Gets a channel.
///
- /// The channel snowflake ID.
+ /// The channel snowflake identifier.
///
- /// A generic WebSocket-based channel object (voice, text, category, etc.); null when the
- /// channel cannot be found.
+ /// A generic WebSocket-based channel object (voice, text, category, etc.) associated with the identifier;
+ /// null when the channel cannot be found.
///
public abstract SocketChannel GetChannel(ulong id);
///
/// Gets a guild.
///
- /// The guild snowflake ID.
+ /// The guild snowflake identifier.
///
- /// A WebSocket-based guild; null when the guild cannot be found.
+ /// A WebSocket-based guild associated with the snowflake identifier; null when the guild cannot be
+ /// found.
///
public abstract SocketGuild GetGuild(ulong id);
///
diff --git a/src/Discord.Net.WebSocket/DiscordSocketConfig.cs b/src/Discord.Net.WebSocket/DiscordSocketConfig.cs
index d85230fec..3ac2a81a0 100644
--- a/src/Discord.Net.WebSocket/DiscordSocketConfig.cs
+++ b/src/Discord.Net.WebSocket/DiscordSocketConfig.cs
@@ -5,7 +5,7 @@ using Discord.Rest;
namespace Discord.WebSocket
{
///
- /// Represents a configuration class for .
+ /// Represents a configuration class for .
///
public class DiscordSocketConfig : DiscordRestConfig
{
diff --git a/src/Discord.Net.WebSocket/Entities/Channels/SocketChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/SocketChannel.cs
index e0fb93d6a..c4787c104 100644
--- a/src/Discord.Net.WebSocket/Entities/Channels/SocketChannel.cs
+++ b/src/Discord.Net.WebSocket/Entities/Channels/SocketChannel.cs
@@ -48,11 +48,11 @@ namespace Discord.WebSocket
///
///
/// This method does NOT attempt to fetch the user if they don't exist in the cache. To guarantee a return
- /// from an existing user that doesn't exist in cache, use .
+ /// from an existing user that doesn't exist in cache, use .
///
- /// The ID of the user.
+ /// The snowflake identifier of the user.
///
- /// The user.
+ /// A user object associated with the snowflake identifier.
///
public SocketUser GetUser(ulong id) => GetUserInternal(id);
internal abstract SocketUser GetUserInternal(ulong id);
diff --git a/src/Discord.Net.WebSocket/Entities/Channels/SocketGroupChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/SocketGroupChannel.cs
index 5a2dc4258..a97e402df 100644
--- a/src/Discord.Net.WebSocket/Entities/Channels/SocketGroupChannel.cs
+++ b/src/Discord.Net.WebSocket/Entities/Channels/SocketGroupChannel.cs
@@ -142,9 +142,9 @@ namespace Discord.WebSocket
///
///
/// This method does NOT attempt to fetch the user if they don't exist in the cache. To guarantee a return
- /// from an existing user that doesn't exist in cache, use .
+ /// from an existing user that doesn't exist in cache, use .
///
- /// The ID of the user.
+ /// The snowflake identifier of the user.
///
/// The user in the group.
///
diff --git a/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs
index b87205bcd..5909421d5 100644
--- a/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs
+++ b/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs
@@ -155,21 +155,21 @@ namespace Discord.WebSocket
public Task CreateWebhookAsync(string name, Stream avatar = null, RequestOptions options = null)
=> ChannelHelper.CreateWebhookAsync(this, Discord, name, avatar, options);
///
- /// Gets the webhook in this text channel with the provided ID.
+ /// Gets a webhook available in this text channel.
///
- /// The ID of the webhook.
+ /// The identifier of the webhook.
/// The options to be used when sending the request.
///
- /// A webhook associated with the , or null if not found.
+ /// An awaitable webhook associated with the identifier, or null if not found.
///
public Task GetWebhookAsync(ulong id, RequestOptions options = null)
=> ChannelHelper.GetWebhookAsync(this, Discord, id, options);
///
- /// Gets the webhooks for this text channel.
+ /// Gets the webhooks available in this text channel.
///
/// The options to be used when sending the request.
///
- /// A collection of webhooks.
+ /// An awaitable collection of webhooks.
///
public Task> GetWebhooksAsync(RequestOptions options = null)
=> ChannelHelper.GetWebhooksAsync(this, Discord, options);
diff --git a/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs b/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs
index ac9ed999c..77e356739 100644
--- a/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs
+++ b/src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs
@@ -530,7 +530,7 @@ namespace Discord.WebSocket
///
/// The options to be used when sending the request.
///
- /// A collection of invites.
+ /// An awaitable containing a collection of invites.
///
public Task> GetInvitesAsync(RequestOptions options = null)
=> GuildHelper.GetInvitesAsync(this, Discord, options);
diff --git a/src/Discord.Net.WebSocket/Entities/Messages/SocketReaction.cs b/src/Discord.Net.WebSocket/Entities/Messages/SocketReaction.cs
index 8df6d51b4..56b4c19e1 100644
--- a/src/Discord.Net.WebSocket/Entities/Messages/SocketReaction.cs
+++ b/src/Discord.Net.WebSocket/Entities/Messages/SocketReaction.cs
@@ -11,7 +11,7 @@ namespace Discord.WebSocket
/// Gets the ID of the user who added the reaction.
///
///
- /// A user snowflake ID.
+ /// A user snowflake identifier associated with the user.
///
public ulong UserId { get; }
///
@@ -25,15 +25,16 @@ namespace Discord.WebSocket
/// Gets the ID of the message that has been reacted to.
///
///
- /// A message snowflake ID.
+ /// A message snowflake identifier associated with the message.
///
public ulong MessageId { get; }
///
/// Gets the message that has been reacted to if possible.
///
///
- /// A WebSocket-based message where possible. This value is not always returned.
+ /// A WebSocket-based message where possible; a value is not always returned.
///
+ ///
public Optional Message { get; }
///
/// Gets the channel where the reaction takes place in.