Skip to content

Commit 8092728

Browse files
authored
docs (#257)
1 parent e4a9d16 commit 8092728

File tree

2 files changed

+21
-18
lines changed

2 files changed

+21
-18
lines changed

BitFaster.Caching/Lfu/ConcurrentLfuBuilder.cs

+9-6
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,16 @@ namespace BitFaster.Caching.Lfu
66
/// <summary>
77
/// A builder of ICache and IScopedCache instances with the following configuration
88
/// settings:
9-
/// - The maximum size.
10-
/// - The concurrency level.
11-
/// - The key comparer.
12-
/// - The buffer sizes.
13-
///
9+
/// <list type="bullet">
10+
/// <item><description>The maximum size.</description></item>
11+
/// <item><description>The concurrency level.</description></item>
12+
/// <item><description>The key comparer.</description></item>
13+
/// </list>
1414
/// The following features can be selected which change the underlying cache implementation:
15-
/// - Scoped IDisposable values.
15+
/// <list type="bullet">
16+
/// <item><description>Scoped IDisposable values.</description></item>
17+
/// <item><description>Atomic value factory.</description></item>
18+
/// </list>
1619
/// </summary>
1720
/// <typeparam name="K">The type of keys in the cache.</typeparam>
1821
/// <typeparam name="V">The type of values in the cache.</typeparam>

BitFaster.Caching/Lru/ConcurrentLruBuilder.cs

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
using System;
2-
using System.Collections.Generic;
3-
using System.Linq;
4-
using System.Text;
5-
using System.Threading.Tasks;
1+

62
using BitFaster.Caching.Lru.Builder;
73

84
namespace BitFaster.Caching.Lru
95
{
106
/// <summary>
117
/// A builder of ICache and IScopedCache instances with the following configuration
128
/// settings:
13-
/// - The maximum size.
14-
/// - The concurrency level.
15-
/// - The key comparer.
16-
///
9+
/// <list type="bullet">
10+
/// <item><description>The maximum size.</description></item>
11+
/// <item><description>The concurrency level.</description></item>
12+
/// <item><description>The key comparer.</description></item>
13+
/// </list>
1714
/// The following features can be selected which change the underlying cache implementation:
18-
/// - Collect metrics (e.g. hit rate). Small perf penalty.
19-
/// - Time based expiration, measured since write.
20-
/// - Scoped IDisposable values.
15+
/// <list type="bullet">
16+
/// <item><description>Collect metrics (e.g. hit rate). Small perf penalty.</description></item>
17+
/// <item><description>Time based expiration, measured since write.</description></item>
18+
/// <item><description>Scoped IDisposable values.</description></item>
19+
/// <item><description>Atomic value factory.</description></item>
20+
/// </list>
2121
/// </summary>
2222
/// <typeparam name="K">The type of keys in the cache.</typeparam>
2323
/// <typeparam name="V">The type of values in the cache.</typeparam>

0 commit comments

Comments
 (0)