JavaDoc cleanup

Author: lhazlewood

api/src/main/java/io/jsonwebtoken/security/AeadAlgorithm.java

@@ -26,7 +26,7 @@
  * Per <a href="https://www.rfc-editor.org/rfc/rfc7516.html#section-4.1.2">JWE RFC 7516, Section 4.1.2</a>, all JWEs
  * <em>MUST</em> use an AEAD algorithm to encrypt or decrypt the JWE payload/content.  Consequently, all
  * <a href="https://www.rfc-editor.org/rfc/rfc7518.html#section-5.1">JWA &quot;enc&quot; algorithms</a> are AEAD
- * algorithms, and they are accessible as concrete instances via {@link Jwe.alg}.
+ * algorithms, and they are accessible as concrete instances via {@link io.jsonwebtoken.Jwe.alg Jwe.alg}.
  *
  * <p><b>&quot;enc&quot; identifier</b></p>
  *
@@ -57,7 +57,7 @@
  * <p>The resulting {@code key} is guaranteed to have the correct algorithm parameters and strength/length necessary for
  * that exact {@code aeadAlgorithm} instance.</p>
  *
- * @see Jwe.alg
+ * @see io.jsonwebtoken.Jwe.alg Jwe.alg
  * @see Identifiable#getId()
  * @see KeyLengthSupplier
  * @see KeyBuilderSupplier

api/src/main/java/io/jsonwebtoken/security/AeadResult.java

@@ -55,8 +55,9 @@ public interface AeadResult extends DigestSupplier, IvSupplier {
      * Returns a new {@link AeadResult} with the specified {@link OutputStream} that will be used to write the
      * resulting ciphertext during encryption or plaintext during decryption.
      *
+     * @param out the {@link OutputStream} that will be used to write the resulting ciphertext during encryption
      * @return a new {@link AeadResult} with the specified {@link OutputStream} that will be used to write the
-     * resulting ciphertext during encryption or plaintext during decryption.
+     * resulting ciphertext during encryption.
      * @since JJWT_RELEASE_VERSION
      */
     static AeadResult with(OutputStream out) {

api/src/main/java/io/jsonwebtoken/security/DecryptAeadRequest.java

@@ -38,6 +38,7 @@ interface Params<M extends Params<M>> extends AeadRequest.Params<M> {
          * Sets the required initialization vector used during AEAD decryption.
          *
          * @param iv the required initialization vector used during AEAD decryption.
+         * @return the instance for method chaining.
          */
         M iv(byte[] iv);
 

api/src/main/java/io/jsonwebtoken/security/Request.java

@@ -105,6 +105,7 @@ interface Builder<T> extends io.jsonwebtoken.lang.Builder<Request<T>>, Params<T,
     /**
      * Returns a new {@link Request.Builder} for creating immutable {@link Request}s.
      *
+     * @param <T> the type of payload in the request.
      * @return a new {@link Request.Builder} for creating immutable {@link Request}s.
      * @since JJWT_RELEASE_VERSION
      */

api/src/main/java/io/jsonwebtoken/security/SecureRequest.java

@@ -60,6 +60,8 @@ interface Builder<T, K extends Key> extends Params<T, K, Builder<T, K>>, io.json
      * Returns a new {@link SecureRequest.Builder} for creating {@link SecureRequest}s used to compute a mac or
      * signature via {@link SecureDigestAlgorithm#digest(Request)}.
      *
+     * @param <T> the type of payload in the request.
+     * @param <K> the type of key used by the algorithm to compute the digest.
      * @return a new {@link SecureRequest.Builder} for creating {@link SecureRequest}s used to compute a mac or
      * signature via {@link SecureDigestAlgorithm#digest(Request)}.
      * @since JJWT_RELEASE_VERSION

api/src/main/java/io/jsonwebtoken/security/VerifySecureDigestRequest.java

@@ -58,6 +58,7 @@ interface Builder<K extends Key> extends Params<K, Builder<K>>, io.jsonwebtoken.
      * Returns a new {@link VerifySecureDigestRequest.Builder} for creating {@link VerifySecureDigestRequest}s used
      * to verify a mac or signature via {@link SecureDigestAlgorithm#verify(VerifyDigestRequest)}.
      *
+     * @param <K> type of key used to verify the digest.
      * @return a new {@link VerifySecureDigestRequest.Builder} for creating {@link VerifySecureDigestRequest}s used
      * to verify a mac or signature via {@link SecureDigestAlgorithm#verify(VerifyDigestRequest)}.
      * @since JJWT_RELEASE_VERSION