Update XML docs to use discard param names and clarify types

Replaced unused parameter names with discards (`_`, `__`) in `Unit` and updated XML docs to refer generically to parameters. Also revised `Mediator` documentation to use non-generic type references for clarity.

Author: Vadim Belov

Sources/EasyExtensions.Mediator/Contracts/Unit.cs

@@ -23,28 +23,28 @@ namespace EasyExtensions.Mediator.Contracts
         /// <summary>
         /// Compares the current object with another object of the same type.
         /// </summary>
-        /// <param name="other">An object to compare with this object.</param>
+        /// <param name="_">An object to compare with this object.</param>
         /// <returns>
         /// A value that indicates the relative order of the objects being compared.
         /// The return value has the following meanings:
-        ///  - Less than zero: This object is less than the <paramref name="other" /> parameter.
-        ///  - Zero: This object is equal to <paramref name="other" />.
-        ///  - Greater than zero: This object is greater than <paramref name="other" />.
+        ///  - Less than zero: This object is less than the parameter.
+        ///  - Zero: This object is equal to the parameter.
+        ///  - Greater than zero: This object is greater than the parameter.
         /// </returns>
-        public int CompareTo(Unit other) => 0;
+        public int CompareTo(Unit _) => 0;
 
         /// <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 this instance.</param>
+        /// <param name="_">An object to compare with this instance.</param>
         /// <returns>
         /// A value that indicates the relative order of the objects being compared.
         /// The return value has these meanings:
-        ///  - Less than zero: This instance precedes <paramref name="obj" /> in the sort order.
-        ///  - Zero: This instance occurs in the same position in the sort order as <paramref name="obj" />.
-        ///  - Greater than zero: This instance follows <paramref name="obj" /> in the sort order.
+        ///  - Less than zero: This instance precedes the object in the sort order.
+        ///  - Zero: This instance occurs in the same position in the sort order as the object.
+        ///  - Greater than zero: This instance follows the object in the sort order.
         /// </returns>
-        int IComparable.CompareTo(object? obj) => 0;
+        int IComparable.CompareTo(object? _) => 0;
 
         /// <summary>
         /// Returns a hash code for this instance.
@@ -57,11 +57,11 @@ namespace EasyExtensions.Mediator.Contracts
         /// <summary>
         /// Determines whether the current object is equal to another object of the same type.
         /// </summary>
-        /// <param name="other">An object to compare with this object.</param>
+        /// <param name="_">An object to compare with this object.</param>
         /// <returns>
-        /// <c>true</c> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <c>false</c>.
+        /// <c>true</c> if the current object is equal to the parameter; otherwise, <c>false</c>.
         /// </returns>
-        public bool Equals(Unit other) => true;
+        public bool Equals(Unit _) => true;
 
         /// <summary>
         /// Determines whether the specified <see cref="System.Object" /> is equal to this instance.
@@ -73,20 +73,20 @@ namespace EasyExtensions.Mediator.Contracts
         public override bool Equals(object? obj) => obj is Unit;
 
         /// <summary>
-        /// Determines whether the <paramref name="first"/> object is equal to the <paramref name="second"/> object.
+        /// Determines whether the first object is equal to the second object.
         /// </summary>
-        /// <param name="first">The first object.</param>
-        /// <param name="second">The second object.</param>
-        /// <c>true</c> if the <paramref name="first"/> object is equal to the <paramref name="second" /> object; otherwise, <c>false</c>.
-        public static bool operator ==(Unit first, Unit second) => true;
+        /// <param name="_">The first object.</param>
+        /// <param name="__">The second object.</param>
+        /// <returns><c>true</c> if the first object is equal to the second object; otherwise, <c>false</c>.</returns>
+        public static bool operator ==(Unit _, Unit __) => true;
 
         /// <summary>
-        /// Determines whether the <paramref name="first"/> object is not equal to the <paramref name="second"/> object.
+        /// Determines whether the first object is not equal to the second object.
         /// </summary>
-        /// <param name="first">The first object.</param>
-        /// <param name="second">The second object.</param>
-        /// <c>true</c> if the <paramref name="first"/> object is not equal to the <paramref name="second" /> object; otherwise, <c>false</c>.
-        public static bool operator !=(Unit first, Unit second) => false;
+        /// <param name="_">The first object.</param>
+        /// <param name="__">The second object.</param>
+        /// <returns><c>true</c> if the first object is not equal to the second object; otherwise, <c>false</c>.</returns>
+        public static bool operator !=(Unit _, Unit __) => false;
 
         /// <summary>
         /// Returns a <see cref="System.String" /> that represents this instance.

Sources/EasyExtensions.Mediator/Mediator.cs

@@ -98,12 +98,12 @@ public Task Send<TRequest>(TRequest request, CancellationToken cancellationToken
         /// <remarks>The request is dispatched to a handler based on its runtime type. If multiple
         /// handlers are registered for the same request type, the behavior is implementation-specific. The method
         /// supports both requests with and without a response type.</remarks>
-        /// <param name="request">The request object to send. Must implement either IRequest or IRequest<TResponse>.</param>
+        /// <param name="request">The request object to send. Must implement either IRequest or IRequest with a response type.</param>
         /// <param name="cancellationToken">A cancellation token that can be used to cancel the request operation.</param>
         /// <returns>A task that represents the asynchronous operation. The task result contains the response from the handler,
         /// or null if the request does not produce a response.</returns>
         /// <exception cref="ArgumentNullException">Thrown if the request parameter is null.</exception>
-        /// <exception cref="ArgumentException">Thrown if the request object does not implement IRequest or IRequest<TResponse>.</exception>
+        /// <exception cref="ArgumentException">Thrown if the request object does not implement IRequest or IRequest with a response type.</exception>
         /// <exception cref="InvalidOperationException">Thrown if a handler wrapper cannot be created for the specified request type.</exception>
         public Task<object?> Send(object request, CancellationToken cancellationToken = default)
         {
@@ -234,12 +234,12 @@ public IAsyncEnumerable<TResponse> CreateStream<TResponse>(IStreamRequest<TRespo
         /// <remarks>The returned stream is evaluated asynchronously. Consumers should enumerate the
         /// stream using await foreach. Each call to this method resolves the appropriate handler for the request type
         /// using dependency injection.</remarks>
-        /// <param name="request">The request object to process. Must implement the IStreamRequest<TResponse> interface.</param>
+        /// <param name="request">The request object to process. Must implement the IStreamRequest interface.</param>
         /// <param name="cancellationToken">A cancellation token that can be used to cancel the stream operation.</param>
         /// <returns>An asynchronous stream of response objects corresponding to the request. The stream may be empty if there
         /// are no results.</returns>
         /// <exception cref="ArgumentNullException">Thrown if the request parameter is null.</exception>
-        /// <exception cref="ArgumentException">Thrown if the request object does not implement the IStreamRequest<TResponse> interface.</exception>
+        /// <exception cref="ArgumentException">Thrown if the request object does not implement the IStreamRequest interface.</exception>
         /// <exception cref="InvalidOperationException">Thrown if a handler wrapper for the request type cannot be created.</exception>
         public IAsyncEnumerable<object?> CreateStream(object request, CancellationToken cancellationToken = default)
         {