Optimize class summary and optimize code structure (#229)

* Add build script

* reactivate one unit test

* Update SmtpServerTests.cs

* Reactivate all unit tests

* Update SmtpServerTests.cs

* Update summary informations, coptimize code structure

* Reset SampleApp

* Optimize summary

* Fix unit tests warning

Support for 'async void' unit tests is being removed from xUnit.net v3.

Examples/SampleApp/Examples/CommonPortsExample.cs

@@ -1,8 +1,5 @@
-using System;
+using SmtpServer;
 using System.Security.Cryptography.X509Certificates;
-using System.Threading;
-using SmtpServer;
-using SmtpServer.ComponentModel;
 
 namespace SampleApp.Examples
 {

Examples/SampleApp/SampleMailClient.cs

@@ -60,4 +60,4 @@ public SmtpResponse SendUnknownCommand(string command, CancellationToken cancell
             }
         }
     }
-}
+}

Examples/SampleApp/SampleMailboxFilter.cs

@@ -70,4 +70,4 @@ public override async Task<bool> CanDeliverToAsync(
             return true;
         }
     }
-}
+}

Examples/SampleApp/SampleMessageStore.cs

@@ -45,4 +45,4 @@ public override async Task<SmtpResponse> SaveAsync(ISessionContext context, IMes
             return SmtpResponse.Ok;
         }
     }
-}
+}

Examples/SampleApp/SampleUserAuthenticator.cs

@@ -24,4 +24,4 @@ public override Task<bool> AuthenticateAsync(
             return Task.FromResult(user == "user" && password == "password");
         }
     }
-}
+}

Examples/SampleApp/TaskExtensions.cs

@@ -17,4 +17,4 @@ public static void WaitWithoutException(this Task task)
             }
         }
     }
-}
+}

Examples/WorkerService/ConsoleMessageStore.cs

@@ -36,4 +36,4 @@ public override async Task<SmtpResponse> SaveAsync(ISessionContext context, IMes
             return SmtpResponse.Ok;
         }
     }
-}
+}

Examples/WorkerService/Worker.cs

@@ -18,4 +18,4 @@ protected override Task ExecuteAsync(CancellationToken stoppingToken)
             return _smtpServer.StartAsync(stoppingToken);
         }
     }
-}
+}

Src/SmtpServer.Benchmarks/Program.cs

@@ -21,4 +21,4 @@ public static void Main(string[] args)
                     .With(ConfigOptions.DisableOptimizationsValidator));
         }
     }
-}
+}

Src/SmtpServer.Benchmarks/ThroughputBenchmarks.cs

@@ -67,4 +67,4 @@ public void Send4()
             _smtpClient.Send(Message4);
         }
     }
-}
+}

Src/SmtpServer.Benchmarks/TokenizerBenchmarks.cs

@@ -28,4 +28,4 @@ static IReadOnlyList<ArraySegment<byte>> Tokenize(params string[] text)
             return text.Select(t => new ArraySegment<byte>(Encoding.ASCII.GetBytes(t))).ToList();
         }
     }
-}
+}

Src/SmtpServer.Tests/MailClient.cs

@@ -96,4 +96,4 @@ public SmtpResponse SendUnknownCommand(string command, CancellationToken cancell
             return SendCommand(command, cancellationToken); 
         }
     }
-}
+}

Src/SmtpServer.Tests/PipeReaderTests.cs

@@ -19,7 +19,7 @@ static PipeReader CreatePipeReader(string text)
 
         [Fact]
         // ReSharper disable once InconsistentNaming
-        public async void CanReadLineAndRemoveTrailingCRLF()
+        public async Task CanReadLineAndRemoveTrailingCRLF()
         {
             // arrange
             var reader = CreatePipeReader("abcde\r\n");
@@ -34,7 +34,7 @@ public async void CanReadLineAndRemoveTrailingCRLF()
 
         [Fact]
         // ReSharper disable once InconsistentNaming
-        public async void CanReadLinesWithInconsistentCRLF()
+        public async Task CanReadLinesWithInconsistentCRLF()
         {
             // arrange
             var reader = CreatePipeReader("ab\rcd\ne\r\n");
@@ -49,7 +49,7 @@ public async void CanReadLinesWithInconsistentCRLF()
 
         [Fact]
         // ReSharper disable once InconsistentNaming
-        public async void CanReadMultipleLines()
+        public async Task CanReadMultipleLines()
         {
             // arrange
             var reader = CreatePipeReader("abcde\r\nfghij\r\nklmno\r\n");
@@ -66,7 +66,7 @@ public async void CanReadMultipleLines()
         }
 
         [Fact]
-        public async void CanReadBlockWithDotStuffingRemoved()
+        public async Task CanReadBlockWithDotStuffingRemoved()
         {
             // arrange
             var reader = CreatePipeReader("abcd\r\n..1234\r\n.\r\n");
@@ -85,4 +85,4 @@ await reader.ReadDotBlockAsync(
             Assert.Equal("abcd\r\n.1234", text);
         }
     }
-}
+}

