Skip to content

Commit f03b899

Browse files
committed
Fix path to examples.
1 parent 0467468 commit f03b899

11 files changed

+462
-462
lines changed

src/Renci.SshNet/BaseClient.cs

Lines changed: 422 additions & 422 deletions
Large diffs are not rendered by default.

src/Renci.SshNet/ConnectionInfo.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ public class ConnectionInfo : IConnectionInfoInternal
122122
/// The connection timeout. The default value is 30 seconds.
123123
/// </value>
124124
/// <example>
125-
/// <code source="..\..\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient Connect Timeout" language="C#" title="Specify connection timeout" />
125+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient Connect Timeout" language="C#" title="Specify connection timeout" />
126126
/// </example>
127127
public TimeSpan Timeout { get; set; }
128128

@@ -156,7 +156,7 @@ public class ConnectionInfo : IConnectionInfoInternal
156156
/// Occurs when authentication banner is sent by the server.
157157
/// </summary>
158158
/// <example>
159-
/// <code source="..\..\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo AuthenticationBanner" language="C#" title="Display authentication banner" />
159+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo AuthenticationBanner" language="C#" title="Display authentication banner" />
160160
/// </example>
161161
public event EventHandler<AuthenticationBannerEventArgs> AuthenticationBanner;
162162

src/Renci.SshNet/ForwardedPortLocal.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public override bool IsStarted
5151
/// <exception cref="ArgumentNullException"><paramref name="host"/> is <c>null</c>.</exception>
5252
/// <exception cref="ArgumentOutOfRangeException"><paramref name="port" /> is greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
5353
/// <example>
54-
/// <code source="..\..\Renci.SshNet.Tests\Classes\ForwardedPortLocalTest.cs" region="Example SshClient AddForwardedPort Start Stop ForwardedPortLocal" language="C#" title="Local port forwarding" />
54+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\ForwardedPortLocalTest.cs" region="Example SshClient AddForwardedPort Start Stop ForwardedPortLocal" language="C#" title="Local port forwarding" />
5555
/// </example>
5656
public ForwardedPortLocal(uint boundPort, string host, uint port)
5757
: this(string.Empty, boundPort, host, port)

