Added xmldoc for Result<T> members.

Author: MrMatthewLayton

OnixLabs.Core/Optional.cs

@@ -78,12 +78,12 @@ internal Optional()
     public static implicit operator Optional<T>(T value) => Some(value);
 
     /// <summary>
-    /// Gets the underlying value of the current <see cref="Optional{T}"/> instance;
+    /// Gets the underlying value of the specified <see cref="Optional{T}"/> instance;
     /// otherwise throws an <see cref="InvalidOperationException"/> if the value is absent.
     /// </summary>
     /// <param name="value">The <see cref="Optional{T}"/> instance from which to obtain the underlying value.</param>
     /// <returns>
-    /// Returns the underlying value of the current <see cref="Optional{T}"/> instance;
+    /// Returns the underlying value of the specified <see cref="Optional{T}"/> instance;
     /// otherwise throws an <see cref="InvalidOperationException"/> if the value is absent.
     /// </returns>
     /// <exception cref="InvalidOperationException">If the underlying value is absent.</exception>

OnixLabs.Core/Result.Failure.cs

@@ -16,35 +16,134 @@
 
 namespace OnixLabs.Core;
 
+/// <summary>
+/// Represents a failed result.
+/// </summary>
+/// <typeparam name="T">The type of the underlying result value.</typeparam>
 public sealed class Failure<T> : Result<T>, IValueEquatable<Failure<T>>
 {
-    public Failure(Exception exception) => Exception = exception;
-
+    /// <summary>
+    /// Initializes a new instance of the <see cref="Failure{T}"/> class.
+    /// </summary>
+    /// <param name="exception">The underlying exception representing the failed result.</param>
+    internal Failure(Exception exception) => Exception = exception;
+
+    /// <summary>
+    /// Gets the underlying result exception.
+    /// </summary>
     public Exception Exception { get; }
 
+    /// <summary>
+    /// Performs an equality comparison between two object instances.
+    /// </summary>
+    /// <param name="left">The left-hand instance to compare.</param>
+    /// <param name="right">The right-hand instance to compare.</param>
+    /// <returns>Returns <see langword="true"/> if the left-hand instance is equal to the right-hand instance; otherwise, <see langword="false"/>.</returns>
     public static bool operator ==(Failure<T> left, Failure<T> right) => Equals(left, right);
 
+    /// <summary>
+    /// Performs an inequality comparison between two object instances.
+    /// </summary>
+    /// <param name="left">The left-hand instance to compare.</param>
+    /// <param name="right">The right-hand instance to compare.</param>
+    /// <returns>Returns <see langword="true"/> if the left-hand instance is not equal to the right-hand instance; otherwise, <see langword="false"/>.</returns>
     public static bool operator !=(Failure<T> left, Failure<T> right) => !Equals(left, right);
 
+    /// <summary>
+    /// Checks whether the current object is equal to another object of the same type.
+    /// </summary>
+    /// <param name="other">An object to compare with the current object.</param>
+    /// <returns>Returns <see langword="true"/> if the current object is equal to the other parameter; otherwise, <see langword="false"/>.</returns>
     public bool Equals(Failure<T>? other) => ReferenceEquals(this, other) || other is not null && Equals(other.Exception, Exception);
 
+    /// <summary>
+    /// Checks for equality between the current instance and another object.
+    /// </summary>
+    /// <param name="obj">The object to check for equality.</param>
+    /// <returns>Returns <see langword="true"/> if the object is equal to the current instance; otherwise, <see langword="false"/>.</returns>
     public override bool Equals(object? obj) => Equals(obj as Failure<T>);
 
+    /// <summary>
+    /// Serves as a hash code function for the current instance.
+    /// </summary>
+    /// <returns>Returns a hash code for the current instance.</returns>
     public override int GetHashCode() => Exception.GetHashCode();
 
+    /// <summary>
+    /// Gets the underlying value of the current <see cref="Result{T}"/> instance, if the underlying value is present;
+    /// otherwise returns the default <typeparam name="T"/> value.
+    /// </summary>
+    /// <returns>
+    /// Returns the underlying value of the current <see cref="Result{T}"/> instance, if the underlying value is present;
+    /// otherwise returns the default <typeparam name="T"/> value.
+    /// </returns>
     public override T? GetValueOrDefault() => default;
 
+    /// <summary>
+    /// Gets the underlying value of the current <see cref="Result{T}"/> instance, if the underlying value is present;
+    /// otherwise returns the specified default value.
+    /// </summary>
+    /// <param name="defaultValue">The default value to return in the event that the underlying value is absent.</param>
+    /// <returns>
+    /// Returns the underlying value of the current <see cref="Result{T}"/> instance, if the underlying value is present;
+    /// otherwise returns the specified default value.
+    /// </returns>
     public override T GetValueOrDefault(T defaultValue) => defaultValue;
 
+    /// <summary>
+    /// Gets the underlying value of the current <see cref="Result{T}"/> instance;
+    /// otherwise throws the underlying exception if the current <see cref="Result{T}"/> is in a failed stated.
+    /// </summary>
+    /// <returns>
+    /// Returns the underlying value of the current <see cref="Result{T}"/> instance;
+    /// otherwise throws the underlying exception if the current <see cref="Result{T}"/> is in a failed stated.
+    /// </returns>
     public override T GetValueOrThrow() => throw Exception;
 
+    /// <summary>
+    /// Executes the action that matches the value of the current <see cref="Result{T}"/> instance.
+    /// </summary>
+    /// <param name="success">The action to execute when the current <see cref="Result{T}"/> instance is in a successful state.</param>
+    /// <param name="failure">The action to execute when the current <see cref="Result{T}"/> instance is in a failed state.</param>
     public override void Match(Action<T> success, Action<Exception> failure) => failure(Exception);
 
+    /// <summary>
+    /// Executes the function that matches the value of the current <see cref="Result{T}"/> instance and returns its result.
+    /// </summary>
+    /// <param name="success">The action to execute when the current <see cref="Result{T}"/> instance is in a successful state.</param>
+    /// <param name="failure">The action to execute when the current <see cref="Result{T}"/> instance is in a failed state.</param>
+    /// <typeparam name="TResult">The underlying type of the result produced by the matching function.</typeparam>
+    /// <returns>
+    /// Returns the result of the <paramref name="success"/> function if the current <see cref="Result{T}"/> instance is in a successful state;
+    /// otherwise, returns the result of the <paramref name="failure"/> function if the current <see cref="Result{T}"/> instance is in a failed state.
+    /// </returns>
     public override TResult Match<TResult>(Func<T, TResult> success, Func<Exception, TResult> failure) => failure(Exception);
 
+    /// <summary>
+    /// Applies the provided selector function to the value of the current <see cref="Result{T}"/> instance.
+    /// </summary>
+    /// <param name="selector">The function to apply to the value of the current <see cref="Result{T}"/> instance.</param>
+    /// <typeparam name="TResult">The underlying type of the result produced by the selector function.</typeparam>
+    /// <returns>
+    /// Returns a new <see cref="Result{TResult}"/> instance containing the result of the function if the current
+    /// <see cref="Result{T}"/> instance is in a successful state; otherwise, returns the current failed <see cref="Result{T}"/> instance.
+    /// </returns>
     public override Result<TResult> Select<TResult>(Func<T, TResult> selector) => Result<TResult>.Failure(Exception);
 
+    /// <summary>
+    /// Applies the provided selector function to the value of the current <see cref="Result{T}"/> instance.
+    /// </summary>
+    /// <param name="selector">The function to apply to the value of the current <see cref="Result{T}"/> instance.</param>
+    /// <typeparam name="TResult">The underlying type of the result produced by the selector function.</typeparam>
+    /// <returns>
+    /// Returns a new <see cref="Result{TResult}"/> instance containing the result of the function if the current
+    /// <see cref="Result{T}"/> instance is in a successful state; otherwise, returns the current failed <see cref="Result{T}"/> instance.
+    /// </returns>
     public override Result<TResult> SelectMany<TResult>(Func<T, Result<TResult>> selector) => Result<TResult>.Failure(Exception);
 
+    /// <summary>
+    /// Returns a <see cref="String"/> that represents the current object.
+    /// </summary>
+    /// <returns>Returns a <see cref="String"/> that represents the current object.</returns>
     public override string ToString() => Exception.ToString();
 }

