Finish up XML docs.

Author: lukebakken

RabbitMQ.AMQP.Client/IPublisher.cs

@@ -33,8 +33,8 @@ public enum OutcomeState
     }
 
     /// <summary>
-    ///  PublishOutcome represents the outcome of a publish operation.
-    ///  It contains the state of the outcome and an error if the outcome is not successful.
+    /// Represents the outcome of a publish operation.
+    /// It contains the state of the outcome and an error if the outcome is not successful.
     /// </summary>
     public class PublishOutcome
     {
@@ -44,11 +44,21 @@ public PublishOutcome(OutcomeState state, Error? error)
             Error = error;
         }
 
+        /// <summary>
+        /// The <see cref="OutcomeState"/>.
+        /// </summary>
         public OutcomeState State { get; }
 
+        /// <summary>
+        /// The <see cref="Error"/>, if any.
+        /// </summary>
         public Error? Error { get; }
     }
 
+    /// <summary>
+    /// Represents the result of a publish operation.
+    /// It contains the <see cref="PublishOutcome"/> and the original <see cref="IMessage"/>.
+    /// </summary>
     public class PublishResult
     {
         public PublishResult(IMessage message, PublishOutcome outcome)
@@ -63,8 +73,8 @@ public PublishResult(IMessage message, PublishOutcome outcome)
     }
 
     /// <summary>
-    ///  Interface for publishing messages to an AMQP broker.
-    ///  Implementations of this interface are expected to be thread-safe.
+    /// Interface for publishing messages to an AMQP broker.
+    /// Implementations of this interface are expected to be thread-safe.
     /// </summary>
     public interface IPublisher : ILifeCycle
     {

RabbitMQ.AMQP.Client/Impl/AmqpConsumer.cs

@@ -14,6 +14,9 @@
 
 namespace RabbitMQ.AMQP.Client.Impl
 {
+    /// <summary>
+    /// Implementation of <see cref="IConsumer"/>.
+    /// </summary>
     public class AmqpConsumer : AbstractReconnectLifeCycle, IConsumer
     {
         private enum PauseStatus

RabbitMQ.AMQP.Client/Impl/AmqpPublisher.cs

@@ -13,6 +13,9 @@
 
 namespace RabbitMQ.AMQP.Client.Impl
 {
+    /// <summary>
+    /// Implementation of <see cref="IPublisher"/>.
+    /// </summary>
     public class AmqpPublisher : AbstractReconnectLifeCycle, IPublisher
     {
         private readonly AmqpConnection _connection;
@@ -30,6 +33,10 @@ public AmqpPublisher(AmqpConnection connection, string? address, IMetricsReporte
             _connection.AddPublisher(_id, this);
         }
 
+        /// <summary>
+        /// Open this publisher
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the async operation.</returns>
         public override async Task OpenAsync()
         {
             try
@@ -91,13 +98,11 @@ await base.OpenAsync()
         }
 
         /// <summary>
-        /// Publishes a message to the broker in an asynchronous manner.
-        /// The PublishResult is synchronous. In order to increase the performance
-        /// you can use more tasks to publish messages in parallel
+        /// Publishes a message to the broker asynchronously.
         /// </summary>
         /// <param name="message"></param>
         /// <param name="cancellationToken"></param>
-        /// <returns></returns>
+        /// <returns>A <see cref="Task"/> representating the await-able result of the publish operation.</returns>
         /// <exception cref="InvalidOperationException"></exception>
         /// <exception cref="NotSupportedException"></exception>
         /// <exception cref="PublisherException"></exception>
@@ -201,6 +206,10 @@ void OutcomeCallback(ILink sender, Message inMessage, Outcome outcome, object st
             return publishResultTcs.Task;
         }
 
+        /// <summary>
+        /// Close this publisher
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the async operation.</returns>
         public override async Task CloseAsync()
         {
             if (_senderLink is null)