bon_sandbox/docs_comparison/mod.rs
1//! This module contains examples of `rustdoc` output for builder macros from different
2//! crates applied to different kinds of syntax.
3//!
4//! The module hierarchy here is `syntax` -> `builder_crate`.
5//!
6//! All builders were configured to produce roughly similar builder API.
7//!
8//! The notable exceptions are:
9//!
10//! - `buildstructor` doesn't support `#[builder(default)]` and `#[builder(into)]`-like annotations;
11//! - `buildstructor` doesn't support doc comments on function arguments;
12//! - `derive_builder` doesn't support typestate-based builders;
13#![expect(
14 dead_code,
15 unused_variables,
16 clippy::needless_pass_by_value,
17 clippy::unused_self
18)]
19
20/// Examples docs generated with builder macros applied to functions
21pub mod functions;
22
23/// Examples docs generated with builder macros applied to structs
24pub mod structs;
25
26/// Examples docs generated with builder macros applied to methods
27pub mod methods;