update/xmldoc

* Updated xmldocs in OnixLabs.Core library.
* Updated xmldocs for OnixLabs.Security library.
* Fixed failing tests due to implementation change in Optional.cs

Author: MrMatthewLayton

OnixLabs.Core/Enumeration.Comparable.cs

@@ -16,21 +16,9 @@ namespace OnixLabs.Core;
 
 public abstract partial class Enumeration<T>
 {
-    /// <summary>
-    /// Compares the current instance with another object of the same type and returns an integer that indicates
-    /// whether the current instance precedes, follows, or occurs in the same position in the sort order as the
-    /// other object.
-    /// </summary>
-    /// <param name="other">An object to compare with the current instance.</param>
-    /// <returns>Returns a value that indicates the relative order of the objects being compared.</returns>
+    /// <inheritdoc/>
     public int CompareTo(T? other) => Value.CompareToNullable(other?.Value);
 
-    /// <summary>
-    /// Compares the current instance with another object of the same type and returns an integer that indicates
-    /// whether the current instance precedes, follows, or occurs in the same position in the sort order as the
-    /// other object.
-    /// </summary>
-    /// <param name="obj">An object to compare with the current instance.</param>
-    /// <returns>Returns a value that indicates the relative order of the objects being compared.</returns>
+    /// <inheritdoc/>
     public int CompareTo(object? obj) => this.CompareToObject(obj);
 }

OnixLabs.Core/Enumeration.Equatable.cs

@@ -18,29 +18,18 @@ namespace OnixLabs.Core;
 
 public abstract partial class Enumeration<T>
 {
-    /// <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>
+    /// <inheritdoc/>
     public bool Equals(T? other) =>
         ReferenceEquals(this, other)
         || other is not null
         && other.GetType() == GetType()
         && other.Value == Value
         && other.Name == Name;
 
-    /// <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>
+    /// <inheritdoc/>
     public override bool Equals(object? obj) => Equals(obj as T);
 
-    /// <summary>
-    /// Serves as a hash code function for the current instance.
-    /// </summary>
-    /// <returns>Returns a hash code for the current instance.</returns>
+    /// <inheritdoc/>
     public override int GetHashCode() => HashCode.Combine(GetType(), Name, Value);
 
     /// <summary>

OnixLabs.Core/Enumeration.To.cs

@@ -24,9 +24,6 @@ public abstract partial class Enumeration<T>
     /// <returns>Returns a tuple that represents the current object.</returns>
     public (int Value, string Name) ToEntry() => (Value, Name);
 
-    /// <summary>
-    /// Returns a <see cref="String"/> that represents the current object.
-    /// </summary>
-    /// <returns>Returns a <see cref="String"/> that represents the current object.</returns>
+    /// <inheritdoc/>
     public override string ToString() => Name;
 }

OnixLabs.Core/Optional.cs

@@ -136,24 +136,13 @@ public static Optional<TStruct> Of<TStruct>(TStruct? value) where TStruct : stru
     /// <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 !=(Optional<T>? left, Optional<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>
+    /// <inheritdoc/>
     public bool Equals(Optional<T>? other) => OptionalEqualityComparer<T>.Default.Equals(this, other);
 
-    /// <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>
+    /// <inheritdoc/>
     public sealed override bool Equals(object? obj) => Equals(obj as Optional<T>);
 
-    /// <summary>
-    /// Serves as a hash code function for the current instance.
-    /// </summary>
-    /// <returns>Returns a hash code for the current instance.</returns>
+    /// <inheritdoc/>
     // ReSharper disable once HeapView.PossibleBoxingAllocation
     public sealed override int GetHashCode() => this is Some<T> some ? some.Value.GetHashCode() : 0;
 
@@ -258,10 +247,7 @@ public void Match(Action<T>? some = null, Action? none = null)
     /// <returns>Returns a new, successful <see cref="Result{T}"/> instance containing the current <see cref="Optional{T}"/> instance.</returns>
     public Result<Optional<T>> ToResult() => Result<Optional<T>>.Success(this);
 
