From 580d30fcb502ee98e03a7a0c6e491bcf39b805da Mon Sep 17 00:00:00 2001
From: sarcasmloading <29299928+sarcasmloading@users.noreply.github.com>
Date: Wed, 11 Jul 2018 22:19:24 +1200
Subject: [PATCH] Fix some documentation issues and document some more audit
 log data types

---
 .../DataTypes/ChannelCreateAuditLogData.cs     |  3 ++-
 .../DataTypes/MemberRoleAuditLogData.cs        |  3 ++-
 .../DataTypes/MemberUpdateAuditLogData.cs      | 18 ++++++++++++++++++
 .../DataTypes/MessageDeleteAuditLogData.cs     | 16 ++++++++++++++++
 .../DataTypes/OverwriteCreateAuditLogData.cs   |  9 +++++++++
 .../DataTypes/OverwriteDeleteAuditLogData.cs   |  9 +++++++++
 6 files changed, 56 insertions(+), 2 deletions(-)

diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs
index d9b6f2ed5..2037bf874 100644
--- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs
+++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs
@@ -71,7 +71,8 @@ namespace Discord.Rest
         ///     Gets a collection of permission overwrites that was assigned to the created channel.
         /// </summary>
         /// <returns>
-        ///     A collection of permission <see cref="Overwrite"/>.
+        ///     A collection of permission <see cref="Overwrite"/>, containing the permission overwrites that were 
+        ///     assigned to the created channel.
         /// </returns>
         public IReadOnlyCollection<Overwrite> Overwrites { get; }
     }
diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleAuditLogData.cs
index 6b31c5a7e..4da2ca196 100644
--- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleAuditLogData.cs
+++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleAuditLogData.cs
@@ -36,7 +36,8 @@ namespace Discord.Rest
         ///     Gets a collection of role changes that were performed on the member.
         /// </summary>
         /// <returns>
-        ///     A read-only collection of <see cref="MemberRoleEditInfo"/>, containing the changes
+        ///     A read-only collection of <see cref="MemberRoleEditInfo"/>, containing the roles that were changed on
+        ///     this user.
         /// </returns>
         public IReadOnlyCollection<MemberRoleEditInfo> Roles { get; }
         /// <summary>
diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberUpdateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberUpdateAuditLogData.cs
index 9f8663bcb..f661aa276 100644
--- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberUpdateAuditLogData.cs
+++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberUpdateAuditLogData.cs
@@ -30,8 +30,26 @@ namespace Discord.Rest
             return new MemberUpdateAuditLogData(user, newNick, oldNick);
         }
 
+        /// <summary>
+        ///     Gets the user that the changes were performed on.
+        /// </summary>
+        /// <returns>
+        ///     A user object representing the user who the changes were performed on.
+        /// </returns>
         public IUser Target { get; }
+        /// <summary>
+        ///     Gets the new nickname of the user.
+        /// </summary>
+        /// <returns>
+        ///     A string containing the new nickname of the user; <c>null</c> if the user no longer has a nickname.
+        /// </returns>
         public string NewNick { get; }
+        /// <summary>
+        ///     Gets the old nickname of the user.
+        /// </summary>
+        /// <returns>
+        ///     A string containing the old nickname of the user; <c>null</c> if the user did not have a nickname.
+        /// </returns>
         public string OldNick { get; }
     }
 }
diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MessageDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MessageDeleteAuditLogData.cs
index 3949cdd68..48312ee32 100644
--- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MessageDeleteAuditLogData.cs
+++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MessageDeleteAuditLogData.cs
@@ -3,6 +3,9 @@ using EntryModel = Discord.API.AuditLogEntry;
 
 namespace Discord.Rest
 {
+    /// <summary>
+    ///     Contains audit log data related to message deletion(s).
+    /// </summary>
     public class MessageDeleteAuditLogData : IAuditLogData
     {
         private MessageDeleteAuditLogData(ulong channelId, int count)
@@ -16,7 +19,20 @@ namespace Discord.Rest
             return new MessageDeleteAuditLogData(entry.Options.MessageDeleteChannelId.Value, entry.Options.MessageDeleteCount.Value);
         }
 
+        /// <summary>
+        ///     Gets the number of messages that were deleted.
+        /// </summary>
+        /// <returns>
+        ///     An <see cref="int"/> representing the number of messages that were deleted from the channel.
+        /// </returns>
         public int MessageCount { get; }
+        /// <summary>
+        ///     Gets the ID of the channel that the messages were deleted from.
+        /// </summary>
+        /// <returns>
+        ///     A <see cref="ulong"/> representing the snowflake identifer for the channel that the messages were 
+        ///     deleted from.
+        /// </returns>
         public ulong ChannelId { get; }
     }
 }
diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteCreateAuditLogData.cs
index d58488136..ab6373333 100644
--- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteCreateAuditLogData.cs
+++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteCreateAuditLogData.cs
@@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry;
 
 namespace Discord.Rest
 {
+    /// <summary>
+    ///     Contains audit log data for a permissions overwrite creation.
+    /// </summary>
     public class OverwriteCreateAuditLogData : IAuditLogData
     {
         private OverwriteCreateAuditLogData(Overwrite overwrite)
@@ -32,6 +35,12 @@ namespace Discord.Rest
             return new OverwriteCreateAuditLogData(new Overwrite(id, target, permissions));
         }
 
+        /// <summary>
+        ///     Gets the permission overwrite object that was created.
+        /// </summary>
+        /// <returns>
+        ///     An <see cref="Overwrite"/> object representing the overwrite that was created.
+        /// </returns>
         public Overwrite Overwrite { get; }
     }
 }
diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteDeleteAuditLogData.cs
index dc2f4a6f0..3c19026e9 100644
--- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteDeleteAuditLogData.cs
+++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteDeleteAuditLogData.cs
@@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry;
 
 namespace Discord.Rest
 {
+    /// <summary>
+    ///     Contains audit log data related to the deletion of a permission overwrite.
+    /// </summary>
     public class OverwriteDeleteAuditLogData : IAuditLogData
     {
         private OverwriteDeleteAuditLogData(Overwrite deletedOverwrite)
@@ -31,6 +34,12 @@ namespace Discord.Rest
             return new OverwriteDeleteAuditLogData(new Overwrite(id, target, new OverwritePermissions(allow, deny)));
         }
 
+        /// <summary>
+        ///     Gets the permission overwrite object that was deleted.
+        /// </summary>
+        /// <returns>
+        ///     An <see cref="Overwrite"/> object representing the overwrite that was deleted.
+        /// </returns>
         public Overwrite Overwrite { get; }
     }
 }