Doccomments

Author: andrewvk

Main/src/Threading/AsyncLock.cs

@@ -25,6 +25,8 @@ public class AsyncLock
 		/// </param>
 		/// <param name="cancellation">The CancellationToken token to observe.</param>
 		/// <returns>A task that returns <see cref="IDisposable"/> to release the lock.</returns>
+		/// <exception cref="OperationCanceledException">The token has had cancellation requested.</exception>
+		/// <exception cref="TimeoutException">The timeout has expired.</exception>
 		[NotNull, ItemNotNull]
 		public async Task<IDisposable> AcquireAsync(TimeSpan timeout, CancellationToken cancellation)
 		{
@@ -46,6 +48,8 @@ public async Task<IDisposable> AcquireAsync(TimeSpan timeout, CancellationToken
 		/// </param>
 		/// <param name="cancellation">The CancellationToken token to observe.</param>
 		/// <returns>A task that returns <see cref="IDisposable"/> to release the lock.</returns>
+		/// <exception cref="OperationCanceledException">The token has had cancellation requested.</exception>
+		/// <exception cref="TimeoutException">The timeout has expired.</exception>
 		[NotNull, ItemNotNull]
 		public Task<IDisposable> AcquireAsync(int timeout, CancellationToken cancellation) =>
 			AcquireAsync(TimeSpan.FromMilliseconds(timeout), cancellation);
@@ -58,6 +62,7 @@ public Task<IDisposable> AcquireAsync(int timeout, CancellationToken cancellatio
 		/// indefinitely, or a 0 to return immediately.
 		/// </param>
 		/// <returns>A task that returns <see cref="IDisposable"/> to release the lock.</returns>
+		/// <exception cref="TimeoutException">The timeout has expired.</exception>
 		[NotNull, ItemNotNull]
 		public Task<IDisposable> AcquireAsync(int timeout) => AcquireAsync(TimeSpan.FromMilliseconds(timeout), CancellationToken.None);
 
@@ -70,6 +75,7 @@ public Task<IDisposable> AcquireAsync(int timeout, CancellationToken cancellatio
 		/// to return immediately.
 		/// </param>
 		/// <returns>A task that returns <see cref="IDisposable"/> to release the lock.</returns>
+		/// <exception cref="TimeoutException">The timeout has expired.</exception>
 		[NotNull, ItemNotNull]
 		public Task<IDisposable> AcquireAsync(TimeSpan timeout) => AcquireAsync(timeout, CancellationToken.None);
 
@@ -78,6 +84,7 @@ public Task<IDisposable> AcquireAsync(int timeout, CancellationToken cancellatio
 		/// </summary>
 		/// <param name="cancellation">The CancellationToken token to observe.</param>
 		/// <returns>A task that returns <see cref="IDisposable"/> to release the lock.</returns>
+		/// <exception cref="OperationCanceledException">The token has had cancellation requested.</exception>
 		[NotNull, ItemNotNull]
 		public Task<IDisposable> AcquireAsync(CancellationToken cancellation) => AcquireAsync(-1, cancellation);