How to document Rust function arguments?

by

I’ve seen the following style used in some of the examples:

/// Brief.
///
/// Description.
/// 
/// * `foo` - Text about foo.
/// * `bar` - Text about bar.
fn function (foo: i32, bar: &str) {}

So far it’s working fine for me too.

P.S. There’s also an issue on this.
P.S. Check also the improved rustdoc linking and the search aliases in 1.48.
P.S. There’s now a docu at https://doc.rust-lang.org/beta/rust-by-example/meta/doc.html

Leave a Comment