Skip to content

Commit 68545fb

Browse files
SslOption: use <seealso> for external links
DocFX doesn't seem to format <see href> the way I'd expect it to but <seealso href> decently formatted.
1 parent ecd4085 commit 68545fb

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

projects/RabbitMQ.Client/client/api/SslOption.cs

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,10 @@
4646
namespace RabbitMQ.Client
4747
{
4848
/// <summary>
49-
/// Represents a configurable SSL option, used in setting up an SSL connection.
49+
/// Represents a set of configurable TLS options for a connection. Use this class to configure
50+
/// TLS version used, client certificate list or file location, peer certificate verification
51+
/// (validation) functions, expected server name (Subject Alternative Name or Common Name),
52+
/// and so on.
5053
/// </summary>
5154
public class SslOption
5255
{
@@ -154,12 +157,12 @@ public X509CertificateCollection Certs
154157
/// Retrieve or set the TLS protocol version.
155158
/// The client will let the OS pick a suitable version by using <see cref="SslProtocols.None" />.
156159
/// If this option is disabled, e.g.see via app context, the client will attempt to fall back
157-
/// to TLSv1.2 (<see cref="SslProtocols.Tls12" />).
158-
/// <see cref="System.Security.Authentication.SslProtocols" />
159-
/// <see href="https://www.rabbitmq.com/ssl.html#dotnet-client" />
160-
/// <see href="https://docs.microsoft.com/en-us/dotnet/framework/network-programming/tls?view=netframework-4.6.2" />
161-
/// <see href="https://docs.microsoft.com/en-us/dotnet/api/system.security.authentication.sslprotocols?view=netframework-4.8" />
160+
/// to TLSv1.2.
162161
/// </summary>
162+
/// <seealso cref="SslProtocols" />
163+
/// <seealso href="https://www.rabbitmq.com/ssl.html#dotnet-client" />
164+
/// <seealso href="https://docs.microsoft.com/en-us/dotnet/framework/network-programming/tls?view=netframework-4.6.2" />
165+
/// <seealso href="https://docs.microsoft.com/en-us/dotnet/api/system.security.authentication.sslprotocols?view=netframework-4.8" />
163166
public SslProtocols Version { get; set; }
164167

165168
/// <summary>

0 commit comments

Comments
 (0)