More javadoc

[zxing.git] / core / src / com / google / zxing / qrcode / decoder / DataMask.java

diff --git a/core/src/com/google/zxing/qrcode/decoder/DataMask.java b/core/src/com/google/zxing/qrcode/decoder/DataMask.java
index 68f1b67..225d463 100755 (executable)
--- a/core/src/com/google/zxing/qrcode/decoder/DataMask.java
+++ b/core/src/com/google/zxing/qrcode/decoder/DataMask.java
@@ -17,13 +17,13 @@
 package com.google.zxing.qrcode.decoder;\r
 \r
 /**\r
- * Encapsulates data masks for the data bits in a QR code, per ISO 18004:2006 6.8. Implementations\r
+ * <p>Encapsulates data masks for the data bits in a QR code, per ISO 18004:2006 6.8. Implementations\r
  * of this class can un-mask a raw BitMatrix. For simplicity, they will unmask the entire BitMatrix,\r
  * including areas used for finder patterns, timing patterns, etc. These areas should be unused\r
- * after the point they are unmasked anyway.\r
+ * after the point they are unmasked anyway.</p>\r
  *\r
- * Note that the diagram in section 6.8.1 is misleading since it indicates that i is column position\r
- * and j is row position. In fact, as the text says, i is row position and j is column position.\r
+ * <p>Note that the diagram in section 6.8.1 is misleading since it indicates that i is column position\r
+ * and j is row position. In fact, as the text says, i is row position and j is column position.</p>\r
  *\r
  * @author srowen@google.com (Sean Owen)\r
  */\r
@@ -46,8 +46,20 @@ abstract class DataMask {
   private DataMask() {\r
   }\r
 \r
+  /**\r
+   * <p>Implementations of this method reverse the data masking process applied to a QR Code and\r
+   * make its bits ready to read.</p>\r
+   *\r
+   * @param bits representation of QR Code bits from {@link com.google.zxing.common.BitMatrix#getBits()}\r
+   * @param dimension dimension of QR Code, represented by bits, being unmasked\r
+   */\r
   abstract void unmaskBitMatrix(int[] bits, int dimension);\r
 \r
+  /**\r
+   * @param reference a value between 0 and 7 indicating one of the eight possible\r
+   *  data mask patterns a QR Code may use\r
+   * @return {@link DataMask} encapsulating the data mask pattern\r
+   */\r
   static DataMask forReference(int reference) {\r
     if (reference < 0 || reference > 7) {\r
       throw new IllegalArgumentException();\r