浏览代码

Fixed a bunch of comment Warnings. Left Zlib and NetConfClient as is for now.

Kenneth_aa_cp 13 年之前
父节点
当前提交
df25d5ace0

+ 0 - 2
Renci.SshClient/Renci.SshNet/KeyboardInteractiveAuthenticationMethod.cs

@@ -40,8 +40,6 @@ namespace Renci.SshNet
         /// <summary>
         /// Initializes a new instance of the <see cref="KeyboardInteractiveAuthenticationMethod"/> class.
         /// </summary>
-        /// <param name="host">The host.</param>
-        /// <param name="port">The port.</param>
         /// <param name="username">The username.</param>
         /// <exception cref="ArgumentException"><paramref name="username"/> is whitespace or null.</exception>
         public KeyboardInteractiveAuthenticationMethod(string username)

+ 1 - 1
Renci.SshClient/Renci.SshNet/MessageEventArgs.cs

@@ -14,7 +14,7 @@ namespace Renci.SshNet
         public T Message { get; private set; }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="MessageEventArgs"/> class.
+        /// Initializes a new instance of the <see cref="MessageEventArgs&lt;T&gt;"/> class.
         /// </summary>
         /// <param name="message">The message.</param>
         /// <exception cref="ArgumentNullException"><paramref name="message"/> is null.</exception>

+ 1 - 1
Renci.SshClient/Renci.SshNet/Messages/Connection/ChannelRequest/ExecRequestInfo.cs

@@ -40,7 +40,7 @@ namespace Renci.SshNet.Messages.Connection
         /// Initializes a new instance of the <see cref="ExecRequestInfo"/> class.
         /// </summary>
         /// <param name="command">The command.</param>
-        /// <exception cref="ArgumentNullException"><paramref name="command"/> is null.</exception>
+        /// <exception cref="System.ArgumentNullException"><paramref name="command"/> is null.</exception>
         public ExecRequestInfo(string command)
             : this()
         {

+ 1 - 0
Renci.SshClient/Renci.SshNet/NetConfClient.cs

@@ -151,6 +151,7 @@ namespace Renci.SshNet
             return SendReceiveRpc(rpc);
         }
 
+        /// <exception cref="SshConnectionException">Client is not connected.</exception>
         public XmlDocument SendCloseRpc()
         {
             this.EnsureConnection();

+ 0 - 2
Renci.SshClient/Renci.SshNet/NoneAuthenticationMethod.cs

@@ -28,8 +28,6 @@ namespace Renci.SshNet
         /// <summary>
         /// Initializes a new instance of the <see cref="KeyboardInteractiveConnectionInfo"/> class.
         /// </summary>
-        /// <param name="host">The host.</param>
-        /// <param name="port">The port.</param>
         /// <param name="username">The username.</param>
         /// <exception cref="ArgumentException"><paramref name="username"/> is whitespace or null.</exception>
         public NoneAuthenticationMethod(string username)

+ 0 - 2
Renci.SshClient/Renci.SshNet/PasswordAuthenticationMethod.cs

@@ -42,8 +42,6 @@ namespace Renci.SshNet
         /// <summary>
         /// Initializes a new instance of the <see cref="PasswordAuthenticationMethod"/> class.
         /// </summary>
-        /// <param name="host">The host.</param>
-        /// <param name="port">The port.</param>
         /// <param name="username">The username.</param>
         /// <param name="password">The password.</param>
         /// <exception cref="ArgumentException"><paramref name="username"/> is whitespace or null.</exception>

+ 0 - 2
Renci.SshClient/Renci.SshNet/PrivateKeyAuthenticationMethod.cs

@@ -37,8 +37,6 @@ namespace Renci.SshNet
         /// <summary>
         /// Initializes a new instance of the <see cref="PrivateKeyAuthenticationMethod"/> class.
         /// </summary>
-        /// <param name="host">The host.</param>
-        /// <param name="port">The port.</param>
         /// <param name="username">The username.</param>
         /// <param name="keyFiles">The key files.</param>
         /// <exception cref="ArgumentException"><paramref name="username"/> is whitespace or null.</exception>

+ 1 - 1
Renci.SshClient/Renci.SshNet/ScpClient.NET.cs

@@ -59,7 +59,7 @@ namespace Renci.SshNet
         /// </summary>
         /// <param name="directoryInfo">Local directory to upload.</param>
         /// <param name="filename">Remote host directory name.</param>
-        /// <exception cref="ArgumentNullException"><paramref name="ArgumentNullException"/> or <paramref name="filename"/> is null.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="directoryInfo"/> or <paramref name="filename"/> is null.</exception>
         public void Upload(DirectoryInfo directoryInfo, string filename)
         {
             if (directoryInfo == null)

+ 4 - 0
Renci.SshClient/Renci.SshNet/Security/Cryptography/HMAC.cs

@@ -154,6 +154,10 @@ namespace Renci.SshNet.Security.Cryptography
             }
         }
 
+        /// <summary>
+        /// Releases unmanaged and - optionally - managed resources
+        /// </summary>
+        /// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged ResourceMessages.</param>
         protected override void Dispose(bool disposing)
         {
             base.Dispose(disposing);