Miscellaneous improvements

- Minor changes from analyzers tips.
- Add/fix Intellisense comments.

Author: josesimoes

Tests/UnitTestDebugLogging/MyTestComponent.cs

@@ -11,7 +11,7 @@ namespace UnitTestDebugLogging
 {
     internal class MyTestComponent
     {
-        private ILogger _logger;
+        private readonly ILogger _logger;
 
         public MyTestComponent()
         {

nanoFramework.Logging.Serial/SerialLogger.cs

@@ -3,22 +3,22 @@
 // See LICENSE file in the project root for full license information.
 //
 
-using System;
 using Microsoft.Extensions.Logging;
+using System;
 using Windows.Devices.SerialCommunication;
 using Windows.Storage.Streams;
 
 namespace nanoFramework.Logging.Serial
 {
     /// <summary>
-    /// A logger that prints to the debug console
+    /// A logger that outputs to a <see cref="SerialDevice"/>.
     /// </summary>
     public class SerialLogger : ILogger
     {
         private readonly DataWriter _outputDataWriter;
 
         /// <summary>
-        /// Creates a new instance of the <see cref="DebugLogger"/>
+        /// Creates a new instance of the <see cref="SerialLogger"/>
         /// </summary>
         /// <param name="serialDevice">The serial port to use</param>
         public SerialLogger(ref SerialDevice serialDevice)

nanoFramework.Logging.Serial/SerialLoggerFactory.cs

@@ -14,14 +14,29 @@ namespace nanoFramework.Logging.Serial
     public class SerialLoggerFactory : ILoggerFactory
     {
         private SerialDevice _serial;
-        private string _comPort;
-        private uint _baudRate;
-        private ushort _dataBits;
-        private SerialParity _parity;
-        private SerialStopBitCount _stopBits;
-        private SerialHandshake _handshake;
+        private readonly string _comPort;
+        private readonly uint _baudRate;
+        private readonly ushort _dataBits;
+        private readonly SerialParity _parity;
+        private readonly SerialStopBitCount _stopBits;
+        private readonly SerialHandshake _handshake;
 
-        public SerialLoggerFactory(string comPort, uint baudRate = 9600, ushort dataBits = 8, SerialParity parity = SerialParity.None, SerialStopBitCount stopBits = SerialStopBitCount.One, SerialHandshake handshake = SerialHandshake.None)
+        /// <summary>
+        /// Create a new instance of <see cref="SerialLoggerFactory"/> from a <see cref="SerialDevice"/>.
+        /// </summary>
+        /// <param name="comPort"></param>
+        /// <param name="baudRate"></param>
+        /// <param name="dataBits"></param>
+        /// <param name="parity"></param>
+        /// <param name="stopBits"></param>
+        /// <param name="handshake"></param>
+        public SerialLoggerFactory(
+            string comPort,
+            uint baudRate = 9600,
+            ushort dataBits = 8,
+            SerialParity parity = SerialParity.None,
+            SerialStopBitCount stopBits = SerialStopBitCount.One,
+            SerialHandshake handshake = SerialHandshake.None)
         {
             _comPort = comPort;
             _baudRate = baudRate;

nanoFramework.Logging.Stream/StreamLogger.cs

@@ -2,24 +2,24 @@
 // Copyright (c) .NET Foundation and Contributors
 // See LICENSE file in the project root for full license information.
 //
+using Microsoft.Extensions.Logging;
 using System;
 using System.IO;
 using System.Text;
-using Microsoft.Extensions.Logging;
 
 namespace nanoFramework.Logging.Stream
 {
     /// <summary>
-    /// A logger that prints to the debug console
+    /// A logger that outputs to a <see cref="Stream"/>.
     /// </summary>
     public class StreamLogger : ILogger, IDisposable
     {
         private System.IO.Stream _stream = null;
-       
+
         /// <summary>
-        /// Creates a new instance of the <see cref="DebugLogger"/>
+        /// Creates a new instance of the <see cref="ILogger"/>
         /// </summary>
-        /// <param name="fileName">fileName</param>
+        /// <param name="stream">Stream to output the log to.</param>
         public StreamLogger(System.IO.Stream stream)
         {
             _stream = stream;
@@ -51,9 +51,7 @@ public void Log(LogLevel logLevel, EventId eventId, string state, Exception exce
             }
         }
 
-        /// <summary>
-        /// Dispose properly the stream
-        /// </summary>
+        /// <inheritdoc/>
         public void Dispose()
         {
             if(_stream != null)

nanoFramework.Logging.Stream/StreamLoggerFactory.cs

@@ -12,10 +12,10 @@ namespace nanoFramework.Logging.Stream
     /// </summary>
     public class StreamLoggerFactory : ILoggerFactory
     {
-        private System.IO.Stream _stream;
+        private readonly System.IO.Stream _stream;
 
         /// <summary>
-        /// Create a new instance of Stream Logger Factory from a stream
+        /// Create a new instance of <see cref="StreamLoggerFactory"/> from a <see cref="Stream"/>.
         /// </summary>
         /// <param name="stream">The stream</param>
         public StreamLoggerFactory(System.IO.Stream stream)

nanoFramework.Logging/DebugLogger.cs

@@ -3,8 +3,8 @@
 // See LICENSE file in the project root for full license information.
 //
 
-using System;
 using Microsoft.Extensions.Logging;
+using System;
 
 namespace nanoFramework.Logging.Debug
 {

nanoFramework.Logging/DebugLoggerFactory.cs

@@ -21,6 +21,7 @@ public ILogger CreateLogger(string categoryName)
         /// <inheritdoc />
         public void Dispose()
         {
+            // nothing to do here
         }
     }
 }

nanoFramework.Logging/ILoggerFactory.cs

@@ -9,7 +9,7 @@ namespace Microsoft.Extensions.Logging
 {
     /// <summary>
     /// Represents a type used to configure the logging system and create instances of <see cref="ILogger"/> from
-    /// the registered <see cref="ILoggerProvider"/>s.
+    /// the registered <see cref="ILogger"/>s.
     /// </summary>
     public interface ILoggerFactory : IDisposable
     {

nanoFramework.Logging/LogDispatcher.cs

@@ -3,8 +3,8 @@
 // See LICENSE file in the project root for full license information.
 //
 
-using System;
 using Microsoft.Extensions.Logging;
+using System;
 
 namespace nanoFramework.Logging
 {
@@ -56,6 +56,7 @@ private class NullLogger : ILogger
         {
             public void Log(LogLevel logLevel, EventId eventId, string state, Exception exception)
             {
+                // nothing to do here
             }
 
             public bool IsEnabled(LogLevel logLevel)