Src/SmtpServer.Tests/SmtpParserTests.cs

@@ -689,4 +689,4 @@ public void CanNotMakeIPv6AddressLiteral(string input)
             Assert.False(result);
         }
     }
-}
+}

Src/SmtpServer.Tests/SmtpServerDisposable.cs

@@ -31,4 +31,4 @@ public void Dispose()
         /// </summary>
         public SmtpServer Server { get; }
     }
-}
+}

Src/SmtpServer.Tests/SmtpServerTests.cs

@@ -494,4 +494,4 @@ SmtpServerDisposable CreateServer(
         /// </summary>
         public CancellationTokenSource CancellationTokenSource { get; }
     }
-}
+}

Src/SmtpServer.Tests/TokenReaderTests.cs

@@ -121,4 +121,4 @@ static bool TryMakeNumber(ref TokenReader r)
             }
         }
     }
-}
+}

Src/SmtpServer/AssemblyInfo.cs

@@ -2,4 +2,4 @@
 
 [assembly: InternalsVisibleTo("SmtpServer.Tests")]
 [assembly: InternalsVisibleTo("SmtpServer.Benchmarks")]
-[assembly: InternalsVisibleTo("SampleApp")]
+[assembly: InternalsVisibleTo("SampleApp")]

Src/SmtpServer/Authentication/DelegatingUserAuthenticator.cs

@@ -4,6 +4,9 @@
 
 namespace SmtpServer.Authentication
 {
+    /// <summary>
+    /// Delegating User Authenticator
+    /// </summary>
     public sealed class DelegatingUserAuthenticator : UserAuthenticator
     {
         readonly Func<ISessionContext, string, string, bool> _delegate;
@@ -71,4 +74,4 @@ public override Task<bool> AuthenticateAsync(
             return Task.FromResult(_delegate(context, user, password));
         }
     }
-}
+}

Src/SmtpServer/Authentication/DelegatingUserAuthenticatorFactory.cs

@@ -2,10 +2,17 @@
 
 namespace SmtpServer.Authentication
 {
+    /// <summary>
+    /// Delegating User Authenticator Factory
+    /// </summary>
     public sealed class DelegatingUserAuthenticatorFactory : IUserAuthenticatorFactory
     {
         readonly Func<ISessionContext, IUserAuthenticator> _delegate;
 
+        /// <summary>
+        /// Delegating User Authenticator Factory
+        /// </summary>
+        /// <param name="delegate"></param>
         public DelegatingUserAuthenticatorFactory(Func<ISessionContext, IUserAuthenticator> @delegate)
         {
             _delegate = @delegate;
@@ -21,4 +28,4 @@ public IUserAuthenticator CreateInstance(ISessionContext context)
             return _delegate(context);
         }
     }
-}
+}

Src/SmtpServer/Authentication/IUserAuthenticator.cs

@@ -3,6 +3,9 @@
 
 namespace SmtpServer.Authentication
 {
+    /// <summary>
+    /// User Authenticator Interface
+    /// </summary>
     public interface IUserAuthenticator
     {
         /// <summary>
@@ -15,4 +18,4 @@ public interface IUserAuthenticator
         /// <returns>true if the user is authenticated, false if not.</returns>
         Task<bool> AuthenticateAsync(ISessionContext context, string user, string password, CancellationToken cancellationToken);
     }
-}
+}

Src/SmtpServer/Authentication/IUserAuthenticatorFactory.cs

@@ -2,5 +2,8 @@
 
 namespace SmtpServer.Authentication
 {
+    /// <summary>
+    /// User Authenticator Factory Interface
+    /// </summary>
     public interface IUserAuthenticatorFactory : ISessionContextInstanceFactory<IUserAuthenticator> { }
-}
+}

Src/SmtpServer/Authentication/UserAuthenticator.cs

@@ -3,6 +3,9 @@
 
 namespace SmtpServer.Authentication
 {
+    /// <summary>
+    /// User Authenticator
+    /// </summary>
     public abstract class UserAuthenticator : IUserAuthenticator
     {
         public static readonly IUserAuthenticator Default = new DefaultUserAuthenticator();
@@ -41,4 +44,4 @@ public override Task<bool> AuthenticateAsync(
             }
         }
     }
