Merge pull request #4 from kruton/doc-fix

Fix some javadoc

2 files changed, 17 insertions, 16 deletions

diff --git a/sshlib/src/main/java/com/trilead/ssh2/AuthAgentCallback.java b/sshlib/src/main/java/com/trilead/ssh2/AuthAgentCallback.java
index 96f2d07..17dcbb4 100644
--- a/sshlib/src/main/java/com/trilead/ssh2/AuthAgentCallback.java
+++ b/sshlib/src/main/java/com/trilead/ssh2/AuthAgentCallback.java
@@ -17,9 +17,9 @@ public interface AuthAgentCallback {
 	Map<String,byte[]> retrieveIdentities();
 
 	/**
-	 * @param pair A <code>RSAPrivateKey</code> or <code>DSAPrivateKey</code>
-	 *             containing a DSA or RSA private key of
-	 *             the user in Trilead object format.
+	 * @param pair A <code>RSAPrivateKey</code>, <code>ECPrivateKey</code>, or
+	 *             <code>DSAPrivateKey</code> containing a DSA, EC, or RSA private
+	 *             and corresponding <code>PublicKey</code>.
 	 * @param comment comment associated with this key
 	 * @param confirmUse whether to prompt before using this key
 	 * @param lifetime lifetime in seconds for key to be remembered
diff --git a/sshlib/src/main/java/com/trilead/ssh2/Connection.java b/sshlib/src/main/java/com/trilead/ssh2/Connection.java
index 8582ea4..6badb09 100644
--- a/sshlib/src/main/java/com/trilead/ssh2/Connection.java
+++ b/sshlib/src/main/java/com/trilead/ssh2/Connection.java
@@ -350,7 +350,7 @@ public class Connection
 	 * <code>getRemainingAuthMethods</code> method to get a list of the
 	 * remaining possible methods).
 	 * 
-	 * @param user
+	 * @param user the username to attempt to log in as
 	 * @return if the connection is now authenticated.
 	 * @throws IOException
 	 */
@@ -382,8 +382,8 @@ public class Connection
 	/**
 	 * After a successful connect, one has to authenticate oneself. The
 	 * authentication method "publickey" works by signing a challenge sent by
-	 * the server. The signature is either DSA or RSA based - it just depends on
-	 * the type of private key you specify, either a DSA or RSA private key in
+	 * the server. The signature is either DSA, EC, or RSA based - it just depends
+	 * on the type of private key you specify, either a DSA or RSA private key in
 	 * PEM format. And yes, this is may seem to be a little confusing, the
 	 * method is called "publickey" in the SSH-2 protocol specification, however
 	 * since we need to generate a signature, you actually have to supply a
@@ -391,7 +391,7 @@ public class Connection
 	 * <p>
 	 * The private key contained in the PEM file may also be encrypted
 	 * ("Proc-Type: 4,ENCRYPTED"). The library supports DES-CBC and DES-EDE3-CBC
-	 * encryption, as well as the more exotic PEM encrpytions AES-128-CBC,
+	 * encryption, as well as the more exotic PEM encryption AES-128-CBC,
 	 * AES-192-CBC and AES-256-CBC.
 	 * <p>
 	 * If the authentication phase is complete, <code>true</code> will be
@@ -452,9 +452,9 @@ public class Connection
 	/**
 	 * After a successful connect, one has to authenticate oneself. The
 	 * authentication method "publickey" works by signing a challenge sent by
-	 * the server. The signature is either DSA or RSA based - it just depends on
-	 * the type of private key you specify, either a DSA or RSA private key in
-	 * PEM format. And yes, this is may seem to be a little confusing, the
+	 * the server. The signature is either DSA, EC, or RSA based - it just depends
+	 * on the type of private key you specify, either a DSA, EC, or RSA private key
+	 * in PEM format. And yes, this is may seem to be a little confusing, the
 	 * method is called "publickey" in the SSH-2 protocol specification, however
 	 * since we need to generate a signature, you actually have to supply a
 	 * private key =).
@@ -469,9 +469,9 @@ public class Connection
 	 * @param user
 	 *            A <code>String</code> holding the username.
 	 * @param pair
-	 *            A <code>RSAPrivateKey</code> or <code>DSAPrivateKey</code>
-	 *            containing a DSA or RSA private key of
-	 *            the user in Trilead object format.
+	 *            A <code>KeyPair</code> containing a <code>RSAPrivateKey</code>,
+	 *            <code>DSAPrivateKey</code>, or <code>ECPrivateKey</code> and
+	 *            corresponding PublicKey.
 	 * 
 	 * @return whether the connection is now authenticated.
 	 * @throws IOException
@@ -503,7 +503,7 @@ public class Connection
 	}
 	/**
 	 * A convenience wrapper function which reads in a private key (PEM format,
-	 * either DSA or RSA) and then calls
+	 * either DSA, EC, or RSA) and then calls
 	 * <code>authenticateWithPublicKey(String, char[], String)</code>.
 	 * <p>
 	 * NOTE PUTTY USERS: Event though your key file may start with
@@ -516,8 +516,9 @@ public class Connection
 	 *            A <code>String</code> holding the username.
 	 * @param pemFile
 	 *            A <code>File</code> object pointing to a file containing a
-	 *            DSA or RSA private key of the user in OpenSSH key format (PEM,
-	 *            you can't miss the "-----BEGIN DSA PRIVATE KEY-----" or
+	 *            DSA, EC, or RSA private key of the user in OpenSSH key format
+	 *            (PEM, you can't miss the "-----BEGIN DSA PRIVATE KEY-----",
+	 *            "-----BEGIN EC PRIVATE KEY-----", or
 	 *            "-----BEGIN RSA PRIVATE KEY-----" tag).
 	 * @param password
 	 *            If the PEM file is encrypted then you must specify the