Browse Source

Add XML Docs

pull/1161/head
Still Hsu 7 years ago
parent
commit
27dc4831e8
No known key found for this signature in database GPG Key ID: 8601A145FDA95209
2 changed files with 10 additions and 1 deletions
  1. +9
    -0
      src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs
  2. +1
    -1
      src/Discord.Net.Rest/Entities/RestApplication.cs

+ 9
- 0
src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs View File

@@ -17,6 +17,9 @@ namespace Discord
/// <param name="isTTS">Whether the message should be read aloud by Discord or not.</param>
/// <param name="embed">The <see cref="EmbedType.Rich"/> <see cref="Embed"/> to be sent.</param>
/// <param name="options">The options to be used when sending the request.</param>
/// <returns>
/// An awaitable Task containing the message sent to the channel.
/// </returns>
Task<IUserMessage> SendMessageAsync(string text, bool isTTS = false, Embed embed = null, RequestOptions options = null);
#if FILESYSTEM
/// <summary>
@@ -32,6 +35,9 @@ namespace Discord
/// upload the file and refer to the file with "attachment://filename.ext" in the
/// <see cref="Discord.EmbedBuilder.ImageUrl"/>.
/// </remarks>
/// <returns>
/// An awaitable Task containing the message sent to the channel.
/// </returns>
Task<IUserMessage> SendFileAsync(string filePath, string text = null, bool isTTS = false, Embed embed = null, RequestOptions options = null);
#endif
/// <summary>
@@ -48,6 +54,9 @@ namespace Discord
/// upload the file and refer to the file with "attachment://filename.ext" in the
/// <see cref="Discord.EmbedBuilder.ImageUrl"/>.
/// </remarks>
/// <returns>
/// An awaitable Task containing the message sent to the channel.
/// </returns>
Task<IUserMessage> SendFileAsync(Stream stream, string filename, string text = null, bool isTTS = false, Embed embed = null, RequestOptions options = null);

/// <summary>


+ 1
- 1
src/Discord.Net.Rest/Entities/RestApplication.cs View File

@@ -6,7 +6,7 @@ using Model = Discord.API.Application;
namespace Discord.Rest
{
/// <summary>
/// Represents a REST entity that contains information about a Discord application created via the developer portal.
/// Represents a REST-based entity that contains information about a Discord application created via the developer portal.
/// </summary>
[DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class RestApplication : RestEntity<ulong>, IApplication


Loading…
Cancel
Save