From 2596a80dfd24ad48f8de7215e4171b3aa583961d Mon Sep 17 00:00:00 2001
From: Pim Brouwers <pimnation@gmail.com>
Date: Wed, 28 Aug 2024 14:53:33 -0400
Subject: [PATCH] see refs in comments for option result and result option

---
 src/Danom/Option/Option.cs             | 44 +++++++++----------
 src/Danom/Result/Result.cs             | 60 +++++++++++++-------------
 src/Danom/ResultOption/ResultOption.cs | 20 ++++-----
 3 files changed, 61 insertions(+), 63 deletions(-)

diff --git a/src/Danom/Option/Option.cs b/src/Danom/Option/Option.cs
index a1f3aa7..1c49320 100644
--- a/src/Danom/Option/Option.cs
+++ b/src/Danom/Option/Option.cs
@@ -20,17 +20,17 @@ private Option(T t)
     }
 
     /// <summary>
-    /// Returns true if Option is Some, false otherwise.
+    /// Returns true if <see cref="Option{T}"/> is Some, false otherwise.
     /// </summary>
     public bool IsSome { get; } = false;
 
     /// <summary>
-    /// Returns true if Option is None, false otherwise.
+    /// Returns true if <see cref="Option{T}"/> is None, false otherwise.
     /// </summary>
     public bool IsNone => !IsSome;
 
     /// <summary>
-    /// If Option is Some evaluate the some delegate, otherwise none.
+    /// If <see cref="Option{T}"/> is Some evaluate the some delegate, otherwise none.
     /// </summary>
     /// <typeparam name="U"></typeparam>
     /// <param name="some"></param>
@@ -42,7 +42,7 @@ public U Match<U>(Func<T, U> some, Func<U> none) =>
             none();
 
     /// <summary>
-    /// Evaluates the bind delegate if Option is Some otherwise return None.
+    /// Evaluates the bind delegate if <see cref="Option{T}"/> is Some otherwise return None.
     /// </summary>
     /// <typeparam name="U"></typeparam>
     /// <param name="bind"></param>
