docs: add XML docs for exceptions

Signed-off-by: Kenny Pflug <kenny.pflug@live.de>
amantinband · May 9, 2024 · 6fffb3e · 6fffb3e
1 parent 73be4f7
commit 6fffb3e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/src/ErrorOr/ErrorOr.ImplicitConverters.cs b/src/ErrorOr/ErrorOr.ImplicitConverters.cs
@@ -21,6 +21,8 @@ public static implicit operator ErrorOr<TValue>(Error error)
     /// <summary>
     /// Creates an <see cref="ErrorOr{TValue}"/> from a list of errors.
     /// </summary>
+    /// <exception cref="ArgumentNullException">Thrown when <paramref name="errors"/> is null.</exception>
+    /// <exception cref="InvalidOperationException">Thrown when <paramref name="errors" /> is an empty list.</exception>
     public static implicit operator ErrorOr<TValue>(List<Error> errors)
     {
         if (errors is null)
@@ -39,6 +41,8 @@ public static implicit operator ErrorOr<TValue>(List<Error> errors)
     /// <summary>
     /// Creates an <see cref="ErrorOr{TValue}"/> from a list of errors.
     /// </summary>
+    /// <exception cref="ArgumentNullException">Thrown when <paramref name="errors"/> is null.</exception>
+    /// <exception cref="InvalidOperationException">Thrown when <paramref name="errors" /> is an empty array.</exception>
     public static implicit operator ErrorOr<TValue>(Error[] errors)
     {
         if (errors is null)

diff --git a/src/ErrorOr/ErrorOr.ToErrorOrExtensions.cs b/src/ErrorOr/ErrorOr.ToErrorOrExtensions.cs
@@ -19,10 +19,12 @@ public static ErrorOr<TValue> ToErrorOr<TValue>(this Error error)
     }
 
     /// <summary>
-    /// Creates an <see cref="ErrorOr{TValue}"/> instance with the given <paramref name="error"/>.
+    /// Creates an <see cref="ErrorOr{TValue}"/> instance with the given <paramref name="errors"/>.
     /// </summary>
-    public static ErrorOr<TValue> ToErrorOr<TValue>(this List<Error> error)
+    /// <exception cref="ArgumentNullException">Thrown when <paramref name="errors"/> is null.</exception>
+    /// <exception cref="InvalidOperationException">Thrown when <paramref name="errors" /> is an empty list.</exception>
+    public static ErrorOr<TValue> ToErrorOr<TValue>(this List<Error> errors)
     {
-        return error;
+        return errors;
     }
 }