add missing docs

softprops · Apr 12, 2024 · 6e7d008 · 6e7d008
1 parent 3be89c0
commit 6e7d008
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/main/java/typeid/internal/Base32.java b/src/main/java/typeid/internal/Base32.java
@@ -34,6 +34,10 @@ public class Base32 {
     0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
   };
 
+  /**
+   * @param src encoded bytes
+   * @return decoded bytes if valid
+   */
   public static Optional<byte[]> decode(byte[] src) {
     if (src.length != 26) {
       return Optional.empty();
@@ -91,6 +95,10 @@ public static Optional<byte[]> decode(byte[] src) {
         });
   }
 
+  /**
+   * @param src raw bytes
+   * @return string is valid
+   */
   public static Optional<String> encode(byte[] src) {
     if (src.length != 16) {
       return Optional.empty();