docs (#255)

Author: bitfaster

BitFaster.Caching/Buffers/MpmcBoundedBuffer.cs

@@ -9,10 +9,7 @@ namespace BitFaster.Caching.Buffers
     /// Provides a multi-producer, multi-consumer thread-safe ring buffer. When the buffer is full,
     /// TryAdd fails and returns false. When the buffer is empty, TryTake fails and returns false.
     /// </summary>
-    /// <remarks>
-    /// Based on the Segment internal class from ConcurrentQueue
-    /// https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.CoreLib/src/System/Collections/Concurrent/ConcurrentQueueSegment.cs
-    /// </remarks>
+    /// Based on the Segment internal class from the .NET ConcurrentQueue class.
     public sealed class MpmcBoundedBuffer<T>
     {
         private Slot[] slots;

BitFaster.Caching/Buffers/MpscBoundedBuffer.cs

@@ -8,10 +8,7 @@ namespace BitFaster.Caching.Buffers
     /// Provides a multi-producer, single-consumer thread-safe ring buffer. When the buffer is full,
     /// TryAdd fails and returns false. When the buffer is empty, TryTake fails and returns false.
     /// </summary>
-    /// <remarks>
-    /// Based on BoundedBuffer by Ben Manes.
-    /// https://github.com/ben-manes/caffeine/blob/master/caffeine/src/main/java/com/github/benmanes/caffeine/cache/BoundedBuffer.java
-    /// </remarks>
+    /// Based on the BoundedBuffer class in the Caffeine library by [email protected] (Ben Manes).
     [DebuggerDisplay("Count = {Count}/{Capacity}")]
     public sealed class MpscBoundedBuffer<T> where T : class
     {

BitFaster.Caching/Counters/Counter.cs

@@ -9,6 +9,7 @@ namespace BitFaster.Caching.Counters
     /// <summary>
     /// A thread-safe counter suitable for high throuhgput counting across many concurrent threads.
     /// </summary>
+    /// Based on the LongAdder class by Doug Lea.
     public sealed class Counter : Striped64
     {
         /// <summary>

BitFaster.Caching/Lfu/CmSketch.cs

@@ -8,10 +8,8 @@ namespace BitFaster.Caching.Lfu
     /// accumulated count across all values over time, such that a historic popular value will decay to zero frequency
     /// over time if it is not accessed.
     /// </summary>
-    /// <remarks>
     /// This is a direct C# translation of FrequencySketch in the Caffeine library by [email protected] (Ben Manes).
     /// https://github.com/ben-manes/caffeine
-    /// </remarks>
     public sealed class CmSketch<T>
     {
         // A mixture of seeds from FNV-1a, CityHash, and Murmur3

BitFaster.Caching/Lfu/ConcurrentLfu.cs

@@ -37,10 +37,8 @@ namespace BitFaster.Caching.Lfu
     /// hill climbing algorithm. A larger window favors workloads with high recency bias, whereas a larger main space
     /// favors workloads with frequency bias.
     /// </summary>
-    /// <remarks>
     /// Based on the Caffeine library by [email protected] (Ben Manes).
     /// https://github.com/ben-manes/caffeine
-    /// </remarks>
     [DebuggerTypeProxy(typeof(ConcurrentLfu<,>.LfuDebugView))]
     [DebuggerDisplay("Count = {Count}/{Capacity}")]
     public sealed class ConcurrentLfu<K, V> : ICache<K, V>, IAsyncCache<K, V>, IBoundedPolicy