status-im
/
QR-Code-generator
mirror of https://github.com/status-im/QR-Code-generator.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Tweaked comments about inclusive ranges so that the word is consistently parenthesized.

This commit is contained in:
Project Nayuki 2018-08-26 02:33:20 +00:00
parent ccd571624e
commit c8f05d24d1
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
c/qrcodegen.h
View File

@ -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, // 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)];' // 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. // Requires qrcodegen_VERSION_MIN <= n <= qrcodegen_VERSION_MAX.
#define qrcodegen_BUFFER_LEN_FOR_VERSION(n) ((((n) * 4 + 17) * ((n) * 4 + 17) + 7) / 8 + 1) #define qrcodegen_BUFFER_LEN_FOR_VERSION(n) ((((n) * 4 + 17) * ((n) * 4 + 17) + 7) / 8 + 1)

6
java/io/nayuki/qrcodegen/QrCode.java
View File

@ -180,7 +180,7 @@ public final class QrCode {
public final int version; public final int version;
/** The width and height of this QR Code symbol, measured in modules. /** The width and height of this QR Code symbol, measured in modules.
* Always equal to version &times; 4 + 17, in the range 21 to 177. */ * Always equal to version &times; 4 + 17, in the range 21 to 177 (inclusive). */
public final int size; public final int size;
/** The error correction level used in this QR Code symbol. Never {@code null}. */ /** 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. * 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. * <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> * 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 ecl the error correction level to use
* @param dataCodewords the bytes representing segments to encode (without ECC) * @param dataCodewords the bytes representing segments to encode (without ECC)
* @param mask the mask pattern to use, which is either &minus;1 for automatic choice or from 0 to 7 for fixed choice * @param mask the mask pattern to use, which is either &minus;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 * 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. * 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 &lt; 1 or degree > 255 * @throws IllegalArgumentException if degree &lt; 1 or degree > 255
*/ */
public ReedSolomonGenerator(int degree) { public ReedSolomonGenerator(int degree) {

4
java/io/nayuki/qrcodegen/QrSegment.java
View File

@ -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. * 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 * @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 * @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 * @throws IllegalArgumentException if the version number is out of range
*/ */
int numCharCountBits(int ver) { int numCharCountBits(int ver) {