@@ -52,7 +52,7 @@ public Option<U> Bind<U>(
         Match(bind, Option<U>.None);
 
     /// <summary>
-    /// Evaluates the map delegate if Option is Some otherwise return None.
+    /// Evaluates the map delegate if <see cref="Option{T}"/> is Some otherwise return None.
     /// </summary>
     /// <typeparam name="U"></typeparam>
     /// <param name="map"></param>
@@ -62,7 +62,7 @@ public Option<U> Map<U>(
         Bind(x => Option<U>.Some(map(x)));
 
     /// <summary>
-    /// Returns the value of Option if it is T otherwise return default.
+    /// Returns the value of <see cref="Option{T}"/> if it is T otherwise return default.
     /// </summary>
     /// <param name="defaultValue"></param>
     /// <returns></returns>
@@ -71,7 +71,7 @@ public T DefaultValue(
          Match(some => some, () => defaultValue);
 
     /// <summary>
-    /// Returns the value of Option if it is T otherwise evaluate default.
+    /// Returns the value of <see cref="Option{T}"/> if it is T otherwise evaluate default.
     /// </summary>
     /// <param name="defaultWith"></param>
     /// <returns></returns>
@@ -80,7 +80,7 @@ public T DefaultWith(
         Match(some => some, () => defaultWith());
 
     /// <summary>
-    /// Return Option if it is Some, otherwise return ifNone.
+    /// Return <see cref="Option{T}"/> if it is Some, otherwise return ifNone.
     /// </summary>
     /// <param name="ifNone"></param>
     /// <returns></returns>
@@ -89,7 +89,7 @@ public Option<T> OrElse(
         Match(Option<T>.Some, () => ifNone);
 
     /// <summary>
-    /// Return Option if it is Some, otherwise evaluate ifNoneWith.
+    /// Return <see cref="Option{T}"/> if it is Some, otherwise evaluate ifNoneWith.
     /// </summary>
     /// <param name="ifNoneWith"></param>
     /// <returns></returns>
@@ -99,7 +99,7 @@ public Option<T> OrElseWith(
 
 
     /// <summary>
-    /// Creates a new Option with the specified value.
+    /// Creates a new <see cref="Option{T}"/> with the specified value.
     /// </summary>
     /// <param name="value"></param>
     /// <returns></returns>
@@ -107,7 +107,7 @@ public static Option<T> Some(T value) =>
         new(value);
 
     /// <summary>
-    /// Creates Option with the specified value wrapped in a completed Task.
+    /// Creates <see cref="Option{T}"/> with the specified value wrapped in a completed Task.
     /// </summary>
     /// <param name="value"></param>
     /// <returns></returns>
@@ -115,7 +115,7 @@ public static Task<Option<T>> SomeAsync(T value) =>
         Task.FromResult(Some(value));
 
     /// <summary>
-    /// Creates a new Option with the value of the awaited Task.
+    /// Creates a new <see cref="Option{T}"/> with the value of the awaited Task.
     /// </summary>
     /// <param name="value"></param>
     /// <returns></returns>
@@ -123,21 +123,21 @@ public static async Task<Option<T>> SomeAsync(Task<T> value) =>
         Some(await value);
 
     /// <summary>
-    /// Creates a new Option with no value.
+    /// Creates a new <see cref="Option{T}"/> with no value.
     /// </summary>
     /// <returns></returns>
     public static Option<T> None() =>
         new();
 
     /// <summary>
-    /// Creates a new Option with no value wrapped in a completed Task.
+    /// Creates a new <see cref="Option{T}"/> with no value wrapped in a completed Task.
     /// </summary>
     /// <returns></returns>
     public static Task<Option<T>> NoneAsync() =>
         Task.FromResult(None());
 
     /// <summary>
-    /// Returns true if the specified Options are equal.
+    /// Returns true if the specified <see cref="Option{T}"/>s are equal.
     /// </summary>
     /// <param name="left"></param>
     /// <param name="right"></param>
@@ -146,7 +146,7 @@ public static Task<Option<T>> NoneAsync() =>
         left.Equals(right);
 
     /// <summary>
-    /// Returns true if the specified Options are not equal.
+    /// Returns true if the specified <see cref="Option{T}"/>s are not equal.
     /// </summary>
     /// <param name="left"></param>
     /// <param name="right"></param>
@@ -155,7 +155,7 @@ public static Task<Option<T>> NoneAsync() =>
         !(left == right);
 
     /// <summary>
-    /// Returns true if the specified Options are equal.
+    /// Returns true if the specified <see cref="Option{T}"/>s are equal.
     /// </summary>
     /// <param name="obj"></param>
     /// <returns></returns>
@@ -163,7 +163,7 @@ public override bool Equals(object? obj) =>
         obj is Option<T> o && Equals(o);
 
     /// <summary>
-    /// Returns true if the specified Options are equal.
+    /// Returns true if the specified <see cref="Option{T}"/>s are equal.
     /// </summary>
     /// <param name="other"></param>
     /// <returns></returns>
@@ -180,7 +180,7 @@ public readonly bool Equals(Option<T> other) =>
             );
 
     /// <summary>
-    /// Returns the hash code of the Option.
+    /// Returns the hash code of the <see cref="Option{T}"/>.
     /// </summary>
     /// <returns></returns>
     public override int GetHashCode() =>
@@ -189,7 +189,7 @@ public override int GetHashCode() =>
             none: () => 0);
 
     /// <summary>
-    /// Returns the string representation of the Option.
+    /// Returns the string representation of the <see cref="Option{T}"/>.
     /// </summary>
     /// <returns></returns>
     public override string ToString() =>
@@ -199,12 +199,12 @@ public override string ToString() =>
 }
 
 /// <summary>
-/// Extension methods to allow Option matching using
+/// Extension methods to allow <see cref="Option{T}"/> matching using
 /// </summary>
 public static class OptionActionExtensions
 {
     /// <summary>
-    /// If Option is Some, evaluates the some delegate, otherwise evaluates
+    /// If <see cref="Option{T}"/> is Some, evaluates the some delegate, otherwise evaluates
     /// the none delegate.
     /// </summary>
     /// <typeparam name="T"></typeparam>
diff --git a/src/Danom/Result/Result.cs b/src/Danom/Result/Result.cs
index bb61a96..55ef6a2 100644
--- a/src/Danom/Result/Result.cs
+++ b/src/Danom/Result/Result.cs
@@ -24,17 +24,17 @@ private Result(TError tError)
     }
 
     /// <summary>
-    /// Returns true if Result is Ok, false otherwise.
+    /// Returns true if <see cref="Result{T, TError}"/> is Ok, false otherwise.
     /// </summary>
     public bool IsOk { get; } = false;
 
     /// <summary>
-    /// Returns true if Result is Error, false otherwise.
+    /// Returns true if <see cref="Result{T, TError}"/> is Error, false otherwise.
     /// </summary>
     public bool IsError => !IsOk;
 
     /// <summary>
-    /// If Result is Ok evaluate the ok delegate, otherwise error.
+    /// If <see cref="Result{T, TError}"/> is Ok evaluate the ok delegate, otherwise error.
     /// </summary>
     /// <typeparam name="U"></typeparam>
     /// <param name="ok"></param>
@@ -48,7 +48,7 @@ public U Match<U>(Func<T, U> ok, Func<TError, U> error) =>
                 throw new InvalidOperationException("Result error has not been initialized.");
 
     /// <summary>
-    /// Evaluates the bind delegate if Result is Ok otherwise return Error.
+    /// Evaluates the bind delegate if <see cref="Result{T, TError}"/> is Ok otherwise return Error.
     /// </summary>
     /// <typeparam name="U"></typeparam>
     /// <param name="bind"></param>
@@ -58,7 +58,7 @@ public Result<U, TError> Bind<U>(
         Match(bind, Result<U, TError>.Error);
 
     /// <summary>
-    /// Evaluates the map delegate if Result is Ok otherwise return Error.
+    /// Evaluates the map delegate if <see cref="Result{T, TError}"/> is Ok otherwise return Error.
     /// </summary>
     /// <typeparam name="U"></typeparam>
     /// <param name="map"></param>
@@ -68,7 +68,7 @@ public Result<U, TError> Map<U>(
         Bind(x => Result<U, TError>.Ok(map(x)));
 
     /// <summary>
-    /// Evaluates the mapError delegate if Result is Error otherwise return Ok.
+    /// Evaluates the mapError delegate if <see cref="Result{T, TError}"/> is Error otherwise return Ok.
     /// </summary>
     /// <typeparam name="UError"></typeparam>
     /// <param name="mapError"></param>
@@ -78,7 +78,7 @@ public Result<T, UError> MapError<UError>(
         Match(Result<T, UError>.Ok, e => Result<T, UError>.Error(mapError(e)));
 
     /// <summary>
-    /// Returns the value of Result if it is T, otherwise returns the
+    /// Returns the value of <see cref="Result{T, TError}"/> if it is T, otherwise returns the
     /// specified default value.
     /// </summary>
     /// <param name="defaultValue"></param>
@@ -88,7 +88,7 @@ public T DefaultValue(
          Match(ok => ok, _ => defaultValue);
 
     /// <summary>
-    /// Returns the value of Result if it is T, otherwise returns the
+    /// Returns the value of <see cref="Result{T, TError}"/> if it is T, otherwise returns the
     /// </summary>
     /// <param name="defaultWith"></param>
     /// <returns></returns>
@@ -97,7 +97,7 @@ public T DefaultWith(
         Match(ok => ok, _ => defaultWith());
 
     /// <summary>
-    /// Creates a new Result with the specified value.
+    /// Creates a new <see cref="Result{T, TError}"/> with the specified value.
     /// </summary>
     /// <param name="value"></param>
     /// <returns></returns>
@@ -105,7 +105,7 @@ public static Result<T, TError> Ok(T value) =>
         new(value);
 
     /// <summary>
-    /// Creates Result with the specified value wrapped in a completed Task.
+    /// Creates <see cref="Result{T, TError}"/> with the specified value wrapped in a completed Task.
     /// </summary>
     /// <param name="value"></param>
     /// <returns></returns>
@@ -113,7 +113,7 @@ public static Task<Result<T, TError>> OkAsync(T value) =>
         Task.FromResult(Ok(value));
 
     /// <summary>
-    /// Creates Result with the value of the awaited Task.
+    /// Creates <see cref="Result{T, TError}"/> with the value of the awaited Task.
     /// </summary>
     /// <param name="valueTask"></param>
     /// <returns></returns>
@@ -121,7 +121,7 @@ public static async Task<Result<T, TError>> OkAsync(Task<T> valueTask) =>
         Ok(await valueTask);
 
     /// <summary>
-    /// Creates a new Result with the specified error.
+    /// Creates a new <see cref="Result{T, TError}"/> with the specified error.
     /// </summary>
     /// <param name="errors"></param>
     /// <returns></returns>
@@ -129,7 +129,7 @@ public static Result<T, TError> Error(TError errors) =>
         new(errors);
 
     /// <summary>
-    /// Creates Result with the specified error wrapped in a completed Task.
+    /// Creates <see cref="Result{T, TError}"/> with the specified error wrapped in a completed Task.
     /// </summary>
     /// <param name="errors"></param>
     /// <returns></returns>
@@ -137,7 +137,7 @@ public static Task<Result<T, TError>> ErrorAsync(TError errors) =>
         Task.FromResult(Error(errors));
 
     /// <summary>
-    /// Creates Result with the value of the awaited Task.
+    /// Creates <see cref="Result{T, TError}"/> with the value of the awaited Task.
     /// </summary>
     /// <param name="errors"></param>
     /// <returns></returns>
@@ -145,7 +145,7 @@ public static async Task<Result<T, TError>> ErrorAsync(Task<TError> errors) =>
         Error(await errors);
 
     /// <summary>
-    /// Returns true if the specified Result is equal to the current Result.
+    /// Returns true if the specified Result is equal to the current <see cref="Result{T, TError}"/>.
     /// </summary>
     /// <param name="left"></param>
     /// <param name="right"></param>
@@ -154,7 +154,7 @@ public static async Task<Result<T, TError>> ErrorAsync(Task<TError> errors) =>
         left.Equals(right);
 
     /// <summary>
-    /// Returns true if the specified Result is not equal to the current Result.
+    /// Returns true if the specified Result is not equal to the current <see cref="Result{T, TError}"/>.
     /// </summary>
     /// <param name="left"></param>
     /// <param name="right"></param>
@@ -163,7 +163,7 @@ public static async Task<Result<T, TError>> ErrorAsync(Task<TError> errors) =>
         !(left == right);
 
     /// <summary>
-    /// Returns true if the specified Result is equal to the current Result.
+    /// Returns true if the specified Result is equal to the current <see cref="Result{T, TError}"/>.
     /// </summary>
     /// <param name="obj"></param>
     /// <returns></returns>
@@ -171,7 +171,7 @@ public override bool Equals(object? obj) =>
         obj is Result<T, TError> o && Equals(o);
 
     /// <summary>
-    /// Returns true if the specified Result is equal to the current Result.
+    /// Returns true if the specified Result is equal to the current <see cref="Result{T, TError}"/>.
     /// </summary>
     /// <param name="other"></param>
     /// <returns></returns>
@@ -187,7 +187,7 @@ public readonly bool Equals(Result<T, TError> other) =>
                     error: e2 => e2 is not null && e2.Equals(e1)));
 
     /// <summary>
-    /// Returns the hash code for the Result.
+    /// Returns the hash code for the <see cref="Result{T, TError}"/>.
     /// </summary>
     /// <returns></returns>
     public override int GetHashCode() =>
@@ -196,7 +196,7 @@ public override int GetHashCode() =>
             error: e => e is null ? 0 : e.GetHashCode());
 
     /// <summary>
-    /// Returns a string representation of the Result.
+    /// Returns a string representation of the <see cref="Result{T, TError}"/>.
     /// </summary>
     /// <returns></returns>
     public override string ToString() =>
@@ -207,16 +207,14 @@ public override string ToString() =>
 
 
 /// <summary>
-/// The <see cref="Result{T, TError}"/> with <see cref="ResultErrors"/>
+/// The <see cref="Result{T, ResultErrors}"/> with <see cref="ResultErrors"/>
 /// as the predefined error type.
-///
-/// Alias for <see cref="Result{T, ResultErrors}"/>.
 /// </summary>
 /// <typeparam name="T"></typeparam>
 public static class Result<T>
 {
     /// <summary>
-    /// Creates a new Result with the specified value.
+    /// Creates a new <see cref="Result{T, ResultErrors}"/> with the specified value.
     /// </summary>
     /// <param name="value"></param>
     /// <returns></returns>
@@ -224,7 +222,7 @@ public static Result<T, ResultErrors> Ok(T value) =>
         Result<T, ResultErrors>.Ok(value);
 
     /// <summary>
-    /// Creates Result with the specified value wrapped in a completed Task.
+    /// Creates <see cref="Result{T, ResultErrors}"/> with the specified value wrapped in a completed Task.
     /// </summary>
     /// <param name="value"></param>
     /// <returns></returns>
@@ -232,7 +230,7 @@ public static Task<Result<T, ResultErrors>> OkAsync(T value) =>
         Result<T, ResultErrors>.OkAsync(value);
 
     /// <summary>
-    /// Creates Result with the value of the awaited Task.
+    /// Creates <see cref="Result{T, ResultErrors}"/> with the value of the awaited Task.
     /// </summary>
     /// <param name="valueTask"></param>
     /// <returns></returns>
@@ -240,7 +238,7 @@ public static Task<Result<T, ResultErrors>> OkAsync(Task<T> valueTask) =>
         Result<T, ResultErrors>.OkAsync(valueTask);
 
     /// <summary>
-    /// Creates a new Result with the specified error.
+    /// Creates a new <see cref="Result{T, ResultErrors}"/> with the specified error.
     /// </summary>
     /// <param name="errors"></param>
     /// <returns></returns>
@@ -248,7 +246,7 @@ public static Result<T, ResultErrors> Error(ResultErrors errors) =>
         Result<T, ResultErrors>.Error(errors);
 
     /// <summary>
-    /// Creates Result with the specified error wrapped in a completed Task.
+    /// Creates <see cref="Result{T, ResultErrors}"/> with the specified error wrapped in a completed Task.
     /// </summary>
     /// <param name="errors"></param>
     /// <returns></returns>
@@ -256,7 +254,7 @@ public static Task<Result<T, ResultErrors>> ErrorAsync(ResultErrors errors) =>
         Task.FromResult(Error(errors));
 
     /// <summary>
-    /// Creates a new Result with the specified error.
+    /// Creates a new <see cref="Result{T, ResultErrors}"/> with the specified error.
     /// </summary>
     /// <param name="messages"></param>
     /// <returns></returns>
@@ -264,7 +262,7 @@ public static Result<T, ResultErrors> Error(IEnumerable<string> messages) =>
         Error(new ResultErrors(messages));
 
     /// <summary>
-    /// Creates Result with the specified error wrapped in a completed Task.
+    /// Creates <see cref="Result{T, ResultErrors}"/> with the specified error wrapped in a completed Task.
     /// </summary>
     /// <param name="message"></param>
     /// <returns></returns>
@@ -272,7 +270,7 @@ public static Result<T, ResultErrors> Error(string message) =>
         Error([message]);
 
     /// <summary>
-    /// Creates Result with the specified error wrapped in a completed Task.
+    /// Creates <see cref="Result{T, ResultErrors}"/> with the specified error wrapped in a completed Task.
     /// </summary>
     /// <param name="message"></param>
     /// <returns></returns>
diff --git a/src/Danom/ResultOption/ResultOption.cs b/src/Danom/ResultOption/ResultOption.cs
index 7cecbbc..0ba3468 100644
--- a/src/Danom/ResultOption/ResultOption.cs
+++ b/src/Danom/ResultOption/ResultOption.cs
@@ -237,14 +237,14 @@ public override string ToString() =>
 
 
 /// <summary>
-/// Static methods for creating <see cref="ResultOption{T, TError}"/> instances with
+/// Static methods for creating <see cref="ResultOption{T, ResultErrors}"/> instances with
 /// <see cref="ResultErrors"/> as the error type.
 /// </summary>
 /// <typeparam name="T"></typeparam>
 public static class ResultOption<T>
 {
     /// <summary>
-    /// Creates a new <see cref="ResultOption{T, TError}"/> instance with the
+    /// Creates a new <see cref="ResultOption{T, ResultErrors}"/> instance with the
     /// specified value.
     /// </summary>
     /// <param name="value"></param>
@@ -253,7 +253,7 @@ public static ResultOption<T, ResultErrors> Ok(T value) =>
         ResultOption<T, ResultErrors>.Ok(value);
 
     /// <summary>
-    /// Creates a new <see cref="ResultOption{T, TError}"/> instance with the
+    /// Creates a new <see cref="ResultOption{T, ResultErrors}"/> instance with the
     /// value of the awaited Task.
     /// </summary>
     /// <param name="value"></param>
@@ -262,7 +262,7 @@ public static Task<ResultOption<T, ResultErrors>> OkAsync(T value) =>
         ResultOption<T, ResultErrors>.OkAsync(value);
 
     /// <summary>
-    /// Creates a new <see cref="ResultOption{T, TError}"/> instance with the
+    /// Creates a new <see cref="ResultOption{T, ResultErrors}"/> instance with the
     /// value of the awaited Task.
     /// </summary>
     /// <param name="valueTask"></param>
@@ -271,7 +271,7 @@ public static Task<ResultOption<T, ResultErrors>> OkAsync(Task<T> valueTask) =>
         ResultOption<T, ResultErrors>.OkAsync(valueTask);
 
     /// <summary>
-    /// Creates a new <see cref="ResultOption{T, TError}"/> instance with no
+    /// Creates a new <see cref="ResultOption{T, ResultErrors}"/> instance with no
     /// value.
     /// </summary>
     /// <returns></returns>
@@ -279,7 +279,7 @@ public static ResultOption<T, ResultErrors> None() =>
         ResultOption<T, ResultErrors>.None();
 
     /// <summary>
-    /// Creates a new <see cref="ResultOption{T, TError}"/> instance with no
+    /// Creates a new <see cref="ResultOption{T, ResultErrors}"/> instance with no
     /// value wrapped in a completed Task.
     /// in a completed Task.
     /// </summary>
@@ -288,7 +288,7 @@ public static Task<ResultOption<T, ResultErrors>> NoneAsync() =>
         ResultOption<T, ResultErrors>.NoneAsync();
 
     /// <summary>
-    /// Creates a new <see cref="ResultOption{T, TError}"/> instance with the
+    /// Creates a new <see cref="ResultOption{T, ResultErrors}"/> instance with the
     /// specified error.
     /// </summary>
     /// <param name="errors"></param>
@@ -297,7 +297,7 @@ public static ResultOption<T, ResultErrors> Error(ResultErrors errors) =>
         ResultOption<T, ResultErrors>.Error(errors);
 
     /// <summary>
-    /// Creates a new <see cref="ResultOption{T, TError}"/> instance with the
+    /// Creates a new <see cref="ResultOption{T, ResultErrors}"/> instance with the
     /// specified error.
     /// </summary>
     /// <param name="message"></param>
@@ -306,7 +306,7 @@ public static ResultOption<T, ResultErrors> Error(string message) =>
         Error([new ResultError(string.Empty, [message])]);
 
     /// <summary>
-    /// Creates a new <see cref="ResultOption{T, TError}"/> instance with the
+    /// Creates a new <see cref="ResultOption{T, ResultErrors}"/> instance with the
     /// specified error wrapped in a completed Task.
     /// </summary>
     /// <param name="errors"></param>
@@ -315,7 +315,7 @@ public static Task<ResultOption<T, ResultErrors>> ErrorAsync(ResultErrors errors
         Task.FromResult(Error(errors));
 
     /// <summary>
-    /// Creates a new <see cref="ResultOption{T, TError}"/> instance with the
+    /// Creates a new <see cref="ResultOption{T, ResultErrors}"/> instance with the
     /// specified error wrapped in a completed Task.
     /// </summary>
     /// <param name="message"></param>