Browse Source

Remove/fix invalid XMLdoc strings

pull/1379/head
Still Hsu 6 years ago
parent
commit
91cbd68e05
No known key found for this signature in database GPG Key ID: C176DD7907FF62A7
4 changed files with 7 additions and 7 deletions
  1. +4
    -3
      src/Discord.Net.Core/Entities/Channels/Direction.cs
  2. +2
    -2
      src/Discord.Net.Core/Entities/Guilds/IGuild.cs
  3. +1
    -1
      src/Discord.Net.Core/Entities/Users/IGuildUser.cs
  4. +0
    -1
      src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs

+ 4
- 3
src/Discord.Net.Core/Entities/Channels/Direction.cs View File

@@ -1,14 +1,15 @@
namespace Discord
{
/// <summary>
/// Specifies the direction of where message(s) should be retrieved from.
/// Specifies the direction of where message(s) should be retrieved from.
/// </summary>
/// <remarks>
/// This enum is used to specify the direction for retrieving messages.
/// <note type="important">
/// At the time of writing, <see cref="Around"/> is not yet implemented into
/// <see cref="IMessageChannel.GetMessagesAsync"/>. Attempting to use the method with <see cref="Around"/>
/// as its direction will throw a <see cref="System.NotImplementedException"/>.
/// <see cref="IMessageChannel.GetMessagesAsync(int, CacheMode, RequestOptions)"/>.
/// Attempting to use the method with <see cref="Around"/> will throw
/// a <see cref="System.NotImplementedException"/>.
/// </note>
/// </remarks>
public enum Direction


+ 2
- 2
src/Discord.Net.Core/Entities/Guilds/IGuild.cs View File

@@ -586,11 +586,11 @@ namespace Discord
/// <remarks>
/// This method requires you have an OAuth2 access token for the user, requested with the guilds.join scope, and that the bot have the MANAGE_INVITES permission in the guild.
/// </remarks>
/// <param name="id">The snowflake identifier of the user.</param>
/// <param name="userId">The snowflake identifier of the user.</param>
/// <param name="accessToken">The OAuth2 access token for the user, requested with the guilds.join scope.</param>
/// <param name="func">The delegate containing the properties to be applied to the user upon being added to the guild.</param>
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>A guild user associated with the specified <paramref name="id" />; <c>null</c> if the user is already in the guild.</returns>
/// <returns>A guild user associated with the specified <paramref name="userId" />; <c>null</c> if the user is already in the guild.</returns>
Task<IGuildUser> AddGuildUserAsync(ulong userId, string accessToken, Action<AddGuildUserProperties> func = null, RequestOptions options = null);
/// <summary>
/// Gets a collection of all users in this guild.


+ 1
- 1
src/Discord.Net.Core/Entities/Users/IGuildUser.cs View File

@@ -73,7 +73,7 @@ namespace Discord
/// </summary>
/// <example>
/// The following example checks if the current user has the ability to send a message with attachment in
/// this channel; if so, uploads a file via <see cref="IMessageChannel.SendFileAsync"/>.
/// this channel; if so, uploads a file via <see cref="IMessageChannel.SendFileAsync(string, string, bool, Embed, RequestOptions, bool)"/>.
/// <code language="cs">
/// if (currentUser?.GetPermissions(targetChannel)?.AttachFiles)
/// await targetChannel.SendFileAsync("fortnite.png");


+ 0
- 1
src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs View File

@@ -294,7 +294,6 @@ namespace Discord.Rest
/// <summary>
/// Gets a collection of all text channels in this guild.
/// </summary>
/// <param name="mode">The <see cref="CacheMode"/> that determines whether the object should be fetched from cache.</param>
/// <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 read-only collection of


Loading…
Cancel
Save