From 541b473d59f9dbb2b9171c81960658383243b20a Mon Sep 17 00:00:00 2001
From: sarcasmloading <29299928+sarcasmloading@users.noreply.github.com>
Date: Wed, 11 Jul 2018 23:00:35 +1200
Subject: [PATCH] Documented two more types

---
 .../DataTypes/OverwriteUpdateAuditLogData.cs  | 30 ++++++++++++++++++-
 .../AuditLogs/DataTypes/PruneAuditLogData.cs  | 18 +++++++++++
 2 files changed, 47 insertions(+), 1 deletion(-)

diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteUpdateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteUpdateAuditLogData.cs
index d000146c3..5746955a1 100644
--- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteUpdateAuditLogData.cs
+++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteUpdateAuditLogData.cs
@@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry;
 
 namespace Discord.Rest
 {
+    /// <summary>
+    ///     Contains audit log data related to the update of a permission overwrite.
+    /// </summary>
     public class OverwriteUpdateAuditLogData : IAuditLogData
     {
         private OverwriteUpdateAuditLogData(OverwritePermissions before, OverwritePermissions after, ulong targetId, PermissionTarget targetType)
@@ -35,10 +38,35 @@ namespace Discord.Rest
             return new OverwriteUpdateAuditLogData(beforePermissions, afterPermissions, entry.Options.OverwriteTargetId.Value, target);
         }
 
+        /// <summary>
+        ///     Gets the overwrite permissions before the changes.
+        /// </summary>
+        /// <returns>
+        ///     An overwrite permissions object representing the overwrite permissions that the overwrite had before 
+        ///     the changes were made.
+        /// </returns>
         public OverwritePermissions OldPermissions { get; }
+        /// <summary>
+        ///     Gets the overwrite permissions after the changes.
+        /// </summary>
+        /// <returns>
+        ///     An overwrite permissions object representing the overwrite permissions that the overwrite now has after
+        ///     the changes.
+        /// </returns>
         public OverwritePermissions NewPermissions { get; }
-
+        /// <summary>
+        ///     Gets the snowflake ID of the overwrite that has been updated.
+        /// </summary>
+        /// <returns>
+        ///     A <see cref="ulong"/> representing the snowflake identifier of the overwrite that has been updated.
+        /// </returns>
         public ulong OverwriteTargetId { get; }
+        /// <summary>
+        ///     Gets the target of the updated permission overwrite.
+        /// </summary>
+        /// <returns>
+        ///     The target of the updated permission overwrite.
+        /// </returns>
         public PermissionTarget OverwriteType { get; }
     }
 }
diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/PruneAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/PruneAuditLogData.cs
index 0005e304d..363a8eff3 100644
--- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/PruneAuditLogData.cs
+++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/PruneAuditLogData.cs
@@ -3,6 +3,9 @@ using EntryModel = Discord.API.AuditLogEntry;
 
 namespace Discord.Rest
 {
+    /// <summary>
+    ///     Contains audit log data related to a guild prune.
+    /// </summary>
     public class PruneAuditLogData : IAuditLogData
     {
         private PruneAuditLogData(int pruneDays, int membersRemoved)
@@ -16,7 +19,22 @@ namespace Discord.Rest
             return new PruneAuditLogData(entry.Options.PruneDeleteMemberDays.Value, entry.Options.PruneMembersRemoved.Value);
         }
 
+        /// <summary>
+        ///     Gets the threshold for a guild member to not be kicked.
+        /// </summary>
+        /// <returns>
+        ///     An <see cref="int"/> representing the amount of days that a member must have been seen in the server, 
+        ///     to avoid being kicked. (i.e. If a user has not been seen for more than PruneDays, they will be 
+        ///     kicked from the server)
+        /// </returns>
         public int PruneDays { get; }
+        /// <summary>
+        ///     Gets the number of members that were kicked during the purge.
+        /// </summary>
+        /// <returns>
+        ///     An <see cref="int"/> representing the number of members that were removed from this guild for having
+        ///     not been seen within PruneDays.
+        /// </returns>
         public int MembersRemoved { get; }
     }
 }