Skip to content

Commit e14123a

Browse files
committed
Fix broken JavaDoc for RegistrationResult.attestationType and .attestationTrustPath
1 parent 58322c1 commit e14123a

File tree

2 files changed

+20
-19
lines changed

2 files changed

+20
-19
lines changed

NEWS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Fixes:
99
in the Subject Alternative Names extension.
1010
** Thanks to Oussama Zgheb for the contribution, see
1111
https://github.com/Yubico/java-webauthn-server/pull/241
12-
* Fixed various link syntax errors in JavaDocs.
12+
* Fixed various errors in JavaDoc.
1313

1414

1515
`webauthn-server-attestation`:

webauthn-server-core/src/main/java/com/yubico/webauthn/RegistrationResult.java

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ public class RegistrationResult {
8989
private final boolean attestationTrusted;
9090

9191
/**
92-
* The attestation type <a
93-
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-attestation-types">§6.4.3.
94-
* Attestation Types</a> that was used for the created credential.
92+
* The <a
93+
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-attestation-types">attestation
94+
* type</a> that was used for the created credential.
9595
*
9696
* <p>You can ignore this if authenticator attestation is not relevant to your application.
9797
*
@@ -101,21 +101,7 @@ public class RegistrationResult {
101101
*/
102102
@NonNull private final AttestationType attestationType;
103103

104-
/**
105-
* The <a
106-
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#attestation-trust-path">attestation
107-
* trust path</a> for the created credential, if any.
108-
*
109-
* <p>If present, this may be useful for looking up attestation metadata from external sources.
110-
* The attestation trust path has been successfully verified as trusted if and only if {@link
111-
* #isAttestationTrusted()} is <code>true</code>.
112-
*
113-
* <p>You can ignore this if authenticator attestation is not relevant to your application.
114-
*
115-
* @see <a
116-
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#attestation-trust-path">Attestation
117-
* trust path</a>
118-
*/
104+
// JavaDoc on getter
119105
private final List<X509Certificate> attestationTrustPath;
120106

121107
/**
@@ -200,6 +186,21 @@ private static RegistrationResult fromJson(
200186
authenticatorExtensionOutputs);
201187
}
202188

189+
/**
190+
* The <a
191+
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#attestation-trust-path">attestation
192+
* trust path</a> for the created credential, if any.
193+
*
194+
* <p>If present, this may be useful for looking up attestation metadata from external sources.
195+
* The attestation trust path has been successfully verified as trusted if and only if {@link
196+
* #isAttestationTrusted()} is <code>true</code>.
197+
*
198+
* <p>You can ignore this if authenticator attestation is not relevant to your application.
199+
*
200+
* @see <a
201+
* href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#attestation-trust-path">Attestation
202+
* trust path</a>
203+
*/
203204
@JsonIgnore
204205
public Optional<List<X509Certificate>> getAttestationTrustPath() {
205206
return Optional.ofNullable(attestationTrustPath);

0 commit comments

Comments
 (0)