src/Renci.SshNet/ForwardedPortRemote.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ public ForwardedPortRemote(IPAddress boundHostAddress, uint boundPort, IPAddress
106106
/// <param name="host">The host.</param>
107107
/// <param name="port">The port.</param>
108108
/// <example>
109-
/// <code source="..\..\Renci.SshNet.Tests\Classes\ForwardedPortRemoteTest.cs" region="Example SshClient AddForwardedPort Start Stop ForwardedPortRemote" language="C#" title="Remote port forwarding" />
109+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\ForwardedPortRemoteTest.cs" region="Example SshClient AddForwardedPort Start Stop ForwardedPortRemote" language="C#" title="Remote port forwarding" />
110110
/// </example>
111111
public ForwardedPortRemote(uint boundPort, string host, uint port)
112112
: this(string.Empty, boundPort, host, port)

src/Renci.SshNet/IConnectionInfo.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ internal interface IConnectionInfo
7171
/// The connection timeout. The default value is 30 seconds.
7272
/// </value>
7373
/// <example>
74-
/// <code source="..\..\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient Connect Timeout" language="C#" title="Specify connection timeout" />
74+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient Connect Timeout" language="C#" title="Specify connection timeout" />
7575
/// </example>
7676
TimeSpan Timeout { get; }
7777

src/Renci.SshNet/KeyboardInteractiveConnectionInfo.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ namespace Renci.SshNet
88
/// Provides connection information when keyboard interactive authentication method is used
99
/// </summary>
1010
/// <example>
11-
/// <code source="..\..\Renci.SshNet.Tests\Classes\KeyboardInteractiveConnectionInfoTest.cs" region="Example KeyboardInteractiveConnectionInfo AuthenticationPrompt" language="C#" title="Connect using interactive method" />
11+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\KeyboardInteractiveConnectionInfoTest.cs" region="Example KeyboardInteractiveConnectionInfo AuthenticationPrompt" language="C#" title="Connect using interactive method" />
1212
/// </example>
1313
public class KeyboardInteractiveConnectionInfo : ConnectionInfo, IDisposable
1414
{
1515
/// <summary>
1616
/// Occurs when server prompts for more authentication information.
1717
/// </summary>
1818
/// <example>
19-
/// <code source="..\..\Renci.SshNet.Tests\Classes\KeyboardInteractiveConnectionInfoTest.cs" region="Example KeyboardInteractiveConnectionInfo AuthenticationPrompt" language="C#" title="Connect using interactive method" />
19+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\KeyboardInteractiveConnectionInfoTest.cs" region="Example KeyboardInteractiveConnectionInfo AuthenticationPrompt" language="C#" title="Connect using interactive method" />
2020
/// </example>
2121
public event EventHandler<AuthenticationPromptEventArgs> AuthenticationPrompt;
2222

src/Renci.SshNet/PasswordConnectionInfo.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ namespace Renci.SshNet
99
/// Provides connection information when password authentication method is used
1010
/// </summary>
1111
/// <example>
12-
/// <code source="..\..\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo" language="C#" title="Connect using username and password" />
13-
/// <code source="..\..\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo PasswordExpired" language="C#" title="Change password when connecting" />
14-
/// <code source="..\..\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo AuthenticationBanner" language="C#" title="Display authentication banner" />
12+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo" language="C#" title="Connect using username and password" />
13+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo PasswordExpired" language="C#" title="Change password when connecting" />
14+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo AuthenticationBanner" language="C#" title="Display authentication banner" />
1515
/// </example>
1616
public class PasswordConnectionInfo : ConnectionInfo, IDisposable
1717
{
1818
/// <summary>
1919
/// Occurs when user's password has expired and needs to be changed.
2020
/// </summary>
2121
/// <example>
22-
/// <code source="..\..\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo PasswordExpired" language="C#" title="Change password when connecting" />
22+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo PasswordExpired" language="C#" title="Change password when connecting" />
2323
/// </example>
2424
public event EventHandler<AuthenticationPasswordChangeEventArgs> PasswordExpired;
2525

@@ -30,7 +30,7 @@ public class PasswordConnectionInfo : ConnectionInfo, IDisposable
3030
/// <param name="username">Connection username.</param>
3131
/// <param name="password">Connection password.</param>
3232
/// <example>
33-
/// <code source="..\..\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo" language="C#" title="Connect using username and password" />
33+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo" language="C#" title="Connect using username and password" />
3434
/// </example>
3535
/// <exception cref="ArgumentNullException"><paramref name="password"/> is null.</exception>
3636
/// <exception cref="ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is null or contains whitespace characters.</exception>

src/Renci.SshNet/PrivateKeyConnectionInfo.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ namespace Renci.SshNet
99
/// Provides connection information when private key authentication method is used
1010
/// </summary>
1111
/// <example>
12-
/// <code source="..\..\Renci.SshNet.Tests\Classes\PrivateKeyConnectionInfoTest.cs" region="Example PrivateKeyConnectionInfo PrivateKeyFile" language="C#" title="Connect using private key" />
12+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PrivateKeyConnectionInfoTest.cs" region="Example PrivateKeyConnectionInfo PrivateKeyFile" language="C#" title="Connect using private key" />
1313
/// </example>
1414
public class PrivateKeyConnectionInfo : ConnectionInfo, IDisposable
1515
{
@@ -25,8 +25,8 @@ public class PrivateKeyConnectionInfo : ConnectionInfo, IDisposable
2525
/// <param name="username">Connection username.</param>
2626
/// <param name="keyFiles">Connection key files.</param>
2727
/// <example>
28-
/// <code source="..\..\Renci.SshNet.Tests\Classes\PrivateKeyConnectionInfoTest.cs" region="Example PrivateKeyConnectionInfo PrivateKeyFile" language="C#" title="Connect using private key" />
29-
/// <code source="..\..\Renci.SshNet.Tests\Classes\PrivateKeyConnectionInfoTest.cs" region="Example PrivateKeyConnectionInfo PrivateKeyFile Multiple" language="C#" title="Connect using multiple private key" />
28+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PrivateKeyConnectionInfoTest.cs" region="Example PrivateKeyConnectionInfo PrivateKeyFile" language="C#" title="Connect using private key" />
29+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PrivateKeyConnectionInfoTest.cs" region="Example PrivateKeyConnectionInfo PrivateKeyFile Multiple" language="C#" title="Connect using multiple private key" />
3030
/// </example>
3131
public PrivateKeyConnectionInfo(string host, string username, params PrivateKeyFile[] keyFiles)
3232
: this(host, DefaultPort, username, ProxyTypes.None, string.Empty, 0, string.Empty, string.Empty, keyFiles)

src/Renci.SshNet/PrivateKeyFile.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ namespace Renci.SshNet
1818
/// Represents private key information.
1919
/// </summary>
2020
/// <example>
21-
/// <code source="..\..\Renci.SshNet.Tests\Data\Key.RSA.txt" language="Text" title="Private RSA key example" />
21+
/// <code source="..\..\src\Renci.SshNet.Tests\Data\Key.RSA.txt" language="Text" title="Private RSA key example" />
2222
/// </example>
2323
/// <remarks>
2424
/// <para>

src/Renci.SshNet/SshClient.cs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ public IEnumerable<ForwardedPort> ForwardedPorts
4545
/// </summary>
4646
/// <param name="connectionInfo">The connection info.</param>
4747
/// <example>
48-
/// <code source="..\..\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo" language="C#" title="Connect using PasswordConnectionInfo object" />
49-
/// <code source="..\..\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo PasswordExpired" language="C#" title="Connect using PasswordConnectionInfo object with passwod change option" />
50-
/// <code source="..\..\Renci.SshNet.Tests\Classes\PrivateKeyConnectionInfoTest.cs" region="Example PrivateKeyConnectionInfo PrivateKeyFile" language="C#" title="Connect using PrivateKeyConnectionInfo" />
51-
/// <code source="..\..\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient Connect Timeout" language="C#" title="Specify connection timeout when connecting" />
48+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo" language="C#" title="Connect using PasswordConnectionInfo object" />
49+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo PasswordExpired" language="C#" title="Connect using PasswordConnectionInfo object with passwod change option" />
50+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PrivateKeyConnectionInfoTest.cs" region="Example PrivateKeyConnectionInfo PrivateKeyFile" language="C#" title="Connect using PrivateKeyConnectionInfo" />
51+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient Connect Timeout" language="C#" title="Specify connection timeout when connecting" />
5252
/// </example>
5353
/// <exception cref="ArgumentNullException"><paramref name="connectionInfo"/> is null.</exception>
5454
public SshClient(ConnectionInfo connectionInfo)
@@ -79,7 +79,7 @@ public SshClient(string host, int port, string username, string password)
7979
/// <param name="username">Authentication username.</param>
8080
/// <param name="password">Authentication password.</param>
8181
/// <example>
82-
/// <code source="..\..\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient(host, username) Connect" language="C#" title="Connect using username and password" />
82+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient(host, username) Connect" language="C#" title="Connect using username and password" />
8383
/// </example>
8484
/// <exception cref="ArgumentNullException"><paramref name="password"/> is null.</exception>
8585
/// <exception cref="ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is null or contains whitespace characters.</exception>
@@ -96,8 +96,8 @@ public SshClient(string host, string username, string password)
9696
/// <param name="username">Authentication username.</param>
9797
/// <param name="keyFiles">Authentication private key file(s) .</param>
9898
/// <example>
99-
/// <code source="..\..\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient(host, username) Connect PrivateKeyFile" language="C#" title="Connect using username and private key" />
100-
/// <code source="..\..\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient(host, username) Connect PrivateKeyFile PassPhrase" language="C#" title="Connect using username and private key and pass phrase" />
99+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient(host, username) Connect PrivateKeyFile" language="C#" title="Connect using username and private key" />
100+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient(host, username) Connect PrivateKeyFile PassPhrase" language="C#" title="Connect using username and private key and pass phrase" />
101101
/// </example>
102102
/// <exception cref="ArgumentNullException"><paramref name="keyFiles"/> is null.</exception>
103103
/// <exception cref="ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is null or contains whitespace characters.</exception>
@@ -115,8 +115,8 @@ public SshClient(string host, int port, string username, params PrivateKeyFile[]
115115
/// <param name="username">Authentication username.</param>
116116
/// <param name="keyFiles">Authentication private key file(s) .</param>
117117
/// <example>
118-
/// <code source="..\..\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient(host, username) Connect PrivateKeyFile" language="C#" title="Connect using private key" />
119-
/// <code source="..\..\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient(host, username) Connect PrivateKeyFile PassPhrase" language="C#" title="Connect using private key and pass phrase" />
118+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient(host, username) Connect PrivateKeyFile" language="C#" title="Connect using private key" />
119+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient(host, username) Connect PrivateKeyFile PassPhrase" language="C#" title="Connect using private key and pass phrase" />
120120
/// </example>
121121
/// <exception cref="ArgumentNullException"><paramref name="keyFiles"/> is null.</exception>
122122
/// <exception cref="ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is null or contains whitespace characters.</exception>
@@ -178,8 +178,8 @@ protected override void OnDisconnecting()
178178
/// </summary>
179179
/// <param name="port">The port.</param>
180180
/// <example>
181-
/// <code source="..\..\Renci.SshNet.Tests\Classes\ForwardedPortRemoteTest.cs" region="Example SshClient AddForwardedPort Start Stop ForwardedPortRemote" language="C#" title="Remote port forwarding" />
182-
/// <code source="..\..\Renci.SshNet.Tests\Classes\ForwardedPortLocalTest.cs" region="Example SshClient AddForwardedPort Start Stop ForwardedPortLocal" language="C#" title="Local port forwarding" />
181+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\ForwardedPortRemoteTest.cs" region="Example SshClient AddForwardedPort Start Stop ForwardedPortRemote" language="C#" title="Remote port forwarding" />
182+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\ForwardedPortLocalTest.cs" region="Example SshClient AddForwardedPort Start Stop ForwardedPortLocal" language="C#" title="Local port forwarding" />
183183
/// </example>
184184
/// <exception cref="InvalidOperationException">Forwarded port is already added to a different client.</exception>
185185
/// <exception cref="ArgumentNullException"><paramref name="port"/> is null.</exception>
@@ -259,8 +259,8 @@ public SshCommand CreateCommand(string commandText, Encoding encoding)
259259
/// <returns>Returns an instance of <see cref="SshCommand"/> with execution results.</returns>
260260
/// <remarks>This method internally uses asynchronous calls.</remarks>
261261
/// <example>
262-
/// <code source="..\..\Renci.SshNet.Tests\Classes\SshCommandTest.cs" region="Example SshCommand RunCommand Result" language="C#" title="Running simple command" />
263-
/// <code source="..\..\Renci.SshNet.Tests\Classes\SshCommandTest.NET40.cs" region="Example SshCommand RunCommand Parallel" language="C#" title="Run many commands in parallel" />
262+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshCommandTest.cs" region="Example SshCommand RunCommand Result" language="C#" title="Running simple command" />
263+
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshCommandTest.NET40.cs" region="Example SshCommand RunCommand Parallel" language="C#" title="Run many commands in parallel" />
264264
/// </example>
265265
/// <exception cref="ArgumentException">CommandText property is empty.</exception>
266266
/// <exception cref="T:Renci.SshNet.Common.SshException">Invalid Operation - An existing channel was used to execute this command.</exception>

0 commit comments

Comments
 (0)