From 667c744d8b444646a6a79eaad33d863f7f293971 Mon Sep 17 00:00:00 2001 From: Project Nayuki Date: Thu, 4 Oct 2018 18:48:29 +0000 Subject: [PATCH] Updated and synchronized the QrCode class top-level documentation comment, in all languages except C. --- cpp/QrCode.hpp | 4 ++-- java/io/nayuki/qrcodegen/QrCode.java | 4 ++-- javascript/qrcodegen.js | 6 +++--- python/qrcodegen.py | 6 ++++-- rust/src/lib.rs | 4 ++-- typescript/qrcodegen.ts | 8 ++++---- 6 files changed, 17 insertions(+), 15 deletions(-) diff --git a/cpp/QrCode.hpp b/cpp/QrCode.hpp index 0c71131..4639a22 100644 --- a/cpp/QrCode.hpp +++ b/cpp/QrCode.hpp @@ -34,8 +34,8 @@ namespace qrcodegen { /* * Represents an immutable square grid of black and white cells for a QR Code symbol, and * provides static functions to create a QR Code from user-supplied textual or binary data. - * This class covers the QR Code model 2 specification, supporting all versions (sizes) - * from 1 to 40, all 4 error correction levels, and only 3 character encoding modes. + * This class covers the QR Code Model 2 specification, supporting all versions (sizes) + * from 1 to 40, all 4 error correction levels, and 4 character encoding modes. */ class QrCode final { diff --git a/java/io/nayuki/qrcodegen/QrCode.java b/java/io/nayuki/qrcodegen/QrCode.java index 6e0669c..7279f04 100644 --- a/java/io/nayuki/qrcodegen/QrCode.java +++ b/java/io/nayuki/qrcodegen/QrCode.java @@ -32,8 +32,8 @@ import java.util.Objects; /** * Represents an immutable square grid of black and white cells for a QR Code symbol, and * provides static functions to create a QR Code from user-supplied textual or binary data. - *

This class covers the QR Code model 2 specification, supporting all versions (sizes) - * from 1 to 40, all 4 error correction levels, and only 3 character encoding modes.

+ *

This class covers the QR Code Model 2 specification, supporting all versions (sizes) + * from 1 to 40, all 4 error correction levels, and 4 character encoding modes.

*/ public final class QrCode { diff --git a/javascript/qrcodegen.js b/javascript/qrcodegen.js index 8f1170c..9c9e507 100644 --- a/javascript/qrcodegen.js +++ b/javascript/qrcodegen.js @@ -61,9 +61,9 @@ var qrcodegen = new function() { /* * A class that represents an immutable square grid of black and white cells for a QR Code symbol, - * with associated static functions to create a QR Code from user-supplied textual or binary data. - * This class covers the QR Code model 2 specification, supporting all versions (sizes) - * from 1 to 40, all 4 error correction levels. + * and provides static functions to create a QR Code from user-supplied textual or binary data. + * This class covers the QR Code Model 2 specification, supporting all versions (sizes) + * from 1 to 40, all 4 error correction levels, and 4 character encoding modes. * This constructor creates a new QR Code symbol with the given version number, error correction level, binary data array, * and mask number. mask = -1 is for automatic choice, or 0 to 7 for fixed choice. This is a cumbersome low-level constructor * that should not be invoked directly by the user. To go one level up, see the QrCode.encodeSegments() function. diff --git a/python/qrcodegen.py b/python/qrcodegen.py index 23482e2..a971d7a 100644 --- a/python/qrcodegen.py +++ b/python/qrcodegen.py @@ -61,8 +61,10 @@ This module "qrcodegen", public members: # ---- QR Code symbol class ---- class QrCode(object): - """Represents an immutable square grid of black or white cells for a QR Code symbol. This class covers the - QR Code model 2 specification, supporting all versions (sizes) from 1 to 40, all 4 error correction levels.""" + """Represents an immutable square grid of black and white cells for a QR Code symbol, and + provides static functions to create a QR Code from user-supplied textual or binary data. + This class covers the QR Code Model 2 specification, supporting all versions (sizes) + from 1 to 40, all 4 error correction levels, and 4 character encoding modes.""" # ---- Public static factory functions ---- diff --git a/rust/src/lib.rs b/rust/src/lib.rs index 8653a90..069b50d 100644 --- a/rust/src/lib.rs +++ b/rust/src/lib.rs @@ -26,8 +26,8 @@ // Represents an immutable square grid of black and white cells for a QR Code symbol, and // provides static functions to create a QR Code from user-supplied textual or binary data. -// This struct covers the QR Code model 2 specification, supporting all versions (sizes) -// from 1 to 40, all 4 error correction levels, and only 3 character encoding modes. +// This struct and impl cover the QR Code Model 2 specification, supporting all versions +// (sizes) from 1 to 40, all 4 error correction levels, and 4 character encoding modes. #[derive(Clone)] pub struct QrCode { diff --git a/typescript/qrcodegen.ts b/typescript/qrcodegen.ts index c346dea..58bd14b 100644 --- a/typescript/qrcodegen.ts +++ b/typescript/qrcodegen.ts @@ -34,10 +34,10 @@ namespace qrcodegen { /*---- QR Code symbol class ----*/ /* - * A class that represents an immutable square grid of black and white cells for a QR Code symbol, - * with associated static functions to create a QR Code from user-supplied textual or binary data. - * This class covers the QR Code model 2 specification, supporting all versions (sizes) - * from 1 to 40, all 4 error correction levels. + * Represents an immutable square grid of black and white cells for a QR Code symbol, and + * provides static functions to create a QR Code from user-supplied textual or binary data. + * This class covers the QR Code Model 2 specification, supporting all versions (sizes) + * from 1 to 40, all 4 error correction levels, and 4 character encoding modes. * This constructor creates a new QR Code symbol with the given version number, error correction level, binary data array, * and mask number. mask = -1 is for automatic choice, or 0 to 7 for fixed choice. This is a cumbersome low-level constructor * that should not be invoked directly by the user. To go one level up, see the QrCode.encodeSegments() function.