Skip to content

docs: Add missing documentation #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kennytm merged 3 commits into from
Aug 25, 2025
Merged

docs: Add missing documentation #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a281f5
docs: Add missing documentation
sorairolake Aug 19, 2025
d59cd2a
Update `src/optimize.rs`
sorairolake Aug 24, 2025
81cc58a
Update `src/render/unicode.rs`
sorairolake Aug 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(feature = "bench", feature(test))] // Unstable libraries
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![warn(missing_docs)]
#![warn(clippy::pedantic)]
#![allow(
clippy::must_use_candidate, // This is just annoying.
Expand Down
2 changes: 2 additions & 0 deletions src/optimize.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ mod parse_tests {
//------------------------------------------------------------------------------
//{{{ Optimizer

/// QR code data optimizer.
pub struct Optimizer<I> {
parser: I,
last_segment: Segment,
Expand Down Expand Up @@ -287,6 +288,7 @@ impl<I: Iterator<Item = Segment>> Optimizer<I> {
}

impl Parser<'_> {
/// Creates a new `Optimizer` based on this parser.
pub fn optimize(self, version: Version) -> Optimizer<Self> {
Optimizer::new(self, version)
}
Expand Down
2 changes: 2 additions & 0 deletions src/render/image.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! Raster image rendering support powered by the [`image`] crate.

#![cfg(feature = "image")]

use crate::render::{Canvas, Pixel};
Expand Down
13 changes: 13 additions & 0 deletions src/render/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@ pub trait Pixel: Copy + Sized {

/// Rendering canvas of a QR code image.
pub trait Canvas: Sized {
/// Type of an image pixel.
type Pixel: Sized;

/// Type of the finalized image.
type Image: Sized;

/// Constructs a new canvas of the given dimensions.
Expand All @@ -43,6 +46,8 @@ pub trait Canvas: Sized {
/// Draws a single dark pixel at the (x, y) coordinate.
fn draw_dark_pixel(&mut self, x: u32, y: u32);

/// Draws a dark rectangle with dimensions `width`×`height` at the (`left`,
/// `top`) coordinate.
fn draw_dark_rect(&mut self, left: u32, top: u32, width: u32, height: u32) {
for y in top..(top + height) {
for x in left..(left + width) {
Expand Down Expand Up @@ -121,6 +126,14 @@ impl<'a, P: Pixel> Renderer<'a, P> {
self
}

/// Sets the minimum total image width (and thus height) in pixels,
/// including the quiet zone if applicable. The renderer will try to find
/// the dimension as small as possible, such that each module in the QR code
/// has uniform size (no distortion).
///
/// For instance, a version 1 QR code has 19 modules across including the
/// quiet zone. If we request an image of width ≥200px, we get that each
/// module's size should be 11px, so the actual image size will be 209px.
#[deprecated(since = "0.4.0", note = "use `.min_dimensions(width, width)` instead")]
pub fn min_width(&mut self, width: u32) -> &mut Self {
self.min_dimensions(width, width)
Expand Down
6 changes: 6 additions & 0 deletions src/render/string.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,15 @@ use alloc::string::String;
use alloc::vec;
use alloc::vec::Vec;

/// Abstraction of an image element.
pub trait Element: Copy {
/// Obtains the default element color when a module is dark or light.
fn default_color(color: Color) -> Self;

/// Returns the number of bytes in `self`.
fn strlen(self) -> usize;

/// Appends `self` to the end of the given `string`.
fn append_to_string(self, string: &mut String);
}

Expand Down
4 changes: 4 additions & 0 deletions src/render/unicode.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ use alloc::vec::Vec;

const CODEPAGE: [&str; 4] = [" ", "\u{2584}", "\u{2580}", "\u{2588}"];

/// An image pixel for UTF-8 rendering.
#[derive(Copy, Clone, PartialEq, Eq)]
pub enum Dense1x2 {
/// The pixel is dark colored.
Dark,
/// The pixel is light colored.
Light,
}

Expand All @@ -37,6 +40,7 @@ impl Dense1x2 {
}
}

/// A canvas for UTF-8 rendering with a resolution of 1×2 modules per character.
pub struct Canvas1x2 {
canvas: Vec<u8>,
width: u32,
Expand Down
3 changes: 3 additions & 0 deletions src/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
//! The `types` module contains types associated with the functional elements of
//! a QR code.

use crate::cast::As;
use core::cmp::{Ordering, PartialOrd};
use core::default::Default;
Expand Down
Loading