Fix JavaDoc warnings

Author: str4d

src/net/i2p/crypto/eddsa/EdDSAEngine.java

@@ -318,6 +318,8 @@ private boolean x_engineVerify(byte[] sigBytes) throws SignatureException {
      *  sig = sign()
      *</pre>
      *
+     * @param data the message to be signed
+     * @return the signature
      * @throws SignatureException if update() already called
      * @see #ONE_SHOT_MODE
      */
@@ -336,6 +338,10 @@ public byte[] signOneShot(byte[] data) throws SignatureException {
      *  sig = sign()
      *</pre>
      *
+     * @param data byte array containing the message to be signed
+     * @param off the start of the message inside data
+     * @param len the length of the message
+     * @return the signature
      * @throws SignatureException if update() already called
      * @see #ONE_SHOT_MODE
      */
@@ -356,6 +362,9 @@ public byte[] signOneShot(byte[] data, int off, int len) throws SignatureExcepti
      *  ok = verify(signature)
      *</pre>
      *
+     * @param data the message that was signed
+     * @param signature of the message
+     * @return true if the signature is valid, false otherwise
      * @throws SignatureException if update() already called
      * @see #ONE_SHOT_MODE
      */
@@ -374,6 +383,11 @@ public boolean verifyOneShot(byte[] data, byte[] signature) throws SignatureExce
      *  ok = verify(signature)
      *</pre>
      *
+     * @param data byte array containing the message that was signed
+     * @param off the start of the message inside data
+     * @param len the length of the message
+     * @param signature of the message
+     * @return true if the signature is valid, false otherwise
      * @throws SignatureException if update() already called
      * @see #ONE_SHOT_MODE
      */
@@ -392,6 +406,11 @@ public boolean verifyOneShot(byte[] data, int off, int len, byte[] signature) th
      *  ok = verify(signature, sigoff, siglen)
      *</pre>
      *
+     * @param data the message that was signed
+     * @param signature byte array containing the signature
+     * @param sigoff the start of the signature
+     * @param siglen the length of the signature
+     * @return true if the signature is valid, false otherwise
      * @throws SignatureException if update() already called
      * @see #ONE_SHOT_MODE
      */
@@ -410,6 +429,13 @@ public boolean verifyOneShot(byte[] data, byte[] signature, int sigoff, int sigl
      *  ok = verify(signature, sigoff, siglen)
      *</pre>
      *
+     * @param data byte array containing the message that was signed
+     * @param off the start of the message inside data
+     * @param len the length of the message
+     * @param signature byte array containing the signature
+     * @param sigoff the start of the signature
+     * @param siglen the length of the signature
+     * @return true if the signature is valid, false otherwise
      * @throws SignatureException if update() already called
      * @see #ONE_SHOT_MODE
      */

src/net/i2p/crypto/eddsa/EdDSAKey.java

@@ -24,8 +24,8 @@ public interface EdDSAKey {
     String KEY_ALGORITHM = "EdDSA";
 
     /**
-     * return a parameter specification representing the EdDSA domain
-     * parameters for the key.
+     * @return a parameter specification representing the EdDSA domain
+     *         parameters for the key.
      */
     EdDSAParameterSpec getParams();
 }

src/net/i2p/crypto/eddsa/Utils.java

@@ -21,6 +21,8 @@
 public class Utils {
     /**
      * Constant-time byte comparison.
+     * @param b a byte
+     * @param c a byte
      * @return 1 if b and c are equal, 0 otherwise.
      */
     public static int equal(int b, int c) {
@@ -34,6 +36,8 @@ public static int equal(int b, int c) {
 
     /**
      * Constant-time byte[] comparison.
+     * @param b a byte[]
+     * @param c a byte[]
      * @return 1 if b and c are equal, 0 otherwise.
      */
     public static int equal(byte[] b, byte[] c) {

src/net/i2p/crypto/eddsa/math/Encoding.java

@@ -28,6 +28,7 @@ public synchronized void setField(Field f) {
 
     /**
      * Encode a FieldElement in its $(b-1)$-bit encoding.
+     * @param x the FieldElement to encode
      * @return the $(b-1)$-bit encoding of this FieldElement.
      */
     public abstract byte[] encode(FieldElement x);
@@ -46,6 +47,7 @@ public synchronized void setField(Field f) {
      * than the $(b-1)$-bit encoding of -x. If $q$ is an odd prime and the encoding
      * is the little-endian representation of $\{0, 1,\dots, q-1\}$ then the negative
      * elements of $F_q$ are $\{1, 3, 5,\dots, q-2\}$.
+     * @param x the FieldElement to check
      * @return true if negative
      */
     public abstract boolean isNegative(FieldElement x);

src/net/i2p/crypto/eddsa/math/GroupElement.java

@@ -505,7 +505,7 @@ public synchronized void precompute(final boolean precomputeSingle) {
      * $r$ in $P \times P$ representation:
      * <p>
      * $r = ((X' : Z'), (Y' : T'))$ where
-     * <p><ul>
+     * </p><ul>
      * <li>$X' = (X + Y)^2 - (Y^2 + X^2)$
      * <li>$Y' = Y^2 + X^2$
      * <li>$Z' = y^2 - X^2$
@@ -514,7 +514,7 @@ public synchronized void precompute(final boolean precomputeSingle) {
      * $r$ converted from $P \times P$ to $P^2$ representation:
      * <p>
      * $r = (X'' : Y'' : Z'')$ where
-     * <p><ul>
+     * </p><ul>
      * <li>$X'' = X' * Z' = ((X + Y)^2 - Y^2 - X^2) * (2 * Z^2 - (y^2 - X^2))$
      * <li>$Y'' = Y' * T' = (Y^2 + X^2) * (2 * Z^2 - (y^2 - X^2))$
      * <li>$Z'' = Z' * T' = (y^2 - X^2) * (2 * Z^2 - (y^2 - X^2))$
@@ -647,14 +647,14 @@ private GroupElement msub(GroupElement q) {
      * $r = p + q$ where $p = this = (X1 : Y1 : Z1 : T1), q = (q.X, q.Y, q.Z, q.T) = (Y2 + X2, Y2 - X2, Z2, 2 * d * T2)$
      * <p>
      * $r$ in $P \times P$ representation:
-     * <p><ul>
+     * </p><ul>
      * <li>$X' = (Y1 + X1) * (Y2 + X2) - (Y1 - X1) * (Y2 - X2)$
      * <li>$Y' = (Y1 + X1) * (Y2 + X2) + (Y1 - X1) * (Y2 - X2)$
      * <li>$Z' = 2 * Z1 * Z2 + 2 * d * T1 * T2$
      * <li>$T' = 2 * Z1 * T2 - 2 * d * T1 * T2$
      * </ul><p>
      * Setting $A = (Y1 - X1) * (Y2 - X2), B = (Y1 + X1) * (Y2 + X2), C = 2 * d * T1 * T2, D = 2 * Z1 * Z2$ we get
-     * <p><ul>
+     * </p><ul>
      * <li>$X' = (B - A)$
      * <li>$Y' = (B + A)$
      * <li>$Z' = (D + C)$

src/net/i2p/crypto/eddsa/math/ScalarOps.java

@@ -18,16 +18,16 @@ public interface ScalarOps {
      * From the Ed25519 paper:<br>
      * Here we interpret $2b$-bit strings in little-endian form as integers in
      * $\{0, 1,..., 2^{(2b)}-1\}$.
-     * @param s
+     * @param s the scalar to reduce
      * @return $s \bmod l$
      */
     public byte[] reduce(byte[] s);
 
     /**
      * $r = (a * b + c) \bmod l$
-     * @param a
-     * @param b
-     * @param c
+     * @param a a scalar
+     * @param b a scalar
+     * @param c a scalar
      * @return $(a*b + c) \bmod l$
      */
     public byte[] multiplyAndAdd(byte[] a, byte[] b, byte[] c);

src/net/i2p/crypto/eddsa/math/bigint/BigIntegerLittleEndianEncoding.java

@@ -39,6 +39,7 @@ public byte[] encode(FieldElement x) {
      *  Convert $x$ to little endian.
      *  Constant time.
      *
+     *  @param x the BigInteger value to encode
      *  @return array of length $b/8$
      *  @throws IllegalStateException if field not set
      */
@@ -75,6 +76,9 @@ public FieldElement decode(byte[] in) {
 
     /**
      *  Convert in to big endian
+     *
+     *  @param in the $(b-1)$-bit encoding of a FieldElement.
+     *  @return the decoded value as a BigInteger
      */
     public BigInteger toBigInteger(byte[] in) {
         byte[] out = new byte[in.length];

src/net/i2p/crypto/eddsa/spec/EdDSAParameterSpec.java

@@ -34,7 +34,11 @@ public class EdDSAParameterSpec implements AlgorithmParameterSpec, Serializable
     private final GroupElement B;
 
     /**
-     *  @throws IllegalArgumentException if hash algorithm is unsupported or length is wrong
+     * @param curve the curve
+     * @param hashAlgo the JCA string for the hash algorithm
+     * @param sc the parameter L represented as ScalarOps
+     * @param B the parameter B
+     * @throws IllegalArgumentException if hash algorithm is unsupported or length is wrong
      */
     public EdDSAParameterSpec(Curve curve, String hashAlgo,
             ScalarOps sc, GroupElement B) {

src/net/i2p/crypto/eddsa/spec/EdDSAPrivateKeySpec.java

@@ -30,6 +30,8 @@ public class EdDSAPrivateKeySpec implements KeySpec {
     private final EdDSAParameterSpec spec;
 
     /**
+     *  @param seed the private key
+     *  @param spec the parameter specification for this key
      *  @throws IllegalArgumentException if seed length is wrong or hash algorithm is unsupported
      */
     public EdDSAPrivateKeySpec(byte[] seed, EdDSAParameterSpec spec) {
@@ -67,6 +69,7 @@ public EdDSAPrivateKeySpec(byte[] seed, EdDSAParameterSpec spec) {
      *  Initialize directly from the hash.
      *  getSeed() will return null if this constructor is used.
      *
+     *  @param spec the parameter specification for this key
      *  @param h the private key
      *  @throws IllegalArgumentException if hash length is wrong
      *  @since 0.1.1

src/net/i2p/crypto/eddsa/spec/EdDSAPublicKeySpec.java

@@ -25,7 +25,9 @@ public class EdDSAPublicKeySpec implements KeySpec {
     private final EdDSAParameterSpec spec;
 
     /**
-     *  @throws IllegalArgumentException if key length is wrong
+     * @param pk the public key
+     * @param spec the parameter specification for this key
+     * @throws IllegalArgumentException if key length is wrong
      */
     public EdDSAPublicKeySpec(byte[] pk, EdDSAParameterSpec spec) {
         if (pk.length != spec.getCurve().getField().getb()/8)