Skip to content

Commit 09851bd

Browse files
jstedfastjstedfast
committed
Fixed ProxyClient.Connect/Async docs for host & port parameters
1 parent e3790d9 commit 09851bd

File tree

5 files changed

+28
-28
lines changed

5 files changed

+28
-28
lines changed

‎MailKit/Net/Proxy/HttpProxyClient.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,8 @@ internal static void ValidateHttpResponse (string response, string host, int por
152152
/// Connects to the target host and port through the proxy server.
153153
/// </remarks>
154154
/// <returns>The connected network stream.</returns>
155-
/// <param name="host">The host name of the proxy server.</param>
156-
/// <param name="port">The proxy server port.</param>
155+
/// <param name="host">The host name of the target server.</param>
156+
/// <param name="port">The target server port.</param>
157157
/// <param name="cancellationToken">The cancellation token.</param>
158158
/// <exception cref="System.ArgumentNullException">
159159
/// <paramref name="host"/> is <c>null</c>.
@@ -221,8 +221,8 @@ public override Stream Connect (string host, int port, CancellationToken cancell
221221
/// Asynchronously connects to the target host and port through the proxy server.
222222
/// </remarks>
223223
/// <returns>The connected network stream.</returns>
224-
/// <param name="host">The host name of the proxy server.</param>
225-
/// <param name="port">The proxy server port.</param>
224+
/// <param name="host">The host name of the target server.</param>
225+
/// <param name="port">The target server port.</param>
226226
/// <param name="cancellationToken">The cancellation token.</param>
227227
/// <exception cref="System.ArgumentNullException">
228228
/// <paramref name="host"/> is <c>null</c>.

‎MailKit/Net/Proxy/HttpsProxyClient.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -245,8 +245,8 @@ SslClientAuthenticationOptions GetSslClientAuthenticationOptions (string host, R
245245
/// Connects to the target host and port through the proxy server.
246246
/// </remarks>
247247
/// <returns>The connected network stream.</returns>
248-
/// <param name="host">The host name of the proxy server.</param>
249-
/// <param name="port">The proxy server port.</param>
248+
/// <param name="host">The host name of the target server.</param>
249+
/// <param name="port">The target server port.</param>
250250
/// <param name="cancellationToken">The cancellation token.</param>
251251
/// <exception cref="System.ArgumentNullException">
252252
/// <paramref name="host"/> is <c>null</c>.
@@ -326,8 +326,8 @@ public override Stream Connect (string host, int port, CancellationToken cancell
326326
/// Asynchronously connects to the target host and port through the proxy server.
327327
/// </remarks>
328328
/// <returns>The connected network stream.</returns>
329-
/// <param name="host">The host name of the proxy server.</param>
330-
/// <param name="port">The proxy server port.</param>
329+
/// <param name="host">The host name of the target server.</param>
330+
/// <param name="port">The target server port.</param>
331331
/// <param name="cancellationToken">The cancellation token.</param>
332332
/// <exception cref="System.ArgumentNullException">
333333
/// <paramref name="host"/> is <c>null</c>.

‎MailKit/Net/Proxy/IProxyClient.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ public interface IProxyClient
8888
/// Connects to the target host and port through the proxy server.
8989
/// </remarks>
9090
/// <returns>The connected network stream.</returns>
91-
/// <param name="host">The host name of the proxy server.</param>
92-
/// <param name="port">The proxy server port.</param>
91+
/// <param name="host">The host name of the target server.</param>
92+
/// <param name="port">The target server port.</param>
9393
/// <param name="cancellationToken">The cancellation token.</param>
9494
/// <exception cref="System.ArgumentNullException">
9595
/// <paramref name="host"/> is <c>null</c>.
@@ -118,8 +118,8 @@ public interface IProxyClient
118118
/// Asynchronously connects to the target host and port through the proxy server.
119119
/// </remarks>
120120
/// <returns>The connected network stream.</returns>
121-
/// <param name="host">The host name of the proxy server.</param>
122-
/// <param name="port">The proxy server port.</param>
121+
/// <param name="host">The host name of the target server.</param>
122+
/// <param name="port">The target server port.</param>
123123
/// <param name="cancellationToken">The cancellation token.</param>
124124
/// <exception cref="System.ArgumentNullException">
125125
/// <paramref name="host"/> is <c>null</c>.
@@ -148,8 +148,8 @@ public interface IProxyClient
148148
/// Connects to the target host and port through the proxy server.
149149
/// </remarks>
150150
/// <returns>The connected network stream.</returns>
151-
/// <param name="host">The host name of the proxy server.</param>
152-
/// <param name="port">The proxy server port.</param>
151+
/// <param name="host">The host name of the target server.</param>
152+
/// <param name="port">The target server port.</param>
153153
/// <param name="timeout">The timeout, in milliseconds.</param>
154154
/// <param name="cancellationToken">The cancellation token.</param>
155155
/// <exception cref="System.ArgumentNullException">
@@ -182,8 +182,8 @@ public interface IProxyClient
182182
/// Asynchronously connects to the target host and port through the proxy server.
183183
/// </remarks>
184184
/// <returns>The connected network stream.</returns>
185-
/// <param name="host">The host name of the proxy server.</param>
186-
/// <param name="port">The proxy server port.</param>
185+
/// <param name="host">The host name of the target server.</param>
186+
/// <param name="port">The target server port.</param>
187187
/// <param name="timeout">The timeout, in milliseconds.</param>
188188
/// <param name="cancellationToken">The cancellation token.</param>
189189
/// <exception cref="System.ArgumentNullException">

‎MailKit/Net/Proxy/ProxyClient.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -285,8 +285,8 @@ internal static async Task<int> ReceiveAsync (Socket socket, byte[] buffer, int
285285
/// Connects to the target host and port through the proxy server.
286286
/// </remarks>
287287
/// <returns>The connected network stream.</returns>
288-
/// <param name="host">The host name of the proxy server.</param>
289-
/// <param name="port">The proxy server port.</param>
288+
/// <param name="host">The host name of the target server.</param>
289+
/// <param name="port">The target server port.</param>
290290
/// <param name="cancellationToken">The cancellation token.</param>
291291
/// <exception cref="System.ArgumentNullException">
292292
/// <paramref name="host"/> is <c>null</c>.
@@ -315,8 +315,8 @@ internal static async Task<int> ReceiveAsync (Socket socket, byte[] buffer, int
315315
/// Asynchronously connects to the target host and port through the proxy server.
316316
/// </remarks>
317317
/// <returns>The connected network stream.</returns>
318-
/// <param name="host">The host name of the proxy server.</param>
319-
/// <param name="port">The proxy server port.</param>
318+
/// <param name="host">The host name of the target server.</param>
319+
/// <param name="port">The target server port.</param>
320320
/// <param name="cancellationToken">The cancellation token.</param>
321321
/// <exception cref="System.ArgumentNullException">
322322
/// <paramref name="host"/> is <c>null</c>.
@@ -345,8 +345,8 @@ internal static async Task<int> ReceiveAsync (Socket socket, byte[] buffer, int
345345
/// Connects to the target host and port through the proxy server.
346346
/// </remarks>
347347
/// <returns>The connected network stream.</returns>
348-
/// <param name="host">The host name of the proxy server.</param>
349-
/// <param name="port">The proxy server port.</param>
348+
/// <param name="host">The host name of the target server.</param>
349+
/// <param name="port">The target server port.</param>
350350
/// <param name="timeout">The timeout, in milliseconds.</param>
351351
/// <param name="cancellationToken">The cancellation token.</param>
352352
/// <exception cref="System.ArgumentNullException">
@@ -396,8 +396,8 @@ public virtual Stream Connect (string host, int port, int timeout, CancellationT
396396
/// Asynchronously connects to the target host and port through the proxy server.
397397
/// </remarks>
398398
/// <returns>The connected network stream.</returns>
399-
/// <param name="host">The host name of the proxy server.</param>
400-
/// <param name="port">The proxy server port.</param>
399+
/// <param name="host">The host name of the target server.</param>
400+
/// <param name="port">The target server port.</param>
401401
/// <param name="timeout">The timeout, in milliseconds.</param>
402402
/// <param name="cancellationToken">The cancellation token.</param>
403403
/// <exception cref="System.ArgumentNullException">

‎MailKit/Net/Proxy/Socks5Client.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -367,8 +367,8 @@ int ProcessPartialConnectResponse (string host, int port, byte[] buffer)
367367
/// Connects to the target host and port through the proxy server.
368368
/// </remarks>
369369
/// <returns>The connected network stream.</returns>
370-
/// <param name="host">The host name of the proxy server.</param>
371-
/// <param name="port">The proxy server port.</param>
370+
/// <param name="host">The host name of the target server.</param>
371+
/// <param name="port">The target server port.</param>
372372
/// <param name="cancellationToken">The cancellation token.</param>
373373
/// <exception cref="System.ArgumentNullException">
374374
/// <paramref name="host"/> is <c>null</c>.
@@ -465,8 +465,8 @@ public override Stream Connect (string host, int port, CancellationToken cancell
465465
/// Asynchronously connects to the target host and port through the proxy server.
466466
/// </remarks>
467467
/// <returns>The connected network stream.</returns>
468-
/// <param name="host">The host name of the proxy server.</param>
469-
/// <param name="port">The proxy server port.</param>
468+
/// <param name="host">The host name of the target server.</param>
469+
/// <param name="port">The target server port.</param>
470470
/// <param name="cancellationToken">The cancellation token.</param>
471471
/// <exception cref="System.ArgumentNullException">
472472
/// <paramref name="host"/> is <c>null</c>.

0 commit comments

Comments
 (0)