From f4b16f25b01a1ae534ba2c9b27afc1f875ef84da Mon Sep 17 00:00:00 2001 From: Project Nayuki Date: Sat, 6 Oct 2018 03:40:31 +0000 Subject: [PATCH] Updated documentation comment for field QrCode.modules, in most languages. --- cpp/QrCode.hpp | 3 ++- java/io/nayuki/qrcodegen/QrCode.java | 3 ++- python/qrcodegen.py | 3 ++- rust/src/lib.rs | 3 ++- typescript/qrcodegen.ts | 3 ++- 5 files changed, 10 insertions(+), 5 deletions(-) diff --git a/cpp/QrCode.hpp b/cpp/QrCode.hpp index 4d33300..9bcb2a6 100644 --- a/cpp/QrCode.hpp +++ b/cpp/QrCode.hpp @@ -128,7 +128,8 @@ class QrCode final { // Private grids of modules/pixels, with dimensions of size*size: - // The modules of this QR Code (false = white, true = black). Immutable after constructor finishes. + // The modules of this QR Code (false = white, true = black). + // Immutable after constructor finishes. Accessed through getModule(). private: std::vector > modules; // Indicates function modules that are not subjected to masking. Discarded when constructor finishes. diff --git a/java/io/nayuki/qrcodegen/QrCode.java b/java/io/nayuki/qrcodegen/QrCode.java index faafc4a..a63b721 100644 --- a/java/io/nayuki/qrcodegen/QrCode.java +++ b/java/io/nayuki/qrcodegen/QrCode.java @@ -212,7 +212,8 @@ public final class QrCode { // Private grids of modules/pixels, with dimensions of size*size: - // The modules of this QR Code (false = white, true = black). Immutable after constructor finishes. + // The modules of this QR Code (false = white, true = black). + // Immutable after constructor finishes. Accessed through getModule(). private boolean[][] modules; // Indicates function modules that are not subjected to masking. Discarded when constructor finishes. diff --git a/python/qrcodegen.py b/python/qrcodegen.py index 9c75982..e202fcb 100644 --- a/python/qrcodegen.py +++ b/python/qrcodegen.py @@ -186,7 +186,8 @@ class QrCode(object): self._errcorlvl = errcorlvl # Initialize both grids to be size*size arrays of Boolean false - # The modules of this QR Code (False = white, True = black). Immutable after constructor finishes + # The modules of this QR Code (False = white, True = black). + # Immutable after constructor finishes. Accessed through get_module(). self._modules = [[False] * self._size for _ in range(self._size)] # Initially all white # Indicates function modules that are not subjected to masking. Discarded when constructor finishes self._isfunction = [[False] * self._size for _ in range(self._size)] diff --git a/rust/src/lib.rs b/rust/src/lib.rs index 4c08978..8cd84c6 100644 --- a/rust/src/lib.rs +++ b/rust/src/lib.rs @@ -64,7 +64,8 @@ pub struct QrCode { // Grids of modules/pixels, with dimensions of size*size: - // The modules of this QR Code (false = white, true = black). Immutable after constructor finishes. + // The modules of this QR Code (false = white, true = black). + // Immutable after constructor finishes. Accessed through get_module(). modules: Vec, // Indicates function modules that are not subjected to masking. Discarded when constructor finishes. diff --git a/typescript/qrcodegen.ts b/typescript/qrcodegen.ts index 2aca061..9b59dbf 100644 --- a/typescript/qrcodegen.ts +++ b/typescript/qrcodegen.ts @@ -148,7 +148,8 @@ namespace qrcodegen { // 21 and 177 (inclusive). This is equal to version * 4 + 17. public readonly size: int; - // The modules of this QR Code (false = white, true = black). Immutable after constructor finishes. + // The modules of this QR Code (false = white, true = black). + // Immutable after constructor finishes. Accessed through getModule(). private readonly modules : Array> = []; // Indicates function modules that are not subjected to masking. Discarded when constructor finishes.