From 393cbbeb23170016d6e1256be0fcafc92986717e Mon Sep 17 00:00:00 2001
From: Christopher F <foxbot@protonmail.com>
Date: Sat, 14 Oct 2017 15:52:25 -0400
Subject: [PATCH] Fixed spelling of LogAdapter, added docstrings

---
 .../Extensions.cs                             | 11 ++++-
 .../LogAdapter.cs                             | 44 +++++++++++++++++++
 .../LogAdaptor.cs                             | 29 ------------
 3 files changed, 54 insertions(+), 30 deletions(-)
 create mode 100644 src/Discord.Net.MicrosoftLogging/LogAdapter.cs
 delete mode 100644 src/Discord.Net.MicrosoftLogging/LogAdaptor.cs

diff --git a/src/Discord.Net.MicrosoftLogging/Extensions.cs b/src/Discord.Net.MicrosoftLogging/Extensions.cs
index c654e78b2..1232a8a7f 100644
--- a/src/Discord.Net.MicrosoftLogging/Extensions.cs
+++ b/src/Discord.Net.MicrosoftLogging/Extensions.cs
@@ -5,9 +5,18 @@ namespace Discord.MicrosoftLogging
 {
     public static class Extensions
     {
+        /// <summary>
+        /// Configure this Discord client with support for Microsoft's logging abstractions
+        /// </summary>
+        /// <param name="client">The Discord client to hook into</param>
+        /// <param name="logger">A logger created for logging to</param>
+        /// <param name="formatter">
+        /// A custom message formatter, should the default one not suffice. 
+        /// 
+        /// See <see cref="LogAdapter(ILogger, Func{LogMessage, Exception, string})"/> for more information.</param>
         public static void UseMicrosoftLogging(this IDiscordClient client, ILogger logger, Func<LogMessage, Exception, string> formatter = null)
         {
-            var adaptor = new LogAdaptor(logger, formatter);
+            var adaptor = new LogAdapter(logger, formatter);
             client.Log += adaptor.Log;
         }
     }
diff --git a/src/Discord.Net.MicrosoftLogging/LogAdapter.cs b/src/Discord.Net.MicrosoftLogging/LogAdapter.cs
new file mode 100644
index 000000000..18cf75aaa
--- /dev/null
+++ b/src/Discord.Net.MicrosoftLogging/LogAdapter.cs
@@ -0,0 +1,44 @@
+using System;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+
+namespace Discord.MicrosoftLogging
+{
+    public class LogAdapter
+    {
+        private readonly ILogger _logger;
+        private readonly Func<LogMessage, Exception, string> _formatter;
+
+        /// <summary>
+        /// Creates a LogAdapter to be used with a Discord client
+        /// </summary>
+        /// <param name="logger">The logger implementation that messages will be written to</param>
+        /// <param name="formatter">
+        /// A custom message formatter, should the default be inadequate.
+        /// 
+        /// The default message formatter simply returns <see cref="LogMessage.ToString()"/>, which 
+        /// in most cases should not be a problem.
+        /// </param>
+        public LogAdapter(ILogger logger, Func<LogMessage, Exception, string> formatter = null)
+        {
+            _logger = logger;
+            _formatter = formatter ?? DefaultFormatter;
+        }
+
+        /// <summary>
+        /// Convert a Discord.Net log event to an abstract log event
+        /// </summary>
+        /// <param name="message">The log event to be converted</param>
+        /// <returns>A task for compatibility with Discord.Net's async events</returns>
+        public Task Log(LogMessage message)
+        {
+            _logger.Log(GetLogLevel(message.Severity), default(EventId), message, message.Exception, _formatter);
+            return Task.Delay(0);
+        }
+
+        private string DefaultFormatter(LogMessage message, Exception _)
+            => message.ToString();
+        private static LogLevel GetLogLevel(LogSeverity severity)
+            => (LogLevel)(Math.Abs((int)severity - 5));
+    }
+}
diff --git a/src/Discord.Net.MicrosoftLogging/LogAdaptor.cs b/src/Discord.Net.MicrosoftLogging/LogAdaptor.cs
deleted file mode 100644
index e0dc02044..000000000
--- a/src/Discord.Net.MicrosoftLogging/LogAdaptor.cs
+++ /dev/null
@@ -1,29 +0,0 @@
-using System;
-using System.Threading.Tasks;
-using Microsoft.Extensions.Logging;
-
-namespace Discord.MicrosoftLogging
-{
-    public class LogAdaptor
-    {
-        private readonly ILogger _logger;
-        private readonly Func<LogMessage, Exception, string> _formatter;
-
-        public LogAdaptor(ILogger logger, Func<LogMessage, Exception, string> formatter = null)
-        {
-            _logger = logger;
-            _formatter = formatter ?? DefaultFormatter;
-        }
-
-        public Task Log(LogMessage message)
-        {
-            _logger.Log(GetLogLevel(message.Severity), default(EventId), message, message.Exception, _formatter);
-            return Task.Delay(0);
-        }
-
-        private string DefaultFormatter(LogMessage message, Exception _)
-            => message.ToString();
-        private static LogLevel GetLogLevel(LogSeverity severity)
-            => (LogLevel)(Math.Abs((int)severity - 5));
-    }
-}