Skip to content

Commit 7436a38

Browse files
WojciechNagorskiFiliniFilippoGualandi-CRIFdarinkeswxtsxt
authored
Remove code examples (#1210)
* Release 2023.0.0 (#1201) * Assets/logos (#782) * Added logo assets * Added PNG 1260x640 with white border Co-authored-by: 103filgualan <[email protected]> * OPENSSH KeyReader for more keys (#614) * OPENSSH KeyReader for more keys Add support to parse OpenSSH Keys with ECDSA 256/384/521 and RSA. https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.key Change-Id: Iaa9cce0f2522e5fee377a82cb252f81f0b7cc563 * Fix ED25519Key KeyLength * Fix ED25519 PubKey-auth LeadingZeros of BigInteger-Conversion have to be removed before sending the Key. * Add interface to SftpFile #120 (#812) * Create ISftpFile interface. SftpFile sealed. Return ISftpFile from SftpClient instead of SftpFile. Make ISftpClient interface disposable. Co-authored-by: Wojciech Swieboda <[email protected]> * Start MessageListener with ThreadAbstraction.ExecuteThreadLongRunning (#902) * Fix Thread pool exhaustion due to MessageListener running on ThreadPool * Mark long running thread as background * Add async support to SftpClient and SftpFileStream (#819) * Add FEATURE_TAP and net472 target * Add TAP async support to SftpClient and SftpFileStream * Add async support to DnsAbstraction and SocketAbstraction * Add async support to *Connector and refactor the hierarchy * Add ConnectAsync to BaseClient * Add CODEOWNERS file. * Fix virus false-positive by Defender on Renci.SSHNet.Tests.dll (#867) Co-authored-by: Pedro Fonseca <[email protected]> * Add unit tests for task-based asynchronous API (#906) * Fix runtime and culture dependant tests. * Set C# 7.3 in Tests.csproj to limit intellisense's suggestions under different targets * Add SftpClientTest.*Async * Add SftpFileStreamTest_OpenAsync_* * Add SftpFileStreamTest_WriteAsync_* * Add SftpFileStreamTest_ReadAsync_* * Align AppVeyor script with Test project target frameworks * correct 'Documenation' to 'Documentation' (#838) in the documentation's window title * Agent auth and Keygen (#794) * Allow to set PrivateKeyFile Key directly So you can add your own Key-Classes to SSH.NET * Add ED25519 ctor for just pub key part. * Make ECDSA Key Bits accessible You cant export imported CngKeys. To be able to export them to agent or Key-Files make the private bits also accessible. * Better NETFRAMEWORK vs NETSTANDARD handling * Add Comment Property to Key * Add IPrivateKeySource So Extension can add own PrivateKeyFiles, e.g. PuttyKeyFile. * Use cryptographically secure random number generator. Fixes CVE-2022-29245. * Remove unused import. * Add IBaseClient for BaseClient and ISftpClient to inherit from (#975) Add IBaseClient for BaseClient and ISftpClient to inherit from * fix typo (#999) * Fix Seek Operations in SftpFileStream (#910) * Fix offset operations in SftpFileStream.Seek * Fix seek exception message and add default case for invalid seek origin * Use named params when throwing ArgumentException * Add tests for seeking from end of file * Add back copyright to license. (#1060) Fixes #1059. * Removing old target frameworks (#1109) Remove support for legacy / deprecated target frameworks while adding support for .NET 6.0 (and higher). The supported target frameworks are now: * .NETFramework 4.6.2 (and higher) * .NET Standard 2.0 * .NET 6.0 (and higher) * Remove old features [Part 1] (#1117) Remove obsolete feature switches (now that we've remove support for legacy target frameworks) and remove corresponding conditional code. * Remove FEATURE_DIRECTORYINFO_ENUMERATEFILES (#1119) * Remove FEATURE_DIRECTORYINFO_ENUMERATEFILES * Add exception documentation * Fix some (lots of) issues reported by analyzers. (#1125) Fix some (lots of) issues reported by analyzers. * Round 2 of analyzer fixes and general cleanup. (#1132) * Analyzer fixes round 3. (#1135) * Replace Array<T>.Empty with Array.Empty<T>() (#1137) * Replace IsNullOrWhiteSpace extension (#1142) * Use License Expression for NuGet Package licenseUrl is deprecated, see NuGet/Announcements#32 * Integration tests * Remove todos * Update CODEOWNERS * Use correct SSH.NET * ListDirectoryAsync return IAsyncEnumerable (#1126) * ListDirectoryAsync return IAsyncEnumerable * Fix documentation * Update README.md * Fix * Add Sftp ListDirectoryAsync test * Revert * Integration tests for ListDirectoryAsync with IAsyncEnumerable * Fix the assembly resolution build warning (#1165) * Delete performance/longrunning tests (#1143) Co-authored-by: Wojciech Nagórski <[email protected]> * Move Integration tests (#1173) * Renci.SshNet.IntegrationTests * Renci.SshNet.TestTools.OpenSSH * Move integration tests to main repo * Move old tests to new integration tests * Move old integration tests to new integration tests * Move more tests * Move authentication tests * Move SshClientTests * Fix some tests * Remove duplicated test * Poc of ProcessDisruptor * Rename * Some fixes * Remove performance tests * Small improvements * Add a benchmarks project (#1151) * Add a benchmarks project * Small improvements --------- Co-authored-by: Wojciech Nagórski <[email protected]> * Use ExceptionDispatchInfo to retain call stack in Session.WaitOnHandle() (#936) * Use ExceptionDispatchInfo to retain call stack in Session.WaitOnHandle() * merge * Update src/Renci.SshNet/Session.cs Co-authored-by: Rob Hague <[email protected]> --------- Co-authored-by: Wojciech Nagórski <[email protected]> Co-authored-by: Rob Hague <[email protected]> * Support SHA256 fingerprints for host key validation (#1098) * Add tests for HostKeyEventArgs * Add SHA256 fingerprint support * Add support for RSA SHA-2 public key algorithms (#1177) * Abstract out the hash algorithm from RsaDigitalSignature * Add integration tests * Add DigitalSignature property to KeyHostAlgorithm * Add IHostAlgorithmsProvider interface * Verify the host signature * Fix HostKeyEventArgsTest after merge * Remove PubkeyAcceptedAlgorithms ssh-rsa * Add test coverage for RSA keys in PrivateKeyFile * Obsolete IPrivateKeySource --------- Co-authored-by: Wojciech Nagórski <[email protected]> * Improvements after #1177 (#1180) * Use ExceptionDispatchInfo in more places (#1182) Co-authored-by: Wojciech Nagórski <[email protected]> * Try to "fix" the flaky test (#1185) * Enable DSA tests (#1181) Co-authored-by: Wojciech Nagórski <[email protected]> * FingerPrints (#1186) * Use OS-agnostic socket error codes to allow tests run on different OSes (#1179) SocketErrorCode is OS agnostic, ErrorCode is OS specific. On Windows ErrorCode = (int) SocketErrorCode, but on Mac and Unix it is not. For example ExitCode for HostNotFound (11001) on Windows is 11001, on Mac & Unix is -131073. So testing for ExitCode == 11001 fails on Mac & Unix. Co-authored-by: Wojciech Nagórski <[email protected]> * Fix for channel session semaphore from thread blocking (#1071) * Merging fix from @clivetong into our own SSH.NET fork - The following article describes some of the issues with the double check lock that we have seen issues with: https://www.sudhanshutheone.com/posts/double-check-lock-csharp * Merging fix from @clivetong into our own SSH.NET fork - The following article describes some of the issues with the double check lock that we have seen issues with: https://www.sudhanshutheone.com/posts/double-check-lock-csharp * Update Channel to fix AppVeyor failure (field should be readonly) * Update ISftpClient for #120 (#1193) * Implement set last write and access time (#1194) * Add/migrate hmac+cipher integration tests (#1189) * Add/migrate hmac+cipher integration tests * fix integration tests --------- Co-authored-by: Wojciech Nagórski <[email protected]> * Update tests for SetLastAccessTime(Utc) to also verify the time component and the Kind of the DateTime value returned by GetLastAccessTime(Utc). (#1198) --------- Co-authored-by: Filippo Gualandi <[email protected]> Co-authored-by: 103filgualan <[email protected]> Co-authored-by: Stefan Rinkes <[email protected]> Co-authored-by: wxtsxt <[email protected]> Co-authored-by: Wojciech Swieboda <[email protected]> Co-authored-by: Igor Milavec <[email protected]> Co-authored-by: drieseng <[email protected]> Co-authored-by: Pedro Fonseca <[email protected]> Co-authored-by: Pedro Fonseca <[email protected]> Co-authored-by: Maximiliano Jabase <[email protected]> Co-authored-by: Owen Krueger <[email protected]> Co-authored-by: Masuri <[email protected]> Co-authored-by: LemonPi314 <[email protected]> Co-authored-by: Gert Driesen <[email protected]> Co-authored-by: Rob Hague <[email protected]> Co-authored-by: Rob Hague <[email protected]> Co-authored-by: Marius Thesing <[email protected]> Co-authored-by: Dāvis Mošenkovs <[email protected]> Co-authored-by: Dmitry Tsarevich <[email protected]> Co-authored-by: Patrick Yates <[email protected]> * Remove code examples --------- Co-authored-by: Filippo Gualandi <[email protected]> Co-authored-by: 103filgualan <[email protected]> Co-authored-by: Stefan Rinkes <[email protected]> Co-authored-by: wxtsxt <[email protected]> Co-authored-by: Wojciech Swieboda <[email protected]> Co-authored-by: Igor Milavec <[email protected]> Co-authored-by: drieseng <[email protected]> Co-authored-by: Pedro Fonseca <[email protected]> Co-authored-by: Pedro Fonseca <[email protected]> Co-authored-by: Maximiliano Jabase <[email protected]> Co-authored-by: Owen Krueger <[email protected]> Co-authored-by: Masuri <[email protected]> Co-authored-by: LemonPi314 <[email protected]> Co-authored-by: Gert Driesen <[email protected]> Co-authored-by: Rob Hague <[email protected]> Co-authored-by: Rob Hague <[email protected]> Co-authored-by: Marius Thesing <[email protected]> Co-authored-by: Dāvis Mošenkovs <[email protected]> Co-authored-by: Dmitry Tsarevich <[email protected]> Co-authored-by: Patrick Yates <[email protected]>
1 parent 4c2dcd5 commit 7436a38

12 files changed

+0
-108
lines changed

‎src/Renci.SshNet/BaseClient.cs

-6
Original file line numberDiff line numberDiff line change
@@ -140,17 +140,11 @@ public TimeSpan KeepAliveInterval
140140
/// <summary>
141141
/// Occurs when an error occurred.
142142
/// </summary>
143-
/// <example>
144-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient Connect ErrorOccurred" language="C#" title="Handle ErrorOccurred event" />
145-
/// </example>
146143
public event EventHandler<ExceptionEventArgs> ErrorOccurred;
147144

148145
/// <summary>
149146
/// Occurs when host key received.
150147
/// </summary>
151-
/// <example>
152-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient Connect HostKeyReceived" language="C#" title="Handle HostKeyReceived event" />
153-
/// </example>
154148
public event EventHandler<HostKeyEventArgs> HostKeyReceived;
155149

156150
/// <summary>

‎src/Renci.SshNet/ConnectionInfo.cs

-6
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,6 @@ public class ConnectionInfo : IConnectionInfoInternal
144144
/// <value>
145145
/// The connection timeout. The default value is 30 seconds.
146146
/// </value>
147-
/// <example>
148-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient Connect Timeout" language="C#" title="Specify connection timeout" />
149-
/// </example>
150147
public TimeSpan Timeout { get; set; }
151148

152149
/// <summary>
@@ -190,9 +187,6 @@ public class ConnectionInfo : IConnectionInfoInternal
190187
/// <summary>
191188
/// Occurs when authentication banner is sent by the server.
192189
/// </summary>
193-
/// <example>
194-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo AuthenticationBanner" language="C#" title="Display authentication banner" />
195-
/// </example>
196190
public event EventHandler<AuthenticationBannerEventArgs> AuthenticationBanner;
197191

198192
/// <summary>

‎src/Renci.SshNet/ForwardedPortLocal.cs

-3
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,6 @@ public override bool IsStarted
5858
/// <exception cref="ArgumentOutOfRangeException"><paramref name="boundPort" /> is greater than <see cref="IPEndPoint.MaxPort" />.</exception>
5959
/// <exception cref="ArgumentNullException"><paramref name="host"/> is <see langword="null"/>.</exception>
6060
/// <exception cref="ArgumentOutOfRangeException"><paramref name="port" /> is greater than <see cref="IPEndPoint.MaxPort" />.</exception>
61-
/// <example>
62-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\ForwardedPortLocalTest.cs" region="Example SshClient AddForwardedPort Start Stop ForwardedPortLocal" language="C#" title="Local port forwarding" />
63-
/// </example>
6461
public ForwardedPortLocal(uint boundPort, string host, uint port)
6562
: this(string.Empty, boundPort, host, port)
6663
{

‎src/Renci.SshNet/ForwardedPortRemote.cs

-3
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,6 @@ public ForwardedPortRemote(IPAddress boundHostAddress, uint boundPort, IPAddress
112112
/// <param name="boundPort">The bound port.</param>
113113
/// <param name="host">The host.</param>
114114
/// <param name="port">The port.</param>
115-
/// <example>
116-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\ForwardedPortRemoteTest.cs" region="Example SshClient AddForwardedPort Start Stop ForwardedPortRemote" language="C#" title="Remote port forwarding" />
117-
/// </example>
118115
public ForwardedPortRemote(uint boundPort, string host, uint port)
119116
: this(string.Empty, boundPort, host, port)
120117
{

‎src/Renci.SshNet/IBaseClient.cs

-6
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,11 @@ public interface IBaseClient : IDisposable
4343
/// <summary>
4444
/// Occurs when an error occurred.
4545
/// </summary>
46-
/// <example>
47-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient Connect ErrorOccurred" language="C#" title="Handle ErrorOccurred event" />
48-
/// </example>
4946
event EventHandler<ExceptionEventArgs> ErrorOccurred;
5047

5148
/// <summary>
5249
/// Occurs when host key received.
5350
/// </summary>
54-
/// <example>
55-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient Connect HostKeyReceived" language="C#" title="Handle HostKeyReceived event" />
56-
/// </example>
5751
event EventHandler<HostKeyEventArgs> HostKeyReceived;
5852

5953
/// <summary>

‎src/Renci.SshNet/IConnectionInfo.cs

-3
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,6 @@ internal interface IConnectionInfo
9898
/// <value>
9999
/// The connection timeout. The default value is 30 seconds.
100100
/// </value>
101-
/// <example>
102-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient Connect Timeout" language="C#" title="Specify connection timeout" />
103-
/// </example>
104101
TimeSpan Timeout { get; }
105102

106103
/// <summary>

‎src/Renci.SshNet/KeyboardInteractiveConnectionInfo.cs

-6
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,13 @@ namespace Renci.SshNet
66
/// <summary>
77
/// Provides connection information when keyboard interactive authentication method is used.
88
/// </summary>
9-
/// <example>
10-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\KeyboardInteractiveConnectionInfoTest.cs" region="Example KeyboardInteractiveConnectionInfo AuthenticationPrompt" language="C#" title="Connect using interactive method" />
11-
/// </example>
129
public class KeyboardInteractiveConnectionInfo : ConnectionInfo, IDisposable
1310
{
1411
private bool _isDisposed;
1512

1613
/// <summary>
1714
/// Occurs when server prompts for more authentication information.
1815
/// </summary>
19-
/// <example>
20-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\KeyboardInteractiveConnectionInfoTest.cs" region="Example KeyboardInteractiveConnectionInfo AuthenticationPrompt" language="C#" title="Connect using interactive method" />
21-
/// </example>
2216
public event EventHandler<AuthenticationPromptEventArgs> AuthenticationPrompt;
2317

2418
/// <summary>

‎src/Renci.SshNet/PasswordConnectionInfo.cs

-11
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,13 @@ namespace Renci.SshNet
88
/// <summary>
99
/// Provides connection information when password authentication method is used.
1010
/// </summary>
11-
/// <example>
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" />
15-
/// </example>
1611
public class PasswordConnectionInfo : ConnectionInfo, IDisposable
1712
{
1813
private bool _isDisposed;
1914

2015
/// <summary>
2116
/// Occurs when user's password has expired and needs to be changed.
2217
/// </summary>
23-
/// <example>
24-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo PasswordExpired" language="C#" title="Change password when connecting" />
25-
/// </example>
2618
public event EventHandler<AuthenticationPasswordChangeEventArgs> PasswordExpired;
2719

2820
/// <summary>
@@ -31,9 +23,6 @@ public class PasswordConnectionInfo : ConnectionInfo, IDisposable
3123
/// <param name="host">Connection host.</param>
3224
/// <param name="username">Connection username.</param>
3325
/// <param name="password">Connection password.</param>
34-
/// <example>
35-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo" language="C#" title="Connect using username and password" />
36-
/// </example>
3726
/// <exception cref="ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
3827
/// <exception cref="ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
3928
public PasswordConnectionInfo(string host, string username, string password)

‎src/Renci.SshNet/PrivateKeyConnectionInfo.cs

-7
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ namespace Renci.SshNet
77
/// <summary>
88
/// Provides connection information when private key authentication method is used.
99
/// </summary>
10-
/// <example>
11-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PrivateKeyConnectionInfoTest.cs" region="Example PrivateKeyConnectionInfo PrivateKeyFile" language="C#" title="Connect using private key" />
12-
/// </example>
1310
public class PrivateKeyConnectionInfo : ConnectionInfo, IDisposable
1411
{
1512
private bool _isDisposed;
@@ -25,10 +22,6 @@ public class PrivateKeyConnectionInfo : ConnectionInfo, IDisposable
2522
/// <param name="host">Connection host.</param>
2623
/// <param name="username">Connection username.</param>
2724
/// <param name="keyFiles">Connection key files.</param>
28-
/// <example>
29-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PrivateKeyConnectionInfoTest.cs" region="Example PrivateKeyConnectionInfo PrivateKeyFile" language="C#" title="Connect using private key" />
30-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PrivateKeyConnectionInfoTest.cs" region="Example PrivateKeyConnectionInfo PrivateKeyFile Multiple" language="C#" title="Connect using multiple private key" />
31-
/// </example>
3225
public PrivateKeyConnectionInfo(string host, string username, params PrivateKeyFile[] keyFiles)
3326
: this(host, DefaultPort, username, ProxyTypes.None, string.Empty, 0, string.Empty, string.Empty, keyFiles)
3427
{

‎src/Renci.SshNet/PrivateKeyFile.cs

-3
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@ namespace Renci.SshNet
2020
/// <summary>
2121
/// Represents private key information.
2222
/// </summary>
23-
/// <example>
24-
/// <code source="..\..\src\Renci.SshNet.Tests\Data\Key.RSA.txt" language="Text" title="Private RSA key example" />
25-
/// </example>
2623
/// <remarks>
2724
/// <para>
2825
/// The following private keys are supported:

‎src/Renci.SshNet/SshClient.cs

-25
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,6 @@ public IEnumerable<ForwardedPort> ForwardedPorts
4444
/// Initializes a new instance of the <see cref="SshClient" /> class.
4545
/// </summary>
4646
/// <param name="connectionInfo">The connection info.</param>
47-
/// <example>
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" />
52-
/// </example>
5347
/// <exception cref="ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
5448
public SshClient(ConnectionInfo connectionInfo)
5549
: this(connectionInfo, ownsConnectionInfo: false)
@@ -80,9 +74,6 @@ public SshClient(string host, int port, string username, string password)
8074
/// <param name="host">Connection host.</param>
8175
/// <param name="username">Authentication username.</param>
8276
/// <param name="password">Authentication password.</param>
83-
/// <example>
84-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient(host, username) Connect" language="C#" title="Connect using username and password" />
85-
/// </example>
8677
/// <exception cref="ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
8778
/// <exception cref="ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
8879
public SshClient(string host, string username, string password)
@@ -97,10 +88,6 @@ public SshClient(string host, string username, string password)
9788
/// <param name="port">Connection port.</param>
9889
/// <param name="username">Authentication username.</param>
9990
/// <param name="keyFiles">Authentication private key file(s) .</param>
100-
/// <example>
101-
/// <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" />
102-
/// <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" />
103-
/// </example>
10491
/// <exception cref="ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
10592
/// <exception cref="ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
10693
/// <exception cref="ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="IPEndPoint.MinPort"/> and <see cref="IPEndPoint.MaxPort"/>.</exception>
@@ -116,10 +103,6 @@ public SshClient(string host, int port, string username, params IPrivateKeySourc
116103
/// <param name="host">Connection host.</param>
117104
/// <param name="username">Authentication username.</param>
118105
/// <param name="keyFiles">Authentication private key file(s) .</param>
119-
/// <example>
120-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshClientTest.cs" region="Example SshClient(host, username) Connect PrivateKeyFile" language="C#" title="Connect using private key" />
121-
/// <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" />
122-
/// </example>
123106
/// <exception cref="ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
124107
/// <exception cref="ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
125108
public SshClient(string host, string username, params IPrivateKeySource[] keyFiles)
@@ -177,10 +160,6 @@ protected override void OnDisconnecting()
177160
/// Adds the forwarded port.
178161
/// </summary>
179162
/// <param name="port">The port.</param>
180-
/// <example>
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" />
183-
/// </example>
184163
/// <exception cref="InvalidOperationException">Forwarded port is already added to a different client.</exception>
185164
/// <exception cref="ArgumentNullException"><paramref name="port"/> is <see langword="null"/>.</exception>
186165
/// <exception cref="SshConnectionException">Client is not connected.</exception>
@@ -265,10 +244,6 @@ public SshCommand CreateCommand(string commandText, Encoding encoding)
265244
/// <param name="commandText">The command text.</param>
266245
/// <returns>Returns an instance of <see cref="SshCommand"/> with execution results.</returns>
267246
/// <remarks>This method internally uses asynchronous calls.</remarks>
268-
/// <example>
269-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshCommandTest.cs" region="Example SshCommand RunCommand Result" language="C#" title="Running simple command" />
270-
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\SshCommandTest.cs" region="Example SshCommand RunCommand Parallel" language="C#" title="Run many commands in parallel" />
271-
/// </example>
272247
/// <exception cref="ArgumentException">CommandText property is empty.</exception>
273248
/// <exception cref="SshException">Invalid Operation - An existing channel was used to execute this command.</exception>
274249
/// <exception cref="InvalidOperationException">Asynchronous operation is already in progress.</exception>

0 commit comments

Comments
 (0)