From 8551314425dac9130a99c016d91360c72de63d7b Mon Sep 17 00:00:00 2001 From: Project Nayuki Date: Mon, 5 Nov 2018 04:38:11 +0000 Subject: [PATCH] Added/updated/deleted some comments. --- src/io/nayuki/fastqrcodegen/QrCode.java | 4 ++++ src/io/nayuki/fastqrcodegen/QrSegment.java | 6 +++--- src/io/nayuki/fastqrcodegen/QrTemplate.java | 5 ++--- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/src/io/nayuki/fastqrcodegen/QrCode.java b/src/io/nayuki/fastqrcodegen/QrCode.java index c24aae4..32b2acf 100644 --- a/src/io/nayuki/fastqrcodegen/QrCode.java +++ b/src/io/nayuki/fastqrcodegen/QrCode.java @@ -197,6 +197,8 @@ public final class QrCode { /*---- Instance fields ----*/ + // Public immutable scalar parameters: + /** The version number of this QR Code, which is between 1 and 40 (inclusive). * This determines the size of this barcode. */ public final int version; @@ -213,6 +215,8 @@ public final class QrCode { * −1), the resulting object still has a mask value between 0 and 7. */ public final int mask; + // Private grid of modules/pixels: + // The modules of this QR Code. Immutable after constructor finishes. Accessed through getModule(). private final int[] modules; diff --git a/src/io/nayuki/fastqrcodegen/QrSegment.java b/src/io/nayuki/fastqrcodegen/QrSegment.java index 86cce95..7ac0234 100644 --- a/src/io/nayuki/fastqrcodegen/QrSegment.java +++ b/src/io/nayuki/fastqrcodegen/QrSegment.java @@ -40,7 +40,8 @@ import java.util.Objects; *

This segment class imposes no length restrictions, but QR Codes have restrictions. * Even in the most favorable conditions, a QR Code can only hold 7089 characters of data. * Any segment longer than this is meaningless for the purpose of generating QR Codes. - * This class can represent kanji mode segments, but provides no help in encoding them.

+ * This class can represent kanji mode segments, but provides no help in encoding them + * - see {@link QrSegmentAdvanced} for full kanji support.

*/ public final class QrSegment { @@ -224,7 +225,7 @@ public final class QrSegment { * Always zero or positive. Not the same as the data's bit length. */ public final int numChars; - // The data bits of this segment. Not null. Accessed through getData(). + // The data bits of this segment. Not null. final int[] data; // Requires 0 <= bitLength <= data.length * 32. @@ -273,7 +274,6 @@ public final class QrSegment { } - /*---- Constants ----*/ static final int[] ALPHANUMERIC_MAP; diff --git a/src/io/nayuki/fastqrcodegen/QrTemplate.java b/src/io/nayuki/fastqrcodegen/QrTemplate.java index 3ccfb40..f933bd7 100644 --- a/src/io/nayuki/fastqrcodegen/QrTemplate.java +++ b/src/io/nayuki/fastqrcodegen/QrTemplate.java @@ -90,7 +90,8 @@ final class QrTemplate { final int[][] masks; final int[] dataOutputBitIndexes; - private int[] isFunction; // Discarded when constructor finishes + // Indicates function modules that are not subjected to masking. Discarded when constructor finishes. + private int[] isFunction; private QrTemplate(int ver) { @@ -275,8 +276,6 @@ final class QrTemplate { } - /*---- Private static helper functions ----*/ - // Returns an ascending list of positions of alignment patterns for this version number. // Each position is in the range [0,177), and are used on both the x and y axes. // This could be implemented as lookup table of 40 variable-length lists of unsigned bytes.