Actually include the documentation in the nuget package

Add missing documentation

Author: calledude

AsyncMemoryCache/AsyncMemoryCache.cs

@@ -13,7 +13,7 @@ namespace AsyncMemoryCache;
 
 /// <summary>
 /// This interface exists mainly to avoid having concrete types as constructor arguments.
-/// An effect of this is enabling subsitution and as a result, easier testing, where an actual concrete instance is not required in each and every test that uses a class that looks like the following
+/// An effect of this is enabling substitution and as a result, easier testing, where an actual concrete instance is not required in each and every test that uses a class that looks like the following
 /// <para/>
 /// <code>
 /// public MyService(AsyncMemoryCache&lt;string, SomeCacheable&gt;) { }
@@ -71,6 +71,11 @@ public sealed class AsyncMemoryCache<TKey, TValue> : IAsyncDisposable, IAsyncMem
 	private readonly IDictionary<TKey, CacheEntity<TKey, TValue>> _cache;
 	private readonly ILogger<AsyncMemoryCache<TKey, TValue>> _logger;
 
+	/// <summary>
+	/// Creates a new instance of <see cref="AsyncMemoryCache{TKey, TValue}"/> with the supplied arguments.
+	/// </summary>
+	/// <param name="configuration">The <see cref="IAsyncMemoryCacheConfiguration{TKey, TValue}"/>.</param>
+	/// <param name="logger">The optional <see cref="ILogger{CategoryName}">ILogger</see>&lt;<see cref="AsyncMemoryCache{TKey, TValue}"></see>&gt;</param>
 	public AsyncMemoryCache(IAsyncMemoryCacheConfiguration<TKey, TValue> configuration, ILogger<AsyncMemoryCache<TKey, TValue>>? logger = null)
 	{
 #if NET8_0_OR_GREATER
@@ -146,6 +151,7 @@ public bool TryGetValue(TKey key, [NotNullWhen(true)] out CacheEntityReference<T
 		return false;
 	}
 
+	/// <inheritdoc/>
 	public async ValueTask DisposeAsync()
 	{
 		await _configuration.EvictionBehavior.DisposeAsync().ConfigureAwait(false);

AsyncMemoryCache/AsyncMemoryCache.csproj

@@ -9,6 +9,7 @@
 		<EnableNETAnalyzers>true</EnableNETAnalyzers>
 		<AnalysisLevel>preview</AnalysisLevel>
 
+		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 		<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
 		<CodeAnalysisTreatWarningsAsErrors>true</CodeAnalysisTreatWarningsAsErrors>
 	</PropertyGroup>

AsyncMemoryCache/AsyncMemoryCacheConfiguration.cs

@@ -16,6 +16,9 @@ public interface IAsyncMemoryCacheConfiguration<TKey, TValue>
 	where TKey : notnull
 	where TValue : IAsyncDisposable
 {
+	/// <summary>
+	/// The callback to be invoked when a cache item expires.
+	/// </summary>
 	Action<TKey, TValue>? CacheItemExpired { get; init; }
 
 	/// <summary>
@@ -38,6 +41,7 @@ public sealed class AsyncMemoryCacheConfiguration<TKey, TValue> : IAsyncMemoryCa
 	where TKey : notnull
 	where TValue : IAsyncDisposable
 {
+	/// <inheritdoc/>
 	public Action<TKey, TValue>? CacheItemExpired { get; init; }
 
 	/// <inheritdoc/>

AsyncMemoryCache/CacheEntity.cs

@@ -14,13 +14,26 @@ public sealed class CacheEntity<TKey, TValue>
 	where TKey : notnull
 	where TValue : IAsyncDisposable
 {
+	/// <summary>
+	/// Creates a new instance of <see cref="CacheEntity{TKey, TValue}"/> with the supplied arguments.
+	/// </summary>
+	/// <param name="key">The <typeparamref name="TKey"/>.</param>
+	/// <param name="objectFactory">The <see cref="Func{TResult}">Func</see>&lt;<see cref="Task{TValue}"></see>&gt;.</param>
+	/// <param name="lazyFlags">The <see cref="AsyncLazyFlags"/>.</param>
 	public CacheEntity(TKey key, Func<Task<TValue>> objectFactory, AsyncLazyFlags lazyFlags)
 	{
 		Key = key;
 		ObjectFactory = new(objectFactory, lazyFlags);
 	}
 
+	/// <summary>
+	/// The <typeparamref name="TKey"/>.
+	/// </summary>
 	public TKey Key { get; }
+
+	/// <summary>
+	/// The <see cref="AsyncLazy{T}">AsyncLazy</see>&lt;<typeparamref name="TValue"/>&gt; which represents the cache item creation method.
+	/// </summary>
 	public AsyncLazy<TValue> ObjectFactory { get; }
 
 	private int _references;

AsyncMemoryCache/CacheEntityReference.cs

@@ -17,8 +17,15 @@ public sealed class CacheEntityReference<TKey, TValue> : IDisposable
 {
 	private bool _disposed;
 
+	/// <summary>
+	/// The <see cref="CacheEntity{TKey, TValue}"/> which this object wraps.
+	/// </summary>
 	public CacheEntity<TKey, TValue> CacheEntity { get; }
 
+	/// <summary>
+	/// Creates a new instance of <see cref="CacheEntityReference{TKey, TValue}"/> with the supplied arguments.
+	/// </summary>
+	/// <param name="cacheEntity">The <see cref="CacheEntity{TKey, TValue}"/> to wrap.</param>
 	public CacheEntityReference(CacheEntity<TKey, TValue> cacheEntity)
 	{
 #if NET8_0_OR_GREATER
@@ -32,6 +39,10 @@ public CacheEntityReference(CacheEntity<TKey, TValue> cacheEntity)
 		_ = Interlocked.Increment(ref cacheEntity.References);
 	}
 
+	/// <summary>
+	/// The finalizer for <see cref="CacheEntityReference{TKey, TValue}"/>.
+	/// This serves as a fail-safe if <see cref="Dispose"/> is never called.
+	/// </summary>
 #if NET8_0_OR_GREATER
 	[ExcludeFromCodeCoverage(Justification = "Finalizers are unreliable in tests")]
 #endif
@@ -40,6 +51,7 @@ public CacheEntityReference(CacheEntity<TKey, TValue> cacheEntity)
 		Dispose();
 	}
 
+	/// <inheritdoc/>
 	public void Dispose()
 	{
 		if (_disposed)

AsyncMemoryCache/EvictionBehaviors/DefaultEvictionBehavior.cs

@@ -20,6 +20,11 @@ public sealed class DefaultEvictionBehavior : IEvictionBehavior
 	private readonly PeriodicTimer _timer;
 	private Task? _workerTask;
 
+	/// <summary>
+	/// Creates a new instance of <see cref="DefaultEvictionBehavior"/> with the supplied arguments.
+	/// </summary>
+	/// <param name="timeProvider">The <see cref="TimeProvider"/>.</param>
+	/// <param name="evictionCheckInterval">The interval to use when checking for expired items.</param>
 	public DefaultEvictionBehavior(TimeProvider? timeProvider = default, TimeSpan? evictionCheckInterval = default)
 	{
 		_interval = evictionCheckInterval ?? TimeSpan.FromSeconds(30);
@@ -29,13 +34,18 @@ public DefaultEvictionBehavior(TimeProvider? timeProvider = default, TimeSpan? e
 #else
 	private Timer? _timer;
 
+	/// <summary>
+	/// Creates a new instance of <see cref="DefaultEvictionBehavior"/> with the supplied arguments.
+	/// </summary>
+	/// <param name="evictionCheckInterval">The interval to use when checking for expired items.</param>
 	public DefaultEvictionBehavior(TimeSpan? evictionCheckInterval = default)
 	{
 		_cts = new();
 		_interval = evictionCheckInterval ?? TimeSpan.FromSeconds(30);
 	}
 #endif
 
+	/// <inheritdoc/>
 	public void Start<TKey, TValue>(IAsyncMemoryCacheConfiguration<TKey, TValue> configuration, ILogger<AsyncMemoryCache<TKey, TValue>> logger)
 		where TKey : notnull
 		where TValue : IAsyncDisposable
@@ -106,6 +116,7 @@ private static async Task CheckExpiredItems<TKey, TValue>(IAsyncMemoryCacheConfi
 		logger.LogTrace("Done checking expired items. Evicted {EvictedItemsCount} items.", expiredItems.Count);
 	}
 
+	/// <inheritdoc/>
 #if NET8_0_OR_GREATER
 	public async ValueTask DisposeAsync()
 	{

AsyncMemoryCache/EvictionBehaviors/EvictionBehavior.cs

@@ -3,6 +3,9 @@
 
 namespace AsyncMemoryCache.EvictionBehaviors;
 
+/// <summary>
+/// A class containing default values for implementations of <see cref="IEvictionBehavior"/>
+/// </summary>
 public static class EvictionBehavior
 {
 	/// <inheritdoc cref="DefaultEvictionBehavior"/>
@@ -15,6 +18,10 @@ public static class EvictionBehavior
 	public static readonly IEvictionBehavior Disabled = new NoOpEvictionBehavior();
 }
 
+/// <summary>
+/// An interface that can be used to implement custom eviction behaviors.
+/// See <see cref="EvictionBehavior"/> for default implementations.
+/// </summary>
 public interface IEvictionBehavior : IAsyncDisposable
 {
 	/// <summary>

AsyncMemoryCache/Extensions/CacheEntityReferenceExtensions.cs

@@ -3,6 +3,9 @@
 
 namespace AsyncMemoryCache.Extensions;
 
+/// <summary>
+/// A class containing extension methods to ease the configuration of a <see cref="CacheEntity{TKey, TValue}"/> object.
+/// </summary>
 public static class CacheEntityReferenceExtensions
 {
 	/// <summary>

AsyncMemoryCache/Extensions/ServiceCollectionExtensions.cs

@@ -3,6 +3,9 @@
 
 namespace AsyncMemoryCache.Extensions;
 
+/// <summary>
+/// A class containing extension methods to help with configuration of an <see cref="IServiceCollection"/>.
+/// </summary>
 public static class ServiceCollectionExtensions
 {
 	/// <summary>