#283 Adding xml documentation for the interfaces and public/protected methods.

Author: vaptsarov

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/DistributedCache/WithoutDistributedCache/IAndWithoutDistributedCache.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.Distributed.IDistributedCache"/> builder.
+    /// </summary>
     public interface IAndWithoutDistributedCache : IWithoutDistributedCache
     {
+        /// <summary>
+        /// AndAlso method for better readability when building <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/>.
+        /// </summary>
+        /// <returns></returns>
         IWithoutDistributedCache AndAlso();
     }
 }

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/DistributedCache/WithoutDistributedCache/IWithoutDistributedCache.cs

@@ -1,15 +1,38 @@
 namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data
 {
     using System.Collections.Generic;
+    using Microsoft.Extensions.Caching.Distributed;
 
+    /// <summary>
+    /// Used for building mocked <see cref="IDistributedCache"/>.
+    /// </summary>
     public interface IWithoutDistributedCache
     {
+        /// <summary>
+        /// Remove cache entry to the mocked <see cref="IDistributedCache"/>.
+        /// </summary>
+        /// <param name="key">Key of the cache entry.</param>
+        /// <returns>The same <see cref="IAndWithoutDistributedCache"/>.</returns>
         IAndWithoutDistributedCache WithoutEntry(object key);
 
+        /// <summary>
+        /// Remove cache entries to the mocked <see cref="IDistributedCache"/>.
+        /// </summary>
+        /// <param name="keys">Keys of the cache entries.</param>
+        /// <returns>The same <see cref="IAndWithoutDistributedCache"/>.</returns>
         IAndWithoutDistributedCache WithoutEntries(IEnumerable<object> keys);
 
+        /// <summary>
+        /// Remove cache params to the mocked <see cref="IDistributedCache"/>.
+        /// </summary>
+        /// <param name="keys">Keys of the cache entries.</param>
+        /// <returns>The same <see cref="IAndWithoutDistributedCache"/>.</returns>
         IAndWithoutDistributedCache WithoutEntries(params object[] keys);
 
+        /// <summary>
+        /// Clear all entries persisted into the <see cref="IDistributedCache"/>.
+        /// </summary>
+        /// <returns>The same <see cref="IAndWithoutDistributedCache"/>.</returns>
         IAndWithoutDistributedCache WithoutAllEntries();
     }
 }

src/MyTested.AspNetCore.Mvc.Caching/Builders/Data/DistributedCache/BaseDistributedCacheBuilder.cs

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

src/MyTested.AspNetCore.Mvc.Caching/Builders/Data/DistributedCache/WithoutDistributedCache/WithoutDistributedCacheBuilder.cs

@@ -1,9 +1,11 @@
 namespace MyTested.AspNetCore.Mvc.Builders.Data.DistributedCache.WithoutDistributedCache
 {
     using System;
+    using System.Collections.Generic;
     using Microsoft.Extensions.Caching.Distributed;
+    using MyTested.AspNetCore.Mvc.Builders.Contracts.Data;
 
-    public class WithoutDistributedCacheBuilder : BaseDistributedCacheBuilder
+    public class WithoutDistributedCacheBuilder : BaseDistributedCacheBuilder, IAndWithoutDistributedCache
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="WithoutDistributedCacheBuilder"/> class.
@@ -13,5 +15,32 @@ public WithoutDistributedCacheBuilder(IServiceProvider services)
             : base(services)
         {
         }
+
+        /// <inheritdoc />
+        public IAndWithoutDistributedCache WithoutAllEntries()
+        {
+            throw new NotImplementedException();
+        }
+
+        /// <inheritdoc />
+        public IAndWithoutDistributedCache WithoutEntries(IEnumerable<object> keys)
+        {
+            throw new NotImplementedException();
+        }
+
+        /// <inheritdoc />
+        public IAndWithoutDistributedCache WithoutEntries(params object[] keys)
+        {
+            throw new NotImplementedException();
+        }
+
+        /// <inheritdoc />
+        public IAndWithoutDistributedCache WithoutEntry(object key)
+        {
+            throw new NotImplementedException();
+        }
+
+        /// <inheritdoc />
+        public IWithoutDistributedCache AndAlso() => this;
     }
 }

src/MyTested.AspNetCore.Mvc.Caching/Builders/Data/MemoryCache/BaseMemoryCacheBuilder.cs

@@ -16,6 +16,10 @@ public abstract class BaseMemoryCacheBuilder
         public BaseMemoryCacheBuilder(IServiceProvider services)
             => this.MemoryCache = services.GetRequiredService<IMemoryCache>();
 
+        /// <summary>
+        /// Gets the mocked <see cref="IMemoryCache"/>.
+        /// </summary>
+        /// <value>Built <see cref="IMemoryCache"/>.</value>
         protected IMemoryCache MemoryCache { get; private set; }
     }
 }