Skip to content

Commit 6ba4603

Browse files
committed
Tidy up Connection docs
The Kerberos header and description were not emitted in docs because the multiline comment did not start with two asterisks.
1 parent fc00a17 commit 6ba4603

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

src/Tests/Tests/ClientConcepts/Connection/ModifyingDefaultConnection.doc.cs

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -120,15 +120,16 @@ public void InMemoryConnectionOverloadedCtor()
120120
*
121121
* By deriving from `HttpConnection`, it is possible to change the behaviour of the connection. The following
122122
* provides some examples
123-
*
124-
*
123+
*/
124+
#if !DOTNETCORE
125+
126+
/**
125127
* [[servicepoint-behaviour]]
126128
* ===== ServicePoint behaviour
127129
*
128130
* If you are running on the Desktop CLR you can override specific properties for the current `ServicePoint` easily
129131
* by overriding `AlterServicePoint` on an `IConnection` implementation deriving from `HttpConnection`
130132
*/
131-
#if !DOTNETCORE
132133
public class MyCustomHttpConnection : HttpConnection
133134
{
134135
protected override void AlterServicePoint(ServicePoint requestServicePoint, RequestData requestData)
@@ -186,15 +187,16 @@ public void UseX509CertificateHttpConnection()
186187
*/
187188
#endif
188189
#if DOTNETCORE
189-
/*
190+
/**
190191
* [[kerberos-authentication]]
191192
* ===== Kerberos Authentication
192193
*
193-
* For a lot of use cases subclassing HttpConnection is a great way to customize the http connection for your needs.
194-
* E.g if you want to authenticate with Kerberos, creating a custom HttpConnection as followed allows you to set the right HTTP headers.
194+
* For a lot of use cases, deriving from `HttpConnection` is a great way to customize the connection for your needs.
195+
* If you want to authenticate with Kerberos for example, creating a custom `HttpConnection` as follows
196+
* allows you to set the right HTTP headers
195197
*
196198
*
197-
* TIP use something like https://www.nuget.org/packages/Kerberos.NET/ to fill in the actual blanks of this implementation
199+
* TIP: use something like https://www.nuget.org/packages/Kerberos.NET/ to fill in the actual blanks of this implementation
198200
*/
199201
public class KerberosConnection : HttpConnection
200202
{

0 commit comments

Comments
 (0)