Fix broken JavaDoc for RegistrationResult.attestationType and .attest…

…ationTrustPath
Yubico · Nov 10, 2022 · e14123a · e14123a
1 parent 58322c1
commit e14123a
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 19 deletions.
diff --git a/NEWS b/NEWS
@@ -9,7 +9,7 @@ Fixes:
   in the Subject Alternative Names extension.
  ** Thanks to Oussama Zgheb for the contribution, see
     https://github.com/Yubico/java-webauthn-server/pull/241
-* Fixed various link syntax errors in JavaDocs.
+* Fixed various errors in JavaDoc.
 
 
 `webauthn-server-attestation`:

diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/RegistrationResult.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/RegistrationResult.java
@@ -89,9 +89,9 @@ public class RegistrationResult {
   private final boolean attestationTrusted;
 
   /**
-   * The attestation type <a
-   * href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-attestation-types">§6.4.3.
-   * Attestation Types</a> that was used for the created credential.
+   * The <a
+   * href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-attestation-types">attestation
+   * type</a> that was used for the created credential.
    *
    * <p>You can ignore this if authenticator attestation is not relevant to your application.
    *
@@ -101,21 +101,7 @@ public class RegistrationResult {
    */
   @NonNull private final AttestationType attestationType;
 
-  /**
-   * The <a
-   * href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#attestation-trust-path">attestation
-   * trust path</a> for the created credential, if any.
-   *
-   * <p>If present, this may be useful for looking up attestation metadata from external sources.
-   * The attestation trust path has been successfully verified as trusted if and only if {@link
-   * #isAttestationTrusted()} is <code>true</code>.
-   *
-   * <p>You can ignore this if authenticator attestation is not relevant to your application.
-   *
-   * @see <a
-   *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#attestation-trust-path">Attestation
-   *     trust path</a>
-   */
+  // JavaDoc on getter
   private final List<X509Certificate> attestationTrustPath;
 
   /**
@@ -200,6 +186,21 @@ private static RegistrationResult fromJson(
         authenticatorExtensionOutputs);
   }
 
+  /**
+   * The <a
+   * href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#attestation-trust-path">attestation
+   * trust path</a> for the created credential, if any.
+   *
+   * <p>If present, this may be useful for looking up attestation metadata from external sources.
+   * The attestation trust path has been successfully verified as trusted if and only if {@link
+   * #isAttestationTrusted()} is <code>true</code>.
+   *
+   * <p>You can ignore this if authenticator attestation is not relevant to your application.
+   *
+   * @see <a
+   *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#attestation-trust-path">Attestation
+   *     trust path</a>
+   */
   @JsonIgnore
   public Optional<List<X509Certificate>> getAttestationTrustPath() {
     return Optional.ofNullable(attestationTrustPath);