snippet

ffizz_header

Macro snippet 

Source 
snippet!() { /* proc-macro */ }
Expand description

Generate C header content from the included docstring.

This macro operates much like #[ffizz_header::item], but can be applied when there is no Rust item to document. The #[ffizz(name="..")] attribute must always be supplied, and order is usually supplied as well.

ยงExample

# ignored because ffizz_header isn't available in doctests
ffizz_header::snippet! {
    #[ffizz(name="invariants", order=10)]
    /// LIBRARY INVARIANTS
    ///
    /// This library maintains the following invariants:
    ///  * what goes up, must come down
}

produces

// LIBRARY INVARIANTS
//
// This library maintains the following invariants:
//  * what goes up, must come down