Minor javadoc fixes

kocakosm · Aug 22, 2016 · f2b203b · f2b203b
1 parent 13f585d
commit f2b203b
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 21 deletions.
diff --git a/src/org/kocakosm/pitaya/security/HMAC.java b/src/org/kocakosm/pitaya/security/HMAC.java
@@ -34,11 +34,11 @@
 public final class HMAC
 {
 	/**
-	 * Returns a new MD2 HMAC engine.
+	 * Returns a new HMAC-MD2 engine.
 	 *
 	 * @param key the HMAC's secret key.
 	 *
-	 * @return a new MD2 HMAC engine.
+	 * @return a new HMAC-MD2 engine.
 	 *
 	 * @throws NullPointerException if {@code key} is {@code null}.
 	 */
@@ -62,11 +62,11 @@ public static MAC md4(byte... key)
 	}
 
 	/**
-	 * Returns a new MD5 HMAC engine.
+	 * Returns a new HMAC-MD5 engine.
 	 *
 	 * @param key the HMAC's secret key.
 	 *
-	 * @return a new MD5 HMAC engine.
+	 * @return a new HMAC-MD5 engine.
 	 *
 	 * @throws NullPointerException if {@code key} is {@code null}.
 	 */
@@ -76,11 +76,11 @@ public static MAC md5(byte... key)
 	}
 
 	/**
-	 * Returns a new SHA1 HMAC engine.
+	 * Returns a new HMAC-SHA1 engine.
 	 *
 	 * @param key the HMAC's secret key.
 	 *
-	 * @return a new SHA1 HMAC engine.
+	 * @return a new HMAC-SHA1 engine.
 	 *
 	 * @throws NullPointerException if {@code key} is {@code null}.
 	 */
@@ -90,11 +90,11 @@ public static MAC sha1(byte... key)
 	}
 
 	/**
-	 * Returns a new SHA-256 HMAC engine.
+	 * Returns a new HMAC-SHA-256 engine.
 	 *
 	 * @param key the HMAC's secret key.
 	 *
-	 * @return a new SHA-256 HMAC engine.
+	 * @return a new HMAC-SHA-256 engine.
 	 *
 	 * @throws NullPointerException if {@code key} is {@code null}.
 	 */
@@ -104,11 +104,11 @@ public static MAC sha256(byte... key)
 	}
 
 	/**
-	 * Returns a new SHA-512 HMAC engine.
+	 * Returns a new HMAC-SHA-512 engine.
 	 *
 	 * @param key the HMAC's secret key.
 	 *
-	 * @return a new SHA-512 HMAC engine.
+	 * @return a new HMAC-SHA-512 engine.
 	 *
 	 * @throws NullPointerException if {@code key} is {@code null}.
 	 */
@@ -118,11 +118,11 @@ public static MAC sha512(byte... key)
 	}
 
 	/**
-	 * Returns a new Keccak-224 HMAC engine.
+	 * Returns a new HMAC-Keccak-224 engine.
 	 *
 	 * @param key the HMAC's secret key.
 	 *
-	 * @return a new Keccak-224 HMAC engine.
+	 * @return a new HMAC-Keccak-224 engine.
 	 *
 	 * @throws NullPointerException if {@code key} is {@code null}.
 	 */
@@ -132,11 +132,11 @@ public static MAC keccak224(byte... key)
 	}
 
 	/**
-	 * Returns a new Keccak-256 HMAC engine.
+	 * Returns a new HMAC-Keccak-256 engine.
 	 *
 	 * @param key the HMAC's secret key.
 	 *
-	 * @return a new Keccak-256 HMAC engine.
+	 * @return a new HMAC-Keccak-256 engine.
 	 *
 	 * @throws NullPointerException if {@code key} is {@code null}.
 	 */
@@ -146,11 +146,11 @@ public static MAC keccak256(byte... key)
 	}
 
 	/**
-	 * Returns a new Keccak-384 HMAC engine.
+	 * Returns a new HMAC-Keccak-384 engine.
 	 *
 	 * @param key the HMAC's secret key.
 	 *
-	 * @return a new Keccak-384 HMAC engine.
+	 * @return a new HMAC-Keccak-384 engine.
 	 *
 	 * @throws NullPointerException if {@code key} is {@code null}.
 	 */
@@ -160,11 +160,11 @@ public static MAC keccak384(byte... key)
 	}
 
 	/**
-	 * Returns a new Keccak-512 HMAC engine.
+	 * Returns a new HMAC-Keccak-512 engine.
 	 *
 	 * @param key the HMAC's secret key.
 	 *
-	 * @return a new Keccak-512 HMAC engine.
+	 * @return a new HMAC-Keccak-512 engine.
 	 *
 	 * @throws NullPointerException if {@code key} is {@code null}.
 	 */

diff --git a/src/org/kocakosm/pitaya/security/KDFs.java b/src/org/kocakosm/pitaya/security/KDFs.java
@@ -88,9 +88,7 @@ public static KDF hkdf(Algorithm<MAC> mac, byte[] info, int dkLen)
 
 	/**
 	 * Creates and returns a new immutable {@code KDF} instance implementing
-	 * the SCrypt algorithm as specified by the Internet Engineering Task
-	 * Force. See http://tools.ietf.org/html/draft-josefsson-scrypt-kdf-01
-	 * for more information.
+	 * the SCrypt algorithm (RFC 7914).
 	 *
 	 * @param r the block size parameter.
 	 * @param n the CPU/Memory cost parameter.