add javadoc to extension classes

Yubico · Dec 10, 2024 · 117e9f3 · 117e9f3
1 parent 70ea7d0
commit 117e9f3
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 0 deletions.
diff --git a/fido/src/main/java/com/yubico/yubikit/fido/client/extensions/CredBlobExtension.java b/fido/src/main/java/com/yubico/yubikit/fido/client/extensions/CredBlobExtension.java
@@ -28,6 +28,10 @@
 
 import javax.annotation.Nullable;
 
+/**
+ * Implements the Credential Blob (credBlob) CTAP2 extension.
+ * @see <a href="https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#sctn-credBlob-extension">Credential Blob (credBlob)</a>
+ */
 public class CredBlobExtension extends Extension {
 
     public CredBlobExtension() {

diff --git a/fido/src/main/java/com/yubico/yubikit/fido/client/extensions/CredPropsExtension.java b/fido/src/main/java/com/yubico/yubikit/fido/client/extensions/CredPropsExtension.java
@@ -27,6 +27,10 @@
 
 import javax.annotation.Nullable;
 
+/**
+ * Implements the Credential Properties (credProps) WebAuthn extension.
+ * @see <a href="https://www.w3.org/TR/webauthn-3/#sctn-authenticator-credential-properties-extension">Credential Properties Extension (credProps)</a>
+ */
 public class CredPropsExtension extends Extension {
 
     public CredPropsExtension() {

diff --git a/fido/src/main/java/com/yubico/yubikit/fido/client/extensions/CredProtectExtension.java b/fido/src/main/java/com/yubico/yubikit/fido/client/extensions/CredProtectExtension.java
@@ -25,6 +25,10 @@
 
 import javax.annotation.Nullable;
 
+/**
+ * Implements the Credential Protection CTAP2 extension.
+ * @see <a href="https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#sctn-credProtect-extension">Credential Protection (credProtect)</a>
+ */
 public class CredProtectExtension extends Extension {
 
     private static final String POLICY = "credentialProtectionPolicy";

diff --git a/fido/src/main/java/com/yubico/yubikit/fido/client/extensions/Extension.java b/fido/src/main/java/com/yubico/yubikit/fido/client/extensions/Extension.java
@@ -30,6 +30,10 @@
 
 import javax.annotation.Nullable;
 
+/**
+ * Base class for FIDO2 extensions.
+ * @see <a href="https://www.w3.org/TR/webauthn-3/#sctn-extensions">Webauthn Extensions</a>
+ */
 public abstract class Extension {
     protected final String name;
 

diff --git a/fido/src/main/java/com/yubico/yubikit/fido/client/extensions/LargeBlobExtension.java b/fido/src/main/java/com/yubico/yubikit/fido/client/extensions/LargeBlobExtension.java
@@ -39,6 +39,11 @@
 
 import javax.annotation.Nullable;
 
+/**
+ * Implements the Large Blob storage (largeBlob) WebAuthn extension.
+ * @see <a href="https://www.w3.org/TR/webauthn-3/#sctn-large-blob-extension">Large blob extension</a>
+ * @see <a href="https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#sctn-largeBlobKey-extension">Large Blob Key (largeBlobKey)</a>
+ */
 public class LargeBlobExtension extends Extension {
     private static final String LARGE_BLOB_KEY = "largeBlobKey";
     private static final String LARGE_BLOB = "largeBlob";

diff --git a/fido/src/main/java/com/yubico/yubikit/fido/client/extensions/MinPinLengthExtension.java b/fido/src/main/java/com/yubico/yubikit/fido/client/extensions/MinPinLengthExtension.java
@@ -25,6 +25,10 @@
 
 import javax.annotation.Nullable;
 
+/**
+ * Implements the Minimum PIN Length (minPinLength) CTAP2 extension.
+ * @see <a href="https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#sctn-minpinlength-extension">Minimum PIN Length Extension (minPinLength)</a>
+ */
 public class MinPinLengthExtension extends Extension {
 
     public MinPinLengthExtension() {