From 17a4af71ee8062966bfe477d4d9ea68b490cfb77 Mon Sep 17 00:00:00 2001
From: Still Hsu <341464@gmail.com>
Date: Tue, 29 May 2018 17:15:10 +0800
Subject: [PATCH] Add documentation for new API version & few events

---
 src/Discord.Net.Core/DiscordConfig.cs         |  9 +++++-
 .../BaseSocketClient.Events.cs                | 32 +++++++++++++++----
 2 files changed, 34 insertions(+), 7 deletions(-)

diff --git a/src/Discord.Net.Core/DiscordConfig.cs b/src/Discord.Net.Core/DiscordConfig.cs
index c6ad799151..d0c1c3a84b 100644
--- a/src/Discord.Net.Core/DiscordConfig.cs
+++ b/src/Discord.Net.Core/DiscordConfig.cs
@@ -11,12 +11,19 @@ public class DiscordConfig
         ///     Returns the API version Discord.Net uses. 
         /// </summary>
         /// <returns>
-        ///     A 32-bit integer representing the API version that Discord.Net uses to communicate with Discord.
+        ///     An <see cref="int"/> representing the API version that Discord.Net uses to communicate with Discord.
         ///     <para>A list of available API version can be seen on the official 
         ///     <see href="https://discordapp.com/developers/docs/reference#api-versioning">Discord API documentation</see>
         ///     .</para>
         /// </returns>
         public const int APIVersion = 6;
+        /// <summary>
+        /// Returns the Voice API version Discord.Net uses.
+        /// </summary>
+        /// <returns>
+        ///     An <see cref="int"/> representing the API version that Discord.Net uses to communicate with Discord's
+        ///     voice server.
+        /// </returns>
         public const int VoiceAPIVersion = 3;
         /// <summary>
         ///     Gets the Discord.Net version, including the build number.
diff --git a/src/Discord.Net.WebSocket/BaseSocketClient.Events.cs b/src/Discord.Net.WebSocket/BaseSocketClient.Events.cs
index 9a94cbf235..db4eb9c94d 100644
--- a/src/Discord.Net.WebSocket/BaseSocketClient.Events.cs
+++ b/src/Discord.Net.WebSocket/BaseSocketClient.Events.cs
@@ -10,7 +10,7 @@ public partial class BaseSocketClient
         /// <remarks>
         ///     <para>
         ///         This event is fired when a generic channel has been created. The event handler must return a
-        ///         <see cref="Task"/>.
+        ///         <see cref="Task"/> and accept a <see cref="SocketChannel"/> as its parameter.
         ///     </para>
         ///     <para>
         ///         The newly created channel is passed into the event handler parameter. The given channel type may
@@ -28,7 +28,7 @@ public event Func<SocketChannel, Task> ChannelCreated
         /// <remarks>
         ///     <para>
         ///         This event is fired when a generic channel has been destroyed. The event handler must return a
-        ///         <see cref="Task"/>.
+        ///         <see cref="Task"/> and accept a <see cref="SocketChannel"/> as its parameter.
         ///     </para>
         ///     <para>
         ///         The destroyed channel is passed into the event handler parameter. The given channel type may
@@ -45,7 +45,7 @@ public event Func<SocketChannel, Task> ChannelDestroyed {
         /// <remarks>
         ///     <para>
         ///         This event is fired when a generic channel has been destroyed. The event handler must return a
-        ///         <see cref="Task"/>.
+        ///         <see cref="Task"/> and accept 2 <see cref="SocketChannel"/> as its parameters.
         ///     </para>
         ///     <para>
         ///         The original (prior to update) channel is passed into the first <see cref="SocketChannel"/>, while
@@ -65,13 +65,13 @@ public event Func<SocketChannel, SocketChannel, Task> ChannelUpdated {
         /// <remarks>
         ///     <para>
         ///         This event is fired when a message is received. The event handler must return a
-        ///         <see cref="Task"/>.
+        ///         <see cref="Task"/> and accept a <see cref="SocketMessage"/> as its parameter.
         ///     </para>
         ///     <para>
         ///         The message that is sent to the client is passed into the event handler parameter as
         ///         <see cref="SocketMessage"/>. This message may be a system message (i.e.
-        ///         <see cref="SocketSystemMessage"/>) or a user message (i.e. <see cref="SocketUserMessage"/>. See
-        ///         the derived clsases of <see cref="SocketMessage"/> for more details.
+        ///         <see cref="SocketSystemMessage"/>) or a user message (i.e. <see cref="SocketUserMessage"/>. See the
+        ///         derived clsases of <see cref="SocketMessage"/> for more details.
         ///     </para>
         /// </remarks>
         public event Func<SocketMessage, Task> MessageReceived {
@@ -108,6 +108,26 @@ public event Func<Cacheable<IMessage, ulong>, ISocketMessageChannel, Task> Messa
         }
         internal readonly AsyncEvent<Func<Cacheable<IMessage, ulong>, ISocketMessageChannel, Task>> _messageDeletedEvent = new AsyncEvent<Func<Cacheable<IMessage, ulong>, ISocketMessageChannel, Task>>();
         /// <summary> Fired when a message is updated. </summary>
+        /// <remarks>
+        ///     <para>
+        ///         This event is fired when a message is updated. The event handler must return a
+        ///         <see cref="Task"/> and accept a <see cref="Cacheable{TEntity,TId}"/>, <see cref="SocketMessage"/>,
+        ///         and <see cref="ISocketMessageChannel"/> as its parameters.
+        ///     </para>
+        ///     <para>
+        ///         If caching is enabled via <see cref="DiscordSocketConfig"/>, the
+        ///         <see cref="Cacheable{TEntity,TId}"/> entity will contain the original message; otherwise, in event
+        ///         that the message cannot be retrieved, the snowflake ID of the message is preserved in the 
+        ///         <see cref="ulong"/>.
+        ///     </para>
+        ///     <para>
+        ///         The updated message will be passed into the <see cref="SocketMessage"/> parameter.
+        ///     </para>
+        ///     <para>
+        ///         The source channel of the updated message will be passed into the 
+        ///         <see cref="ISocketMessageChannel"/> parameter.
+        ///     </para>
+        /// </remarks>
         public event Func<Cacheable<IMessage, ulong>, SocketMessage, ISocketMessageChannel, Task> MessageUpdated {
             add { _messageUpdatedEvent.Add(value); }
             remove { _messageUpdatedEvent.Remove(value); }