diff --git a/src/Discord.Net.Core/Entities/Messages/TagHandling.cs b/src/Discord.Net.Core/Entities/Messages/TagHandling.cs index 667f7241b..eaadd6400 100644 --- a/src/Discord.Net.Core/Entities/Messages/TagHandling.cs +++ b/src/Discord.Net.Core/Entities/Messages/TagHandling.cs @@ -1,21 +1,39 @@ namespace Discord { - /// Specifies the handling type the tag should use. + /// + /// Specifies the handling type the tag should use. + /// + /// + /// public enum TagHandling { - /// Tag handling is ignored. - Ignore = 0, //<@53905483156684800> -> <@53905483156684800> - /// Removes the tag entirely. - Remove, //<@53905483156684800> -> - /// Resolves to username (e.g. @User). - Name, //<@53905483156684800> -> @Voltana - /// Resolves to username without mention prefix (e.g. User). - NameNoPrefix, //<@53905483156684800> -> Voltana - /// Resolves to username with discriminator value. (e.g. @User#0001). - FullName, //<@53905483156684800> -> @Voltana#8252 - /// Resolves to username with discriminator value without mention prefix. (e.g. User#0001). - FullNameNoPrefix, //<@53905483156684800> -> Voltana#8252 - /// Sanitizes the tag. - Sanitize //<@53905483156684800> -> <@53905483156684800> (w/ nbsp) + /// + /// Tag handling is ignored (e.g. <@53905483156684800> -> <@53905483156684800>). + /// + Ignore = 0, + /// + /// Removes the tag entirely. + /// + Remove, + /// + /// Resolves to username (e.g. <@53905483156684800> -> @Voltana). + /// + Name, + /// + /// Resolves to username without mention prefix (e.g. <@53905483156684800> -> Voltana). + /// + NameNoPrefix, + /// + /// Resolves to username with discriminator value. (e.g. <@53905483156684800> -> @Voltana#8252). + /// + FullName, + /// + /// Resolves to username with discriminator value without mention prefix. (e.g. <@53905483156684800> -> Voltana#8252). + /// + FullNameNoPrefix, + /// + /// Sanitizes the tag (e.g. <@53905483156684800> -> <@53905483156684800> (w/ nbsp)). + /// + Sanitize } } diff --git a/src/Discord.Net.Core/Utils/MentionUtils.cs b/src/Discord.Net.Core/Utils/MentionUtils.cs index edfd3b12c..ae506e142 100644 --- a/src/Discord.Net.Core/Utils/MentionUtils.cs +++ b/src/Discord.Net.Core/Utils/MentionUtils.cs @@ -16,16 +16,25 @@ namespace Discord /// /// Returns a mention string based on the user ID. /// + /// + /// A user mention string (e.g. <@80351110224678912>). + /// public static string MentionUser(ulong id) => MentionUser(id.ToString(), true); internal static string MentionChannel(string id) => $"<#{id}>"; /// /// Returns a mention string based on the channel ID. /// + /// + /// A channel mention string (e.g. <#103735883630395392>). + /// public static string MentionChannel(ulong id) => MentionChannel(id.ToString()); internal static string MentionRole(string id) => $"<@&{id}>"; /// /// Returns a mention string based on the role ID. /// + /// + /// A role mention string (e.g. <@&165511591545143296>). + /// public static string MentionRole(ulong id) => MentionRole(id.ToString()); ///