From 9d0d2298b24e5a577fdcd3450968593c3f34c2c2 Mon Sep 17 00:00:00 2001
From: doomchild <lee.crabtree@gmail.com>
Date: Tue, 26 Nov 2024 17:45:39 -0600
Subject: [PATCH] Issue-104: Update XML docs with missing parameters

closes #104
SemVer:None
---
 src/TaskExtensions.cs            |  1 +
 src/TaskExtensionsIfFaulted.cs   |  3 +++
 src/TaskExtensionsIfFulfilled.cs |  1 +
 src/TaskExtensionsTap.cs         | 14 +++++++++++---
 src/TaskExtensionsThen.cs        | 15 ++++++++++++++-
 src/TaskExtras.cs                |  4 ++--
 6 files changed, 32 insertions(+), 6 deletions(-)

diff --git a/src/TaskExtensions.cs b/src/TaskExtensions.cs
index 9f9b2b3..b7fd2d6 100644
--- a/src/TaskExtensions.cs
+++ b/src/TaskExtensions.cs
@@ -58,6 +58,7 @@ private static Exception HandleCancellation<T>(this Task<T> task)
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TR">The type of the other input value to <paramref name="morphismTask"/>.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="morphismTask">A <see cref="Task{Func{T, TR, TNext}}"/> containing the transformation function. </param>
   /// <returns>The transformed task.</returns>
   public static Task<TNext> Ap<T, TNext>(
diff --git a/src/TaskExtensionsIfFaulted.cs b/src/TaskExtensionsIfFaulted.cs
index 333a637..6fc2d0a 100644
--- a/src/TaskExtensionsIfFaulted.cs
+++ b/src/TaskExtensionsIfFaulted.cs
@@ -12,6 +12,7 @@ public static partial class TaskExtensions
   /// Performs an action if the <see name="Task{T}"/> is in a faulted state.
   /// </summary>
   /// <typeparam name="T">The task's underlying type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFaulted">The action to perform if the task is faulted.</param>
   /// <returns>The task.</returns>
   public static Task<T> IfFaulted<T>(this Task<T> task, Action<Exception> onFaulted)
@@ -27,6 +28,7 @@ public static Task<T> IfFaulted<T>(this Task<T> task, Action<Exception> onFaulte
   /// </summary>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="R">The output task's underlying type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFaulted">The function to execute if the task is faulted.</param>
   /// <returns>The task.</returns>
   public static Task<T> IfFaulted<T, R>(this Task<T> task, Func<Exception, Task<R>> onFaulted)
@@ -64,6 +66,7 @@ public static Task<T> IfFaulted<T, R>(this Task<T> task, Func<Exception, Task<R>
   /// Executes a function and throws away the result if the <see name="Task{T}"/> is in a faulted state.
   /// </summary>
   /// <typeparam name="T">The task's underlying type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFaulted">The function to execute if the task is faulted.</param>
   /// <returns>The task.</returns>
   public static Task<T> IfFaulted<T>(this Task<T> task, Func<Exception, Task> onFaulted)
diff --git a/src/TaskExtensionsIfFulfilled.cs b/src/TaskExtensionsIfFulfilled.cs
index 246168c..850551b 100644
--- a/src/TaskExtensionsIfFulfilled.cs
+++ b/src/TaskExtensionsIfFulfilled.cs
@@ -12,6 +12,7 @@ public static partial class TaskExtensions
   /// Performs an action if the <see name="Task{T}"/> is in a fulfilled state.
   /// </summary>
   /// <typeparam name="T">The task's underlying type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="consumer">The action to perform if the task is fulfilled.</param>
   /// <returns>The task.</returns>
   public static Task<T> IfFulfilled<T>(this Task<T> task, Action<T> consumer)
diff --git a/src/TaskExtensionsTap.cs b/src/TaskExtensionsTap.cs
index d15fe4b..b5cf8e5 100644
--- a/src/TaskExtensionsTap.cs
+++ b/src/TaskExtensionsTap.cs
@@ -14,6 +14,7 @@ public static partial class TaskExtensions
   /// <remarks>This method is useful if you need to perform a side effect without altering the <see name"Task{T}"/>'s
   /// value, such as logging.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The function to execute if the task is fulfilled.</param>
   /// <param name="onFaulted">The function to execute if the task is faulted.</param>
   /// <returns>The task.</returns>
@@ -26,7 +27,8 @@ public static Task<T> Tap<T>(this Task<T> task, Action<T> onFulfilled, Action<Ex
   /// <remarks>This method is useful if you need to perform a side effect without altering the <see name"Task{T}"/>'s
   /// value, such as logging.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
-  /// <typeparam name="R">The output type of the <paramref name="onFaulted" /> function.
+  /// <typeparam name="R">The output type of the <paramref name="onFaulted" /> function.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The function to execute if the task is fulfilled.</param>
   /// <param name="onFaulted">The function to execute if the task is faulted.</param>
   /// <returns>The task.</returns>
@@ -39,6 +41,7 @@ public static Task<T> Tap<T, R>(this Task<T> task, Action<T> onFulfilled, Func<E
   /// <remarks>This method is useful if you need to perform a side effect without altering the <see name"Task{T}"/>'s
   /// value, such as logging.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The function to execute if the task is fulfilled.</param>
   /// <param name="onFaulted">The function to execute if the task is faulted.</param>
   /// <returns>The task.</returns>
@@ -51,7 +54,8 @@ public static Task<T> Tap<T>(this Task<T> task, Action<T> onFulfilled, Func<Exce
   /// <remarks>This method is useful if you need to perform a side effect without altering the <see name"Task{T}"/>'s
   /// value, such as logging.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
-  /// <typeparam name="R">The output type of the <paramref name="onFaulted" /> function.
+  /// <typeparam name="R">The output type of the <paramref name="onFaulted" /> function.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The action to perform if the task is fulfilled.</param>
   /// <param name="onFaulted">The function to execute if the task is faulted.</param>
   /// <returns>The task.</returns>
@@ -64,6 +68,7 @@ public static Task<T> Tap<T, R>(this Task<T> task, Func<T, Task<R>> onFulfilled,
   /// <remarks>This method is useful if you need to perform a side effect without altering the <see name"Task{T}"/>'s
   /// value, such as logging.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The function to execute if the task is fulfilled.</param>
   /// <param name="onFaulted">The function to execute if the task is faulted.</param>
   /// <returns>The task.</returns>
@@ -76,7 +81,8 @@ public static Task<T> Tap<T>(this Task<T> task, Func<T, Task> onFulfilled, Actio
   /// <remarks>This method is useful if you need to perform a side effect without altering the <see name"Task{T}"/>'s
   /// value, such as logging.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
-  /// <typeparam name="R">The output type of the <paramref name="onFaulted" /> function.
+  /// <typeparam name="R">The output type of the <paramref name="onFaulted" /> function.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The function to execute if the task is fulfilled.</param>
   /// <param name="onFaulted">The function to execute if the task is faulted.</param>
   /// <returns>The task.</returns>
@@ -89,6 +95,7 @@ public static Task<T> Tap<T, R, S>(this Task<T> task, Func<T, Task<R>> onFulfill
   /// <remarks>This method is useful if you need to perform a side effect without altering the <see name"Task{T}"/>'s
   /// value, such as logging.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The function to execute if the task is fulfilled.</param>
   /// <param name="onFaulted">The function to execute if the task is faulted.</param>
   /// <returns>The task.</returns>
@@ -101,6 +108,7 @@ public static Task<T> Tap<T>(this Task<T> task, Func<T, Task> onFulfilled, Func<
   /// <remarks>This method is useful if you need to perform a side effect without altering the <see name"Task{T}"/>'s
   /// value, such as logging.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The function to execute if the task is fulfilled.</param>
   /// <param name="onFaulted">The function to execute if the task is faulted.</param>
   /// <returns>The task.</returns>
diff --git a/src/TaskExtensionsThen.cs b/src/TaskExtensionsThen.cs
index c74a71a..6d5f477 100644
--- a/src/TaskExtensionsThen.cs
+++ b/src/TaskExtensionsThen.cs
@@ -14,6 +14,7 @@ public static partial class TaskExtensions
   /// <remarks>This method is an alias to <code>Task.ResultMap</code>.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The transformation function.</param>
   /// <returns>The transformed task.</returns>
   public static Task<TNext> Then<T, TNext>(this Task<T> task, Func<T, TNext> onFulfilled)
@@ -25,6 +26,7 @@ public static Task<TNext> Then<T, TNext>(this Task<T> task, Func<T, TNext> onFul
   /// <remarks>This method is an alias to <code>Task.Bind</code>.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The transformation function.</param>
   /// <returns>The transformed task.</returns>
   public static Task<TNext> Then<T, TNext>(this Task<T> task, Func<T, Task<TNext>> onFulfilled)
@@ -36,6 +38,7 @@ public static Task<TNext> Then<T, TNext>(this Task<T> task, Func<T, Task<TNext>>
   /// <remarks>This method is an alias to <code>Task.BiBind</code>.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The transformation function for a fulfilled task.</param>
   /// <param name="onFaulted">The transformation function for a faulted task.</param>
   /// <returns>The transformed task.</returns>
@@ -54,6 +57,7 @@ Func<Exception, TNext> onFaulted
   /// <remarks>This method is an alias to <code>Task.BiBind</code>.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The transformation function for a fulfilled task.</param>
   /// <param name="onFaulted">The transformation function for a faulted task.</param>
   /// <returns>The transformed task.</returns>
@@ -69,6 +73,7 @@ Func<Exception, Task<TNext>> onFaulted
   /// <remarks>This method is an alias to <code>Task.BiBind</code>.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The transformation function for a fulfilled task.</param>
   /// <param name="onFaulted">The transformation function for a faulted task.</param>
   /// <returns>The transformed task.</returns>
@@ -84,6 +89,7 @@ Func<Exception, TNext> onFaulted
   /// <remarks>This method is an alias to <code>Task.BiBind</code>.</remarks>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The transformation function for a fulfilled task.</param>
   /// <param name="onFaulted">The transformation function for a faulted task.</param>
   /// <returns>The transformed task.</returns>
@@ -96,7 +102,8 @@ Func<Exception, Task<TNext>> onFaulted
   /// <summary>
   /// Transforms the value in a fulfilled <see name="Task{T}"/> to another type.
   /// </summary>
-  /// <typeparam name="T">The task's underlying type.</typeparams>
+  /// <typeparam name="T">The task's underlying type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <typeparam name="TNext">The transformed type.</typeparam>
   /// <param name="onFulfilled">The transformation function.</param>
   /// <param name="cancellationToken">A cancellation token</param>
@@ -125,6 +132,7 @@ public static Task<TNext> Then<T, TNext>(
   /// </summary>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The transformation function for a fulfilled task.</param>
   /// <param name="onFaulted">The transformation function for a faulted task.</param>
   /// <param name="cancellationToken">A cancellation token.</param>
@@ -154,6 +162,7 @@ public static Task<TNext> Then<T, TNext>(
   /// </summary>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The transformation function for a fulfilled task.</param>
   /// <param name="onFaulted">The transformation function for a faulted task.</param>
   /// <param name="cancellationToken">A cancellation token.</param>
@@ -183,6 +192,7 @@ public static Task<TNext> Then<T, TNext>(
   /// </summary>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The transformation function for a fulfilled task.</param>
   /// <param name="onFaulted">The transformation function for a faulted task.</param>
   /// <param name="cancellationToken">A cancellation token.</param>
@@ -212,6 +222,7 @@ public static Task<TNext> Then<T, TNext>(
   /// </summary>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The transformation function for a fulfilled task.</param>
   /// <param name="onFaulted">The transformation function for a faulted task.</param>
   /// <param name="cancellationToken">A cancellation token.</param>
@@ -241,6 +252,7 @@ public static Task<TNext> Then<T, TNext>(
   /// </summary>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The transformation function for a fulfilled task.</param>
   /// <param name="onFaulted">The transformation function for a faulted task.</param>
   /// <param name="cancellationToken">A cancellation token.</param>
@@ -270,6 +282,7 @@ public static Task<TNext> Then<T, TNext>(
   /// </summary>
   /// <typeparam name="T">The task's underlying type.</typeparam>
   /// <typeparam name="TNext">The transformed type.</typeparam>
+  /// <param name="task">The task.</param>
   /// <param name="onFulfilled">The transformation function for a fulfilled task.</param>
   /// <param name="onFaulted">The transformation function for a faulted task.</param>
   /// <param name="cancellationToken">A cancellation token.</param>
diff --git a/src/TaskExtras.cs b/src/TaskExtras.cs
index c009b3f..43ffdb3 100644
--- a/src/TaskExtras.cs
+++ b/src/TaskExtras.cs
@@ -106,7 +106,7 @@ Func<Exception, T> fulfillmentMorphism
 		: Task.FromException<T>(value);
 
 	/// <summary>
-	/// Produces a fulfilled <see cref="Task{T}"/> using the output of the <paramref name="fulfillmentMorphism"/> if the
+	/// Produces a fulfilled <see cref="Task{T}"/> using the output of the <paramref name="resolutionSupplier"/> if the
 	/// <paramref name="predicate"/> returns <code>true</code>.
 	/// </summary>
 	/// <example>This is a handy way to return to a non-faulted state.  You might do something like the following:
@@ -121,7 +121,7 @@ Func<Exception, T> fulfillmentMorphism
 	/// </example>
 	/// <typeparam name="T">The task's underlying type.</typeparam>
 	/// <param name="predicate">A predicate to evaluate with the <see cref="Task{T}"/>'s <see cref="Exception"/>.</param>
-	/// <param name="fulfillmentMorphism">A function that takes an <see cref="Exception"/> and returns a
+	/// <param name="resolutionSupplier">A function that takes an <see cref="Exception"/> and returns a
 	/// <typeparamref name="T"/>.</param>
 	/// <returns>A function that performs fulfillment.</returns>
 	public static Func<Exception, Task<T>> ResolveIf<T>(