Updated and synchronized the QrCode class top-level documentation comment, in all languages except C.

pull/39/merge
Project Nayuki 6 years ago
parent c8c29cc116
commit 667c744d8b

@ -34,8 +34,8 @@ namespace qrcodegen {
/* /*
* Represents an immutable square grid of black and white cells for a QR Code symbol, and * 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. * 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) * 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. * from 1 to 40, all 4 error correction levels, and 4 character encoding modes.
*/ */
class QrCode final { class QrCode final {

@ -32,8 +32,8 @@ import java.util.Objects;
/** /**
* Represents an immutable square grid of black and white cells for a QR Code symbol, and * 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. * provides static functions to create a QR Code from user-supplied textual or binary data.
* <p>This class covers the QR Code model 2 specification, supporting all versions (sizes) * <p>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.</p> * from 1 to 40, all 4 error correction levels, and 4 character encoding modes.</p>
*/ */
public final class QrCode { public final class QrCode {

@ -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, * 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. * 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) * This class covers the QR Code Model 2 specification, supporting all versions (sizes)
* from 1 to 40, all 4 error correction levels. * 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, * 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 * 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. * that should not be invoked directly by the user. To go one level up, see the QrCode.encodeSegments() function.

@ -61,8 +61,10 @@ This module "qrcodegen", public members:
# ---- QR Code symbol class ---- # ---- QR Code symbol class ----
class QrCode(object): class QrCode(object):
"""Represents an immutable square grid of black or white cells for a QR Code symbol. This class covers the """Represents an immutable square grid of black and white cells for a QR Code symbol, and
QR Code model 2 specification, supporting all versions (sizes) from 1 to 40, all 4 error correction levels.""" 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 ---- # ---- Public static factory functions ----

@ -26,8 +26,8 @@
// Represents an immutable square grid of black and white cells for a QR Code symbol, and // 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. // 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) // This struct and impl cover the QR Code Model 2 specification, supporting all versions
// from 1 to 40, all 4 error correction levels, and only 3 character encoding modes. // (sizes) from 1 to 40, all 4 error correction levels, and 4 character encoding modes.
#[derive(Clone)] #[derive(Clone)]
pub struct QrCode { pub struct QrCode {

@ -34,10 +34,10 @@ namespace qrcodegen {
/*---- QR Code symbol class ----*/ /*---- QR Code symbol class ----*/
/* /*
* A class that represents an immutable square grid of black and white cells for a QR Code symbol, * Represents an immutable square grid of black and white cells for a QR Code symbol, and
* with associated static functions to create a QR Code from user-supplied textual or binary data. * 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) * This class covers the QR Code Model 2 specification, supporting all versions (sizes)
* from 1 to 40, all 4 error correction levels. * 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, * 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 * 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. * that should not be invoked directly by the user. To go one level up, see the QrCode.encodeSegments() function.

Loading…
Cancel
Save