Skip to content

Commit c41bcdb

Browse files
committed
Add JavaDoc cross-references between getAuthenticatorAttachment() methods
1 parent 15e9108 commit c41bcdb

File tree

3 files changed

+19
-1
lines changed

3 files changed

+19
-1
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,7 @@ public boolean isBackedUp() {
200200
* The <a href="https://w3c.github.io/webauthn/#authenticator-attachment-modality">authenticator
201201
* attachment modality</a> in effect at the time the asserted credential was used.
202202
*
203+
* @see PublicKeyCredential#getAuthenticatorAttachment()
203204
* @deprecated EXPERIMENTAL: This feature is from a not yet mature standard; it could change as
204205
* the standard matures.
205206
*/

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,7 @@ public boolean isBackedUp() {
180180
* The <a href="https://w3c.github.io/webauthn/#authenticator-attachment-modality">authenticator
181181
* attachment modality</a> in effect at the time the credential was created.
182182
*
183+
* @see PublicKeyCredential#getAuthenticatorAttachment()
183184
* @deprecated EXPERIMENTAL: This feature is from a not yet mature standard; it could change as
184185
* the standard matures.
185186
*/

webauthn-server-core/src/main/java/com/yubico/webauthn/data/PublicKeyCredential.java

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@
2828
import com.fasterxml.jackson.annotation.JsonProperty;
2929
import com.fasterxml.jackson.core.type.TypeReference;
3030
import com.yubico.internal.util.JacksonCodecs;
31+
import com.yubico.webauthn.AssertionResult;
32+
import com.yubico.webauthn.FinishAssertionOptions;
33+
import com.yubico.webauthn.FinishRegistrationOptions;
34+
import com.yubico.webauthn.RegistrationResult;
35+
import com.yubico.webauthn.RelyingParty;
3136
import java.io.IOException;
3237
import java.util.Optional;
3338
import lombok.AllArgsConstructor;
@@ -113,8 +118,19 @@ private PublicKeyCredential(
113118

114119
/**
115120
* The <a href="https://w3c.github.io/webauthn/#authenticator-attachment-modality">authenticator
116-
* attachment modality</a> in effect at the time the credential was used.
121+
* attachment modality</a> in effect at the time the credential was created or used.
117122
*
123+
* <p>If parsed from JSON, this will be present if and only if the input was a valid value of
124+
* {@link AuthenticatorAttachment}.
125+
*
126+
* <p>The same value will also be available via {@link
127+
* RegistrationResult#getAuthenticatorAttachment()} or {@link
128+
* AssertionResult#getAuthenticatorAttachment()} on the result from {@link
129+
* RelyingParty#finishRegistration(FinishRegistrationOptions)} or {@link
130+
* RelyingParty#finishAssertion(FinishAssertionOptions)}.
131+
*
132+
* @see RegistrationResult#getAuthenticatorAttachment()
133+
* @see AssertionResult#getAuthenticatorAttachment()
118134
* @deprecated EXPERIMENTAL: This feature is from a not yet mature standard; it could change as
119135
* the standard matures.
120136
*/

0 commit comments

Comments
 (0)