#283 Adding comments for the public methods and classes in WithoutCache components.

Author: vaptsarov

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/IAndWithoutMemoryCacheBuilder.cs

@@ -1,7 +1,14 @@
 namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data
 {
+    /// <summary>
+    /// Used for adding AndAlso() method to the <see cref="Microsoft.Extensions.Caching.Memory.IMemoryCache"/> builder.
+    /// </summary>
     public interface IAndWithoutMemoryCacheBuilder : IWithoutMemoryCacheBuilder
     {
+        /// <summary>
+        /// AndAlso method for better readability when building <see cref="Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
+        /// </summary>
+        /// <returns>The same <see cref="IWithoutMemoryCacheBuilder"/>.</returns>
         IWithoutMemoryCacheBuilder AndAlso();
     }
 }

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/IWithoutMemoryCacheBuilder.cs

@@ -1,13 +1,31 @@
 namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data
 {
+    using Microsoft.Extensions.Caching.Memory;
     using System.Collections.Generic;
 
+    /// <summary>
+    /// Used for building mocked <see cref="IMemoryCache"/>.
+    /// </summary>
     public interface IWithoutMemoryCacheBuilder
     {
+        /// <summary>
+        /// Remove cache entry to the mocked <see cref="IMemoryCache"/>.
+        /// </summary>
+        /// <param name="key">Key of the cache entry.</param>
+        /// <returns>The same <see cref="IAndWithoutMemoryCacheBuilder"/>.</returns>
         IAndWithoutMemoryCacheBuilder WithoutEntry(object key);
 
+        /// <summary>
+        /// Remove cache entries to the mocked <see cref="IMemoryCache"/>.
+        /// </summary>
+        /// <param name="keys">Keys of the cache entries.</param>
+        /// <returns>The same <see cref="IAndWithoutMemoryCacheBuilder"/>.</returns>
         IAndWithoutMemoryCacheBuilder WithoutEntries(IEnumerable<object> keys);
 
+        /// <summary>
+        /// Clear all entries persisted into the <see cref="IMemoryCache"/>.
+        /// </summary>
+        /// <returns>The same <see cref="IAndWithoutMemoryCacheBuilder"/>.</returns>
         IAndWithoutMemoryCacheBuilder ClearCache();
     }
 }

src/MyTested.AspNetCore.Mvc.Caching/Builders/Data/MemoryCacheBaseBuilder.cs

@@ -4,8 +4,15 @@
     using Microsoft.Extensions.DependencyInjection;
     using System;
 
