Skip to content

Commit 1f2da01

Browse files
committed
- JavaDoc fixes/enhancements
1 parent 6f219c8 commit 1f2da01

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

api/src/main/java/io/jsonwebtoken/JwtBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -566,7 +566,7 @@ public interface JwtBuilder extends ClaimsMutator<JwtBuilder> {
566566
* length to parallel similar decisions in the JWT specification for HMAC and ECDSA signature algorithms.
567567
* This is not required - just a convenience.</li>
568568
* <li><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/security/interfaces/EdECKey.html">EdECKey</a>s
569-
* require JDK >= 15 or BouncyCastle in the runtime classpath.</li>
569+
* require JDK &gt;= 15 or BouncyCastle in the runtime classpath.</li>
570570
* </ol>
571571
*
572572
* <p>This implementation does not use the {@link StandardSecureDigestAlgorithms#PS256 PS256},

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

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -159,24 +159,28 @@ public static StandardSecureDigestAlgorithms get() { // named `get` to mimic jav
159159
* {@code EdDSA} signature algorithm as defined by
160160
* <a href="https://www.rfc-editor.org/rfc/rfc8037#section-3.1">RFC 8037, Section 3.1</a>. This algorithm
161161
* requires either {@code Ed25519} or {@code Ed448} Edwards Curve keys.
162+
* <p><b>This algorithm requires at least JDK 15 or a compatible JCA Provider (like BouncyCastle) in the runtime
163+
* classpath.</b></p>
162164
*/
163165
public final SignatureAlgorithm EdDSA = doGet("EdDSA");
164166

165167
/**
166-
* {@code EdDSA} signature algorithm using Curve 25519 as defined by
168+
* {@code EdDSA} signature algorithm using Curve {@code Ed25519} as defined by
167169
* <a href="https://www.rfc-editor.org/rfc/rfc8037#section-3.1">RFC 8037, Section 3.1</a>. This algorithm
168-
* requires {@code Ed25519} Edwards Curve keys to create signatures.
169-
* <p><b>This is a convenience alias for {@link #EdDSA}</b> that defaults key generation to
170-
* {@code Ed25519} keys.</p>
170+
* requires {@code Ed25519} Edwards Curve keys to create signatures. <b>This is a convenience alias for
171+
* {@link #EdDSA}</b> that defaults key generation to {@code Ed25519} keys.</p>
172+
* <p><b>This algorithm requires at least JDK 15 or a compatible JCA Provider (like BouncyCastle) in the runtime
173+
* classpath.</b></p>
171174
*/
172175
public final SignatureAlgorithm Ed25519 = doGet("Ed25519");
173176

174177
/**
175-
* {@code EdDSA} signature algorithm using Curve 25519 as defined by
178+
* {@code EdDSA} signature algorithm using Curve {@code Ed448} as defined by
176179
* <a href="https://www.rfc-editor.org/rfc/rfc8037#section-3.1">RFC 8037, Section 3.1</a>. This algorithm
177-
* requires {@code Ed448} Edwards Curve keys to create signatures.
178-
* <p><b>This is a convenience alias for {@link #EdDSA}</b> that defaults key generation to
179-
* {@code Ed448} keys.</p>
180+
* requires {@code Ed448} Edwards Curve keys to create signatures. <b>This is a convenience alias for
181+
* {@link #EdDSA}</b> that defaults key generation to {@code Ed448} keys.
182+
* <p><b>This algorithm requires at least JDK 15 or a compatible JCA Provider (like BouncyCastle) in the runtime
183+
* classpath.</b></p>
180184
*/
181185
public final SignatureAlgorithm Ed448 = doGet("Ed448");
182186

0 commit comments

Comments
 (0)