Fix various javadoc errors

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<String,byte[]> retrieveIdentities();
 
 	/**
-	 * @param key 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> or <code>DSAPrivateKey</code>
+	 *             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 <code>((cond & ChannelCondition.CLOSED) != 0)</code>.
+	 * something like <code>((cond &amp; ChannelCondition.CLOSED) != 0)</code>.
 	 */
 	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 <code>String</code> holding the username.
-	 * @param key
+	 * @param pair
 	 *            A <code>RSAPrivateKey</code> or <code>DSAPrivateKey</code>
 	 *            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 &gt= 1024 and &lt;= 8192
+	 * @param pref_group_len has to be &gt;= 1024 and &lt;= 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.
 	 * <p>
-	 * All values have to be &gt= 1024 and &lt;= 8192. Furthermore,
+	 * All values have to be &gt;= 1024 and &lt;= 8192. Furthermore,
 	 * min_group_len &lt;= pref_group_len &lt;= 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 <code>known_hosts</code> file can be loaded at construction time.
  * It is also possible to add more keys later (e.g., one can parse different
- * <code>known_hosts<code> files).
+ * <code>known_hosts</code> files).
  * <p>
  * It is a thread safe implementation, therefore, you need only to instantiate one
  * <code>KnownHosts</code> 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
 	 * <ul>
 	 * <li>The server will read as many bytes as it can from the file (up to <code>len</code>),
 	 * and return them.</li>
-	 * <li>If EOF is encountered before reading any data, <code>-1</code> is returned.
-	 * <li>If an error occurs, an exception is thrown</li>.
+	 * <li>If EOF is encountered before reading any data, <code>-1</code> is returned.</li>
+	 * <li>If an error occurs, an exception is thrown.</li>
 	 * <li>For normal disk files, it is guaranteed that the server will return the specified
 	 * number of bytes, or up to end of file. For, e.g., device files this may return
 	 * fewer bytes than requested.</li>
diff --git a/lib/src/main/java/com/trilead/ssh2/Session.java b/lib/src/main/java/com/trilead/ssh2/Session.java
index bf3c7e0..9c84004 100644
--- a/lib/src/main/java/com/trilead/ssh2/Session.java
+++ b/lib/src/main/java/com/trilead/ssh2/Session.java
@@ -442,8 +442,8 @@ public class Session
 	 * This method returns as soon as one of the following happens:
 	 * <ul>
 	 * <li>at least of the specified conditions (see {@link ChannelCondition}) holds true</li>
-	 * <li>timeout > 0 and a timeout occured (TIMEOUT will be set in result conditions)</a> 
-	 * <li>the underlying channel was closed (CLOSED will be set in result conditions)</a>
+	 * <li>timeout &gt; 0 and a timeout occured (TIMEOUT will be set in result conditions)</li> 
+	 * <li>the underlying channel was closed (CLOSED will be set in result conditions)</li>
 	 * </ul>
 	 * <p>
 	 * In any case, the result value contains ALL current conditions, which may be more
@@ -472,7 +472,7 @@ public class Session
 	 * Get the exit code/status from the remote command - if available. Be
 	 * careful - not all server implementations return this value. It is
 	 * generally a good idea to call this method only when all data from the
-	 * remote side has been consumed (see also the <code<WaitForCondition</code> method).
+	 * remote side has been consumed (see also the <code>WaitForCondition</code> method).
 	 * 
 	 * @return An <code>Integer</code> holding the exit code, or
 	 *         <code>null</code> if no exit code is (yet) available.
diff --git a/lib/src/main/java/com/trilead/ssh2/channel/ChannelManager.java b/lib/src/main/java/com/trilead/ssh2/channel/ChannelManager.java
index 88beffd..3f05468 100644
--- a/lib/src/main/java/com/trilead/ssh2/channel/ChannelManager.java
+++ b/lib/src/main/java/com/trilead/ssh2/channel/ChannelManager.java
@@ -535,7 +535,8 @@ public class ChannelManager implements MessageHandler
 	}
 
 	/**
-	 * @param agent
+	 * @param c
+	 * @param authAgent
 	 * @throws IOException
 	 */
 	public boolean requestChannelAgentForwarding(Channel c, AuthAgentCallback authAgent) throws IOException {
diff --git a/lib/src/main/java/com/trilead/ssh2/crypto/cipher/DES.java b/lib/src/main/java/com/trilead/ssh2/crypto/cipher/DES.java
index 6588459..40d6481 100644
--- a/lib/src/main/java/com/trilead/ssh2/crypto/cipher/DES.java
+++ b/lib/src/main/java/com/trilead/ssh2/crypto/cipher/DES.java
@@ -187,7 +187,7 @@ public class DES implements BlockCipher
 	 * generate an integer based working key based on our secret key and what we
 	 * processing we are planning to do.
 	 * 
-	 * Acknowledgements for this routine go to James Gillogly & Phil Karn.
+	 * Acknowledgements for this routine go to James Gillogly &amp; Phil Karn.
 	 * (whoever, and wherever they are!).
 	 */
 	protected int[] generateWorkingKey(boolean encrypting, byte[] key, int off)