Added more javadoc

[zxing.git] / core / src / com / google / zxing / common / BitArray.java

diff --git a/core/src/com/google/zxing/common/BitArray.java b/core/src/com/google/zxing/common/BitArray.java
index 398be9e..d4e2f19 100644 (file)
--- a/core/src/com/google/zxing/common/BitArray.java
+++ b/core/src/com/google/zxing/common/BitArray.java
@@ -34,6 +34,7 @@ public final class BitArray {
   }\r
 \r
   /**\r
+   * @param i bit to get\r
    * @return true iff bit i is set\r
    */\r
   public boolean get(int i) {\r
@@ -42,17 +43,26 @@ public final class BitArray {
 \r
   /**\r
    * Sets bit i.\r
+   *\r
+   * @param i bit to set\r
    */\r
   public void set(int i) {\r
     bits[i >> 5] |= 1 << (i & 0x1F);\r
   }\r
 \r
+  /**\r
+   * Sets a block of 32 bits, starting at bit i.\r
+   *\r
+   * @param i first bit to set\r
+   * @param newBits the new value of the next 32 bits. Note again that the least-significant bit\r
+   *  correponds to bit i, the next-least-significant to i+1, and so on.\r
+   */\r
   public void setBulk(int i, int newBits) {\r
     bits[i >> 5] = newBits;\r
   }\r
 \r
   /**\r
-   * Clears all bits.\r
+   * Clears all bits (sets to false).\r
    */\r
   public void clear() {\r
     int max = bits.length;\r