status-im/QR-Code-generator
2
0
Fork 0
mirror of https://github.com/status-im/QR-Code-generator.git synced 2025-02-24 02:18:22 +00:00
Code Issues Projects Releases Wiki Activity

Tweaked comments in Rust code to fix Rust-specific facts.

Browse Source
This commit is contained in:
Project Nayuki 2018-10-13 01:27:50 +00:00
parent 0810860b57
commit 7d84b8b128
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
rust/src/lib.rs
View File

@ -37,7 +37,7 @@
///
/// - High level: Take the payload data and call `QrCode::encode_text()` or `QrCode::encode_binary()`.
/// - Mid level: Custom-make the list of segments and call
/// `QrCode.encode_segments()` or `QrCode.encode_segments_advanced()`.
/// `QrCode::encode_segments()` or `QrCode::encode_segments_advanced()`.
/// - Low level: Custom-make the array of data codeword bytes (including segment
/// headers and final padding, excluding error correction codewords), supply the
/// appropriate version number, and call the `QrCode::encode_codewords()` constructor.
@ -132,11 +132,11 @@ impl QrCode {
/// chosen for the output. Iff boostecl is `true`, then the ECC level of the result
/// may be higher than the ecl argument if it can be done without increasing the
/// version. The mask number is either between 0 to 7 (inclusive) to force that
/// mask, or -1 to automatically choose an appropriate mask (which may be slow).
/// mask, or `None` to automatically choose an appropriate mask (which may be slow).
///
/// This function allows the user to create a custom sequence of segments that switches
/// between modes (such as alphanumeric and byte) to encode text in less space.
/// This is a mid-level API; the high-level API is `encodeText()` and `encodeBinary()`.
/// This is a mid-level API; the high-level API is `encode_text()` and `encode_binary()`.
///
/// Returns a wrapped `QrCode` if successful, or `None` if the data is too long to fit
/// in any version in the given range at the given ECC level.