Browse Source

docs: update xmldoc for AllowedMentions type

pull/1455/head
Chris Johnston 5 years ago
parent
commit
be9f67cad4
1 changed files with 6 additions and 5 deletions
  1. +6
    -5
      src/Discord.Net.Core/Entities/Messages/AllowedMentions.cs

+ 6
- 5
src/Discord.Net.Core/Entities/Messages/AllowedMentions.cs View File

@@ -3,23 +3,24 @@ using System.Collections.Generic;
namespace Discord namespace Discord
{ {
/// <summary> /// <summary>
/// Defines which types of mentions will be parsed from a created message's content.
/// Defines which mentions and types of mentions will notify users from the message text.
/// </summary> /// </summary>
public class AllowedMentions public class AllowedMentions
{ {
/// <summary> /// <summary>
/// Gets or sets the allowed mention types to parse from the message content.
/// If <c>null</c>, no users will be notified.
/// Gets or sets the type of mentions that will notify users.
/// If <c>null</c>, only the role and user Ids specified in <see cref="RoleIds"/>
/// and <see cref="UserIds"/> respectively will be notified.
/// </summary> /// </summary>
public AllowedMentionTypes? AllowedTypes { get; set; } public AllowedMentionTypes? AllowedTypes { get; set; }


/// <summary> /// <summary>
/// Gets or sets the list of all role Ids that can be mentioned.
/// Gets or sets the list of all role Ids that will be mentioned.
/// </summary> /// </summary>
public List<ulong> RoleIds { get; set; } public List<ulong> RoleIds { get; set; }


/// <summary> /// <summary>
/// Gets or sets the list of all user Ids that can be mentioned.
/// Gets or sets the list of all user Ids that will be mentioned.
/// </summary> /// </summary>
public List<ulong> UserIds { get; set; } public List<ulong> UserIds { get; set; }
} }


Loading…
Cancel
Save