openharmony/third_party_qrcodegen
1
0
Fork 0
mirror of https://gitee.com/openharmony/third_party_qrcodegen synced 2024-11-23 07:10:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Copied paragraphs in Rust comments for top-level QR-encoding functions for consistency.

Browse Source
This commit is contained in:
Project Nayuki 2022-01-08 04:28:10 +00:00
parent f3705873ab
commit 4e41cb2c72
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
rust-no-heap/src/lib.rs
View File

@ -193,6 +193,12 @@ impl<'a> QrCode<'a> {
/// If the data is too long to fit in any version in the given range /// If the data is too long to fit in any version in the given range
/// at the given ECC level, then `Err` is returned. /// at the given ECC level, then `Err` is returned.
/// ///
/// The smallest possible QR Code version within the given range is automatically
/// 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 `None` to automatically choose an appropriate mask (which may be slow).
///
/// About the slices, letting len = maxversion.buffer_len(): /// About the slices, letting len = maxversion.buffer_len():
/// - Before calling the function: /// - Before calling the function:
/// - The slices dataandtempbuffer and outbuffer each must have a length of at least len. /// - The slices dataandtempbuffer and outbuffer each must have a length of at least len.
@ -232,6 +238,12 @@ impl<'a> QrCode<'a> {
/// Returns an intermediate state representing the given segments /// Returns an intermediate state representing the given segments
/// with the given encoding parameters being encoded into codewords. /// with the given encoding parameters being encoded into codewords.
/// ///
/// The smallest possible QR Code version within the given range is automatically
/// 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 `None` to automatically choose an appropriate mask (which may be slow).
///
/// This function exists to allow segments to use parts of a temporary buffer, /// This function exists to allow segments to use parts of a temporary buffer,
/// then have the segments be encoded to an output buffer, then invalidate all the segments, /// then have the segments be encoded to an output buffer, then invalidate all the segments,
/// and finally have the output buffer and temporary buffer be encoded to a QR Code. /// and finally have the output buffer and temporary buffer be encoded to a QR Code.