Added documentation on every class in the main namespace (#193)

Author: ivaylokenov

src/MyTested.AspNetCore.Mvc.Abstractions/MyApplication.cs

@@ -5,23 +5,38 @@
     using Builders.Contracts.Application;
     using Internal.Application;
 
+    /// <summary>
+    /// Provides methods to set up the ASP.NET Core MVC test application.
+    /// </summary>
     public class MyApplication : ApplicationConfigurationBuilder
     {
         static MyApplication()
         {
             TestApplication.TryInitialize();
         }
-
+        
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MyApplication"/> class.
+        /// </summary>
         public MyApplication()
             : this(null)
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MyApplication"/> class.
+        /// </summary>
+        /// <param name="startupType">Startup class to bootstrap the test application from.</param>
         public MyApplication(Type startupType)
             : base(startupType)
         {
         }
-        
+
+        /// <summary>
+        /// Specifies the Startup class from which the test application is bootstrapped.
+        /// </summary>
+        /// <typeparam name="TStartup">Startup class to bootstrap the test application from.</typeparam>
+        /// <returns>Builder of <see cref="IApplicationConfigurationBuilder"/> type.</returns>
         public static IApplicationConfigurationBuilder StartsFrom<TStartup>()
             where TStartup : class
         {

src/MyTested.AspNetCore.Mvc.Abstractions/ServiceCollectionAbstractionsExtensions.cs

@@ -16,6 +16,11 @@
     /// </summary>
     public static class ServiceCollectionAbstractionsExtensions
     {
+        /// <summary>
+        /// Adds core MVC testing services.
+        /// </summary>
+        /// <param name="serviceCollection">Instance of <see cref="IServiceCollection"/> type.</param>
+        /// <returns>The same <see cref="IServiceCollection"/>.</returns>
         public static IServiceCollection AddCoreTesting(this IServiceCollection serviceCollection)
         {
             CommonValidator.CheckForNullReference(serviceCollection, nameof(serviceCollection));

src/MyTested.AspNetCore.Mvc.Authentication/HttpRequestBuilderAuthenticationExtensions.cs

@@ -6,6 +6,9 @@
     using Builders.Http;
     using System;
 
+    /// <summary>
+    /// Contains authentication extension methods for <see cref="IHttpRequestBuilder"/>.
+    /// </summary>
     public static class HttpRequestBuilderAuthenticationExtensions
     {
         /// <summary>

src/MyTested.AspNetCore.Mvc.Controllers/ActionAttributes.cs

@@ -4,6 +4,9 @@
     using System.Collections.Generic;
     using Utilities.Validators;
 
+    /// <summary>
+    /// Class used for specifying additional assertions on the action attributes.
+    /// </summary>
     public class ActionAttributes : IEnumerable<object>
     {
         private readonly IEnumerable<object> attributes;

src/MyTested.AspNetCore.Mvc.Controllers/ControllerAttributes.cs

@@ -4,6 +4,9 @@
     using System.Collections.Generic;
     using Utilities.Validators;
 
+    /// <summary>
+    /// Class used for specifying additional assertions on the controller attributes.
+    /// </summary>
     public class ControllerAttributes : IEnumerable<object>
     {
         private readonly IEnumerable<object> attributes;

src/MyTested.AspNetCore.Mvc.Controllers/MyController.cs

@@ -6,6 +6,10 @@
     using Internal.Application;
     using Internal.TestContexts;
 
+    /// <summary>
+    /// Provides methods to specify an ASP.NET Core MVC controller test case.
+    /// </summary>
+    /// <typeparam name="TController">Type of ASP.NET Core MVC controller to test.</typeparam>
     public class MyController<TController> : ControllerBuilder<TController>
         where TController : class
     {
@@ -14,31 +18,56 @@ static MyController()
             TestApplication.TryInitialize();
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MyController{TController}"/> class.
+        /// </summary>
         public MyController()
             : this((TController)null)
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MyController{TController}"/> class.
+        /// </summary>
+        /// <param name="controller">Instance of the ASP.NET Core MVC controller to test.</param>
         public MyController(TController controller)
             : this(() => controller)
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MyController{TController}"/> class.
+        /// </summary>
+        /// <param name="construction">Construction function returning the instantiated controller.</param>
         public MyController(Func<TController> construction)
             : base(new ControllerTestContext { ComponentConstructionDelegate = construction })
         {
         }
 
+        /// <summary>
+        /// Starts a controller test.
+        /// </summary>
+        /// <returns>Test builder of <see cref="IControllerBuilder{TController}"/> type.</returns>
         public static IControllerBuilder<TController> Instance()
         {
             return Instance((TController)null);
         }
 
+        /// <summary>
+        /// Starts a controller test.
+        /// </summary>
+        /// <param name="controller">Instance of the ASP.NET Core MVC controller to test.</param>
+        /// <returns>Test builder of <see cref="IControllerBuilder{TController}"/> type.</returns>
         public static IControllerBuilder<TController> Instance(TController controller)
         {
             return Instance(() => controller);
         }
 
+        /// <summary>
+        /// Starts a controller test.
+        /// </summary>
+        /// <param name="construction">Construction function returning the instantiated controller.</param>
+        /// <returns>Test builder of <see cref="IControllerBuilder{TController}"/> type.</returns>
         public static IControllerBuilder<TController> Instance(Func<TController> construction)
         {
             return new MyController<TController>(construction);

src/MyTested.AspNetCore.Mvc.Controllers/ServiceCollectionControllersExtensions.cs

@@ -24,6 +24,11 @@ public static IServiceCollection AddActionContextAccessor(this IServiceCollectio
             return serviceCollection.AddSingleton<IActionContextAccessor, ActionContextAccessor>();
         }
 
+        /// <summary>
+        /// Adds controller testing services.
+        /// </summary>
+        /// <param name="serviceCollection">Instance of <see cref="IServiceCollection"/> type.</param>
+        /// <returns>The same <see cref="IServiceCollection"/>.</returns>
         public static IServiceCollection AddControllersTesting(this IServiceCollection serviceCollection)
         {
             CommonValidator.CheckForNullReference(serviceCollection, nameof(serviceCollection));

src/MyTested.AspNetCore.Mvc.Core/ServiceCollectionCoreExtensions.cs

@@ -3,8 +3,16 @@
     using Microsoft.Extensions.DependencyInjection;
     using Utilities.Validators;
 
+    /// <summary>
+    /// Contains extension methods for <see cref="IServiceCollection"/>.
+    /// </summary>
     public static class ServiceCollectionCoreExtensions
     {
+        /// <summary>
+        /// Adds core MVC testing services.
+        /// </summary>
+        /// <param name="serviceCollection">Instance of <see cref="IServiceCollection"/> type.</param>
+        /// <returns>The same <see cref="IServiceCollection"/>.</returns>
         public static IServiceCollection AddMvcCoreTesting(this IServiceCollection serviceCollection)
         {
             CommonValidator.CheckForNullReference(serviceCollection, nameof(serviceCollection));

src/MyTested.AspNetCore.Mvc.Http/ServiceCollectionHttpExtensions.cs

@@ -8,6 +8,9 @@
     using Utilities.Validators;
     using Internal.Formatters;
 
+    /// <summary>
+    /// Contains HTTP extension methods for <see cref="IServiceCollection"/>.
+    /// </summary>
     public static class ServiceCollectionHttpExtensions
     {
         /// <summary>
@@ -21,6 +24,11 @@ public static IServiceCollection AddHttpContextAccessor(this IServiceCollection
             return serviceCollection.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
         }
 
+        /// <summary>
+        /// Adds an <see cref="IInputFormatter"/> which can process "text/plain" media type. Useful for testing with HTTP request body.
+        /// </summary>
+        /// <param name="serviceCollection">Instance of <see cref="IServiceCollection"/> type.</param>
+        /// <returns>The same <see cref="IServiceCollection"/>.</returns>
         public static IServiceCollection AddStringInputFormatter(this IServiceCollection serviceCollection)
         {
             CommonValidator.CheckForNullReference(serviceCollection, nameof(IServiceCollection));

src/MyTested.AspNetCore.Mvc.Routing/MyRouting.cs

@@ -7,13 +7,19 @@
     using Internal.Configuration;
     using Internal.TestContexts;
 
+    /// <summary>
+    /// Provides methods to specify an ASP.NET Core MVC route test case.
+    /// </summary>
     public class MyRouting : RouteTestBuilder
     {
         static MyRouting()
         {
             TestApplication.TryInitialize();
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MyRouting"/> class.
+        /// </summary>
         public MyRouting()
             : base(new RouteTestContext
             {
@@ -27,6 +33,10 @@ public MyRouting()
             }
         }
 
+        /// <summary>
+        /// Starts a route test.
+        /// </summary>
+        /// <returns>Test builder of <see cref="IRouteTestBuilder"/> type.</returns>
         public static IRouteTestBuilder Configuration()
         {
             return new MyRouting();