docs (#169)

Author: bitfaster

BitFaster.Caching/CachePolicy.cs

@@ -6,6 +6,10 @@
 
 namespace BitFaster.Caching
 {
+    /// <summary>
+    /// Represents the cache policy. Cache policy is dependent on the parameters chosen
+    /// when constructing the cache.
+    /// </summary>
     public class CachePolicy
     {
         public CachePolicy(IBoundedPolicy eviction, ITimePolicy expireAfterWrite)
@@ -14,8 +18,16 @@ public CachePolicy(IBoundedPolicy eviction, ITimePolicy expireAfterWrite)
             this.ExpireAfterWrite = expireAfterWrite;
         }
 
+        /// <summary>
+        /// Gets the bounded size eviction policy. This policy evicts items from the cache
+        /// if it exceeds capacity.
+        /// </summary>
         public IBoundedPolicy Eviction { get; }
 
+        /// <summary>
+        /// Gets the expire after write policy, if any. This policy evicts items after a 
+        /// fixed duration since an entry's creation or most recent replacement.
+        /// </summary>
         public ITimePolicy ExpireAfterWrite { get; }
     }
 }

BitFaster.Caching/IAsyncCache.cs

@@ -28,6 +28,9 @@ public interface IAsyncCache<K, V> : IEnumerable<KeyValuePair<K, V>>
         /// </summary>
         ICacheEvents<K, V> Events { get; }
 
+        /// <summary>
+        /// Gets the cache policy.
+        /// </summary>
         CachePolicy Policy { get; }
 
         /// <summary>

BitFaster.Caching/IBoundedPolicy.cs

@@ -6,6 +6,9 @@
 
 namespace BitFaster.Caching
 {
+    /// <summary>
+    /// Represents a bounded size cache policy.
+    /// </summary>
     public interface IBoundedPolicy
     {
         /// <summary>

BitFaster.Caching/ICache.cs

@@ -33,6 +33,9 @@ public interface ICache<K, V> : IEnumerable<KeyValuePair<K, V>>
         /// </summary>
         ICacheEvents<K, V> Events { get; }
 
+        /// <summary>
+        /// Gets the cache policy.
+        /// </summary>
         CachePolicy Policy { get; }
 
         /// <summary>

BitFaster.Caching/IScopedAsyncCache.cs

@@ -32,6 +32,9 @@ public interface IScopedAsyncCache<K, V> : IEnumerable<KeyValuePair<K, Scoped<V>
         /// </remarks>
         ICacheEvents<K, Scoped<V>> Events { get; }
 
+        /// <summary>
+        /// Gets the cache policy.
+        /// </summary>
         CachePolicy Policy { get; }
 
         /// <summary>

BitFaster.Caching/IScopedCache.cs

@@ -37,6 +37,9 @@ public interface IScopedCache<K, V> : IEnumerable<KeyValuePair<K, Scoped<V>>> wh
         /// </remarks>
         ICacheEvents<K, Scoped<V>> Events { get; }
 
+        /// <summary>
+        /// Gets the cache policy.
+        /// </summary>
         CachePolicy Policy { get; }
 
         /// <summary>

BitFaster.Caching/ITimePolicy.cs

@@ -6,6 +6,9 @@
 
 namespace BitFaster.Caching
 {
+    /// <summary>
+    /// Represents a time based cache policy.
+    /// </summary>
     public interface ITimePolicy
     {
         /// <summary>

BitFaster.Caching/ScopedAsyncCache.cs

@@ -38,6 +38,7 @@ public ScopedAsyncCache(IAsyncCache<K, Scoped<V>> cache)
         ///<inheritdoc/>
         public ICacheEvents<K, Scoped<V>> Events => this.cache.Events;
 
+        ///<inheritdoc/>
         public CachePolicy Policy => this.cache.Policy;
 
         ///<inheritdoc/>

BitFaster.Caching/ScopedCache.cs

@@ -41,6 +41,7 @@ public ScopedCache(ICache<K, Scoped<V>> cache)
         ///<inheritdoc/>
         public ICacheEvents<K, Scoped<V>> Events => this.cache.Events;
 
+        ///<inheritdoc/>
         public CachePolicy Policy => this.cache.Policy;
 
         ///<inheritdoc/>