How do I prevent `rust doc` from adding dependencies to documentation?
I found the answer: cargo doc –no-deps.
rustdoc
How to document Rust function arguments?
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 … Read more
How do you document function arguments?
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 … Read more
How to link to other fns/structs/enums/traits in rustdoc?
As of Rust 1.48, you can now rely on RFC 1946. This adds the concept of intra-documentation links. This allows using Rust paths as the URL of a link: [Iterator](std::iter::Iterator) [Iterator][iter], and somewhere else in the document: [iter]: std::iter::Iterator [Iterator], and somewhere else in the document: [Iterator]: std::iter::Iterator The RFC also introduces “Implied Shortcut Reference … Read more