-    /// <summary>
-    /// Returns a <see cref="String"/> that represents the current object.
-    /// </summary>
-    /// <returns>Returns a <see cref="String"/> that represents the current object.</returns>
+    /// <inheritdoc/>
     // ReSharper disable once HeapView.PossibleBoxingAllocation
     public sealed override string ToString() => this is Some<T> some ? some.Value.ToString() ?? string.Empty : nameof(None);
 }

OnixLabs.Core/OptionalEqualityComparer.cs

@@ -29,10 +29,7 @@ public sealed class OptionalEqualityComparer<T>(EqualityComparer<T>? valueEquali
     // ReSharper disable once HeapView.ObjectAllocation.Evident
     public static readonly OptionalEqualityComparer<T> Default = new();
 
-    /// <summary>Determines whether the specified <see cref="Optional{T}"/> values are equal.</summary>
-    /// <param name="x">The first object of type <see cref="Optional{T}"/> to compare.</param>
-    /// <param name="y">The second object of type <see cref="Optional{T}"/> to compare.</param>
-    /// <returns> Returns <see langword="true" /> if the specified <see cref="Optional{T}"/> values are equal; otherwise, <see langword="false" />.</returns>
+    /// <inheritdoc/>
     public bool Equals(Optional<T>? x, Optional<T>? y)
     {
         if (ReferenceEquals(x, y)) return true;
@@ -43,8 +40,6 @@ public bool Equals(Optional<T>? x, Optional<T>? y)
         return (valueEqualityComparer ?? EqualityComparer<T>.Default).Equals(x.GetValueOrDefault(), y.GetValueOrDefault());
     }
 
-    /// <summary>Returns a hash code for the specified object.</summary>
-    /// <param name="obj">The <see cref="object" /> for which a hash code is to be returned.</param>
-    /// <returns>A hash code for the specified object.</returns>
+    /// <inheritdoc/>
     public int GetHashCode(Optional<T> obj) => obj.GetHashCode();
 }

OnixLabs.Core/Result.Generic.cs

