mirror of
https://github.com/status-im/QR-Code-generator.git
synced 2025-02-24 02:18:22 +00:00
Updated and synchronized the QrCode class top-level documentation comment, in all languages except C.
This commit is contained in:
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
|
||||
* 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 {
|
||||
|
||||
|
@ -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.
|
||||
* <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>
|
||||
* <p>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.</p>
|
||||
*/
|
||||
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,
|
||||
* 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.
|
||||
|
@ -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 ----
|
||||
|
||||
|
@ -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 {
|
||||
|
||||
|
@ -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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user