Skip to content

Commit c11ea5c

Browse files
author
Emile Joubert
committed
Correct broken documentation tags
1 parent 5134ab2 commit c11ea5c

File tree

4 files changed

+24
-21
lines changed

4 files changed

+24
-21
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@
4141

4242
namespace RabbitMQ.Client
4343
{
44-
/// A pluggable authentication mechanism.
44+
///<summary>A pluggable authentication mechanism.</summary>
4545
public interface AuthMechanism {
46-
/// Handle one round of challenge-response
46+
///<summary>Handle one round of challenge-response</summary>
4747
byte[] handleChallenge(byte[] challenge, ConnectionFactory factory);
4848
}
49-
}
49+
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@
4242
namespace RabbitMQ.Client
4343
{
4444
public interface AuthMechanismFactory {
45-
/// Return a new authentication mechanism implementation
45+
///<summary>Return a new authentication mechanism implementation</summary>
4646
AuthMechanism GetInstance();
4747

48-
/// The name of the authentication mechanism, as negotiated on the wire
48+
///<summary>The name of the authentication mechanism, as negotiated on the wire</summary>
4949
string Name { get; }
5050
}
51-
}
51+
}

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

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -317,26 +317,28 @@ uint QueueDelete(string queue,
317317
[AmqpUnsupported("RabbitMQ.Client.Framing.v0_9")]
318318
void ConfirmSelect();
319319

320-
//<summary>Wait until all published messages have been confirmed.
321-
//<remarks>
322-
//Waits until all messages published since the last call have
323-
//been either ack'd or nack'd by the broker. Returns whether
324-
//all the messages were ack'd (and none were nack'd). Note,
325-
//when called on a non-Confirm channel, returns true
326-
//immediately.
327-
//</remarks>
320+
///<summary>Wait until all published messages have been confirmed.
321+
///</summary>
322+
///<remarks>
323+
///Waits until all messages published since the last call have
324+
///been either ack'd or nack'd by the broker. Returns whether
325+
///all the messages were ack'd (and none were nack'd). Note,
326+
///when called on a non-Confirm channel, returns true
327+
///immediately.
328+
///</remarks>
328329
[AmqpMethodDoNotImplement(null)]
329330
[AmqpUnsupported("RabbitMQ.Client.Framing.v0_8qpid")]
330331
[AmqpUnsupported("RabbitMQ.Client.Framing.v0_8")]
331332
[AmqpUnsupported("RabbitMQ.Client.Framing.v0_9")]
332333
bool WaitForConfirms();
333334

334-
//<summary>Wait until all published messages have been confirmed.
335-
//<remarks>
336-
//Waits until all messages published since the last call have
337-
//been ack'd by the broker. If a nack is received, throws an
338-
//OperationInterrupedException exception immediately.
339-
//</remarks>
335+
///<summary>Wait until all published messages have been confirmed.
336+
///</summary>
337+
///<remarks>
338+
///Waits until all messages published since the last call have
339+
///been ack'd by the broker. If a nack is received, throws an
340+
///OperationInterrupedException exception immediately.
341+
///</remarks>
340342
[AmqpMethodDoNotImplement(null)]
341343
[AmqpUnsupported("RabbitMQ.Client.Framing.v0_8qpid")]
342344
[AmqpUnsupported("RabbitMQ.Client.Framing.v0_8")]

projects/client/RabbitMQ.Client/src/client/events/BasicNackEventArgs.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@ public bool Multiple
7070
set { m_multiple = value; }
7171
}
7272

73-
//<summary>Clients should ignore this field.</summary>
73+
///<summary>Ignore</summary>
74+
///<remarks>Clients should ignore this field.</remarks>
7475
public bool Requeue
7576
{
7677
get { return m_requeue; }

0 commit comments

Comments
 (0)