OnixLabs.Core/Result.Success.cs

@@ -16,35 +16,134 @@
 
 namespace OnixLabs.Core;
 
+/// <summary>
+/// Represents a successful result.
+/// </summary>
+/// <typeparam name="T">The type of the underlying result value.</typeparam>
 public sealed class Success<T> : Result<T>, IValueEquatable<Success<T>>
 {
-    public Success(T value) => Value = value;
-
+    /// <summary>
+    /// Initializes a new instance of the <see cref="Success{T}"/> class.
+    /// </summary>
+    /// <param name="value">The underlying value representing the successful result.</param>
+    internal Success(T value) => Value = value;
+
+    /// <summary>
+    /// Gets the underlying result value.
+    /// </summary>
     public T Value { get; }
 
+    /// <summary>
+    /// Performs an equality comparison between two object instances.
+    /// </summary>
+    /// <param name="left">The left-hand instance to compare.</param>
+    /// <param name="right">The right-hand instance to compare.</param>
+    /// <returns>Returns <see langword="true"/> if the left-hand instance is equal to the right-hand instance; otherwise, <see langword="false"/>.</returns>
     public static bool operator ==(Success<T> left, Success<T> right) => Equals(left, right);
 
+    /// <summary>
+    /// Performs an inequality comparison between two object instances.
+    /// </summary>
+    /// <param name="left">The left-hand instance to compare.</param>
+    /// <param name="right">The right-hand instance to compare.</param>
+    /// <returns>Returns <see langword="true"/> if the left-hand instance is not equal to the right-hand instance; otherwise, <see langword="false"/>.</returns>
     public static bool operator !=(Success<T> left, Success<T> right) => Equals(left, right);
 
+    /// <summary>
+    /// Checks whether the current object is equal to another object of the same type.
+    /// </summary>
+    /// <param name="other">An object to compare with the current object.</param>
+    /// <returns>Returns <see langword="true"/> if the current object is equal to the other parameter; otherwise, <see langword="false"/>.</returns>
     public bool Equals(Success<T>? other) => ReferenceEquals(this, other) || other is not null && Equals(other.Value, Value);
 
+    /// <summary>
+    /// Checks for equality between the current instance and another object.
+    /// </summary>
+    /// <param name="obj">The object to check for equality.</param>
+    /// <returns>Returns <see langword="true"/> if the object is equal to the current instance; otherwise, <see langword="false"/>.</returns>
     public override bool Equals(object? obj) => Equals(obj as Success<T>);
 
+    /// <summary>
+    /// Serves as a hash code function for the current instance.
+    /// </summary>
+    /// <returns>Returns a hash code for the current instance.</returns>
     public override int GetHashCode() => Value?.GetHashCode() ?? default;
 
+    /// <summary>
+    /// Gets the underlying value of the current <see cref="Result{T}"/> instance, if the underlying value is present;
+    /// otherwise returns the default <typeparam name="T"/> value.
+    /// </summary>
+    /// <returns>
+    /// Returns the underlying value of the current <see cref="Result{T}"/> instance, if the underlying value is present;
+    /// otherwise returns the default <typeparam name="T"/> value.
+    /// </returns>
     public override T? GetValueOrDefault() => Value;
 
+    /// <summary>
+    /// Gets the underlying value of the current <see cref="Result{T}"/> instance, if the underlying value is present;
+    /// otherwise returns the specified default value.
+    /// </summary>
+    /// <param name="defaultValue">The default value to return in the event that the underlying value is absent.</param>
+    /// <returns>
+    /// Returns the underlying value of the current <see cref="Result{T}"/> instance, if the underlying value is present;
+    /// otherwise returns the specified default value.
+    /// </returns>
     public override T GetValueOrDefault(T defaultValue) => Value ?? defaultValue;
 
+    /// <summary>
+    /// Gets the underlying value of the current <see cref="Result{T}"/> instance;
+    /// otherwise throws the underlying exception if the current <see cref="Result{T}"/> is in a failed stated.
+    /// </summary>
+    /// <returns>
+    /// Returns the underlying value of the current <see cref="Result{T}"/> instance;
+    /// otherwise throws the underlying exception if the current <see cref="Result{T}"/> is in a failed stated.
+    /// </returns>
     public override T GetValueOrThrow() => Value;
 
+    /// <summary>
+    /// Executes the action that matches the value of the current <see cref="Result{T}"/> instance.
+    /// </summary>
+    /// <param name="success">The action to execute when the current <see cref="Result{T}"/> instance is in a successful state.</param>
+    /// <param name="failure">The action to execute when the current <see cref="Result{T}"/> instance is in a failed state.</param>
     public override void Match(Action<T> success, Action<Exception> failure) => success(Value);
 
+    /// <summary>
+    /// Executes the function that matches the value of the current <see cref="Result{T}"/> instance and returns its result.
+    /// </summary>
+    /// <param name="success">The action to execute when the current <see cref="Result{T}"/> instance is in a successful state.</param>
+    /// <param name="failure">The action to execute when the current <see cref="Result{T}"/> instance is in a failed state.</param>
+    /// <typeparam name="TResult">The underlying type of the result produced by the matching function.</typeparam>
+    /// <returns>
+    /// Returns the result of the <paramref name="success"/> function if the current <see cref="Result{T}"/> instance is in a successful state;
+    /// otherwise, returns the result of the <paramref name="failure"/> function if the current <see cref="Result{T}"/> instance is in a failed state.
+    /// </returns>
     public override TResult Match<TResult>(Func<T, TResult> success, Func<Exception, TResult> failure) => success(Value);
 
+    /// <summary>
+    /// Applies the provided selector function to the value of the current <see cref="Result{T}"/> instance.
+    /// </summary>
+    /// <param name="selector">The function to apply to the value of the current <see cref="Result{T}"/> instance.</param>
+    /// <typeparam name="TResult">The underlying type of the result produced by the selector function.</typeparam>
+    /// <returns>
+    /// Returns a new <see cref="Result{TResult}"/> instance containing the result of the function if the current
+    /// <see cref="Result{T}"/> instance is in a successful state; otherwise, returns the current failed <see cref="Result{T}"/> instance.
+    /// </returns>
     public override Result<TResult> Select<TResult>(Func<T, TResult> selector) => selector(Value);
 
+    /// <summary>
+    /// Applies the provided selector function to the value of the current <see cref="Result{T}"/> instance.
+    /// </summary>
+    /// <param name="selector">The function to apply to the value of the current <see cref="Result{T}"/> instance.</param>
+    /// <typeparam name="TResult">The underlying type of the result produced by the selector function.</typeparam>
+    /// <returns>
+    /// Returns a new <see cref="Result{TResult}"/> instance containing the result of the function if the current
+    /// <see cref="Result{T}"/> instance is in a successful state; otherwise, returns the current failed <see cref="Result{T}"/> instance.
+    /// </returns>
     public override Result<TResult> SelectMany<TResult>(Func<T, Result<TResult>> selector) => selector(Value);
 
+    /// <summary>
+    /// Returns a <see cref="String"/> that represents the current object.
+    /// </summary>
+    /// <returns>Returns a <see cref="String"/> that represents the current object.</returns>
     public override string ToString() => Value?.ToString() ?? string.Empty;
 }