Squash sketch

Author: Jin Kwon

src/main/java/com/github/jinahya/bit/io/BitIoConstants.java

@@ -1,7 +1,15 @@
 package com.github.jinahya.bit.io;
 
+/**
+ * Defines constants for bit-io.
+ *
+ * @author Jin Kwon <onacit_at_gmail.com>\
+ */
 final class BitIoConstants {
 
+    /**
+     * An array of pre-initialized bit masks.
+     */
     private static final int[] MASKS = new int[8];
 
     static {
@@ -12,10 +20,19 @@ final class BitIoConstants {
         }
     }
 
+    /**
+     * Returns a bit mask for specified bit size.
+     *
+     * @param size the number of bits to mask.
+     * @return a bit mask.
+     */
     static int mask(final int size) {
         return MASKS[size - 1];
     }
 
+    /**
+     * Creates a new instance.
+     */
     private BitIoConstants() {
         throw new AssertionError("initialization is not allowed");
     }