From 1ab1c0412b38b6d361c3271650afa9f6ee7e5019 Mon Sep 17 00:00:00 2001 From: Kenny Root Date: Sat, 18 Jul 2015 10:13:58 -0700 Subject: Fix various javadoc errors --- lib/src/main/java/com/trilead/ssh2/AuthAgentCallback.java | 6 +++--- lib/src/main/java/com/trilead/ssh2/ChannelCondition.java | 2 +- lib/src/main/java/com/trilead/ssh2/Connection.java | 2 +- lib/src/main/java/com/trilead/ssh2/DHGexParameters.java | 4 ++-- lib/src/main/java/com/trilead/ssh2/KnownHosts.java | 2 +- lib/src/main/java/com/trilead/ssh2/SFTPv3Client.java | 4 ++-- lib/src/main/java/com/trilead/ssh2/Session.java | 6 +++--- lib/src/main/java/com/trilead/ssh2/channel/ChannelManager.java | 3 ++- lib/src/main/java/com/trilead/ssh2/crypto/cipher/DES.java | 2 +- 9 files changed, 16 insertions(+), 15 deletions(-) diff --git a/lib/src/main/java/com/trilead/ssh2/AuthAgentCallback.java b/lib/src/main/java/com/trilead/ssh2/AuthAgentCallback.java index 7fe270b..96f2d07 100644 --- a/lib/src/main/java/com/trilead/ssh2/AuthAgentCallback.java +++ b/lib/src/main/java/com/trilead/ssh2/AuthAgentCallback.java @@ -17,9 +17,9 @@ public interface AuthAgentCallback { Map retrieveIdentities(); /** - * @param key A RSAPrivateKey or DSAPrivateKey - * containing a DSA or RSA private key of - * the user in Trilead object format. + * @param pair A RSAPrivateKey or DSAPrivateKey + * containing a DSA or RSA private key of + * the user in Trilead object format. * @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/lib/src/main/java/com/trilead/ssh2/ChannelCondition.java b/lib/src/main/java/com/trilead/ssh2/ChannelCondition.java index df1ad50..711e47b 100644 --- a/lib/src/main/java/com/trilead/ssh2/ChannelCondition.java +++ b/lib/src/main/java/com/trilead/ssh2/ChannelCondition.java @@ -17,7 +17,7 @@ public abstract interface ChannelCondition * A timeout has occurred, none of your requested conditions is fulfilled. * However, other conditions may be true - therefore, NEVER use the "==" * operator to test for this (or any other) condition. Always use - * something like ((cond & ChannelCondition.CLOSED) != 0). + * something like ((cond & ChannelCondition.CLOSED) != 0). */ public static final int TIMEOUT = 1; diff --git a/lib/src/main/java/com/trilead/ssh2/Connection.java b/lib/src/main/java/com/trilead/ssh2/Connection.java index 163fdb5..8582ea4 100644 --- a/lib/src/main/java/com/trilead/ssh2/Connection.java +++ b/lib/src/main/java/com/trilead/ssh2/Connection.java @@ -468,7 +468,7 @@ public class Connection * * @param user * A String holding the username. - * @param key + * @param pair * A RSAPrivateKey or DSAPrivateKey * containing a DSA or RSA private key of * the user in Trilead object format. diff --git a/lib/src/main/java/com/trilead/ssh2/DHGexParameters.java b/lib/src/main/java/com/trilead/ssh2/DHGexParameters.java index a2945ee..7872358 100644 --- a/lib/src/main/java/com/trilead/ssh2/DHGexParameters.java +++ b/lib/src/main/java/com/trilead/ssh2/DHGexParameters.java @@ -39,7 +39,7 @@ public class DHGexParameters * Internally, the minimum and maximum group lengths will * be set to zero. * - * @param pref_group_len has to be >= 1024 and <= 8192 + * @param pref_group_len has to be >= 1024 and <= 8192 */ public DHGexParameters(int pref_group_len) { @@ -58,7 +58,7 @@ public class DHGexParameters * Note: older OpenSSH servers don't understand this request, in which * case you should use the {@link #DHGexParameters(int)} constructor. *

- * All values have to be >= 1024 and <= 8192. Furthermore, + * All values have to be >= 1024 and <= 8192. Furthermore, * min_group_len <= pref_group_len <= max_group_len. * * @param min_group_len diff --git a/lib/src/main/java/com/trilead/ssh2/KnownHosts.java b/lib/src/main/java/com/trilead/ssh2/KnownHosts.java index ec022ff..4e75de1 100644 --- a/lib/src/main/java/com/trilead/ssh2/KnownHosts.java +++ b/lib/src/main/java/com/trilead/ssh2/KnownHosts.java @@ -40,7 +40,7 @@ import com.trilead.ssh2.signature.RSASHA1Verify; * It offers basically an in-memory database for known_hosts entries, as well as some * helper functions. Entries from a known_hosts file can be loaded at construction time. * It is also possible to add more keys later (e.g., one can parse different - * known_hosts files). + * known_hosts files). *

* It is a thread safe implementation, therefore, you need only to instantiate one * KnownHosts for your whole application. diff --git a/lib/src/main/java/com/trilead/ssh2/SFTPv3Client.java b/lib/src/main/java/com/trilead/ssh2/SFTPv3Client.java index 06796e9..ce25f07 100644 --- a/lib/src/main/java/com/trilead/ssh2/SFTPv3Client.java +++ b/lib/src/main/java/com/trilead/ssh2/SFTPv3Client.java @@ -1209,8 +1209,8 @@ public class SFTPv3Client *