-}
+}

Src/SmtpServer/AuthenticationContext.cs

@@ -1,5 +1,8 @@
 namespace SmtpServer
 {
+    /// <summary>
+    /// Authentication Context
+    /// </summary>
     public sealed class AuthenticationContext
     {
         public static readonly AuthenticationContext Unauthenticated = new AuthenticationContext();
@@ -32,4 +35,4 @@ public AuthenticationContext(string user)
         /// </summary>
         public bool IsAuthenticated { get; }
     }
-}
+}

Src/SmtpServer/ComponentModel/DisposableContainer.cs

@@ -29,4 +29,4 @@ public void Dispose()
         /// </summary>
         internal TInstance Instance { get; }
     }
-}
+}

Src/SmtpServer/ComponentModel/ISessionContextInstanceFactory.cs

@@ -1,5 +1,9 @@
 namespace SmtpServer.ComponentModel
 {
+    /// <summary>
+    /// SessionContext Instance Factory Interface
+    /// </summary>
+    /// <typeparam name="TInstance"></typeparam>
     public interface ISessionContextInstanceFactory<out TInstance>
     {
         /// <summary>
@@ -9,4 +13,4 @@ public interface ISessionContextInstanceFactory<out TInstance>
         /// <returns>The service instance for the session context.</returns>
         TInstance CreateInstance(ISessionContext context);
     }
-}
+}

Src/SmtpServer/ComponentModel/ServiceProvider.cs

@@ -6,6 +6,9 @@
 
 namespace SmtpServer.ComponentModel
 {
+    /// <summary>
+    /// Service Provider
+    /// </summary>
     public sealed class ServiceProvider : IServiceProvider
     {
         public static readonly IServiceProvider Default = new ServiceProvider();
@@ -15,7 +18,10 @@ public sealed class ServiceProvider : IServiceProvider
         ISmtpCommandFactory _smtpCommandFactory;
         IMailboxFilterFactory _mailboxFilterFactory;
         IMessageStoreFactory _messageStoreFactory;
-
+
+        /// <summary>
+        /// Service Provider
+        /// </summary>
         public ServiceProvider()
         {
             Add(UserAuthenticator.Default);
@@ -130,4 +136,4 @@ public object GetService(Type serviceType)
             throw new NotSupportedException(serviceType.ToString());
         }
     }
-}
+}

Src/SmtpServer/ComponentModel/ServiceProviderExtensions.cs

@@ -31,4 +31,4 @@ internal static TService GetService<TServiceFactory, TService>(this IServiceProv
             return serviceProvider.GetServiceOrDefault(@default);
         }
     }
-}
+}

Src/SmtpServer/EndpointDefinitionBuilder.cs

@@ -6,6 +6,9 @@
 
 namespace SmtpServer
 {
+    /// <summary>
+    /// Endpoint Definition Builder
+    /// </summary>
     public sealed class EndpointDefinitionBuilder
     {
         readonly List<Action<EndpointDefinition>> _setters = new List<Action<EndpointDefinition>>();
@@ -207,4 +210,4 @@ public X509Certificate GetServerCertificate(ISessionContext sessionContext)
 
         #endregion
     }
-}
+}

Src/SmtpServer/Extensions/TaskExtensions.cs

@@ -4,6 +4,9 @@
 
 namespace SmtpServer
 {
+    /// <summary>
+    /// Task Extensions
+    /// </summary>
     static class TaskExtensions
     {
         /// <summary>
@@ -49,4 +52,4 @@ public static async Task<T> WithCancellation<T>(this Task<T> task, CancellationT
             return await task.ConfigureAwait(false);
         }
     }
-}
+}

Src/SmtpServer/ICertificateFactory.cs

@@ -2,6 +2,9 @@
 
 namespace SmtpServer
 {
+    /// <summary>
+    /// Certificate Factory Interface
+    /// </summary>
     public interface ICertificateFactory
     {
         /// <summary>

Src/SmtpServer/IEndpointDefinition.cs

@@ -1,10 +1,12 @@
 using System;
 using System.Net;
 using System.Security.Authentication;
-using System.Security.Cryptography.X509Certificates;
 
 namespace SmtpServer
 {
+    /// <summary>
+    /// Endpoint Definition Interface
+    /// </summary>
     public interface IEndpointDefinition
     {
         /// <summary>
@@ -42,4 +44,4 @@ public interface IEndpointDefinition
         /// </summary>
         SslProtocols SupportedSslProtocols { get; }
     }
-}
+}