From c8f05d24d1b23ca2a421d46e64cf32bfd29c0d4c Mon Sep 17 00:00:00 2001
From: Project Nayuki <me@nayuki.io>
Date: Sun, 26 Aug 2018 02:33:20 +0000
Subject: [PATCH] Tweaked comments about inclusive ranges so that the word is
consistently parenthesized.
---
c/qrcodegen.h | 2 +-
java/io/nayuki/qrcodegen/QrCode.java | 6 +++---
java/io/nayuki/qrcodegen/QrSegment.java | 4 ++--
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/c/qrcodegen.h b/c/qrcodegen.h
index 899feae..a08fe0f 100644
--- a/c/qrcodegen.h
+++ b/c/qrcodegen.h
@@ -107,7 +107,7 @@ struct qrcodegen_Segment {
// Calculates the number of bytes needed to store any QR Code up to and including the given version number,
// as a compile-time constant. For example, 'uint8_t buffer[qrcodegen_BUFFER_LEN_FOR_VERSION(25)];'
-// can store any single QR Code from version 1 to 25, inclusive.
+// can store any single QR Code from version 1 to 25 (inclusive).
// Requires qrcodegen_VERSION_MIN <= n <= qrcodegen_VERSION_MAX.
#define qrcodegen_BUFFER_LEN_FOR_VERSION(n) ((((n) * 4 + 17) * ((n) * 4 + 17) + 7) / 8 + 1)
diff --git a/java/io/nayuki/qrcodegen/QrCode.java b/java/io/nayuki/qrcodegen/QrCode.java
index 7cf0900..d463f32 100644
--- a/java/io/nayuki/qrcodegen/QrCode.java
+++ b/java/io/nayuki/qrcodegen/QrCode.java
@@ -180,7 +180,7 @@ public final class QrCode {
public final int version;
/** The width and height of this QR Code symbol, measured in modules.
- * Always equal to version × 4 + 17, in the range 21 to 177. */
+ * Always equal to version × 4 + 17, in the range 21 to 177 (inclusive). */
public final int size;
/** The error correction level used in this QR Code symbol. Never {@code null}. */
@@ -203,7 +203,7 @@ public final class QrCode {
* Constructs a QR Code symbol with the specified version number, error correction level, binary data array, and mask number.
* <p>This is a cumbersome low-level constructor that should not be invoked directly by the user.
* To go one level up, see the {@link #encodeSegments(List,Ecc,int,int,int,boolean)} function.</p>
- * @param ver the version number to use, which must be in the range 1 to 40, inclusive
+ * @param ver the version number to use, which must be in the range 1 to 40 (inclusive)
* @param ecl the error correction level to use
* @param dataCodewords the bytes representing segments to encode (without ECC)
* @param mask the mask pattern to use, which is either −1 for automatic choice or from 0 to 7 for fixed choice
@@ -782,7 +782,7 @@ public final class QrCode {
/**
* Constructs a Reed-Solomon ECC generator for the specified degree. This could be implemented
* as a lookup table over all possible parameter values, instead of as an algorithm.
- * @param degree the divisor polynomial degree, which must be between 1 and 255
+ * @param degree the divisor polynomial degree, which must be between 1 and 255 (inclusive)
* @throws IllegalArgumentException if degree < 1 or degree > 255
*/
public ReedSolomonGenerator(int degree) {
diff --git a/java/io/nayuki/qrcodegen/QrSegment.java b/java/io/nayuki/qrcodegen/QrSegment.java
index a9a464f..1d29474 100644
--- a/java/io/nayuki/qrcodegen/QrSegment.java
+++ b/java/io/nayuki/qrcodegen/QrSegment.java
@@ -268,8 +268,8 @@ public final class QrSegment {
/**
* Returns the bit width of the segment character count field for this mode object at the specified version number.
- * @param ver the version number, which is between 1 to 40, inclusive
- * @return the number of bits for the character count, which is between 8 to 16, inclusive
+ * @param ver the version number, which is between 1 to 40 (inclusive)
+ * @return the number of bits for the character count, which is between 8 to 16 (inclusive)
* @throws IllegalArgumentException if the version number is out of range
*/
int numCharCountBits(int ver) {