Skip to content

Commit ae11687

Browse files
authored
Move remarks into summary to make them more visible (#1594)
1 parent 4256e08 commit ae11687

File tree

2 files changed

+8
-12
lines changed

2 files changed

+8
-12
lines changed

src/NServiceBus.Transport.RabbitMQ/Configuration/RabbitMQTransportSettingsExtensions.cs

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,11 @@ public static TransportExtensions<RabbitMQTransport> CustomMessageIdStrategy(thi
116116

117117
/// <summary>
118118
/// Disables the specified broker requirement checks.
119+
/// <br />
120+
/// Using a broker that does not meet all of the requirements can result in message loss or other incorrect operation, so disabling checks is not recommended.
119121
/// </summary>
120122
/// <param name="transportExtensions"></param>
121123
/// <param name="brokerRequirementChecks">The broker requirement checks to disable.</param>
122-
/// <remarks>
123-
/// Using a broker that does not meet all of the requirements can result in message loss or other incorrect operation, so disabling checks is not recommended.
124-
/// </remarks>
125124
[PreObsolete("https://github.com/Particular/NServiceBus/issues/6811",
126125
Message = "This is now part of routing topology configuration, which has been moved to the constructor of the RabbitMQTransport class.",
127126
Note = "Should not be converted to an ObsoleteEx until API mismatch described in issue is resolved.")]
@@ -165,10 +164,9 @@ public static TransportExtensions<RabbitMQTransport> DisableRemoteCertificateVal
165164

166165
/// <summary>
167166
/// Specifies that the transport should not validate that queue delivery limits are configured properly to avoid interfering with message recoverability.
168-
/// </summary>
169-
/// <remarks>
167+
/// <br />
170168
/// Incorrect delivery limit settings could result in message loss, so disabling validation is not recommended.
171-
/// </remarks>
169+
/// </summary>
172170
[PreObsolete("https://github.com/Particular/NServiceBus/issues/6811",
173171
ReplacementTypeOrMember = "RabbitMQTransport.ValidateDeliveryLimits",
174172
Message = "The configuration has been moved to RabbitMQTransport class.",

src/NServiceBus.Transport.RabbitMQ/RabbitMQTransport.cs

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -139,10 +139,9 @@ public PrefetchCountCalculation PrefetchCountCalculation
139139

140140
/// <summary>
141141
/// Should the transport validate that queue delivery limits are configured properly to avoid interfering with message recoverability.
142-
/// </summary>
143-
/// <remarks>
142+
/// <br />
144143
/// Incorrect delivery limit settings could result in message loss, so disabling validation is not recommended.
145-
/// </remarks>
144+
/// </summary>
146145
public bool ValidateDeliveryLimits { get; set; } = true;
147146

148147
/// <summary>
@@ -152,10 +151,9 @@ public PrefetchCountCalculation PrefetchCountCalculation
152151

153152
/// <summary>
154153
/// The broker requirement checks to disable.
155-
/// </summary>
156-
/// <remarks>
154+
/// <br />
157155
/// Using a broker that does not meet all of the requirements can result in message loss or other incorrect operation, so disabling the checks is not recommended.
158-
/// </remarks>
156+
/// </summary>
159157
public BrokerRequirementChecks DisabledBrokerRequirementChecks { get; set; }
160158

161159
/// <summary>

0 commit comments

Comments
 (0)