+    /// <summary>
+    /// Used for building mocked <see cref="IMemoryCache"/>.
+    /// </summary>
     public abstract class MemoryCacheBaseBuilder
     {
+        /// <summary>
+        /// Abstract <see cref="MemoryCacheBaseBuilder"/> class.
+        /// </summary>
+        /// <param name="services"><see cref="IServiceProvider"/> providing the current <see cref="IMemoryCache"/>.</param>
         public MemoryCacheBaseBuilder(IServiceProvider services)
         {
             this.MemoryCache = services.GetRequiredService<IMemoryCache>();

src/MyTested.AspNetCore.Mvc.Caching/Builders/Data/MemoryCacheWithBuilder.cs

@@ -6,9 +6,7 @@
     using Microsoft.Extensions.Caching.Memory;
     using Utilities.Extensions;
 
-    /// <summary>
-    /// Used for building mocked <see cref="IMemoryCache"/>.
-    /// </summary>
+    /// <inheritdoc />
     public class MemoryCacheWithBuilder : MemoryCacheBaseBuilder, IAndWithMemoryCacheBuilder
     {
         /// <summary>

src/MyTested.AspNetCore.Mvc.Caching/Builders/Data/MemoryCacheWithoutBuilder.cs

@@ -3,30 +3,40 @@
     using System;
     using System.Collections.Generic;
     using Contracts.Data;
+    using Microsoft.Extensions.Caching.Memory;
     using Utilities.Extensions;
 
+    /// <inheritdoc />
     public class MemoryCacheWithoutBuilder : MemoryCacheBaseBuilder, IAndWithoutMemoryCacheBuilder
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MemoryCacheWithoutBuilder"/> class.
+        /// </summary>
+        /// <param name="services"><see cref="IServiceProvider"/> providing the current <see cref="IMemoryCache"/>.</param>
         public MemoryCacheWithoutBuilder(IServiceProvider services) : base(services) { }
 
+        /// <inheritdoc />
         public IAndWithoutMemoryCacheBuilder WithoutEntry(object key)
         {
             this.MemoryCache.Remove(key);
             return this;
         }
 
+        /// <inheritdoc />
         public IAndWithoutMemoryCacheBuilder WithoutEntries(IEnumerable<object> keys)
         {
             this.MemoryCache.AsMemoryCacheMock().RemoveKeys(keys);
             return this;
         }
 
+        /// <inheritdoc />
         public IAndWithoutMemoryCacheBuilder ClearCache()
         {
             this.MemoryCache.AsMemoryCacheMock().ClearCache();
             return this;
         }
 
+        /// <inheritdoc />
         public IWithoutMemoryCacheBuilder AndAlso() => this;
     }
 }

src/MyTested.AspNetCore.Mvc.Caching/ComponentBuilderCachingExtensions.cs

@@ -31,23 +31,50 @@ public static TBuilder WithMemoryCache<TBuilder>(
             return actualBuilder.Builder;
         }
 
+        /// <summary>
+        /// Clear all entities from <see cref="Microsoft.Extensions.Caching.Memory.IMemoryCache"/> service.
+        /// </summary>
+        /// <typeparam name="TBuilder">Class representing ASP.NET Core MVC test builder.</typeparam>
+        /// <param name="builder">Instance of <see cref="IBaseTestBuilderWithComponentBuilder{TBuilder}"/> type.</param>
+        /// <returns>The same component builder.</returns>
         public static TBuilder WithoutMemoryCache<TBuilder>(
             this IBaseTestBuilderWithComponentBuilder<TBuilder> builder)
             where TBuilder : IBaseTestBuilder
             => builder.WithoutMemoryCache(cache => cache.ClearCache());
 
+        /// <summary>
+        /// Remove given entity with key from <see cref="Microsoft.Extensions.Caching.Memory.IMemoryCache"/> service.
+        /// </summary>
+        /// <typeparam name="TBuilder">Class representing ASP.NET Core MVC test builder.</typeparam>
+        /// <param name="builder">Instance of <see cref="IBaseTestBuilderWithComponentBuilder{TBuilder}"/> type.</param>
+        /// <param name="key">Key of the entity that will be removed.</param>
+        /// <returns>The same component builder.</returns>
         public static TBuilder WithoutMemoryCache<TBuilder>(
             this IBaseTestBuilderWithComponentBuilder<TBuilder> builder, 
             object key)
             where TBuilder : IBaseTestBuilder
             => builder.WithoutMemoryCache(cache => cache.WithoutEntry(key));
 
+        /// <summary>
+        /// Remove given entities from <see cref="Microsoft.Extensions.Caching.Memory.IMemoryCache"/> service.
+        /// </summary>
+        /// <typeparam name="TBuilder">Class representing ASP.NET Core MVC test builder.</typeparam>
+        /// <param name="builder">Instance of <see cref="IBaseTestBuilderWithComponentBuilder{TBuilder}"/> type.</param>
+        /// <param name="keys">Keys of the entities that will be removed.</param>
+        /// <returns>The same component builder.</returns>
         public static TBuilder WithoutMemoryCache<TBuilder>(
             this IBaseTestBuilderWithComponentBuilder<TBuilder> builder,
             IEnumerable<object> keys)
             where TBuilder : IBaseTestBuilder
             => builder.WithoutMemoryCache(cache => cache.WithoutEntries(keys));
 
+        /// <summary>
+        /// Remove entity or entities from <see cref="Microsoft.Extensions.Caching.Memory.IMemoryCache"/> service.
+        /// </summary>
+        /// <typeparam name="TBuilder">Class representing ASP.NET Core MVC test builder.</typeparam>
+        /// <param name="builder">Instance of <see cref="IBaseTestBuilderWithComponentBuilder{TBuilder}"/> type.</param>
+        /// <param name="memoryCacheBuilder">Action setting the <see cref="Microsoft.Extensions.Caching.Memory.IMemoryCache"/> values by using <see cref="IWithMemoryCacheBuilder"/>.</param>
+        /// <returns>The same component builder.</returns>
         public static TBuilder WithoutMemoryCache<TBuilder>(
             this IBaseTestBuilderWithComponentBuilder<TBuilder> builder,
             Action<IWithoutMemoryCacheBuilder> memoryCacheBuilder)