Update docs

M3DZIK · Feb 28, 2024 · 5a3fc55 · 5a3fc55
1 parent 4afb927
commit 5a3fc55
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/src/main/java/dev/medzik/otp/HOTPGenerator.java b/src/main/java/dev/medzik/otp/HOTPGenerator.java
@@ -18,7 +18,7 @@ public final class HOTPGenerator {
     private OTPParameters params;
 
     /**
-     * Generate HOTP code from the given parameters for the given counter.
+     * Generates HOTP code from the given parameters for the given counter.
      *
      * @param params The OTP parameters.
      * @param counter The HOTP counter.
@@ -30,9 +30,10 @@ public static String generate(OTPParameters params, long counter) throws Illegal
     }
 
     /**
-     * Generate HOTP code from the OTPAuth URL.
+     * Generates HOTP code from the OTPAuth URL.
      *
      * @param url The OTPAuth URL.
+     * @param counter The HOTP counter.
      * @return The HOTP code.
      * @throws URISyntaxException If the OTP type is not TOTP.
      */

diff --git a/src/main/java/dev/medzik/otp/OTPParameters.java b/src/main/java/dev/medzik/otp/OTPParameters.java
@@ -121,7 +121,7 @@ public OTPParameters build() throws IllegalArgumentException {
     }
 
     /**
-     * Encode the parameters as OTPAuth URL.
+     * Encodes the parameters as OTPAuth URL.
      *
      * @return The encoded OTPAuth URL.
      */
@@ -176,15 +176,17 @@ public final static class Secret {
         private final byte[] value;
 
         /**
-         * Generate OTP secret with default number of bits.
+         * Generates OTP secret with default number of bits.
+         *
          * @return The randomly generated secret.
          */
         public static Secret generate() {
             return generate(DEFAULT_BITS);
         }
 
         /**
-         * Generate OTP secret with specified number of bits.
+         * Generates OTP secret with specified number of bits.
+         *
          * @param bits The number of bits to generate.
          * @return The randomly generated secret.
          */

diff --git a/src/main/java/dev/medzik/otp/OTPType.java b/src/main/java/dev/medzik/otp/OTPType.java
@@ -2,6 +2,7 @@
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;
+import lombok.experimental.PackagePrivate;
 
 @AllArgsConstructor
 @Getter
@@ -11,7 +12,8 @@ public enum OTPType {
 
     private final String value;
 
-    public static OTPType get(String value) throws IllegalArgumentException {
+    @PackagePrivate
+    static OTPType get(String value) throws IllegalArgumentException {
         switch (value.toLowerCase()) {
             case "totp":
                 return TOTP;