Skip to content

Commit

Permalink
Fixed ProxyClient.Connect/Async docs for host & port parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
jstedfast committed Sep 29, 2024
1 parent e3790d9 commit 09851bd
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 28 deletions.
8 changes: 4 additions & 4 deletions MailKit/Net/Proxy/HttpProxyClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,8 @@ internal static void ValidateHttpResponse (string response, string host, int por
/// Connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="host"/> is <c>null</c>.
Expand Down Expand Up @@ -221,8 +221,8 @@ public override Stream Connect (string host, int port, CancellationToken cancell
/// Asynchronously connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="host"/> is <c>null</c>.
Expand Down
8 changes: 4 additions & 4 deletions MailKit/Net/Proxy/HttpsProxyClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -245,8 +245,8 @@ SslClientAuthenticationOptions GetSslClientAuthenticationOptions (string host, R
/// Connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="host"/> is <c>null</c>.
Expand Down Expand Up @@ -326,8 +326,8 @@ public override Stream Connect (string host, int port, CancellationToken cancell
/// Asynchronously connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="host"/> is <c>null</c>.
Expand Down
16 changes: 8 additions & 8 deletions MailKit/Net/Proxy/IProxyClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ public interface IProxyClient
/// Connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="host"/> is <c>null</c>.
Expand Down Expand Up @@ -118,8 +118,8 @@ public interface IProxyClient
/// Asynchronously connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="host"/> is <c>null</c>.
Expand Down Expand Up @@ -148,8 +148,8 @@ public interface IProxyClient
/// Connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="timeout">The timeout, in milliseconds.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
Expand Down Expand Up @@ -182,8 +182,8 @@ public interface IProxyClient
/// Asynchronously connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="timeout">The timeout, in milliseconds.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
Expand Down
16 changes: 8 additions & 8 deletions MailKit/Net/Proxy/ProxyClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -285,8 +285,8 @@ internal static async Task<int> ReceiveAsync (Socket socket, byte[] buffer, int
/// Connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="host"/> is <c>null</c>.
Expand Down Expand Up @@ -315,8 +315,8 @@ internal static async Task<int> ReceiveAsync (Socket socket, byte[] buffer, int
/// Asynchronously connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="host"/> is <c>null</c>.
Expand Down Expand Up @@ -345,8 +345,8 @@ internal static async Task<int> ReceiveAsync (Socket socket, byte[] buffer, int
/// Connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="timeout">The timeout, in milliseconds.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
Expand Down Expand Up @@ -396,8 +396,8 @@ public virtual Stream Connect (string host, int port, int timeout, CancellationT
/// Asynchronously connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="timeout">The timeout, in milliseconds.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
Expand Down
8 changes: 4 additions & 4 deletions MailKit/Net/Proxy/Socks5Client.cs
Original file line number Diff line number Diff line change
Expand Up @@ -367,8 +367,8 @@ int ProcessPartialConnectResponse (string host, int port, byte[] buffer)
/// Connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="host"/> is <c>null</c>.
Expand Down Expand Up @@ -465,8 +465,8 @@ public override Stream Connect (string host, int port, CancellationToken cancell
/// Asynchronously connects to the target host and port through the proxy server.
/// </remarks>
/// <returns>The connected network stream.</returns>
/// <param name="host">The host name of the proxy server.</param>
/// <param name="port">The proxy server port.</param>
/// <param name="host">The host name of the target server.</param>
/// <param name="port">The target server port.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="host"/> is <c>null</c>.
Expand Down

0 comments on commit 09851bd

Please sign in to comment.