Minor IModel API reference improvements (for 3.6.x)

Author: michaelklishin

projects/client/RabbitMQ.Client/src/client/api/IModel.cs

@@ -185,7 +185,7 @@ public interface IModel : IDisposable
         void Abort(ushort replyCode, string replyText);
 
         /// <summary>
-        /// (Spec method) Acknowledge one or more delivered message(s).
+        /// Acknowledge one or more delivered message(s).
         /// </summary>
         void BasicAck(ulong deliveryTag, bool multiple);
 
@@ -235,7 +235,7 @@ string BasicConsume(string queue,
             IBasicConsumer consumer);
 
         /// <summary>
-        /// (Spec method) Retrieve an individual message, if
+        /// Retrieve an individual message, if
         /// one is available; returns null if the server answers that
         /// no messages are currently available. See also <see cref="IModel.BasicAck"/>.
         /// </summary>
@@ -246,7 +246,7 @@ string BasicConsume(string queue,
         void BasicNack(ulong deliveryTag, bool multiple, bool requeue);
 
         /// <summary>
-        /// (Spec method) Convenience overload of BasicPublish.
+        /// Convenience overload of BasicPublish.
         /// </summary>
         /// <remarks>
         /// The publication occurs with mandatory=false and immediate=false.
@@ -255,7 +255,7 @@ string BasicConsume(string queue,
         void BasicPublish(PublicationAddress addr, IBasicProperties basicProperties, byte[] body);
 
         /// <summary>
-        /// (Spec method) Convenience overload of BasicPublish.
+        /// Convenience overload of BasicPublish.
         /// </summary>
         /// <remarks>
         /// The publication occurs with mandatory=false
@@ -264,14 +264,14 @@ string BasicConsume(string queue,
         void BasicPublish(string exchange, string routingKey, IBasicProperties basicProperties, byte[] body);
 
         /// <summary>
-        /// (Spec method) Convenience overload of BasicPublish.
+        /// Convenience overload of BasicPublish.
         /// </summary>
         [AmqpMethodDoNotImplement(null)]
         void BasicPublish(string exchange, string routingKey, bool mandatory,
             IBasicProperties basicProperties, byte[] body);
 
         /// <summary>
-        /// (Spec method) Configures QoS parameters of the Basic content-class.
+        /// Configures QoS parameters of the Basic content-class.
         /// </summary>
         void BasicQos(uint prefetchSize, ushort prefetchCount, bool global);
 
@@ -286,7 +286,7 @@ void BasicPublish(string exchange, string routingKey, bool mandatory,
         /// </summary>
         void BasicRecoverAsync(bool requeue);
 
-        /// <summary>(Spec method) Reject a delivered message.</summary>
+        /// <summary>Reject a delivered message.</summary>
         void BasicReject(ulong deliveryTag, bool requeue);
 
         /// <summary>Close this session.</summary>
@@ -327,24 +327,39 @@ void BasicPublish(string exchange, string routingKey, bool mandatory,
         IBasicProperties CreateBasicProperties();
 
         /// <summary>
-        /// (Extension method) Bind an exchange to an exchange.
+        /// Bind an exchange to an exchange.
         /// </summary>
+        /// <remarks>
+        ///   <para>
+        ///     Routing key must be shorter than 255 bytes.
+        ///   </para>
+        /// </remarks>
         [AmqpMethodDoNotImplement(null)]
         void ExchangeBind(string destination, string source, string routingKey, IDictionary<string, object> arguments);
 
         /// <summary>
-        /// (Extension method) Bind an exchange to an exchange.
+        /// Bind an exchange to an exchange.
         /// </summary>
+        /// <remarks>
+        ///   <para>
+        ///     Routing key must be shorter than 255 bytes.
+        ///   </para>
+        /// </remarks>
         [AmqpMethodDoNotImplement(null)]
         void ExchangeBind(string destination, string source, string routingKey);
 
         /// <summary>
-        ///Like ExchangeBind but sets nowait to true.
+        /// Like ExchangeBind but sets nowait to true.
         /// </summary>
+        /// <remarks>
+        ///   <para>
+        ///     Routing key must be shorter than 255 bytes.
+        ///   </para>
+        /// </remarks>
         void ExchangeBindNoWait(string destination, string source, string routingKey,
             IDictionary<string, object> arguments);
 
-        /// <summary>(Spec method) Declare an exchange.</summary>
+        /// <summary>Declare an exchange.</summary>
         /// <remarks>
         /// The exchange is declared non-passive and non-internal.
         /// The "nowait" option is not exercised.
@@ -354,7 +369,7 @@ void ExchangeDeclare(string exchange, string type, bool durable, bool autoDelete
             IDictionary<string, object> arguments);
 
         /// <summary>
-        /// (Spec method) Declare an exchange.
+        /// Declare an exchange.
         /// </summary>
         /// <remarks>
         /// The exchange is declared non-passive, non-autodelete, and
@@ -364,7 +379,7 @@ void ExchangeDeclare(string exchange, string type, bool durable, bool autoDelete
         void ExchangeDeclare(string exchange, string type, bool durable);
 
         /// <summary>
-        /// (Spec method) Declare an exchange.
+        /// Declare an exchange.
         /// </summary>
         /// <remarks>
         /// The exchange is declared non-passive, non-durable, non-autodelete, and
@@ -381,7 +396,7 @@ void ExchangeDeclareNoWait(string exchange, string type, bool durable, bool auto
             IDictionary<string, object> arguments);
 
         /// <summary>
-        /// (Spec method) Declare an exchange.
+        /// Declare an exchange.
         /// </summary>
         /// <remarks>
         /// The exchange is declared passive.
@@ -390,12 +405,12 @@ void ExchangeDeclareNoWait(string exchange, string type, bool durable, bool auto
         void ExchangeDeclarePassive(string exchange);
 
         /// <summary>
-        /// (Spec method) Delete an exchange.
+        /// Delete an exchange.
         /// </summary>
         [AmqpMethodDoNotImplement(null)]
         void ExchangeDelete(string exchange, bool ifUnused);
 
-        /// <summary>(Spec method) Delete an exchange.</summary>
+        /// <summary>Delete an exchange.</summary>
         /// <remarks>
         /// The exchange is deleted regardless of any queue bindings.
         /// </remarks>
@@ -408,17 +423,27 @@ void ExchangeDeclareNoWait(string exchange, string type, bool durable, bool auto
         void ExchangeDeleteNoWait(string exchange, bool ifUnused);
 
         /// <summary>
-        /// (Extension method) Unbind an exchange from an exchange.
+        /// Unbind an exchange from an exchange.
         /// </summary>
+        /// <remarks>
+        ///   <para>
+        ///     Routing key must be shorter than 255 bytes.
+        ///   </para>
+        /// </remarks>
         [AmqpMethodDoNotImplement(null)]
         void ExchangeUnbind(string destination,
             string source,
             string routingKey,
             IDictionary<string, object> arguments);
 
         /// <summary>
-        /// (Extension method) Unbind an exchange from an exchange.
+        /// Unbind an exchange from an exchange.
         /// </summary>
+        /// <remarks>
+        ///   <para>
+        ///     Routing key must be shorter than 255 bytes.
+        ///   </para>
+        /// </remarks>
         [AmqpMethodDoNotImplement(null)]
         void ExchangeUnbind(string destination, string source, string routingKey);
 
@@ -430,19 +455,34 @@ void ExchangeUnbindNoWait(string destination, string source, string routingKey,
             IDictionary<string, object> arguments);
 
         /// <summary>
-        /// (Spec method) Bind a queue to an exchange.
+        /// Bind a queue to an exchange.
         /// </summary>
+        /// <remarks>
+        ///   <para>
+        ///     Routing key must be shorter than 255 bytes.
+        ///   </para>
+        /// </remarks>
         [AmqpMethodDoNotImplement(null)]
         void QueueBind(string queue, string exchange, string routingKey, IDictionary<string, object> arguments);
 
-        /// <summary>(Spec method) Bind a queue to an exchange.</summary>
+        /// <summary>Bind a queue to an exchange.</summary>
+        /// <remarks>
+        ///   <para>
+        ///     Routing key must be shorter than 255 bytes.
+        ///   </para>
+        /// </remarks>
         [AmqpMethodDoNotImplement(null)]
         void QueueBind(string queue, string exchange, string routingKey);
 
         /// <summary>Same as QueueBind but sets nowait parameter to true.</summary>
+        /// <remarks>
+        ///   <para>
+        ///     Routing key must be shorter than 255 bytes.
+        ///   </para>
+        /// </remarks>
         void QueueBindNoWait(string queue, string exchange, string routingKey, IDictionary<string, object> arguments);
 
-        /// <summary>(Spec method) Declare a queue.</summary>
+        /// <summary>Declare a queue.</summary>
         /// <remarks>
         /// The queue is declared non-passive, non-durable,
         /// but exclusive and autodelete, with no arguments. The
@@ -451,7 +491,7 @@ void ExchangeUnbindNoWait(string destination, string source, string routingKey,
         [AmqpMethodDoNotImplement(null)]
         QueueDeclareOk QueueDeclare();
 
-        /// <summary>(Spec method) Declare a queue.</summary>
+        /// <summary>Declare a queue.</summary>
         [AmqpMethodDoNotImplement(null)]
         QueueDeclareOk QueueDeclare(string queue, bool durable, bool exclusive,
             bool autoDelete, IDictionary<string, object> arguments);
@@ -491,7 +531,7 @@ void QueueDeclareNoWait(string queue, bool durable, bool exclusive,
         uint ConsumerCount(string queue);
 
         /// <summary>
-        /// (Spec method) Delete a queue.
+        /// Delete a queue.
         /// </summary>
         /// <remarks>
         ///Returns the number of messages purged during queue deletion.
@@ -501,7 +541,7 @@ void QueueDeclareNoWait(string queue, bool durable, bool exclusive,
         uint QueueDelete(string queue, bool ifUnused, bool ifEmpty);
 
         /// <summary>
-        /// (Spec method) Delete a queue.
+        /// Delete a queue.
         /// </summary>
         /// <remarks>
         ///Returns the number of messages purged during queue deletion.
@@ -516,7 +556,7 @@ void QueueDeclareNoWait(string queue, bool durable, bool exclusive,
         void QueueDeleteNoWait(string queue, bool ifUnused, bool ifEmpty);
 
         /// <summary>
-        /// (Spec method) Purge a queue of messages.
+        /// Purge a queue of messages.
         /// </summary>
         /// <remarks>
         /// Returns the number of messages purged.
@@ -525,22 +565,22 @@ void QueueDeclareNoWait(string queue, bool durable, bool exclusive,
         uint QueuePurge(string queue);
 
         /// <summary>
-        /// (Spec method) Unbind a queue from an exchange.
+        /// Unbind a queue from an exchange.
         /// </summary>
         void QueueUnbind(string queue, string exchange, string routingKey, IDictionary<string, object> arguments);
 
         /// <summary>
-        /// (Spec method) Commit this session's active TX transaction.
+        /// Commit this session's active TX transaction.
         /// </summary>
         void TxCommit();
 
         /// <summary>
-        /// (Spec method) Roll back this session's active TX transaction.
+        /// Roll back this session's active TX transaction.
         /// </summary>
         void TxRollback();
 
         /// <summary>
-        /// (Spec method) Enable TX mode for this session.
+        /// Enable TX mode for this session.
         /// </summary>
         void TxSelect();