traits icon indicating copy to clipboard operation
traits copied to clipboard

[WIP] aead: add `doc_usage!` macro

Open tarcieri opened this issue 6 months ago • 0 comments

Adds a macro which generates the crate usage boilerplate, customized to a specific crate and example AEAD cipher.

Downstream crates can use it like:

#![doc = include_str!("../README.md")]
#![doc = aead::doc_usage!(Aes256Gcm)]

Rendering of the generated rustdoc showing the macro output on top and the original boilerplate text below:

Screenshot 2025-08-02 at 6 28 30 PM

tarcieri avatar Aug 03 '25 00:08 tarcieri