@@ -174,9 +174,7 @@ public static async Task<Result<T>> OfAsync(Func<CancellationToken, Task<T>> fun
     /// <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 !=(Result<T>? left, Result<T>? right) => !Equals(left, right);
 
-    /// <summary>
-    /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
-    /// </summary>
+    /// <inheritdoc/>
     public void Dispose()
     {
         // ReSharper disable once HeapView.PossibleBoxingAllocation
@@ -186,12 +184,7 @@ public void Dispose()
         GC.SuppressFinalize(this);
     }
 
-    /// <summary>
-    /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.
-    /// </summary>
-    /// <returns>
-    /// Returns a task that represents the asynchronous dispose operation.
-    /// </returns>
+    /// <inheritdoc/>
     public async ValueTask DisposeAsync()
     {
         // ReSharper disable once HeapView.PossibleBoxingAllocation
@@ -201,24 +194,13 @@ public async ValueTask DisposeAsync()
         GC.SuppressFinalize(this);
     }
 
-    /// <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>
+    /// <inheritdoc/>
     public bool Equals(Result<T>? other) => ResultEqualityComparer<T>.Default.Equals(this, other);
 
-    /// <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>
+    /// <inheritdoc/>
     public sealed override bool Equals(object? obj) => Equals(obj as Result<T>);
 
-    /// <summary>
-    /// Serves as a hash code function for the current instance.
-    /// </summary>
-    /// <returns>Returns a hash code for the current instance.</returns>
+    /// <inheritdoc/>
     public sealed override int GetHashCode() => this switch
     {
         // ReSharper disable once HeapView.PossibleBoxingAllocation
@@ -855,10 +837,7 @@ public void Throw()
             throw 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>
+    /// <inheritdoc/>
     public sealed override string ToString() => this switch
     {
         // ReSharper disable once HeapView.PossibleBoxingAllocation

OnixLabs.Core/Result.cs

@@ -152,11 +152,7 @@ public static async Task<Result> OfAsync(Func<CancellationToken, Task> func, Can
     /// <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 !=(Result? left, Result? 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>
+    /// <inheritdoc/>
     public bool Equals(Result? other)
     {
         if (ReferenceEquals(this, other)) return true;
@@ -167,17 +163,10 @@ public bool Equals(Result? other)
         return this is Success && other is Success;
     }
 
-    /// <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>
+    /// <inheritdoc/>
     public sealed override bool Equals(object? obj) => Equals(obj as Result);
 
-    /// <summary>
-    /// Serves as a hash code function for the current instance.
-    /// </summary>
-    /// <returns>Returns a hash code for the current instance.</returns>
+    /// <inheritdoc/>
     public sealed override int GetHashCode() => this is Failure failure ? failure.Exception.GetHashCode() : 0;
 
     /// <summary>
@@ -738,10 +727,7 @@ public void Throw()
             throw 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>
+    /// <inheritdoc/>
     public sealed override string ToString() => this is Failure failure ? failure.Exception.Message : string.Empty;
 }
 

OnixLabs.Core/ResultEqualityComparer.cs

@@ -30,10 +30,7 @@ public sealed class ResultEqualityComparer<T>(EqualityComparer<T>? valueComparer
     // ReSharper disable once HeapView.ObjectAllocation.Evident
     public static readonly ResultEqualityComparer<T> Default = new();
 
-    /// <summary>Determines whether the specified <see cref="Result{T}"/> values are equal.</summary>
-    /// <param name="x">The first object of type <see cref="Result{T}"/> to compare.</param>
-    /// <param name="y">The second object of type <see cref="Result{T}"/> to compare.</param>
-    /// <returns> Returns <see langword="true" /> if the specified <see cref="Result{T}"/> values are equal; otherwise, <see langword="false" />.</returns>
+    /// <inheritdoc/>
     public bool Equals(Result<T>? x, Result<T>? y)
     {
         if (ReferenceEquals(x, y)) return true;
@@ -48,8 +45,6 @@ public bool Equals(Result<T>? x, Result<T>? y)
         return valueComparer.GetOrDefault().Equals(xValue, yValue);
     }
 
-    /// <summary>Returns a hash code for the specified object.</summary>
-    /// <param name="obj">The <see cref="object" /> for which a hash code is to be returned.</param>
-    /// <returns>A hash code for the specified object.</returns>
+    /// <inheritdoc/>
     public int GetHashCode(Result<T> obj) => obj.GetHashCode();
 }

OnixLabs.Core/Specification.cs

@@ -105,9 +105,7 @@ public static Specification<T> Or(params IEnumerable<Specification<T>> specifica
 /// <typeparam name="T">The underlying type of the subject to which the specification applies.</typeparam>
 public class CriteriaSpecification<T>(Expression<Func<T, bool>> criteria) : Specification<T>
 {
-    /// <summary>
-    /// Gets the underlying expression criteria of the current specification.
-    /// </summary>
+    /// <inheritdoc/>
     public override Expression<Func<T, bool>> Criteria => criteria;
 }
 

OnixLabs.Security/SecurityToken.Equatable.cs

@@ -18,39 +18,18 @@ namespace OnixLabs.Security;
 
 public readonly partial struct SecurityToken
 {
-    /// <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>
+    /// <inheritdoc/>
     public bool Equals(SecurityToken other) => value.SequenceEqualOrNull(other.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>
+    /// <inheritdoc/>
     public override bool Equals(object? obj) => obj is SecurityToken other && Equals(other);
 
-    /// <summary>
-    /// Serves as a hash code function for the current instance.
-    /// </summary>
-    /// <returns>Returns a hash code for the current instance.</returns>
+    /// <inheritdoc/>
     public override int GetHashCode() => value.GetContentHashCode();
 
-    /// <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>
+    /// <inheritdoc/>
     public static bool operator ==(SecurityToken left, SecurityToken right) => left.Equals(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>
+    /// <inheritdoc/>
     public static bool operator !=(SecurityToken left, SecurityToken right) => !left.Equals(right);
 }